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/config.descriptor.h"
33 #include "src/trace_processor/importers/proto/packet_sequence_state_generation.h"
34 #include "src/trace_processor/importers/proto/proto_importer_module.h"
35 #include "src/trace_processor/storage/metadata.h"
36 #include "src/trace_processor/storage/trace_storage.h"
37 #include "src/trace_processor/types/variadic.h"
38 #include "src/trace_processor/util/descriptors.h"
39 #include "src/trace_processor/util/protozero_to_text.h"
40
41 #include "protos/perfetto/config/trace_config.pbzero.h"
42 #include "protos/perfetto/trace/chrome/chrome_trigger.pbzero.h"
43 #include "protos/perfetto/trace/trace_packet.pbzero.h"
44 #include "protos/perfetto/trace/trace_uuid.pbzero.h"
45 #include "protos/perfetto/trace/trigger.pbzero.h"
46
47 namespace perfetto::trace_processor {
48
49 namespace {
50
51 using perfetto::protos::pbzero::TracePacket;
52
53 constexpr auto kTriggerTrackBlueprint =
54 tracks::SliceBlueprint("triggers",
55 tracks::DimensionBlueprints(),
56 tracks::StaticNameBlueprint("Trace Triggers"));
57
58 } // namespace
59
MetadataModule(TraceProcessorContext * context)60 MetadataModule::MetadataModule(TraceProcessorContext* context)
61 : context_(context),
62 producer_name_key_id_(context_->storage->InternString("producer_name")),
63 trusted_producer_uid_key_id_(
64 context_->storage->InternString("trusted_producer_uid")),
65 chrome_trigger_name_id_(
66 context_->storage->InternString("chrome_trigger.name")),
67 chrome_trigger_hash_id_(
68 context_->storage->InternString("chrome_trigger.name_hash")) {
69 RegisterForField(TracePacket::kUiStateFieldNumber, context);
70 RegisterForField(TracePacket::kTriggerFieldNumber, context);
71 RegisterForField(TracePacket::kChromeTriggerFieldNumber, 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());
121 }
122 if (field_id == TracePacket::kChromeTriggerFieldNumber) {
123 ParseChromeTrigger(ts, decoder.chrome_trigger());
124 }
125 }
126
ParseTrigger(int64_t ts,ConstBytes blob)127 void MetadataModule::ParseTrigger(int64_t ts, ConstBytes blob) {
128 protos::pbzero::Trigger::Decoder trigger(blob.data, blob.size);
129 StringId cat_id = kNullStringId;
130 TrackId track_id =
131 context_->track_tracker->InternTrack(kTriggerTrackBlueprint);
132 StringId name_id = context_->storage->InternString(trigger.trigger_name());
133 context_->slice_tracker->Scoped(
134 ts, track_id, cat_id, name_id,
135 /* duration = */ 0,
136 [&trigger, this](ArgsTracker::BoundInserter* args_table) {
137 StringId producer_name =
138 context_->storage->InternString(trigger.producer_name());
139 if (!producer_name.is_null()) {
140 args_table->AddArg(producer_name_key_id_,
141 Variadic::String(producer_name));
142 }
143 if (trigger.has_trusted_producer_uid()) {
144 args_table->AddArg(trusted_producer_uid_key_id_,
145 Variadic::Integer(trigger.trusted_producer_uid()));
146 }
147 });
148 }
149
ParseChromeTrigger(int64_t ts,ConstBytes blob)150 void MetadataModule::ParseChromeTrigger(int64_t ts, ConstBytes blob) {
151 protos::pbzero::ChromeTrigger::Decoder trigger(blob);
152 StringId cat_id = kNullStringId;
153 TrackId track_id =
154 context_->track_tracker->InternTrack(kTriggerTrackBlueprint);
155 StringId name_id;
156 if (trigger.has_trigger_name()) {
157 name_id = context_->storage->InternString(trigger.trigger_name());
158 } else {
159 name_id =
160 context_->storage->InternString(base::StringView("chrome_trigger"));
161 }
162 auto slice_id = context_->slice_tracker->Scoped(
163 ts, track_id, cat_id, name_id,
164 /* duration = */ 0, [&](ArgsTracker::BoundInserter* inserter) {
165 inserter->AddArg(
166 chrome_trigger_hash_id_,
167 Variadic::UnsignedInteger(trigger.trigger_name_hash()));
168 if (trigger.has_trigger_name()) {
169 inserter->AddArg(chrome_trigger_name_id_, Variadic::String(name_id));
170 }
171 });
172 if (slice_id && trigger.has_flow_id() &&
173 context_->flow_tracker->IsActive(trigger.flow_id())) {
174 context_->flow_tracker->End(*slice_id, trigger.flow_id(),
175 /* close_flow = */ true);
176 }
177
178 MetadataTracker* metadata = context_->metadata_tracker.get();
179 metadata->SetDynamicMetadata(
180 context_->storage->InternString("cr-triggered_rule_name_hash"),
181 Variadic::Integer(trigger.trigger_name_hash()));
182 }
183
ParseTraceUuid(ConstBytes blob)184 void MetadataModule::ParseTraceUuid(ConstBytes blob) {
185 // If both the TraceUuid packet and TraceConfig.trace_uuid_msb/lsb are set,
186 // the former (which is emitted first) takes precedence. This is because the
187 // UUID can change throughout the lifecycle of a tracing session if gap-less
188 // snapshots are used. Each trace file has at most one TraceUuid packet (i
189 // has if it comes from an older version of the tracing service < v32)
190 protos::pbzero::TraceUuid::Decoder uuid_packet(blob.data, blob.size);
191 if (uuid_packet.msb() != 0 || uuid_packet.lsb() != 0) {
192 base::Uuid uuid(uuid_packet.lsb(), uuid_packet.msb());
193 std::string str = uuid.ToPrettyString();
194 StringId id = context_->storage->InternString(base::StringView(str));
195 context_->metadata_tracker->SetMetadata(metadata::trace_uuid,
196 Variadic::String(id));
197 context_->uuid_found_in_trace = true;
198 }
199 }
200
ParseTraceConfig(const protos::pbzero::TraceConfig_Decoder & trace_config)201 void MetadataModule::ParseTraceConfig(
202 const protos::pbzero::TraceConfig_Decoder& trace_config) {
203 int64_t uuid_msb = trace_config.trace_uuid_msb();
204 int64_t uuid_lsb = trace_config.trace_uuid_lsb();
205 if (!context_->uuid_found_in_trace && (uuid_msb != 0 || uuid_lsb != 0)) {
206 base::Uuid uuid(uuid_lsb, uuid_msb);
207 std::string str = uuid.ToPrettyString();
208 StringId id = context_->storage->InternString(base::StringView(str));
209 context_->metadata_tracker->SetMetadata(metadata::trace_uuid,
210 Variadic::String(id));
211 context_->uuid_found_in_trace = true;
212 }
213
214 if (trace_config.has_unique_session_name()) {
215 StringId id = context_->storage->InternString(
216 base::StringView(trace_config.unique_session_name()));
217 context_->metadata_tracker->SetMetadata(metadata::unique_session_name,
218 Variadic::String(id));
219 }
220
221 DescriptorPool pool;
222 pool.AddFromFileDescriptorSet(kConfigDescriptor.data(),
223 kConfigDescriptor.size());
224
225 std::string text = protozero_to_text::ProtozeroToText(
226 pool, ".perfetto.protos.TraceConfig",
227 protozero::ConstBytes{
228 trace_config.begin(),
229 static_cast<uint32_t>(trace_config.end() - trace_config.begin())},
230 protozero_to_text::kIncludeNewLines);
231 StringId id = context_->storage->InternString(base::StringView(text));
232 context_->metadata_tracker->SetMetadata(metadata::trace_config_pbtxt,
233 Variadic::String(id));
234 }
235
236 } // namespace perfetto::trace_processor
237