Update lttng-ust header copy for disabled UST compilation
[lttng-tools.git] / src / bin / lttng-sessiond / lttng-ust-abi.h
1 #ifndef _LTTNG_UST_ABI_H
2 #define _LTTNG_UST_ABI_H
3
4 /*
5 * lttng/ust-abi.h
6 *
7 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * LTTng-UST ABI header
10 *
11 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
12 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
23 */
24
25 #include <stdint.h>
26
27 #define LTTNG_UST_SYM_NAME_LEN 256
28
29 #define LTTNG_UST_COMM_VERSION_MAJOR 2
30 #define LTTNG_UST_COMM_VERSION_MINOR 0
31
32 enum lttng_ust_instrumentation {
33 LTTNG_UST_TRACEPOINT = 0,
34 LTTNG_UST_PROBE = 1,
35 LTTNG_UST_FUNCTION = 2,
36 };
37
38 enum lttng_ust_loglevel_type {
39 LTTNG_UST_LOGLEVEL_ALL = 0,
40 LTTNG_UST_LOGLEVEL_RANGE = 1,
41 LTTNG_UST_LOGLEVEL_SINGLE = 2,
42 };
43
44 enum lttng_ust_output {
45 LTTNG_UST_MMAP = 0,
46 };
47
48 struct lttng_ust_tracer_version {
49 uint32_t major;
50 uint32_t minor;
51 uint32_t patchlevel;
52 };
53
54 #define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32
55 struct lttng_ust_channel {
56 int overwrite; /* 1: overwrite, 0: discard */
57 uint64_t subbuf_size; /* in bytes */
58 uint64_t num_subbuf;
59 unsigned int switch_timer_interval; /* usecs */
60 unsigned int read_timer_interval; /* usecs */
61 enum lttng_ust_output output; /* output mode */
62 char padding[LTTNG_UST_CHANNEL_PADDING];
63 };
64
65 #define LTTNG_UST_STREAM_PADDING1 16
66 #define LTTNG_UST_STREAM_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
67 struct lttng_ust_stream {
68 char padding[LTTNG_UST_STREAM_PADDING1];
69
70 union {
71 char padding[LTTNG_UST_STREAM_PADDING2];
72 } u;
73 };
74
75 #define LTTNG_UST_EVENT_PADDING1 16
76 #define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
77 struct lttng_ust_event {
78 enum lttng_ust_instrumentation instrumentation;
79 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
80
81 enum lttng_ust_loglevel_type loglevel_type;
82 int loglevel; /* value, -1: all */
83 char padding[LTTNG_UST_EVENT_PADDING1];
84
85 /* Per instrumentation type configuration */
86 union {
87 char padding[LTTNG_UST_EVENT_PADDING2];
88 } u;
89 };
90
91 enum lttng_ust_field_type {
92 LTTNG_UST_FIELD_OTHER = 0,
93 LTTNG_UST_FIELD_INTEGER = 1,
94 LTTNG_UST_FIELD_ENUM = 2,
95 LTTNG_UST_FIELD_FLOAT = 3,
96 LTTNG_UST_FIELD_STRING = 4,
97 };
98
99 #define LTTNG_UST_FIELD_ITER_PADDING LTTNG_UST_SYM_NAME_LEN + 32
100 struct lttng_ust_field_iter {
101 char event_name[LTTNG_UST_SYM_NAME_LEN];
102 char field_name[LTTNG_UST_SYM_NAME_LEN];
103 enum lttng_ust_field_type type;
104 int loglevel; /* event loglevel */
105 char padding[LTTNG_UST_FIELD_ITER_PADDING];
106 };
107
108 enum lttng_ust_context_type {
109 LTTNG_UST_CONTEXT_VTID = 0,
110 LTTNG_UST_CONTEXT_VPID = 1,
111 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
112 LTTNG_UST_CONTEXT_PROCNAME = 3,
113 };
114
115 #define LTTNG_UST_CONTEXT_PADDING1 16
116 #define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
117 struct lttng_ust_context {
118 enum lttng_ust_context_type ctx;
119 char padding[LTTNG_UST_CONTEXT_PADDING1];
120
121 union {
122 char padding[LTTNG_UST_CONTEXT_PADDING2];
123 } u;
124 };
125
126 /*
127 * Tracer channel attributes.
128 */
129 #define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32
130 struct lttng_ust_channel_attr {
131 int overwrite; /* 1: overwrite, 0: discard */
132 uint64_t subbuf_size; /* bytes */
133 uint64_t num_subbuf; /* power of 2 */
134 unsigned int switch_timer_interval; /* usec */
135 unsigned int read_timer_interval; /* usec */
136 enum lttng_ust_output output; /* splice, mmap */
137 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
138 };
139
140 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
141 struct lttng_ust_tracepoint_iter {
142 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
143 int loglevel;
144 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
145 };
146
147 #define LTTNG_UST_OBJECT_DATA_PADDING LTTNG_UST_SYM_NAME_LEN + 32
148 struct lttng_ust_object_data {
149 int handle;
150 int shm_fd;
151 int wait_fd;
152 uint64_t memory_map_size;
153 char padding[LTTNG_UST_OBJECT_DATA_PADDING];
154 };
155
156 enum lttng_ust_calibrate_type {
157 LTTNG_UST_CALIBRATE_TRACEPOINT,
158 };
159
160 #define LTTNG_UST_CALIBRATE_PADDING1 16
161 #define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
162 struct lttng_ust_calibrate {
163 enum lttng_ust_calibrate_type type; /* type (input) */
164 char padding[LTTNG_UST_CALIBRATE_PADDING1];
165
166 union {
167 char padding[LTTNG_UST_CALIBRATE_PADDING2];
168 } u;
169 };
170
171 #define _UST_CMD(minor) (minor)
172 #define _UST_CMDR(minor, type) (minor)
173 #define _UST_CMDW(minor, type) (minor)
174
175 /* Handled by object descriptor */
176 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
177
178 /* Handled by object cmd */
179
180 /* LTTng-UST commands */
181 #define LTTNG_UST_SESSION _UST_CMD(0x40)
182 #define LTTNG_UST_TRACER_VERSION \
183 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
184 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
185 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
186 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
187 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
188
189 /* Session FD commands */
190 #define LTTNG_UST_METADATA \
191 _UST_CMDW(0x50, struct lttng_ust_channel)
192 #define LTTNG_UST_CHANNEL \
193 _UST_CMDW(0x51, struct lttng_ust_channel)
194 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
195 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
196
197 /* Channel FD commands */
198 #define LTTNG_UST_STREAM _UST_CMD(0x60)
199 #define LTTNG_UST_EVENT \
200 _UST_CMDW(0x61, struct lttng_ust_event)
201
202 /* Event and Channel FD commands */
203 #define LTTNG_UST_CONTEXT \
204 _UST_CMDW(0x70, struct lttng_ust_context)
205 #define LTTNG_UST_FLUSH_BUFFER \
206 _UST_CMD(0x71)
207
208 /* Event, Channel and Session commands */
209 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
210 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
211
212 /* Tracepoint list commands */
213 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
214 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
215
216 #define LTTNG_UST_ROOT_HANDLE 0
217
218 struct lttng_ust_obj;
219
220 union ust_args {
221 struct {
222 int *shm_fd;
223 int *wait_fd;
224 uint64_t *memory_map_size;
225 } channel;
226 struct {
227 int *shm_fd;
228 int *wait_fd;
229 uint64_t *memory_map_size;
230 } stream;
231 struct {
232 struct lttng_ust_field_iter entry;
233 } field_list;
234 };
235
236 struct lttng_ust_objd_ops {
237 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
238 union ust_args *args);
239 int (*release)(int objd);
240 };
241
242 /* Create root handle. Always ID 0. */
243 int lttng_abi_create_root_handle(void);
244
245 const struct lttng_ust_objd_ops *objd_ops(int id);
246 int lttng_ust_objd_unref(int id);
247
248 void lttng_ust_abi_exit(void);
249 void lttng_ust_events_exit(void);
250
251 #endif /* _LTTNG_UST_ABI_H */
This page took 0.051361 seconds and 4 git commands to generate.