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, curr_avg_ua, 219 voltage_uv): 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 battery_count.voltage_uv = voltage_uv 228 229 def add_binder_transaction(self, transaction_id, ts_start, ts_end, tid, pid, 230 reply_id, reply_ts_start, reply_ts_end, reply_tid, 231 reply_pid): 232 # Binder transaction start. 233 ftrace = self.__add_ftrace_event(ts_start, tid) 234 binder_transaction = ftrace.binder_transaction 235 binder_transaction.debug_id = transaction_id 236 binder_transaction.to_proc = reply_pid 237 binder_transaction.to_thread = reply_tid 238 binder_transaction.reply = False 239 240 # Binder reply start 241 ftrace = self.__add_ftrace_event(reply_ts_start, reply_tid) 242 binder_transaction_received = ftrace.binder_transaction_received 243 binder_transaction_received.debug_id = transaction_id 244 245 # Binder reply finish 246 ftrace = self.__add_ftrace_event(reply_ts_end, reply_tid) 247 reply_binder_transaction = ftrace.binder_transaction 248 reply_binder_transaction.debug_id = reply_id 249 reply_binder_transaction.to_proc = pid 250 reply_binder_transaction.to_thread = tid 251 reply_binder_transaction.reply = True 252 253 # Binder transaction finish 254 ftrace = self.__add_ftrace_event(ts_end, tid) 255 reply_binder_transaction_received = ftrace.binder_transaction_received 256 reply_binder_transaction_received.debug_id = reply_id 257 258 def add_battery_counters_no_curr_ua(self, ts, charge_uah, cap_prct, 259 curr_avg_ua, voltage_uv): 260 self.packet = self.trace.packet.add() 261 self.packet.timestamp = ts 262 battery_count = self.packet.battery 263 battery_count.charge_counter_uah = charge_uah 264 battery_count.capacity_percent = cap_prct 265 battery_count.current_avg_ua = curr_avg_ua 266 battery_count.voltage_uv = voltage_uv 267 268 def add_power_rails_desc(self, index_val, name): 269 power_rails = self.packet.power_rails 270 descriptor = power_rails.rail_descriptor.add() 271 descriptor.index = index_val 272 descriptor.rail_name = name 273 274 def add_power_rails_data(self, ts, index_val, value): 275 power_rails = self.packet.power_rails 276 energy_data = power_rails.energy_data.add() 277 energy_data.index = index_val 278 energy_data.timestamp_ms = ts 279 energy_data.energy = value 280 281 def add_package_list(self, ts, name, uid, version_code): 282 packet = self.add_packet() 283 packet.timestamp = ts 284 plist = packet.packages_list 285 pinfo = plist.packages.add() 286 pinfo.name = name 287 pinfo.uid = uid 288 pinfo.version_code = version_code 289 290 def add_debuggable_package_list(self, ts, name, uid, version_code): 291 packet = self.add_packet() 292 packet.timestamp = ts 293 plist = packet.packages_list 294 pinfo = plist.packages.add() 295 pinfo.name = name 296 pinfo.uid = uid 297 pinfo.version_code = version_code 298 pinfo.debuggable = True 299 300 def add_profile_packet(self, ts): 301 packet = self.add_packet() 302 packet.timestamp = ts 303 return packet.profile_packet 304 305 def add_clock_snapshot(self, clocks, seq_id=None): 306 packet = self.add_packet() 307 if seq_id is not None: 308 packet.trusted_packet_sequence_id = seq_id 309 snap = self.packet.clock_snapshot 310 for k, v in clocks.items(): 311 clock = snap.clocks.add() 312 clock.clock_id = k 313 clock.timestamp = v 314 315 def add_gpu_counter_spec(self, 316 ts, 317 counter_id, 318 name, 319 description=None, 320 unit_numerators=[], 321 unit_denominators=[]): 322 packet = self.add_packet() 323 packet.timestamp = ts 324 gpu_counters = packet.gpu_counter_event 325 counter_desc = gpu_counters.counter_descriptor 326 spec = counter_desc.specs.add() 327 spec.counter_id = counter_id 328 spec.name = name 329 if description is not None: 330 spec.description = description 331 spec.numerator_units.extend(unit_numerators) 332 spec.denominator_units.extend(unit_denominators) 333 334 def add_gpu_counter(self, ts, counter_id, value, clock_id=None, seq_id=None): 335 packet = self.add_packet() 336 packet.timestamp = ts 337 if clock_id is not None: 338 packet.timestamp_clock_id = clock_id 339 if seq_id is not None: 340 packet.trusted_packet_sequence_id = seq_id 341 gpu_counters = self.packet.gpu_counter_event 342 gpu_counter = gpu_counters.counters.add() 343 gpu_counter.counter_id = counter_id 344 gpu_counter.int_value = value 345 346 def add_gpu_render_stages_hw_queue_spec(self, specs=[]): 347 packet = self.add_packet() 348 spec = self.packet.gpu_render_stage_event.specifications 349 for s in specs: 350 hw_queue = spec.hw_queue.add() 351 hw_queue.name = s.get('name', '') 352 if 'description' in s: 353 hw_queue.description = s['description'] 354 355 def add_gpu_render_stages_stage_spec(self, specs=[]): 356 packet = self.add_packet() 357 spec = self.packet.gpu_render_stage_event.specifications 358 for s in specs: 359 stage = spec.stage.add() 360 stage.name = s.get('name', '') 361 if 'description' in s: 362 stage.description = s['description'] 363 364 def add_gpu_render_stages(self, 365 ts, 366 event_id, 367 duration, 368 hw_queue_id, 369 stage_id, 370 context, 371 render_target_handle=None, 372 render_pass_handle=None, 373 render_subpass_index_mask=None, 374 command_buffer_handle=None, 375 submission_id=None, 376 extra_data={}): 377 packet = self.add_packet() 378 packet.timestamp = ts 379 render_stage = self.packet.gpu_render_stage_event 380 render_stage.event_id = event_id 381 render_stage.duration = duration 382 render_stage.hw_queue_id = hw_queue_id 383 render_stage.stage_id = stage_id 384 render_stage.context = context 385 if render_target_handle is not None: 386 render_stage.render_target_handle = render_target_handle 387 if render_pass_handle is not None: 388 render_stage.render_pass_handle = render_pass_handle 389 if render_subpass_index_mask is not None: 390 for mask in render_subpass_index_mask: 391 render_stage.render_subpass_index_mask.append(mask) 392 if command_buffer_handle is not None: 393 render_stage.command_buffer_handle = command_buffer_handle 394 if submission_id is not None: 395 render_stage.submission_id = submission_id 396 for key, value in extra_data.items(): 397 data = render_stage.extra_data.add() 398 data.name = key 399 if value is not None: 400 data.value = value 401 402 def add_vk_debug_marker(self, ts, pid, vk_device, obj_type, obj, obj_name): 403 packet = self.add_packet() 404 packet.timestamp = ts 405 debug_marker = (self.packet.vulkan_api_event.vk_debug_utils_object_name) 406 debug_marker.pid = pid 407 debug_marker.vk_device = vk_device 408 debug_marker.object_type = obj_type 409 debug_marker.object = obj 410 debug_marker.object_name = obj_name 411 412 def add_vk_queue_submit(self, ts, dur, pid, tid, vk_queue, vk_command_buffers, 413 submission_id): 414 packet = self.add_packet() 415 packet.timestamp = ts 416 submit = (self.packet.vulkan_api_event.vk_queue_submit) 417 submit.duration_ns = dur 418 submit.pid = pid 419 submit.tid = tid 420 for cmd in vk_command_buffers: 421 submit.vk_command_buffers.append(cmd) 422 submit.submission_id = submission_id 423 424 def add_gpu_log(self, ts, severity, tag, message): 425 packet = self.add_packet() 426 packet.timestamp = ts 427 gpu_log = self.packet.gpu_log 428 gpu_log.severity = severity 429 gpu_log.tag = tag 430 gpu_log.log_message = message 431 432 def add_buffer_event_packet(self, ts, buffer_id, layer_name, frame_number, 433 event_type, duration): 434 packet = self.add_packet() 435 packet.timestamp = ts 436 buffer_event = packet.graphics_frame_event.buffer_event 437 if buffer_id >= 0: 438 buffer_event.buffer_id = buffer_id 439 buffer_event.layer_name = layer_name 440 buffer_event.frame_number = frame_number 441 if event_type >= 0: 442 buffer_event.type = event_type 443 buffer_event.duration_ns = duration 444 445 def add_cpu(self, freqs): 446 cpu = self.packet.cpu_info.cpus.add() 447 for freq in freqs: 448 cpu.frequencies.append(freq) 449 450 def add_process_stats(self, pid, freqs): 451 process = self.packet.process_stats.processes.add() 452 process.pid = pid 453 thread = process.threads.add() 454 thread.tid = pid * 10 455 for index in freqs: 456 thread.cpu_freq_indices.append(index) 457 thread.cpu_freq_ticks.append(freqs[index]) 458 459 def add_gpu_mem_total_ftrace_event(self, ftrace_pid, pid, ts, size): 460 ftrace = self.__add_ftrace_event(ts, ftrace_pid) 461 gpu_mem_total_ftrace_event = ftrace.gpu_mem_total 462 gpu_mem_total_ftrace_event.pid = pid 463 gpu_mem_total_ftrace_event.size = size 464 465 def add_gpu_mem_total_event(self, pid, ts, size): 466 packet = self.add_packet() 467 packet.timestamp = ts 468 gpu_mem_total_event = packet.gpu_mem_total_event 469 gpu_mem_total_event.pid = pid 470 gpu_mem_total_event.size = size 471 472 def add_sched_blocked_reason(self, ts, pid, io_wait, unblock_pid): 473 ftrace = self.__add_ftrace_event(ts, unblock_pid) 474 sched_blocked_reason = ftrace.sched_blocked_reason 475 sched_blocked_reason.pid = pid 476 sched_blocked_reason.io_wait = io_wait 477 478 def add_track_event(self, 479 name=None, 480 ts=None, 481 track=None, 482 trusted_sequence_id=0, 483 cpu_time=None): 484 packet = self.add_packet(ts=ts) 485 if name is not None: 486 packet.track_event.name = name 487 if track is not None: 488 packet.track_event.track_uuid = track 489 packet.trusted_packet_sequence_id = trusted_sequence_id 490 if cpu_time is not None: 491 packet.track_event.extra_counter_values.append(cpu_time) 492 return packet 493 494 def add_track_descriptor(self, uuid, parent=None): 495 packet = self.add_packet() 496 track_descriptor = packet.track_descriptor 497 if uuid is not None: 498 track_descriptor.uuid = uuid 499 if parent is not None: 500 track_descriptor.parent_uuid = parent 501 return packet 502 503 def add_process_track_descriptor(self, 504 process_track, 505 pid=None, 506 process_name=None): 507 packet = self.add_track_descriptor(process_track) 508 if pid is not None: 509 packet.track_descriptor.process.pid = pid 510 if process_name is not None: 511 packet.track_descriptor.process.process_name = process_name 512 return packet 513 514 def add_chrome_process_track_descriptor( 515 self, 516 process_track, 517 pid=None, 518 process_type=None, 519 host_app_package_name="org.chromium.chrome"): 520 if process_type is None: 521 process_type = self.prototypes.ChromeProcessDescriptor \ 522 .ProcessType \ 523 .PROCESS_RENDERER 524 525 packet = self.add_process_track_descriptor(process_track, pid=pid) 526 chrome_process = packet.track_descriptor.chrome_process 527 chrome_process.process_type = process_type 528 chrome_process.host_app_package_name = host_app_package_name 529 return packet 530 531 def add_thread_track_descriptor(self, 532 process_track, 533 thread_track, 534 trusted_packet_sequence_id=None, 535 pid=None, 536 tid=None, 537 thread_name=None): 538 packet = self.add_track_descriptor(thread_track, parent=process_track) 539 if trusted_packet_sequence_id is not None: 540 packet.trusted_packet_sequence_id = trusted_packet_sequence_id 541 if pid is not None: 542 packet.track_descriptor.thread.pid = pid 543 if tid is not None: 544 packet.track_descriptor.thread.tid = tid 545 if thread_name is not None: 546 packet.track_descriptor.thread.thread_name = thread_name 547 return packet 548 549 def add_chrome_thread_track_descriptor(self, 550 process_track, 551 thread_track, 552 trusted_packet_sequence_id=None, 553 pid=None, 554 tid=None, 555 thread_type=None): 556 if thread_type is None: 557 thread_type = self.prototypes.ThreadDescriptor \ 558 .ChromeThreadType \ 559 .CHROME_THREAD_TYPE_UNSPECIFIED 560 561 packet = self.add_thread_track_descriptor( 562 process_track, 563 thread_track, 564 trusted_packet_sequence_id=trusted_packet_sequence_id, 565 pid=pid, 566 tid=tid) 567 packet.track_descriptor.thread.chrome_thread_type = thread_type 568 return packet 569 570 def add_trace_packet_defaults(self, 571 trusted_packet_sequence_id=None, 572 thread_track=None, 573 counter_track=None): 574 packet = self.add_track_descriptor(None) 575 packet.trusted_packet_sequence_id = trusted_packet_sequence_id 576 track_event_defaults = packet.trace_packet_defaults.track_event_defaults 577 track_event_defaults.track_uuid = thread_track 578 track_event_defaults.extra_counter_track_uuids.append(counter_track) 579 return packet 580 581 def add_counter_track_descriptor(self, 582 trusted_packet_sequence_id=None, 583 thread_track=None, 584 counter_track=None): 585 packet = self.add_track_descriptor(counter_track, parent=thread_track) 586 packet.trusted_packet_sequence_id = trusted_packet_sequence_id 587 packet.track_descriptor.counter.type = self.prototypes.CounterDescriptor \ 588 .BuiltinCounterType \ 589 .COUNTER_THREAD_TIME_NS 590 return packet 591 592 def add_chrome_thread_with_cpu_counter(self, 593 process_track, 594 thread_track, 595 trusted_packet_sequence_id=None, 596 counter_track=None, 597 pid=None, 598 tid=None, 599 thread_type=None): 600 self.add_chrome_thread_track_descriptor( 601 process_track, 602 thread_track, 603 trusted_packet_sequence_id=trusted_packet_sequence_id, 604 pid=pid, 605 tid=tid, 606 thread_type=thread_type) 607 self.add_trace_packet_defaults( 608 trusted_packet_sequence_id=trusted_packet_sequence_id, 609 counter_track=counter_track, 610 thread_track=thread_track) 611 612 self.add_counter_track_descriptor( 613 trusted_packet_sequence_id=trusted_packet_sequence_id, 614 counter_track=counter_track, 615 thread_track=thread_track) 616 617 def add_track_event_slice_begin(self, 618 name, 619 ts, 620 track=None, 621 trusted_sequence_id=0, 622 cpu_time=None): 623 packet = self.add_track_event( 624 name, 625 ts=ts, 626 track=track, 627 trusted_sequence_id=trusted_sequence_id, 628 cpu_time=cpu_time) 629 packet.track_event.type = self.prototypes.TrackEvent.Type.TYPE_SLICE_BEGIN 630 return packet 631 632 def add_track_event_slice_end(self, 633 ts, 634 track=None, 635 trusted_sequence_id=0, 636 cpu_time=None): 637 packet = self.add_track_event( 638 ts=ts, 639 track=track, 640 trusted_sequence_id=trusted_sequence_id, 641 cpu_time=cpu_time) 642 packet.track_event.type = self.prototypes.TrackEvent.Type.TYPE_SLICE_END 643 return packet 644 645 # Returns the start slice packet. 646 def add_track_event_slice(self, 647 name, 648 ts, 649 dur, 650 track=None, 651 trusted_sequence_id=0, 652 cpu_start=None, 653 cpu_delta=None): 654 655 packet = self.add_track_event_slice_begin( 656 name, 657 ts, 658 track=track, 659 trusted_sequence_id=trusted_sequence_id, 660 cpu_time=cpu_start) 661 662 if dur >= 0: 663 cpu_end = cpu_start + cpu_delta if cpu_start is not None else None 664 self.add_track_event_slice_end( 665 ts + dur, 666 track=track, 667 trusted_sequence_id=trusted_sequence_id, 668 cpu_time=cpu_end) 669 670 return packet 671 672 def add_rail_mode_slice(self, ts, dur, track, mode): 673 packet = self.add_track_event_slice( 674 "Scheduler.RAILMode", ts=ts, dur=dur, track=track) 675 packet.track_event.chrome_renderer_scheduler_state.rail_mode = mode 676 677 def add_latency_info_flow(self, 678 ts, 679 dur, 680 track=None, 681 trusted_sequence_id=None, 682 trace_id=None, 683 step=None, 684 flow_ids=[], 685 terminating_flow_ids=[]): 686 packet = self.add_track_event_slice( 687 "LatencyInfo.Flow", 688 ts, 689 dur, 690 track=track, 691 trusted_sequence_id=trusted_sequence_id) 692 if trace_id is not None: 693 packet.track_event.chrome_latency_info.trace_id = trace_id 694 if step is not None: 695 packet.track_event.chrome_latency_info.step = step 696 for flow_id in flow_ids: 697 packet.track_event.flow_ids.append(flow_id) 698 for flow_id in terminating_flow_ids: 699 packet.track_event.terminating_flow_ids.append(flow_id) 700 return packet 701 702 def add_input_latency_event_slice(self, 703 name, 704 ts, 705 dur, 706 track=None, 707 trace_id=None, 708 gesture_scroll_id=None, 709 touch_id=None, 710 is_coalesced=None, 711 gets_to_gpu=True): 712 packet = self.add_track_event_slice( 713 "InputLatency::" + name, ts=ts, dur=dur, track=track) 714 latency_info = packet.track_event.chrome_latency_info 715 latency_info.trace_id = trace_id 716 if gesture_scroll_id is not None: 717 latency_info.gesture_scroll_id = gesture_scroll_id 718 if touch_id is not None: 719 latency_info.touch_id = touch_id 720 if gets_to_gpu: 721 component = latency_info.component_info.add() 722 component.component_type = self.prototypes \ 723 .ChromeLatencyInfo.ComponentType \ 724 .COMPONENT_INPUT_EVENT_GPU_SWAP_BUFFER 725 if is_coalesced is not None: 726 latency_info.is_coalesced = is_coalesced 727 return packet 728 729 def add_chrome_metadata(self, os_name=None): 730 metadata = self.add_packet().chrome_events.metadata.add() 731 if os_name is not None: 732 metadata.name = "os-name" 733 metadata.string_value = os_name 734 735 return metadata 736 737 def add_expected_display_frame_start_event(self, ts, cookie, token, pid): 738 packet = self.add_packet() 739 packet.timestamp = ts 740 event = packet.frame_timeline_event.expected_display_frame_start 741 if token != -1: 742 event.cookie = cookie 743 event.token = token 744 event.pid = pid 745 746 def add_actual_display_frame_start_event(self, ts, cookie, token, pid, 747 present_type, on_time_finish, 748 gpu_composition, jank_type, 749 prediction_type): 750 packet = self.add_packet() 751 packet.timestamp = ts 752 event = packet.frame_timeline_event.actual_display_frame_start 753 if token != -1: 754 event.cookie = cookie 755 event.token = token 756 event.pid = pid 757 event.present_type = present_type 758 event.on_time_finish = on_time_finish 759 event.gpu_composition = gpu_composition 760 event.jank_type = jank_type 761 event.prediction_type = prediction_type 762 763 def add_expected_surface_frame_start_event(self, ts, cookie, token, 764 display_frame_token, pid, 765 layer_name): 766 packet = self.add_packet() 767 packet.timestamp = ts 768 event = packet.frame_timeline_event.expected_surface_frame_start 769 if token != -1 and display_frame_token != -1: 770 event.cookie = cookie 771 event.token = token 772 event.display_frame_token = display_frame_token 773 event.pid = pid 774 event.layer_name = layer_name 775 776 def add_actual_surface_frame_start_event(self, 777 ts, 778 cookie, 779 token, 780 display_frame_token, 781 pid, 782 layer_name, 783 present_type, 784 on_time_finish, 785 gpu_composition, 786 jank_type, 787 prediction_type, 788 jank_severity_type=None): 789 packet = self.add_packet() 790 packet.timestamp = ts 791 event = packet.frame_timeline_event.actual_surface_frame_start 792 if token != -1 and display_frame_token != -1: 793 event.cookie = cookie 794 event.token = token 795 event.display_frame_token = display_frame_token 796 event.pid = pid 797 event.layer_name = layer_name 798 event.present_type = present_type 799 event.on_time_finish = on_time_finish 800 event.gpu_composition = gpu_composition 801 event.jank_type = jank_type 802 # jank severity type is not available on every trace. 803 # When not set, default to none if no jank; otherwise default to unknown 804 if jank_severity_type is None: 805 event.jank_severity_type = 1 if event.jank_type == 1 else 0 806 else: 807 event.jank_severity_type = jank_severity_type 808 event.prediction_type = prediction_type 809 810 def add_frame_end_event(self, ts, cookie): 811 packet = self.add_packet() 812 packet.timestamp = ts 813 event = packet.frame_timeline_event.frame_end 814 event.cookie = cookie 815 816 817def read_descriptor(file_name): 818 with open(file_name, 'rb') as f: 819 contents = f.read() 820 821 descriptor = descriptor_pb2.FileDescriptorSet() 822 descriptor.MergeFromString(contents) 823 824 return descriptor 825 826 827def create_pool(args): 828 trace_descriptor = read_descriptor(args.trace_descriptor) 829 830 pool = descriptor_pool.DescriptorPool() 831 for file in trace_descriptor.file: 832 pool.Add(file) 833 834 return pool 835 836 837def create_trace(): 838 parser = argparse.ArgumentParser() 839 parser.add_argument( 840 'trace_descriptor', type=str, help='location of trace descriptor') 841 args = parser.parse_args() 842 843 pool = create_pool(args) 844 ProtoTrace = get_message_class( 845 pool, pool.FindMessageTypeByName('perfetto.protos.Trace')) 846 847 class EnumPrototype(object): 848 849 def from_descriptor(desc): 850 res = EnumPrototype() 851 for desc in desc.values: 852 setattr(res, desc.name, desc.number) 853 return res 854 855 ChromeLatencyInfo = namedtuple('ChromeLatencyInfo', [ 856 'ComponentType', 857 'Step', 858 ]) 859 860 Prototypes = namedtuple('Prototypes', [ 861 'TrackEvent', 862 'ChromeRAILMode', 863 'ChromeLatencyInfo', 864 'ChromeProcessDescriptor', 865 'CounterDescriptor', 866 'ThreadDescriptor', 867 ]) 868 869 chrome_latency_info_prototypes = ChromeLatencyInfo( 870 ComponentType=EnumPrototype.from_descriptor( 871 pool.FindEnumTypeByName( 872 'perfetto.protos.ChromeLatencyInfo.LatencyComponentType')), 873 Step=EnumPrototype.from_descriptor( 874 pool.FindEnumTypeByName('perfetto.protos.ChromeLatencyInfo.Step')), 875 ) 876 877 prototypes = Prototypes( 878 TrackEvent=get_message_class( 879 pool, pool.FindMessageTypeByName('perfetto.protos.TrackEvent')), 880 ChromeRAILMode=EnumPrototype.from_descriptor( 881 pool.FindEnumTypeByName('perfetto.protos.ChromeRAILMode')), 882 ChromeLatencyInfo=chrome_latency_info_prototypes, 883 ChromeProcessDescriptor=get_message_class( 884 pool, 885 pool.FindMessageTypeByName( 886 'perfetto.protos.ChromeProcessDescriptor')), 887 CounterDescriptor=get_message_class( 888 pool, 889 pool.FindMessageTypeByName('perfetto.protos.CounterDescriptor')), 890 ThreadDescriptor=get_message_class( 891 pool, pool.FindMessageTypeByName('perfetto.protos.ThreadDescriptor')), 892 ) 893 return Trace(ProtoTrace(), prototypes) 894