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>
24 #include "ust-helper.h"
27 #error "LTTNG_PACKED should be defined"
31 * Default timeout the application waits for the sessiond to send its
32 * "register done" command. Can be overridden with the environment
33 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
34 * found, the application proceeds directly without any delay.
36 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
38 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
39 #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
41 /* Queue size of listen(2) */
42 #define LTTNG_UST_COMM_MAX_LISTEN 10
43 #define LTTNG_UST_COMM_REG_MSG_PADDING 64
45 struct lttng_event_field
;
46 struct lttng_ctx_field
;
47 struct lttng_enum_entry
;
48 struct lttng_integer_type
;
51 struct ustctl_reg_msg
{
59 uint32_t bits_per_long
;
60 uint32_t uint8_t_alignment
;
61 uint32_t uint16_t_alignment
;
62 uint32_t uint32_t_alignment
;
63 uint32_t uint64_t_alignment
;
64 uint32_t long_alignment
;
65 uint32_t socket_type
; /* enum ustctl_socket_type */
66 char name
[LTTNG_UST_ABI_PROCNAME_LEN
]; /* process name */
67 char padding
[LTTNG_UST_COMM_REG_MSG_PADDING
];
71 * Data structure for the commands sent from sessiond to UST.
73 #define USTCOMM_MSG_PADDING1 32
74 #define USTCOMM_MSG_PADDING2 32
75 struct ustcomm_ust_msg
{
78 char padding
[USTCOMM_MSG_PADDING1
];
80 struct lttng_ust_abi_channel channel
;
81 struct lttng_ust_abi_stream stream
;
82 struct lttng_ust_abi_event event
;
83 struct lttng_ust_abi_context context
;
84 struct lttng_ust_abi_tracer_version version
;
85 struct lttng_ust_abi_tracepoint_iter tracepoint
;
87 uint32_t data_size
; /* following filter data */
88 uint32_t reloc_offset
;
90 } LTTNG_PACKED filter
;
92 uint32_t count
; /* how many names follow */
93 } LTTNG_PACKED exclusion
;
95 uint32_t data_size
; /* following capture data */
96 uint32_t reloc_offset
;
98 } LTTNG_PACKED capture
;
99 struct lttng_ust_abi_counter counter
;
100 struct lttng_ust_abi_counter_global counter_global
;
101 struct lttng_ust_abi_counter_cpu counter_cpu
;
103 * For lttng_ust_abi_EVENT_NOTIFIER_CREATE, a struct
104 * lttng_ust_abi_event_notifier implicitly follows struct
108 /* Length of struct lttng_ust_abi_event_notifier */
111 char padding
[USTCOMM_MSG_PADDING2
];
116 * Data structure for the response from UST to the session daemon.
117 * cmd_type is sent back in the reply for validation.
119 #define USTCOMM_REPLY_PADDING1 32
120 #define USTCOMM_REPLY_PADDING2 32
121 struct ustcomm_ust_reply
{
124 int32_t ret_code
; /* enum ustcomm_return_code */
125 uint32_t ret_val
; /* return value */
126 char padding
[USTCOMM_REPLY_PADDING1
];
129 uint64_t memory_map_size
;
130 } LTTNG_PACKED channel
;
132 uint64_t memory_map_size
;
133 } LTTNG_PACKED stream
;
134 struct lttng_ust_abi_tracer_version version
;
135 struct lttng_ust_abi_tracepoint_iter tracepoint
;
136 char padding
[USTCOMM_REPLY_PADDING2
];
140 struct ustcomm_notify_hdr
{
144 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
145 struct ustcomm_notify_event_msg
{
146 uint32_t session_objd
;
147 uint32_t channel_objd
;
148 char event_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
150 uint32_t signature_len
;
152 uint32_t model_emf_uri_len
;
153 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
154 /* followed by signature, fields, and model_emf_uri */
157 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
158 struct ustcomm_notify_event_reply
{
159 int32_t ret_code
; /* 0: ok, negative: error code */
161 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
164 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
165 struct ustcomm_notify_enum_msg
{
166 uint32_t session_objd
;
167 char enum_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
168 uint32_t entries_len
;
169 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
170 /* followed by enum entries */
173 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
174 struct ustcomm_notify_enum_reply
{
175 int32_t ret_code
; /* 0: ok, negative: error code */
177 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
180 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
181 struct ustcomm_notify_channel_msg
{
182 uint32_t session_objd
;
183 uint32_t channel_objd
;
184 uint32_t ctx_fields_len
;
185 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
186 /* followed by context fields */
189 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
190 struct ustcomm_notify_channel_reply
{
191 int32_t ret_code
; /* 0: ok, negative: error code */
193 uint32_t header_type
; /* enum ustctl_channel_header */
194 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
198 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
199 * struct lttng_ust_field_iter field.
203 int ustcomm_create_unix_sock(const char *pathname
);
205 int ustcomm_connect_unix_sock(const char *pathname
,
208 int ustcomm_accept_unix_sock(int sock
);
210 int ustcomm_listen_unix_sock(int sock
);
212 int ustcomm_close_unix_sock(int sock
);
215 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
217 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
219 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
221 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
224 const char *ustcomm_get_readable_code(int code
);
226 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
228 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
229 uint32_t expected_handle
, uint32_t expected_cmd
);
231 int ustcomm_send_app_cmd(int sock
,
232 struct ustcomm_ust_msg
*lum
,
233 struct ustcomm_ust_reply
*lur
);
235 int ustcomm_recv_fd(int sock
);
238 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
239 void **chan_data
, uint64_t len
, int *wakeup_fd
);
241 int ustcomm_recv_stream_from_sessiond(int sock
,
242 uint64_t *memory_map_size
,
243 int *shm_fd
, int *wakeup_fd
);
245 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
246 int *event_notifier_notif_fd
);
249 ssize_t
ustcomm_recv_counter_from_sessiond(int sock
,
250 void **counter_data
, uint64_t len
);
252 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
256 * Returns 0 on success, negative error value on error.
257 * Returns -EPIPE or -ECONNRESET if other end has hung up.
260 int ustcomm_send_reg_msg(int sock
,
261 enum ustctl_socket_type type
,
262 uint32_t bits_per_long
,
263 uint32_t uint8_t_alignment
,
264 uint32_t uint16_t_alignment
,
265 uint32_t uint32_t_alignment
,
266 uint32_t uint64_t_alignment
,
267 uint32_t long_alignment
);
270 * Returns 0 on success, negative error value on error.
271 * Returns -EPIPE or -ECONNRESET if other end has hung up.
274 int ustcomm_register_event(int sock
,
275 struct lttng_session
*session
,
276 int session_objd
, /* session descriptor */
277 int channel_objd
, /* channel descriptor */
278 const char *event_name
, /* event name (input) */
280 const char *signature
, /* event signature (input) */
281 size_t nr_fields
, /* fields */
282 const struct lttng_event_field
*fields
,
283 const char *model_emf_uri
,
284 uint32_t *id
); /* event id (output) */
287 * Returns 0 on success, negative error value on error.
288 * Returns -EPIPE or -ECONNRESET if other end has hung up.
291 int ustcomm_register_enum(int sock
,
292 int session_objd
, /* session descriptor */
293 const char *enum_name
, /* enum name (input) */
294 size_t nr_entries
, /* entries */
295 const struct lttng_enum_entry
*entries
,
296 uint64_t *id
); /* enum id (output) */
299 * Returns 0 on success, negative error value on error.
300 * Returns -EPIPE or -ECONNRESET if other end has hung up.
303 int ustcomm_register_channel(int sock
,
304 struct lttng_session
*session
,
305 int session_objd
, /* session descriptor */
306 int channel_objd
, /* channel descriptor */
307 size_t nr_ctx_fields
,
308 const struct lttng_ctx_field
*ctx_fields
,
309 uint32_t *chan_id
, /* channel id (output) */
310 int *header_type
); /* header type (output) */
313 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
315 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
317 #endif /* _LTTNG_UST_COMM_H */