mirror of
https://gitlab.freedesktop.org/wayland/weston.git
synced 2026-05-25 05:48:15 +02:00
3796267cfc
This should be variadic. Nothing uses it, so it hasn't broken yet, but we're about to use it, so clean it up. Signed-off-by: Derek Foreman <derek.foreman@collabora.com>
357 lines
13 KiB
C
357 lines
13 KiB
C
/*
|
|
* Copyright 2022 Google LLC
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
/* This code was taken from the Mesa project, and heavily modified to
|
|
* suit weston's needs.
|
|
*/
|
|
|
|
#ifndef WESTON_TRACE_H
|
|
#define WESTON_TRACE_H
|
|
|
|
#include "perfetto/annotations.h"
|
|
#include "perfetto/u_perfetto.h"
|
|
#include "shared/weston-assert.h"
|
|
#include <string.h>
|
|
|
|
#if defined(HAVE_PERFETTO)
|
|
|
|
#if !defined(HAVE___BUILTIN_EXPECT)
|
|
# define __builtin_expect(x, y) (x)
|
|
#endif
|
|
|
|
#ifndef likely
|
|
# ifdef HAVE___BUILTIN_EXPECT
|
|
# define likely(x) __builtin_expect(!!(x), 1)
|
|
# define unlikely(x) __builtin_expect(!!(x), 0)
|
|
# else
|
|
# define likely(x) (x)
|
|
# define unlikely(x) (x)
|
|
# endif
|
|
#endif
|
|
|
|
/* maximum allowed debug annotations */
|
|
#define WESTON_MAX_DEBUG_ANNOTS 128
|
|
|
|
/* maximum key length */
|
|
#define WESTON_TRACE_MAX_KEY_LENGTH 40
|
|
|
|
/* note that util_perfetto_is_tracing_enabled always returns false until
|
|
* util_perfetto_init is called
|
|
*/
|
|
#define _WESTON_TRACE_BEGIN(name) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
util_perfetto_trace_begin(name); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_FLOW_BEGIN(name, id) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
util_perfetto_trace_begin_flow(name, id); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_END() \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
util_perfetto_trace_end(); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_SET_COUNTER(name, value) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
util_perfetto_counter_set(name, value); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_TIMESTAMP_BEGIN(name, track_id, flow_id, clock, timestamp) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
util_perfetto_trace_full_begin(name, track_id, flow_id, \
|
|
clock, timestamp); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_TIMESTAMP_END(name, track_id, clock, timestamp) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
util_perfetto_trace_full_end(name, track_id, \
|
|
clock, timestamp); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_BEGIN_ANNOTATION() \
|
|
struct weston_debug_annotation __pd_annot[WESTON_MAX_DEBUG_ANNOTS]; \
|
|
struct weston_debug_annotations __pd_annots = { \
|
|
.annots = __pd_annot, \
|
|
.count = 0, \
|
|
}
|
|
|
|
#define _WESTON_TRACE_ANNOTATE_ADD_GENERIC(k, v) \
|
|
static_assert(sizeof(k) < WESTON_TRACE_MAX_KEY_LENGTH); \
|
|
_Generic((v), \
|
|
int: perfetto_annotate_int, \
|
|
bool: perfetto_annotate_bool, \
|
|
unsigned int: perfetto_annotate_int, \
|
|
float: perfetto_annotate_float, \
|
|
double: perfetto_annotate_double, \
|
|
char *: perfetto_annotate_string, \
|
|
const char *: perfetto_annotate_string, \
|
|
struct weston_buffer *: perfetto_annotate_buffer, \
|
|
const struct weston_buffer *: perfetto_annotate_buffer \
|
|
) (&__pd_annots, k, sizeof(k), v);
|
|
|
|
#define _WESTON_TRACE_ANNOTATE_ADD(k, v) \
|
|
do { \
|
|
_WESTON_TRACE_ANNOTATE_ADD_GENERIC(k, v); \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_COMMIT_ANNOTATION(id, name) \
|
|
do { \
|
|
_weston_trace_scope_annotate_commit(id, name, &__pd_annots); \
|
|
} while (0)
|
|
|
|
/* annotated funcs */
|
|
#define _WESTON_TRACE_ANNOTATE_FUNC_BEGIN(name, annots) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) { \
|
|
util_perfetto_trace_commit_annotate_func(name, annots); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_ANNOTATE_FUNC_BEGIN_FLOW(name, id, annots) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) { \
|
|
util_perfetto_trace_commit_annotate_func_flow(id, name, annots); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define _WESTON_TRACE_ANNOTATE(...) \
|
|
do { \
|
|
_WESTON_TRACE_EXPAND(_WESTON_TRACE_ITER_HELPER( \
|
|
_WESTON_TRACE_ANNOTATE_PAIR, __VA_ARGS__)) \
|
|
} while (0)
|
|
|
|
|
|
/* Helpers macros for recursive variadic expansion, never to
|
|
* be used outside of this header.
|
|
*/
|
|
#define _WESTON_TRACE_EXPAND(arg) \
|
|
_WESTON_TRACE_EXPAND1(_WESTON_TRACE_EXPAND1( \
|
|
_WESTON_TRACE_EXPAND1(_WESTON_TRACE_EXPAND1(arg))))
|
|
#define _WESTON_TRACE_EXPAND1(arg) \
|
|
_WESTON_TRACE_EXPAND2(_WESTON_TRACE_EXPAND2( \
|
|
_WESTON_TRACE_EXPAND2(_WESTON_TRACE_EXPAND2(arg))))
|
|
#define _WESTON_TRACE_EXPAND2(arg) arg
|
|
|
|
#define _WESTON_TRACE_ITER_HELPER(operation, pair, ...) \
|
|
operation(pair) \
|
|
__VA_OPT__(_WESTON_TRACE_ITER_AGAIN \
|
|
_WESTON_TRACE_FORCE_RECURSE (operation, __VA_ARGS__))
|
|
#define _WESTON_TRACE_ITER_AGAIN() _WESTON_TRACE_ITER_HELPER
|
|
|
|
#define _WESTON_TRACE_FORCE_RECURSE ()
|
|
#define _WESTON_TRACE_ANNOTATE_PAIR(pair) _WESTON_TRACE_ANNOTATE_ADD_GENERIC pair
|
|
|
|
/* end of helper section */
|
|
#define _WESTON_TRACE_INSTANT_TIMESTAMP(name, track_id, id, clock, timestamp) \
|
|
do { \
|
|
if (unlikely(util_perfetto_is_tracing_enabled())) \
|
|
_weston_trace_instant_timestamp(name, track_id, id, \
|
|
clock, timestamp); \
|
|
} while (0)
|
|
|
|
#if __has_attribute(cleanup) && __has_attribute(unused)
|
|
|
|
#define _WESTON_TRACE_SCOPE_VAR_CONCAT(name, suffix) name##suffix
|
|
#define _WESTON_TRACE_SCOPE_VAR(suffix) \
|
|
_WESTON_TRACE_SCOPE_VAR_CONCAT(_weston_trace_scope_, suffix)
|
|
|
|
/* This must expand to a single non-scoped statement for
|
|
*
|
|
* if (cond)
|
|
* _WESTON_TRACE_SCOPE(...)
|
|
*
|
|
* to work.
|
|
*/
|
|
#define _WESTON_TRACE_SCOPE(name) \
|
|
int _WESTON_TRACE_SCOPE_VAR(__LINE__) \
|
|
__attribute__((cleanup(_weston_trace_scope_end), unused)) = \
|
|
_weston_trace_scope_begin(name)
|
|
|
|
#define _WESTON_TRACE_SCOPE_FLOW(name, id) \
|
|
int _WESTON_TRACE_SCOPE_VAR(__LINE__) \
|
|
__attribute__((cleanup(_weston_trace_scope_end), unused)) = \
|
|
_Generic((id), \
|
|
const uint64_t *: _weston_trace_scope_flow_begin_const, \
|
|
uint64_t *: _weston_trace_scope_flow_begin \
|
|
)(name, id)
|
|
|
|
#define _WESTON_TRACE_ANNOTATE_FUNC(name) \
|
|
int _WESTON_TRACE_SCOPE_VAR(__LINE__) \
|
|
__attribute__((cleanup(_weston_trace_scope_end), unused)) = \
|
|
_weston_trace_annotate_func_begin(name, &__pd_annots)
|
|
|
|
#define _WESTON_TRACE_ANNOTATE_FUNC_FLOW(id, name) \
|
|
int _WESTON_TRACE_SCOPE_VAR(__LINE__) \
|
|
__attribute__((cleanup(_weston_trace_scope_end), unused)) = \
|
|
_Generic((id), \
|
|
uint64_t *: _weston_trace_annotate_func_begin_flow, \
|
|
uint64_t : _weston_trace_annotate_func_begin_const_flow \
|
|
)(name, id, &__pd_annots)
|
|
|
|
static inline int
|
|
_weston_trace_scope_begin(const char *name)
|
|
{
|
|
_WESTON_TRACE_BEGIN(name);
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
_weston_trace_scope_flow_begin(const char *name, uint64_t *id)
|
|
{
|
|
if (*id == 0)
|
|
*id = util_perfetto_next_id();
|
|
_WESTON_TRACE_FLOW_BEGIN(name, *id);
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
_weston_trace_scope_flow_begin_const(const char *name, const uint64_t *id)
|
|
{
|
|
weston_assert_u64_gt(NULL, *id, 0);
|
|
_WESTON_TRACE_FLOW_BEGIN(name, *id);
|
|
return 0;
|
|
}
|
|
|
|
static inline void
|
|
_weston_trace_scope_annotate_commit(uint64_t *id, const char *name,
|
|
struct weston_debug_annotations *annots)
|
|
{
|
|
uint64_t flow_id = 0;
|
|
|
|
if (id) {
|
|
if (*id == 0)
|
|
*id = util_perfetto_next_id();
|
|
|
|
flow_id = *id;
|
|
}
|
|
|
|
if (unlikely(util_perfetto_is_tracing_enabled()))
|
|
util_perfetto_trace_commit_debug_annots(flow_id, name, annots);
|
|
|
|
annots->count = 0;
|
|
}
|
|
|
|
static inline int
|
|
_weston_trace_annotate_func_begin(const char *name,
|
|
struct weston_debug_annotations *annots)
|
|
{
|
|
_WESTON_TRACE_ANNOTATE_FUNC_BEGIN(name, annots);
|
|
|
|
annots->count = 0;
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
_weston_trace_annotate_func_begin_flow(const char *name, uint64_t *id,
|
|
struct weston_debug_annotations *annots)
|
|
{
|
|
if (*id == 0)
|
|
*id = util_perfetto_next_id();
|
|
|
|
_WESTON_TRACE_ANNOTATE_FUNC_BEGIN_FLOW(name, *id, annots);
|
|
|
|
annots->count = 0;
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
_weston_trace_instant_timestamp(const char *name, uint64_t track_id, uint64_t id,
|
|
clock_t clock, uint64_t ts)
|
|
{
|
|
weston_assert_u64_gt(NULL, id, 0);
|
|
util_perfetto_trace_instant_timestamp(name, track_id, id, clock, ts);
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
_weston_trace_annotate_func_begin_const_flow(const char *name, uint64_t id,
|
|
struct weston_debug_annotations *annots)
|
|
{
|
|
weston_assert_u64_gt(NULL, id, 0);
|
|
_WESTON_TRACE_ANNOTATE_FUNC_BEGIN_FLOW(name, id, annots);
|
|
|
|
annots->count = 0;
|
|
return 0;
|
|
}
|
|
|
|
|
|
static inline void
|
|
_weston_trace_scope_end(int *scope)
|
|
{
|
|
_WESTON_TRACE_END();
|
|
}
|
|
|
|
#else
|
|
|
|
#define _WESTON_TRACE_SCOPE(name)
|
|
|
|
#endif /* __has_attribute(cleanup) && __has_attribute(unused) */
|
|
|
|
#else /* No perfetto, make these all do nothing */
|
|
|
|
#define _WESTON_TRACE_SCOPE(name)
|
|
#define _WESTON_TRACE_SCOPE_FLOW(name, id)
|
|
#define _WESTON_TRACE_FUNC()
|
|
#define _WESTON_TRACE_FUNC_FLOW(id)
|
|
#define _WESTON_TRACE_SET_COUNTER(name, value)
|
|
#define _WESTON_TRACE_TIMESTAMP_BEGIN(name, track_id, flow_id, clock, timestamp)
|
|
#define _WESTON_TRACE_TIMESTAMP_END(name, track_id, clock, timestamp)
|
|
#define _WESTON_TRACE_INSTANT_TIMESTAMP(name, track_id, id, clock, timestamp)
|
|
|
|
#define _WESTON_TRACE_BEGIN_ANNOTATION()
|
|
#define _WESTON_TRACE_COMMIT_ANNOTATION(id, name)
|
|
#define _WESTON_TRACE_ANNOTATE_FUNC(...)
|
|
#define _WESTON_TRACE_ANNOTATE_FUNC_FLOW(id, name)
|
|
#define _WESTON_TRACE_ANNOTATE(...)
|
|
|
|
#endif /* HAVE_PERFETTO */
|
|
|
|
#define WESTON_TRACE_SCOPE(name) _WESTON_TRACE_SCOPE(name)
|
|
#define WESTON_TRACE_SCOPE_FLOW(name, id) _WESTON_TRACE_SCOPE_FLOW(name, id)
|
|
#define WESTON_TRACE_FUNC() _WESTON_TRACE_SCOPE(__func__)
|
|
#define WESTON_TRACE_FUNC_FLOW(id) _WESTON_TRACE_SCOPE_FLOW(__func__, id)
|
|
#define WESTON_TRACE_SET_COUNTER(name, value) _WESTON_TRACE_SET_COUNTER(name, value)
|
|
#define WESTON_TRACE_TIMESTAMP_BEGIN(name, track_id, flow_id, clock, timestamp) \
|
|
_WESTON_TRACE_TIMESTAMP_BEGIN(name, track_id, flow_id, clock, timestamp)
|
|
#define WESTON_TRACE_TIMESTAMP_END(name, track_id, clock, timestamp) \
|
|
_WESTON_TRACE_TIMESTAMP_END(name, track_id, clock, timestamp)
|
|
#define WESTON_TRACE_INSTANT_TIMESTAMP(name, track_id, id, clock, timestamp) \
|
|
_WESTON_TRACE_INSTANT_TIMESTAMP(name, track_id, id, clock, timestamp)
|
|
|
|
|
|
#define WESTON_TRACE_BEGIN_ANNOTATION() \
|
|
_WESTON_TRACE_BEGIN_ANNOTATION()
|
|
|
|
#define WESTON_TRACE_COMMIT_ANNOTATION(id) \
|
|
_WESTON_TRACE_COMMIT_ANNOTATION(id, __func__)
|
|
|
|
#define WESTON_TRACE_ANNOTATE_FUNC(...) \
|
|
WESTON_TRACE_BEGIN_ANNOTATION(); \
|
|
WESTON_TRACE_ANNOTATE(__VA_ARGS__); \
|
|
_WESTON_TRACE_ANNOTATE_FUNC(__func__)
|
|
|
|
#define WESTON_TRACE_ANNOTATE_FUNC_FLOW(id, ...) \
|
|
WESTON_TRACE_BEGIN_ANNOTATION(); \
|
|
WESTON_TRACE_ANNOTATE(__VA_ARGS__); \
|
|
_WESTON_TRACE_ANNOTATE_FUNC_FLOW(id, __func__)
|
|
|
|
/* Adds a series of annotations of the form '("key string", value)' separated
|
|
* by commas.
|
|
*
|
|
* Brackets are necessary, and the value can be any type understood by the
|
|
* _Generic block in _WESTON_TRACE_ANNOTATE_ADD
|
|
*/
|
|
#define WESTON_TRACE_ANNOTATE(...) \
|
|
_WESTON_TRACE_ANNOTATE(__VA_ARGS__)
|
|
|
|
#endif /* WESTON_TRACE_H */
|