1/* 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 */ 16 17syntax = "proto2"; 18 19package perfetto.protos; 20 21message ProcessStatsConfig { 22 enum Quirks { 23 QUIRKS_UNSPECIFIED = 0; 24 25 // This has been deprecated and ignored as per 2018-05-01. Full scan at 26 // startup is now disabled by default and can be re-enabled using the 27 // |scan_all_processes_on_start| arg. 28 DISABLE_INITIAL_DUMP = 1 [deprecated = true]; 29 30 DISABLE_ON_DEMAND = 2; 31 } 32 repeated Quirks quirks = 1; 33 34 // If enabled all processes will be scanned and dumped when the trace starts. 35 optional bool scan_all_processes_on_start = 2; 36 37 // If enabled thread names are also recoded (this is redundant if sched_switch 38 // is enabled). 39 optional bool record_thread_names = 3; 40 41 // If > 0 samples counters (see process_stats.proto) from 42 // /proc/pid/status and oom_score_adj every X ms. 43 // It will also sample /proc/pid/smaps_rollup if scan_smaps_rollup = true. 44 // This is required to be > 100ms to avoid excessive CPU usage. 45 optional uint32 proc_stats_poll_ms = 4; 46 47 // id 5 never used 48 49 // This is required to be either = 0 or a multiple of |proc_stats_poll_ms| 50 // (default: |proc_stats_poll_ms|). If = 0, will be set to 51 // |proc_stats_poll_ms|. Non-multiples will be rounded down to the nearest 52 // multiple. 53 optional uint32 proc_stats_cache_ttl_ms = 6; 54 55 // Niche feature: If true this will resolve file descriptors for each process 56 // so these can be mapped to their actual device or file. 57 // Requires raw_syscalls/sys_{enter,exit} ftrace events to be enabled or 58 // new fds opened after initially scanning a process will not be 59 // recognized. 60 optional bool resolve_process_fds = 9; 61 62 // If true, output will include memory stats from /proc/pid/smaps_rollup. 63 // 64 // Does NOT work with the Android system daemon by default, as it requires 65 // running the recording process (traced_probes or tracebox) as root. It is 66 // possible to avoid the root requirement, but the exact steps depend on the 67 // Linux distibution. The proc file requires passing a PTRACE_MODE_READ 68 // check, and might be further covered by the procfs "hidepid" mount option. 69 optional bool scan_smaps_rollup = 10; 70 71 // If true: process descriptions will include process age (starttime in 72 // /proc/pid/stat). 73 // Introduced in: perfetto v44. 74 optional bool record_process_age = 11; 75 76 // If true and |proc_stats_poll_ms| is true, process stats will include time 77 // spent running in user/kernel mode (utime/stime in /proc/pid/stat). 78 // Introduced in: perfetto v44. 79 optional bool record_process_runtime = 12; 80 81 // record_thread_time_in_state 82 reserved 7; 83 // thread_time_in_state_cache_size 84 reserved 8; 85} 86