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
17 #include "src/perfetto_cmd/config.h"
18
19 #include <stdlib.h>
20
21 #include "perfetto/base/logging.h"
22 #include "perfetto/ext/base/string_utils.h"
23 #include "perfetto/tracing/core/data_source_config.h"
24 #include "perfetto/tracing/core/trace_config.h"
25
26 #include "protos/perfetto/config/ftrace/ftrace_config.gen.h"
27 #include "protos/perfetto/config/sys_stats/sys_stats_config.gen.h"
28
29 namespace perfetto {
30 namespace {
31 using ValueUnit = std::pair<uint64_t, std::string>;
32 using UnitMultipler = std::pair<const char*, uint64_t>;
33
SplitValueAndUnit(const std::string & arg,ValueUnit * out)34 bool SplitValueAndUnit(const std::string& arg, ValueUnit* out) {
35 char* end;
36 if (arg.empty())
37 return false;
38 out->first = strtoull(arg.c_str(), &end, 10);
39 if (end == arg.data())
40 return false;
41 std::string unit = arg.substr(static_cast<size_t>(end - arg.data()));
42 out->second = std::move(unit);
43 return true;
44 }
45
ConvertValue(const std::string & arg,std::vector<UnitMultipler> units,uint64_t * out)46 bool ConvertValue(const std::string& arg,
47 std::vector<UnitMultipler> units,
48 uint64_t* out) {
49 if (arg.empty()) {
50 *out = 0;
51 return true;
52 }
53
54 if (arg == "0") {
55 *out = 0;
56 return true;
57 }
58
59 ValueUnit value_unit{};
60 if (!SplitValueAndUnit(arg, &value_unit))
61 return false;
62
63 for (const auto& unit_multiplier : units) {
64 if (value_unit.second != unit_multiplier.first)
65 continue;
66 *out = value_unit.first * unit_multiplier.second;
67 return true;
68 }
69 return false;
70 }
71
ConvertTimeToMs(const std::string & arg,uint64_t * out)72 bool ConvertTimeToMs(const std::string& arg, uint64_t* out) {
73 return ConvertValue(arg,
74 {
75 {"ms", 1},
76 {"s", 1000},
77 {"m", 1000 * 60},
78 {"h", 1000 * 60 * 60},
79 },
80 out);
81 }
82
ConvertSizeToKb(const std::string & arg,uint64_t * out)83 bool ConvertSizeToKb(const std::string& arg, uint64_t* out) {
84 return ConvertValue(arg,
85 {
86 {"kb", 1},
87 {"mb", 1024},
88 {"gb", 1024 * 1024},
89 {"k", 1},
90 {"m", 1024},
91 {"g", 1024 * 1024},
92 },
93 out);
94 }
95
96 } // namespace
97
CreateConfigFromOptions(const ConfigOptions & options,TraceConfig * config)98 bool CreateConfigFromOptions(const ConfigOptions& options,
99 TraceConfig* config) {
100 uint64_t duration_ms = 0;
101 if (!ConvertTimeToMs(options.time, &duration_ms)) {
102 PERFETTO_ELOG("--time argument is invalid");
103 return false;
104 }
105
106 uint64_t buffer_size_kb = 0;
107 if (!ConvertSizeToKb(options.buffer_size, &buffer_size_kb)) {
108 PERFETTO_ELOG("--buffer argument is invalid");
109 return false;
110 }
111
112 uint64_t max_file_size_kb = 0;
113 if (!ConvertSizeToKb(options.max_file_size, &max_file_size_kb)) {
114 PERFETTO_ELOG("--size argument is invalid");
115 return false;
116 }
117
118 std::vector<std::string> ftrace_events;
119 std::vector<std::string> atrace_categories;
120 std::vector<std::string> atrace_apps = options.atrace_apps;
121 bool has_hyp_category = false;
122
123 for (const auto& category : options.categories) {
124 if (base::Contains(category, '/')) {
125 ftrace_events.push_back(category);
126 } else if (category == "hyp") {
127 has_hyp_category = true;
128 } else {
129 atrace_categories.push_back(category);
130 }
131
132 // For the gfx category, also add the frame timeline data source
133 // as it's very useful for debugging gfx issues.
134 if (category == "gfx") {
135 auto* frame_timeline = config->add_data_sources();
136 frame_timeline->mutable_config()->set_name(
137 "android.surfaceflinger.frametimeline");
138 }
139
140 // For the disk category, add the diskstat data source
141 // to figure out disk io statistics.
142 if (category == "disk") {
143 protos::gen::SysStatsConfig cfg;
144 cfg.set_diskstat_period_ms(1000);
145
146 auto* sys_stats_ds = config->add_data_sources();
147 sys_stats_ds->mutable_config()->set_name("linux.sys_stats");
148 sys_stats_ds->mutable_config()->set_sys_stats_config_raw(
149 cfg.SerializeAsString());
150 }
151 }
152
153 config->set_duration_ms(static_cast<unsigned int>(duration_ms));
154 config->set_max_file_size_bytes(max_file_size_kb * 1024);
155 config->set_flush_period_ms(30 * 1000);
156 if (max_file_size_kb)
157 config->set_write_into_file(true);
158 config->add_buffers()->set_size_kb(static_cast<unsigned int>(buffer_size_kb));
159
160 if (!ftrace_events.empty() || !atrace_categories.empty() ||
161 !atrace_apps.empty()) {
162 auto* ds_config = config->add_data_sources()->mutable_config();
163 ds_config->set_name("linux.ftrace");
164 protos::gen::FtraceConfig ftrace_cfg;
165 for (const auto& evt : ftrace_events)
166 ftrace_cfg.add_ftrace_events(evt);
167 for (const auto& cat : atrace_categories)
168 ftrace_cfg.add_atrace_categories(cat);
169 for (const auto& app : atrace_apps)
170 ftrace_cfg.add_atrace_apps(app);
171 ftrace_cfg.set_symbolize_ksyms(true);
172 ds_config->set_ftrace_config_raw(ftrace_cfg.SerializeAsString());
173 }
174
175 // pKVM hypervisor events are coming from a separate special instance called
176 // "hyp", we need a separate config for it.
177 if (has_hyp_category) {
178 auto* ds_config = config->add_data_sources()->mutable_config();
179 ds_config->set_name("linux.ftrace");
180 protos::gen::FtraceConfig ftrace_cfg;
181 ftrace_cfg.set_instance_name("hyp");
182 // Collect all known hypervisor traces.
183 ftrace_cfg.add_ftrace_events("hyp/*");
184 ds_config->set_ftrace_config_raw(ftrace_cfg.SerializeAsString());
185 }
186
187 auto* ps_config = config->add_data_sources()->mutable_config();
188 ps_config->set_name("linux.process_stats");
189 ps_config->set_target_buffer(0);
190
191 auto* sysinfo_config = config->add_data_sources()->mutable_config();
192 sysinfo_config->set_name("linux.system_info");
193 sysinfo_config->set_target_buffer(0);
194
195 return true;
196 }
197
198 } // namespace perfetto
199