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 #ifndef SRC_TRACE_PROCESSOR_IMPORTERS_PROTO_PACKET_SEQUENCE_STATE_H_
18 #define SRC_TRACE_PROCESSOR_IMPORTERS_PROTO_PACKET_SEQUENCE_STATE_H_
19
20 #include <stdint.h>
21
22 #include <unordered_map>
23 #include <vector>
24
25 #include "perfetto/base/compiler.h"
26 #include "perfetto/protozero/proto_decoder.h"
27 #include "src/trace_processor/stack_profile_tracker.h"
28 #include "src/trace_processor/storage/trace_storage.h"
29 #include "src/trace_processor/trace_blob_view.h"
30 #include "src/trace_processor/trace_processor_context.h"
31
32 #include "protos/perfetto/trace/trace_packet_defaults.pbzero.h"
33 #include "protos/perfetto/trace/track_event/track_event.pbzero.h"
34
35 namespace perfetto {
36 namespace trace_processor {
37
38 #if PERFETTO_DCHECK_IS_ON()
39 // When called from GetOrCreateDecoder(), should include the stringified name of
40 // the MessageType.
41 #define PERFETTO_TYPE_IDENTIFIER PERFETTO_DEBUG_FUNCTION_IDENTIFIER()
42 #else // PERFETTO_DCHECK_IS_ON()
43 #define PERFETTO_TYPE_IDENTIFIER nullptr
44 #endif // PERFETTO_DCHECK_IS_ON()
45
46 // Entry in an interning index, refers to the interned message.
47 class InternedMessageView {
48 public:
InternedMessageView(TraceBlobView msg)49 InternedMessageView(TraceBlobView msg) : message_(std::move(msg)) {}
50
51 InternedMessageView(InternedMessageView&&) = default;
52 InternedMessageView& operator=(InternedMessageView&&) = default;
53
54 // Allow copy by cloning the TraceBlobView. This is required for
55 // UpdateTracePacketDefaults().
InternedMessageView(const InternedMessageView & view)56 InternedMessageView(const InternedMessageView& view)
57 : message_(view.message_.slice(0, view.message_.length())) {}
58 InternedMessageView& operator=(const InternedMessageView& view) {
59 this->message_ = view.message_.slice(0, view.message_.length());
60 this->decoder_ = nullptr;
61 this->decoder_type_ = nullptr;
62 this->submessages_.clear();
63 return *this;
64 }
65
66 // Lazily initializes and returns the decoder object for the message. The
67 // decoder is stored in the InternedMessageView to avoid having to parse the
68 // message multiple times.
69 template <typename MessageType>
GetOrCreateDecoder()70 typename MessageType::Decoder* GetOrCreateDecoder() {
71 if (!decoder_) {
72 // Lazy init the decoder and save it away, so that we don't have to
73 // reparse the message every time we access the interning entry.
74 decoder_ = std::unique_ptr<void, std::function<void(void*)>>(
75 new typename MessageType::Decoder(message_.data(), message_.length()),
76 [](void* obj) {
77 delete reinterpret_cast<typename MessageType::Decoder*>(obj);
78 });
79 decoder_type_ = PERFETTO_TYPE_IDENTIFIER;
80 }
81 // Verify that the type of the decoder didn't change.
82 if (PERFETTO_TYPE_IDENTIFIER &&
83 strcmp(decoder_type_,
84 // GCC complains if this arg can be null.
85 PERFETTO_TYPE_IDENTIFIER ? PERFETTO_TYPE_IDENTIFIER : "") != 0) {
86 PERFETTO_FATAL(
87 "Interning entry accessed under different types! previous type: "
88 "%s. new type: %s.",
89 decoder_type_, PERFETTO_DEBUG_FUNCTION_IDENTIFIER());
90 }
91 return reinterpret_cast<typename MessageType::Decoder*>(decoder_.get());
92 }
93
94 // Lookup a submessage of the interned message, which is then itself stored
95 // as InternedMessageView, so that we only need to parse it once. Returns
96 // nullptr if the field isn't set.
97 // TODO(eseckler): Support repeated fields.
98 template <typename MessageType, uint32_t FieldId>
GetOrCreateSubmessageView()99 InternedMessageView* GetOrCreateSubmessageView() {
100 auto it = submessages_.find(FieldId);
101 if (it != submessages_.end())
102 return it->second.get();
103 auto* decoder = GetOrCreateDecoder<MessageType>();
104 // Calls the at() template method on the decoder.
105 auto field = decoder->template at<FieldId>().as_bytes();
106 if (!field.data)
107 return nullptr;
108 const size_t offset = message_.offset_of(field.data);
109 TraceBlobView submessage = message_.slice(offset, field.size);
110 InternedMessageView* submessage_view =
111 new InternedMessageView(std::move(submessage));
112 submessages_.emplace_hint(
113 it, FieldId, std::unique_ptr<InternedMessageView>(submessage_view));
114 return submessage_view;
115 }
116
message()117 const TraceBlobView& message() { return message_; }
118
119 private:
120 using SubMessageViewMap =
121 std::unordered_map<uint32_t /*field_id*/,
122 std::unique_ptr<InternedMessageView>>;
123
124 TraceBlobView message_;
125
126 // Stores the decoder for the message_, so that the message does not have to
127 // be re-decoded every time the interned message is looked up. Lazily
128 // initialized in GetOrCreateDecoder(). Since we don't know the type of the
129 // decoder until GetOrCreateDecoder() is called, we store the decoder as a
130 // void* unique_pointer with a destructor function that's supplied in
131 // GetOrCreateDecoder() when the decoder is created.
132 std::unique_ptr<void, std::function<void(void*)>> decoder_;
133
134 // Type identifier for the decoder. Only valid in debug builds and on
135 // supported platforms. Used to verify that GetOrCreateDecoder() is always
136 // called with the same template argument.
137 const char* decoder_type_ = nullptr;
138
139 // Views of submessages of the interned message. Submessages are lazily
140 // added by GetOrCreateSubmessageView(). By storing submessages and their
141 // decoders, we avoid having to decode submessages multiple times if they
142 // looked up often.
143 SubMessageViewMap submessages_;
144 };
145
146 using InternedMessageMap =
147 std::unordered_map<uint64_t /*iid*/, InternedMessageView>;
148 using InternedFieldMap =
149 std::unordered_map<uint32_t /*field_id*/, InternedMessageMap>;
150
151 class PacketSequenceState;
152
153 class PacketSequenceStateGeneration {
154 public:
155 // Returns |nullptr| if the message with the given |iid| was not found (also
156 // records a stat in this case).
157 template <uint32_t FieldId, typename MessageType>
158 typename MessageType::Decoder* LookupInternedMessage(uint64_t iid);
159
160 // Returns |nullptr| if no defaults were set.
GetTracePacketDefaultsView()161 InternedMessageView* GetTracePacketDefaultsView() {
162 if (!trace_packet_defaults_)
163 return nullptr;
164 return &trace_packet_defaults_.value();
165 }
166
167 // Returns |nullptr| if no defaults were set.
GetTracePacketDefaults()168 protos::pbzero::TracePacketDefaults::Decoder* GetTracePacketDefaults() {
169 InternedMessageView* view = GetTracePacketDefaultsView();
170 if (!view)
171 return nullptr;
172 return view->GetOrCreateDecoder<protos::pbzero::TracePacketDefaults>();
173 }
174
175 // Returns |nullptr| if no TrackEventDefaults were set.
GetTrackEventDefaults()176 protos::pbzero::TrackEventDefaults::Decoder* GetTrackEventDefaults() {
177 auto* packet_defaults_view = GetTracePacketDefaultsView();
178 if (packet_defaults_view) {
179 auto* track_event_defaults_view =
180 packet_defaults_view
181 ->GetOrCreateSubmessageView<protos::pbzero::TracePacketDefaults,
182 protos::pbzero::TracePacketDefaults::
183 kTrackEventDefaultsFieldNumber>();
184 if (track_event_defaults_view) {
185 return track_event_defaults_view
186 ->GetOrCreateDecoder<protos::pbzero::TrackEventDefaults>();
187 }
188 }
189 return nullptr;
190 }
191
state()192 PacketSequenceState* state() const { return state_; }
193
194 private:
195 friend class PacketSequenceState;
196
PacketSequenceStateGeneration(PacketSequenceState * state,size_t generation_index)197 PacketSequenceStateGeneration(PacketSequenceState* state,
198 size_t generation_index)
199 : state_(state), generation_index_(generation_index) {}
200
PacketSequenceStateGeneration(PacketSequenceState * state,size_t generation_index,InternedFieldMap interned_data,TraceBlobView defaults)201 PacketSequenceStateGeneration(PacketSequenceState* state,
202 size_t generation_index,
203 InternedFieldMap interned_data,
204 TraceBlobView defaults)
205 : state_(state),
206 generation_index_(generation_index),
207 interned_data_(interned_data),
208 trace_packet_defaults_(InternedMessageView(std::move(defaults))) {}
209
210 void InternMessage(uint32_t field_id, TraceBlobView message);
211
SetTracePacketDefaults(TraceBlobView defaults)212 void SetTracePacketDefaults(TraceBlobView defaults) {
213 // Defaults should only be set once per generation.
214 PERFETTO_DCHECK(!trace_packet_defaults_);
215 trace_packet_defaults_ = InternedMessageView(std::move(defaults));
216 }
217
218 PacketSequenceState* state_;
219 size_t generation_index_;
220 InternedFieldMap interned_data_;
221 base::Optional<InternedMessageView> trace_packet_defaults_;
222 };
223
224 class PacketSequenceState {
225 public:
PacketSequenceState(TraceProcessorContext * context)226 PacketSequenceState(TraceProcessorContext* context)
227 : context_(context), stack_profile_tracker_(context) {
228 generations_.emplace_back(
229 new PacketSequenceStateGeneration(this, generations_.size()));
230 }
231
IncrementAndGetTrackEventTimeNs(int64_t delta_ns)232 int64_t IncrementAndGetTrackEventTimeNs(int64_t delta_ns) {
233 PERFETTO_DCHECK(track_event_timestamps_valid());
234 track_event_timestamp_ns_ += delta_ns;
235 return track_event_timestamp_ns_;
236 }
237
IncrementAndGetTrackEventThreadTimeNs(int64_t delta_ns)238 int64_t IncrementAndGetTrackEventThreadTimeNs(int64_t delta_ns) {
239 PERFETTO_DCHECK(track_event_timestamps_valid());
240 track_event_thread_timestamp_ns_ += delta_ns;
241 return track_event_thread_timestamp_ns_;
242 }
243
IncrementAndGetTrackEventThreadInstructionCount(int64_t delta)244 int64_t IncrementAndGetTrackEventThreadInstructionCount(int64_t delta) {
245 PERFETTO_DCHECK(track_event_timestamps_valid());
246 track_event_thread_instruction_count_ += delta;
247 return track_event_thread_instruction_count_;
248 }
249
250 // Intern a message into the current generation.
InternMessage(uint32_t field_id,TraceBlobView message)251 void InternMessage(uint32_t field_id, TraceBlobView message) {
252 generations_.back()->InternMessage(field_id, std::move(message));
253 }
254
255 // Set the trace packet defaults for the current generation. If the current
256 // generation already has defaults set, starts a new generation without
257 // invalidating other incremental state (such as interned data).
UpdateTracePacketDefaults(TraceBlobView defaults)258 void UpdateTracePacketDefaults(TraceBlobView defaults) {
259 if (!generations_.back()->GetTracePacketDefaultsView()) {
260 generations_.back()->SetTracePacketDefaults(std::move(defaults));
261 return;
262 }
263
264 // The new defaults should only apply to subsequent messages on the
265 // sequence. Add a new generation with the updated defaults but the
266 // current generation's interned data state.
267 generations_.emplace_back(new PacketSequenceStateGeneration(
268 this, generations_.size(), generations_.back()->interned_data_,
269 std::move(defaults)));
270 }
271
SetThreadDescriptor(int32_t pid,int32_t tid,int64_t timestamp_ns,int64_t thread_timestamp_ns,int64_t thread_instruction_count)272 void SetThreadDescriptor(int32_t pid,
273 int32_t tid,
274 int64_t timestamp_ns,
275 int64_t thread_timestamp_ns,
276 int64_t thread_instruction_count) {
277 track_event_timestamps_valid_ = true;
278 pid_and_tid_valid_ = true;
279 pid_ = pid;
280 tid_ = tid;
281 track_event_timestamp_ns_ = timestamp_ns;
282 track_event_thread_timestamp_ns_ = thread_timestamp_ns;
283 track_event_thread_instruction_count_ = thread_instruction_count;
284 }
285
OnPacketLoss()286 void OnPacketLoss() {
287 packet_loss_ = true;
288 track_event_timestamps_valid_ = false;
289 }
290
291 // Starts a new generation with clean-slate incremental state and defaults.
OnIncrementalStateCleared()292 void OnIncrementalStateCleared() {
293 packet_loss_ = false;
294 generations_.emplace_back(
295 new PacketSequenceStateGeneration(this, generations_.size()));
296 }
297
IsIncrementalStateValid()298 bool IsIncrementalStateValid() const { return !packet_loss_; }
299
stack_profile_tracker()300 StackProfileTracker& stack_profile_tracker() {
301 return stack_profile_tracker_;
302 }
303
304 // Returns a pointer to the current generation.
current_generation()305 PacketSequenceStateGeneration* current_generation() const {
306 return generations_.back().get();
307 }
308
track_event_timestamps_valid()309 bool track_event_timestamps_valid() const {
310 return track_event_timestamps_valid_;
311 }
312
pid_and_tid_valid()313 bool pid_and_tid_valid() const { return pid_and_tid_valid_; }
314
pid()315 int32_t pid() const { return pid_; }
tid()316 int32_t tid() const { return tid_; }
317
context()318 TraceProcessorContext* context() const { return context_; }
319
320 private:
321 // TODO(eseckler): Reference count the generations so that we can get rid of
322 // past generations once all packets referring to them have been parsed.
323 using GenerationList =
324 std::vector<std::unique_ptr<PacketSequenceStateGeneration>>;
325
326 TraceProcessorContext* context_;
327
328 // If true, incremental state on the sequence is considered invalid until we
329 // see the next packet with incremental_state_cleared. We assume that we
330 // missed some packets at the beginning of the trace.
331 bool packet_loss_ = true;
332
333 // We can only consider TrackEvent delta timestamps to be correct after we
334 // have observed a thread descriptor (since the last packet loss).
335 bool track_event_timestamps_valid_ = false;
336
337 // |pid_| and |tid_| are only valid after we parsed at least one
338 // ThreadDescriptor packet on the sequence.
339 bool pid_and_tid_valid_ = false;
340
341 // Process/thread ID of the packet sequence set by a ThreadDescriptor
342 // packet. Used as default values for TrackEvents that don't specify a
343 // pid/tid override. Only valid after |pid_and_tid_valid_| is set to true.
344 int32_t pid_ = 0;
345 int32_t tid_ = 0;
346
347 // Current wall/thread timestamps/counters used as reference for the next
348 // TrackEvent delta timestamp.
349 int64_t track_event_timestamp_ns_ = 0;
350 int64_t track_event_thread_timestamp_ns_ = 0;
351 int64_t track_event_thread_instruction_count_ = 0;
352
353 GenerationList generations_;
354 StackProfileTracker stack_profile_tracker_;
355 };
356
357 template <uint32_t FieldId, typename MessageType>
358 typename MessageType::Decoder*
LookupInternedMessage(uint64_t iid)359 PacketSequenceStateGeneration::LookupInternedMessage(uint64_t iid) {
360 auto field_it = interned_data_.find(FieldId);
361 if (field_it != interned_data_.end()) {
362 auto* message_map = &field_it->second;
363 auto it = message_map->find(iid);
364 if (it != message_map->end()) {
365 return it->second.GetOrCreateDecoder<MessageType>();
366 }
367 }
368 state_->context()->storage->IncrementStats(
369 stats::interned_data_tokenizer_errors);
370 PERFETTO_DLOG("Could not find interning entry for field ID %" PRIu32
371 ", generation %zu, and IID %" PRIu64,
372 FieldId, generation_index_, iid);
373 return nullptr;
374 }
375
376 } // namespace trace_processor
377 } // namespace perfetto
378
379 #endif // SRC_TRACE_PROCESSOR_IMPORTERS_PROTO_PACKET_SEQUENCE_STATE_H_
380