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/proto/android_probes_parser.h"
23 #include "src/trace_processor/importers/proto/android_probes_tracker.h"
24 #include "src/trace_processor/timestamped_trace_piece.h"
25 #include "src/trace_processor/trace_sorter.h"
26
27 #include "protos/perfetto/config/trace_config.pbzero.h"
28 #include "protos/perfetto/trace/power/power_rails.pbzero.h"
29 #include "protos/perfetto/trace/trace_packet.pbzero.h"
30
31 namespace perfetto {
32 namespace trace_processor {
33 namespace {
34
MapToFriendlyPowerRailName(base::StringView raw)35 const char* MapToFriendlyPowerRailName(base::StringView raw) {
36 if (raw == "S4M_VDD_CPUCL0") {
37 return "cpu.little";
38 } else if (raw == "S3M_VDD_CPUCL1") {
39 return "cpu.mid";
40 } else if (raw == "S2M_VDD_CPUCL2") {
41 return "cpu.big";
42 } else if (raw == "S5M_VDD_INT") {
43 return "system.fabric";
44 } else if (raw == "S10M_VDD_TPU") {
45 return "tpu";
46 } else if (raw == "PPVAR_VSYS_PWR_DISP" || raw == "VSYS_PWR_DISPLAY") {
47 return "display";
48 } else if (raw == "VSYS_PWR_MODEM") {
49 return "modem";
50 } else if (raw == "S1M_VDD_MIF") {
51 return "memory.interface";
52 } else if (raw == "VSYS_PWR_WLAN_BT") {
53 return "wifi.bt";
54 } else if (raw == "L2S_VDD_AOC_RET") {
55 return "aoc.memory";
56 } else if (raw == "S9S_VDD_AOC") {
57 return "aoc.logic";
58 } else if (raw == "S5S_VDDQ_MEM") {
59 return "ddr.a";
60 } else if (raw == "S10S_VDD2L") {
61 return "ddr.b";
62 } else if (raw == "S4S_VDD2H_MEM") {
63 return "ddr.c";
64 } else if (raw == "S2S_VDD_G3D") {
65 return "gpu";
66 } else if (raw == "L9S_GNSS_CORE") {
67 return "gps";
68 } else if (raw == "VSYS_PWR_RFFE") {
69 return "radio.frontend";
70 }
71 return nullptr;
72 }
73
74 } // namespace
75
76 using perfetto::protos::pbzero::TracePacket;
77
AndroidProbesModule(TraceProcessorContext * context)78 AndroidProbesModule::AndroidProbesModule(TraceProcessorContext* context)
79 : parser_(context), context_(context) {
80 RegisterForField(TracePacket::kBatteryFieldNumber, context);
81 RegisterForField(TracePacket::kPowerRailsFieldNumber, context);
82 RegisterForField(TracePacket::kAndroidLogFieldNumber, context);
83 RegisterForField(TracePacket::kPackagesListFieldNumber, context);
84 RegisterForField(TracePacket::kInitialDisplayStateFieldNumber, context);
85 }
86
TokenizePacket(const protos::pbzero::TracePacket_Decoder &,TraceBlobView * packet,int64_t packet_timestamp,PacketSequenceState * state,uint32_t field_id)87 ModuleResult AndroidProbesModule::TokenizePacket(
88 const protos::pbzero::TracePacket_Decoder&,
89 TraceBlobView* packet,
90 int64_t packet_timestamp,
91 PacketSequenceState* state,
92 uint32_t field_id) {
93 if (field_id != TracePacket::kPowerRailsFieldNumber)
94 return ModuleResult::Ignored();
95
96 // Power rails are similar to ftrace in that they have many events, each with
97 // their own timestamp, packed inside a single TracePacket. This means that,
98 // similar to ftrace, we need to unpack them and individually sort them.
99
100 // However, as these events are not perf sensitive, it's not worth adding
101 // a lot of machinery to shepherd these events through the sorting queues
102 // in a special way. Therefore, we just forge new packets and sort them as if
103 // they came from the underlying trace.
104
105 protos::pbzero::TracePacket::Decoder decoder(packet->data(),
106 packet->length());
107 auto power_rails = decoder.power_rails();
108 protos::pbzero::PowerRails::Decoder evt(power_rails.data, power_rails.size);
109
110 for (auto it = evt.rail_descriptor(); it; ++it) {
111 protos::pbzero::PowerRails::RailDescriptor::Decoder desc(*it);
112 uint32_t idx = desc.index();
113 if (PERFETTO_UNLIKELY(idx > 256)) {
114 PERFETTO_DLOG("Skipping excessively large power_rail index %" PRIu32,
115 idx);
116 continue;
117 }
118 char counter_name[255];
119 base::StringWriter writer(counter_name, base::ArraySize(counter_name));
120 const char* friendly_name = MapToFriendlyPowerRailName(desc.rail_name());
121 if (friendly_name) {
122 writer.AppendStringView("power.rails.");
123 writer.AppendStringView(friendly_name);
124 } else {
125 writer.AppendStringView("power.");
126 writer.AppendStringView(desc.rail_name());
127 writer.AppendStringView("_uws");
128 }
129 AndroidProbesTracker::GetOrCreate(context_)->SetPowerRailName(
130 desc.index(), context_->storage->InternString(writer.GetStringView()));
131 }
132
133 // For each energy data message, turn it into its own trace packet
134 // making sure its timestamp is consistent between the packet level and
135 // the EnergyData level.
136 for (auto it = evt.energy_data(); it; ++it) {
137 protozero::ConstBytes bytes = *it;
138 protos::pbzero::PowerRails_EnergyData_Decoder data(bytes.data, bytes.size);
139 int64_t actual_ts =
140 data.has_timestamp_ms()
141 ? static_cast<int64_t>(data.timestamp_ms()) * 1000000
142 : packet_timestamp;
143
144 protozero::HeapBuffered<protos::pbzero::TracePacket> data_packet;
145 data_packet->set_timestamp(static_cast<uint64_t>(actual_ts));
146
147 auto* energy = data_packet->set_power_rails()->add_energy_data();
148 energy->set_energy(data.energy());
149 energy->set_index(data.index());
150 energy->set_timestamp_ms(static_cast<uint64_t>(actual_ts / 1000000));
151
152 std::vector<uint8_t> vec = data_packet.SerializeAsArray();
153 TraceBlob blob = TraceBlob::CopyFrom(vec.data(), vec.size());
154 context_->sorter->PushTracePacket(actual_ts, state,
155 TraceBlobView(std::move(blob)));
156 }
157
158 return ModuleResult::Handled();
159 }
160
ParsePacket(const TracePacket::Decoder & decoder,const TimestampedTracePiece & ttp,uint32_t field_id)161 void AndroidProbesModule::ParsePacket(const TracePacket::Decoder& decoder,
162 const TimestampedTracePiece& ttp,
163 uint32_t field_id) {
164 switch (field_id) {
165 case TracePacket::kBatteryFieldNumber:
166 parser_.ParseBatteryCounters(ttp.timestamp, decoder.battery());
167 return;
168 case TracePacket::kPowerRailsFieldNumber:
169 parser_.ParsePowerRails(ttp.timestamp, decoder.power_rails());
170 return;
171 case TracePacket::kAndroidLogFieldNumber:
172 parser_.ParseAndroidLogPacket(decoder.android_log());
173 return;
174 case TracePacket::kPackagesListFieldNumber:
175 parser_.ParseAndroidPackagesList(decoder.packages_list());
176 return;
177 case TracePacket::kInitialDisplayStateFieldNumber:
178 parser_.ParseInitialDisplayState(ttp.timestamp,
179 decoder.initial_display_state());
180 return;
181 }
182 }
183
ParseTraceConfig(const protos::pbzero::TraceConfig::Decoder & decoder)184 void AndroidProbesModule::ParseTraceConfig(
185 const protos::pbzero::TraceConfig::Decoder& decoder) {
186 if (decoder.has_statsd_metadata()) {
187 parser_.ParseStatsdMetadata(decoder.statsd_metadata());
188 }
189 }
190
191 } // namespace trace_processor
192 } // namespace perfetto
193