2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2011 EfficiOS Inc.
5 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * This header is meant for liblttng and libust internal use ONLY.
10 * These declarations should NOT be considered stable API.
13 #ifndef _UST_COMMON_UST_COMM_H
14 #define _UST_COMMON_UST_COMM_H
19 #include <lttng/ust-abi.h>
20 #include <lttng/ust-abi-old.h>
21 #include <lttng/ust-error.h>
22 #include <lttng/ust-compiler.h>
23 #include <lttng/ust-ctl.h>
26 * Default timeout the application waits for the sessiond to send its
27 * "register done" command. Can be overridden with the environment
28 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
29 * found, the application proceeds directly without any delay.
31 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000
33 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
34 #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
36 /* Queue size of listen(2) */
37 #define LTTNG_UST_COMM_MAX_LISTEN 10
38 #define LTTNG_UST_COMM_REG_MSG_PADDING 64
40 struct lttng_ust_event_field
;
41 struct lttng_ust_ctx_field
;
42 struct lttng_ust_enum_entry
;
43 struct lttng_integer_type
;
44 struct lttng_ust_session
;
46 struct lttng_ust_ctl_reg_msg
{
54 uint32_t bits_per_long
;
55 uint32_t uint8_t_alignment
;
56 uint32_t uint16_t_alignment
;
57 uint32_t uint32_t_alignment
;
58 uint32_t uint64_t_alignment
;
59 uint32_t long_alignment
;
60 uint32_t socket_type
; /* enum lttng_ust_ctl_socket_type */
61 char name
[LTTNG_UST_ABI_PROCNAME_LEN
]; /* process name */
62 char padding
[LTTNG_UST_COMM_REG_MSG_PADDING
];
63 } __attribute__((packed
));
66 * Data structure for the commands sent from sessiond to UST.
68 #define USTCOMM_MSG_PADDING1 32
69 #define USTCOMM_MSG_PADDING2 32
70 struct ustcomm_ust_msg
{
73 char padding
[USTCOMM_MSG_PADDING1
];
75 struct lttng_ust_abi_channel channel
;
76 struct lttng_ust_abi_stream stream
;
77 struct lttng_ust_abi_event event
;
78 struct lttng_ust_abi_context context
;
79 struct lttng_ust_abi_tracer_version version
;
80 struct lttng_ust_abi_tracepoint_iter tracepoint
;
82 uint32_t data_size
; /* following filter data */
83 uint32_t reloc_offset
;
85 } __attribute__((packed
)) filter
;
87 uint32_t count
; /* how many names follow */
88 } __attribute__((packed
)) exclusion
;
90 uint32_t data_size
; /* following capture data */
91 uint32_t reloc_offset
;
93 } __attribute__((packed
)) capture
;
94 struct lttng_ust_abi_old_counter counter_old
;
95 struct lttng_ust_abi_old_counter_global counter_global_old
;
96 struct lttng_ust_abi_old_counter_cpu counter_cpu_old
;
99 } __attribute__((packed
)) var_len_cmd
;
100 char padding
[USTCOMM_MSG_PADDING2
];
102 } __attribute__((packed
));
105 * Data structure for the response from UST to the session daemon.
106 * cmd_type is sent back in the reply for validation.
108 #define USTCOMM_REPLY_PADDING1 32
109 #define USTCOMM_REPLY_PADDING2 32
110 struct ustcomm_ust_reply
{
113 int32_t ret_code
; /* enum ustcomm_return_code */
114 uint32_t ret_val
; /* return value */
115 char padding
[USTCOMM_REPLY_PADDING1
];
118 uint64_t memory_map_size
;
119 } __attribute__((packed
)) channel
;
121 uint64_t memory_map_size
;
122 } __attribute__((packed
)) stream
;
123 struct lttng_ust_abi_tracer_version version
;
124 struct lttng_ust_abi_tracepoint_iter tracepoint
;
125 char padding
[USTCOMM_REPLY_PADDING2
];
127 } __attribute__((packed
));
129 struct ustcomm_notify_hdr
{
131 } __attribute__((packed
));
133 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 24
134 struct ustcomm_notify_event_msg
{
135 uint32_t session_objd
;
136 uint32_t channel_objd
;
137 char event_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
139 uint32_t signature_len
;
141 uint32_t model_emf_uri_len
;
143 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
144 /* followed by signature, fields, and model_emf_uri */
145 } __attribute__((packed
));
147 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
148 struct ustcomm_notify_event_reply
{
149 int32_t ret_code
; /* 0: ok, negative: error code */
150 uint32_t id
; /* 32-bit event id. */
151 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
152 } __attribute__((packed
));
154 #define USTCOMM_NOTIFY_KEY_MSG_PADDING 24
155 struct ustcomm_notify_key_msg
{
156 uint32_t session_objd
;
159 uint32_t key_string_len
;
161 char padding
[USTCOMM_NOTIFY_KEY_MSG_PADDING
];
162 /* followed by dimension_indexes (array of @dimension uint64_t items) and key_string. */
163 } __attribute__((packed
));
165 #define USTCOMM_NOTIFY_KEY_REPLY_PADDING 32
166 struct ustcomm_notify_key_reply
{
167 int32_t ret_code
; /* 0: ok, negative: error code */
168 uint64_t index
; /* 64-bit key index. */
169 char padding
[USTCOMM_NOTIFY_KEY_REPLY_PADDING
];
170 } __attribute__((packed
));
172 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
173 struct ustcomm_notify_enum_msg
{
174 uint32_t session_objd
;
175 char enum_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
176 uint32_t entries_len
;
177 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
178 /* followed by enum entries */
179 } __attribute__((packed
));
181 #define USTCOMM_NOTIFY_ENUM_REPLY_PADDING 32
182 struct ustcomm_notify_enum_reply
{
183 int32_t ret_code
; /* 0: ok, negative: error code */
185 char padding
[USTCOMM_NOTIFY_ENUM_REPLY_PADDING
];
186 } __attribute__((packed
));
188 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
189 struct ustcomm_notify_channel_msg
{
190 uint32_t session_objd
;
191 uint32_t channel_objd
;
192 uint32_t ctx_fields_len
;
193 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
194 /* followed by context fields */
195 } __attribute__((packed
));
197 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
198 struct ustcomm_notify_channel_reply
{
199 int32_t ret_code
; /* 0: ok, negative: error code */
201 uint32_t header_type
; /* enum lttng_ust_ctl_channel_header */
202 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
203 } __attribute__((packed
));
206 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
207 * struct lttng_ust_field_iter field.
210 int ustcomm_create_unix_sock(const char *pathname
)
211 __attribute__((visibility("hidden")));
213 int ustcomm_connect_unix_sock(const char *pathname
,
215 __attribute__((visibility("hidden")));
217 int ustcomm_accept_unix_sock(int sock
)
218 __attribute__((visibility("hidden")));
220 int ustcomm_listen_unix_sock(int sock
)
221 __attribute__((visibility("hidden")));
223 int ustcomm_shutdown_unix_sock(int sock
)
224 __attribute__((visibility("hidden")));
226 int ustcomm_close_unix_sock(int sock
)
227 __attribute__((visibility("hidden")));
229 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
230 __attribute__((visibility("hidden")));
232 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
)
233 __attribute__((visibility("hidden")));
235 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
236 __attribute__((visibility("hidden")));
238 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
239 __attribute__((visibility("hidden")));
241 const char *ustcomm_get_readable_code(int code
)
242 __attribute__((visibility("hidden")));
244 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
)
245 __attribute__((visibility("hidden")));
247 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
248 uint32_t expected_handle
, uint32_t expected_cmd
)
249 __attribute__((visibility("hidden")));
251 int ustcomm_send_app_cmd(int sock
,
252 struct ustcomm_ust_msg
*lum
,
253 struct ustcomm_ust_reply
*lur
)
254 __attribute__((visibility("hidden")));
256 int ustcomm_recv_fd(int sock
)
257 __attribute__((visibility("hidden")));
259 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
260 void **chan_data
, uint64_t len
, int *wakeup_fd
)
261 __attribute__((visibility("hidden")));
263 int ustcomm_recv_stream_from_sessiond(int sock
,
264 uint64_t *memory_map_size
,
265 int *shm_fd
, int *wakeup_fd
)
266 __attribute__((visibility("hidden")));
268 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
269 int *event_notifier_notif_fd
)
270 __attribute__((visibility("hidden")));
272 ssize_t
ustcomm_recv_var_len_cmd_from_sessiond(int sock
,
273 void **data
, uint32_t len
)
274 __attribute__((visibility("hidden")));
276 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
278 __attribute__((visibility("hidden")));
281 * Returns 0 on success, negative error value on error.
282 * Returns -EPIPE or -ECONNRESET if other end has hung up.
284 int ustcomm_send_reg_msg(int sock
,
285 enum lttng_ust_ctl_socket_type type
,
286 uint32_t bits_per_long
,
287 uint32_t uint8_t_alignment
,
288 uint32_t uint16_t_alignment
,
289 uint32_t uint32_t_alignment
,
290 uint32_t uint64_t_alignment
,
291 uint32_t long_alignment
,
292 const char *procname
)
293 __attribute__((visibility("hidden")));
296 * Returns 0 on success, negative error value on error.
297 * Returns -EPIPE or -ECONNRESET if other end has hung up.
299 int ustcomm_register_event(int sock
,
300 struct lttng_ust_session
*session
,
301 int session_objd
, /* session descriptor */
302 int channel_objd
, /* channel descriptor */
303 const char *event_name
, /* event name (input) */
305 const char *signature
, /* event signature (input) */
306 size_t nr_fields
, /* fields */
307 const struct lttng_ust_event_field
* const *fields
,
308 const char *model_emf_uri
,
310 uint32_t *id
) /* (output) */
311 __attribute__((visibility("hidden")));
314 * Returns 0 on success, negative error value on error.
315 * Returns -EPIPE or -ECONNRESET if other end has hung up.
317 int ustcomm_register_key(int sock
,
318 int session_objd
, /* session descriptor */
319 int map_objd
, /* map descriptor */
321 const uint64_t *dimension_indexes
,
322 const char *key_string
, /* key string (input) */
324 uint64_t *index
) /* (output) */
325 __attribute__((visibility("hidden")));
328 * Returns 0 on success, negative error value on error.
329 * Returns -EPIPE or -ECONNRESET if other end has hung up.
331 int ustcomm_register_enum(int sock
,
332 int session_objd
, /* session descriptor */
333 const char *enum_name
, /* enum name (input) */
334 size_t nr_entries
, /* entries */
335 const struct lttng_ust_enum_entry
* const *entries
,
336 uint64_t *id
) /* enum id (output) */
337 __attribute__((visibility("hidden")));
340 * Returns 0 on success, negative error value on error.
341 * Returns -EPIPE or -ECONNRESET if other end has hung up.
343 int ustcomm_register_channel(int sock
,
344 struct lttng_ust_session
*session
,
345 int session_objd
, /* session descriptor */
346 int channel_objd
, /* channel descriptor */
347 size_t nr_ctx_fields
,
348 struct lttng_ust_ctx_field
*ctx_fields
,
349 uint32_t *chan_id
, /* channel id (output) */
350 int *header_type
) /* header type (output) */
351 __attribute__((visibility("hidden")));
353 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
354 __attribute__((visibility("hidden")));
356 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
357 __attribute__((visibility("hidden")));
359 #endif /* _UST_COMMON_UST_COMM_H */