1626918 - Allow capturing real-time traces in the Firefox Profiler

Status: RESOLVED FIXED

(Core :: Audio/Video: MediaStreamGraph, enhancement, P2)

Description

[Paul Adenot (:padenot) (off until 2022-08-15)]

Multiple steps for this:

• Generalize the mpsc queue to have arbitrary data instead of just strings
• Allow to have multiple backends for the macros: MOZ_LOG or profiler markers

Comment 1

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Generalize the MPSC queue to allow arbitrary payloads.

Comment 2

[Randell Jesup [:jesup] (needinfo me)]

You can already put all log messages into profiles with "profilermarkers" in MOZ_LOG

Comment 3

[Paul Adenot (:padenot) (off until 2022-08-15)]

Yes, this can't be used for us, the marker API is too slow/not deterministic enough, so we need to use our custom code that does the minimum work possible, put that in a queue, bounce to another thread, and then use the marker API.

Comment 4

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Push the JSON serialization logic for MOZ_LOG output in AsyncLogger, prepare for another mode. r?achronop

Comment 5

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Push PID and TIP gathering to AsyncLogger. r?achronop

Depends on D78496

Comment 6

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Split the MPSC queue in its own file, and generalize it for any type. r?achronop

The allocation still needs to be a power of two so the ergonomics are not
amazing, but this will do until we replace with a buffer-based MPSC ringbuffer.

Depends on D78498

Comment 7

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Teach AsyncLogger to output profiler markers. r?gerald

Depends on D78499

Comment 8

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Add the native audio callback thread to the profiler. r?gregtatum

Depends on D78501

Comment 9

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Register the audio callback thread(s) to the Gecko profiler even when it changes. r?achronop

Depends on D78503

Comment 10

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Add a profiler function to handle an edge case with OS callbacks. r?gerald

Depends on D78504

Comment 11

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Don't start/stop the real-time tracing code from the objects they measure. r?achronop

The profile now handles this.

Depends on D78505

Comment 12

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Add two missing constructors to TracingMarkerPayload. r?gerald

Depends on D78506

Comment 13

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Start and stop audio callback tracing when the profiler starts and stops. r?gerald

Depends on D78507

Comment 14

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Add categories for real-time media tracing. r?gerald

Depends on D78508

Comment 15

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Have a fixed size buffer for the message part of the tracing. r?achronop

Depends on D78509

Comment 16

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Don't register the audio callback thread when using audioipc: it's already registered. r?achronop

Depends on D78510

Comment 17

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9a8a328a2482
Push the JSON serialization logic for MOZ_LOG output in AsyncLogger, prepare for another mode. r=achronop
https://hg.mozilla.org/integration/autoland/rev/f42379fcffdc
Push PID and TIP gathering to AsyncLogger. r=achronop
https://hg.mozilla.org/integration/autoland/rev/c58446c7468a
Split the MPSC queue in its own file, and generalize it for any type. r=achronop
https://hg.mozilla.org/integration/autoland/rev/fca3a809b805
Teach AsyncLogger to output profiler markers. r=gerald
https://hg.mozilla.org/integration/autoland/rev/32bc0f2b3a22
Add the native audio callback thread to the profiler. r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/68e0a73427bf
Register the audio callback thread(s) to the Gecko profiler even when it changes. r=achronop
https://hg.mozilla.org/integration/autoland/rev/6ffb58f1abad
Don't start/stop the real-time tracing code from the objects they measure. r=achronop
https://hg.mozilla.org/integration/autoland/rev/48f24a4445a1
Add two missing constructors to TracingMarkerPayload. r=gerald
https://hg.mozilla.org/integration/autoland/rev/9f3bca4dedde
Start and stop audio callback tracing when the profiler starts and stops. r=gerald
https://hg.mozilla.org/integration/autoland/rev/c2f99008a2a0
Add categories for real-time media tracing. r=gerald
https://hg.mozilla.org/integration/autoland/rev/b12a18558d42
Have a fixed size buffer for the message part of the tracing.  r=achronop
https://hg.mozilla.org/integration/autoland/rev/bd39e75bf891
Don't register the audio callback thread when using audioipc: it's already registered. r=achronop

Comment 18

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Don't require POT for queue items on windows/android for now, on a CLOSED TREE

This is tracked in bug 1645416.

Comment 19

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e88ca3b28a60
Don't require POT for queue items on windows/android for now, on a CLOSED TREE

Comment 20

[Paul Adenot (:padenot) (off until 2022-08-15)]

Attachment: Bug 1626918 - Properly check thread id when running with cubeb not sandboxed on a CLOSED TREE.

Comment 21

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/066838d09929
Properly check thread id when running with cubeb not sandboxed on a CLOSED TREE.

Comment 22

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/9a8a328a2482
https://hg.mozilla.org/mozilla-central/rev/f42379fcffdc
https://hg.mozilla.org/mozilla-central/rev/c58446c7468a
https://hg.mozilla.org/mozilla-central/rev/fca3a809b805
https://hg.mozilla.org/mozilla-central/rev/32bc0f2b3a22
https://hg.mozilla.org/mozilla-central/rev/68e0a73427bf
https://hg.mozilla.org/mozilla-central/rev/6ffb58f1abad
https://hg.mozilla.org/mozilla-central/rev/48f24a4445a1
https://hg.mozilla.org/mozilla-central/rev/9f3bca4dedde
https://hg.mozilla.org/mozilla-central/rev/c2f99008a2a0
https://hg.mozilla.org/mozilla-central/rev/b12a18558d42
https://hg.mozilla.org/mozilla-central/rev/bd39e75bf891
https://hg.mozilla.org/mozilla-central/rev/e88ca3b28a60
https://hg.mozilla.org/mozilla-central/rev/066838d09929