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/common/metadata_tracker.h"
18 #include <cstddef>
19 #include <cstdint>
20 #include <optional>
21
22 #include "perfetto/base/logging.h"
23 #include "perfetto/ext/base/crash_keys.h"
24 #include "perfetto/trace_processor/basic_types.h"
25 #include "src/trace_processor/storage/metadata.h"
26 #include "src/trace_processor/storage/trace_storage.h"
27 #include "src/trace_processor/tables/metadata_tables_py.h"
28 #include "src/trace_processor/types/trace_processor_context.h"
29 #include "src/trace_processor/types/variadic.h"
30
31 namespace perfetto::trace_processor {
32
33 namespace {
34 base::CrashKey g_crash_key_uuid("trace_uuid");
35 }
36
MetadataTracker(TraceStorage * storage)37 MetadataTracker::MetadataTracker(TraceStorage* storage) : storage_(storage) {
38 for (uint32_t i = 0; i < kNumKeys; ++i) {
39 key_ids_[i] = storage->InternString(metadata::kNames[i]);
40 }
41 for (uint32_t i = 0; i < kNumKeyTypes; ++i) {
42 key_type_ids_[i] = storage->InternString(metadata::kKeyTypeNames[i]);
43 }
44 }
45
SetMetadata(metadata::KeyId key,Variadic value)46 MetadataId MetadataTracker::SetMetadata(metadata::KeyId key, Variadic value) {
47 PERFETTO_DCHECK(metadata::kKeyTypes[key] == metadata::KeyType::kSingle);
48 PERFETTO_DCHECK(value.type == metadata::kValueTypes[key]);
49
50 // When the trace_uuid is set, store a copy in a crash key, so in case of
51 // a crash in the pipelines we can tell which trace caused the crash.
52 if (key == metadata::trace_uuid && value.type == Variadic::kString) {
53 auto uuid_string_view = storage_->GetString(value.string_value);
54 g_crash_key_uuid.Set(uuid_string_view);
55 }
56
57 auto& metadata_table = *storage_->mutable_metadata_table();
58 auto key_idx = static_cast<uint32_t>(key);
59 auto name_id = storage_->string_pool().GetId(metadata::kNames[key_idx]);
60 if (name_id) {
61 for (auto it = metadata_table.IterateRows(); it; ++it) {
62 if (it.name() == *name_id) {
63 WriteValue(it.row_number().row_number(), value);
64 return it.id();
65 }
66 }
67 }
68
69 tables::MetadataTable::Row row;
70 row.name = key_ids_[key_idx];
71 row.key_type = key_type_ids_[static_cast<size_t>(metadata::KeyType::kSingle)];
72
73 auto id_and_row = metadata_table.Insert(row);
74 WriteValue(id_and_row.row, value);
75 return id_and_row.id;
76 }
77
GetMetadata(metadata::KeyId key)78 std::optional<SqlValue> MetadataTracker::GetMetadata(metadata::KeyId key) {
79 // KeyType::kMulti not yet supported by this method:
80 PERFETTO_CHECK(metadata::kKeyTypes[key] == metadata::KeyType::kSingle);
81
82 auto& metadata_table = *storage_->mutable_metadata_table();
83 auto key_idx = static_cast<uint32_t>(key);
84
85 auto key_id = storage_->string_pool().GetId(metadata::kNames[key_idx]);
86 if (!key_id) {
87 return std::nullopt;
88 }
89
90 std::optional<tables::MetadataTable::RowReference> row;
91 for (auto it = metadata_table.IterateRows(); it; ++it) {
92 if (key_id == it.name()) {
93 row = it.row_reference();
94 break;
95 }
96 }
97 if (!row.has_value()) {
98 return {};
99 }
100
101 auto value_type = metadata::kValueTypes[key];
102 switch (value_type) {
103 case Variadic::kInt: {
104 return SqlValue::Long(*row->int_value());
105 }
106 case Variadic::kString:
107 return SqlValue::String(storage_->GetString(*row->str_value()).c_str());
108 case Variadic::kNull:
109 return SqlValue();
110 case Variadic::kJson:
111 case Variadic::kUint:
112 case Variadic::kPointer:
113 case Variadic::kReal:
114 case Variadic::kBool:
115 PERFETTO_FATAL("Invalid metadata value type %zu", value_type);
116 }
117 PERFETTO_FATAL("For GCC");
118 }
119
AppendMetadata(metadata::KeyId key,Variadic value)120 MetadataId MetadataTracker::AppendMetadata(metadata::KeyId key,
121 Variadic value) {
122 PERFETTO_DCHECK(key < metadata::kNumKeys);
123 PERFETTO_DCHECK(metadata::kKeyTypes[key] == metadata::KeyType::kMulti);
124 PERFETTO_DCHECK(value.type == metadata::kValueTypes[key]);
125
126 uint32_t key_idx = static_cast<uint32_t>(key);
127 tables::MetadataTable::Row row;
128 row.name = key_ids_[key_idx];
129 row.key_type = key_type_ids_[static_cast<size_t>(metadata::KeyType::kMulti)];
130
131 auto* metadata_table = storage_->mutable_metadata_table();
132 auto id_and_row = metadata_table->Insert(row);
133 WriteValue(id_and_row.row, value);
134 return id_and_row.id;
135 }
136
SetDynamicMetadata(StringId key,Variadic value)137 MetadataId MetadataTracker::SetDynamicMetadata(StringId key, Variadic value) {
138 tables::MetadataTable::Row row;
139 row.name = key;
140 row.key_type = key_type_ids_[static_cast<size_t>(metadata::KeyType::kSingle)];
141
142 auto* metadata_table = storage_->mutable_metadata_table();
143 auto id_and_row = metadata_table->Insert(row);
144 WriteValue(id_and_row.row, value);
145 return id_and_row.id;
146 }
147
WriteValue(uint32_t row,Variadic value)148 void MetadataTracker::WriteValue(uint32_t row, Variadic value) {
149 auto& metadata_table = *storage_->mutable_metadata_table();
150 auto rr = metadata_table[row];
151 switch (value.type) {
152 case Variadic::Type::kInt:
153 rr.set_int_value(value.int_value);
154 break;
155 case Variadic::Type::kString:
156 rr.set_str_value(value.string_value);
157 break;
158 case Variadic::Type::kJson:
159 rr.set_str_value(value.json_value);
160 break;
161 case Variadic::Type::kBool:
162 case Variadic::Type::kPointer:
163 case Variadic::Type::kUint:
164 case Variadic::Type::kReal:
165 case Variadic::Type::kNull:
166 PERFETTO_FATAL("Unsupported value type");
167 }
168 }
169
170 } // namespace perfetto::trace_processor
171