1 /*
2 * Copyright (C) 2019 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/trace_processor/importers/proto/android_probes_module.h"
18
19 #include "perfetto/base/build_config.h"
20 #include "perfetto/ext/base/string_writer.h"
21 #include "perfetto/protozero/scattered_heap_buffer.h"
22 #include "src/trace_processor/importers/common/machine_tracker.h"
23 #include "src/trace_processor/importers/common/track_tracker.h"
24 #include "src/trace_processor/importers/proto/android_probes_parser.h"
25 #include "src/trace_processor/importers/proto/android_probes_tracker.h"
26 #include "src/trace_processor/importers/proto/packet_sequence_state_generation.h"
27 #include "src/trace_processor/sorter/trace_sorter.h"
28
29 #include "protos/perfetto/common/android_energy_consumer_descriptor.pbzero.h"
30 #include "protos/perfetto/config/trace_config.pbzero.h"
31 #include "protos/perfetto/trace/android/packages_list.pbzero.h"
32 #include "protos/perfetto/trace/power/android_energy_estimation_breakdown.pbzero.h"
33 #include "protos/perfetto/trace/power/android_entity_state_residency.pbzero.h"
34 #include "protos/perfetto/trace/power/power_rails.pbzero.h"
35 #include "protos/perfetto/trace/trace_packet.pbzero.h"
36
37 namespace perfetto {
38 namespace trace_processor {
39 namespace {
40
MapToFriendlyPowerRailName(base::StringView raw)41 const char* MapToFriendlyPowerRailName(base::StringView raw) {
42 if (raw == "S4M_VDD_CPUCL0") {
43 return "cpu.little";
44 } else if (raw == "S3M_VDD_CPUCL1") {
45 return "cpu.mid";
46 } else if (raw == "S2M_VDD_CPUCL2") {
47 return "cpu.big";
48 } else if (raw == "S5M_VDD_INT") {
49 return "system.fabric";
50 } else if (raw == "S10M_VDD_TPU" || raw == "S7M_VDD_TPU") {
51 return "tpu";
52 } else if (raw == "PPVAR_VSYS_PWR_DISP" || raw == "VSYS_PWR_DISPLAY") {
53 return "display";
54 } else if (raw == "VSYS_PWR_MODEM") {
55 return "modem";
56 } else if (raw == "S1M_VDD_MIF") {
57 return "memory.interface";
58 } else if (raw == "VSYS_PWR_WLAN_BT") {
59 return "wifi.bt";
60 } else if (raw == "L2S_VDD_AOC_RET") {
61 return "aoc.memory";
62 } else if (raw == "S9S_VDD_AOC") {
63 return "aoc.logic";
64 } else if (raw == "S5S_VDDQ_MEM") {
65 return "ddr.a";
66 } else if (raw == "S10S_VDD2L") {
67 return "ddr.b";
68 } else if (raw == "S4S_VDD2H_MEM") {
69 return "ddr.c";
70 } else if (raw == "S2S_VDD_G3D") {
71 return "gpu";
72 } else if (raw == "L9S_GNSS_CORE") {
73 return "gps";
74 } else if (raw == "VSYS_PWR_RFFE") {
75 return "radio.frontend";
76 }
77 return nullptr;
78 }
79
80 } // namespace
81
82 using perfetto::protos::pbzero::TracePacket;
83
AndroidProbesModule(TraceProcessorContext * context)84 AndroidProbesModule::AndroidProbesModule(TraceProcessorContext* context)
85 : parser_(context),
86 context_(context),
87 power_rail_raw_name_id_(context->storage->InternString("raw_name")),
88 power_rail_subsys_name_arg_id_(
89 context->storage->InternString("subsystem_name")) {
90 RegisterForField(TracePacket::kBatteryFieldNumber, context);
91 RegisterForField(TracePacket::kPowerRailsFieldNumber, context);
92 RegisterForField(TracePacket::kAndroidEnergyEstimationBreakdownFieldNumber,
93 context);
94 RegisterForField(TracePacket::kEntityStateResidencyFieldNumber, context);
95 RegisterForField(TracePacket::kAndroidLogFieldNumber, context);
96 RegisterForField(TracePacket::kPackagesListFieldNumber, context);
97 RegisterForField(TracePacket::kAndroidGameInterventionListFieldNumber,
98 context);
99 RegisterForField(TracePacket::kInitialDisplayStateFieldNumber, context);
100 RegisterForField(TracePacket::kAndroidSystemPropertyFieldNumber, context);
101 }
102
TokenizePacket(const protos::pbzero::TracePacket_Decoder &,TraceBlobView * packet,int64_t packet_timestamp,RefPtr<PacketSequenceStateGeneration> state,uint32_t field_id)103 ModuleResult AndroidProbesModule::TokenizePacket(
104 const protos::pbzero::TracePacket_Decoder&,
105 TraceBlobView* packet,
106 int64_t packet_timestamp,
107 RefPtr<PacketSequenceStateGeneration> state,
108 uint32_t field_id) {
109 protos::pbzero::TracePacket::Decoder decoder(packet->data(),
110 packet->length());
111
112 // The energy descriptor and packages list packets do not have a timestamp so
113 // need to be handled at the tokenization phase.
114 if (field_id == TracePacket::kAndroidEnergyEstimationBreakdownFieldNumber) {
115 return ParseEnergyDescriptor(decoder.android_energy_estimation_breakdown());
116 } else if (field_id == TracePacket::kPackagesListFieldNumber) {
117 return ParseAndroidPackagesList(decoder.packages_list());
118 } else if (field_id == TracePacket::kEntityStateResidencyFieldNumber) {
119 ParseEntityStateDescriptor(decoder.entity_state_residency());
120 // Ignore so that we get a go at parsing any actual residency data that
121 // should also be in the packet.
122 return ModuleResult::Ignored();
123 }
124
125 if (field_id != TracePacket::kPowerRailsFieldNumber) {
126 return ModuleResult::Ignored();
127 }
128
129 // Power rails are similar to ftrace in that they have many events, each with
130 // their own timestamp, packed inside a single TracePacket. This means that,
131 // similar to ftrace, we need to unpack them and individually sort them.
132
133 // However, as these events are not perf sensitive, it's not worth adding
134 // a lot of machinery to shepherd these events through the sorting queues
135 // in a special way. Therefore, we just forge new packets and sort them as if
136 // they came from the underlying trace.
137 auto power_rails = decoder.power_rails();
138 protos::pbzero::PowerRails::Decoder evt(power_rails.data, power_rails.size);
139
140 for (auto it = evt.rail_descriptor(); it; ++it) {
141 protos::pbzero::PowerRails::RailDescriptor::Decoder desc(*it);
142 uint32_t idx = desc.index();
143 if (PERFETTO_UNLIKELY(idx > 256)) {
144 PERFETTO_DLOG("Skipping excessively large power_rail index %" PRIu32,
145 idx);
146 continue;
147 }
148 base::StackString<255> counter_name("overwritten");
149 const char* friendly_name = MapToFriendlyPowerRailName(desc.rail_name());
150 if (friendly_name) {
151 counter_name = base::StackString<255>("power.rails.%s", friendly_name);
152 } else {
153 counter_name = base::StackString<255>(
154 "power.%s_uws", desc.rail_name().ToStdString().c_str());
155 }
156 StringId counter_name_id =
157 context_->storage->InternString(counter_name.string_view());
158 TrackId track = context_->track_tracker->InternGlobalCounterTrack(
159 TrackTracker::Group::kPower, counter_name_id,
160 [this, &desc](ArgsTracker::BoundInserter& inserter) {
161 StringId raw_name = context_->storage->InternString(desc.rail_name());
162 inserter.AddArg(power_rail_raw_name_id_, Variadic::String(raw_name));
163
164 StringId subsys_name =
165 context_->storage->InternString(desc.subsys_name());
166 inserter.AddArg(power_rail_subsys_name_arg_id_,
167 Variadic::String(subsys_name));
168 });
169 AndroidProbesTracker::GetOrCreate(context_)->SetPowerRailTrack(desc.index(),
170 track);
171 }
172
173 // For each energy data message, turn it into its own trace packet
174 // making sure its timestamp is consistent between the packet level and
175 // the EnergyData level.
176 for (auto it = evt.energy_data(); it; ++it) {
177 protozero::ConstBytes bytes = *it;
178 protos::pbzero::PowerRails_EnergyData_Decoder data(bytes.data, bytes.size);
179 int64_t actual_ts =
180 data.has_timestamp_ms()
181 ? static_cast<int64_t>(data.timestamp_ms()) * 1000000
182 : packet_timestamp;
183
184 protozero::HeapBuffered<protos::pbzero::TracePacket> data_packet;
185 // Keep the original timestamp to later extract as an arg; the sorter does
186 // not read this.
187 data_packet->set_timestamp(static_cast<uint64_t>(packet_timestamp));
188
189 auto* energy = data_packet->set_power_rails()->add_energy_data();
190 energy->set_energy(data.energy());
191 energy->set_index(data.index());
192 energy->set_timestamp_ms(static_cast<uint64_t>(actual_ts / 1000000));
193
194 std::vector<uint8_t> vec = data_packet.SerializeAsArray();
195 TraceBlob blob = TraceBlob::CopyFrom(vec.data(), vec.size());
196 context_->sorter->PushTracePacket(actual_ts, state,
197 TraceBlobView(std::move(blob)),
198 context_->machine_id());
199 }
200
201 return ModuleResult::Handled();
202 }
203
ParseTracePacketData(const TracePacket::Decoder & decoder,int64_t ts,const TracePacketData &,uint32_t field_id)204 void AndroidProbesModule::ParseTracePacketData(
205 const TracePacket::Decoder& decoder,
206 int64_t ts,
207 const TracePacketData&,
208 uint32_t field_id) {
209 switch (field_id) {
210 case TracePacket::kBatteryFieldNumber:
211 parser_.ParseBatteryCounters(ts, decoder.battery());
212 return;
213 case TracePacket::kPowerRailsFieldNumber:
214 parser_.ParsePowerRails(ts, decoder.timestamp(), decoder.power_rails());
215 return;
216 case TracePacket::kAndroidEnergyEstimationBreakdownFieldNumber:
217 parser_.ParseEnergyBreakdown(
218 ts, decoder.android_energy_estimation_breakdown());
219 return;
220 case TracePacket::kEntityStateResidencyFieldNumber:
221 parser_.ParseEntityStateResidency(ts, decoder.entity_state_residency());
222 return;
223 case TracePacket::kAndroidLogFieldNumber:
224 parser_.ParseAndroidLogPacket(decoder.android_log());
225 return;
226 case TracePacket::kAndroidGameInterventionListFieldNumber:
227 parser_.ParseAndroidGameIntervention(
228 decoder.android_game_intervention_list());
229 return;
230 case TracePacket::kInitialDisplayStateFieldNumber:
231 parser_.ParseInitialDisplayState(ts, decoder.initial_display_state());
232 return;
233 case TracePacket::kAndroidSystemPropertyFieldNumber:
234 parser_.ParseAndroidSystemProperty(ts, decoder.android_system_property());
235 return;
236 }
237 }
238
ParseTraceConfig(const protos::pbzero::TraceConfig::Decoder & decoder)239 void AndroidProbesModule::ParseTraceConfig(
240 const protos::pbzero::TraceConfig::Decoder& decoder) {
241 if (decoder.has_statsd_metadata()) {
242 parser_.ParseStatsdMetadata(decoder.statsd_metadata());
243 }
244 }
245
ParseEnergyDescriptor(protozero::ConstBytes blob)246 ModuleResult AndroidProbesModule::ParseEnergyDescriptor(
247 protozero::ConstBytes blob) {
248 protos::pbzero::AndroidEnergyEstimationBreakdown::Decoder event(blob);
249 if (!event.has_energy_consumer_descriptor())
250 return ModuleResult::Ignored();
251
252 protos::pbzero::AndroidEnergyConsumerDescriptor::Decoder descriptor(
253 event.energy_consumer_descriptor());
254
255 for (auto it = descriptor.energy_consumers(); it; ++it) {
256 protos::pbzero::AndroidEnergyConsumer::Decoder consumer(*it);
257
258 if (!consumer.has_energy_consumer_id()) {
259 context_->storage->IncrementStats(stats::energy_descriptor_invalid);
260 continue;
261 }
262
263 AndroidProbesTracker::GetOrCreate(context_)->SetEnergyBreakdownDescriptor(
264 consumer.energy_consumer_id(),
265 context_->storage->InternString(consumer.name()),
266 context_->storage->InternString(consumer.type()), consumer.ordinal());
267 }
268 return ModuleResult::Handled();
269 }
270
ParseAndroidPackagesList(protozero::ConstBytes blob)271 ModuleResult AndroidProbesModule::ParseAndroidPackagesList(
272 protozero::ConstBytes blob) {
273 protos::pbzero::PackagesList::Decoder pkg_list(blob.data, blob.size);
274 context_->storage->SetStats(stats::packages_list_has_read_errors,
275 pkg_list.read_error());
276 context_->storage->SetStats(stats::packages_list_has_parse_errors,
277 pkg_list.parse_error());
278
279 AndroidProbesTracker* tracker = AndroidProbesTracker::GetOrCreate(context_);
280 for (auto it = pkg_list.packages(); it; ++it) {
281 protos::pbzero::PackagesList_PackageInfo::Decoder pkg(*it);
282 std::string pkg_name = pkg.name().ToStdString();
283 if (!tracker->ShouldInsertPackage(pkg_name)) {
284 continue;
285 }
286 context_->storage->mutable_package_list_table()->Insert(
287 {context_->storage->InternString(pkg.name()),
288 static_cast<int64_t>(pkg.uid()), pkg.debuggable(),
289 pkg.profileable_from_shell(),
290 static_cast<int64_t>(pkg.version_code())});
291 tracker->InsertedPackage(std::move(pkg_name));
292 }
293 return ModuleResult::Handled();
294 }
295
ParseEntityStateDescriptor(protozero::ConstBytes blob)296 void AndroidProbesModule::ParseEntityStateDescriptor(
297 protozero::ConstBytes blob) {
298 protos::pbzero::EntityStateResidency::Decoder event(blob);
299 if (!event.has_power_entity_state())
300 return;
301
302 for (auto it = event.power_entity_state(); it; ++it) {
303 protos::pbzero::EntityStateResidency::PowerEntityState::Decoder
304 entity_state(*it);
305
306 if (!entity_state.has_entity_index() || !entity_state.has_state_index()) {
307 context_->storage->IncrementStats(stats::energy_descriptor_invalid);
308 continue;
309 }
310
311 AndroidProbesTracker::GetOrCreate(context_)->SetEntityStateDescriptor(
312 entity_state.entity_index(), entity_state.state_index(),
313 context_->storage->InternString(entity_state.entity_name()),
314 context_->storage->InternString(entity_state.state_name()));
315 }
316 }
317
318 } // namespace trace_processor
319 } // namespace perfetto
320