Class: Pf2::Reporter::FirefoxProfilerSer2::ThreadReport

Inherits:
Object
  • Object
show all
Defined in:
lib/pf2/reporter/firefox_profiler_ser2.rb

Instance Method Summary collapse

Constructor Details

#initialize(profile, thread_id, samples) ⇒ ThreadReport

Returns a new instance of ThreadReport.



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 68

def initialize(profile, thread_id, samples)
  @profile = profile
  @thread_id = thread_id
  @samples = samples

  # Global state
  @stack_tree = { :stack_id => nil }
  @reverse_stack_tree = []
  @string_table = { nil => 0 }
  @stack_weaver = StackWeaver.new(@profile)
end

Instance Method Details

#build_frame_table ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 154

def build_frame_table
  ret = {
    address: [],
    category: [],
    subcategory: [],
    func: [],
    inner_window_id: [],
    implementation: [],
    line: [],
    column: [],
    optimizations: [],
    inline_depth: [],
    native_symbol: [],
  }

  @profile[:locations].each.with_index do |location, i|
    function = @profile[:functions][location[:function_index]]

    ret[:address] << location[:address]
    ret[:category] << (function[:implementation] == :native ? 3 : 2)
    ret[:subcategory] << nil
    ret[:func] << location[:function_index]
    ret[:inner_window_id] << nil
    ret[:implementation] << nil
    ret[:line] << location[:lineno]
    ret[:column] << nil
    ret[:optimizations] << nil
    ret[:inline_depth] << 0
    ret[:native_symbol] << nil
  end

  ret[:length] = ret[:address].length
  ret
end

#build_func_table ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 189

def build_func_table
  ret = {
    name: [],
    is_js: [],
    relevant_for_js: [],
    resource: [],
    file_name: [],
    line_number: [],
    column_number: [],
  }

  @profile[:functions].each do |function|
    is_ruby = (function[:implementation] == :ruby)

    ret[:name] << string_id(function[:name] || "<unknown>")
    ret[:is_js] << is_ruby
    ret[:relevant_for_js] << false
    ret[:resource] << -1
    ret[:file_name] << string_id(function[:filename])
    ret[:line_number] << function[:start_lineno]
    ret[:column_number] << nil
  end

  ret[:length] = ret[:name].length
  ret
end

#build_samples ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 128

def build_samples
  ret = {
    event_delay: [],
    stack: [],
    time: [],
    duration: [],
    # weight: nil,
    # weight_type: 'samples',
  }

  @samples.each do |sample|
    # Weave Ruby stack and native stack
    woven_stack = @stack_weaver.weave(sample[:stack], sample[:native_stack] || [])
    woven_stack.reverse! # StackWeaver returns in root->leaf order, we need leaf->root
    stack_id = @stack_tree.dig(*woven_stack, :stack_id)

    ret[:stack] << stack_id
    ret[:time] << sample[:elapsed_ns] / 1_000_000 # ns -> ms
    ret[:duration] << 100
    ret[:event_delay] << 0
  end

  ret[:length] = ret[:stack].length
  ret
end

#build_stack_table(func_table, frame_table) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 216

def build_stack_table(func_table, frame_table)
  ret = {
    frame: [],
    category: [],
    subcategory: [],
    prefix: [],
  }

  @profile[:samples].each do |sample|
    # Weave Ruby stack and native stack
    woven_stack = @stack_weaver.weave(sample[:stack], sample[:native_stack] || [])
    woven_stack.reverse! # StackWeaver returns in root->leaf order, we need leaf->root

    # Build the stack_table Array which Firefox Profiler requires.
    # At the same time, build the stack tree for efficient traversal.

    current_node = @stack_tree # the stack tree root
    woven_stack.each do |location_index|
      if current_node[location_index].nil?
        # The tree node is unknown. Create it.
        new_stack_id = ret[:frame].length # The position of the new stack in the stack_table array
        current_node[location_index] = { stack_id: new_stack_id }

        # Retrieve the corresponding location and function from the profile
        location = @profile[:locations][location_index]
        function = @profile[:functions][location[:function_index]]

        # Register the stack in the stack_table Array
        ret[:frame] << location_index
        ret[:category] << (function[:implementation] == :native ? 3 : 2)
        ret[:subcategory] << nil
        ret[:prefix] << current_node[:stack_id] # the parent's position in the stack_table array
      end

      # Update the current node to the child node
      current_node = current_node[location_index]
    end
  end

  ret[:length] = ret[:frame].length
  ret
end

#build_string_table ⇒ Object 



259
260
261
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 259

def build_string_table
  @string_table.sort_by {|_, v| v}.map {|s| s[0] }
end

#emit ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 84

def emit
  # Build func table from profile[:functions]
  func_table = build_func_table
  # Build frame table from profile[:locations]
  frame_table = build_frame_table
  # Build stack table from profile[:samples][][:stack]
  stack_table = build_stack_table(func_table, frame_table)
  # Build samples from profile[:samples]
  samples = build_samples

  string_table = build_string_table

  {
    process_type: 'default',
    process_name: 'ruby',
    process_startup_time: 0,
    process_shutdown_time: nil,
    register_time: 0,
    unregister_time: nil,
    paused_ranges: [],
    name: "Thread (tid: #{@thread_id})",
    is_main_thread: true,
    is_js_tracer: true,
    # FIXME: We can fill the correct PID only after we correctly fill is_main_thread
    # (only one thread could be marked as is_main_thread in a single process)
    pid: @thread_id,
    tid: @thread_id,
    samples: samples,
    markers: markers,
    stack_table: stack_table,
    frame_table: frame_table,
    string_array: string_table,
    func_table: func_table,
    resource_table: {
      lib: [],
      name: [],
      host: [],
      type: [],
      length: 0,
    },
    native_symbols: [],
  }
end

#inspect ⇒ Object 



80
81
82
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 80

def inspect
  "#<#{self.class.name} (#{@samples.length} samples)>"
end

#markers ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 270

def markers
  {
    data: [],
    name: [],
    time: [],
    start_time: [],
    end_time: [],
    phase: [],
    category: [],
    length: 0
  }
end

#string_id(str) ⇒ Object 



264
265
266
267
268
 
# File 'lib/pf2/reporter/firefox_profiler_ser2.rb', line 264

def string_id(str)
  id = @string_table[str]
  return id if id
  @string_table[str] = @string_table.length
end