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;
44 * If sock is negative, it means we don't have to notify the other side
45 * (e.g. application has already vanished).
47 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
)
49 struct ustcomm_ust_msg lum
;
50 struct ustcomm_ust_reply lur
;
53 if (data
->shm_fd
>= 0) {
54 ret
= close(data
->shm_fd
);
59 if (data
->wait_fd
>= 0) {
60 ret
= close(data
->wait_fd
);
66 memset(&lum
, 0, sizeof(lum
));
67 lum
.handle
= data
->handle
;
68 lum
.cmd
= LTTNG_UST_RELEASE
;
69 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
78 * Send registration done packet to the application.
80 int ustctl_register_done(int sock
)
82 struct ustcomm_ust_msg lum
;
83 struct ustcomm_ust_reply lur
;
86 DBG("Sending register done command to %d", sock
);
87 memset(&lum
, 0, sizeof(lum
));
88 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
89 lum
.cmd
= LTTNG_UST_REGISTER_DONE
;
90 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
93 if (lur
.ret_code
!= USTCOMM_OK
) {
94 DBG("Return code: %s", ustcomm_get_readable_code(lur
.ret_code
));
104 * returns session handle.
106 int ustctl_create_session(int sock
)
108 struct ustcomm_ust_msg lum
;
109 struct ustcomm_ust_reply lur
;
110 int ret
, session_handle
;
113 memset(&lum
, 0, sizeof(lum
));
114 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
115 lum
.cmd
= LTTNG_UST_SESSION
;
116 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
119 session_handle
= lur
.ret_val
;
120 DBG("received session handle %u", session_handle
);
121 return session_handle
;
124 /* open the metadata global channel */
125 int ustctl_open_metadata(int sock
, int session_handle
,
126 struct lttng_ust_channel_attr
*chops
,
127 struct lttng_ust_object_data
**_metadata_data
)
129 struct ustcomm_ust_msg lum
;
130 struct ustcomm_ust_reply lur
;
131 struct lttng_ust_object_data
*metadata_data
;
134 metadata_data
= malloc(sizeof(*metadata_data
));
137 init_object(metadata_data
);
138 /* Create metadata channel */
139 memset(&lum
, 0, sizeof(lum
));
140 lum
.handle
= session_handle
;
141 lum
.cmd
= LTTNG_UST_METADATA
;
142 lum
.u
.channel
.overwrite
= chops
->overwrite
;
143 lum
.u
.channel
.subbuf_size
= chops
->subbuf_size
;
144 lum
.u
.channel
.num_subbuf
= chops
->num_subbuf
;
145 lum
.u
.channel
.switch_timer_interval
= chops
->switch_timer_interval
;
146 lum
.u
.channel
.read_timer_interval
= chops
->read_timer_interval
;
147 lum
.u
.channel
.output
= chops
->output
;
148 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
153 if (lur
.ret_code
!= USTCOMM_OK
) {
157 metadata_data
->handle
= lur
.ret_val
;
158 DBG("received metadata handle %u", metadata_data
->handle
);
159 metadata_data
->memory_map_size
= lur
.u
.channel
.memory_map_size
;
161 ret
= ustcomm_recv_fd(sock
);
164 metadata_data
->shm_fd
= ret
;
166 ret
= ustcomm_recv_fd(sock
);
169 metadata_data
->wait_fd
= ret
;
170 *_metadata_data
= metadata_data
;
174 (void) ustctl_release_object(sock
, metadata_data
);
179 int ustctl_create_channel(int sock
, int session_handle
,
180 struct lttng_ust_channel_attr
*chops
,
181 struct lttng_ust_object_data
**_channel_data
)
183 struct ustcomm_ust_msg lum
;
184 struct ustcomm_ust_reply lur
;
185 struct lttng_ust_object_data
*channel_data
;
188 channel_data
= malloc(sizeof(*channel_data
));
191 init_object(channel_data
);
192 /* Create metadata channel */
193 memset(&lum
, 0, sizeof(lum
));
194 lum
.handle
= session_handle
;
195 lum
.cmd
= LTTNG_UST_CHANNEL
;
196 lum
.u
.channel
.overwrite
= chops
->overwrite
;
197 lum
.u
.channel
.subbuf_size
= chops
->subbuf_size
;
198 lum
.u
.channel
.num_subbuf
= chops
->num_subbuf
;
199 lum
.u
.channel
.switch_timer_interval
= chops
->switch_timer_interval
;
200 lum
.u
.channel
.read_timer_interval
= chops
->read_timer_interval
;
201 lum
.u
.channel
.output
= chops
->output
;
202 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
207 if (lur
.ret_code
!= USTCOMM_OK
) {
211 channel_data
->handle
= lur
.ret_val
;
212 DBG("received channel handle %u", channel_data
->handle
);
213 channel_data
->memory_map_size
= lur
.u
.channel
.memory_map_size
;
215 ret
= ustcomm_recv_fd(sock
);
218 channel_data
->shm_fd
= ret
;
220 ret
= ustcomm_recv_fd(sock
);
223 channel_data
->wait_fd
= ret
;
224 *_channel_data
= channel_data
;
228 (void) ustctl_release_object(sock
, channel_data
);
234 * Return -ENOENT if no more stream is available for creation.
235 * Return 0 on success.
236 * Return negative error value on error.
238 int ustctl_create_stream(int sock
, struct lttng_ust_object_data
*channel_data
,
239 struct lttng_ust_object_data
**_stream_data
)
241 struct ustcomm_ust_msg lum
;
242 struct ustcomm_ust_reply lur
;
243 struct lttng_ust_object_data
*stream_data
;
246 stream_data
= malloc(sizeof(*stream_data
));
249 init_object(stream_data
);
250 memset(&lum
, 0, sizeof(lum
));
251 lum
.handle
= channel_data
->handle
;
252 lum
.cmd
= LTTNG_UST_STREAM
;
253 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
258 if (lur
.ret_code
!= USTCOMM_OK
) {
263 stream_data
->handle
= lur
.ret_val
;
264 DBG("received stream handle %u", stream_data
->handle
);
265 stream_data
->memory_map_size
= lur
.u
.stream
.memory_map_size
;
267 fd
= ustcomm_recv_fd(sock
);
270 stream_data
->shm_fd
= fd
;
272 fd
= ustcomm_recv_fd(sock
);
275 stream_data
->wait_fd
= fd
;
276 *_stream_data
= stream_data
;
280 (void) ustctl_release_object(sock
, stream_data
);
285 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
286 struct lttng_ust_object_data
*channel_data
,
287 struct lttng_ust_object_data
**_event_data
)
289 struct ustcomm_ust_msg lum
;
290 struct ustcomm_ust_reply lur
;
291 struct lttng_ust_object_data
*event_data
;
294 event_data
= malloc(sizeof(*event_data
));
297 init_object(event_data
);
298 memset(&lum
, 0, sizeof(lum
));
299 lum
.handle
= channel_data
->handle
;
300 lum
.cmd
= LTTNG_UST_EVENT
;
301 strncpy(lum
.u
.event
.name
, ev
->name
,
302 LTTNG_UST_SYM_NAME_LEN
);
303 lum
.u
.event
.instrumentation
= ev
->instrumentation
;
304 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
309 event_data
->handle
= lur
.ret_val
;
310 DBG("received event handle %u", event_data
->handle
);
311 *_event_data
= event_data
;
315 int ustctl_add_context(int sock
, struct lttng_ust_context
*ctx
,
316 struct lttng_ust_object_data
*obj_data
,
317 struct lttng_ust_object_data
**_context_data
)
319 struct ustcomm_ust_msg lum
;
320 struct ustcomm_ust_reply lur
;
321 struct lttng_ust_object_data
*context_data
;
324 context_data
= malloc(sizeof(*context_data
));
327 init_object(context_data
);
328 memset(&lum
, 0, sizeof(lum
));
329 lum
.handle
= obj_data
->handle
;
330 lum
.cmd
= LTTNG_UST_CONTEXT
;
331 lum
.u
.context
.ctx
= ctx
->ctx
;
332 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
337 context_data
->handle
= lur
.ret_val
;
338 DBG("received context handle %u", context_data
->handle
);
339 *_context_data
= context_data
;
343 /* Enable event, channel and session ioctl */
344 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
)
346 struct ustcomm_ust_msg lum
;
347 struct ustcomm_ust_reply lur
;
350 memset(&lum
, 0, sizeof(lum
));
351 lum
.handle
= object
->handle
;
352 lum
.cmd
= LTTNG_UST_ENABLE
;
353 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
356 DBG("enabled handle %u", object
->handle
);
360 /* Disable event, channel and session ioctl */
361 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
)
363 struct ustcomm_ust_msg lum
;
364 struct ustcomm_ust_reply lur
;
367 memset(&lum
, 0, sizeof(lum
));
368 lum
.handle
= object
->handle
;
369 lum
.cmd
= LTTNG_UST_DISABLE
;
370 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
373 DBG("disable handle %u", object
->handle
);
377 int ustctl_start_session(int sock
, int handle
)
379 struct lttng_ust_object_data obj
;
382 return ustctl_enable(sock
, &obj
);
385 int ustctl_stop_session(int sock
, int handle
)
387 struct lttng_ust_object_data obj
;
390 return ustctl_disable(sock
, &obj
);
393 int ustctl_tracepoint_list(int sock
)
395 struct ustcomm_ust_msg lum
;
396 struct ustcomm_ust_reply lur
;
397 int ret
, tp_list_handle
;
399 memset(&lum
, 0, sizeof(lum
));
400 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
401 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST
;
402 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
405 tp_list_handle
= lur
.ret_val
;
406 DBG("received tracepoint list handle %u", tp_list_handle
);
407 return tp_list_handle
;
410 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
411 struct ustctl_tracepoint_iter
*iter
)
413 struct ustcomm_ust_msg lum
;
414 struct ustcomm_ust_reply lur
;
417 memset(&lum
, 0, sizeof(lum
));
418 lum
.handle
= tp_list_handle
;
419 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST_GET
;
420 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
423 DBG("received tracepoint list entry %s", lur
.u
.tracepoint_list_entry
);
424 memcpy(iter
->name
, lur
.u
.tracepoint_list_entry
, LTTNG_UST_SYM_NAME_LEN
);
428 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
)
430 struct ustcomm_ust_msg lum
;
431 struct ustcomm_ust_reply lur
;
434 memset(&lum
, 0, sizeof(lum
));
435 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
436 lum
.cmd
= LTTNG_UST_TRACER_VERSION
;
437 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
440 memcpy(v
, &lur
.u
.version
, sizeof(*v
));
441 DBG("received tracer version");
445 int ustctl_wait_quiescent(int sock
)
447 struct ustcomm_ust_msg lum
;
448 struct ustcomm_ust_reply lur
;
451 memset(&lum
, 0, sizeof(lum
));
452 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
453 lum
.cmd
= LTTNG_UST_WAIT_QUIESCENT
;
454 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
457 DBG("waited for quiescent state");
461 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
)
466 /* Buffer operations */
468 /* Map channel shm into process memory */
469 struct lttng_ust_shm_handle
*ustctl_map_channel(struct lttng_ust_object_data
*chan_data
)
471 struct lttng_ust_shm_handle
*handle
;
472 struct channel
*chan
;
474 struct lttng_ust_lib_ring_buffer_config
*config
;
477 handle
= channel_handle_create(chan_data
->shm_fd
,
479 chan_data
->memory_map_size
);
481 ERR("create handle error");
485 * Set to -1 because the lttng_ust_shm_handle destruction will take care
486 * of closing shm_fd and wait_fd.
488 chan_data
->shm_fd
= -1;
489 chan_data
->wait_fd
= -1;
492 * TODO: add consistency checks to be resilient if the
493 * application try to feed us with incoherent channel structure
496 chan
= shmp(handle
, handle
->chan
);
497 /* chan is object 0. This is hardcoded. */
498 chan_size
= handle
->table
->objects
[0].allocated_len
;
499 handle
->shadow_chan
= malloc(chan_size
);
500 if (!handle
->shadow_chan
) {
501 channel_destroy(chan
, handle
, 1);
504 memcpy(handle
->shadow_chan
, chan
, chan_size
);
506 * The callback pointers in the producer are invalid in the
507 * consumer. We need to look them up here.
509 config
= &handle
->shadow_chan
->backend
.config
;
510 switch (config
->client_type
) {
511 case LTTNG_CLIENT_METADATA
:
512 memcpy(&config
->cb
, lttng_client_callbacks_metadata
,
515 case LTTNG_CLIENT_DISCARD
:
516 memcpy(&config
->cb
, lttng_client_callbacks_discard
,
519 case LTTNG_CLIENT_OVERWRITE
:
520 memcpy(&config
->cb
, lttng_client_callbacks_overwrite
,
524 ERR("Unknown client type %d", config
->client_type
);
525 channel_destroy(chan
, handle
, 1);
528 /* Replace the object table pointer. */
529 ret
= munmap(handle
->table
->objects
[0].memory_map
,
530 handle
->table
->objects
[0].memory_map_size
);
535 handle
->table
->objects
[0].memory_map
= (char *) handle
->shadow_chan
;
536 handle
->table
->objects
[0].is_shadow
= 1;
540 /* Add stream to channel shm and map its shm into process memory */
541 int ustctl_add_stream(struct lttng_ust_shm_handle
*handle
,
542 struct lttng_ust_object_data
*stream_data
)
546 if (!stream_data
->handle
)
549 ret
= channel_handle_add_stream(handle
,
551 stream_data
->wait_fd
,
552 stream_data
->memory_map_size
);
554 ERR("add stream error\n");
558 * Set to -1 because the lttng_ust_shm_handle destruction will take care
559 * of closing shm_fd and wait_fd.
561 stream_data
->shm_fd
= -1;
562 stream_data
->wait_fd
= -1;
566 void ustctl_unmap_channel(struct lttng_ust_shm_handle
*handle
)
568 struct channel
*chan
;
570 chan
= shmp(handle
, handle
->chan
);
571 channel_destroy(chan
, handle
, 1);
574 struct lttng_ust_lib_ring_buffer
*ustctl_open_stream_read(struct lttng_ust_shm_handle
*handle
,
577 struct channel
*chan
= handle
->shadow_chan
;
579 uint64_t memory_map_size
;
580 struct lttng_ust_lib_ring_buffer
*buf
;
583 buf
= channel_get_ring_buffer(&chan
->backend
.config
,
584 chan
, cpu
, handle
, &shm_fd
, &wait_fd
, &memory_map_size
);
587 ret
= lib_ring_buffer_open_read(buf
, handle
, 1);
593 void ustctl_close_stream_read(struct lttng_ust_shm_handle
*handle
,
594 struct lttng_ust_lib_ring_buffer
*buf
)
596 lib_ring_buffer_release_read(buf
, handle
, 1);
599 /* For mmap mode, readable without "get" operation */
601 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle
*handle
,
602 struct lttng_ust_lib_ring_buffer
*buf
)
604 return shmp(handle
, buf
->backend
.memory_map
);
607 /* returns the length to mmap. */
608 int ustctl_get_mmap_len(struct lttng_ust_shm_handle
*handle
,
609 struct lttng_ust_lib_ring_buffer
*buf
,
612 unsigned long mmap_buf_len
;
613 struct channel
*chan
= handle
->shadow_chan
;
615 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
617 mmap_buf_len
= chan
->backend
.buf_size
;
618 if (chan
->backend
.extra_reader_sb
)
619 mmap_buf_len
+= chan
->backend
.subbuf_size
;
620 if (mmap_buf_len
> INT_MAX
)
626 /* returns the maximum size for sub-buffers. */
627 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle
*handle
,
628 struct lttng_ust_lib_ring_buffer
*buf
,
631 struct channel
*chan
= handle
->shadow_chan
;
633 *len
= chan
->backend
.subbuf_size
;
638 * For mmap mode, operate on the current packet (between get/put or
639 * get_next/put_next).
642 /* returns the offset of the subbuffer belonging to the mmap reader. */
643 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle
*handle
,
644 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *off
)
646 struct channel
*chan
= handle
->shadow_chan
;
647 unsigned long sb_bindex
;
649 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
651 sb_bindex
= subbuffer_id_get_index(&chan
->backend
.config
,
652 buf
->backend
.buf_rsb
.id
);
653 *off
= shmp(handle
, shmp_index(handle
, buf
->backend
.array
, sb_bindex
)->shmp
)->mmap_offset
;
657 /* returns the size of the current sub-buffer, without padding (for mmap). */
658 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle
*handle
,
659 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *len
)
661 struct channel
*chan
= handle
->shadow_chan
;
663 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
668 /* returns the size of the current sub-buffer, without padding (for mmap). */
669 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle
*handle
,
670 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *len
)
672 struct channel
*chan
= handle
->shadow_chan
;
674 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
676 *len
= PAGE_ALIGN(*len
);
680 /* Get exclusive read access to the next sub-buffer that can be read. */
681 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle
*handle
,
682 struct lttng_ust_lib_ring_buffer
*buf
)
684 return lib_ring_buffer_get_next_subbuf(buf
, handle
);
688 /* Release exclusive sub-buffer access, move consumer forward. */
689 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle
*handle
,
690 struct lttng_ust_lib_ring_buffer
*buf
)
692 lib_ring_buffer_put_next_subbuf(buf
, handle
);
698 /* Get a snapshot of the current ring buffer producer and consumer positions */
699 int ustctl_snapshot(struct lttng_ust_shm_handle
*handle
,
700 struct lttng_ust_lib_ring_buffer
*buf
)
702 return lib_ring_buffer_snapshot(buf
, &buf
->cons_snapshot
,
703 &buf
->prod_snapshot
, handle
);
706 /* Get the consumer position (iteration start) */
707 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle
*handle
,
708 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
)
710 *pos
= buf
->cons_snapshot
;
714 /* Get the producer position (iteration end) */
715 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle
*handle
,
716 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
)
718 *pos
= buf
->prod_snapshot
;
722 /* Get exclusive read access to the specified sub-buffer position */
723 int ustctl_get_subbuf(struct lttng_ust_shm_handle
*handle
,
724 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
)
726 return lib_ring_buffer_get_subbuf(buf
, *pos
, handle
);
729 /* Release exclusive sub-buffer access */
730 int ustctl_put_subbuf(struct lttng_ust_shm_handle
*handle
,
731 struct lttng_ust_lib_ring_buffer
*buf
)
733 lib_ring_buffer_put_subbuf(buf
, handle
);
737 void ustctl_flush_buffer(struct lttng_ust_shm_handle
*handle
,
738 struct lttng_ust_lib_ring_buffer
*buf
,
741 lib_ring_buffer_switch_slow(buf
,
742 producer_active
? SWITCH_ACTIVE
: SWITCH_FLUSH
,