Commit 5aacd7f0 authored by Anup Sharma's avatar Anup Sharma Committed by Arnaldo Carvalho de Melo
Browse files

perf scripts python: Add classes and conversion functions 



This commit introduces new classes and conversion functions to
facilitate the representation of Gecko profile information. The new
classes Frame, Stack, Sample, and Thread are added to handle specific
components of the profile data, also link to the origin docs has been
commented out.

Additionally, Inside the Thread class _to_json_dict() method has been
created that converts the current thread data into the corresponding
format expected by the GeckoThread JSON schema, as per the Gecko
profile format specification.

Signed-off-by: default avatarAnup Sharma <anupnewsmail@gmail.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: https://lore.kernel.org/r/ab7b40bd32df7101a6f8b4a3aa41570b63b831ac.1689961706.git.anupnewsmail@gmail.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 0a02e44c

tools/perf/scripts/python/gecko.py

+132 −1
Original line number Diff line number Diff line
@@ -11,7 +11,8 @@ 


import os

import sys

from typing import Dict

from dataclasses import dataclass, field

from typing import List, Dict, Optional, NamedTuple, Set, Tuple, Any



# Add the Perf-Trace-Util library to the Python path

sys.path.append(os.environ['PERF_EXEC_PATH'] + \
@@ -20,9 +21,139 @@ sys.path.append(os.environ['PERF_EXEC_PATH'] + \ 
from perf_trace_context import *

from Core import *



StringID = int

StackID = int

FrameID = int

CategoryID = int

Milliseconds = float



# start_time is intialiazed only once for the all event traces.

start_time = None



# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L156

class Frame(NamedTuple):

	string_id: StringID

	relevantForJS: bool

	innerWindowID: int

	implementation: None

	optimizations: None

	line: None

	column: None

	category: CategoryID

	subcategory: int



# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L216

class Stack(NamedTuple):

	prefix_id: Optional[StackID]

	frame_id: FrameID



# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L90

class Sample(NamedTuple):

	stack_id: Optional[StackID]

	time_ms: Milliseconds

	responsiveness: int



@dataclass

class Thread:

	"""A builder for a profile of the thread.



	Attributes:

		comm: Thread command-line (name).

		pid: process ID of containing process.

		tid: thread ID.

		samples: Timeline of profile samples.

		frameTable: interned stack frame ID -> stack frame.

		stringTable: interned string ID -> string.

		stringMap: interned string -> string ID.

		stackTable: interned stack ID -> stack.

		stackMap: (stack prefix ID, leaf stack frame ID) -> interned Stack ID.

		frameMap: Stack Frame string -> interned Frame ID.

		comm: str

		pid: int

		tid: int

		samples: List[Sample] = field(default_factory=list)

		frameTable: List[Frame] = field(default_factory=list)

		stringTable: List[str] = field(default_factory=list)

		stringMap: Dict[str, int] = field(default_factory=dict)

		stackTable: List[Stack] = field(default_factory=list)

		stackMap: Dict[Tuple[Optional[int], int], int] = field(default_factory=dict)

		frameMap: Dict[str, int] = field(default_factory=dict)

	"""

	comm: str

	pid: int

	tid: int

	samples: List[Sample] = field(default_factory=list)

	frameTable: List[Frame] = field(default_factory=list)

	stringTable: List[str] = field(default_factory=list)

	stringMap: Dict[str, int] = field(default_factory=dict)

	stackTable: List[Stack] = field(default_factory=list)

	stackMap: Dict[Tuple[Optional[int], int], int] = field(default_factory=dict)

	frameMap: Dict[str, int] = field(default_factory=dict)



	def _to_json_dict(self) -> Dict:

		"""Converts current Thread to GeckoThread JSON format."""

		# Gecko profile format is row-oriented data as List[List],

		# And a schema for interpreting each index.

		# Schema:

		# https://github.com/firefox-devtools/profiler/blob/main/docs-developer/gecko-profile-format.md

		# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L230

		return {

			"tid": self.tid,

			"pid": self.pid,

			"name": self.comm,

			# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L51

			"markers": {

				"schema": {

					"name": 0,

					"startTime": 1,

					"endTime": 2,

					"phase": 3,

					"category": 4,

					"data": 5,

				},

				"data": [],

			},



			# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L90

			"samples": {

				"schema": {

					"stack": 0,

					"time": 1,

					"responsiveness": 2,

				},

				"data": self.samples

			},



			# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L156

			"frameTable": {

				"schema": {

					"location": 0,

					"relevantForJS": 1,

					"innerWindowID": 2,

					"implementation": 3,

					"optimizations": 4,

					"line": 5,

					"column": 6,

					"category": 7,

					"subcategory": 8,

				},

				"data": self.frameTable,

			},



			# https://github.com/firefox-devtools/profiler/blob/53970305b51b9b472e26d7457fee1d66cd4e2737/src/types/gecko-profile.js#L216

			"stackTable": {

				"schema": {

					"prefix": 0,

					"frame": 1,

				},

				"data": self.stackTable,

			},

			"stringTable": self.stringTable,

			"registerTime": 0,

			"unregisterTime": None,

			"processType": "default",

		}



# Uses perf script python interface to parse each

# event and store the data in the thread builder.

def process_event(param_dict: Dict) -> None: