Namespace liblttng-ust-ctl symbols
[lttng-ust.git] / src / common / ustcomm.h
CommitLineData
67c5b804 1/*
c0c0989a 2 * SPDX-License-Identifier: LGPL-2.1-only
15f672f9 3 *
c0c0989a
MJ
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>
67c5b804
MD
7 */
8
9/*
10 * This header is meant for liblttng and libust internal use ONLY.
11 * These declarations should NOT be considered stable API.
12 */
13
67534785
MJ
14#ifndef _UST_COMMON_UST_COMM_H
15#define _UST_COMMON_UST_COMM_H
c0c0989a 16
fb31eb73 17#include <stdint.h>
67c5b804 18#include <limits.h>
57773204 19#include <unistd.h>
4318ae1b 20#include <lttng/ust-abi.h>
7bc53e94 21#include <lttng/ust-error.h>
b3f60bbf 22#include <lttng/ust-compiler.h>
c785c634 23#include <lttng/ust-ctl.h>
67c5b804 24
11ff9c7d 25/*
cf12a773
MD
26 * Default timeout the application waits for the sessiond to send its
27 * "register done" command. Can be overridden with the environment
69400ac4 28 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
cf12a773 29 * found, the application proceeds directly without any delay.
11ff9c7d 30 */
156b0cf7 31#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000
11ff9c7d 32
751d4e91 33#define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
32ce8569 34#define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
7fc90dca 35
67c5b804 36/* Queue size of listen(2) */
32ce8569
MD
37#define LTTNG_UST_COMM_MAX_LISTEN 10
38#define LTTNG_UST_COMM_REG_MSG_PADDING 64
39
25cff019 40struct lttng_ust_event_field;
daacdbfc 41struct lttng_ust_ctx_field;
891d6b55 42struct lttng_ust_enum_entry;
c785c634 43struct lttng_integer_type;
f69fe5fb 44struct lttng_ust_session;
32ce8569 45
249cffb5 46struct lttng_ust_ctl_reg_msg {
32ce8569
MD
47 uint32_t magic;
48 uint32_t major;
49 uint32_t minor;
50 uint32_t pid;
51 uint32_t ppid;
52 uint32_t uid;
53 uint32_t gid;
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;
249cffb5 60 uint32_t socket_type; /* enum lttng_ust_ctl_socket_type */
32ce8569
MD
61 char name[LTTNG_UST_ABI_PROCNAME_LEN]; /* process name */
62 char padding[LTTNG_UST_COMM_REG_MSG_PADDING];
9f5ade14 63} __attribute__((packed));
67c5b804 64
67c5b804 65/*
e7723462 66 * Data structure for the commands sent from sessiond to UST.
67c5b804 67 */
32ce8569
MD
68#define USTCOMM_MSG_PADDING1 32
69#define USTCOMM_MSG_PADDING2 32
57773204 70struct ustcomm_ust_msg {
1ece9766 71 uint32_t handle;
46050b1a 72 uint32_t cmd;
32ce8569 73 char padding[USTCOMM_MSG_PADDING1];
67c5b804 74 union {
fd17d7ce
MD
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;
2d78951a 81 struct {
2734ca65
CB
82 uint32_t data_size; /* following filter data */
83 uint32_t reloc_offset;
3f6fd224 84 uint64_t seqnum;
9f5ade14 85 } __attribute__((packed)) filter;
75582b3a
JI
86 struct {
87 uint32_t count; /* how many names follow */
9f5ade14 88 } __attribute__((packed)) exclusion;
d37ecb3f
FD
89 struct {
90 uint32_t data_size; /* following capture data */
91 uint32_t reloc_offset;
92 uint64_t seqnum;
9f5ade14 93 } __attribute__((packed)) capture;
fd17d7ce
MD
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;
8406222c 97 /*
fd17d7ce
MD
98 * For lttng_ust_abi_EVENT_NOTIFIER_CREATE, a struct
99 * lttng_ust_abi_event_notifier implicitly follows struct
8406222c
MD
100 * ustcomm_ust_msg.
101 */
102 struct {
fd17d7ce 103 /* Length of struct lttng_ust_abi_event_notifier */
8406222c
MD
104 uint32_t len;
105 } event_notifier;
32ce8569 106 char padding[USTCOMM_MSG_PADDING2];
67c5b804 107 } u;
9f5ade14 108} __attribute__((packed));
67c5b804 109
9eb62b9c
MD
110/*
111 * Data structure for the response from UST to the session daemon.
112 * cmd_type is sent back in the reply for validation.
113 */
32ce8569
MD
114#define USTCOMM_REPLY_PADDING1 32
115#define USTCOMM_REPLY_PADDING2 32
57773204 116struct ustcomm_ust_reply {
46050b1a
MD
117 uint32_t handle;
118 uint32_t cmd;
7f2348b8 119 int32_t ret_code; /* enum ustcomm_return_code */
1ece9766 120 uint32_t ret_val; /* return value */
32ce8569 121 char padding[USTCOMM_REPLY_PADDING1];
9eb62b9c 122 union {
193183fb
MD
123 struct {
124 uint64_t memory_map_size;
9f5ade14 125 } __attribute__((packed)) channel;
381c0f1e
MD
126 struct {
127 uint64_t memory_map_size;
9f5ade14 128 } __attribute__((packed)) stream;
fd17d7ce
MD
129 struct lttng_ust_abi_tracer_version version;
130 struct lttng_ust_abi_tracepoint_iter tracepoint;
32ce8569 131 char padding[USTCOMM_REPLY_PADDING2];
9eb62b9c 132 } u;
9f5ade14 133} __attribute__((packed));
9eb62b9c 134
32ce8569
MD
135struct ustcomm_notify_hdr {
136 uint32_t notify_cmd;
9f5ade14 137} __attribute__((packed));
32ce8569
MD
138
139#define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
140struct ustcomm_notify_event_msg {
141 uint32_t session_objd;
142 uint32_t channel_objd;
fd17d7ce 143 char event_name[LTTNG_UST_ABI_SYM_NAME_LEN];
32ce8569
MD
144 int32_t loglevel;
145 uint32_t signature_len;
146 uint32_t fields_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 */
9f5ade14 150} __attribute__((packed));
32ce8569
MD
151
152#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
153struct ustcomm_notify_event_reply {
154 int32_t ret_code; /* 0: ok, negative: error code */
155 uint32_t event_id;
156 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
9f5ade14 157} __attribute__((packed));
32ce8569 158
c785c634
MD
159#define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
160struct ustcomm_notify_enum_msg {
161 uint32_t session_objd;
fd17d7ce 162 char enum_name[LTTNG_UST_ABI_SYM_NAME_LEN];
c785c634
MD
163 uint32_t entries_len;
164 char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
165 /* followed by enum entries */
9f5ade14 166} __attribute__((packed));
c785c634
MD
167
168#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
169struct ustcomm_notify_enum_reply {
170 int32_t ret_code; /* 0: ok, negative: error code */
171 uint64_t enum_id;
172 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
9f5ade14 173} __attribute__((packed));
c785c634 174
32ce8569
MD
175#define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
176struct 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 */
9f5ade14 182} __attribute__((packed));
32ce8569
MD
183
184#define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
185struct ustcomm_notify_channel_reply {
186 int32_t ret_code; /* 0: ok, negative: error code */
187 uint32_t chan_id;
249cffb5 188 uint32_t header_type; /* enum lttng_ust_ctl_channel_header */
32ce8569 189 char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
9f5ade14 190} __attribute__((packed));
32ce8569 191
40003310
MD
192/*
193 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
194 * struct lttng_ust_field_iter field.
195 */
196
1d18d519
MJ
197int ustcomm_create_unix_sock(const char *pathname)
198 __attribute__((visibility("hidden")));
ddabe860 199
8f1313b1 200int ustcomm_connect_unix_sock(const char *pathname,
1d18d519
MJ
201 long timeout)
202 __attribute__((visibility("hidden")));
ddabe860 203
1d18d519
MJ
204int ustcomm_accept_unix_sock(int sock)
205 __attribute__((visibility("hidden")));
ddabe860 206
1d18d519
MJ
207int ustcomm_listen_unix_sock(int sock)
208 __attribute__((visibility("hidden")));
ddabe860 209
1d18d519
MJ
210int ustcomm_close_unix_sock(int sock)
211 __attribute__((visibility("hidden")));
74d81a6c 212
1d18d519
MJ
213ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
214 __attribute__((visibility("hidden")));
ddabe860 215
1d18d519
MJ
216ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len)
217 __attribute__((visibility("hidden")));
ddabe860 218
1d18d519
MJ
219ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
220 __attribute__((visibility("hidden")));
ddabe860 221
1d18d519
MJ
222ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd)
223 __attribute__((visibility("hidden")));
74d81a6c 224
1d18d519
MJ
225const char *ustcomm_get_readable_code(int code)
226 __attribute__((visibility("hidden")));
ddabe860 227
1d18d519
MJ
228int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum)
229 __attribute__((visibility("hidden")));
ddabe860 230
8f1313b1 231int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
1d18d519
MJ
232 uint32_t expected_handle, uint32_t expected_cmd)
233 __attribute__((visibility("hidden")));
ddabe860 234
8f1313b1 235int ustcomm_send_app_cmd(int sock,
57773204 236 struct ustcomm_ust_msg *lum,
1d18d519
MJ
237 struct ustcomm_ust_reply *lur)
238 __attribute__((visibility("hidden")));
ddabe860 239
1d18d519
MJ
240int ustcomm_recv_fd(int sock)
241 __attribute__((visibility("hidden")));
67c5b804 242
74d81a6c 243ssize_t ustcomm_recv_channel_from_sessiond(int sock,
1d18d519
MJ
244 void **chan_data, uint64_t len, int *wakeup_fd)
245 __attribute__((visibility("hidden")));
ddabe860 246
74d81a6c
MD
247int ustcomm_recv_stream_from_sessiond(int sock,
248 uint64_t *memory_map_size,
1d18d519
MJ
249 int *shm_fd, int *wakeup_fd)
250 __attribute__((visibility("hidden")));
ddabe860 251
d8d2416d 252ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock,
1d18d519
MJ
253 int *event_notifier_notif_fd)
254 __attribute__((visibility("hidden")));
74d81a6c 255
ebabbf58 256ssize_t ustcomm_recv_counter_from_sessiond(int sock,
1d18d519
MJ
257 void **counter_data, uint64_t len)
258 __attribute__((visibility("hidden")));
ddabe860 259
ebabbf58 260int ustcomm_recv_counter_shm_from_sessiond(int sock,
1d18d519
MJ
261 int *shm_fd)
262 __attribute__((visibility("hidden")));
ebabbf58 263
32ce8569
MD
264/*
265 * Returns 0 on success, negative error value on error.
266 * Returns -EPIPE or -ECONNRESET if other end has hung up.
267 */
268int ustcomm_send_reg_msg(int sock,
249cffb5 269 enum lttng_ust_ctl_socket_type type,
32ce8569
MD
270 uint32_t bits_per_long,
271 uint32_t uint8_t_alignment,
272 uint32_t uint16_t_alignment,
273 uint32_t uint32_t_alignment,
274 uint32_t uint64_t_alignment,
1d18d519
MJ
275 uint32_t long_alignment)
276 __attribute__((visibility("hidden")));
32ce8569
MD
277
278/*
279 * Returns 0 on success, negative error value on error.
280 * Returns -EPIPE or -ECONNRESET if other end has hung up.
281 */
282int ustcomm_register_event(int sock,
f69fe5fb 283 struct lttng_ust_session *session,
32ce8569
MD
284 int session_objd, /* session descriptor */
285 int channel_objd, /* channel descriptor */
286 const char *event_name, /* event name (input) */
287 int loglevel,
288 const char *signature, /* event signature (input) */
289 size_t nr_fields, /* fields */
3d33ca1d 290 const struct lttng_ust_event_field * const *fields,
32ce8569 291 const char *model_emf_uri,
1d18d519
MJ
292 uint32_t *id) /* event id (output) */
293 __attribute__((visibility("hidden")));
32ce8569 294
c785c634
MD
295/*
296 * Returns 0 on success, negative error value on error.
297 * Returns -EPIPE or -ECONNRESET if other end has hung up.
298 */
299int ustcomm_register_enum(int sock,
300 int session_objd, /* session descriptor */
301 const char *enum_name, /* enum name (input) */
302 size_t nr_entries, /* entries */
3d33ca1d 303 const struct lttng_ust_enum_entry * const *entries,
1d18d519
MJ
304 uint64_t *id) /* enum id (output) */
305 __attribute__((visibility("hidden")));
c785c634 306
32ce8569
MD
307/*
308 * Returns 0 on success, negative error value on error.
309 * Returns -EPIPE or -ECONNRESET if other end has hung up.
310 */
311int ustcomm_register_channel(int sock,
f69fe5fb 312 struct lttng_ust_session *session,
32ce8569
MD
313 int session_objd, /* session descriptor */
314 int channel_objd, /* channel descriptor */
315 size_t nr_ctx_fields,
4e48b5d2 316 struct lttng_ust_ctx_field *ctx_fields,
32ce8569 317 uint32_t *chan_id, /* channel id (output) */
1d18d519
MJ
318 int *header_type) /* header type (output) */
319 __attribute__((visibility("hidden")));
32ce8569 320
1d18d519
MJ
321int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec)
322 __attribute__((visibility("hidden")));
ddabe860 323
1d18d519
MJ
324int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec)
325 __attribute__((visibility("hidden")));
ff517991 326
67534785 327#endif /* _UST_COMMON_UST_COMM_H */
This page took 0.077332 seconds and 4 git commands to generate.