Commit | Line | Data |
---|---|---|
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 | ||
c0c0989a MJ |
14 | #ifndef _LTTNG_UST_COMM_H |
15 | #define _LTTNG_UST_COMM_H | |
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> |
864a1eda | 24 | #include "ust-helper.h" |
67c5b804 | 25 | |
db56acaf MD |
26 | #ifndef LTTNG_PACKED |
27 | #error "LTTNG_PACKED should be defined" | |
28 | #endif | |
29 | ||
11ff9c7d | 30 | /* |
cf12a773 MD |
31 | * Default timeout the application waits for the sessiond to send its |
32 | * "register done" command. Can be overridden with the environment | |
69400ac4 | 33 | * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not |
cf12a773 | 34 | * found, the application proceeds directly without any delay. |
11ff9c7d | 35 | */ |
2b4444ce | 36 | #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS |
11ff9c7d | 37 | |
751d4e91 | 38 | #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR |
32ce8569 | 39 | #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng" |
7fc90dca | 40 | |
67c5b804 | 41 | /* Queue size of listen(2) */ |
32ce8569 MD |
42 | #define LTTNG_UST_COMM_MAX_LISTEN 10 |
43 | #define LTTNG_UST_COMM_REG_MSG_PADDING 64 | |
44 | ||
45 | struct lttng_event_field; | |
83e43212 | 46 | struct lttng_ctx_field; |
c785c634 MD |
47 | struct lttng_enum_entry; |
48 | struct lttng_integer_type; | |
49 | struct lttng_session; | |
32ce8569 MD |
50 | |
51 | struct ustctl_reg_msg { | |
52 | uint32_t magic; | |
53 | uint32_t major; | |
54 | uint32_t minor; | |
55 | uint32_t pid; | |
56 | uint32_t ppid; | |
57 | uint32_t uid; | |
58 | uint32_t gid; | |
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]; | |
68 | } LTTNG_PACKED; | |
67c5b804 | 69 | |
67c5b804 | 70 | /* |
e7723462 | 71 | * Data structure for the commands sent from sessiond to UST. |
67c5b804 | 72 | */ |
32ce8569 MD |
73 | #define USTCOMM_MSG_PADDING1 32 |
74 | #define USTCOMM_MSG_PADDING2 32 | |
57773204 | 75 | struct ustcomm_ust_msg { |
1ece9766 | 76 | uint32_t handle; |
46050b1a | 77 | uint32_t cmd; |
32ce8569 | 78 | char padding[USTCOMM_MSG_PADDING1]; |
67c5b804 | 79 | union { |
1ece9766 | 80 | struct lttng_ust_channel channel; |
381c0f1e | 81 | struct lttng_ust_stream stream; |
1ece9766 MD |
82 | struct lttng_ust_event event; |
83 | struct lttng_ust_context context; | |
57773204 | 84 | struct lttng_ust_tracer_version version; |
cbef6901 | 85 | struct lttng_ust_tracepoint_iter tracepoint; |
2d78951a | 86 | struct { |
2734ca65 CB |
87 | uint32_t data_size; /* following filter data */ |
88 | uint32_t reloc_offset; | |
3f6fd224 | 89 | uint64_t seqnum; |
b3f60bbf | 90 | } LTTNG_PACKED filter; |
75582b3a JI |
91 | struct { |
92 | uint32_t count; /* how many names follow */ | |
93 | } LTTNG_PACKED exclusion; | |
d37ecb3f FD |
94 | struct { |
95 | uint32_t data_size; /* following capture data */ | |
96 | uint32_t reloc_offset; | |
97 | uint64_t seqnum; | |
98 | } LTTNG_PACKED capture; | |
ebabbf58 MD |
99 | struct lttng_ust_counter counter; |
100 | struct lttng_ust_counter_global counter_global; | |
101 | struct lttng_ust_counter_cpu counter_cpu; | |
8406222c MD |
102 | /* |
103 | * For LTTNG_UST_EVENT_NOTIFIER_CREATE, a struct | |
104 | * lttng_ust_event_notifier implicitly follows struct | |
105 | * ustcomm_ust_msg. | |
106 | */ | |
107 | struct { | |
108 | /* Length of struct lttng_ust_event_notifier */ | |
109 | uint32_t len; | |
110 | } event_notifier; | |
32ce8569 | 111 | char padding[USTCOMM_MSG_PADDING2]; |
67c5b804 | 112 | } u; |
b3f60bbf | 113 | } LTTNG_PACKED; |
67c5b804 | 114 | |
9eb62b9c MD |
115 | /* |
116 | * Data structure for the response from UST to the session daemon. | |
117 | * cmd_type is sent back in the reply for validation. | |
118 | */ | |
32ce8569 MD |
119 | #define USTCOMM_REPLY_PADDING1 32 |
120 | #define USTCOMM_REPLY_PADDING2 32 | |
57773204 | 121 | struct ustcomm_ust_reply { |
46050b1a MD |
122 | uint32_t handle; |
123 | uint32_t cmd; | |
7f2348b8 | 124 | int32_t ret_code; /* enum ustcomm_return_code */ |
1ece9766 | 125 | uint32_t ret_val; /* return value */ |
32ce8569 | 126 | char padding[USTCOMM_REPLY_PADDING1]; |
9eb62b9c | 127 | union { |
193183fb MD |
128 | struct { |
129 | uint64_t memory_map_size; | |
b3f60bbf | 130 | } LTTNG_PACKED channel; |
381c0f1e MD |
131 | struct { |
132 | uint64_t memory_map_size; | |
b3f60bbf | 133 | } LTTNG_PACKED stream; |
57773204 | 134 | struct lttng_ust_tracer_version version; |
cbef6901 | 135 | struct lttng_ust_tracepoint_iter tracepoint; |
32ce8569 | 136 | char padding[USTCOMM_REPLY_PADDING2]; |
9eb62b9c | 137 | } u; |
b3f60bbf | 138 | } LTTNG_PACKED; |
9eb62b9c | 139 | |
32ce8569 MD |
140 | struct ustcomm_notify_hdr { |
141 | uint32_t notify_cmd; | |
142 | } LTTNG_PACKED; | |
143 | ||
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_SYM_NAME_LEN]; | |
149 | int32_t loglevel; | |
150 | uint32_t signature_len; | |
151 | uint32_t fields_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 */ | |
155 | } LTTNG_PACKED; | |
156 | ||
157 | #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32 | |
158 | struct ustcomm_notify_event_reply { | |
159 | int32_t ret_code; /* 0: ok, negative: error code */ | |
160 | uint32_t event_id; | |
161 | char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING]; | |
162 | } LTTNG_PACKED; | |
163 | ||
c785c634 MD |
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_SYM_NAME_LEN]; | |
168 | uint32_t entries_len; | |
169 | char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING]; | |
170 | /* followed by enum entries */ | |
171 | } LTTNG_PACKED; | |
172 | ||
173 | #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32 | |
174 | struct ustcomm_notify_enum_reply { | |
175 | int32_t ret_code; /* 0: ok, negative: error code */ | |
176 | uint64_t enum_id; | |
177 | char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING]; | |
178 | } LTTNG_PACKED; | |
179 | ||
32ce8569 MD |
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 */ | |
187 | } LTTNG_PACKED; | |
188 | ||
189 | #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32 | |
190 | struct ustcomm_notify_channel_reply { | |
191 | int32_t ret_code; /* 0: ok, negative: error code */ | |
192 | uint32_t chan_id; | |
193 | uint32_t header_type; /* enum ustctl_channel_header */ | |
194 | char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING]; | |
195 | } LTTNG_PACKED; | |
196 | ||
40003310 MD |
197 | /* |
198 | * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a | |
199 | * struct lttng_ust_field_iter field. | |
200 | */ | |
201 | ||
8f1313b1 MJ |
202 | LTTNG_HIDDEN |
203 | int ustcomm_create_unix_sock(const char *pathname); | |
204 | LTTNG_HIDDEN | |
205 | int ustcomm_connect_unix_sock(const char *pathname, | |
206 | long timeout); | |
207 | LTTNG_HIDDEN | |
208 | int ustcomm_accept_unix_sock(int sock); | |
209 | LTTNG_HIDDEN | |
210 | int ustcomm_listen_unix_sock(int sock); | |
211 | LTTNG_HIDDEN | |
212 | int ustcomm_close_unix_sock(int sock); | |
74d81a6c | 213 | |
8f1313b1 MJ |
214 | LTTNG_HIDDEN |
215 | ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len); | |
216 | LTTNG_HIDDEN | |
217 | ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len); | |
218 | LTTNG_HIDDEN | |
219 | ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd); | |
220 | LTTNG_HIDDEN | |
221 | ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd); | |
74d81a6c | 222 | |
8f1313b1 MJ |
223 | LTTNG_HIDDEN |
224 | const char *ustcomm_get_readable_code(int code); | |
225 | LTTNG_HIDDEN | |
226 | int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum); | |
227 | LTTNG_HIDDEN | |
228 | int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur, | |
229 | uint32_t expected_handle, uint32_t expected_cmd); | |
230 | LTTNG_HIDDEN | |
231 | int ustcomm_send_app_cmd(int sock, | |
57773204 MD |
232 | struct ustcomm_ust_msg *lum, |
233 | struct ustcomm_ust_reply *lur); | |
8f1313b1 | 234 | LTTNG_HIDDEN |
57773204 | 235 | int ustcomm_recv_fd(int sock); |
67c5b804 | 236 | |
8f1313b1 | 237 | LTTNG_HIDDEN |
74d81a6c | 238 | ssize_t ustcomm_recv_channel_from_sessiond(int sock, |
ff0f5728 | 239 | void **chan_data, uint64_t len, int *wakeup_fd); |
8f1313b1 | 240 | LTTNG_HIDDEN |
74d81a6c MD |
241 | int ustcomm_recv_stream_from_sessiond(int sock, |
242 | uint64_t *memory_map_size, | |
243 | int *shm_fd, int *wakeup_fd); | |
76644b7e | 244 | LTTNG_HIDDEN |
d8d2416d FD |
245 | ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock, |
246 | int *event_notifier_notif_fd); | |
74d81a6c | 247 | |
76644b7e | 248 | LTTNG_HIDDEN |
ebabbf58 MD |
249 | ssize_t ustcomm_recv_counter_from_sessiond(int sock, |
250 | void **counter_data, uint64_t len); | |
76644b7e | 251 | LTTNG_HIDDEN |
ebabbf58 MD |
252 | int ustcomm_recv_counter_shm_from_sessiond(int sock, |
253 | int *shm_fd); | |
254 | ||
32ce8569 MD |
255 | /* |
256 | * Returns 0 on success, negative error value on error. | |
257 | * Returns -EPIPE or -ECONNRESET if other end has hung up. | |
258 | */ | |
8f1313b1 | 259 | LTTNG_HIDDEN |
32ce8569 MD |
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); | |
268 | ||
269 | /* | |
270 | * Returns 0 on success, negative error value on error. | |
271 | * Returns -EPIPE or -ECONNRESET if other end has hung up. | |
272 | */ | |
8f1313b1 | 273 | LTTNG_HIDDEN |
32ce8569 | 274 | int ustcomm_register_event(int sock, |
c785c634 | 275 | struct lttng_session *session, |
32ce8569 MD |
276 | int session_objd, /* session descriptor */ |
277 | int channel_objd, /* channel descriptor */ | |
278 | const char *event_name, /* event name (input) */ | |
279 | int loglevel, | |
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) */ | |
285 | ||
c785c634 MD |
286 | /* |
287 | * Returns 0 on success, negative error value on error. | |
288 | * Returns -EPIPE or -ECONNRESET if other end has hung up. | |
289 | */ | |
8f1313b1 | 290 | LTTNG_HIDDEN |
c785c634 MD |
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) */ | |
297 | ||
32ce8569 MD |
298 | /* |
299 | * Returns 0 on success, negative error value on error. | |
300 | * Returns -EPIPE or -ECONNRESET if other end has hung up. | |
301 | */ | |
8f1313b1 | 302 | LTTNG_HIDDEN |
32ce8569 | 303 | int ustcomm_register_channel(int sock, |
53569322 | 304 | struct lttng_session *session, |
32ce8569 MD |
305 | int session_objd, /* session descriptor */ |
306 | int channel_objd, /* channel descriptor */ | |
307 | size_t nr_ctx_fields, | |
83e43212 | 308 | const struct lttng_ctx_field *ctx_fields, |
32ce8569 MD |
309 | uint32_t *chan_id, /* channel id (output) */ |
310 | int *header_type); /* header type (output) */ | |
311 | ||
8f1313b1 | 312 | LTTNG_HIDDEN |
ff517991 | 313 | int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec); |
8f1313b1 | 314 | LTTNG_HIDDEN |
ff517991 MD |
315 | int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec); |
316 | ||
b35d179d | 317 | #endif /* _LTTNG_UST_COMM_H */ |