Commit | Line | Data |
---|---|---|
57773204 MD |
1 | /* |
2 | * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca> | |
3 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
4 | * | |
e92f3e28 MD |
5 | * This program is free software; you can redistribute it and/or modify |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation; version 2 of the License only. | |
57773204 MD |
8 | * |
9 | * This program is distributed in the hope that it will be useful, | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
13 | * | |
e92f3e28 MD |
14 | * You should have received a copy of the GNU General Public License along |
15 | * with this program; if not, write to the Free Software Foundation, Inc., | |
16 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
57773204 MD |
17 | */ |
18 | ||
9d335227 | 19 | #define _GNU_SOURCE |
57773204 | 20 | #include <string.h> |
4318ae1b MD |
21 | #include <lttng/ust-ctl.h> |
22 | #include <lttng/ust-abi.h> | |
c1fca457 | 23 | #include <lttng/ust-events.h> |
7a784989 | 24 | #include <sys/mman.h> |
44c72f10 MD |
25 | |
26 | #include <usterr-signal-safe.h> | |
b728d87e | 27 | #include <ust-comm.h> |
57773204 MD |
28 | |
29 | #include "../libringbuffer/backend.h" | |
30 | #include "../libringbuffer/frontend.h" | |
31 | ||
6b120308 MD |
32 | volatile enum ust_loglevel ust_loglevel; |
33 | ||
57773204 | 34 | static |
61f02aea | 35 | void init_object(struct lttng_ust_object_data *data) |
57773204 MD |
36 | { |
37 | data->handle = -1; | |
38 | data->shm_fd = -1; | |
39 | data->wait_fd = -1; | |
40 | data->memory_map_size = 0; | |
41 | } | |
42 | ||
2be0e72c MD |
43 | int ustctl_release_handle(int sock, int handle) |
44 | { | |
45 | struct ustcomm_ust_msg lum; | |
46 | struct ustcomm_ust_reply lur; | |
47 | int ret; | |
48 | ||
49 | if (sock >= 0) { | |
50 | memset(&lum, 0, sizeof(lum)); | |
51 | lum.handle = handle; | |
52 | lum.cmd = LTTNG_UST_RELEASE; | |
53 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
54 | if (ret < 0) { | |
55 | return ret; | |
56 | } | |
57 | } | |
58 | return 0; | |
59 | } | |
12388166 MD |
60 | /* |
61 | * If sock is negative, it means we don't have to notify the other side | |
62 | * (e.g. application has already vanished). | |
63 | */ | |
d26228ae | 64 | int ustctl_release_object(int sock, struct lttng_ust_object_data *data) |
57773204 | 65 | { |
57773204 MD |
66 | int ret; |
67 | ||
9bfc503d MD |
68 | if (!data) |
69 | return -EINVAL; | |
70 | ||
d26228ae MD |
71 | if (data->shm_fd >= 0) { |
72 | ret = close(data->shm_fd); | |
73 | if (ret < 0) { | |
74 | return ret; | |
75 | } | |
76 | } | |
77 | if (data->wait_fd >= 0) { | |
78 | ret = close(data->wait_fd); | |
79 | if (ret < 0) { | |
80 | return ret; | |
81 | } | |
82 | } | |
2be0e72c | 83 | return ustctl_release_handle(sock, data->handle); |
57773204 MD |
84 | } |
85 | ||
1c5e467e MD |
86 | /* |
87 | * Send registration done packet to the application. | |
88 | */ | |
89 | int ustctl_register_done(int sock) | |
90 | { | |
91 | struct ustcomm_ust_msg lum; | |
92 | struct ustcomm_ust_reply lur; | |
93 | int ret; | |
94 | ||
95 | DBG("Sending register done command to %d", sock); | |
96 | memset(&lum, 0, sizeof(lum)); | |
97 | lum.handle = LTTNG_UST_ROOT_HANDLE; | |
98 | lum.cmd = LTTNG_UST_REGISTER_DONE; | |
99 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
100 | if (ret) | |
101 | return ret; | |
102 | if (lur.ret_code != USTCOMM_OK) { | |
103 | DBG("Return code: %s", ustcomm_get_readable_code(lur.ret_code)); | |
104 | goto error; | |
105 | } | |
106 | return 0; | |
107 | ||
108 | error: | |
109 | return -1; | |
110 | } | |
111 | ||
57773204 MD |
112 | /* |
113 | * returns session handle. | |
114 | */ | |
115 | int ustctl_create_session(int sock) | |
116 | { | |
117 | struct ustcomm_ust_msg lum; | |
118 | struct ustcomm_ust_reply lur; | |
119 | int ret, session_handle; | |
120 | ||
121 | /* Create session */ | |
122 | memset(&lum, 0, sizeof(lum)); | |
123 | lum.handle = LTTNG_UST_ROOT_HANDLE; | |
124 | lum.cmd = LTTNG_UST_SESSION; | |
125 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
126 | if (ret) | |
127 | return ret; | |
128 | session_handle = lur.ret_val; | |
129 | DBG("received session handle %u", session_handle); | |
130 | return session_handle; | |
131 | } | |
132 | ||
133 | /* open the metadata global channel */ | |
134 | int ustctl_open_metadata(int sock, int session_handle, | |
135 | struct lttng_ust_channel_attr *chops, | |
61f02aea | 136 | struct lttng_ust_object_data **_metadata_data) |
57773204 MD |
137 | { |
138 | struct ustcomm_ust_msg lum; | |
139 | struct ustcomm_ust_reply lur; | |
61f02aea | 140 | struct lttng_ust_object_data *metadata_data; |
eeee05f3 | 141 | int ret, err = 0; |
57773204 | 142 | |
9bfc503d MD |
143 | if (!chops || !_metadata_data) |
144 | return -EINVAL; | |
145 | ||
57773204 MD |
146 | metadata_data = malloc(sizeof(*metadata_data)); |
147 | if (!metadata_data) | |
148 | return -ENOMEM; | |
149 | init_object(metadata_data); | |
150 | /* Create metadata channel */ | |
151 | memset(&lum, 0, sizeof(lum)); | |
152 | lum.handle = session_handle; | |
153 | lum.cmd = LTTNG_UST_METADATA; | |
154 | lum.u.channel.overwrite = chops->overwrite; | |
155 | lum.u.channel.subbuf_size = chops->subbuf_size; | |
156 | lum.u.channel.num_subbuf = chops->num_subbuf; | |
157 | lum.u.channel.switch_timer_interval = chops->switch_timer_interval; | |
158 | lum.u.channel.read_timer_interval = chops->read_timer_interval; | |
159 | lum.u.channel.output = chops->output; | |
160 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
161 | if (ret) { | |
162 | free(metadata_data); | |
163 | return ret; | |
164 | } | |
165 | if (lur.ret_code != USTCOMM_OK) { | |
166 | free(metadata_data); | |
167 | return lur.ret_code; | |
168 | } | |
169 | metadata_data->handle = lur.ret_val; | |
170 | DBG("received metadata handle %u", metadata_data->handle); | |
171 | metadata_data->memory_map_size = lur.u.channel.memory_map_size; | |
172 | /* get shm fd */ | |
173 | ret = ustcomm_recv_fd(sock); | |
174 | if (ret < 0) | |
eeee05f3 MD |
175 | err = 1; |
176 | else | |
177 | metadata_data->shm_fd = ret; | |
178 | /* | |
179 | * We need to get the second FD even if the first fails, because | |
180 | * libust expects us to read the two FDs. | |
181 | */ | |
57773204 MD |
182 | /* get wait fd */ |
183 | ret = ustcomm_recv_fd(sock); | |
184 | if (ret < 0) | |
eeee05f3 MD |
185 | err = 1; |
186 | else | |
187 | metadata_data->wait_fd = ret; | |
188 | if (err) | |
57773204 | 189 | goto error; |
57773204 MD |
190 | *_metadata_data = metadata_data; |
191 | return 0; | |
192 | ||
193 | error: | |
d26228ae | 194 | (void) ustctl_release_object(sock, metadata_data); |
38970582 | 195 | free(metadata_data); |
57773204 MD |
196 | return -EINVAL; |
197 | } | |
198 | ||
199 | int ustctl_create_channel(int sock, int session_handle, | |
200 | struct lttng_ust_channel_attr *chops, | |
61f02aea | 201 | struct lttng_ust_object_data **_channel_data) |
57773204 MD |
202 | { |
203 | struct ustcomm_ust_msg lum; | |
204 | struct ustcomm_ust_reply lur; | |
61f02aea | 205 | struct lttng_ust_object_data *channel_data; |
eeee05f3 | 206 | int ret, err = 0; |
57773204 | 207 | |
9bfc503d MD |
208 | if (!chops || !_channel_data) |
209 | return -EINVAL; | |
210 | ||
57773204 MD |
211 | channel_data = malloc(sizeof(*channel_data)); |
212 | if (!channel_data) | |
213 | return -ENOMEM; | |
214 | init_object(channel_data); | |
215 | /* Create metadata channel */ | |
216 | memset(&lum, 0, sizeof(lum)); | |
217 | lum.handle = session_handle; | |
218 | lum.cmd = LTTNG_UST_CHANNEL; | |
219 | lum.u.channel.overwrite = chops->overwrite; | |
220 | lum.u.channel.subbuf_size = chops->subbuf_size; | |
221 | lum.u.channel.num_subbuf = chops->num_subbuf; | |
222 | lum.u.channel.switch_timer_interval = chops->switch_timer_interval; | |
223 | lum.u.channel.read_timer_interval = chops->read_timer_interval; | |
224 | lum.u.channel.output = chops->output; | |
225 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
226 | if (ret) { | |
227 | free(channel_data); | |
228 | return ret; | |
229 | } | |
230 | if (lur.ret_code != USTCOMM_OK) { | |
231 | free(channel_data); | |
232 | return lur.ret_code; | |
233 | } | |
234 | channel_data->handle = lur.ret_val; | |
235 | DBG("received channel handle %u", channel_data->handle); | |
236 | channel_data->memory_map_size = lur.u.channel.memory_map_size; | |
237 | /* get shm fd */ | |
238 | ret = ustcomm_recv_fd(sock); | |
239 | if (ret < 0) | |
eeee05f3 MD |
240 | err = 1; |
241 | else | |
242 | channel_data->shm_fd = ret; | |
243 | /* | |
244 | * We need to get the second FD even if the first fails, because | |
245 | * libust expects us to read the two FDs. | |
246 | */ | |
57773204 MD |
247 | /* get wait fd */ |
248 | ret = ustcomm_recv_fd(sock); | |
249 | if (ret < 0) | |
eeee05f3 MD |
250 | err = 1; |
251 | else | |
252 | channel_data->wait_fd = ret; | |
253 | if (err) | |
57773204 | 254 | goto error; |
57773204 MD |
255 | *_channel_data = channel_data; |
256 | return 0; | |
257 | ||
258 | error: | |
d26228ae | 259 | (void) ustctl_release_object(sock, channel_data); |
38970582 | 260 | free(channel_data); |
57773204 MD |
261 | return -EINVAL; |
262 | } | |
263 | ||
264 | /* | |
265 | * Return -ENOENT if no more stream is available for creation. | |
266 | * Return 0 on success. | |
267 | * Return negative error value on error. | |
268 | */ | |
61f02aea MD |
269 | int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data, |
270 | struct lttng_ust_object_data **_stream_data) | |
57773204 MD |
271 | { |
272 | struct ustcomm_ust_msg lum; | |
273 | struct ustcomm_ust_reply lur; | |
61f02aea | 274 | struct lttng_ust_object_data *stream_data; |
eeee05f3 | 275 | int ret, fd, err = 0; |
57773204 | 276 | |
9bfc503d MD |
277 | if (!channel_data || !_stream_data) |
278 | return -EINVAL; | |
279 | ||
57773204 MD |
280 | stream_data = malloc(sizeof(*stream_data)); |
281 | if (!stream_data) | |
282 | return -ENOMEM; | |
283 | init_object(stream_data); | |
284 | memset(&lum, 0, sizeof(lum)); | |
285 | lum.handle = channel_data->handle; | |
286 | lum.cmd = LTTNG_UST_STREAM; | |
287 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
288 | if (ret) { | |
289 | free(stream_data); | |
290 | return ret; | |
291 | } | |
292 | if (lur.ret_code != USTCOMM_OK) { | |
293 | free(stream_data); | |
294 | return lur.ret_code; | |
295 | } | |
296 | ||
297 | stream_data->handle = lur.ret_val; | |
298 | DBG("received stream handle %u", stream_data->handle); | |
299 | stream_data->memory_map_size = lur.u.stream.memory_map_size; | |
300 | /* get shm fd */ | |
301 | fd = ustcomm_recv_fd(sock); | |
302 | if (fd < 0) | |
eeee05f3 MD |
303 | err = 1; |
304 | else | |
305 | stream_data->shm_fd = fd; | |
306 | /* | |
307 | * We need to get the second FD even if the first fails, because | |
308 | * libust expects us to read the two FDs. | |
309 | */ | |
57773204 MD |
310 | /* get wait fd */ |
311 | fd = ustcomm_recv_fd(sock); | |
312 | if (fd < 0) | |
eeee05f3 MD |
313 | err = 1; |
314 | else | |
315 | stream_data->wait_fd = fd; | |
316 | if (err) | |
57773204 | 317 | goto error; |
57773204 MD |
318 | *_stream_data = stream_data; |
319 | return ret; | |
320 | ||
321 | error: | |
d26228ae | 322 | (void) ustctl_release_object(sock, stream_data); |
38970582 | 323 | free(stream_data); |
57773204 MD |
324 | return -EINVAL; |
325 | } | |
326 | ||
327 | int ustctl_create_event(int sock, struct lttng_ust_event *ev, | |
61f02aea MD |
328 | struct lttng_ust_object_data *channel_data, |
329 | struct lttng_ust_object_data **_event_data) | |
57773204 MD |
330 | { |
331 | struct ustcomm_ust_msg lum; | |
332 | struct ustcomm_ust_reply lur; | |
61f02aea | 333 | struct lttng_ust_object_data *event_data; |
57773204 MD |
334 | int ret; |
335 | ||
9bfc503d MD |
336 | if (!channel_data || !_event_data) |
337 | return -EINVAL; | |
338 | ||
57773204 MD |
339 | event_data = malloc(sizeof(*event_data)); |
340 | if (!event_data) | |
341 | return -ENOMEM; | |
342 | init_object(event_data); | |
343 | memset(&lum, 0, sizeof(lum)); | |
344 | lum.handle = channel_data->handle; | |
345 | lum.cmd = LTTNG_UST_EVENT; | |
346 | strncpy(lum.u.event.name, ev->name, | |
347 | LTTNG_UST_SYM_NAME_LEN); | |
348 | lum.u.event.instrumentation = ev->instrumentation; | |
457a6b58 MD |
349 | lum.u.event.loglevel_type = ev->loglevel_type; |
350 | lum.u.event.loglevel = ev->loglevel; | |
57773204 MD |
351 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); |
352 | if (ret) { | |
353 | free(event_data); | |
354 | return ret; | |
355 | } | |
356 | event_data->handle = lur.ret_val; | |
357 | DBG("received event handle %u", event_data->handle); | |
358 | *_event_data = event_data; | |
359 | return 0; | |
360 | } | |
361 | ||
362 | int ustctl_add_context(int sock, struct lttng_ust_context *ctx, | |
61f02aea MD |
363 | struct lttng_ust_object_data *obj_data, |
364 | struct lttng_ust_object_data **_context_data) | |
57773204 MD |
365 | { |
366 | struct ustcomm_ust_msg lum; | |
367 | struct ustcomm_ust_reply lur; | |
61f02aea | 368 | struct lttng_ust_object_data *context_data; |
57773204 MD |
369 | int ret; |
370 | ||
9bfc503d MD |
371 | if (!obj_data || !_context_data) |
372 | return -EINVAL; | |
373 | ||
57773204 MD |
374 | context_data = malloc(sizeof(*context_data)); |
375 | if (!context_data) | |
376 | return -ENOMEM; | |
377 | init_object(context_data); | |
378 | memset(&lum, 0, sizeof(lum)); | |
3039d8ed | 379 | lum.handle = obj_data->handle; |
57773204 MD |
380 | lum.cmd = LTTNG_UST_CONTEXT; |
381 | lum.u.context.ctx = ctx->ctx; | |
382 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
383 | if (ret) { | |
384 | free(context_data); | |
385 | return ret; | |
386 | } | |
387 | context_data->handle = lur.ret_val; | |
388 | DBG("received context handle %u", context_data->handle); | |
389 | *_context_data = context_data; | |
390 | return ret; | |
391 | } | |
392 | ||
393 | /* Enable event, channel and session ioctl */ | |
61f02aea | 394 | int ustctl_enable(int sock, struct lttng_ust_object_data *object) |
57773204 MD |
395 | { |
396 | struct ustcomm_ust_msg lum; | |
397 | struct ustcomm_ust_reply lur; | |
398 | int ret; | |
399 | ||
9bfc503d MD |
400 | if (!object) |
401 | return -EINVAL; | |
402 | ||
57773204 MD |
403 | memset(&lum, 0, sizeof(lum)); |
404 | lum.handle = object->handle; | |
405 | lum.cmd = LTTNG_UST_ENABLE; | |
406 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
407 | if (ret) | |
408 | return ret; | |
409 | DBG("enabled handle %u", object->handle); | |
410 | return 0; | |
411 | } | |
412 | ||
413 | /* Disable event, channel and session ioctl */ | |
61f02aea | 414 | int ustctl_disable(int sock, struct lttng_ust_object_data *object) |
57773204 MD |
415 | { |
416 | struct ustcomm_ust_msg lum; | |
417 | struct ustcomm_ust_reply lur; | |
418 | int ret; | |
419 | ||
9bfc503d MD |
420 | if (!object) |
421 | return -EINVAL; | |
422 | ||
57773204 MD |
423 | memset(&lum, 0, sizeof(lum)); |
424 | lum.handle = object->handle; | |
425 | lum.cmd = LTTNG_UST_DISABLE; | |
426 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
427 | if (ret) | |
428 | return ret; | |
429 | DBG("disable handle %u", object->handle); | |
430 | return 0; | |
431 | } | |
432 | ||
4a6ca058 | 433 | int ustctl_start_session(int sock, int handle) |
57773204 | 434 | { |
61f02aea | 435 | struct lttng_ust_object_data obj; |
4a6ca058 MD |
436 | |
437 | obj.handle = handle; | |
438 | return ustctl_enable(sock, &obj); | |
57773204 MD |
439 | } |
440 | ||
4a6ca058 | 441 | int ustctl_stop_session(int sock, int handle) |
57773204 | 442 | { |
61f02aea | 443 | struct lttng_ust_object_data obj; |
4a6ca058 MD |
444 | |
445 | obj.handle = handle; | |
446 | return ustctl_disable(sock, &obj); | |
57773204 MD |
447 | } |
448 | ||
57773204 MD |
449 | int ustctl_tracepoint_list(int sock) |
450 | { | |
b115631f MD |
451 | struct ustcomm_ust_msg lum; |
452 | struct ustcomm_ust_reply lur; | |
453 | int ret, tp_list_handle; | |
454 | ||
455 | memset(&lum, 0, sizeof(lum)); | |
456 | lum.handle = LTTNG_UST_ROOT_HANDLE; | |
457 | lum.cmd = LTTNG_UST_TRACEPOINT_LIST; | |
458 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
459 | if (ret) | |
460 | return ret; | |
461 | tp_list_handle = lur.ret_val; | |
462 | DBG("received tracepoint list handle %u", tp_list_handle); | |
463 | return tp_list_handle; | |
464 | } | |
465 | ||
466 | int ustctl_tracepoint_list_get(int sock, int tp_list_handle, | |
cbef6901 | 467 | struct lttng_ust_tracepoint_iter *iter) |
b115631f MD |
468 | { |
469 | struct ustcomm_ust_msg lum; | |
470 | struct ustcomm_ust_reply lur; | |
471 | int ret; | |
472 | ||
9bfc503d MD |
473 | if (!iter) |
474 | return -EINVAL; | |
475 | ||
b115631f MD |
476 | memset(&lum, 0, sizeof(lum)); |
477 | lum.handle = tp_list_handle; | |
478 | lum.cmd = LTTNG_UST_TRACEPOINT_LIST_GET; | |
479 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
480 | if (ret) | |
481 | return ret; | |
882a56d7 | 482 | DBG("received tracepoint list entry name %s loglevel %d", |
cbef6901 | 483 | lur.u.tracepoint.name, |
882a56d7 | 484 | lur.u.tracepoint.loglevel); |
cbef6901 | 485 | memcpy(iter, &lur.u.tracepoint, sizeof(*iter)); |
b115631f | 486 | return 0; |
57773204 MD |
487 | } |
488 | ||
489 | int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v) | |
490 | { | |
491 | struct ustcomm_ust_msg lum; | |
492 | struct ustcomm_ust_reply lur; | |
493 | int ret; | |
494 | ||
9bfc503d MD |
495 | if (!v) |
496 | return -EINVAL; | |
497 | ||
57773204 MD |
498 | memset(&lum, 0, sizeof(lum)); |
499 | lum.handle = LTTNG_UST_ROOT_HANDLE; | |
500 | lum.cmd = LTTNG_UST_TRACER_VERSION; | |
501 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
502 | if (ret) | |
503 | return ret; | |
504 | memcpy(v, &lur.u.version, sizeof(*v)); | |
505 | DBG("received tracer version"); | |
506 | return 0; | |
507 | } | |
508 | ||
509 | int ustctl_wait_quiescent(int sock) | |
510 | { | |
511 | struct ustcomm_ust_msg lum; | |
512 | struct ustcomm_ust_reply lur; | |
513 | int ret; | |
514 | ||
515 | memset(&lum, 0, sizeof(lum)); | |
516 | lum.handle = LTTNG_UST_ROOT_HANDLE; | |
517 | lum.cmd = LTTNG_UST_WAIT_QUIESCENT; | |
518 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
519 | if (ret) | |
520 | return ret; | |
521 | DBG("waited for quiescent state"); | |
522 | return 0; | |
523 | } | |
524 | ||
525 | int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate) | |
526 | { | |
9bfc503d MD |
527 | if (!calibrate) |
528 | return -EINVAL; | |
529 | ||
57773204 MD |
530 | return -ENOSYS; |
531 | } | |
532 | ||
f1fffc57 MD |
533 | int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object) |
534 | { | |
535 | struct ustcomm_ust_msg lum; | |
536 | struct ustcomm_ust_reply lur; | |
537 | int ret; | |
538 | ||
9bfc503d MD |
539 | if (!object) |
540 | return -EINVAL; | |
541 | ||
f1fffc57 MD |
542 | memset(&lum, 0, sizeof(lum)); |
543 | lum.handle = object->handle; | |
544 | lum.cmd = LTTNG_UST_FLUSH_BUFFER; | |
545 | ret = ustcomm_send_app_cmd(sock, &lum, &lur); | |
546 | if (ret) | |
547 | return ret; | |
548 | DBG("flushed buffer handle %u", object->handle); | |
549 | return 0; | |
550 | } | |
551 | ||
57773204 MD |
552 | /* Buffer operations */ |
553 | ||
554 | /* Map channel shm into process memory */ | |
38fae1d3 | 555 | struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data) |
57773204 | 556 | { |
38fae1d3 | 557 | struct lttng_ust_shm_handle *handle; |
57773204 MD |
558 | struct channel *chan; |
559 | size_t chan_size; | |
c1fca457 | 560 | struct lttng_ust_lib_ring_buffer_config *config; |
7a784989 | 561 | int ret; |
57773204 | 562 | |
9bfc503d MD |
563 | if (!chan_data) |
564 | return NULL; | |
565 | ||
57773204 MD |
566 | handle = channel_handle_create(chan_data->shm_fd, |
567 | chan_data->wait_fd, | |
568 | chan_data->memory_map_size); | |
569 | if (!handle) { | |
570 | ERR("create handle error"); | |
571 | return NULL; | |
572 | } | |
573 | /* | |
0bfe09ec MD |
574 | * Set to -1, and then close the shm fd, and set the handle shm |
575 | * fd to -1 too. We don't need the shm fds after they have been | |
576 | * mapped. | |
577 | * The wait_fd is set to -1 in chan_data because it is now owned | |
578 | * by the handle. | |
57773204 MD |
579 | */ |
580 | chan_data->shm_fd = -1; | |
581 | chan_data->wait_fd = -1; | |
582 | ||
0bfe09ec MD |
583 | /* chan is object 0. This is hardcoded. */ |
584 | if (handle->table->objects[0].shm_fd >= 0) { | |
585 | ret = close(handle->table->objects[0].shm_fd); | |
586 | if (ret) { | |
587 | perror("Error closing shm_fd"); | |
588 | } | |
589 | handle->table->objects[0].shm_fd = -1; | |
590 | } | |
591 | ||
57773204 MD |
592 | /* |
593 | * TODO: add consistency checks to be resilient if the | |
594 | * application try to feed us with incoherent channel structure | |
595 | * values. | |
596 | */ | |
597 | chan = shmp(handle, handle->chan); | |
598 | /* chan is object 0. This is hardcoded. */ | |
599 | chan_size = handle->table->objects[0].allocated_len; | |
600 | handle->shadow_chan = malloc(chan_size); | |
601 | if (!handle->shadow_chan) { | |
602 | channel_destroy(chan, handle, 1); | |
603 | return NULL; | |
604 | } | |
605 | memcpy(handle->shadow_chan, chan, chan_size); | |
bbc70d1b MD |
606 | /* |
607 | * The callback pointers in the producer are invalid in the | |
c1fca457 | 608 | * consumer. We need to look them up here. |
bbc70d1b | 609 | */ |
c1fca457 MD |
610 | config = &handle->shadow_chan->backend.config; |
611 | switch (config->client_type) { | |
612 | case LTTNG_CLIENT_METADATA: | |
613 | memcpy(&config->cb, lttng_client_callbacks_metadata, | |
614 | sizeof(config->cb)); | |
615 | break; | |
616 | case LTTNG_CLIENT_DISCARD: | |
617 | memcpy(&config->cb, lttng_client_callbacks_discard, | |
618 | sizeof(config->cb)); | |
619 | break; | |
620 | case LTTNG_CLIENT_OVERWRITE: | |
621 | memcpy(&config->cb, lttng_client_callbacks_overwrite, | |
622 | sizeof(config->cb)); | |
623 | break; | |
624 | default: | |
625 | ERR("Unknown client type %d", config->client_type); | |
626 | channel_destroy(chan, handle, 1); | |
627 | return NULL; | |
628 | } | |
7a784989 MD |
629 | /* Replace the object table pointer. */ |
630 | ret = munmap(handle->table->objects[0].memory_map, | |
631 | handle->table->objects[0].memory_map_size); | |
632 | if (ret) { | |
633 | perror("munmap"); | |
634 | assert(0); | |
635 | } | |
636 | handle->table->objects[0].memory_map = (char *) handle->shadow_chan; | |
637 | handle->table->objects[0].is_shadow = 1; | |
57773204 MD |
638 | return handle; |
639 | } | |
640 | ||
641 | /* Add stream to channel shm and map its shm into process memory */ | |
38fae1d3 | 642 | int ustctl_add_stream(struct lttng_ust_shm_handle *handle, |
61f02aea | 643 | struct lttng_ust_object_data *stream_data) |
57773204 MD |
644 | { |
645 | int ret; | |
646 | ||
9bfc503d MD |
647 | if (!handle || !stream_data) |
648 | return -EINVAL; | |
649 | ||
57773204 MD |
650 | if (!stream_data->handle) |
651 | return -ENOENT; | |
652 | /* map stream */ | |
653 | ret = channel_handle_add_stream(handle, | |
654 | stream_data->shm_fd, | |
655 | stream_data->wait_fd, | |
656 | stream_data->memory_map_size); | |
657 | if (ret) { | |
658 | ERR("add stream error\n"); | |
659 | return ret; | |
660 | } | |
661 | /* | |
38fae1d3 | 662 | * Set to -1 because the lttng_ust_shm_handle destruction will take care |
57773204 MD |
663 | * of closing shm_fd and wait_fd. |
664 | */ | |
665 | stream_data->shm_fd = -1; | |
666 | stream_data->wait_fd = -1; | |
667 | return 0; | |
668 | } | |
669 | ||
38fae1d3 | 670 | void ustctl_unmap_channel(struct lttng_ust_shm_handle *handle) |
5224b5c8 MD |
671 | { |
672 | struct channel *chan; | |
673 | ||
9bfc503d | 674 | assert(handle); |
5224b5c8 MD |
675 | chan = shmp(handle, handle->chan); |
676 | channel_destroy(chan, handle, 1); | |
677 | } | |
678 | ||
0bfe09ec MD |
679 | /* |
680 | * ustctl closes the shm_fd fds after mapping it. | |
681 | */ | |
4cfec15c | 682 | struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle, |
6e922b24 MD |
683 | int cpu) |
684 | { | |
685 | struct channel *chan = handle->shadow_chan; | |
ef9ff354 MD |
686 | int *shm_fd, *wait_fd; |
687 | uint64_t *memory_map_size; | |
4cfec15c | 688 | struct lttng_ust_lib_ring_buffer *buf; |
6e922b24 MD |
689 | int ret; |
690 | ||
9bfc503d MD |
691 | if (!handle) |
692 | return NULL; | |
693 | ||
6e922b24 MD |
694 | buf = channel_get_ring_buffer(&chan->backend.config, |
695 | chan, cpu, handle, &shm_fd, &wait_fd, &memory_map_size); | |
696 | if (!buf) | |
697 | return NULL; | |
698 | ret = lib_ring_buffer_open_read(buf, handle, 1); | |
699 | if (ret) | |
700 | return NULL; | |
0bfe09ec MD |
701 | /* |
702 | * We can close shm_fd early, right after is has been mapped. | |
703 | */ | |
704 | if (*shm_fd >= 0) { | |
705 | ret = close(*shm_fd); | |
706 | if (ret) { | |
707 | perror("Error closing shm_fd"); | |
708 | } | |
709 | *shm_fd = -1; | |
710 | } | |
6e922b24 MD |
711 | return buf; |
712 | } | |
713 | ||
38fae1d3 | 714 | void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle, |
4cfec15c | 715 | struct lttng_ust_lib_ring_buffer *buf) |
6e922b24 | 716 | { |
9bfc503d | 717 | assert(handle && buf); |
6e922b24 MD |
718 | lib_ring_buffer_release_read(buf, handle, 1); |
719 | } | |
720 | ||
57773204 MD |
721 | /* For mmap mode, readable without "get" operation */ |
722 | ||
38fae1d3 | 723 | void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle, |
4cfec15c | 724 | struct lttng_ust_lib_ring_buffer *buf) |
9095efe9 | 725 | { |
9bfc503d MD |
726 | if (!handle || !buf) |
727 | return NULL; | |
9095efe9 MD |
728 | return shmp(handle, buf->backend.memory_map); |
729 | } | |
730 | ||
57773204 | 731 | /* returns the length to mmap. */ |
38fae1d3 | 732 | int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle, |
4cfec15c | 733 | struct lttng_ust_lib_ring_buffer *buf, |
57773204 MD |
734 | unsigned long *len) |
735 | { | |
736 | unsigned long mmap_buf_len; | |
737 | struct channel *chan = handle->shadow_chan; | |
738 | ||
9bfc503d MD |
739 | if (!handle || !buf || !len) |
740 | return -EINVAL; | |
741 | ||
57773204 MD |
742 | if (chan->backend.config.output != RING_BUFFER_MMAP) |
743 | return -EINVAL; | |
744 | mmap_buf_len = chan->backend.buf_size; | |
745 | if (chan->backend.extra_reader_sb) | |
746 | mmap_buf_len += chan->backend.subbuf_size; | |
747 | if (mmap_buf_len > INT_MAX) | |
748 | return -EFBIG; | |
749 | *len = mmap_buf_len; | |
750 | return 0; | |
751 | } | |
752 | ||
753 | /* returns the maximum size for sub-buffers. */ | |
38fae1d3 | 754 | int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle, |
4cfec15c | 755 | struct lttng_ust_lib_ring_buffer *buf, |
57773204 MD |
756 | unsigned long *len) |
757 | { | |
758 | struct channel *chan = handle->shadow_chan; | |
759 | ||
9bfc503d MD |
760 | if (!handle || !buf || !len) |
761 | return -EINVAL; | |
762 | ||
57773204 MD |
763 | *len = chan->backend.subbuf_size; |
764 | return 0; | |
765 | } | |
766 | ||
767 | /* | |
768 | * For mmap mode, operate on the current packet (between get/put or | |
769 | * get_next/put_next). | |
770 | */ | |
771 | ||
772 | /* returns the offset of the subbuffer belonging to the mmap reader. */ | |
38fae1d3 | 773 | int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle, |
4cfec15c | 774 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *off) |
57773204 MD |
775 | { |
776 | struct channel *chan = handle->shadow_chan; | |
777 | unsigned long sb_bindex; | |
778 | ||
9bfc503d MD |
779 | if (!handle || !buf || !off) |
780 | return -EINVAL; | |
781 | ||
57773204 MD |
782 | if (chan->backend.config.output != RING_BUFFER_MMAP) |
783 | return -EINVAL; | |
784 | sb_bindex = subbuffer_id_get_index(&chan->backend.config, | |
785 | buf->backend.buf_rsb.id); | |
786 | *off = shmp(handle, shmp_index(handle, buf->backend.array, sb_bindex)->shmp)->mmap_offset; | |
787 | return 0; | |
788 | } | |
789 | ||
790 | /* returns the size of the current sub-buffer, without padding (for mmap). */ | |
38fae1d3 | 791 | int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle, |
4cfec15c | 792 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *len) |
57773204 MD |
793 | { |
794 | struct channel *chan = handle->shadow_chan; | |
795 | ||
9bfc503d MD |
796 | if (!handle || !buf || !len) |
797 | return -EINVAL; | |
798 | ||
57773204 MD |
799 | *len = lib_ring_buffer_get_read_data_size(&chan->backend.config, buf, |
800 | handle); | |
801 | return 0; | |
802 | } | |
803 | ||
804 | /* returns the size of the current sub-buffer, without padding (for mmap). */ | |
38fae1d3 | 805 | int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle, |
4cfec15c | 806 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *len) |
57773204 MD |
807 | { |
808 | struct channel *chan = handle->shadow_chan; | |
809 | ||
9bfc503d MD |
810 | if (!handle || !buf || !len) |
811 | return -EINVAL; | |
812 | ||
57773204 MD |
813 | *len = lib_ring_buffer_get_read_data_size(&chan->backend.config, buf, |
814 | handle); | |
815 | *len = PAGE_ALIGN(*len); | |
816 | return 0; | |
817 | } | |
818 | ||
819 | /* Get exclusive read access to the next sub-buffer that can be read. */ | |
38fae1d3 | 820 | int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle, |
4cfec15c | 821 | struct lttng_ust_lib_ring_buffer *buf) |
57773204 | 822 | { |
9bfc503d MD |
823 | if (!handle || !buf) |
824 | return -EINVAL; | |
825 | ||
57773204 MD |
826 | return lib_ring_buffer_get_next_subbuf(buf, handle); |
827 | } | |
828 | ||
829 | ||
830 | /* Release exclusive sub-buffer access, move consumer forward. */ | |
38fae1d3 | 831 | int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle, |
4cfec15c | 832 | struct lttng_ust_lib_ring_buffer *buf) |
57773204 | 833 | { |
9bfc503d MD |
834 | if (!handle || !buf) |
835 | return -EINVAL; | |
836 | ||
57773204 MD |
837 | lib_ring_buffer_put_next_subbuf(buf, handle); |
838 | return 0; | |
839 | } | |
840 | ||
841 | /* snapshot */ | |
842 | ||
843 | /* Get a snapshot of the current ring buffer producer and consumer positions */ | |
38fae1d3 | 844 | int ustctl_snapshot(struct lttng_ust_shm_handle *handle, |
4cfec15c | 845 | struct lttng_ust_lib_ring_buffer *buf) |
57773204 | 846 | { |
9bfc503d MD |
847 | if (!handle || !buf) |
848 | return -EINVAL; | |
849 | ||
57773204 MD |
850 | return lib_ring_buffer_snapshot(buf, &buf->cons_snapshot, |
851 | &buf->prod_snapshot, handle); | |
852 | } | |
853 | ||
854 | /* Get the consumer position (iteration start) */ | |
38fae1d3 | 855 | int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle, |
4cfec15c | 856 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos) |
57773204 | 857 | { |
9bfc503d MD |
858 | if (!handle || !buf || !pos) |
859 | return -EINVAL; | |
860 | ||
57773204 MD |
861 | *pos = buf->cons_snapshot; |
862 | return 0; | |
863 | } | |
864 | ||
865 | /* Get the producer position (iteration end) */ | |
38fae1d3 | 866 | int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle, |
4cfec15c | 867 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos) |
57773204 | 868 | { |
9bfc503d MD |
869 | if (!handle || !buf || !pos) |
870 | return -EINVAL; | |
871 | ||
57773204 MD |
872 | *pos = buf->prod_snapshot; |
873 | return 0; | |
874 | } | |
875 | ||
876 | /* Get exclusive read access to the specified sub-buffer position */ | |
38fae1d3 | 877 | int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle, |
4cfec15c | 878 | struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos) |
57773204 | 879 | { |
9bfc503d MD |
880 | if (!handle || !buf || !pos) |
881 | return -EINVAL; | |
882 | ||
57773204 MD |
883 | return lib_ring_buffer_get_subbuf(buf, *pos, handle); |
884 | } | |
885 | ||
886 | /* Release exclusive sub-buffer access */ | |
38fae1d3 | 887 | int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle, |
4cfec15c | 888 | struct lttng_ust_lib_ring_buffer *buf) |
57773204 | 889 | { |
9bfc503d MD |
890 | if (!handle || !buf) |
891 | return -EINVAL; | |
892 | ||
57773204 MD |
893 | lib_ring_buffer_put_subbuf(buf, handle); |
894 | return 0; | |
895 | } | |
896 | ||
02a15cfb | 897 | void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle, |
b52190f2 MD |
898 | struct lttng_ust_lib_ring_buffer *buf, |
899 | int producer_active) | |
57773204 | 900 | { |
9bfc503d | 901 | assert(handle && buf); |
b52190f2 MD |
902 | lib_ring_buffer_switch_slow(buf, |
903 | producer_active ? SWITCH_ACTIVE : SWITCH_FLUSH, | |
904 | handle); | |
57773204 | 905 | } |