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