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
);
283 * lttng_cmd - lttng control through socket commands
285 * @objd: the object descriptor
289 * This descriptor implements lttng commands:
291 * Returns a LTTng trace session object descriptor
292 * LTTNG_UST_TRACER_VERSION
293 * Returns the LTTng kernel tracer version
294 * LTTNG_UST_TRACEPOINT_LIST
295 * Returns a file descriptor listing available tracepoints
296 * LTTNG_UST_WAIT_QUIESCENT
297 * Returns after all previously running probes have completed
299 * The returned session will be deleted when its file descriptor is closed.
302 long lttng_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
305 case LTTNG_UST_SESSION
:
306 return lttng_abi_create_session();
307 case LTTNG_UST_TRACER_VERSION
:
308 return lttng_abi_tracer_version(objd
,
309 (struct lttng_ust_tracer_version
*) arg
);
310 case LTTNG_UST_TRACEPOINT_LIST
:
311 return -ENOSYS
; //TODO
312 //return lttng_abi_tracepoint_list();
313 case LTTNG_UST_WAIT_QUIESCENT
:
321 static const struct objd_ops lttng_ops
= {
326 * We tolerate no failure in this function (if one happens, we print a dmesg
327 * error, but cannot return any error, because the channel information is
331 void lttng_metadata_create_events(int channel_objd
)
333 struct ltt_channel
*channel
= objd_private(channel_objd
);
334 static struct lttng_ust_event metadata_params
= {
335 .instrumentation
= LTTNG_UST_TRACEPOINT
,
336 .name
= "lttng_metadata",
338 struct ltt_event
*event
;
342 * We tolerate no failure path after event creation. It will stay
343 * invariant for the rest of the session.
345 event
= ltt_event_create(channel
, &metadata_params
, NULL
);
354 return; /* not allowed to return error */
357 int lttng_abi_create_channel(int session_objd
,
358 struct lttng_ust_channel
*chan_param
,
359 enum channel_type channel_type
)
361 struct ltt_session
*session
= objd_private(session_objd
);
362 const struct objd_ops
*ops
;
363 const char *transport_name
;
364 struct ltt_channel
*chan
;
368 chan_objd
= objd_alloc(NULL
, <tng_channel_ops
);
373 switch (channel_type
) {
374 case PER_CPU_CHANNEL
:
375 if (chan_param
->output
== LTTNG_UST_MMAP
) {
376 transport_name
= chan_param
->overwrite
?
377 "relay-overwrite-mmap" : "relay-discard-mmap";
381 ops
= <tng_channel_ops
;
383 case METADATA_CHANNEL
:
384 if (chan_param
->output
== LTTNG_UST_MMAP
)
385 transport_name
= "relay-metadata-mmap";
388 ops
= <tng_metadata_ops
;
391 transport_name
= "<unknown>";
395 * We tolerate no failure path after channel creation. It will stay
396 * invariant for the rest of the session.
398 chan
= ltt_channel_create(session
, transport_name
, NULL
,
399 chan_param
->subbuf_size
,
400 chan_param
->num_subbuf
,
401 chan_param
->switch_timer_interval
,
402 chan_param
->read_timer_interval
,
404 &chan_param
->wait_fd
,
405 &chan_param
->memory_map_size
);
410 objd_set_private(chan_objd
, chan
);
411 chan
->objd
= chan_objd
;
412 if (channel_type
== METADATA_CHANNEL
) {
413 session
->metadata
= chan
;
414 lttng_metadata_create_events(chan_objd
);
417 /* The channel created holds a reference on the session */
418 objd_ref(session_objd
);
426 err
= objd_unref(chan_objd
);
434 * lttng_session_cmd - lttng session object command
440 * This descriptor implements lttng commands:
442 * Returns a LTTng channel object descriptor
444 * Enables tracing for a session (weak enable)
446 * Disables tracing for a session (strong disable)
448 * Returns a LTTng metadata object descriptor
450 * The returned channel will be deleted when its file descriptor is closed.
453 long lttng_session_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
455 struct ltt_session
*session
= objd_private(objd
);
458 case LTTNG_UST_CHANNEL
:
459 return lttng_abi_create_channel(objd
,
460 (struct lttng_ust_channel
*) arg
,
462 case LTTNG_UST_SESSION_START
:
463 case LTTNG_UST_ENABLE
:
464 return ltt_session_enable(session
);
465 case LTTNG_UST_SESSION_STOP
:
466 case LTTNG_UST_DISABLE
:
467 return ltt_session_disable(session
);
468 case LTTNG_UST_METADATA
:
469 return lttng_abi_create_channel(objd
,
470 (struct lttng_ust_channel
*) arg
,
478 * Called when the last file reference is dropped.
480 * Big fat note: channels and events are invariant for the whole session after
481 * their creation. So this session destruction also destroys all channel and
482 * event structures specific to this session (they are not destroyed when their
483 * individual file is released).
486 int lttng_release_session(int objd
)
488 struct ltt_session
*session
= objd_private(objd
);
491 ltt_session_destroy(session
);
498 static const struct objd_ops lttng_session_ops
= {
499 .release
= lttng_release_session
,
500 .cmd
= lttng_session_cmd
,
503 struct stream_priv_data
{
504 struct lib_ring_buffer
*buf
;
505 struct ltt_channel
*ltt_chan
;
509 int lttng_abi_open_stream(int channel_objd
, struct lttng_ust_stream
*info
)
511 struct ltt_channel
*channel
= objd_private(channel_objd
);
512 struct lib_ring_buffer
*buf
;
513 struct stream_priv_data
*priv
;
514 int stream_objd
, ret
;
516 buf
= channel
->ops
->buffer_read_open(channel
->chan
, channel
->handle
,
517 &info
->shm_fd
, &info
->wait_fd
, &info
->memory_map_size
);
521 priv
= zmalloc(sizeof(*priv
));
527 priv
->ltt_chan
= channel
;
528 stream_objd
= objd_alloc(priv
, &lib_ring_buffer_objd_ops
);
529 if (stream_objd
< 0) {
533 /* Hold a reference on the channel object descriptor */
534 objd_ref(channel_objd
);
540 channel
->ops
->buffer_read_close(buf
, channel
->handle
);
545 int lttng_abi_create_event(int channel_objd
,
546 struct lttng_ust_event
*event_param
)
548 struct ltt_channel
*channel
= objd_private(channel_objd
);
549 struct ltt_event
*event
;
552 event_param
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
553 event_objd
= objd_alloc(NULL
, <tng_event_ops
);
554 if (event_objd
< 0) {
559 * We tolerate no failure path after event creation. It will stay
560 * invariant for the rest of the session.
562 event
= ltt_event_create(channel
, event_param
, NULL
);
567 objd_set_private(event_objd
, event
);
568 /* The event holds a reference on the channel */
569 objd_ref(channel_objd
);
576 err
= objd_unref(event_objd
);
584 * lttng_channel_cmd - lttng control through object descriptors
586 * @objd: the object descriptor
590 * This object descriptor implements lttng commands:
592 * Returns an event stream object descriptor or failure.
593 * (typically, one event stream records events from one CPU)
595 * Returns an event object descriptor or failure.
597 * Prepend a context field to each event in the channel
599 * Enable recording for events in this channel (weak enable)
601 * Disable recording for events in this channel (strong disable)
603 * Channel and event file descriptors also hold a reference on the session.
606 long lttng_channel_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
608 struct ltt_channel
*channel
= objd_private(objd
);
611 case LTTNG_UST_STREAM
:
613 struct lttng_ust_stream
*stream
;
615 stream
= (struct lttng_ust_stream
*) arg
;
616 /* stream used as output */
617 return lttng_abi_open_stream(objd
, stream
);
619 case LTTNG_UST_EVENT
:
620 return lttng_abi_create_event(objd
, (struct lttng_ust_event
*) arg
);
621 case LTTNG_UST_CONTEXT
:
622 return lttng_abi_add_context(objd
,
623 (struct lttng_ust_context
*) arg
,
624 &channel
->ctx
, channel
->session
);
625 case LTTNG_UST_ENABLE
:
626 return ltt_channel_enable(channel
);
627 case LTTNG_UST_DISABLE
:
628 return ltt_channel_disable(channel
);
635 * lttng_metadata_cmd - lttng control through object descriptors
637 * @objd: the object descriptor
641 * This object descriptor implements lttng commands:
643 * Returns an event stream file descriptor or failure.
645 * Channel and event file descriptors also hold a reference on the session.
648 long lttng_metadata_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
651 case LTTNG_UST_STREAM
:
653 struct lttng_ust_stream
*stream
;
655 stream
= (struct lttng_ust_stream
*) arg
;
656 /* stream used as output */
657 return lttng_abi_open_stream(objd
, stream
);
666 * lttng_channel_poll - lttng stream addition/removal monitoring
671 unsigned int lttng_channel_poll(struct file
*file
, poll_table
*wait
)
673 struct ltt_channel
*channel
= file
->private_data
;
674 unsigned int mask
= 0;
676 if (file
->f_mode
& FMODE_READ
) {
677 poll_wait_set_exclusive(wait
);
678 poll_wait(file
, channel
->ops
->get_hp_wait_queue(channel
->chan
),
681 if (channel
->ops
->is_disabled(channel
->chan
))
683 if (channel
->ops
->is_finalized(channel
->chan
))
685 if (channel
->ops
->buffer_has_read_closed_stream(channel
->chan
))
686 return POLLIN
| POLLRDNORM
;
695 int lttng_channel_release(int objd
)
697 struct ltt_channel
*channel
= objd_private(objd
);
700 return objd_unref(channel
->session
->objd
);
704 static const struct objd_ops lttng_channel_ops
= {
705 .release
= lttng_channel_release
,
706 //.poll = lttng_channel_poll,
707 .cmd
= lttng_channel_cmd
,
710 static const struct objd_ops lttng_metadata_ops
= {
711 .release
= lttng_channel_release
,
712 .cmd
= lttng_metadata_cmd
,
716 * lttng_rb_cmd - lttng ring buffer control through object descriptors
718 * @objd: the object descriptor
722 * This object descriptor implements lttng commands:
723 * (None for now. Access is done directly though shm.)
724 * TODO: Add buffer flush.
727 long lttng_rb_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
729 //struct stream_priv_data *priv = objd_private(objd);
738 int lttng_rb_release(int objd
)
740 struct stream_priv_data
*priv
= objd_private(objd
);
741 struct lib_ring_buffer
*buf
;
742 struct ltt_channel
*channel
;
746 channel
= priv
->ltt_chan
;
748 channel
->ops
->buffer_read_close(buf
, channel
->handle
);
750 return objd_unref(channel
->objd
);
755 static const struct objd_ops lib_ring_buffer_objd_ops
= {
756 .release
= lttng_rb_release
,
761 * lttng_event_cmd - lttng control through object descriptors
763 * @objd: the object descriptor
767 * This object descriptor implements lttng commands:
769 * Prepend a context field to each record of this event
771 * Enable recording for this event (weak enable)
773 * Disable recording for this event (strong disable)
776 long lttng_event_cmd(int objd
, unsigned int cmd
, unsigned long arg
)
778 struct ltt_event
*event
= objd_private(objd
);
781 case LTTNG_UST_CONTEXT
:
782 return lttng_abi_add_context(objd
,
783 (struct lttng_ust_context
*) arg
,
784 &event
->ctx
, event
->chan
->session
);
785 case LTTNG_UST_ENABLE
:
786 return ltt_event_enable(event
);
787 case LTTNG_UST_DISABLE
:
788 return ltt_event_disable(event
);
795 int lttng_event_release(int objd
)
797 struct ltt_event
*event
= objd_private(objd
);
800 return objd_unref(event
->chan
->objd
);
804 /* TODO: filter control ioctl */
805 static const struct objd_ops lttng_event_ops
= {
806 .release
= lttng_event_release
,
807 .cmd
= lttng_event_cmd
,
810 void lttng_ust_abi_exit(void)
812 objd_table_destroy();