summaryrefslogtreecommitdiffstats
path: root/testing/mozbase/docs/mozgeckoprofiler.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /testing/mozbase/docs/mozgeckoprofiler.rst
parentInitial commit. (diff)
downloadfirefox-esr-upstream.tar.xz
firefox-esr-upstream.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--testing/mozbase/docs/mozgeckoprofiler.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/testing/mozbase/docs/mozgeckoprofiler.rst b/testing/mozbase/docs/mozgeckoprofiler.rst
new file mode 100644
index 0000000000..8e1ae6090d
--- /dev/null
+++ b/testing/mozbase/docs/mozgeckoprofiler.rst
@@ -0,0 +1,21 @@
+:mod:`mozgeckoprofiler.rst` --- Gecko Profiler utilities
+========================================================
+
+This module contains various utilities to work with the Firefox Profiler, Gecko's
+built-in performance profiler. Gecko itself records the profiles, and can dump them
+out to file once the browser shuts down. This package takes those files, symbolicates
+them (turns raw memory addresses into function or symbol names), and provides utilities
+like opening up a locally stored profile in the Firefox Profiler interface. This
+is done by serving the profiles locally, and opening a custom url in profiler.firefox.com.
+
+:mod:`mozgeckoprofiler.rst` --- File origins in mozgeckoprofiler
+----------------------------------------------------------------
+The symbolication files were originally imported from the following repos,
+with permission from their respective authors. However, since then the code has
+been updated for usage within mozbase.
+
+https://github.com/vdjeric/Snappy-Symbolication-Server/
+https://github.com/mstange/analyze-tryserver-profiles/
+
+The dump_syms_mac binary was copied from the objdir of a Firefox build on Mac. It's a
+byproduct of the regular Firefox build process and gets generated in objdir/dist/host/bin/.