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 * 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 ustctl_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 ustctl_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_counter counter
;
95 struct lttng_ust_abi_counter_global counter_global
;
96 struct lttng_ust_abi_counter_cpu counter_cpu
;
98 * For lttng_ust_abi_EVENT_NOTIFIER_CREATE, a struct
99 * lttng_ust_abi_event_notifier implicitly follows struct
103 /* Length of struct lttng_ust_abi_event_notifier */
106 char padding
[USTCOMM_MSG_PADDING2
];
108 } __attribute__((packed
));
111 * Data structure for the response from UST to the session daemon.
112 * cmd_type is sent back in the reply for validation.
114 #define USTCOMM_REPLY_PADDING1 32
115 #define USTCOMM_REPLY_PADDING2 32
116 struct ustcomm_ust_reply
{
119 int32_t ret_code
; /* enum ustcomm_return_code */
120 uint32_t ret_val
; /* return value */
121 char padding
[USTCOMM_REPLY_PADDING1
];
124 uint64_t memory_map_size
;
125 } __attribute__((packed
)) channel
;
127 uint64_t memory_map_size
;
128 } __attribute__((packed
)) stream
;
129 struct lttng_ust_abi_tracer_version version
;
130 struct lttng_ust_abi_tracepoint_iter tracepoint
;
131 char padding
[USTCOMM_REPLY_PADDING2
];
133 } __attribute__((packed
));
135 struct ustcomm_notify_hdr
{
137 } __attribute__((packed
));
139 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
140 struct ustcomm_notify_event_msg
{
141 uint32_t session_objd
;
142 uint32_t channel_objd
;
143 char event_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
145 uint32_t signature_len
;
147 uint32_t model_emf_uri_len
;
148 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
149 /* followed by signature, fields, and model_emf_uri */
150 } __attribute__((packed
));
152 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
153 struct ustcomm_notify_event_reply
{
154 int32_t ret_code
; /* 0: ok, negative: error code */
156 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
157 } __attribute__((packed
));
159 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
160 struct ustcomm_notify_enum_msg
{
161 uint32_t session_objd
;
162 char enum_name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
163 uint32_t entries_len
;
164 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
165 /* followed by enum entries */
166 } __attribute__((packed
));
168 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
169 struct ustcomm_notify_enum_reply
{
170 int32_t ret_code
; /* 0: ok, negative: error code */
172 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
173 } __attribute__((packed
));
175 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
176 struct ustcomm_notify_channel_msg
{
177 uint32_t session_objd
;
178 uint32_t channel_objd
;
179 uint32_t ctx_fields_len
;
180 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
181 /* followed by context fields */
182 } __attribute__((packed
));
184 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
185 struct ustcomm_notify_channel_reply
{
186 int32_t ret_code
; /* 0: ok, negative: error code */
188 uint32_t header_type
; /* enum ustctl_channel_header */
189 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
190 } __attribute__((packed
));
193 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
194 * struct lttng_ust_field_iter field.
197 __attribute__((visibility("hidden")))
198 int ustcomm_create_unix_sock(const char *pathname
);
200 __attribute__((visibility("hidden")))
201 int ustcomm_connect_unix_sock(const char *pathname
,
204 __attribute__((visibility("hidden")))
205 int ustcomm_accept_unix_sock(int sock
);
207 __attribute__((visibility("hidden")))
208 int ustcomm_listen_unix_sock(int sock
);
210 __attribute__((visibility("hidden")))
211 int ustcomm_close_unix_sock(int sock
);
213 __attribute__((visibility("hidden")))
214 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
216 __attribute__((visibility("hidden")))
217 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
219 __attribute__((visibility("hidden")))
220 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
222 __attribute__((visibility("hidden")))
223 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
225 __attribute__((visibility("hidden")))
226 const char *ustcomm_get_readable_code(int code
);
228 __attribute__((visibility("hidden")))
229 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
231 __attribute__((visibility("hidden")))
232 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
233 uint32_t expected_handle
, uint32_t expected_cmd
);
235 __attribute__((visibility("hidden")))
236 int ustcomm_send_app_cmd(int sock
,
237 struct ustcomm_ust_msg
*lum
,
238 struct ustcomm_ust_reply
*lur
);
240 __attribute__((visibility("hidden")))
241 int ustcomm_recv_fd(int sock
);
243 __attribute__((visibility("hidden")))
244 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
245 void **chan_data
, uint64_t len
, int *wakeup_fd
);
247 __attribute__((visibility("hidden")))
248 int ustcomm_recv_stream_from_sessiond(int sock
,
249 uint64_t *memory_map_size
,
250 int *shm_fd
, int *wakeup_fd
);
252 __attribute__((visibility("hidden")))
253 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
254 int *event_notifier_notif_fd
);
256 __attribute__((visibility("hidden")))
257 ssize_t
ustcomm_recv_counter_from_sessiond(int sock
,
258 void **counter_data
, uint64_t len
);
260 __attribute__((visibility("hidden")))
261 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
265 * Returns 0 on success, negative error value on error.
266 * Returns -EPIPE or -ECONNRESET if other end has hung up.
268 __attribute__((visibility("hidden")))
269 int ustcomm_send_reg_msg(int sock
,
270 enum ustctl_socket_type type
,
271 uint32_t bits_per_long
,
272 uint32_t uint8_t_alignment
,
273 uint32_t uint16_t_alignment
,
274 uint32_t uint32_t_alignment
,
275 uint32_t uint64_t_alignment
,
276 uint32_t long_alignment
);
279 * Returns 0 on success, negative error value on error.
280 * Returns -EPIPE or -ECONNRESET if other end has hung up.
282 __attribute__((visibility("hidden")))
283 int ustcomm_register_event(int sock
,
284 struct lttng_ust_session
*session
,
285 int session_objd
, /* session descriptor */
286 int channel_objd
, /* channel descriptor */
287 const char *event_name
, /* event name (input) */
289 const char *signature
, /* event signature (input) */
290 size_t nr_fields
, /* fields */
291 struct lttng_ust_event_field
**fields
,
292 const char *model_emf_uri
,
293 uint32_t *id
); /* event id (output) */
296 * Returns 0 on success, negative error value on error.
297 * Returns -EPIPE or -ECONNRESET if other end has hung up.
299 __attribute__((visibility("hidden")))
300 int ustcomm_register_enum(int sock
,
301 int session_objd
, /* session descriptor */
302 const char *enum_name
, /* enum name (input) */
303 size_t nr_entries
, /* entries */
304 struct lttng_ust_enum_entry
**entries
,
305 uint64_t *id
); /* enum id (output) */
308 * Returns 0 on success, negative error value on error.
309 * Returns -EPIPE or -ECONNRESET if other end has hung up.
311 __attribute__((visibility("hidden")))
312 int ustcomm_register_channel(int sock
,
313 struct lttng_ust_session
*session
,
314 int session_objd
, /* session descriptor */
315 int channel_objd
, /* channel descriptor */
316 size_t nr_ctx_fields
,
317 struct lttng_ust_ctx_field
**ctx_fields
,
318 uint32_t *chan_id
, /* channel id (output) */
319 int *header_type
); /* header type (output) */
321 __attribute__((visibility("hidden")))
322 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
324 __attribute__((visibility("hidden")))
325 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
327 #endif /* _LTTNG_UST_COMM_H */