1 /*
2 * Copyright (C) 2021 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/metadata_module.h"
18
19 #include <cstdint>
20 #include <string>
21
22 #include "perfetto/ext/base/base64.h"
23 #include "perfetto/ext/base/string_view.h"
24 #include "perfetto/ext/base/uuid.h"
25 #include "perfetto/trace_processor/ref_counted.h"
26 #include "src/trace_processor/importers/common/flow_tracker.h"
27 #include "src/trace_processor/importers/common/metadata_tracker.h"
28 #include "src/trace_processor/importers/common/parser_types.h"
29 #include "src/trace_processor/importers/common/slice_tracker.h"
30 #include "src/trace_processor/importers/common/track_tracker.h"
31 #include "src/trace_processor/importers/common/tracks.h"
32 #include "src/trace_processor/importers/proto/packet_sequence_state_generation.h"
33 #include "src/trace_processor/importers/proto/proto_importer_module.h"
34 #include "src/trace_processor/storage/metadata.h"
35 #include "src/trace_processor/storage/trace_storage.h"
36 #include "src/trace_processor/types/variadic.h"
37 #include "src/trace_processor/util/descriptors.h"
38 #include "src/trace_processor/util/protozero_to_text.h"
39
40 #include "protos/perfetto/config/trace_config.pbzero.h"
41 #include "protos/perfetto/trace/chrome/chrome_trigger.pbzero.h"
42 #include "protos/perfetto/trace/trace_packet.pbzero.h"
43 #include "protos/perfetto/trace/trace_uuid.pbzero.h"
44 #include "protos/perfetto/trace/trigger.pbzero.h"
45
46 namespace perfetto::trace_processor {
47
48 namespace {
49
50 using perfetto::protos::pbzero::TracePacket;
51
52 constexpr auto kTriggerTrackBlueprint =
53 tracks::SliceBlueprint("triggers",
54 tracks::DimensionBlueprints(),
55 tracks::StaticNameBlueprint("Trace Triggers"));
56
57 } // namespace
58
MetadataModule(TraceProcessorContext * context)59 MetadataModule::MetadataModule(TraceProcessorContext* context)
60 : context_(context),
61 producer_name_key_id_(context_->storage->InternString("producer_name")),
62 trusted_producer_uid_key_id_(
63 context_->storage->InternString("trusted_producer_uid")),
64 chrome_trigger_name_id_(
65 context_->storage->InternString("chrome_trigger.name")),
66 chrome_trigger_hash_id_(
67 context_->storage->InternString("chrome_trigger.name_hash")) {
68 RegisterForField(TracePacket::kUiStateFieldNumber, context);
69 RegisterForField(TracePacket::kTriggerFieldNumber, context);
70 RegisterForField(TracePacket::kChromeTriggerFieldNumber, context);
71 RegisterForField(TracePacket::kCloneSnapshotTriggerFieldNumber, context);
72 RegisterForField(TracePacket::kTraceUuidFieldNumber, context);
73 }
74
TokenizePacket(const protos::pbzero::TracePacket::Decoder & decoder,TraceBlobView *,int64_t,RefPtr<PacketSequenceStateGeneration>,uint32_t field_id)75 ModuleResult MetadataModule::TokenizePacket(
76 const protos::pbzero::TracePacket::Decoder& decoder,
77 TraceBlobView*,
78 int64_t,
79 RefPtr<PacketSequenceStateGeneration>,
80 uint32_t field_id) {
81 switch (field_id) {
82 case TracePacket::kUiStateFieldNumber: {
83 auto ui_state = decoder.ui_state();
84 std::string base64 = base::Base64Encode(ui_state.data, ui_state.size);
85 StringId id = context_->storage->InternString(base::StringView(base64));
86 context_->metadata_tracker->SetMetadata(metadata::ui_state,
87 Variadic::String(id));
88 return ModuleResult::Handled();
89 }
90 case TracePacket::kTraceUuidFieldNumber: {
91 // If both the TraceUuid packet and TraceConfig.trace_uuid_msb/lsb are
92 // set, the former (which is emitted first) takes precedence. This is
93 // because the UUID can change throughout the lifecycle of a tracing
94 // session if gap-less snapshots are used. Each trace file has at most one
95 // TraceUuid packet (i has if it comes from an older version of the
96 // tracing service < v32)
97 protos::pbzero::TraceUuid::Decoder uuid_packet(decoder.trace_uuid());
98 if (uuid_packet.msb() != 0 || uuid_packet.lsb() != 0) {
99 base::Uuid uuid(uuid_packet.lsb(), uuid_packet.msb());
100 std::string str = uuid.ToPrettyString();
101 StringId id = context_->storage->InternString(base::StringView(str));
102 context_->metadata_tracker->SetMetadata(metadata::trace_uuid,
103 Variadic::String(id));
104 context_->uuid_found_in_trace = true;
105 }
106 return ModuleResult::Handled();
107 }
108 }
109 return ModuleResult::Ignored();
110 }
111
ParseTracePacketData(const protos::pbzero::TracePacket::Decoder & decoder,int64_t ts,const TracePacketData &,uint32_t field_id)112 void MetadataModule::ParseTracePacketData(
113 const protos::pbzero::TracePacket::Decoder& decoder,
114 int64_t ts,
115 const TracePacketData&,
116 uint32_t field_id) {
117 // We handle triggers at parse time rather at tokenization because
118 // we add slices to tables which need to happen post-sorting.
119 if (field_id == TracePacket::kTriggerFieldNumber) {
120 ParseTrigger(ts, decoder.trigger(), TraceTriggerPacketType::kTraceTrigger);
121 }
122 if (field_id == TracePacket::kChromeTriggerFieldNumber) {
123 ParseChromeTrigger(ts, decoder.chrome_trigger());
124 }
125 if (field_id == TracePacket::kCloneSnapshotTriggerFieldNumber) {
126 ParseTrigger(ts, decoder.clone_snapshot_trigger(),
127 TraceTriggerPacketType::kCloneSnapshot);
128 }
129 }
130
ParseTrigger(int64_t ts,ConstBytes blob,TraceTriggerPacketType packetType)131 void MetadataModule::ParseTrigger(int64_t ts,
132 ConstBytes blob,
133 TraceTriggerPacketType packetType) {
134 protos::pbzero::Trigger::Decoder trigger(blob.data, blob.size);
135 StringId cat_id = kNullStringId;
136 TrackId track_id =
137 context_->track_tracker->InternTrack(kTriggerTrackBlueprint);
138 StringId name_id = context_->storage->InternString(trigger.trigger_name());
139 context_->slice_tracker->Scoped(
140 ts, track_id, cat_id, name_id,
141 /* duration = */ 0,
142 [&trigger, this](ArgsTracker::BoundInserter* args_table) {
143 StringId producer_name =
144 context_->storage->InternString(trigger.producer_name());
145 if (!producer_name.is_null()) {
146 args_table->AddArg(producer_name_key_id_,
147 Variadic::String(producer_name));
148 }
149 if (trigger.has_trusted_producer_uid()) {
150 args_table->AddArg(trusted_producer_uid_key_id_,
151 Variadic::Integer(trigger.trusted_producer_uid()));
152 }
153 });
154
155 if (packetType == TraceTriggerPacketType::kCloneSnapshot &&
156 trace_trigger_packet_type_ != TraceTriggerPacketType::kCloneSnapshot) {
157 trace_trigger_packet_type_ = TraceTriggerPacketType::kCloneSnapshot;
158 context_->metadata_tracker->SetMetadata(metadata::trace_trigger,
159 Variadic::String(name_id));
160 } else if (packetType == TraceTriggerPacketType::kTraceTrigger &&
161 trace_trigger_packet_type_ == TraceTriggerPacketType::kNone) {
162 trace_trigger_packet_type_ = TraceTriggerPacketType::kTraceTrigger;
163 context_->metadata_tracker->SetMetadata(metadata::trace_trigger,
164 Variadic::String(name_id));
165 }
166 }
167
ParseChromeTrigger(int64_t ts,ConstBytes blob)168 void MetadataModule::ParseChromeTrigger(int64_t ts, ConstBytes blob) {
169 protos::pbzero::ChromeTrigger::Decoder trigger(blob);
170 StringId cat_id = kNullStringId;
171 TrackId track_id =
172 context_->track_tracker->InternTrack(kTriggerTrackBlueprint);
173 StringId name_id;
174 if (trigger.has_trigger_name()) {
175 name_id = context_->storage->InternString(trigger.trigger_name());
176 } else {
177 name_id =
178 context_->storage->InternString(base::StringView("chrome_trigger"));
179 }
180 auto slice_id = context_->slice_tracker->Scoped(
181 ts, track_id, cat_id, name_id,
182 /* duration = */ 0, [&](ArgsTracker::BoundInserter* inserter) {
183 inserter->AddArg(
184 chrome_trigger_hash_id_,
185 Variadic::UnsignedInteger(trigger.trigger_name_hash()));
186 if (trigger.has_trigger_name()) {
187 inserter->AddArg(chrome_trigger_name_id_, Variadic::String(name_id));
188 }
189 });
190 if (slice_id && trigger.has_flow_id() &&
191 context_->flow_tracker->IsActive(trigger.flow_id())) {
192 context_->flow_tracker->End(*slice_id, trigger.flow_id(),
193 /* close_flow = */ true);
194 }
195
196 MetadataTracker* metadata = context_->metadata_tracker.get();
197 metadata->SetDynamicMetadata(
198 context_->storage->InternString("cr-triggered_rule_name_hash"),
199 Variadic::Integer(trigger.trigger_name_hash()));
200 }
201
ParseTraceUuid(ConstBytes blob)202 void MetadataModule::ParseTraceUuid(ConstBytes blob) {
203 // If both the TraceUuid packet and TraceConfig.trace_uuid_msb/lsb are set,
204 // the former (which is emitted first) takes precedence. This is because the
205 // UUID can change throughout the lifecycle of a tracing session if gap-less
206 // snapshots are used. Each trace file has at most one TraceUuid packet (i
207 // has if it comes from an older version of the tracing service < v32)
208 protos::pbzero::TraceUuid::Decoder uuid_packet(blob.data, blob.size);
209 if (uuid_packet.msb() != 0 || uuid_packet.lsb() != 0) {
210 base::Uuid uuid(uuid_packet.lsb(), uuid_packet.msb());
211 std::string str = uuid.ToPrettyString();
212 StringId id = context_->storage->InternString(base::StringView(str));
213 context_->metadata_tracker->SetMetadata(metadata::trace_uuid,
214 Variadic::String(id));
215 context_->uuid_found_in_trace = true;
216 }
217 }
218
ParseTraceConfig(const protos::pbzero::TraceConfig_Decoder & trace_config)219 void MetadataModule::ParseTraceConfig(
220 const protos::pbzero::TraceConfig_Decoder& trace_config) {
221 int64_t uuid_msb = trace_config.trace_uuid_msb();
222 int64_t uuid_lsb = trace_config.trace_uuid_lsb();
223 if (!context_->uuid_found_in_trace && (uuid_msb != 0 || uuid_lsb != 0)) {
224 base::Uuid uuid(uuid_lsb, uuid_msb);
225 std::string str = uuid.ToPrettyString();
226 StringId id = context_->storage->InternString(base::StringView(str));
227 context_->metadata_tracker->SetMetadata(metadata::trace_uuid,
228 Variadic::String(id));
229 context_->uuid_found_in_trace = true;
230 }
231
232 if (trace_config.has_unique_session_name()) {
233 StringId id = context_->storage->InternString(
234 base::StringView(trace_config.unique_session_name()));
235 context_->metadata_tracker->SetMetadata(metadata::unique_session_name,
236 Variadic::String(id));
237 }
238
239 std::string text = protozero_to_text::ProtozeroToText(
240 *context_->descriptor_pool_, ".perfetto.protos.TraceConfig",
241 protozero::ConstBytes{
242 trace_config.begin(),
243 static_cast<uint32_t>(trace_config.end() - trace_config.begin())},
244 protozero_to_text::kIncludeNewLines);
245 StringId id = context_->storage->InternString(base::StringView(text));
246 context_->metadata_tracker->SetMetadata(metadata::trace_config_pbtxt,
247 Variadic::String(id));
248 }
249
250 } // namespace perfetto::trace_processor
251