1#!/usr/bin/env python3 2# Copyright (C) 2018 The Android Open Source Project 3# 4# Licensed under the Apache License, Version 2.0 (the "License"); 5# you may not use this file except in compliance with the License. 6# You may obtain a copy of the License at 7# 8# http://www.apache.org/licenses/LICENSE-2.0 9# 10# Unless required by applicable law or agreed to in writing, software 11# distributed under the License is distributed on an "AS IS" BASIS, 12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13# See the License for the specific language governing permissions and 14# limitations under the License. 15 16import argparse 17 18from collections import namedtuple 19from google.protobuf import descriptor_pb2, message_factory, descriptor_pool 20 21CLONE_THREAD = 0x00010000 22CLONE_VFORK = 0x00004000 23CLONE_VM = 0x00000100 24 25 26# For compatibility with older pb module versions. 27def get_message_class(pool, msg): 28 if hasattr(message_factory, "GetMessageClass"): 29 return message_factory.GetMessageClass(msg) 30 else: 31 return message_factory.MessageFactory(pool).GetPrototype(msg) 32 33 34def ms_to_ns(time_in_ms): 35 return int(time_in_ms * 1000000) 36 37 38def s_to_ns(time_in_s): 39 return int(time_in_s * 1000000000) 40 41 42class Trace(object): 43 44 def __init__(self, trace, prototypes): 45 self.trace = trace 46 self.prototypes = prototypes 47 self.proc_map = {} 48 self.proc_map[0] = 'idle_thread' 49 50 def add_system_info(self, arch="", fingerprint=""): 51 self.packet = self.trace.packet.add() 52 self.packet.system_info.utsname.machine = arch 53 self.packet.system_info.android_build_fingerprint = fingerprint 54 55 def add_ftrace_packet(self, cpu): 56 self.packet = self.trace.packet.add() 57 self.packet.ftrace_events.cpu = cpu 58 59 def add_packet(self, ts=None): 60 self.packet = self.trace.packet.add() 61 if ts is not None: 62 self.packet.timestamp = ts 63 return self.packet 64 65 def __add_ftrace_event(self, ts, tid): 66 ftrace = self.packet.ftrace_events.event.add() 67 ftrace.timestamp = ts 68 ftrace.pid = tid 69 return ftrace 70 71 def add_rss_stat(self, ts, tid, member, size, mm_id=None, curr=None): 72 ftrace = self.__add_ftrace_event(ts, tid) 73 rss_stat = ftrace.rss_stat 74 rss_stat.member = member 75 rss_stat.size = size 76 if mm_id is not None: 77 rss_stat.mm_id = mm_id 78 if curr is not None: 79 rss_stat.curr = curr 80 81 def add_ion_event(self, ts, tid, heap_name, len, size=0): 82 ftrace = self.__add_ftrace_event(ts, tid) 83 ion = ftrace.ion_heap_grow 84 ion.heap_name = heap_name 85 ion.len = len 86 ion.total_allocated = size 87 88 def add_oom_score_update(self, ts, oom_score_adj, pid): 89 ftrace = self.__add_ftrace_event(ts, pid) 90 oom_score = ftrace.oom_score_adj_update 91 oom_score.comm = self.proc_map[pid] 92 oom_score.oom_score_adj = oom_score_adj 93 oom_score.pid = pid 94 95 def add_sched(self, 96 ts, 97 prev_pid, 98 next_pid, 99 prev_comm=None, 100 next_comm=None, 101 prev_state=None): 102 ftrace = self.__add_ftrace_event(ts, 0) 103 ss = ftrace.sched_switch 104 ss.prev_comm = prev_comm or self.proc_map[prev_pid] 105 ss.prev_pid = prev_pid 106 ss.next_pid = next_pid 107 ss.next_comm = next_comm or self.proc_map[next_pid] 108 if prev_state: 109 if prev_state == 'R': 110 ss.prev_state = 0 111 elif prev_state == 'S': 112 ss.prev_state = 1 113 elif prev_state == 'U' or prev_state == 'D': 114 ss.prev_state = 2 115 else: 116 raise Exception('Invalid prev state {}'.format(prev_state)) 117 118 def add_cpufreq(self, ts, freq, cpu): 119 ftrace = self.__add_ftrace_event(ts, 0) 120 cpufreq = ftrace.cpu_frequency 121 cpufreq.state = freq 122 cpufreq.cpu_id = cpu 123 124 def add_kernel_lmk(self, ts, tid): 125 ftrace = self.__add_ftrace_event(ts, tid) 126 lowmemory_kill = ftrace.lowmemory_kill 127 lowmemory_kill.pid = tid 128 129 def add_sys_enter(self, ts, tid, id): 130 ftrace = self.__add_ftrace_event(ts, tid) 131 sys_enter = ftrace.sys_enter 132 sys_enter.id = id 133 134 def add_sys_exit(self, ts, tid, id, ret): 135 ftrace = self.__add_ftrace_event(ts, tid) 136 sys_exit = ftrace.sys_exit 137 sys_exit.id = id 138 sys_exit.ret = ret 139 140 def add_newtask(self, ts, tid, new_tid, new_comm, flags): 141 ftrace = self.__add_ftrace_event(ts, tid) 142 newtask = ftrace.task_newtask 143 newtask.pid = new_tid 144 newtask.comm = new_comm 145 newtask.clone_flags = flags 146 147 def add_process_free(self, ts, tid, comm, prio): 148 ftrace = self.__add_ftrace_event(ts, tid) 149 sched_process_free = ftrace.sched_process_free 150 sched_process_free.pid = tid 151 sched_process_free.comm = comm 152 sched_process_free.prio = prio 153 154 def add_rename(self, ts, tid, old_comm, new_comm, oom_score_adj): 155 ftrace = self.__add_ftrace_event(ts, tid) 156 task_rename = ftrace.task_rename 157 task_rename.pid = tid 158 task_rename.oldcomm = old_comm 159 task_rename.newcomm = new_comm 160 task_rename.oom_score_adj = oom_score_adj 161 162 def add_print(self, ts, tid, buf): 163 ftrace = self.__add_ftrace_event(ts, tid) 164 print_event = getattr(ftrace, 'print') 165 print_event.buf = buf 166 167 def add_kmalloc(self, ts, tid, bytes_alloc, bytes_req, call_site, gfp_flags, 168 ptr): 169 ftrace = self.__add_ftrace_event(ts, tid) 170 kmalloc = ftrace.kmalloc 171 kmalloc.bytes_alloc = bytes_alloc 172 kmalloc.bytes_req = bytes_req 173 kmalloc.call_site = call_site 174 kmalloc.gfp_flags = gfp_flags 175 kmalloc.ptr = ptr 176 177 def add_kfree(self, ts, tid, call_site, ptr): 178 ftrace = self.__add_ftrace_event(ts, tid) 179 kfree = ftrace.kfree 180 kfree.call_site = call_site 181 kfree.ptr = ptr 182 183 def add_atrace_counter(self, ts, pid, tid, buf, cnt): 184 self.add_print(ts, tid, 'C|{}|{}|{}'.format(pid, buf, cnt)) 185 186 def add_atrace_begin(self, ts, tid, pid, buf): 187 self.add_print(ts, tid, 'B|{}|{}'.format(pid, buf)) 188 189 def add_atrace_end(self, ts, tid, pid): 190 self.add_print(ts, tid, 'E|{}'.format(pid)) 191 192 def add_atrace_async_begin(self, ts, tid, pid, buf): 193 self.add_print(ts, tid, 'S|{}|{}|0'.format(pid, buf)) 194 195 def add_atrace_async_end(self, ts, tid, pid, buf): 196 self.add_print(ts, tid, 'F|{}|{}|0'.format(pid, buf)) 197 198 def add_atrace_instant(self, ts, tid, pid, buf): 199 self.add_print(ts, tid, 'I|{}|{}'.format(pid, buf)) 200 201 def add_process(self, pid, ppid, cmdline, uid=None): 202 process = self.packet.process_tree.processes.add() 203 process.pid = pid 204 process.ppid = ppid 205 process.cmdline.append(cmdline) 206 if uid is not None: 207 process.uid = uid 208 self.proc_map[pid] = cmdline 209 210 def add_thread(self, tid, tgid, cmdline, name=None): 211 thread = self.packet.process_tree.threads.add() 212 thread.tid = tid 213 thread.tgid = tgid 214 if name is not None: 215 thread.name = name 216 self.proc_map[tid] = cmdline 217 218 def add_battery_counters(self, ts, charge_uah, cap_prct, curr_ua, 219 curr_avg_ua): 220 self.packet = self.trace.packet.add() 221 self.packet.timestamp = ts 222 battery_count = self.packet.battery 223 battery_count.charge_counter_uah = charge_uah 224 battery_count.capacity_percent = cap_prct 225 battery_count.current_ua = curr_ua 226 battery_count.current_avg_ua = curr_avg_ua 227 228 def add_binder_transaction(self, transaction_id, ts_start, ts_end, tid, pid, 229 reply_id, reply_ts_start, reply_ts_end, reply_tid, 230 reply_pid): 231 # Binder transaction start. 232 ftrace = self.__add_ftrace_event(ts_start, tid) 233 binder_transaction = ftrace.binder_transaction 234 binder_transaction.debug_id = transaction_id 235 binder_transaction.to_proc = reply_pid 236 binder_transaction.to_thread = reply_tid 237 binder_transaction.reply = False 238 239 # Binder reply start 240 ftrace = self.__add_ftrace_event(reply_ts_start, reply_tid) 241 binder_transaction_received = ftrace.binder_transaction_received 242 binder_transaction_received.debug_id = transaction_id 243 244 # Binder reply finish 245 ftrace = self.__add_ftrace_event(reply_ts_end, reply_tid) 246 reply_binder_transaction = ftrace.binder_transaction 247 reply_binder_transaction.debug_id = reply_id 248 reply_binder_transaction.to_proc = pid 249 reply_binder_transaction.to_thread = tid 250 reply_binder_transaction.reply = True 251 252 # Binder transaction finish 253 ftrace = self.__add_ftrace_event(ts_end, tid) 254 reply_binder_transaction_received = ftrace.binder_transaction_received 255 reply_binder_transaction_received.debug_id = reply_id 256 257 def add_battery_counters_no_curr_ua(self, ts, charge_uah, cap_prct, 258 curr_avg_ua): 259 self.packet = self.trace.packet.add() 260 self.packet.timestamp = ts 261 battery_count = self.packet.battery 262 battery_count.charge_counter_uah = charge_uah 263 battery_count.capacity_percent = cap_prct 264 battery_count.current_avg_ua = curr_avg_ua 265 266 def add_power_rails_desc(self, index_val, name): 267 power_rails = self.packet.power_rails 268 descriptor = power_rails.rail_descriptor.add() 269 descriptor.index = index_val 270 descriptor.rail_name = name 271 272 def add_power_rails_data(self, ts, index_val, value): 273 power_rails = self.packet.power_rails 274 energy_data = power_rails.energy_data.add() 275 energy_data.index = index_val 276 energy_data.timestamp_ms = ts 277 energy_data.energy = value 278 279 def add_package_list(self, ts, name, uid, version_code): 280 packet = self.add_packet() 281 packet.timestamp = ts 282 plist = packet.packages_list 283 pinfo = plist.packages.add() 284 pinfo.name = name 285 pinfo.uid = uid 286 pinfo.version_code = version_code 287 288 def add_debuggable_package_list(self, ts, name, uid, version_code): 289 packet = self.add_packet() 290 packet.timestamp = ts 291 plist = packet.packages_list 292 pinfo = plist.packages.add() 293 pinfo.name = name 294 pinfo.uid = uid 295 pinfo.version_code = version_code 296 pinfo.debuggable = True 297 298 def add_profile_packet(self, ts): 299 packet = self.add_packet() 300 packet.timestamp = ts 301 return packet.profile_packet 302 303 def add_clock_snapshot(self, clocks, seq_id=None): 304 packet = self.add_packet() 305 if seq_id is not None: 306 packet.trusted_packet_sequence_id = seq_id 307 snap = self.packet.clock_snapshot 308 for k, v in clocks.items(): 309 clock = snap.clocks.add() 310 clock.clock_id = k 311 clock.timestamp = v 312 313 def add_gpu_counter_spec(self, 314 ts, 315 counter_id, 316 name, 317 description=None, 318 unit_numerators=[], 319 unit_denominators=[]): 320 packet = self.add_packet() 321 packet.timestamp = ts 322 gpu_counters = packet.gpu_counter_event 323 counter_desc = gpu_counters.counter_descriptor 324 spec = counter_desc.specs.add() 325 spec.counter_id = counter_id 326 spec.name = name 327 if description is not None: 328 spec.description = description 329 spec.numerator_units.extend(unit_numerators) 330 spec.denominator_units.extend(unit_denominators) 331 332 def add_gpu_counter(self, ts, counter_id, value, clock_id=None, seq_id=None): 333 packet = self.add_packet() 334 packet.timestamp = ts 335 if clock_id is not None: 336 packet.timestamp_clock_id = clock_id 337 if seq_id is not None: 338 packet.trusted_packet_sequence_id = seq_id 339 gpu_counters = self.packet.gpu_counter_event 340 gpu_counter = gpu_counters.counters.add() 341 gpu_counter.counter_id = counter_id 342 gpu_counter.int_value = value 343 344 def add_gpu_render_stages_hw_queue_spec(self, specs=[]): 345 packet = self.add_packet() 346 spec = self.packet.gpu_render_stage_event.specifications 347 for s in specs: 348 hw_queue = spec.hw_queue.add() 349 hw_queue.name = s.get('name', '') 350 if 'description' in s: 351 hw_queue.description = s['description'] 352 353 def add_gpu_render_stages_stage_spec(self, specs=[]): 354 packet = self.add_packet() 355 spec = self.packet.gpu_render_stage_event.specifications 356 for s in specs: 357 stage = spec.stage.add() 358 stage.name = s.get('name', '') 359 if 'description' in s: 360 stage.description = s['description'] 361 362 def add_gpu_render_stages(self, 363 ts, 364 event_id, 365 duration, 366 hw_queue_id, 367 stage_id, 368 context, 369 render_target_handle=None, 370 render_pass_handle=None, 371 render_subpass_index_mask=None, 372 command_buffer_handle=None, 373 submission_id=None, 374 extra_data={}): 375 packet = self.add_packet() 376 packet.timestamp = ts 377 render_stage = self.packet.gpu_render_stage_event 378 render_stage.event_id = event_id 379 render_stage.duration = duration 380 render_stage.hw_queue_id = hw_queue_id 381 render_stage.stage_id = stage_id 382 render_stage.context = context 383 if render_target_handle is not None: 384 render_stage.render_target_handle = render_target_handle 385 if render_pass_handle is not None: 386 render_stage.render_pass_handle = render_pass_handle 387 if render_subpass_index_mask is not None: 388 for mask in render_subpass_index_mask: 389 render_stage.render_subpass_index_mask.append(mask) 390 if command_buffer_handle is not None: 391 render_stage.command_buffer_handle = command_buffer_handle 392 if submission_id is not None: 393 render_stage.submission_id = submission_id 394 for key, value in extra_data.items(): 395 data = render_stage.extra_data.add() 396 data.name = key 397 if value is not None: 398 data.value = value 399 400 def add_vk_debug_marker(self, ts, pid, vk_device, obj_type, obj, obj_name): 401 packet = self.add_packet() 402 packet.timestamp = ts 403 debug_marker = (self.packet.vulkan_api_event.vk_debug_utils_object_name) 404 debug_marker.pid = pid 405 debug_marker.vk_device = vk_device 406 debug_marker.object_type = obj_type 407 debug_marker.object = obj 408 debug_marker.object_name = obj_name 409 410 def add_vk_queue_submit(self, ts, dur, pid, tid, vk_queue, vk_command_buffers, 411 submission_id): 412 packet = self.add_packet() 413 packet.timestamp = ts 414 submit = (self.packet.vulkan_api_event.vk_queue_submit) 415 submit.duration_ns = dur 416 submit.pid = pid 417 submit.tid = tid 418 for cmd in vk_command_buffers: 419 submit.vk_command_buffers.append(cmd) 420 submit.submission_id = submission_id 421 422 def add_gpu_log(self, ts, severity, tag, message): 423 packet = self.add_packet() 424 packet.timestamp = ts 425 gpu_log = self.packet.gpu_log 426 gpu_log.severity = severity 427 gpu_log.tag = tag 428 gpu_log.log_message = message 429 430 def add_buffer_event_packet(self, ts, buffer_id, layer_name, frame_number, 431 event_type, duration): 432 packet = self.add_packet() 433 packet.timestamp = ts 434 buffer_event = packet.graphics_frame_event.buffer_event 435 if buffer_id >= 0: 436 buffer_event.buffer_id = buffer_id 437 buffer_event.layer_name = layer_name 438 buffer_event.frame_number = frame_number 439 if event_type >= 0: 440 buffer_event.type = event_type 441 buffer_event.duration_ns = duration 442 443 def add_cpu(self, freqs): 444 cpu = self.packet.cpu_info.cpus.add() 445 for freq in freqs: 446 cpu.frequencies.append(freq) 447 448 def add_process_stats(self, pid, freqs): 449 process = self.packet.process_stats.processes.add() 450 process.pid = pid 451 thread = process.threads.add() 452 thread.tid = pid * 10 453 for index in freqs: 454 thread.cpu_freq_indices.append(index) 455 thread.cpu_freq_ticks.append(freqs[index]) 456 457 def add_gpu_mem_total_ftrace_event(self, ftrace_pid, pid, ts, size): 458 ftrace = self.__add_ftrace_event(ts, ftrace_pid) 459 gpu_mem_total_ftrace_event = ftrace.gpu_mem_total 460 gpu_mem_total_ftrace_event.pid = pid 461 gpu_mem_total_ftrace_event.size = size 462 463 def add_gpu_mem_total_event(self, pid, ts, size): 464 packet = self.add_packet() 465 packet.timestamp = ts 466 gpu_mem_total_event = packet.gpu_mem_total_event 467 gpu_mem_total_event.pid = pid 468 gpu_mem_total_event.size = size 469 470 def add_sched_blocked_reason(self, ts, pid, io_wait, unblock_pid): 471 ftrace = self.__add_ftrace_event(ts, unblock_pid) 472 sched_blocked_reason = ftrace.sched_blocked_reason 473 sched_blocked_reason.pid = pid 474 sched_blocked_reason.io_wait = io_wait 475 476 def add_track_event(self, 477 name=None, 478 ts=None, 479 track=None, 480 trusted_sequence_id=0, 481 cpu_time=None): 482 packet = self.add_packet(ts=ts) 483 if name is not None: 484 packet.track_event.name = name 485 if track is not None: 486 packet.track_event.track_uuid = track 487 packet.trusted_packet_sequence_id = trusted_sequence_id 488 if cpu_time is not None: 489 packet.track_event.extra_counter_values.append(cpu_time) 490 return packet 491 492 def add_track_descriptor(self, uuid, parent=None): 493 packet = self.add_packet() 494 track_descriptor = packet.track_descriptor 495 if uuid is not None: 496 track_descriptor.uuid = uuid 497 if parent is not None: 498 track_descriptor.parent_uuid = parent 499 return packet 500 501 def add_process_track_descriptor(self, 502 process_track, 503 pid=None, 504 process_name=None): 505 packet = self.add_track_descriptor(process_track) 506 if pid is not None: 507 packet.track_descriptor.process.pid = pid 508 if process_name is not None: 509 packet.track_descriptor.process.process_name = process_name 510 return packet 511 512 def add_chrome_process_track_descriptor( 513 self, 514 process_track, 515 pid=None, 516 process_type=None, 517 host_app_package_name="org.chromium.chrome"): 518 if process_type is None: 519 process_type = self.prototypes.ChromeProcessDescriptor \ 520 .ProcessType \ 521 .PROCESS_RENDERER 522 523 packet = self.add_process_track_descriptor(process_track, pid=pid) 524 chrome_process = packet.track_descriptor.chrome_process 525 chrome_process.process_type = process_type 526 chrome_process.host_app_package_name = host_app_package_name 527 return packet 528 529 def add_thread_track_descriptor(self, 530 process_track, 531 thread_track, 532 trusted_packet_sequence_id=None, 533 pid=None, 534 tid=None, 535 thread_name=None): 536 packet = self.add_track_descriptor(thread_track, parent=process_track) 537 if trusted_packet_sequence_id is not None: 538 packet.trusted_packet_sequence_id = trusted_packet_sequence_id 539 if pid is not None: 540 packet.track_descriptor.thread.pid = pid 541 if tid is not None: 542 packet.track_descriptor.thread.tid = tid 543 if thread_name is not None: 544 packet.track_descriptor.thread.thread_name = thread_name 545 return packet 546 547 def add_chrome_thread_track_descriptor(self, 548 process_track, 549 thread_track, 550 trusted_packet_sequence_id=None, 551 pid=None, 552 tid=None, 553 thread_type=None): 554 if thread_type is None: 555 thread_type = self.prototypes.ThreadDescriptor \ 556 .ChromeThreadType \ 557 .CHROME_THREAD_TYPE_UNSPECIFIED 558 559 packet = self.add_thread_track_descriptor( 560 process_track, 561 thread_track, 562 trusted_packet_sequence_id=trusted_packet_sequence_id, 563 pid=pid, 564 tid=tid) 565 packet.track_descriptor.thread.chrome_thread_type = thread_type 566 return packet 567 568 def add_trace_packet_defaults(self, 569 trusted_packet_sequence_id=None, 570 thread_track=None, 571 counter_track=None): 572 packet = self.add_track_descriptor(None) 573 packet.trusted_packet_sequence_id = trusted_packet_sequence_id 574 track_event_defaults = packet.trace_packet_defaults.track_event_defaults 575 track_event_defaults.track_uuid = thread_track 576 track_event_defaults.extra_counter_track_uuids.append(counter_track) 577 return packet 578 579 def add_counter_track_descriptor(self, 580 trusted_packet_sequence_id=None, 581 thread_track=None, 582 counter_track=None): 583 packet = self.add_track_descriptor(counter_track, parent=thread_track) 584 packet.trusted_packet_sequence_id = trusted_packet_sequence_id 585 packet.track_descriptor.counter.type = self.prototypes.CounterDescriptor \ 586 .BuiltinCounterType \ 587 .COUNTER_THREAD_TIME_NS 588 return packet 589 590 def add_chrome_thread_with_cpu_counter(self, 591 process_track, 592 thread_track, 593 trusted_packet_sequence_id=None, 594 counter_track=None, 595 pid=None, 596 tid=None, 597 thread_type=None): 598 self.add_chrome_thread_track_descriptor( 599 process_track, 600 thread_track, 601 trusted_packet_sequence_id=trusted_packet_sequence_id, 602 pid=pid, 603 tid=tid, 604 thread_type=thread_type) 605 self.add_trace_packet_defaults( 606 trusted_packet_sequence_id=trusted_packet_sequence_id, 607 counter_track=counter_track, 608 thread_track=thread_track) 609 610 self.add_counter_track_descriptor( 611 trusted_packet_sequence_id=trusted_packet_sequence_id, 612 counter_track=counter_track, 613 thread_track=thread_track) 614 615 def add_track_event_slice_begin(self, 616 name, 617 ts, 618 track=None, 619 trusted_sequence_id=0, 620 cpu_time=None): 621 packet = self.add_track_event( 622 name, 623 ts=ts, 624 track=track, 625 trusted_sequence_id=trusted_sequence_id, 626 cpu_time=cpu_time) 627 packet.track_event.type = self.prototypes.TrackEvent.Type.TYPE_SLICE_BEGIN 628 return packet 629 630 def add_track_event_slice_end(self, 631 ts, 632 track=None, 633 trusted_sequence_id=0, 634 cpu_time=None): 635 packet = self.add_track_event( 636 ts=ts, 637 track=track, 638 trusted_sequence_id=trusted_sequence_id, 639 cpu_time=cpu_time) 640 packet.track_event.type = self.prototypes.TrackEvent.Type.TYPE_SLICE_END 641 return packet 642 643 # Returns the start slice packet. 644 def add_track_event_slice(self, 645 name, 646 ts, 647 dur, 648 track=None, 649 trusted_sequence_id=0, 650 cpu_start=None, 651 cpu_delta=None): 652 653 packet = self.add_track_event_slice_begin( 654 name, 655 ts, 656 track=track, 657 trusted_sequence_id=trusted_sequence_id, 658 cpu_time=cpu_start) 659 660 if dur >= 0: 661 cpu_end = cpu_start + cpu_delta if cpu_start is not None else None 662 self.add_track_event_slice_end( 663 ts + dur, 664 track=track, 665 trusted_sequence_id=trusted_sequence_id, 666 cpu_time=cpu_end) 667 668 return packet 669 670 def add_rail_mode_slice(self, ts, dur, track, mode): 671 packet = self.add_track_event_slice( 672 "Scheduler.RAILMode", ts=ts, dur=dur, track=track) 673 packet.track_event.chrome_renderer_scheduler_state.rail_mode = mode 674 675 def add_latency_info_flow(self, 676 ts, 677 dur, 678 track=None, 679 trusted_sequence_id=None, 680 trace_id=None, 681 step=None, 682 flow_ids=[], 683 terminating_flow_ids=[]): 684 packet = self.add_track_event_slice( 685 "LatencyInfo.Flow", 686 ts, 687 dur, 688 track=track, 689 trusted_sequence_id=trusted_sequence_id) 690 if trace_id is not None: 691 packet.track_event.chrome_latency_info.trace_id = trace_id 692 if step is not None: 693 packet.track_event.chrome_latency_info.step = step 694 for flow_id in flow_ids: 695 packet.track_event.flow_ids.append(flow_id) 696 for flow_id in terminating_flow_ids: 697 packet.track_event.terminating_flow_ids.append(flow_id) 698 return packet 699 700 def add_input_latency_event_slice(self, 701 name, 702 ts, 703 dur, 704 track=None, 705 trace_id=None, 706 gesture_scroll_id=None, 707 touch_id=None, 708 is_coalesced=None, 709 gets_to_gpu=True): 710 packet = self.add_track_event_slice( 711 "InputLatency::" + name, ts=ts, dur=dur, track=track) 712 latency_info = packet.track_event.chrome_latency_info 713 latency_info.trace_id = trace_id 714 if gesture_scroll_id is not None: 715 latency_info.gesture_scroll_id = gesture_scroll_id 716 if touch_id is not None: 717 latency_info.touch_id = touch_id 718 if gets_to_gpu: 719 component = latency_info.component_info.add() 720 component.component_type = self.prototypes \ 721 .ChromeLatencyInfo.ComponentType \ 722 .COMPONENT_INPUT_EVENT_GPU_SWAP_BUFFER 723 if is_coalesced is not None: 724 latency_info.is_coalesced = is_coalesced 725 return packet 726 727 def add_chrome_metadata(self, os_name=None): 728 metadata = self.add_packet().chrome_events.metadata.add() 729 if os_name is not None: 730 metadata.name = "os-name" 731 metadata.string_value = os_name 732 733 return metadata 734 735 def add_expected_display_frame_start_event(self, ts, cookie, token, pid): 736 packet = self.add_packet() 737 packet.timestamp = ts 738 event = packet.frame_timeline_event.expected_display_frame_start 739 if token != -1: 740 event.cookie = cookie 741 event.token = token 742 event.pid = pid 743 744 def add_actual_display_frame_start_event(self, ts, cookie, token, pid, 745 present_type, on_time_finish, 746 gpu_composition, jank_type, 747 prediction_type): 748 packet = self.add_packet() 749 packet.timestamp = ts 750 event = packet.frame_timeline_event.actual_display_frame_start 751 if token != -1: 752 event.cookie = cookie 753 event.token = token 754 event.pid = pid 755 event.present_type = present_type 756 event.on_time_finish = on_time_finish 757 event.gpu_composition = gpu_composition 758 event.jank_type = jank_type 759 event.prediction_type = prediction_type 760 761 def add_expected_surface_frame_start_event(self, ts, cookie, token, 762 display_frame_token, pid, 763 layer_name): 764 packet = self.add_packet() 765 packet.timestamp = ts 766 event = packet.frame_timeline_event.expected_surface_frame_start 767 if token != -1 and display_frame_token != -1: 768 event.cookie = cookie 769 event.token = token 770 event.display_frame_token = display_frame_token 771 event.pid = pid 772 event.layer_name = layer_name 773 774 def add_actual_surface_frame_start_event(self, 775 ts, 776 cookie, 777 token, 778 display_frame_token, 779 pid, 780 layer_name, 781 present_type, 782 on_time_finish, 783 gpu_composition, 784 jank_type, 785 prediction_type, 786 jank_severity_type=None): 787 packet = self.add_packet() 788 packet.timestamp = ts 789 event = packet.frame_timeline_event.actual_surface_frame_start 790 if token != -1 and display_frame_token != -1: 791 event.cookie = cookie 792 event.token = token 793 event.display_frame_token = display_frame_token 794 event.pid = pid 795 event.layer_name = layer_name 796 event.present_type = present_type 797 event.on_time_finish = on_time_finish 798 event.gpu_composition = gpu_composition 799 event.jank_type = jank_type 800 # jank severity type is not available on every trace. 801 # When not set, default to none if no jank; otherwise default to unknown 802 if jank_severity_type is None: 803 event.jank_severity_type = 1 if event.jank_type == 1 else 0 804 else: 805 event.jank_severity_type = jank_severity_type 806 event.prediction_type = prediction_type 807 808 def add_frame_end_event(self, ts, cookie): 809 packet = self.add_packet() 810 packet.timestamp = ts 811 event = packet.frame_timeline_event.frame_end 812 event.cookie = cookie 813 814 815def read_descriptor(file_name): 816 with open(file_name, 'rb') as f: 817 contents = f.read() 818 819 descriptor = descriptor_pb2.FileDescriptorSet() 820 descriptor.MergeFromString(contents) 821 822 return descriptor 823 824 825def create_pool(args): 826 trace_descriptor = read_descriptor(args.trace_descriptor) 827 828 pool = descriptor_pool.DescriptorPool() 829 for file in trace_descriptor.file: 830 pool.Add(file) 831 832 return pool 833 834 835def create_trace(): 836 parser = argparse.ArgumentParser() 837 parser.add_argument( 838 'trace_descriptor', type=str, help='location of trace descriptor') 839 args = parser.parse_args() 840 841 pool = create_pool(args) 842 ProtoTrace = get_message_class( 843 pool, pool.FindMessageTypeByName('perfetto.protos.Trace')) 844 845 class EnumPrototype(object): 846 847 def from_descriptor(desc): 848 res = EnumPrototype() 849 for desc in desc.values: 850 setattr(res, desc.name, desc.number) 851 return res 852 853 ChromeLatencyInfo = namedtuple('ChromeLatencyInfo', [ 854 'ComponentType', 855 'Step', 856 ]) 857 858 Prototypes = namedtuple('Prototypes', [ 859 'TrackEvent', 860 'ChromeRAILMode', 861 'ChromeLatencyInfo', 862 'ChromeProcessDescriptor', 863 'CounterDescriptor', 864 'ThreadDescriptor', 865 ]) 866 867 chrome_latency_info_prototypes = ChromeLatencyInfo( 868 ComponentType=EnumPrototype.from_descriptor( 869 pool.FindEnumTypeByName( 870 'perfetto.protos.ChromeLatencyInfo.LatencyComponentType')), 871 Step=EnumPrototype.from_descriptor( 872 pool.FindEnumTypeByName('perfetto.protos.ChromeLatencyInfo.Step')), 873 ) 874 875 prototypes = Prototypes( 876 TrackEvent=get_message_class( 877 pool, pool.FindMessageTypeByName('perfetto.protos.TrackEvent')), 878 ChromeRAILMode=EnumPrototype.from_descriptor( 879 pool.FindEnumTypeByName('perfetto.protos.ChromeRAILMode')), 880 ChromeLatencyInfo=chrome_latency_info_prototypes, 881 ChromeProcessDescriptor=get_message_class( 882 pool, 883 pool.FindMessageTypeByName( 884 'perfetto.protos.ChromeProcessDescriptor')), 885 CounterDescriptor=get_message_class( 886 pool, 887 pool.FindMessageTypeByName('perfetto.protos.CounterDescriptor')), 888 ThreadDescriptor=get_message_class( 889 pool, pool.FindMessageTypeByName('perfetto.protos.ThreadDescriptor')), 890 ) 891 return Trace(ProtoTrace(), prototypes) 892