1 #ifndef _LTTNG_UST_ABI_H
2 #define _LTTNG_UST_ABI_H
7 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * Dual LGPL v2.1/GPL v2 license.
16 #define LTTNG_UST_SYM_NAME_LEN 256
18 #define LTTNG_UST_COMM_VERSION_MAJOR 0
19 #define LTTNG_UST_COMM_VERSION_MINOR 1
21 enum lttng_ust_instrumentation
{
22 LTTNG_UST_TRACEPOINT
= 0,
24 LTTNG_UST_FUNCTION
= 2,
25 LTTNG_UST_TRACEPOINT_LOGLEVEL
= 3,
28 enum lttng_ust_output
{
32 struct lttng_ust_tracer_version
{
38 struct lttng_ust_channel
{
39 int overwrite
; /* 1: overwrite, 0: discard */
40 uint64_t subbuf_size
; /* in bytes */
42 unsigned int switch_timer_interval
; /* usecs */
43 unsigned int read_timer_interval
; /* usecs */
44 enum lttng_ust_output output
; /* output mode */
45 /* The following fields are used internally within UST. */
48 uint64_t memory_map_size
;
52 * This structure is only used internally within UST. It is not per-se
53 * part of the communication between sessiond and UST.
55 struct lttng_ust_stream
{
58 uint64_t memory_map_size
;
61 struct lttng_ust_event
{
62 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
63 enum lttng_ust_instrumentation instrumentation
;
64 /* Per instrumentation type configuration */
69 enum lttng_ust_context_type
{
70 LTTNG_UST_CONTEXT_VTID
= 0,
71 LTTNG_UST_CONTEXT_VPID
= 1,
72 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
73 LTTNG_UST_CONTEXT_PROCNAME
= 3,
76 struct lttng_ust_context
{
77 enum lttng_ust_context_type ctx
;
83 * Tracer channel attributes.
85 struct lttng_ust_channel_attr
{
86 int overwrite
; /* 1: overwrite, 0: discard */
87 uint64_t subbuf_size
; /* bytes */
88 uint64_t num_subbuf
; /* power of 2 */
89 unsigned int switch_timer_interval
; /* usec */
90 unsigned int read_timer_interval
; /* usec */
91 enum lttng_ust_output output
; /* splice, mmap */
94 struct lttng_ust_tracepoint_iter
{
95 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
96 char loglevel
[LTTNG_UST_SYM_NAME_LEN
]; /* loglevel */
97 int64_t loglevel_value
;
100 struct lttng_ust_object_data
{
104 uint64_t memory_map_size
;
107 #define _UST_CMD(minor) (minor)
108 #define _UST_CMDR(minor, type) (minor)
109 #define _UST_CMDW(minor, type) (minor)
111 /* Handled by object descriptor */
112 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
114 /* Handled by object cmd */
116 /* LTTng-UST commands */
117 #define LTTNG_UST_SESSION _UST_CMD(0x40)
118 #define LTTNG_UST_TRACER_VERSION \
119 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
120 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
121 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
122 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
124 /* Session FD commands */
125 #define LTTNG_UST_METADATA \
126 _UST_CMDW(0x50, struct lttng_ust_channel)
127 #define LTTNG_UST_CHANNEL \
128 _UST_CMDW(0x51, struct lttng_ust_channel)
129 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
130 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
132 /* Channel FD commands */
133 #define LTTNG_UST_STREAM _UST_CMD(0x60)
134 #define LTTNG_UST_EVENT \
135 _UST_CMDW(0x61, struct lttng_ust_event)
137 /* Event and Channel FD commands */
138 #define LTTNG_UST_CONTEXT \
139 _UST_CMDW(0x70, struct lttng_ust_context)
140 #define LTTNG_UST_FLUSH_BUFFER \
143 /* Event, Channel and Session commands */
144 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
145 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
147 /* Tracepoint list commands */
148 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
150 #define LTTNG_UST_ROOT_HANDLE 0
152 struct lttng_ust_obj
;
154 struct lttng_ust_objd_ops
{
155 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
);
156 int (*release
)(int objd
);
159 /* Create root handle. Always ID 0. */
160 int lttng_abi_create_root_handle(void);
162 const struct lttng_ust_objd_ops
*objd_ops(int id
);
163 int lttng_ust_objd_unref(int id
);
165 void lttng_ust_abi_exit(void);
166 void lttng_ust_events_exit(void);
168 #endif /* _LTTNG_UST_ABI_H */