xref: /aosp_15_r20/external/perfetto/src/trace_processor/storage/metadata.h (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
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_STORAGE_METADATA_H_
18 #define SRC_TRACE_PROCESSOR_STORAGE_METADATA_H_
19 
20 #include <stddef.h>
21 
22 #include "src/trace_processor/types/variadic.h"
23 
24 namespace perfetto {
25 namespace trace_processor {
26 namespace metadata {
27 
28 // Compile time list of metadata items.
29 // clang-format off
30 #define PERFETTO_TP_METADATA(F)                                               \
31   F(all_data_source_flushed_ns,        KeyType::kMulti,   Variadic::kInt),    \
32   F(all_data_source_started_ns,        KeyType::kSingle,  Variadic::kInt),    \
33   F(android_build_fingerprint,         KeyType::kSingle,  Variadic::kString), \
34   F(android_device_manufacturer,       KeyType::kSingle,  Variadic::kString), \
35   F(android_sdk_version,               KeyType::kSingle,  Variadic::kInt),    \
36   F(android_soc_model,                 KeyType::kSingle,  Variadic::kString), \
37   F(android_guest_soc_model,           KeyType::kSingle,  Variadic::kString), \
38   F(android_hardware_revision,         KeyType::kSingle,  Variadic::kString), \
39   F(android_storage_model,             KeyType::kSingle,  Variadic::kString), \
40   F(android_ram_model,                 KeyType::kSingle,  Variadic::kString), \
41   F(benchmark_description,             KeyType::kSingle,  Variadic::kString), \
42   F(benchmark_had_failures,            KeyType::kSingle,  Variadic::kInt),    \
43   F(benchmark_label,                   KeyType::kSingle,  Variadic::kString), \
44   F(benchmark_name,                    KeyType::kSingle,  Variadic::kString), \
45   F(benchmark_start_time_us,           KeyType::kSingle,  Variadic::kInt),    \
46   F(benchmark_story_name,              KeyType::kSingle,  Variadic::kString), \
47   F(benchmark_story_run_index,         KeyType::kSingle,  Variadic::kInt),    \
48   F(benchmark_story_run_time_us,       KeyType::kSingle,  Variadic::kInt),    \
49   F(benchmark_story_tags,              KeyType::kMulti,   Variadic::kString), \
50   F(ftrace_setup_errors,               KeyType::kMulti,   Variadic::kString), \
51   F(ftrace_latest_data_start_ns,       KeyType::kSingle,  Variadic::kInt),    \
52   F(range_of_interest_start_us,        KeyType::kSingle,  Variadic::kInt),    \
53   F(slow_start_data_source,            KeyType::kMulti,   Variadic::kString), \
54   F(statsd_triggering_subscription_id, KeyType::kSingle,  Variadic::kInt),    \
55   F(system_machine,                    KeyType::kSingle,  Variadic::kString), \
56   F(system_name,                       KeyType::kSingle,  Variadic::kString), \
57   F(system_release,                    KeyType::kSingle,  Variadic::kString), \
58   F(system_version,                    KeyType::kSingle,  Variadic::kString), \
59   F(timezone_off_mins,                 KeyType::kSingle,  Variadic::kInt),    \
60   F(trace_config_pbtxt,                KeyType::kSingle,  Variadic::kString), \
61   F(trace_size_bytes,                  KeyType::kSingle,  Variadic::kInt),    \
62   F(trace_time_clock_id,               KeyType::kSingle,  Variadic::kInt),    \
63   F(trace_type,                        KeyType::kSingle,  Variadic::kString), \
64   F(trace_uuid,                        KeyType::kSingle,  Variadic::kString), \
65   F(tracing_disabled_ns,               KeyType::kSingle,  Variadic::kInt),    \
66   F(tracing_started_ns,                KeyType::kSingle,  Variadic::kInt),    \
67   F(ui_state,                          KeyType::kSingle,  Variadic::kString), \
68   F(unique_session_name,               KeyType::kSingle,  Variadic::kString)
69 // clang-format on
70 
71 // Compile time list of metadata items.
72 // clang-format off
73 #define PERFETTO_TP_METADATA_KEY_TYPES(F) \
74   F(kSingle, "single"),                   \
75   F(kMulti,  "multi")
76 // clang-format
77 
78 // Ignore GCC warning about a missing argument for a variadic macro parameter.
79 #if defined(__GNUC__) || defined(__clang__)
80 #pragma GCC system_header
81 #endif
82 
83 #define PERFETTO_TP_META_TYPE_ENUM(varname, ...) varname
84 enum class KeyType : size_t {
85   PERFETTO_TP_METADATA_KEY_TYPES(PERFETTO_TP_META_TYPE_ENUM),
86   kNumKeyTypes,
87 };
88 
89 #define PERFETTO_TP_META_TYPE_NAME(_, name, ...) name
90 constexpr char const* kKeyTypeNames[] = {
91   PERFETTO_TP_METADATA_KEY_TYPES(PERFETTO_TP_META_TYPE_NAME)
92 };
93 
94 // Declares an enum of literals (one for each item). The enum values of each
95 // literal corresponds to the string index in the arrays below.
96 #define PERFETTO_TP_META_ENUM(name, ...) name
97 enum KeyId : size_t {
98   PERFETTO_TP_METADATA(PERFETTO_TP_META_ENUM),
99   kNumKeys
100 };
101 
102 // The code below declares an array for each property:
103 // name, key type, value type.
104 
105 #define PERFETTO_TP_META_NAME(name, ...) #name
106 constexpr char const* kNames[] = {
107   PERFETTO_TP_METADATA(PERFETTO_TP_META_NAME)};
108 
109 #define PERFETTO_TP_META_KEYTYPE(_, type, ...) type
110 constexpr KeyType kKeyTypes[] = {
111     PERFETTO_TP_METADATA(PERFETTO_TP_META_KEYTYPE)};
112 
113 #define PERFETTO_TP_META_VALUETYPE(_, __, type, ...) type
114 constexpr Variadic::Type kValueTypes[] = {
115     PERFETTO_TP_METADATA(PERFETTO_TP_META_VALUETYPE)};
116 
117 }  // namespace metadata
118 }  // namespace trace_processor
119 }  // namespace perfetto
120 
121 #endif  // SRC_TRACE_PROCESSOR_STORAGE_METADATA_H_
122