1/* 2 * Copyright (C) 2017 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 21import "protos/perfetto/config/android/android_log_config.proto"; 22import "protos/perfetto/config/android/android_polled_state_config.proto"; 23import "protos/perfetto/config/android/packages_list_config.proto"; 24import "protos/perfetto/config/chrome/chrome_config.proto"; 25import "protos/perfetto/config/ftrace/ftrace_config.proto"; 26import "protos/perfetto/config/gpu/gpu_counter_config.proto"; 27import "protos/perfetto/config/gpu/vulkan_memory_config.proto"; 28import "protos/perfetto/config/inode_file/inode_file_config.proto"; 29import "protos/perfetto/config/interceptor_config.proto"; 30import "protos/perfetto/config/power/android_power_config.proto"; 31import "protos/perfetto/config/process_stats/process_stats_config.proto"; 32import "protos/perfetto/config/profiling/heapprofd_config.proto"; 33import "protos/perfetto/config/profiling/java_hprof_config.proto"; 34import "protos/perfetto/config/profiling/perf_event_config.proto"; 35import "protos/perfetto/config/sys_stats/sys_stats_config.proto"; 36import "protos/perfetto/config/test_config.proto"; 37import "protos/perfetto/config/track_event/track_event_config.proto"; 38 39// The configuration that is passed to each data source when starting tracing. 40// Next id: 116 41message DataSourceConfig { 42 enum SessionInitiator { 43 SESSION_INITIATOR_UNSPECIFIED = 0; 44 // This trace was initiated from a trusted system app has DUMP and 45 // USAGE_STATS permission. This system app is expected to not expose the 46 // trace to the user of the device. 47 // This is determined by checking the UID initiating the trace. 48 SESSION_INITIATOR_TRUSTED_SYSTEM = 1; 49 }; 50 // Data source unique name, e.g., "linux.ftrace". This must match 51 // the name passed by the data source when it registers (see 52 // RegisterDataSource()). 53 optional string name = 1; 54 55 // The index of the logging buffer where TracePacket(s) will be stored. 56 // This field doesn't make a major difference for the Producer(s). The final 57 // logging buffers, in fact, are completely owned by the Service. We just ask 58 // the Producer to copy this number into the chunk headers it emits, so that 59 // the Service can quickly identify the buffer where to move the chunks into 60 // without expensive lookups on its fastpath. 61 optional uint32 target_buffer = 2; 62 63 // Set by the service to indicate the duration of the trace. 64 // DO NOT SET in consumer as this will be overridden by the service. 65 optional uint32 trace_duration_ms = 3; 66 67 // Set by the service to indicate how long it waits after StopDataSource. 68 // DO NOT SET in consumer as this will be overridden by the service. 69 optional uint32 stop_timeout_ms = 7; 70 71 // Set by the service to indicate whether this tracing session has extra 72 // guardrails. 73 // DO NOT SET in consumer as this will be overridden by the service. 74 optional bool enable_extra_guardrails = 6; 75 76 // Set by the service to indicate which user initiated this trace. 77 // DO NOT SET in consumer as this will be overridden by the service. 78 optional SessionInitiator session_initiator = 8; 79 80 // Set by the service to indicate which tracing session the data source 81 // belongs to. The intended use case for this is checking if two data sources, 82 // one of which produces metadata for the other one, belong to the same trace 83 // session and hence should be linked together. 84 // This field was introduced in Aug 2018 after Android P. 85 // DO NOT SET in consumer as this will be overridden by the service. 86 optional uint64 tracing_session_id = 4; 87 88 // Keeep the lower IDs (up to 99) for fields that are *not* specific to 89 // data-sources and needs to be processed by the traced daemon. 90 91 // All data source config fields must be marked as [lazy=true]. This prevents 92 // the proto-to-cpp generator from recursing into those when generating the 93 // cpp classes and polluting tracing/core with data-source-specific classes. 94 // Instead they are treated as opaque strings containing raw proto bytes. 95 96 // Data source name: linux.ftrace 97 optional FtraceConfig ftrace_config = 100 [lazy = true]; 98 // Data source name: linux.inode_file_map 99 optional InodeFileConfig inode_file_config = 102 [lazy = true]; 100 // Data source name: linux.process_stats 101 optional ProcessStatsConfig process_stats_config = 103 [lazy = true]; 102 // Data source name: linux.sys_stats 103 optional SysStatsConfig sys_stats_config = 104 [lazy = true]; 104 // Data source name: android.heapprofd 105 // Introduced in Android 10. 106 optional HeapprofdConfig heapprofd_config = 105 [lazy = true]; 107 // Data source name: android.java_hprof 108 // Introduced in Android 11. 109 optional JavaHprofConfig java_hprof_config = 110 [lazy = true]; 110 // Data source name: android.power 111 optional AndroidPowerConfig android_power_config = 106 [lazy = true]; 112 // Data source name: android.log 113 optional AndroidLogConfig android_log_config = 107 [lazy = true]; 114 // TODO(fmayer): Add data source name for this. 115 optional GpuCounterConfig gpu_counter_config = 108 [lazy = true]; 116 // Data source name: android.packages_list 117 optional PackagesListConfig packages_list_config = 109 [lazy = true]; 118 // Data source name: linux.perf 119 optional PerfEventConfig perf_event_config = 111 [lazy = true]; 120 // Data source name: vulkan.memory_tracker 121 optional VulkanMemoryConfig vulkan_memory_config = 112 [lazy = true]; 122 // Data source name: track_event 123 optional TrackEventConfig track_event_config = 113 [lazy = true]; 124 // Data source name: android.polled_state 125 optional AndroidPolledStateConfig android_polled_state_config = 114 126 [lazy = true]; 127 128 // Chrome is special as it doesn't use the perfetto IPC layer. We want to 129 // avoid proto serialization and de-serialization there because that would 130 // just add extra hops on top of the Mojo ser/des. Instead we auto-generate a 131 // C++ class for it so it can pass around plain C++ objets. 132 optional ChromeConfig chrome_config = 101; 133 134 // If an interceptor is specified here, packets for this data source will be 135 // rerouted to the interceptor instead of the main trace buffer. This can be 136 // used, for example, to write trace data into ETW or for logging trace points 137 // to the console. 138 // 139 // Note that interceptors are only supported by data sources registered 140 // through the Perfetto SDK API. Data sources that don't use that API (e.g., 141 // traced_probes) may not support interception. 142 optional InterceptorConfig interceptor_config = 115; 143 144 // This is a fallback mechanism to send a free-form text config to the 145 // producer. In theory this should never be needed. All the code that 146 // is part of the platform (i.e. traced service) is supposed to *not* truncate 147 // the trace config proto and propagate unknown fields. However, if anything 148 // in the pipeline (client or backend) ends up breaking this forward compat 149 // plan, this field will become the escape hatch to allow future data sources 150 // to get some meaningful configuration. 151 optional string legacy_config = 1000; 152 153 // This field is only used for testing. 154 optional TestConfig for_testing = 1001; 155 156 // Was |for_testing|. Caused more problems then found. 157 reserved 268435455; 158} 159