Re: [RFC] Adding Support for Firefox's Gecko Profile Format
From: Anup Sharma
Date: Wed Jun 14 2023 - 16:14:54 EST
On Thu, Jun 08, 2023 at 06:23:49PM +0530, Anup Sharma wrote:
> On Wed, Jun 07, 2023 at 11:58:57PM -0700, Ian Rogers wrote:
> > On Mon, Jun 5, 2023 at 2:47 PM Anup Sharma <anupnewsmail@xxxxxxxxx> wrote:
> > >
> > > On Fri, Jun 02, 2023 at 02:19:30AM +0530, Anup Sharma wrote:
> > > > On Sat, May 27, 2023 at 01:19:47AM +0530, Anup Sharma wrote:
> > > > > On Fri, May 26, 2023 at 08:17:44AM -0700, Ian Rogers wrote:
> > > > > > On Thu, May 25, 2023 at 1:53 PM Namhyung Kim <namhyung@xxxxxxxxxx> wrote:
> > > > > > >
> > > > > > > Hi Anup,
> > > > > > >
> > > > > > > On Wed, May 24, 2023 at 12:25 PM Anup Sharma <anupnewsmail@xxxxxxxxx> wrote:
> > > > > > > >
> > > > > > > > Hello everyone,
> > > > > > > >
> > > > > > > > I'm happy to share that I'll be working on adding support for Firefox's Gecko profile format.
> > > > > > > > This format is utilized by the Firefox profiler, which is a powerful tool for performance analysis
> > > > > > > > and debugging. By enhancing the perf data command to generate perf.data files in the Gecko
> > > > > > > > profile format, it will allow us to leverage the capabilities of the Firefox profiler for visualizing
> > > > > > > > and analyzing the performance data.
> > > > > > > >
> > > > > > > > As a starter task, I have created a test for testing the perf data JSON converter command.
> > > > > > > > I'm also looking for a few more starter tasks related to this project. I would greatly appreciate
> > > > > > > > your advice and guidance.
> > > > > > > >
> > > > > > > > In my effort to identify any existing bugs, I have enabled flags like 'fsanitize=address' to detect
> > > > > > > > potential issues but have not found any :). Additionally, I am running perf data commands to ensure
> > > > > > > > that all use cases are handled properly.
> > > > > > >
> > > > > > > Great, good to know it works well with asan for the basic use cases at least.
> > > > > > >
> > > > > > > >
> > > > > > > > I have one question regarding the installation process. Typically, I navigate to the perf directory,
> > > > > > > > run 'make', and then cp 'perf' to '/usr/bin'. However, I noticed that by default, perf is installed in
> > > > > > > > the '~/bin/perf' directory. Could someone please clarify why this is the case? Furthermore, I would
> > > > > > > > like to know how all of you compile the perf tree.
> > > > > > >
> > > > > > > I guess $HOME is the default prefix unless you set it to other, then
> > > > > > > make install will put
> > > > > > > the binary there. You can make sure if your PATH contains the ~/bin and use it.
> > > > > > >
> > > > > > > But it's also possible you can run the perf without installing. I
> > > > > > > have a symlink in
> > > > > > > my tmp directory to point to the recent build of the binary and use it
> > > > > > > always. :)
> > > > > > > To build, you can either 'cd tools/perf; make' or 'make -C tools/perf'
> > > > > > > in the top
> > > > > > > level linux source tree. I also pass "BUILD_BPF_SKEL=1" to enable BPF.
> > > > > > >
> > > > > > > Thanks,
> > > > > > > Namhyung
> > > > > >
> > > > > > I quite often test with address sanitizer, I do this by passing to make:
> > > > > > DEBUG=1 EXTRA_CFLAGS="-O0 -g -fno-omit-frame- pointer
> > > > > > -fsanitize=address" NO_LIBTRACEEVENT=1
> > > > > >
> > > > > > The libtraceevent exclusion is to avoid false address sanitizer
> > > > > > warnings in libtraceevent (it wasn't compiled with address sanitizer).
> > > > > > The other flags are to make the code easier to debug. A good place to
> > > > > > start for a description of the build flags is Makefile.perf:
> > > > > > https://git.kernel.org/pub/scm/linux/kernel/git/acme/linux.git/tree/tools/perf/Makefile.perf?h=perf-tools-next
> > > > > >
> > > > > > There's also some description here:
> > > > > > https://git.kernel.org/pub/scm/linux/kernel/git/acme/linux.git/tree/tools/perf/Documentation/Build.txt?h=perf-tools-next
> > > > > >
> > > > > > Perhaps you can suggest improvements :-)
> > > > > >
> > > > >
> > > > > Thanks Namhyung and Ian for your suggestions. I'll try them out and let you know if I have any questions.
> > > > >
> > > >
> > > > Hello all,
> > > >
> > > > Thank you for participating in today's office hours and helping me clarify my doubts.
> > > > One topic that emerged from our discussion is the choice of programming language
> > > > for writing the converter. I am considering using Python as it offers convenient
> > > > libraries for JSON manipulation. However, I need to investigate whether Python is
> > > > enabled by default in most of the Linux distributions that ship with perf, as its
> > > > absence could pose a potential obstacle.
> > > >
> > > > Additionally, two profile formats are available: Gecko profile format and Processed profile format[1].
> > > > Upon discussing on Firefox Profiler matrix channel, they recommended opting for the Processed format,
> > > > as it will be supported in future releases as well. Therefore, I intend to begin by working with the
> > > > Processed format and evaluate the results. If any of you have suggestions regarding the choice of
> > > > format, I would greatly appreciate your input.
> > > >
> > > > Later on, I will address concerns I have regarding the file-loading process.
> > > > Once again, thank you all for your time.
> > >
> > > I wanted to provide an update on my exploration of various tools
> > > and methods to generate a profiler format. In my experimentation, I
> > > considered following command as a reference.
> > >
> > > perf record -F 99 -g -- perf test -w noploop
> > >
> > > The command generated perf.data file has been used with three
> > > different tools to generate the required format and uploaded them to
> > > profiler.firefox.com. Interestingly, I noticed distinct call trees in
> > > each of the three cases. I find myself in a state of confusion regarding
> > > which result to consider as a reference. Here are the outcomes:
> > >
> > > 1. Result obtained using perf script: https://share.firefox.dev/3qxEt7F
> > > 2. Result obtained using samply:https://share.firefox.dev/3OZsha2
> > > 3. Result obtained using simpleperf gecko_profile_generator: https://share.firefox.dev/45Q2BTe
> > >
> > > I would greatly appreciate any guidance or suggestions in this matter.
> >
> > Hi Anup,
> >
> > of the 3 outcomes the perf script output looks best. Is the reason
> > using the processed profile format? For the other two the major issue
> > appears to be symbolization. Presumably with the first perf script is
> > helping out. I'm not sure why the simpleperf stacks are truncated.
> > Sorry to not be of more use, presumably you've looked into this more
> > and we can discuss this in the office hours tomorrow.
>
> The issue does not appear to be related to the processed or gecko profile format.
> Despite specifying the path to the debug symbols using the -symfs option, the
> simpleperf gecko_profile_generator script is unable to detect the debug symbols
> in my system. I have confirmed that the permissions are correct.
>
> Here is the basic output:
>
> root@yoga:/home/anup/perf/simpleperf/scripts# ./gecko_profile_generator.py -i
> perf.data | gzip > profiler.gz
> python3 W 06-08 18:13:27 160392 160392 dso.cpp:446] /usr/lib/x86_64-linux-gnu/
> ld-linux-x86-64.so.2 doesn't contain symbol table
> python3 W 06-08 18:13:27 160392 160392 dso.cpp:446] /usr/lib/x86_64-linux-gnu/
> libc.so.6 doesn't contain symbol table
>
Hi All,
I wanted to take a moment to provide you with an update on the progress
of our Firefox Gecko converter work. While I must emphasize that the code
I'm sharing is not the final version, I wanted to share the advancements
I have made thus far.
This script can generate a JSON format from the output of the "perf script" command.
I attempted to load this JSON file into profile.firefox.com, and although it
successfully loaded, the call tree are not visible. I'm certain this issue
is related to the format of the JSON file or if there is another underlying
cause. I will continue investigating to determine the cause of this problem.
----------------------->cut<---------------------------
diff --git a/tools/perf/scripts/python/gecko_converter.py b/tools/perf/scripts/python/gecko_converter.py
new file mode 100644
index 000000000000..7340ea4bd84e
--- /dev/null
+++ b/tools/perf/scripts/python/gecko_converter.py
@@ -0,0 +1,236 @@
+#!/usr/env/bin python3
+import re
+import sys
+import json
+from functools import reduce
+
+def isPerfScriptFormat(profile):
+ if profile.startswith('{'):
+ return False
+
+ firstLine = profile[:profile.index('\n')]
+ return bool(re.match(r'^\S.*?\s+(?:\d+/)?\d+\s+(?:\d+\d+\s+)?[\d.]+:', firstLine))
+
+CATEGORIES = [
+{'name': 'User', 'color': 'yellow', 'subcategories': ['Other']},
+{'name': 'Kernel', 'color': 'orange', 'subcategories': ['Other']}
+]
+USER_CATEGORY_INDEX = 0
+KERNEL_CATEGORY_INDEX = 1
+
+def convertPerfScriptProfile(profile):
+ def _createtread(name, pid, tid):
+ markers = {
+ 'schema': {
+ 'name': 0,
+ 'startTime': 1,
+ 'endTime': 2,
+ 'phase': 3,
+ 'category': 4,
+ 'data': 5,
+ },
+ 'data': [],
+ }
+ samples = {
+ 'schema': {
+ 'stack': 0,
+ 'time': 1,
+ 'responsiveness': 2,
+ },
+ 'data': [],
+ }
+ frameTable = {
+ 'schema': {
+ 'location': 0,
+ 'relevantForJS': 1,
+ 'innerWindowID': 2,
+ 'implementation': 3,
+ 'optimizations': 4,
+ 'line': 5,
+ 'column': 6,
+ 'category': 7,
+ 'subcategory': 8,
+ },
+ 'data': [],
+ }
+ stackTable = {
+ 'schema': {
+ 'prefix': 0,
+ 'frame': 1,
+ },
+ 'data': [],
+ }
+ stringTable = []
+
+ stackMap = dict()
+ def get_or_create_stack(frame, prefix):
+ key = f"{frame}" if prefix is None else f"{frame},{prefix}"
+ stack = stackMap.get(key)
+ if stack is None:
+ stack = len(stackTable['data'])
+ stackTable['data'].append([prefix, frame])
+ stackMap[key] = stack
+ return stack
+
+ frameMap = dict()
+ def get_or_create_frame(frameString):
+ frame = frameMap.get(frameString)
+ if frame is None:
+ frame = len(frameTable['data'])
+ location = len(stringTable)
+ stringTable.append(frameString)
+ # print('batman', frame, frameString)
+
+ category = KERNEL_CATEGORY_INDEX if frameString.find('kallsyms') != -1 or frameString.find('/vmlinux') != 1 or frameString.endswith('.ko)') else USER_CATEGORY_INDEX
+ implementation = None
+ optimizations = None
+ line = None
+ relevantForJS = False
+ subcategory = None
+ innerWindowID = 0
+ column = None
+
+ frameTable['data'].append([
+ location,
+ relevantForJS,
+ innerWindowID,
+ implementation,
+ optimizations,
+ line,
+ column,
+ category,
+ subcategory,
+ ])
+ frameMap[frameString] = frame
+ return frame
+
+ def addSample(threadName, stackArray, time):
+ nonlocal name
+ if name != threadName:
+ name = threadName
+ stack = reduce(lambda prefix, stackFrame: get_or_create_stack(get_or_create_frame(stackFrame), prefix), stackArray)
+ responsiveness = 0
+ samples['data'].append([stack, time, responsiveness])
+
+ def finish():
+ return {
+ "tid": tid,
+ "pid": pid,
+ "name": name,
+ "markers": markers,
+ "samples": samples,
+ "frameTable": frameTable,
+ "stackTable": stackTable,
+ "stringTable": stringTable,
+ "registerTime": 0,
+ "unregisterTime": None,
+ "processType": 'default'
+ }
+
+ return {
+ "addSample": addSample,
+ "finish": finish
+ }
+
+ threadMap = dict()
+ def _addThreadSample(pid, tid, threadName, time_stamp, stack):
+ thread = threadMap.get(tid)
+ if not thread:
+ thread = _createtread(pid, tid, threadName)
+ threadMap[tid] = thread
+ thread['addSample'](threadName, stack, time_stamp)
+
+ lines = profile.split('\n')
+
+ line_index = 0
+ start_time = 0
+ while line_index < len(lines):
+ line = lines[line_index]
+ line_index += 1
+ if line == '' or line.startswith('#'):
+ continue
+
+ sample_start_line = line
+
+ sample_start_match = re.match(r'^(.*)\s+([\d.]+):', sample_start_line)
+ if not sample_start_match:
+ print(f'Could not parse line as the start of a sample in the "perf script" profile format: "{sample_start_line}"')
+ continue
+
+ before_time_stamp = sample_start_match[1]
+ time_stamp = float(sample_start_match[2]) * 1000
+
+ threadNamePidAndTidMatch = re.match(r'^(.*)\s+(?:(\d+)\/)?(\d+)\b', before_time_stamp)
+
+ if not threadNamePidAndTidMatch:
+ print('Could not parse line as the start of a sample in the "perf script" profile format: "%s"' % sampleStartLine)
+ continue
+
+ threadName = threadNamePidAndTidMatch[1].strip()
+ pid = int(threadNamePidAndTidMatch[2] or 0)
+ tid = int(threadNamePidAndTidMatch[3] or 0)
+ startTime = 0 #workarround
+ if startTime == 0:
+ startTime = time_stamp
+ stack = []
+ while line_index < len(lines):
+ stackFrameLine = lines[line_index]
+ line_index += 1
+ if stackFrameLine.strip() == '':
+ break
+ stackFrameMatch = re.match(r'^\s*(\w+)\s*(.+) \(([^)]*)\)', stackFrameLine)
+ if stackFrameMatch:
+ rawFunc = stackFrameMatch[2]
+ mod = stackFrameMatch[3]
+ rawFunc = re.sub(r'\+0x[\da-f]+$', '', rawFunc)
+
+ if rawFunc.startswith('('):
+ continue # skip process names
+
+ if mod:
+ rawFunc += f' (in {mod})'
+
+ stack.append(rawFunc)
+ if len(stack) != 0:
+ stack.reverse()
+ _addThreadSample(pid, tid, threadName, time_stamp, stack)
+
+ thread_array = list(map(lambda thread: thread['finish'](), threadMap.values()))
+
+ for thread in thread_array:
+ key = thread['samples']['schema']['time']
+ thread['samples']['data'].sort(key=lambda data : float(data[key]))
+
+ return {
+ 'meta': {
+ 'interval': 1,
+ 'processType': 0,
+ 'product': 'Firefox',
+ 'stackwalk': 1,
+ 'debug': 0,
+ 'gcpoison': 0,
+ 'asyncstack': 1,
+ 'startTime': startTime,
+ 'shutdownTime': None,
+ 'version': 24,
+ 'presymbolicated': True,
+ 'categories': CATEGORIES,
+ 'markerSchema': []
+ },
+ 'libs': [],
+ 'threads': thread_array,
+ 'processes': [],
+ 'pausedRanges': []
+}
+
+def main():
+# inputFile = input('Enter input file name: ')
+ with open('test.txt') as f:
+ profile = f.read()
+ isPerfScript = isPerfScriptFormat(profile)
+ output = convertPerfScriptProfile(profile)
+ json.dump(output, sys.stdout, indent=2)
+ # print('isPerfScript: {}'.format(isPerfScript))
+
+if __name__ == '__main__':
+ main()
------------------------>cut<---------------------------
Thanks,
Anup
> >
> > Thanks,
> > Ian
> >
> > > > Thanks,
> > > > Anup
> > > >
> > > > [1] https://github.com/firefox-devtools/profiler/blob/main/docs-developer/custom-importer.md
> > > >
> > > > > > Thanks,
> > > > > > Ian
> > > > > >
> > > > > > > >
> > > > > > > > Thank you for your support and I'm looking forward to collaborating with you on this project!