2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * The context provider feature is part of the ABI and used by the Java jni
7 * interface. This header should be moved to the public header directory once
8 * some test code and documentation is written.
11 #ifndef _LTTNG_UST_CONTEXT_PROVIDER_H
12 #define _LTTNG_UST_CONTEXT_PROVIDER_H
15 #include <lttng/ust-config.h>
16 #include <lttng/ust-events.h>
18 #include "common/dynamic-type.h"
20 struct lttng_ust_registered_context_provider
;
21 struct lttng_ust_probe_ctx
;
26 * IMPORTANT: this structure is part of the ABI between the probe and
27 * UST. Additional selectors may be added in the future, mapping to new
28 * union fields, which means the overall size of this structure may
29 * increase. This means this structure should never be nested within a
30 * public structure interface, nor embedded in an array.
33 struct lttng_ust_ctx_value
{
34 enum lttng_ust_dynamic_type sel
; /* Type selector */
46 * IMPORTANT: this structure is part of the ABI between the probe and
47 * UST. Fields need to be only added at the end, never reordered, never
50 * The field @struct_size should be used to determine the size of the
51 * structure. It should be queried before using additional fields added
52 * at the end of the structure.
55 struct lttng_ust_context_provider
{
59 size_t (*get_size
)(void *priv
, struct lttng_ust_probe_ctx
*probe_ctx
,
61 void (*record
)(void *priv
, struct lttng_ust_probe_ctx
*probe_ctx
,
62 struct lttng_ust_ring_buffer_ctx
*ctx
,
63 struct lttng_ust_channel_buffer
*chan
);
64 void (*get_value
)(void *priv
, struct lttng_ust_probe_ctx
*probe_ctx
,
65 struct lttng_ust_ctx_value
*value
);
68 /* End of base ABI. Fields below should be used after checking struct_size. */
72 * Application context callback private data
74 * IMPORTANT: this structure is part of the ABI between the probe and
75 * UST. Fields need to be only added at the end, never reordered, never
78 * The field @struct_size should be used to determine the size of the
79 * structure. It should be queried before using additional fields added
80 * at the end of the structure.
83 struct lttng_ust_app_context
{
86 struct lttng_ust_event_field
*event_field
;
89 /* End of base ABI. Fields below should be used after checking struct_size. */
92 /* Custom upgrade 2.12 to 2.13 */
93 #ifndef LTTNG_UST_CUSTOM_UPGRADE_CONFLICTING_SYMBOLS
94 #define lttng_ust_context_provider_register lttng_ust_context_provider_register1
95 #define lttng_ust_context_provider_unregister lttng_ust_context_provider_unregister1
99 * Returns an opaque pointer on success, which must be passed to
100 * lttng_ust_context_provider_unregister for unregistration. Returns
103 struct lttng_ust_registered_context_provider
*lttng_ust_context_provider_register(struct lttng_ust_context_provider
*provider
);
105 void lttng_ust_context_provider_unregister(struct lttng_ust_registered_context_provider
*reg_provider
);
107 #endif /* _LTTNG_UST_CONTEXT_PROVIDER_H */