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
|
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UTIL_TRACE_LOGGING_H_
#define UTIL_TRACE_LOGGING_H_
#include "build/config/features.h"
#include "platform/base/trace_logging_types.h"
// All compile-time macros for tracing.
// NOTE: The ternary operator is used here to ensure that the TraceLogger object
// is only constructed if tracing is enabled, but at the same time is created in
// the caller's scope. The C++ standards guide guarantees that the constructor
// should only be called when IsTraceLoggingEnabled(...) evaluates to true.
// static_cast calls are used because if the type of the result of the ternary
// operator does not match the expected type, temporary storage is used for the
// created object, which results in an extra call to the constructor and
// destructor of the tracing objects.
//
// Further details about how these macros are used can be found in
// docs/trace_logging.md.
// TODO(rwkeane): Add support for user-provided properties.
#if defined(ENABLE_TRACE_LOGGING)
#define INCLUDING_FROM_UTIL_TRACE_LOGGING_H_
#include "util/trace_logging/macro_support.h"
#undef INCLUDING_FROM_UTIL_TRACE_LOGGING_H_
#define TRACE_SET_RESULT(result) \
do { \
if (TRACE_IS_ENABLED(openscreen::TraceCategory::Value::Any)) { \
openscreen::internal::ScopedTraceOperation::set_result(result); \
} \
} while (false)
#define TRACE_SET_HIERARCHY(ids) TRACE_SET_HIERARCHY_INTERNAL(__LINE__, ids)
#define TRACE_HIERARCHY \
(TRACE_IS_ENABLED(openscreen::TraceCategory::Value::Any) \
? openscreen::internal::ScopedTraceOperation::hierarchy() \
: openscreen::TraceIdHierarchy::Empty())
#define TRACE_CURRENT_ID \
(TRACE_IS_ENABLED(openscreen::TraceCategory::Value::Any) \
? openscreen::internal::ScopedTraceOperation::current_id() \
: kEmptyTraceId)
#define TRACE_ROOT_ID \
(TRACE_IS_ENABLED(openscreen::TraceCategory::Value::Any) \
? openscreen::internal::ScopedTraceOperation::root_id() \
: kEmptyTraceId)
// Synchronous Trace Macro.
#define TRACE_SCOPED(category, name, ...) \
TRACE_SCOPED_INTERNAL(__LINE__, category, name, ##__VA_ARGS__)
// Asynchronous Trace Macros.
#define TRACE_ASYNC_START(category, name, ...) \
TRACE_ASYNC_START_INTERNAL(__LINE__, category, name, ##__VA_ARGS__)
#define TRACE_ASYNC_END(category, id, result) \
TRACE_IS_ENABLED(category) \
? openscreen::internal::ScopedTraceOperation::TraceAsyncEnd( \
__LINE__, __FILE__, id, result) \
: false
#else // ENABLE_TRACE_LOGGING not defined
namespace openscreen {
namespace internal {
// Consumes |args| (to avoid "warn unused variable" errors at compile time), and
// provides a "void" result type in the macros below.
template <typename... Args>
inline void DoNothingForTracing(Args... args) {}
} // namespace internal
} // namespace openscreen
#define TRACE_SET_RESULT(result) \
openscreen::internal::DoNothingForTracing(result)
#define TRACE_SET_HIERARCHY(ids) openscreen::internal::DoNothingForTracing(ids)
#define TRACE_HIERARCHY openscreen::TraceIdHierarchy::Empty()
#define TRACE_CURRENT_ID openscreen::kEmptyTraceId
#define TRACE_ROOT_ID openscreen::kEmptyTraceId
#define TRACE_SCOPED(category, name, ...) \
openscreen::internal::DoNothingForTracing(category, name, ##__VA_ARGS__)
#define TRACE_ASYNC_START(category, name, ...) \
openscreen::internal::DoNothingForTracing(category, name, ##__VA_ARGS__)
#define TRACE_ASYNC_END(category, id, result) \
openscreen::internal::DoNothingForTracing(category, id, result)
#endif // defined(ENABLE_TRACE_LOGGING)
#endif // UTIL_TRACE_LOGGING_H_
|
