1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/*
* Copyright (C) 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef INCLUDE_PERFETTO_TRACING_DEBUG_ANNOTATION_H_
#define INCLUDE_PERFETTO_TRACING_DEBUG_ANNOTATION_H_
#include "perfetto/base/export.h"
#include "protos/perfetto/trace/track_event/debug_annotation.pbzero.h"
#include <stdint.h>
#include <memory>
#include <string>
namespace {
// std::underlying_type can't be used with non-enum types, so we need this
// indirection.
template <typename T, bool = std::is_enum<T>::value>
struct safe_underlying_type {
using type = typename std::underlying_type<T>::type;
};
template <typename T>
struct safe_underlying_type<T, false> {
using type = T;
};
} // namespace
namespace perfetto {
namespace protos {
namespace pbzero {
class DebugAnnotation;
} // namespace pbzero
} // namespace protos
// A base class for custom track event debug annotations.
class PERFETTO_EXPORT DebugAnnotation {
public:
DebugAnnotation() = default;
virtual ~DebugAnnotation();
// Called to write the contents of the debug annotation into the trace.
virtual void Add(protos::pbzero::DebugAnnotation*) const = 0;
};
namespace internal {
// Overloads for all the supported built in debug annotation types. Numeric
// types are handled with templates to avoid problems with overloading
// platform-specific types (e.g., size_t).
void PERFETTO_EXPORT WriteDebugAnnotation(protos::pbzero::DebugAnnotation*,
const char*);
void PERFETTO_EXPORT WriteDebugAnnotation(protos::pbzero::DebugAnnotation*,
const std::string&);
void PERFETTO_EXPORT WriteDebugAnnotation(protos::pbzero::DebugAnnotation*,
const void*);
void PERFETTO_EXPORT WriteDebugAnnotation(protos::pbzero::DebugAnnotation*,
const DebugAnnotation&);
template <typename T>
void WriteDebugAnnotation(
protos::pbzero::DebugAnnotation* annotation,
T value,
typename std::enable_if<std::is_floating_point<T>::value>::type* =
nullptr) {
annotation->set_double_value(static_cast<double>(value));
}
template <typename T>
void WriteDebugAnnotation(
protos::pbzero::DebugAnnotation* annotation,
T value,
typename std::enable_if<std::is_integral<T>::value &&
!std::is_same<T, bool>::value &&
std::is_signed<T>::value>::type* = nullptr) {
annotation->set_int_value(value);
}
template <typename T>
void WriteDebugAnnotation(
protos::pbzero::DebugAnnotation* annotation,
T value,
typename std::enable_if<
std::is_enum<T>::value &&
std::is_signed<typename safe_underlying_type<T>::type>::value>::type* =
nullptr) {
annotation->set_int_value(value);
}
template <typename T>
void WriteDebugAnnotation(
protos::pbzero::DebugAnnotation* annotation,
T value,
typename std::enable_if<std::is_enum<T>::value &&
std::is_unsigned<typename safe_underlying_type<
T>::type>::value>::type* = nullptr) {
annotation->set_uint_value(value);
}
template <typename T>
void WriteDebugAnnotation(
protos::pbzero::DebugAnnotation* annotation,
T value,
typename std::enable_if<std::is_integral<T>::value &&
!std::is_same<T, bool>::value &&
std::is_unsigned<T>::value>::type* = nullptr) {
annotation->set_uint_value(value);
}
template <typename T>
void WriteDebugAnnotation(
protos::pbzero::DebugAnnotation* annotation,
T value,
typename std::enable_if<std::is_same<T, bool>::value>::type* = nullptr) {
annotation->set_bool_value(value);
}
template <typename T>
void WriteDebugAnnotation(protos::pbzero::DebugAnnotation* annotation,
const std::unique_ptr<T>& value) {
WriteDebugAnnotation(annotation, *value);
}
} // namespace internal
} // namespace perfetto
#endif // INCLUDE_PERFETTO_TRACING_DEBUG_ANNOTATION_H_
|
