Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 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 | |
Sami Kyostila | 4d172cd | 2019-11-07 12:59:44 +0000 | [diff] [blame] | 25 | #include "perfetto/base/compiler.h" |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 26 | #include "perfetto/protozero/proto_decoder.h" |
Lalit Maganti | 05819e2 | 2020-04-14 21:01:38 +0100 | [diff] [blame] | 27 | #include "src/trace_processor/importers/proto/stack_profile_tracker.h" |
Lalit Maganti | 7010b33 | 2020-02-07 10:51:15 +0000 | [diff] [blame] | 28 | #include "src/trace_processor/storage/trace_storage.h" |
Lalit Maganti | 0faddc4 | 2020-04-10 17:58:24 +0100 | [diff] [blame] | 29 | #include "src/trace_processor/types/trace_processor_context.h" |
Alexander Timin | 97d8785 | 2021-05-17 18:01:33 +0000 | [diff] [blame^] | 30 | #include "src/trace_processor/util/interned_message_view.h" |
| 31 | #include "src/trace_processor/util/trace_blob_view.h" |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 32 | |
Eric Seckler | 1edbe00 | 2019-12-16 18:08:57 +0000 | [diff] [blame] | 33 | #include "protos/perfetto/trace/trace_packet_defaults.pbzero.h" |
Eric Seckler | 926b337 | 2020-03-06 16:17:53 +0000 | [diff] [blame] | 34 | #include "protos/perfetto/trace/track_event/track_event.pbzero.h" |
Eric Seckler | 1edbe00 | 2019-12-16 18:08:57 +0000 | [diff] [blame] | 35 | |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 36 | namespace perfetto { |
| 37 | namespace trace_processor { |
| 38 | |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 39 | using InternedMessageMap = |
| 40 | std::unordered_map<uint64_t /*iid*/, InternedMessageView>; |
| 41 | using InternedFieldMap = |
| 42 | std::unordered_map<uint32_t /*field_id*/, InternedMessageMap>; |
| 43 | |
| 44 | class PacketSequenceState; |
| 45 | |
| 46 | class PacketSequenceStateGeneration { |
| 47 | public: |
| 48 | // Returns |nullptr| if the message with the given |iid| was not found (also |
| 49 | // records a stat in this case). |
| 50 | template <uint32_t FieldId, typename MessageType> |
| 51 | typename MessageType::Decoder* LookupInternedMessage(uint64_t iid); |
| 52 | |
Alexander Timin | 99653b1 | 2021-05-11 22:50:00 +0000 | [diff] [blame] | 53 | InternedMessageView* GetInternedMessageView(uint32_t field_id, uint64_t iid); |
Eric Seckler | 926b337 | 2020-03-06 16:17:53 +0000 | [diff] [blame] | 54 | // Returns |nullptr| if no defaults were set. |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 55 | InternedMessageView* GetTracePacketDefaultsView() { |
| 56 | if (!trace_packet_defaults_) |
| 57 | return nullptr; |
| 58 | return &trace_packet_defaults_.value(); |
| 59 | } |
| 60 | |
Eric Seckler | 926b337 | 2020-03-06 16:17:53 +0000 | [diff] [blame] | 61 | // Returns |nullptr| if no defaults were set. |
| 62 | protos::pbzero::TracePacketDefaults::Decoder* GetTracePacketDefaults() { |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 63 | InternedMessageView* view = GetTracePacketDefaultsView(); |
| 64 | if (!view) |
| 65 | return nullptr; |
| 66 | return view->GetOrCreateDecoder<protos::pbzero::TracePacketDefaults>(); |
| 67 | } |
| 68 | |
Eric Seckler | 926b337 | 2020-03-06 16:17:53 +0000 | [diff] [blame] | 69 | // Returns |nullptr| if no TrackEventDefaults were set. |
| 70 | protos::pbzero::TrackEventDefaults::Decoder* GetTrackEventDefaults() { |
| 71 | auto* packet_defaults_view = GetTracePacketDefaultsView(); |
| 72 | if (packet_defaults_view) { |
| 73 | auto* track_event_defaults_view = |
| 74 | packet_defaults_view |
| 75 | ->GetOrCreateSubmessageView<protos::pbzero::TracePacketDefaults, |
| 76 | protos::pbzero::TracePacketDefaults:: |
| 77 | kTrackEventDefaultsFieldNumber>(); |
| 78 | if (track_event_defaults_view) { |
| 79 | return track_event_defaults_view |
| 80 | ->GetOrCreateDecoder<protos::pbzero::TrackEventDefaults>(); |
| 81 | } |
| 82 | } |
| 83 | return nullptr; |
| 84 | } |
| 85 | |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 86 | PacketSequenceState* state() const { return state_; } |
Primiano Tucci | 6320170 | 2020-12-04 17:38:12 +0100 | [diff] [blame] | 87 | size_t generation_index() const { return generation_index_; } |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 88 | |
| 89 | private: |
| 90 | friend class PacketSequenceState; |
| 91 | |
| 92 | PacketSequenceStateGeneration(PacketSequenceState* state, |
| 93 | size_t generation_index) |
| 94 | : state_(state), generation_index_(generation_index) {} |
| 95 | |
| 96 | PacketSequenceStateGeneration(PacketSequenceState* state, |
| 97 | size_t generation_index, |
| 98 | InternedFieldMap interned_data, |
| 99 | TraceBlobView defaults) |
| 100 | : state_(state), |
| 101 | generation_index_(generation_index), |
| 102 | interned_data_(interned_data), |
| 103 | trace_packet_defaults_(InternedMessageView(std::move(defaults))) {} |
| 104 | |
| 105 | void InternMessage(uint32_t field_id, TraceBlobView message); |
| 106 | |
| 107 | void SetTracePacketDefaults(TraceBlobView defaults) { |
| 108 | // Defaults should only be set once per generation. |
| 109 | PERFETTO_DCHECK(!trace_packet_defaults_); |
| 110 | trace_packet_defaults_ = InternedMessageView(std::move(defaults)); |
| 111 | } |
| 112 | |
| 113 | PacketSequenceState* state_; |
| 114 | size_t generation_index_; |
| 115 | InternedFieldMap interned_data_; |
| 116 | base::Optional<InternedMessageView> trace_packet_defaults_; |
| 117 | }; |
| 118 | |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 119 | class PacketSequenceState { |
| 120 | public: |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 121 | PacketSequenceState(TraceProcessorContext* context) |
Florian Mayer | ab0c27a | 2020-08-12 17:42:49 +0100 | [diff] [blame] | 122 | : context_(context), sequence_stack_profile_tracker_(context) { |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 123 | current_generation_.reset( |
| 124 | new PacketSequenceStateGeneration(this, generation_index_++)); |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | int64_t IncrementAndGetTrackEventTimeNs(int64_t delta_ns) { |
| 128 | PERFETTO_DCHECK(track_event_timestamps_valid()); |
| 129 | track_event_timestamp_ns_ += delta_ns; |
| 130 | return track_event_timestamp_ns_; |
| 131 | } |
| 132 | |
| 133 | int64_t IncrementAndGetTrackEventThreadTimeNs(int64_t delta_ns) { |
| 134 | PERFETTO_DCHECK(track_event_timestamps_valid()); |
| 135 | track_event_thread_timestamp_ns_ += delta_ns; |
| 136 | return track_event_thread_timestamp_ns_; |
| 137 | } |
| 138 | |
| 139 | int64_t IncrementAndGetTrackEventThreadInstructionCount(int64_t delta) { |
| 140 | PERFETTO_DCHECK(track_event_timestamps_valid()); |
| 141 | track_event_thread_instruction_count_ += delta; |
| 142 | return track_event_thread_instruction_count_; |
| 143 | } |
| 144 | |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 145 | // Intern a message into the current generation. |
| 146 | void InternMessage(uint32_t field_id, TraceBlobView message) { |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 147 | current_generation_->InternMessage(field_id, std::move(message)); |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 148 | } |
| 149 | |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 150 | // Set the trace packet defaults for the current generation. If the current |
| 151 | // generation already has defaults set, starts a new generation without |
| 152 | // invalidating other incremental state (such as interned data). |
| 153 | void UpdateTracePacketDefaults(TraceBlobView defaults) { |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 154 | if (!current_generation_->GetTracePacketDefaultsView()) { |
| 155 | current_generation_->SetTracePacketDefaults(std::move(defaults)); |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 156 | return; |
| 157 | } |
| 158 | |
| 159 | // The new defaults should only apply to subsequent messages on the |
| 160 | // sequence. Add a new generation with the updated defaults but the |
| 161 | // current generation's interned data state. |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 162 | current_generation_.reset(new PacketSequenceStateGeneration( |
| 163 | this, generation_index_++, current_generation_->interned_data_, |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 164 | std::move(defaults))); |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | void SetThreadDescriptor(int32_t pid, |
| 168 | int32_t tid, |
| 169 | int64_t timestamp_ns, |
| 170 | int64_t thread_timestamp_ns, |
| 171 | int64_t thread_instruction_count) { |
| 172 | track_event_timestamps_valid_ = true; |
| 173 | pid_and_tid_valid_ = true; |
| 174 | pid_ = pid; |
| 175 | tid_ = tid; |
| 176 | track_event_timestamp_ns_ = timestamp_ns; |
| 177 | track_event_thread_timestamp_ns_ = thread_timestamp_ns; |
| 178 | track_event_thread_instruction_count_ = thread_instruction_count; |
| 179 | } |
| 180 | |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 181 | void OnPacketLoss() { |
| 182 | packet_loss_ = true; |
| 183 | track_event_timestamps_valid_ = false; |
| 184 | } |
| 185 | |
| 186 | // Starts a new generation with clean-slate incremental state and defaults. |
| 187 | void OnIncrementalStateCleared() { |
| 188 | packet_loss_ = false; |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 189 | current_generation_.reset( |
| 190 | new PacketSequenceStateGeneration(this, generation_index_++)); |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 191 | } |
| 192 | |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 193 | bool IsIncrementalStateValid() const { return !packet_loss_; } |
| 194 | |
Florian Mayer | ab0c27a | 2020-08-12 17:42:49 +0100 | [diff] [blame] | 195 | SequenceStackProfileTracker& sequence_stack_profile_tracker() { |
| 196 | return sequence_stack_profile_tracker_; |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 197 | } |
| 198 | |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 199 | // Returns a ref-counted ptr to the current generation. |
| 200 | std::shared_ptr<PacketSequenceStateGeneration> current_generation() const { |
| 201 | return current_generation_; |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 202 | } |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 203 | |
| 204 | bool track_event_timestamps_valid() const { |
| 205 | return track_event_timestamps_valid_; |
| 206 | } |
| 207 | |
| 208 | bool pid_and_tid_valid() const { return pid_and_tid_valid_; } |
| 209 | |
| 210 | int32_t pid() const { return pid_; } |
| 211 | int32_t tid() const { return tid_; } |
| 212 | |
Eric Seckler | 7e9dc31 | 2020-01-02 15:17:28 +0000 | [diff] [blame] | 213 | TraceProcessorContext* context() const { return context_; } |
Eric Seckler | 1edbe00 | 2019-12-16 18:08:57 +0000 | [diff] [blame] | 214 | |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 215 | private: |
| 216 | TraceProcessorContext* context_; |
| 217 | |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 218 | size_t generation_index_ = 0; |
| 219 | |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 220 | // If true, incremental state on the sequence is considered invalid until we |
| 221 | // see the next packet with incremental_state_cleared. We assume that we |
| 222 | // missed some packets at the beginning of the trace. |
| 223 | bool packet_loss_ = true; |
| 224 | |
| 225 | // We can only consider TrackEvent delta timestamps to be correct after we |
| 226 | // have observed a thread descriptor (since the last packet loss). |
| 227 | bool track_event_timestamps_valid_ = false; |
| 228 | |
| 229 | // |pid_| and |tid_| are only valid after we parsed at least one |
| 230 | // ThreadDescriptor packet on the sequence. |
| 231 | bool pid_and_tid_valid_ = false; |
| 232 | |
| 233 | // Process/thread ID of the packet sequence set by a ThreadDescriptor |
| 234 | // packet. Used as default values for TrackEvents that don't specify a |
| 235 | // pid/tid override. Only valid after |pid_and_tid_valid_| is set to true. |
| 236 | int32_t pid_ = 0; |
| 237 | int32_t tid_ = 0; |
| 238 | |
| 239 | // Current wall/thread timestamps/counters used as reference for the next |
| 240 | // TrackEvent delta timestamp. |
| 241 | int64_t track_event_timestamp_ns_ = 0; |
| 242 | int64_t track_event_thread_timestamp_ns_ = 0; |
| 243 | int64_t track_event_thread_instruction_count_ = 0; |
| 244 | |
Lalit Maganti | 9a84311 | 2020-11-10 13:39:05 +0000 | [diff] [blame] | 245 | std::shared_ptr<PacketSequenceStateGeneration> current_generation_; |
Florian Mayer | ab0c27a | 2020-08-12 17:42:49 +0100 | [diff] [blame] | 246 | SequenceStackProfileTracker sequence_stack_profile_tracker_; |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 247 | }; |
| 248 | |
Florian Mayer | 2881d6b | 2021-01-12 17:53:53 +0000 | [diff] [blame] | 249 | template <uint32_t FieldId, typename MessageType> |
| 250 | typename MessageType::Decoder* |
| 251 | PacketSequenceStateGeneration::LookupInternedMessage(uint64_t iid) { |
Alexander Timin | 99653b1 | 2021-05-11 22:50:00 +0000 | [diff] [blame] | 252 | auto* interned_message_view = GetInternedMessageView(FieldId, iid); |
Florian Mayer | 2881d6b | 2021-01-12 17:53:53 +0000 | [diff] [blame] | 253 | if (!interned_message_view) |
| 254 | return nullptr; |
| 255 | |
| 256 | return interned_message_view->template GetOrCreateDecoder<MessageType>(); |
| 257 | } |
| 258 | |
Eric Seckler | 771960c | 2019-10-22 15:37:12 +0100 | [diff] [blame] | 259 | } // namespace trace_processor |
| 260 | } // namespace perfetto |
| 261 | |
| 262 | #endif // SRC_TRACE_PROCESSOR_IMPORTERS_PROTO_PACKET_SEQUENCE_STATE_H_ |