• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
33  repeated Quirks quirks = 1;
34
35  // If enabled all processes will be scanned and dumped when the trace starts.
36  optional bool scan_all_processes_on_start = 2;
37
38  // If enabled thread names are also recoded (this is redundant if sched_switch
39  // is enabled).
40  optional bool record_thread_names = 3;
41
42  // If > 0 samples counters (see process_stats.proto) from
43  // /proc/pid/status and oom_score_adj every X ms.
44  // It will also sample /proc/pid/smaps_rollup if scan_smaps_rollup = true.
45  // This is required to be > 100ms to avoid excessive CPU usage.
46  // TODO(primiano): add CPU cost for change this value.
47  optional uint32 proc_stats_poll_ms = 4;
48
49  // If empty samples stats for all processes. If non empty samples stats only
50  // for processes matching the given string in their argv0 (i.e. the first
51  // entry of /proc/pid/cmdline).
52  // TODO(primiano): implement this feature.
53  // repeated string proc_stats_filter = 5;
54
55  // This is required to be either = 0 or a multiple of |proc_stats_poll_ms|
56  // (default: |proc_stats_poll_ms|). If = 0, will be set to
57  // |proc_stats_poll_ms|. Non-multiples will be rounded down to the nearest
58  // multiple.
59  optional uint32 proc_stats_cache_ttl_ms = 6;
60
61  // DEPRECATED record_thread_time_in_state
62  reserved 7;
63
64  // DEPRECATED thread_time_in_state_cache_size
65  reserved 8;
66
67  // If true this will resolve filedescriptors for each process so these
68  // can be mapped to their actual device or file.
69  // Requires raw_syscalls/sys_exit ftrace events to be enabled or
70  // new fds opened after initially scanning a process will not be
71  // recognized.
72  optional bool resolve_process_fds = 9;
73
74  // If enabled memory stats from /proc/pid/smaps_rollup will be included
75  // in process stats.
76  optional bool scan_smaps_rollup = 10;
77}
78