2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #include <lttng/ust-ctl.h>
22 #include <lttng/ust-abi.h>
23 #include <lttng/ust-events.h>
26 #include <usterr-signal-safe.h>
29 #include "../libringbuffer/backend.h"
30 #include "../libringbuffer/frontend.h"
32 volatile enum ust_loglevel ust_loglevel
;
35 void init_object(struct lttng_ust_object_data
*data
)
40 data
->memory_map_size
= 0;
43 int ustctl_release_handle(int sock
, int handle
)
45 struct ustcomm_ust_msg lum
;
46 struct ustcomm_ust_reply lur
;
50 memset(&lum
, 0, sizeof(lum
));
52 lum
.cmd
= LTTNG_UST_RELEASE
;
53 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
61 * If sock is negative, it means we don't have to notify the other side
62 * (e.g. application has already vanished).
64 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
)
68 if (data
->shm_fd
>= 0) {
69 ret
= close(data
->shm_fd
);
74 if (data
->wait_fd
>= 0) {
75 ret
= close(data
->wait_fd
);
80 return ustctl_release_handle(sock
, data
->handle
);
84 * Send registration done packet to the application.
86 int ustctl_register_done(int sock
)
88 struct ustcomm_ust_msg lum
;
89 struct ustcomm_ust_reply lur
;
92 DBG("Sending register done command to %d", sock
);
93 memset(&lum
, 0, sizeof(lum
));
94 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
95 lum
.cmd
= LTTNG_UST_REGISTER_DONE
;
96 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
99 if (lur
.ret_code
!= USTCOMM_OK
) {
100 DBG("Return code: %s", ustcomm_get_readable_code(lur
.ret_code
));
110 * returns session handle.
112 int ustctl_create_session(int sock
)
114 struct ustcomm_ust_msg lum
;
115 struct ustcomm_ust_reply lur
;
116 int ret
, session_handle
;
119 memset(&lum
, 0, sizeof(lum
));
120 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
121 lum
.cmd
= LTTNG_UST_SESSION
;
122 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
125 session_handle
= lur
.ret_val
;
126 DBG("received session handle %u", session_handle
);
127 return session_handle
;
130 /* open the metadata global channel */
131 int ustctl_open_metadata(int sock
, int session_handle
,
132 struct lttng_ust_channel_attr
*chops
,
133 struct lttng_ust_object_data
**_metadata_data
)
135 struct ustcomm_ust_msg lum
;
136 struct ustcomm_ust_reply lur
;
137 struct lttng_ust_object_data
*metadata_data
;
140 metadata_data
= malloc(sizeof(*metadata_data
));
143 init_object(metadata_data
);
144 /* Create metadata channel */
145 memset(&lum
, 0, sizeof(lum
));
146 lum
.handle
= session_handle
;
147 lum
.cmd
= LTTNG_UST_METADATA
;
148 lum
.u
.channel
.overwrite
= chops
->overwrite
;
149 lum
.u
.channel
.subbuf_size
= chops
->subbuf_size
;
150 lum
.u
.channel
.num_subbuf
= chops
->num_subbuf
;
151 lum
.u
.channel
.switch_timer_interval
= chops
->switch_timer_interval
;
152 lum
.u
.channel
.read_timer_interval
= chops
->read_timer_interval
;
153 lum
.u
.channel
.output
= chops
->output
;
154 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
159 if (lur
.ret_code
!= USTCOMM_OK
) {
163 metadata_data
->handle
= lur
.ret_val
;
164 DBG("received metadata handle %u", metadata_data
->handle
);
165 metadata_data
->memory_map_size
= lur
.u
.channel
.memory_map_size
;
167 ret
= ustcomm_recv_fd(sock
);
170 metadata_data
->shm_fd
= ret
;
172 ret
= ustcomm_recv_fd(sock
);
175 metadata_data
->wait_fd
= ret
;
176 *_metadata_data
= metadata_data
;
180 (void) ustctl_release_object(sock
, metadata_data
);
185 int ustctl_create_channel(int sock
, int session_handle
,
186 struct lttng_ust_channel_attr
*chops
,
187 struct lttng_ust_object_data
**_channel_data
)
189 struct ustcomm_ust_msg lum
;
190 struct ustcomm_ust_reply lur
;
191 struct lttng_ust_object_data
*channel_data
;
194 channel_data
= malloc(sizeof(*channel_data
));
197 init_object(channel_data
);
198 /* Create metadata channel */
199 memset(&lum
, 0, sizeof(lum
));
200 lum
.handle
= session_handle
;
201 lum
.cmd
= LTTNG_UST_CHANNEL
;
202 lum
.u
.channel
.overwrite
= chops
->overwrite
;
203 lum
.u
.channel
.subbuf_size
= chops
->subbuf_size
;
204 lum
.u
.channel
.num_subbuf
= chops
->num_subbuf
;
205 lum
.u
.channel
.switch_timer_interval
= chops
->switch_timer_interval
;
206 lum
.u
.channel
.read_timer_interval
= chops
->read_timer_interval
;
207 lum
.u
.channel
.output
= chops
->output
;
208 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
213 if (lur
.ret_code
!= USTCOMM_OK
) {
217 channel_data
->handle
= lur
.ret_val
;
218 DBG("received channel handle %u", channel_data
->handle
);
219 channel_data
->memory_map_size
= lur
.u
.channel
.memory_map_size
;
221 ret
= ustcomm_recv_fd(sock
);
224 channel_data
->shm_fd
= ret
;
226 ret
= ustcomm_recv_fd(sock
);
229 channel_data
->wait_fd
= ret
;
230 *_channel_data
= channel_data
;
234 (void) ustctl_release_object(sock
, channel_data
);
240 * Return -ENOENT if no more stream is available for creation.
241 * Return 0 on success.
242 * Return negative error value on error.
244 int ustctl_create_stream(int sock
, struct lttng_ust_object_data
*channel_data
,
245 struct lttng_ust_object_data
**_stream_data
)
247 struct ustcomm_ust_msg lum
;
248 struct ustcomm_ust_reply lur
;
249 struct lttng_ust_object_data
*stream_data
;
252 stream_data
= malloc(sizeof(*stream_data
));
255 init_object(stream_data
);
256 memset(&lum
, 0, sizeof(lum
));
257 lum
.handle
= channel_data
->handle
;
258 lum
.cmd
= LTTNG_UST_STREAM
;
259 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
264 if (lur
.ret_code
!= USTCOMM_OK
) {
269 stream_data
->handle
= lur
.ret_val
;
270 DBG("received stream handle %u", stream_data
->handle
);
271 stream_data
->memory_map_size
= lur
.u
.stream
.memory_map_size
;
273 fd
= ustcomm_recv_fd(sock
);
276 stream_data
->shm_fd
= fd
;
278 fd
= ustcomm_recv_fd(sock
);
281 stream_data
->wait_fd
= fd
;
282 *_stream_data
= stream_data
;
286 (void) ustctl_release_object(sock
, stream_data
);
291 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
292 struct lttng_ust_object_data
*channel_data
,
293 struct lttng_ust_object_data
**_event_data
)
295 struct ustcomm_ust_msg lum
;
296 struct ustcomm_ust_reply lur
;
297 struct lttng_ust_object_data
*event_data
;
300 event_data
= malloc(sizeof(*event_data
));
303 init_object(event_data
);
304 memset(&lum
, 0, sizeof(lum
));
305 lum
.handle
= channel_data
->handle
;
306 lum
.cmd
= LTTNG_UST_EVENT
;
307 strncpy(lum
.u
.event
.name
, ev
->name
,
308 LTTNG_UST_SYM_NAME_LEN
);
309 lum
.u
.event
.instrumentation
= ev
->instrumentation
;
310 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
315 event_data
->handle
= lur
.ret_val
;
316 DBG("received event handle %u", event_data
->handle
);
317 *_event_data
= event_data
;
321 int ustctl_add_context(int sock
, struct lttng_ust_context
*ctx
,
322 struct lttng_ust_object_data
*obj_data
,
323 struct lttng_ust_object_data
**_context_data
)
325 struct ustcomm_ust_msg lum
;
326 struct ustcomm_ust_reply lur
;
327 struct lttng_ust_object_data
*context_data
;
330 context_data
= malloc(sizeof(*context_data
));
333 init_object(context_data
);
334 memset(&lum
, 0, sizeof(lum
));
335 lum
.handle
= obj_data
->handle
;
336 lum
.cmd
= LTTNG_UST_CONTEXT
;
337 lum
.u
.context
.ctx
= ctx
->ctx
;
338 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
343 context_data
->handle
= lur
.ret_val
;
344 DBG("received context handle %u", context_data
->handle
);
345 *_context_data
= context_data
;
349 /* Enable event, channel and session ioctl */
350 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
)
352 struct ustcomm_ust_msg lum
;
353 struct ustcomm_ust_reply lur
;
356 memset(&lum
, 0, sizeof(lum
));
357 lum
.handle
= object
->handle
;
358 lum
.cmd
= LTTNG_UST_ENABLE
;
359 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
362 DBG("enabled handle %u", object
->handle
);
366 /* Disable event, channel and session ioctl */
367 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
)
369 struct ustcomm_ust_msg lum
;
370 struct ustcomm_ust_reply lur
;
373 memset(&lum
, 0, sizeof(lum
));
374 lum
.handle
= object
->handle
;
375 lum
.cmd
= LTTNG_UST_DISABLE
;
376 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
379 DBG("disable handle %u", object
->handle
);
383 int ustctl_start_session(int sock
, int handle
)
385 struct lttng_ust_object_data obj
;
388 return ustctl_enable(sock
, &obj
);
391 int ustctl_stop_session(int sock
, int handle
)
393 struct lttng_ust_object_data obj
;
396 return ustctl_disable(sock
, &obj
);
399 int ustctl_tracepoint_list(int sock
)
401 struct ustcomm_ust_msg lum
;
402 struct ustcomm_ust_reply lur
;
403 int ret
, tp_list_handle
;
405 memset(&lum
, 0, sizeof(lum
));
406 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
407 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST
;
408 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
411 tp_list_handle
= lur
.ret_val
;
412 DBG("received tracepoint list handle %u", tp_list_handle
);
413 return tp_list_handle
;
416 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
417 struct lttng_ust_tracepoint_iter
*iter
)
419 struct ustcomm_ust_msg lum
;
420 struct ustcomm_ust_reply lur
;
423 memset(&lum
, 0, sizeof(lum
));
424 lum
.handle
= tp_list_handle
;
425 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST_GET
;
426 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
429 DBG("received tracepoint list entry name %s loglevel %s loglevel_value %lld",
430 lur
.u
.tracepoint
.name
,
431 lur
.u
.tracepoint
.loglevel
,
432 (unsigned long long) lur
.u
.tracepoint
.loglevel_value
);
433 memcpy(iter
, &lur
.u
.tracepoint
, sizeof(*iter
));
437 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
)
439 struct ustcomm_ust_msg lum
;
440 struct ustcomm_ust_reply lur
;
443 memset(&lum
, 0, sizeof(lum
));
444 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
445 lum
.cmd
= LTTNG_UST_TRACER_VERSION
;
446 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
449 memcpy(v
, &lur
.u
.version
, sizeof(*v
));
450 DBG("received tracer version");
454 int ustctl_wait_quiescent(int sock
)
456 struct ustcomm_ust_msg lum
;
457 struct ustcomm_ust_reply lur
;
460 memset(&lum
, 0, sizeof(lum
));
461 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
462 lum
.cmd
= LTTNG_UST_WAIT_QUIESCENT
;
463 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
466 DBG("waited for quiescent state");
470 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
)
475 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
)
477 struct ustcomm_ust_msg lum
;
478 struct ustcomm_ust_reply lur
;
481 memset(&lum
, 0, sizeof(lum
));
482 lum
.handle
= object
->handle
;
483 lum
.cmd
= LTTNG_UST_FLUSH_BUFFER
;
484 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
487 DBG("flushed buffer handle %u", object
->handle
);
491 /* Buffer operations */
493 /* Map channel shm into process memory */
494 struct lttng_ust_shm_handle
*ustctl_map_channel(struct lttng_ust_object_data
*chan_data
)
496 struct lttng_ust_shm_handle
*handle
;
497 struct channel
*chan
;
499 struct lttng_ust_lib_ring_buffer_config
*config
;
502 handle
= channel_handle_create(chan_data
->shm_fd
,
504 chan_data
->memory_map_size
);
506 ERR("create handle error");
510 * Set to -1, and then close the shm fd, and set the handle shm
511 * fd to -1 too. We don't need the shm fds after they have been
513 * The wait_fd is set to -1 in chan_data because it is now owned
516 chan_data
->shm_fd
= -1;
517 chan_data
->wait_fd
= -1;
519 /* chan is object 0. This is hardcoded. */
520 if (handle
->table
->objects
[0].shm_fd
>= 0) {
521 ret
= close(handle
->table
->objects
[0].shm_fd
);
523 perror("Error closing shm_fd");
525 handle
->table
->objects
[0].shm_fd
= -1;
529 * TODO: add consistency checks to be resilient if the
530 * application try to feed us with incoherent channel structure
533 chan
= shmp(handle
, handle
->chan
);
534 /* chan is object 0. This is hardcoded. */
535 chan_size
= handle
->table
->objects
[0].allocated_len
;
536 handle
->shadow_chan
= malloc(chan_size
);
537 if (!handle
->shadow_chan
) {
538 channel_destroy(chan
, handle
, 1);
541 memcpy(handle
->shadow_chan
, chan
, chan_size
);
543 * The callback pointers in the producer are invalid in the
544 * consumer. We need to look them up here.
546 config
= &handle
->shadow_chan
->backend
.config
;
547 switch (config
->client_type
) {
548 case LTTNG_CLIENT_METADATA
:
549 memcpy(&config
->cb
, lttng_client_callbacks_metadata
,
552 case LTTNG_CLIENT_DISCARD
:
553 memcpy(&config
->cb
, lttng_client_callbacks_discard
,
556 case LTTNG_CLIENT_OVERWRITE
:
557 memcpy(&config
->cb
, lttng_client_callbacks_overwrite
,
561 ERR("Unknown client type %d", config
->client_type
);
562 channel_destroy(chan
, handle
, 1);
565 /* Replace the object table pointer. */
566 ret
= munmap(handle
->table
->objects
[0].memory_map
,
567 handle
->table
->objects
[0].memory_map_size
);
572 handle
->table
->objects
[0].memory_map
= (char *) handle
->shadow_chan
;
573 handle
->table
->objects
[0].is_shadow
= 1;
577 /* Add stream to channel shm and map its shm into process memory */
578 int ustctl_add_stream(struct lttng_ust_shm_handle
*handle
,
579 struct lttng_ust_object_data
*stream_data
)
583 if (!stream_data
->handle
)
586 ret
= channel_handle_add_stream(handle
,
588 stream_data
->wait_fd
,
589 stream_data
->memory_map_size
);
591 ERR("add stream error\n");
595 * Set to -1 because the lttng_ust_shm_handle destruction will take care
596 * of closing shm_fd and wait_fd.
598 stream_data
->shm_fd
= -1;
599 stream_data
->wait_fd
= -1;
603 void ustctl_unmap_channel(struct lttng_ust_shm_handle
*handle
)
605 struct channel
*chan
;
607 chan
= shmp(handle
, handle
->chan
);
608 channel_destroy(chan
, handle
, 1);
612 * ustctl closes the shm_fd fds after mapping it.
614 struct lttng_ust_lib_ring_buffer
*ustctl_open_stream_read(struct lttng_ust_shm_handle
*handle
,
617 struct channel
*chan
= handle
->shadow_chan
;
618 int *shm_fd
, *wait_fd
;
619 uint64_t *memory_map_size
;
620 struct lttng_ust_lib_ring_buffer
*buf
;
623 buf
= channel_get_ring_buffer(&chan
->backend
.config
,
624 chan
, cpu
, handle
, &shm_fd
, &wait_fd
, &memory_map_size
);
627 ret
= lib_ring_buffer_open_read(buf
, handle
, 1);
631 * We can close shm_fd early, right after is has been mapped.
634 ret
= close(*shm_fd
);
636 perror("Error closing shm_fd");
643 void ustctl_close_stream_read(struct lttng_ust_shm_handle
*handle
,
644 struct lttng_ust_lib_ring_buffer
*buf
)
646 lib_ring_buffer_release_read(buf
, handle
, 1);
649 /* For mmap mode, readable without "get" operation */
651 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle
*handle
,
652 struct lttng_ust_lib_ring_buffer
*buf
)
654 return shmp(handle
, buf
->backend
.memory_map
);
657 /* returns the length to mmap. */
658 int ustctl_get_mmap_len(struct lttng_ust_shm_handle
*handle
,
659 struct lttng_ust_lib_ring_buffer
*buf
,
662 unsigned long mmap_buf_len
;
663 struct channel
*chan
= handle
->shadow_chan
;
665 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
667 mmap_buf_len
= chan
->backend
.buf_size
;
668 if (chan
->backend
.extra_reader_sb
)
669 mmap_buf_len
+= chan
->backend
.subbuf_size
;
670 if (mmap_buf_len
> INT_MAX
)
676 /* returns the maximum size for sub-buffers. */
677 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle
*handle
,
678 struct lttng_ust_lib_ring_buffer
*buf
,
681 struct channel
*chan
= handle
->shadow_chan
;
683 *len
= chan
->backend
.subbuf_size
;
688 * For mmap mode, operate on the current packet (between get/put or
689 * get_next/put_next).
692 /* returns the offset of the subbuffer belonging to the mmap reader. */
693 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle
*handle
,
694 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *off
)
696 struct channel
*chan
= handle
->shadow_chan
;
697 unsigned long sb_bindex
;
699 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
701 sb_bindex
= subbuffer_id_get_index(&chan
->backend
.config
,
702 buf
->backend
.buf_rsb
.id
);
703 *off
= shmp(handle
, shmp_index(handle
, buf
->backend
.array
, sb_bindex
)->shmp
)->mmap_offset
;
707 /* returns the size of the current sub-buffer, without padding (for mmap). */
708 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle
*handle
,
709 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *len
)
711 struct channel
*chan
= handle
->shadow_chan
;
713 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
718 /* returns the size of the current sub-buffer, without padding (for mmap). */
719 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle
*handle
,
720 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *len
)
722 struct channel
*chan
= handle
->shadow_chan
;
724 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
726 *len
= PAGE_ALIGN(*len
);
730 /* Get exclusive read access to the next sub-buffer that can be read. */
731 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle
*handle
,
732 struct lttng_ust_lib_ring_buffer
*buf
)
734 return lib_ring_buffer_get_next_subbuf(buf
, handle
);
738 /* Release exclusive sub-buffer access, move consumer forward. */
739 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle
*handle
,
740 struct lttng_ust_lib_ring_buffer
*buf
)
742 lib_ring_buffer_put_next_subbuf(buf
, handle
);
748 /* Get a snapshot of the current ring buffer producer and consumer positions */
749 int ustctl_snapshot(struct lttng_ust_shm_handle
*handle
,
750 struct lttng_ust_lib_ring_buffer
*buf
)
752 return lib_ring_buffer_snapshot(buf
, &buf
->cons_snapshot
,
753 &buf
->prod_snapshot
, handle
);
756 /* Get the consumer position (iteration start) */
757 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle
*handle
,
758 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
)
760 *pos
= buf
->cons_snapshot
;
764 /* Get the producer position (iteration end) */
765 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle
*handle
,
766 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
)
768 *pos
= buf
->prod_snapshot
;
772 /* Get exclusive read access to the specified sub-buffer position */
773 int ustctl_get_subbuf(struct lttng_ust_shm_handle
*handle
,
774 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
)
776 return lib_ring_buffer_get_subbuf(buf
, *pos
, handle
);
779 /* Release exclusive sub-buffer access */
780 int ustctl_put_subbuf(struct lttng_ust_shm_handle
*handle
,
781 struct lttng_ust_lib_ring_buffer
*buf
)
783 lib_ring_buffer_put_subbuf(buf
, handle
);
787 void ustctl_flush_buffer(struct lttng_ust_shm_handle
*handle
,
788 struct lttng_ust_lib_ring_buffer
*buf
,
791 lib_ring_buffer_switch_slow(buf
,
792 producer_active
? SWITCH_ACTIVE
: SWITCH_FLUSH
,