1576819 - Add PROFILER_ADD_MARKER_WITH_PAYLOAD, use it and PROFILER_ADD_MARKER everywhere

Status: RESOLVED FIXED

(Core :: Gecko Profiler, task, P2)

Description

[Gerald Squelart (he/him) (not at Mozilla since 2022-09-15)]

Greg suggested in his review of bug 1576550, that the extra timing routine before each profiler_add_marker() call could instead be added to the existing PROFILER_ADD_MARKER macro.

Unfortunately, PROFILER_ADD_MARKER only accepts two arguments, and it's not used everywhere anyway... yet!

So I think we could:

• Use PROFILER_ADD_MARKER for all two-argument calls to profiler_add_marker() -- this will be more consistent, and will also save our users from having to fully qualify the category pair.
• Add PROFILER_ADD_MARKER_WITH_PAYLOAD, which will take an additional payload type and the list of constructor arguments -- this will also be more consistent, but also make it easier to change to stack-allocated payloads in bug 1576555.

With these, it will be trivial to add the internal profiling instrumentation in bug 1576550.

I will keep the first review separate from the patch stack starting at bug 1576550, just in case this change here is not accepted or needs significant changes (so I don't waste time merging these patches if I then have to revert/remerge them).

Comment 1

[Gerald Squelart (he/him) (not at Mozilla since 2022-09-15)]

Attachment: Bug 1576819 - Use PROFILER_ADD_MARKER{,_WITH_PAYLOAD} everywhere - r?gregtatum

All calls to profiler_add_marker() (outside of the profilers code) are
now replaced by either:

• PROFILER_ADD_MARKER(name, categoryPair)
• PROFILER_ADD_MARKER_WITH_PAYLOAD(name, categoryPair, TypeOfMarkerPayload, (payload, arguments))

This makes all calls consistent, and they won't need to prefix the category pair
with JS::ProfilingCategoryPair::.

Also it will make it easier to add (and later remove) internal-profiling
instrumentation (bug 1576550), and soon to replace heap-allocated payloads with
stack-allocated ones (bug 1576555).

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/49471b9a3a99
Use PROFILER_ADD_MARKER{,_WITH_PAYLOAD} everywhere - r=gregtatum

Comment 3

[Cristian Brindusan [:cbrindusan]]

https://hg.mozilla.org/mozilla-central/rev/49471b9a3a99