2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
5 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
6 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 * This header is meant for liblttng and libust internal use ONLY.
11 * These declarations should NOT be considered stable API.
14 #ifndef _LTTNG_UST_COMM_H
15 #define _LTTNG_UST_COMM_H
20 #include <lttng/ust-abi.h>
21 #include <lttng/ust-error.h>
22 #include <lttng/ust-compiler.h>
23 #include <lttng/ust-ctl.h>
26 #error "LTTNG_PACKED should be defined"
30 * Default timeout the application waits for the sessiond to send its
31 * "register done" command. Can be overridden with the environment
32 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
33 * found, the application proceeds directly without any delay.
35 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
37 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
38 #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
40 /* Queue size of listen(2) */
41 #define LTTNG_UST_COMM_MAX_LISTEN 10
42 #define LTTNG_UST_COMM_REG_MSG_PADDING 64
44 struct lttng_ust_event_field
;
45 struct lttng_ctx_field
;
46 struct lttng_ust_enum_entry
;
47 struct lttng_integer_type
;
50 struct ustctl_reg_msg
{
58 uint32_t bits_per_long
;
59 uint32_t uint8_t_alignment
;
60 uint32_t uint16_t_alignment
;
61 uint32_t uint32_t_alignment
;
62 uint32_t uint64_t_alignment
;
63 uint32_t long_alignment
;
64 uint32_t socket_type
; /* enum ustctl_socket_type */
65 char name
[LTTNG_UST_ABI_PROCNAME_LEN
]; /* process name */
66 char padding
[LTTNG_UST_COMM_REG_MSG_PADDING
];
70 * Data structure for the commands sent from sessiond to UST.
72 #define USTCOMM_MSG_PADDING1 32
73 #define USTCOMM_MSG_PADDING2 32
74 struct ustcomm_ust_msg
{
77 char padding
[USTCOMM_MSG_PADDING1
];
79 struct lttng_ust_abi_channel channel
;
80 struct lttng_ust_abi_stream stream
;
81 struct lttng_ust_abi_event event
;
82 struct lttng_ust_abi_context context
;
83 struct lttng_ust_abi_tracer_version version
;
84 struct lttng_ust_abi_tracepoint_iter tracepoint
;
86 uint32_t data_size
; /* following filter data */
87 uint32_t reloc_offset
;
89 } LTTNG_PACKED filter
;
91 uint32_t count
; /* how many names follow */
92 } LTTNG_PACKED exclusion
;
94 uint32_t data_size
; /* following capture data */
95 uint32_t reloc_offset
;
97 } LTTNG_PACKED capture
;
98 struct lttng_ust_abi_counter counter
;
99 struct lttng_ust_abi_counter_global counter_global
;
100 struct lttng_ust_abi_counter_cpu counter_cpu
;
102 * For lttng_ust_abi_EVENT_NOTIFIER_CREATE, a struct
103 * lttng_ust_abi_event_notifier implicitly follows struct
107 /* Length of struct lttng_ust_abi_event_notifier */
110 char padding
[USTCOMM_MSG_PADDING2
];
115 * Data structure for the response from UST to the session daemon.
116 * cmd_type is sent back in the reply for validation.
118 #define USTCOMM_REPLY_PADDING1 32
119 #define USTCOMM_REPLY_PADDING2 32
120 struct ustcomm_ust_reply
{
123 int32_t ret_code
; /* enum ustcomm_return_code */
124 uint32_t ret_val
; /* return value */
125 char padding
[USTCOMM_REPLY_PADDING1
];
128 uint64_t memory_map_size
;
129 } LTTNG_PACKED channel
;
131 uint64_t memory_map_size
;
132 } LTTNG_PACKED stream
;
133 struct lttng_ust_abi_tracer_version version
;
134 struct lttng_ust_abi_tracepoint_iter tracepoint
;
135 char padding
[USTCOMM_REPLY_PADDING2
];
139 struct ustcomm_notify_hdr
{
143 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
144 struct ustcomm_notify_event_msg
{
145 uint32_t session_objd
;
146 uint32_t channel_objd
;
147 char event_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
149 uint32_t signature_len
;
151 uint32_t model_emf_uri_len
;
152 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
153 /* followed by signature, fields, and model_emf_uri */
156 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
157 struct ustcomm_notify_event_reply
{
158 int32_t ret_code
; /* 0: ok, negative: error code */
160 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
163 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
164 struct ustcomm_notify_enum_msg
{
165 uint32_t session_objd
;
166 char enum_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
167 uint32_t entries_len
;
168 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
169 /* followed by enum entries */
172 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
173 struct ustcomm_notify_enum_reply
{
174 int32_t ret_code
; /* 0: ok, negative: error code */
176 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
179 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
180 struct ustcomm_notify_channel_msg
{
181 uint32_t session_objd
;
182 uint32_t channel_objd
;
183 uint32_t ctx_fields_len
;
184 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
185 /* followed by context fields */
188 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
189 struct ustcomm_notify_channel_reply
{
190 int32_t ret_code
; /* 0: ok, negative: error code */
192 uint32_t header_type
; /* enum ustctl_channel_header */
193 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
197 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
198 * struct lttng_ust_field_iter field.
201 __attribute__((visibility("hidden")))
202 int ustcomm_create_unix_sock(const char *pathname
);
204 __attribute__((visibility("hidden")))
205 int ustcomm_connect_unix_sock(const char *pathname
,
208 __attribute__((visibility("hidden")))
209 int ustcomm_accept_unix_sock(int sock
);
211 __attribute__((visibility("hidden")))
212 int ustcomm_listen_unix_sock(int sock
);
214 __attribute__((visibility("hidden")))
215 int ustcomm_close_unix_sock(int sock
);
217 __attribute__((visibility("hidden")))
218 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
220 __attribute__((visibility("hidden")))
221 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
223 __attribute__((visibility("hidden")))
224 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
226 __attribute__((visibility("hidden")))
227 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
229 __attribute__((visibility("hidden")))
230 const char *ustcomm_get_readable_code(int code
);
232 __attribute__((visibility("hidden")))
233 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
235 __attribute__((visibility("hidden")))
236 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
237 uint32_t expected_handle
, uint32_t expected_cmd
);
239 __attribute__((visibility("hidden")))
240 int ustcomm_send_app_cmd(int sock
,
241 struct ustcomm_ust_msg
*lum
,
242 struct ustcomm_ust_reply
*lur
);
244 __attribute__((visibility("hidden")))
245 int ustcomm_recv_fd(int sock
);
247 __attribute__((visibility("hidden")))
248 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
249 void **chan_data
, uint64_t len
, int *wakeup_fd
);
251 __attribute__((visibility("hidden")))
252 int ustcomm_recv_stream_from_sessiond(int sock
,
253 uint64_t *memory_map_size
,
254 int *shm_fd
, int *wakeup_fd
);
256 __attribute__((visibility("hidden")))
257 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
258 int *event_notifier_notif_fd
);
260 __attribute__((visibility("hidden")))
261 ssize_t
ustcomm_recv_counter_from_sessiond(int sock
,
262 void **counter_data
, uint64_t len
);
264 __attribute__((visibility("hidden")))
265 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
269 * Returns 0 on success, negative error value on error.
270 * Returns -EPIPE or -ECONNRESET if other end has hung up.
272 __attribute__((visibility("hidden")))
273 int ustcomm_send_reg_msg(int sock
,
274 enum ustctl_socket_type type
,
275 uint32_t bits_per_long
,
276 uint32_t uint8_t_alignment
,
277 uint32_t uint16_t_alignment
,
278 uint32_t uint32_t_alignment
,
279 uint32_t uint64_t_alignment
,
280 uint32_t long_alignment
);
283 * Returns 0 on success, negative error value on error.
284 * Returns -EPIPE or -ECONNRESET if other end has hung up.
286 __attribute__((visibility("hidden")))
287 int ustcomm_register_event(int sock
,
288 struct lttng_session
*session
,
289 int session_objd
, /* session descriptor */
290 int channel_objd
, /* channel descriptor */
291 const char *event_name
, /* event name (input) */
293 const char *signature
, /* event signature (input) */
294 size_t nr_fields
, /* fields */
295 const struct lttng_ust_event_field
**fields
,
296 const char *model_emf_uri
,
297 uint32_t *id
); /* event id (output) */
300 * Returns 0 on success, negative error value on error.
301 * Returns -EPIPE or -ECONNRESET if other end has hung up.
303 __attribute__((visibility("hidden")))
304 int ustcomm_register_enum(int sock
,
305 int session_objd
, /* session descriptor */
306 const char *enum_name
, /* enum name (input) */
307 size_t nr_entries
, /* entries */
308 const struct lttng_ust_enum_entry
**entries
,
309 uint64_t *id
); /* enum id (output) */
312 * Returns 0 on success, negative error value on error.
313 * Returns -EPIPE or -ECONNRESET if other end has hung up.
315 __attribute__((visibility("hidden")))
316 int ustcomm_register_channel(int sock
,
317 struct lttng_session
*session
,
318 int session_objd
, /* session descriptor */
319 int channel_objd
, /* channel descriptor */
320 size_t nr_ctx_fields
,
321 const struct lttng_ctx_field
*ctx_fields
,
322 uint32_t *chan_id
, /* channel id (output) */
323 int *header_type
); /* header type (output) */
325 __attribute__((visibility("hidden")))
326 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
328 __attribute__((visibility("hidden")))
329 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
331 #endif /* _LTTNG_UST_COMM_H */