4 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * Mimic system calls for:
9 * - session creation, returns an object descriptor or failure.
10 * - channel creation, returns an object descriptor or failure.
11 * - Operates on a session object descriptor
12 * - Takes all channel options as parameters.
13 * - stream get, returns an object descriptor or failure.
14 * - Operates on a channel object descriptor.
15 * - stream notifier get, returns an object descriptor or failure.
16 * - Operates on a channel object descriptor.
17 * - event creation, returns an object descriptor or failure.
18 * - Operates on a channel object descriptor
19 * - Takes an event name as parameter
20 * - Takes an instrumentation source as parameter
21 * - e.g. tracepoints, dynamic_probes...
22 * - Takes instrumentation source specific arguments.
24 * Dual LGPL v2.1/GPL v2 license.
27 #include <ust/lttng-ust-abi.h>
28 #include <urcu/compiler.h>
29 #include <urcu/list.h>
30 #include <ust/lttng-events.h>
31 #include <ust/usterr-signal-safe.h>
33 #include "ltt-tracer.h"
36 * Object descriptor table. Should be protected from concurrent access
44 const struct objd_ops
*ops
;
47 int freelist_next
; /* offset freelist. end is -1. */
53 unsigned int len
, allocated_len
;
54 int freelist_head
; /* offset freelist head. end is -1 */
57 static struct objd_table objd_table
= {
62 int objd_alloc(void *private_data
, const struct objd_ops
*ops
)
66 if (objd_table
.freelist_head
!= -1) {
67 obj
= &objd_table
.array
[objd_table
.freelist_head
];
68 objd_table
.freelist_head
= obj
->u
.freelist_next
;
72 if (objd_table
.len
>= objd_table
.allocated_len
) {
73 unsigned int new_allocated_len
, old_allocated_len
;
74 struct obj
*new_table
, *old_table
;
76 old_allocated_len
= objd_table
.allocated_len
;
77 old_table
= objd_table
.array
;
78 if (!old_allocated_len
)
79 new_allocated_len
= 1;
81 new_allocated_len
= old_allocated_len
<< 1;
82 new_table
= zmalloc(sizeof(struct obj
) * new_allocated_len
);
85 memcpy(new_table
, old_table
,
86 sizeof(struct obj
) * old_allocated_len
);
88 objd_table
.array
= new_table
;
89 objd_table
.allocated_len
= new_allocated_len
;
91 obj
= &objd_table
.array
[objd_table
.len
];
94 obj
->u
.s
.private_data
= private_data
;
96 obj
->u
.s
.f_count
= 2; /* count == 1 : object is allocated */
97 /* count == 2 : allocated + hold ref */
98 return obj
- objd_table
.array
;
102 struct obj
*_objd_get(int id
)
104 if (id
>= objd_table
.len
)
106 if (!objd_table
.array
[id
].u
.s
.f_count
)
108 return &objd_table
.array
[id
];
112 void *objd_private(int id
)
114 struct obj
*obj
= _objd_get(id
);
116 return obj
->u
.s
.private_data
;
120 void objd_set_private(int id
, void *private_data
)
122 struct obj
*obj
= _objd_get(id
);
124 obj
->u
.s
.private_data
= private_data
;
127 const struct objd_ops
*objd_ops(int id
)
129 struct obj
*obj
= _objd_get(id
);
137 void objd_free(int id
)
139 struct obj
*obj
= _objd_get(id
);
142 obj
->u
.freelist_next
= objd_table
.freelist_head
;
143 objd_table
.freelist_head
= obj
- objd_table
.array
;
144 assert(obj
->u
.s
.f_count
== 1);
145 obj
->u
.s
.f_count
= 0; /* deallocated */
149 void objd_ref(int id
)
151 struct obj
*obj
= _objd_get(id
);
155 int objd_unref(int id
)
157 struct obj
*obj
= _objd_get(id
);
161 if (obj
->u
.s
.f_count
== 1) {
162 ERR("Reference counting error\n");
165 if ((--obj
->u
.s
.f_count
) == 1) {
166 const struct objd_ops
*ops
= objd_ops(id
);
176 void objd_table_destroy(void)
180 for (i
= 0; i
< objd_table
.allocated_len
; i
++)
181 (void) objd_unref(i
);
182 free(objd_table
.array
);
183 objd_table
.array
= NULL
;
185 objd_table
.allocated_len
= 0;
186 objd_table
.freelist_head
= -1;
190 * This is LTTng's own personal way to create an ABI for sessiond.
191 * We send commands over a socket.
194 static const struct objd_ops lttng_ops
;
195 static const struct objd_ops lttng_session_ops
;
196 static const struct objd_ops lttng_channel_ops
;
197 static const struct objd_ops lttng_metadata_ops
;
198 static const struct objd_ops lttng_event_ops
;
199 static const struct objd_ops lib_ring_buffer_objd_ops
;
206 int lttng_abi_create_root_handle(void)
210 root_handle
= objd_alloc(NULL
, <tng_ops
);
215 int lttng_abi_create_session(void)
217 struct ltt_session
*session
;
218 int session_objd
, ret
;
220 session
= ltt_session_create();
223 session_objd
= objd_alloc(session
, <tng_session_ops
);
224 if (session_objd
< 0) {
228 session
->objd
= session_objd
;
232 ltt_session_destroy(session
);
238 int lttng_abi_tracepoint_list(void)
242 /* TODO: Create list private data */
243 list_objd
= objd_alloc(NULL
, <tng_tracepoint_list_ops
);
257 long lttng_abi_tracer_version(int objd
,
258 struct lttng_ust_tracer_version
*v
)
260 v
->version
= LTTNG_UST_VERSION
;
261 v
->patchlevel
= LTTNG_UST_PATCHLEVEL
;
262 v
->sublevel
= LTTNG_UST_SUBLEVEL
;
267 long lttng_abi_add_context(int objd
,
268 struct lttng_ust_context
*context_param
,
269 struct lttng_ctx
**ctx
, struct ltt_session
*session
)
271 if (session
->been_active
)
274 switch (context_param
->ctx
) {
275 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
276 return lttng_add_pthread_id_to_ctx(ctx
);
277 case LTTNG_UST_CONTEXT_VTID
:
278 return lttng_add_vtid_to_ctx(ctx
);
285 * lttng_cmd - lttng control through socket commands
287 * @objd: the object descriptor
291 * This descriptor implements lttng commands:
293 * Returns a LTTng trace session object descriptor
294 * LTTNG_UST_TRACER_VERSION
295 * Returns the LTTng kernel tracer version
296 * LTTNG_UST_TRACEPOINT_LIST
297 * Returns a file descriptor listing available tracepoints
298 * LTTNG_UST_WAIT_QUIESCENT
299 * Returns after all previously running probes have completed
301 * The returned session will be deleted when its file descriptor is closed.
304 long lttng_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
307 case LTTNG_UST_SESSION
:
308 return lttng_abi_create_session();
309 case LTTNG_UST_TRACER_VERSION
:
310 return lttng_abi_tracer_version(objd
,
311 (struct lttng_ust_tracer_version
*) arg
);
312 case LTTNG_UST_TRACEPOINT_LIST
:
313 return -ENOSYS
; //TODO
314 //return lttng_abi_tracepoint_list();
315 case LTTNG_UST_WAIT_QUIESCENT
:
323 static const struct objd_ops lttng_ops
= {
328 * We tolerate no failure in this function (if one happens, we print a dmesg
329 * error, but cannot return any error, because the channel information is
333 void lttng_metadata_create_events(int channel_objd
)
335 struct ltt_channel
*channel
= objd_private(channel_objd
);
336 static struct lttng_ust_event metadata_params
= {
337 .instrumentation
= LTTNG_UST_TRACEPOINT
,
338 .name
= "lttng_metadata",
340 struct ltt_event
*event
;
344 * We tolerate no failure path after event creation. It will stay
345 * invariant for the rest of the session.
347 event
= ltt_event_create(channel
, &metadata_params
, NULL
);
356 return; /* not allowed to return error */
359 int lttng_abi_create_channel(int session_objd
,
360 struct lttng_ust_channel
*chan_param
,
361 enum channel_type channel_type
)
363 struct ltt_session
*session
= objd_private(session_objd
);
364 const struct objd_ops
*ops
;
365 const char *transport_name
;
366 struct ltt_channel
*chan
;
370 chan_objd
= objd_alloc(NULL
, <tng_channel_ops
);
375 switch (channel_type
) {
376 case PER_CPU_CHANNEL
:
377 if (chan_param
->output
== LTTNG_UST_MMAP
) {
378 transport_name
= chan_param
->overwrite
?
379 "relay-overwrite-mmap" : "relay-discard-mmap";
383 ops
= <tng_channel_ops
;
385 case METADATA_CHANNEL
:
386 if (chan_param
->output
== LTTNG_UST_MMAP
)
387 transport_name
= "relay-metadata-mmap";
390 ops
= <tng_metadata_ops
;
393 transport_name
= "<unknown>";
397 * We tolerate no failure path after channel creation. It will stay
398 * invariant for the rest of the session.
400 chan
= ltt_channel_create(session
, transport_name
, NULL
,
401 chan_param
->subbuf_size
,
402 chan_param
->num_subbuf
,
403 chan_param
->switch_timer_interval
,
404 chan_param
->read_timer_interval
,
406 &chan_param
->wait_fd
,
407 &chan_param
->memory_map_size
);
412 objd_set_private(chan_objd
, chan
);
413 chan
->objd
= chan_objd
;
414 if (channel_type
== METADATA_CHANNEL
) {
415 session
->metadata
= chan
;
416 lttng_metadata_create_events(chan_objd
);
419 /* The channel created holds a reference on the session */
420 objd_ref(session_objd
);
428 err
= objd_unref(chan_objd
);
436 * lttng_session_cmd - lttng session object command
442 * This descriptor implements lttng commands:
444 * Returns a LTTng channel object descriptor
446 * Enables tracing for a session (weak enable)
448 * Disables tracing for a session (strong disable)
450 * Returns a LTTng metadata object descriptor
452 * The returned channel will be deleted when its file descriptor is closed.
455 long lttng_session_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
457 struct ltt_session
*session
= objd_private(objd
);
460 case LTTNG_UST_CHANNEL
:
461 return lttng_abi_create_channel(objd
,
462 (struct lttng_ust_channel
*) arg
,
464 case LTTNG_UST_SESSION_START
:
465 case LTTNG_UST_ENABLE
:
466 return ltt_session_enable(session
);
467 case LTTNG_UST_SESSION_STOP
:
468 case LTTNG_UST_DISABLE
:
469 return ltt_session_disable(session
);
470 case LTTNG_UST_METADATA
:
471 return lttng_abi_create_channel(objd
,
472 (struct lttng_ust_channel
*) arg
,
480 * Called when the last file reference is dropped.
482 * Big fat note: channels and events are invariant for the whole session after
483 * their creation. So this session destruction also destroys all channel and
484 * event structures specific to this session (they are not destroyed when their
485 * individual file is released).
488 int lttng_release_session(int objd
)
490 struct ltt_session
*session
= objd_private(objd
);
493 ltt_session_destroy(session
);
500 static const struct objd_ops lttng_session_ops
= {
501 .release
= lttng_release_session
,
502 .cmd
= lttng_session_cmd
,
505 struct stream_priv_data
{
506 struct lib_ring_buffer
*buf
;
507 struct ltt_channel
*ltt_chan
;
511 int lttng_abi_open_stream(int channel_objd
, struct lttng_ust_stream
*info
)
513 struct ltt_channel
*channel
= objd_private(channel_objd
);
514 struct lib_ring_buffer
*buf
;
515 struct stream_priv_data
*priv
;
516 int stream_objd
, ret
;
518 buf
= channel
->ops
->buffer_read_open(channel
->chan
, channel
->handle
,
519 &info
->shm_fd
, &info
->wait_fd
, &info
->memory_map_size
);
523 priv
= zmalloc(sizeof(*priv
));
529 priv
->ltt_chan
= channel
;
530 stream_objd
= objd_alloc(priv
, &lib_ring_buffer_objd_ops
);
531 if (stream_objd
< 0) {
535 /* Hold a reference on the channel object descriptor */
536 objd_ref(channel_objd
);
542 channel
->ops
->buffer_read_close(buf
, channel
->handle
);
547 int lttng_abi_create_event(int channel_objd
,
548 struct lttng_ust_event
*event_param
)
550 struct ltt_channel
*channel
= objd_private(channel_objd
);
551 struct ltt_event
*event
;
554 event_param
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
555 event_objd
= objd_alloc(NULL
, <tng_event_ops
);
556 if (event_objd
< 0) {
561 * We tolerate no failure path after event creation. It will stay
562 * invariant for the rest of the session.
564 event
= ltt_event_create(channel
, event_param
, NULL
);
569 objd_set_private(event_objd
, event
);
570 /* The event holds a reference on the channel */
571 objd_ref(channel_objd
);
578 err
= objd_unref(event_objd
);
586 * lttng_channel_cmd - lttng control through object descriptors
588 * @objd: the object descriptor
592 * This object descriptor implements lttng commands:
594 * Returns an event stream object descriptor or failure.
595 * (typically, one event stream records events from one CPU)
597 * Returns an event object descriptor or failure.
599 * Prepend a context field to each event in the channel
601 * Enable recording for events in this channel (weak enable)
603 * Disable recording for events in this channel (strong disable)
605 * Channel and event file descriptors also hold a reference on the session.
608 long lttng_channel_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
610 struct ltt_channel
*channel
= objd_private(objd
);
613 case LTTNG_UST_STREAM
:
615 struct lttng_ust_stream
*stream
;
617 stream
= (struct lttng_ust_stream
*) arg
;
618 /* stream used as output */
619 return lttng_abi_open_stream(objd
, stream
);
621 case LTTNG_UST_EVENT
:
622 return lttng_abi_create_event(objd
, (struct lttng_ust_event
*) arg
);
623 case LTTNG_UST_CONTEXT
:
624 return lttng_abi_add_context(objd
,
625 (struct lttng_ust_context
*) arg
,
626 &channel
->ctx
, channel
->session
);
627 case LTTNG_UST_ENABLE
:
628 return ltt_channel_enable(channel
);
629 case LTTNG_UST_DISABLE
:
630 return ltt_channel_disable(channel
);
637 * lttng_metadata_cmd - lttng control through object descriptors
639 * @objd: the object descriptor
643 * This object descriptor implements lttng commands:
645 * Returns an event stream file descriptor or failure.
647 * Channel and event file descriptors also hold a reference on the session.
650 long lttng_metadata_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
653 case LTTNG_UST_STREAM
:
655 struct lttng_ust_stream
*stream
;
657 stream
= (struct lttng_ust_stream
*) arg
;
658 /* stream used as output */
659 return lttng_abi_open_stream(objd
, stream
);
668 * lttng_channel_poll - lttng stream addition/removal monitoring
673 unsigned int lttng_channel_poll(struct file
*file
, poll_table
*wait
)
675 struct ltt_channel
*channel
= file
->private_data
;
676 unsigned int mask
= 0;
678 if (file
->f_mode
& FMODE_READ
) {
679 poll_wait_set_exclusive(wait
);
680 poll_wait(file
, channel
->ops
->get_hp_wait_queue(channel
->chan
),
683 if (channel
->ops
->is_disabled(channel
->chan
))
685 if (channel
->ops
->is_finalized(channel
->chan
))
687 if (channel
->ops
->buffer_has_read_closed_stream(channel
->chan
))
688 return POLLIN
| POLLRDNORM
;
697 int lttng_channel_release(int objd
)
699 struct ltt_channel
*channel
= objd_private(objd
);
702 return objd_unref(channel
->session
->objd
);
706 static const struct objd_ops lttng_channel_ops
= {
707 .release
= lttng_channel_release
,
708 //.poll = lttng_channel_poll,
709 .cmd
= lttng_channel_cmd
,
712 static const struct objd_ops lttng_metadata_ops
= {
713 .release
= lttng_channel_release
,
714 .cmd
= lttng_metadata_cmd
,
718 * lttng_rb_cmd - lttng ring buffer control through object descriptors
720 * @objd: the object descriptor
724 * This object descriptor implements lttng commands:
725 * (None for now. Access is done directly though shm.)
726 * TODO: Add buffer flush.
729 long lttng_rb_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
731 //struct stream_priv_data *priv = objd_private(objd);
740 int lttng_rb_release(int objd
)
742 struct stream_priv_data
*priv
= objd_private(objd
);
743 struct lib_ring_buffer
*buf
;
744 struct ltt_channel
*channel
;
748 channel
= priv
->ltt_chan
;
750 channel
->ops
->buffer_read_close(buf
, channel
->handle
);
752 return objd_unref(channel
->objd
);
757 static const struct objd_ops lib_ring_buffer_objd_ops
= {
758 .release
= lttng_rb_release
,
763 * lttng_event_cmd - lttng control through object descriptors
765 * @objd: the object descriptor
769 * This object descriptor implements lttng commands:
771 * Prepend a context field to each record of this event
773 * Enable recording for this event (weak enable)
775 * Disable recording for this event (strong disable)
778 long lttng_event_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
780 struct ltt_event
*event
= objd_private(objd
);
783 case LTTNG_UST_CONTEXT
:
784 return lttng_abi_add_context(objd
,
785 (struct lttng_ust_context
*) arg
,
786 &event
->ctx
, event
->chan
->session
);
787 case LTTNG_UST_ENABLE
:
788 return ltt_event_enable(event
);
789 case LTTNG_UST_DISABLE
:
790 return ltt_event_disable(event
);
797 int lttng_event_release(int objd
)
799 struct ltt_event
*event
= objd_private(objd
);
802 return objd_unref(event
->chan
->objd
);
806 /* TODO: filter control ioctl */
807 static const struct objd_ops lttng_event_ops
= {
808 .release
= lttng_event_release
,
809 .cmd
= lttng_event_cmd
,
812 void lttng_ust_abi_exit(void)
814 objd_table_destroy();