2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2010-2012 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.
30 #include <urcu/compiler.h>
31 #include <urcu/list.h>
33 #include <lttng/tracepoint.h>
34 #include <lttng/ust-abi.h>
35 #include <lttng/ust-error.h>
36 #include <lttng/ust-events.h>
37 #include <lttng/ust-version.h>
39 #include <usterr-signal-safe.h>
41 #include "../libringbuffer/frontend_types.h"
42 #include "../libringbuffer/shm.h"
43 #include "../libcounter/counter.h"
44 #include "tracepoint-internal.h"
45 #include "lttng-tracer.h"
46 #include "string-utils.h"
47 #include "ust-events-internal.h"
48 #include "context-internal.h"
49 #include "ust-helper.h"
51 #define OBJ_NAME_LEN 16
53 static int lttng_ust_abi_close_in_progress
;
56 int lttng_abi_tracepoint_list(void *owner
);
58 int lttng_abi_tracepoint_field_list(void *owner
);
61 * Object descriptor table. Should be protected from concurrent access
65 struct lttng_ust_abi_obj
{
69 const struct lttng_ust_abi_objd_ops
*ops
;
71 int owner_ref
; /* has ref from owner */
73 char name
[OBJ_NAME_LEN
];
75 int freelist_next
; /* offset freelist. end is -1. */
79 struct lttng_ust_abi_objd_table
{
80 struct lttng_ust_abi_obj
*array
;
81 unsigned int len
, allocated_len
;
82 int freelist_head
; /* offset freelist head. end is -1 */
85 static struct lttng_ust_abi_objd_table objd_table
= {
90 int objd_alloc(void *private_data
, const struct lttng_ust_abi_objd_ops
*ops
,
91 void *owner
, const char *name
)
93 struct lttng_ust_abi_obj
*obj
;
95 if (objd_table
.freelist_head
!= -1) {
96 obj
= &objd_table
.array
[objd_table
.freelist_head
];
97 objd_table
.freelist_head
= obj
->u
.freelist_next
;
101 if (objd_table
.len
>= objd_table
.allocated_len
) {
102 unsigned int new_allocated_len
, old_allocated_len
;
103 struct lttng_ust_abi_obj
*new_table
, *old_table
;
105 old_allocated_len
= objd_table
.allocated_len
;
106 old_table
= objd_table
.array
;
107 if (!old_allocated_len
)
108 new_allocated_len
= 1;
110 new_allocated_len
= old_allocated_len
<< 1;
111 new_table
= zmalloc(sizeof(struct lttng_ust_abi_obj
) * new_allocated_len
);
114 memcpy(new_table
, old_table
,
115 sizeof(struct lttng_ust_abi_obj
) * old_allocated_len
);
117 objd_table
.array
= new_table
;
118 objd_table
.allocated_len
= new_allocated_len
;
120 obj
= &objd_table
.array
[objd_table
.len
];
123 obj
->u
.s
.private_data
= private_data
;
125 obj
->u
.s
.f_count
= 2; /* count == 1 : object is allocated */
126 /* count == 2 : allocated + hold ref */
127 obj
->u
.s
.owner_ref
= 1; /* One owner reference */
128 obj
->u
.s
.owner
= owner
;
129 strncpy(obj
->u
.s
.name
, name
, OBJ_NAME_LEN
);
130 obj
->u
.s
.name
[OBJ_NAME_LEN
- 1] = '\0';
131 return obj
- objd_table
.array
;
135 struct lttng_ust_abi_obj
*_objd_get(int id
)
137 if (id
>= objd_table
.len
)
139 if (!objd_table
.array
[id
].u
.s
.f_count
)
141 return &objd_table
.array
[id
];
145 void *objd_private(int id
)
147 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
149 return obj
->u
.s
.private_data
;
153 void objd_set_private(int id
, void *private_data
)
155 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
157 obj
->u
.s
.private_data
= private_data
;
160 const struct lttng_ust_abi_objd_ops
*lttng_ust_abi_objd_ops(int id
)
162 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
170 void objd_free(int id
)
172 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
175 obj
->u
.freelist_next
= objd_table
.freelist_head
;
176 objd_table
.freelist_head
= obj
- objd_table
.array
;
177 assert(obj
->u
.s
.f_count
== 1);
178 obj
->u
.s
.f_count
= 0; /* deallocated */
182 void objd_ref(int id
)
184 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
189 int lttng_ust_abi_objd_unref(int id
, int is_owner
)
191 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
195 if (obj
->u
.s
.f_count
== 1) {
196 ERR("Reference counting error\n");
200 if (!obj
->u
.s
.owner_ref
) {
201 ERR("Error decrementing owner reference");
204 obj
->u
.s
.owner_ref
--;
206 if ((--obj
->u
.s
.f_count
) == 1) {
207 const struct lttng_ust_abi_objd_ops
*ops
= lttng_ust_abi_objd_ops(id
);
217 void objd_table_destroy(void)
221 for (i
= 0; i
< objd_table
.allocated_len
; i
++) {
222 struct lttng_ust_abi_obj
*obj
;
227 if (!obj
->u
.s
.owner_ref
)
228 continue; /* only unref owner ref. */
229 (void) lttng_ust_abi_objd_unref(i
, 1);
231 free(objd_table
.array
);
232 objd_table
.array
= NULL
;
234 objd_table
.allocated_len
= 0;
235 objd_table
.freelist_head
= -1;
238 const char *lttng_ust_obj_get_name(int id
)
240 struct lttng_ust_abi_obj
*obj
= _objd_get(id
);
244 return obj
->u
.s
.name
;
247 void lttng_ust_abi_objd_table_owner_cleanup(void *owner
)
251 for (i
= 0; i
< objd_table
.allocated_len
; i
++) {
252 struct lttng_ust_abi_obj
*obj
;
258 continue; /* skip root handles */
259 if (!obj
->u
.s
.owner_ref
)
260 continue; /* only unref owner ref. */
261 if (obj
->u
.s
.owner
== owner
)
262 (void) lttng_ust_abi_objd_unref(i
, 1);
267 * This is LTTng's own personal way to create an ABI for sessiond.
268 * We send commands over a socket.
271 static const struct lttng_ust_abi_objd_ops lttng_ops
;
272 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_group_ops
;
273 static const struct lttng_ust_abi_objd_ops lttng_session_ops
;
274 static const struct lttng_ust_abi_objd_ops lttng_channel_ops
;
275 static const struct lttng_ust_abi_objd_ops lttng_event_enabler_ops
;
276 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_enabler_ops
;
277 static const struct lttng_ust_abi_objd_ops lttng_tracepoint_list_ops
;
278 static const struct lttng_ust_abi_objd_ops lttng_tracepoint_field_list_ops
;
280 int lttng_abi_create_root_handle(void)
284 /* root handles have NULL owners */
285 root_handle
= objd_alloc(NULL
, <tng_ops
, NULL
, "root");
290 int lttng_is_channel_ready(struct lttng_ust_channel_buffer
*lttng_chan
)
292 struct lttng_ust_lib_ring_buffer_channel
*chan
;
293 unsigned int nr_streams
, exp_streams
;
295 chan
= lttng_chan
->priv
->rb_chan
;
296 nr_streams
= channel_handle_get_nr_streams(lttng_chan
->priv
->rb_chan
->handle
);
297 exp_streams
= chan
->nr_streams
;
298 return nr_streams
== exp_streams
;
302 int lttng_abi_create_session(void *owner
)
304 struct lttng_ust_session
*session
;
305 int session_objd
, ret
;
307 session
= lttng_session_create();
310 session_objd
= objd_alloc(session
, <tng_session_ops
, owner
, "session");
311 if (session_objd
< 0) {
315 session
->priv
->objd
= session_objd
;
316 session
->priv
->owner
= owner
;
320 lttng_session_destroy(session
);
325 long lttng_abi_tracer_version(int objd
,
326 struct lttng_ust_abi_tracer_version
*v
)
328 v
->major
= LTTNG_UST_MAJOR_VERSION
;
329 v
->minor
= LTTNG_UST_MINOR_VERSION
;
330 v
->patchlevel
= LTTNG_UST_PATCHLEVEL_VERSION
;
335 int lttng_abi_event_notifier_send_fd(void *owner
, int *event_notifier_notif_fd
)
337 struct lttng_event_notifier_group
*event_notifier_group
;
338 int event_notifier_group_objd
, ret
, fd_flag
;
340 event_notifier_group
= lttng_event_notifier_group_create();
341 if (!event_notifier_group
)
345 * Set this file descriptor as NON-BLOCKING.
347 fd_flag
= fcntl(*event_notifier_notif_fd
, F_GETFL
);
349 fd_flag
|= O_NONBLOCK
;
351 ret
= fcntl(*event_notifier_notif_fd
, F_SETFL
, fd_flag
);
357 event_notifier_group_objd
= objd_alloc(event_notifier_group
,
358 <tng_event_notifier_group_ops
, owner
, "event_notifier_group");
359 if (event_notifier_group_objd
< 0) {
360 ret
= event_notifier_group_objd
;
364 event_notifier_group
->objd
= event_notifier_group_objd
;
365 event_notifier_group
->owner
= owner
;
366 event_notifier_group
->notification_fd
= *event_notifier_notif_fd
;
367 /* Object descriptor takes ownership of notification fd. */
368 *event_notifier_notif_fd
= -1;
370 return event_notifier_group_objd
;
373 lttng_event_notifier_group_destroy(event_notifier_group
);
379 long lttng_abi_add_context(int objd
,
380 struct lttng_ust_abi_context
*context_param
,
381 union lttng_ust_abi_args
*uargs
,
382 struct lttng_ust_ctx
**ctx
, struct lttng_ust_session
*session
)
384 return lttng_attach_context(context_param
, uargs
, ctx
, session
);
388 * lttng_cmd - lttng control through socket commands
390 * @objd: the object descriptor
393 * @uargs: UST arguments (internal)
396 * This descriptor implements lttng commands:
397 * LTTNG_UST_ABI_SESSION
398 * Returns a LTTng trace session object descriptor
399 * LTTNG_UST_ABI_TRACER_VERSION
400 * Returns the LTTng kernel tracer version
401 * LTTNG_UST_ABI_TRACEPOINT_LIST
402 * Returns a file descriptor listing available tracepoints
403 * LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST
404 * Returns a file descriptor listing available tracepoint fields
405 * LTTNG_UST_ABI_WAIT_QUIESCENT
406 * Returns after all previously running probes have completed
408 * The returned session will be deleted when its file descriptor is closed.
411 long lttng_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
412 union lttng_ust_abi_args
*uargs
, void *owner
)
415 case LTTNG_UST_ABI_SESSION
:
416 return lttng_abi_create_session(owner
);
417 case LTTNG_UST_ABI_TRACER_VERSION
:
418 return lttng_abi_tracer_version(objd
,
419 (struct lttng_ust_abi_tracer_version
*) arg
);
420 case LTTNG_UST_ABI_TRACEPOINT_LIST
:
421 return lttng_abi_tracepoint_list(owner
);
422 case LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST
:
423 return lttng_abi_tracepoint_field_list(owner
);
424 case LTTNG_UST_ABI_WAIT_QUIESCENT
:
425 lttng_ust_urcu_synchronize_rcu();
427 case LTTNG_UST_ABI_EVENT_NOTIFIER_GROUP_CREATE
:
428 return lttng_abi_event_notifier_send_fd(owner
,
429 &uargs
->event_notifier_handle
.event_notifier_notif_fd
);
435 static const struct lttng_ust_abi_objd_ops lttng_ops
= {
440 int lttng_abi_map_channel(int session_objd
,
441 struct lttng_ust_abi_channel
*ust_chan
,
442 union lttng_ust_abi_args
*uargs
,
445 struct lttng_ust_session
*session
= objd_private(session_objd
);
446 const char *transport_name
;
447 struct lttng_transport
*transport
;
448 const char *chan_name
;
450 struct lttng_ust_shm_handle
*channel_handle
;
451 struct lttng_ust_abi_channel_config
*lttng_chan_config
;
452 struct lttng_ust_channel_buffer
*lttng_chan_buf
;
453 struct lttng_ust_lib_ring_buffer_channel
*chan
;
454 struct lttng_ust_lib_ring_buffer_config
*config
;
459 enum lttng_ust_abi_chan_type type
;
461 chan_data
= uargs
->channel
.chan_data
;
462 wakeup_fd
= uargs
->channel
.wakeup_fd
;
464 type
= ust_chan
->type
;
467 case LTTNG_UST_ABI_CHAN_PER_CPU
:
474 if (session
->priv
->been_active
) {
476 goto active
; /* Refuse to add channel to active session */
479 lttng_chan_buf
= lttng_ust_alloc_channel_buffer();
480 if (!lttng_chan_buf
) {
482 goto lttng_chan_buf_error
;
485 channel_handle
= channel_handle_create(chan_data
, len
, wakeup_fd
);
486 if (!channel_handle
) {
491 /* Ownership of chan_data and wakeup_fd taken by channel handle. */
492 uargs
->channel
.chan_data
= NULL
;
493 uargs
->channel
.wakeup_fd
= -1;
495 chan
= shmp(channel_handle
, channel_handle
->chan
);
497 chan
->handle
= channel_handle
;
498 config
= &chan
->backend
.config
;
499 lttng_chan_config
= channel_get_private_config(chan
);
500 if (!lttng_chan_config
) {
505 if (lttng_ust_session_uuid_validate(session
, lttng_chan_config
->uuid
)) {
510 /* Lookup transport name */
512 case LTTNG_UST_ABI_CHAN_PER_CPU
:
513 if (config
->output
== RING_BUFFER_MMAP
) {
514 if (config
->mode
== RING_BUFFER_OVERWRITE
) {
515 if (config
->wakeup
== RING_BUFFER_WAKEUP_BY_WRITER
) {
516 transport_name
= "relay-overwrite-mmap";
518 transport_name
= "relay-overwrite-rt-mmap";
521 if (config
->wakeup
== RING_BUFFER_WAKEUP_BY_WRITER
) {
522 transport_name
= "relay-discard-mmap";
524 transport_name
= "relay-discard-rt-mmap";
531 chan_name
= "channel";
537 transport
= lttng_ust_transport_find(transport_name
);
539 DBG("LTTng transport %s not found\n",
545 chan_objd
= objd_alloc(NULL
, <tng_channel_ops
, owner
, chan_name
);
551 /* Initialize our lttng chan */
552 lttng_chan_buf
->parent
->enabled
= 1;
553 lttng_chan_buf
->parent
->session
= session
;
555 lttng_chan_buf
->priv
->parent
.tstate
= 1;
556 lttng_chan_buf
->priv
->ctx
= NULL
;
557 lttng_chan_buf
->priv
->rb_chan
= chan
;
559 lttng_chan_buf
->ops
= &transport
->ops
;
561 memcpy(&chan
->backend
.config
,
562 transport
->client_config
,
563 sizeof(chan
->backend
.config
));
564 cds_list_add(<tng_chan_buf
->priv
->node
, &session
->priv
->chan_head
);
565 lttng_chan_buf
->priv
->header_type
= 0;
566 lttng_chan_buf
->priv
->type
= type
;
567 /* Copy fields from lttng ust chan config. */
568 lttng_chan_buf
->priv
->id
= lttng_chan_config
->id
;
569 memcpy(lttng_chan_buf
->priv
->uuid
, lttng_chan_config
->uuid
, LTTNG_UST_UUID_LEN
);
570 channel_set_private(chan
, lttng_chan_buf
);
573 * We tolerate no failure path after channel creation. It will stay
574 * invariant for the rest of the session.
576 objd_set_private(chan_objd
, lttng_chan_buf
);
577 lttng_chan_buf
->priv
->parent
.objd
= chan_objd
;
578 /* The channel created holds a reference on the session */
579 objd_ref(session_objd
);
582 /* error path after channel was created */
587 channel_destroy(chan
, channel_handle
, 0);
588 lttng_ust_free_channel_common(lttng_chan_buf
->parent
);
592 lttng_ust_free_channel_common(lttng_chan_buf
->parent
);
593 lttng_chan_buf_error
:
600 * lttng_session_cmd - lttng session object command
605 * @uargs: UST arguments (internal)
608 * This descriptor implements lttng commands:
609 * LTTNG_UST_ABI_CHANNEL
610 * Returns a LTTng channel object descriptor
611 * LTTNG_UST_ABI_ENABLE
612 * Enables tracing for a session (weak enable)
613 * LTTNG_UST_ABI_DISABLE
614 * Disables tracing for a session (strong disable)
616 * The returned channel will be deleted when its file descriptor is closed.
619 long lttng_session_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
620 union lttng_ust_abi_args
*uargs
, void *owner
)
622 struct lttng_ust_session
*session
= objd_private(objd
);
625 case LTTNG_UST_ABI_CHANNEL
:
626 return lttng_abi_map_channel(objd
,
627 (struct lttng_ust_abi_channel
*) arg
,
629 case LTTNG_UST_ABI_SESSION_START
:
630 case LTTNG_UST_ABI_ENABLE
:
631 return lttng_session_enable(session
);
632 case LTTNG_UST_ABI_SESSION_STOP
:
633 case LTTNG_UST_ABI_DISABLE
:
634 return lttng_session_disable(session
);
635 case LTTNG_UST_ABI_SESSION_STATEDUMP
:
636 return lttng_session_statedump(session
);
637 case LTTNG_UST_ABI_COUNTER
:
638 case LTTNG_UST_ABI_COUNTER_GLOBAL
:
639 case LTTNG_UST_ABI_COUNTER_CPU
:
640 /* Not implemented yet. */
648 * Called when the last file reference is dropped.
650 * Big fat note: channels and events are invariant for the whole session after
651 * their creation. So this session destruction also destroys all channel and
652 * event structures specific to this session (they are not destroyed when their
653 * individual file is released).
656 int lttng_release_session(int objd
)
658 struct lttng_ust_session
*session
= objd_private(objd
);
661 lttng_session_destroy(session
);
668 static const struct lttng_ust_abi_objd_ops lttng_session_ops
= {
669 .release
= lttng_release_session
,
670 .cmd
= lttng_session_cmd
,
673 static int lttng_ust_event_notifier_enabler_create(int event_notifier_group_obj
,
674 void *owner
, struct lttng_ust_abi_event_notifier
*event_notifier_param
,
675 enum lttng_enabler_format_type type
)
677 struct lttng_event_notifier_group
*event_notifier_group
=
678 objd_private(event_notifier_group_obj
);
679 struct lttng_event_notifier_enabler
*event_notifier_enabler
;
680 int event_notifier_objd
, ret
;
682 event_notifier_param
->event
.name
[LTTNG_UST_ABI_SYM_NAME_LEN
- 1] = '\0';
683 event_notifier_objd
= objd_alloc(NULL
, <tng_event_notifier_enabler_ops
, owner
,
684 "event_notifier enabler");
685 if (event_notifier_objd
< 0) {
686 ret
= event_notifier_objd
;
690 event_notifier_enabler
= lttng_event_notifier_enabler_create(
691 event_notifier_group
, type
, event_notifier_param
);
692 if (!event_notifier_enabler
) {
694 goto event_notifier_error
;
697 objd_set_private(event_notifier_objd
, event_notifier_enabler
);
698 /* The event_notifier holds a reference on the event_notifier group. */
699 objd_ref(event_notifier_enabler
->group
->objd
);
701 return event_notifier_objd
;
703 event_notifier_error
:
707 err
= lttng_ust_abi_objd_unref(event_notifier_objd
, 1);
715 long lttng_event_notifier_enabler_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
716 union lttng_ust_abi_args
*uargs
, void *owner
)
718 struct lttng_event_notifier_enabler
*event_notifier_enabler
= objd_private(objd
);
720 case LTTNG_UST_ABI_FILTER
:
721 return lttng_event_notifier_enabler_attach_filter_bytecode(
722 event_notifier_enabler
,
723 (struct lttng_ust_bytecode_node
**) arg
);
724 case LTTNG_UST_ABI_EXCLUSION
:
725 return lttng_event_notifier_enabler_attach_exclusion(event_notifier_enabler
,
726 (struct lttng_ust_excluder_node
**) arg
);
727 case LTTNG_UST_ABI_CAPTURE
:
728 return lttng_event_notifier_enabler_attach_capture_bytecode(
729 event_notifier_enabler
,
730 (struct lttng_ust_bytecode_node
**) arg
);
731 case LTTNG_UST_ABI_ENABLE
:
732 return lttng_event_notifier_enabler_enable(event_notifier_enabler
);
733 case LTTNG_UST_ABI_DISABLE
:
734 return lttng_event_notifier_enabler_disable(event_notifier_enabler
);
741 * lttng_event_notifier_group_error_counter_cmd - lttng event_notifier group error counter object command
746 * @uargs: UST arguments (internal)
749 * This descriptor implements lttng commands:
750 * LTTNG_UST_ABI_COUNTER_GLOBAL
751 * Return negative error code on error, 0 on success.
752 * LTTNG_UST_ABI_COUNTER_CPU
753 * Return negative error code on error, 0 on success.
756 long lttng_event_notifier_group_error_counter_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
757 union lttng_ust_abi_args
*uargs
, void *owner
)
760 struct lttng_counter
*counter
= objd_private(objd
);
763 case LTTNG_UST_ABI_COUNTER_GLOBAL
:
764 ret
= -EINVAL
; /* Unimplemented. */
766 case LTTNG_UST_ABI_COUNTER_CPU
:
768 struct lttng_ust_abi_counter_cpu
*counter_cpu
=
769 (struct lttng_ust_abi_counter_cpu
*)arg
;
771 ret
= lttng_counter_set_cpu_shm(counter
->counter
,
772 counter_cpu
->cpu_nr
, uargs
->counter_shm
.shm_fd
);
774 /* Take ownership of the shm_fd. */
775 uargs
->counter_shm
.shm_fd
= -1;
787 __attribute__((visibility("hidden")))
788 int lttng_release_event_notifier_group_error_counter(int objd
)
790 struct lttng_counter
*counter
= objd_private(objd
);
793 return lttng_ust_abi_objd_unref(counter
->event_notifier_group
->objd
, 0);
799 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_group_error_counter_ops
= {
800 .release
= lttng_release_event_notifier_group_error_counter
,
801 .cmd
= lttng_event_notifier_group_error_counter_cmd
,
805 int lttng_ust_event_notifier_group_create_error_counter(int event_notifier_group_objd
, void *owner
,
806 struct lttng_ust_abi_counter_conf
*error_counter_conf
)
808 const char *counter_transport_name
;
809 struct lttng_event_notifier_group
*event_notifier_group
=
810 objd_private(event_notifier_group_objd
);
811 struct lttng_counter
*counter
;
812 int counter_objd
, ret
;
813 struct lttng_counter_dimension dimensions
[1];
816 if (event_notifier_group
->error_counter
)
819 if (error_counter_conf
->arithmetic
!= LTTNG_UST_ABI_COUNTER_ARITHMETIC_MODULAR
)
822 if (error_counter_conf
->number_dimensions
!= 1)
825 switch (error_counter_conf
->bitness
) {
826 case LTTNG_UST_ABI_COUNTER_BITNESS_64
:
827 counter_transport_name
= "counter-per-cpu-64-modular";
829 case LTTNG_UST_ABI_COUNTER_BITNESS_32
:
830 counter_transport_name
= "counter-per-cpu-32-modular";
836 counter_objd
= objd_alloc(NULL
, <tng_event_notifier_group_error_counter_ops
, owner
,
837 "event_notifier group error counter");
838 if (counter_objd
< 0) {
843 counter_len
= error_counter_conf
->dimensions
[0].size
;
844 dimensions
[0].size
= counter_len
;
845 dimensions
[0].underflow_index
= 0;
846 dimensions
[0].overflow_index
= 0;
847 dimensions
[0].has_underflow
= 0;
848 dimensions
[0].has_overflow
= 0;
850 counter
= lttng_ust_counter_create(counter_transport_name
, 1, dimensions
);
856 event_notifier_group
->error_counter_len
= counter_len
;
858 * store-release to publish error counter matches load-acquire
859 * in record_error. Ensures the counter is created and the
860 * error_counter_len is set before they are used.
861 * Currently a full memory barrier is used, which could be
862 * turned into acquire-release barriers.
865 CMM_STORE_SHARED(event_notifier_group
->error_counter
, counter
);
867 counter
->objd
= counter_objd
;
868 counter
->event_notifier_group
= event_notifier_group
; /* owner */
870 objd_set_private(counter_objd
, counter
);
871 /* The error counter holds a reference on the event_notifier group. */
872 objd_ref(event_notifier_group
->objd
);
880 err
= lttng_ust_abi_objd_unref(counter_objd
, 1);
888 long lttng_event_notifier_group_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
889 union lttng_ust_abi_args
*uargs
, void *owner
)
892 case LTTNG_UST_ABI_EVENT_NOTIFIER_CREATE
:
894 struct lttng_ust_abi_event_notifier
*event_notifier_param
=
895 (struct lttng_ust_abi_event_notifier
*) arg
;
896 if (strutils_is_star_glob_pattern(event_notifier_param
->event
.name
)) {
898 * If the event name is a star globbing pattern,
899 * we create the special star globbing enabler.
901 return lttng_ust_event_notifier_enabler_create(objd
,
902 owner
, event_notifier_param
,
903 LTTNG_ENABLER_FORMAT_STAR_GLOB
);
905 return lttng_ust_event_notifier_enabler_create(objd
,
906 owner
, event_notifier_param
,
907 LTTNG_ENABLER_FORMAT_EVENT
);
910 case LTTNG_UST_ABI_COUNTER
:
912 struct lttng_ust_abi_counter_conf
*counter_conf
=
913 (struct lttng_ust_abi_counter_conf
*) uargs
->counter
.counter_data
;
914 return lttng_ust_event_notifier_group_create_error_counter(
915 objd
, owner
, counter_conf
);
923 int lttng_event_notifier_enabler_release(int objd
)
925 struct lttng_event_notifier_enabler
*event_notifier_enabler
= objd_private(objd
);
927 if (event_notifier_enabler
)
928 return lttng_ust_abi_objd_unref(event_notifier_enabler
->group
->objd
, 0);
932 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_enabler_ops
= {
933 .release
= lttng_event_notifier_enabler_release
,
934 .cmd
= lttng_event_notifier_enabler_cmd
,
938 int lttng_release_event_notifier_group(int objd
)
940 struct lttng_event_notifier_group
*event_notifier_group
= objd_private(objd
);
942 if (event_notifier_group
) {
943 lttng_event_notifier_group_destroy(event_notifier_group
);
950 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_group_ops
= {
951 .release
= lttng_release_event_notifier_group
,
952 .cmd
= lttng_event_notifier_group_cmd
,
956 long lttng_tracepoint_list_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
957 union lttng_ust_abi_args
*uargs
, void *owner
)
959 struct lttng_ust_tracepoint_list
*list
= objd_private(objd
);
960 struct lttng_ust_abi_tracepoint_iter
*tp
=
961 (struct lttng_ust_abi_tracepoint_iter
*) arg
;
962 struct lttng_ust_abi_tracepoint_iter
*iter
;
965 case LTTNG_UST_ABI_TRACEPOINT_LIST_GET
:
967 iter
= lttng_ust_tracepoint_list_get_iter_next(list
);
969 return -LTTNG_UST_ERR_NOENT
;
970 memcpy(tp
, iter
, sizeof(*tp
));
979 int lttng_abi_tracepoint_list(void *owner
)
982 struct lttng_ust_tracepoint_list
*list
;
984 list_objd
= objd_alloc(NULL
, <tng_tracepoint_list_ops
, owner
, "tp_list");
989 list
= zmalloc(sizeof(*list
));
994 objd_set_private(list_objd
, list
);
996 /* populate list by walking on all registered probes. */
997 ret
= lttng_probes_get_event_list(list
);
1009 err
= lttng_ust_abi_objd_unref(list_objd
, 1);
1017 int lttng_release_tracepoint_list(int objd
)
1019 struct lttng_ust_tracepoint_list
*list
= objd_private(objd
);
1022 lttng_probes_prune_event_list(list
);
1030 static const struct lttng_ust_abi_objd_ops lttng_tracepoint_list_ops
= {
1031 .release
= lttng_release_tracepoint_list
,
1032 .cmd
= lttng_tracepoint_list_cmd
,
1036 long lttng_tracepoint_field_list_cmd(int objd
, unsigned int cmd
,
1037 unsigned long arg
, union lttng_ust_abi_args
*uargs
, void *owner
)
1039 struct lttng_ust_field_list
*list
= objd_private(objd
);
1040 struct lttng_ust_abi_field_iter
*tp
= &uargs
->field_list
.entry
;
1041 struct lttng_ust_abi_field_iter
*iter
;
1044 case LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST_GET
:
1046 iter
= lttng_ust_field_list_get_iter_next(list
);
1048 return -LTTNG_UST_ERR_NOENT
;
1049 memcpy(tp
, iter
, sizeof(*tp
));
1058 int lttng_abi_tracepoint_field_list(void *owner
)
1061 struct lttng_ust_field_list
*list
;
1063 list_objd
= objd_alloc(NULL
, <tng_tracepoint_field_list_ops
, owner
,
1065 if (list_objd
< 0) {
1069 list
= zmalloc(sizeof(*list
));
1074 objd_set_private(list_objd
, list
);
1076 /* populate list by walking on all registered probes. */
1077 ret
= lttng_probes_get_field_list(list
);
1089 err
= lttng_ust_abi_objd_unref(list_objd
, 1);
1097 int lttng_release_tracepoint_field_list(int objd
)
1099 struct lttng_ust_field_list
*list
= objd_private(objd
);
1102 lttng_probes_prune_field_list(list
);
1110 static const struct lttng_ust_abi_objd_ops lttng_tracepoint_field_list_ops
= {
1111 .release
= lttng_release_tracepoint_field_list
,
1112 .cmd
= lttng_tracepoint_field_list_cmd
,
1116 int lttng_abi_map_stream(int channel_objd
, struct lttng_ust_abi_stream
*info
,
1117 union lttng_ust_abi_args
*uargs
, void *owner
)
1119 struct lttng_ust_channel_buffer
*lttng_chan_buf
= objd_private(channel_objd
);
1122 ret
= channel_handle_add_stream(lttng_chan_buf
->priv
->rb_chan
->handle
,
1123 uargs
->stream
.shm_fd
, uargs
->stream
.wakeup_fd
,
1124 info
->stream_nr
, info
->len
);
1126 goto error_add_stream
;
1127 /* Take ownership of shm_fd and wakeup_fd. */
1128 uargs
->stream
.shm_fd
= -1;
1129 uargs
->stream
.wakeup_fd
= -1;
1138 int lttng_abi_create_event_enabler(int channel_objd
,
1139 struct lttng_ust_abi_event
*event_param
,
1141 enum lttng_enabler_format_type format_type
)
1143 struct lttng_ust_channel_buffer
*channel
= objd_private(channel_objd
);
1144 struct lttng_event_enabler
*enabler
;
1145 int event_objd
, ret
;
1147 event_param
->name
[LTTNG_UST_ABI_SYM_NAME_LEN
- 1] = '\0';
1148 event_objd
= objd_alloc(NULL
, <tng_event_enabler_ops
, owner
,
1150 if (event_objd
< 0) {
1155 * We tolerate no failure path after event creation. It will stay
1156 * invariant for the rest of the session.
1158 enabler
= lttng_event_enabler_create(format_type
, event_param
, channel
);
1163 objd_set_private(event_objd
, enabler
);
1164 /* The event holds a reference on the channel */
1165 objd_ref(channel_objd
);
1172 err
= lttng_ust_abi_objd_unref(event_objd
, 1);
1180 * lttng_channel_cmd - lttng control through object descriptors
1182 * @objd: the object descriptor
1185 * @uargs: UST arguments (internal)
1186 * @owner: objd owner
1188 * This object descriptor implements lttng commands:
1189 * LTTNG_UST_ABI_STREAM
1190 * Returns an event stream object descriptor or failure.
1191 * (typically, one event stream records events from one CPU)
1192 * LTTNG_UST_ABI_EVENT
1193 * Returns an event object descriptor or failure.
1194 * LTTNG_UST_ABI_CONTEXT
1195 * Prepend a context field to each event in the channel
1196 * LTTNG_UST_ABI_ENABLE
1197 * Enable recording for events in this channel (weak enable)
1198 * LTTNG_UST_ABI_DISABLE
1199 * Disable recording for events in this channel (strong disable)
1201 * Channel and event file descriptors also hold a reference on the session.
1204 long lttng_channel_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
1205 union lttng_ust_abi_args
*uargs
, void *owner
)
1207 struct lttng_ust_channel_buffer
*lttng_chan_buf
= objd_private(objd
);
1209 if (cmd
!= LTTNG_UST_ABI_STREAM
) {
1211 * Check if channel received all streams.
1213 if (!lttng_is_channel_ready(lttng_chan_buf
))
1218 case LTTNG_UST_ABI_STREAM
:
1220 struct lttng_ust_abi_stream
*stream
;
1222 stream
= (struct lttng_ust_abi_stream
*) arg
;
1223 /* stream used as output */
1224 return lttng_abi_map_stream(objd
, stream
, uargs
, owner
);
1226 case LTTNG_UST_ABI_EVENT
:
1228 struct lttng_ust_abi_event
*event_param
=
1229 (struct lttng_ust_abi_event
*) arg
;
1231 if (strutils_is_star_glob_pattern(event_param
->name
)) {
1233 * If the event name is a star globbing pattern,
1234 * we create the special star globbing enabler.
1236 return lttng_abi_create_event_enabler(objd
, event_param
,
1237 owner
, LTTNG_ENABLER_FORMAT_STAR_GLOB
);
1239 return lttng_abi_create_event_enabler(objd
, event_param
,
1240 owner
, LTTNG_ENABLER_FORMAT_EVENT
);
1243 case LTTNG_UST_ABI_CONTEXT
:
1244 return lttng_abi_add_context(objd
,
1245 (struct lttng_ust_abi_context
*) arg
, uargs
,
1246 <tng_chan_buf
->priv
->ctx
,
1247 lttng_chan_buf
->parent
->session
);
1248 case LTTNG_UST_ABI_ENABLE
:
1249 return lttng_channel_enable(lttng_chan_buf
->parent
);
1250 case LTTNG_UST_ABI_DISABLE
:
1251 return lttng_channel_disable(lttng_chan_buf
->parent
);
1252 case LTTNG_UST_ABI_FLUSH_BUFFER
:
1253 return lttng_chan_buf
->ops
->priv
->flush_buffer(lttng_chan_buf
);
1260 int lttng_channel_release(int objd
)
1262 struct lttng_ust_channel_buffer
*lttng_chan_buf
= objd_private(objd
);
1265 return lttng_ust_abi_objd_unref(lttng_chan_buf
->parent
->session
->priv
->objd
, 0);
1269 static const struct lttng_ust_abi_objd_ops lttng_channel_ops
= {
1270 .release
= lttng_channel_release
,
1271 .cmd
= lttng_channel_cmd
,
1275 * lttng_enabler_cmd - lttng control through object descriptors
1277 * @objd: the object descriptor
1280 * @uargs: UST arguments (internal)
1281 * @owner: objd owner
1283 * This object descriptor implements lttng commands:
1284 * LTTNG_UST_ABI_CONTEXT
1285 * Prepend a context field to each record of events of this
1287 * LTTNG_UST_ABI_ENABLE
1288 * Enable recording for this enabler
1289 * LTTNG_UST_ABI_DISABLE
1290 * Disable recording for this enabler
1291 * LTTNG_UST_ABI_FILTER
1292 * Attach a filter to an enabler.
1293 * LTTNG_UST_ABI_EXCLUSION
1294 * Attach exclusions to an enabler.
1297 long lttng_event_enabler_cmd(int objd
, unsigned int cmd
, unsigned long arg
,
1298 union lttng_ust_abi_args
*uargs
, void *owner
)
1300 struct lttng_event_enabler
*enabler
= objd_private(objd
);
1303 case LTTNG_UST_ABI_CONTEXT
:
1304 return lttng_event_enabler_attach_context(enabler
,
1305 (struct lttng_ust_abi_context
*) arg
);
1306 case LTTNG_UST_ABI_ENABLE
:
1307 return lttng_event_enabler_enable(enabler
);
1308 case LTTNG_UST_ABI_DISABLE
:
1309 return lttng_event_enabler_disable(enabler
);
1310 case LTTNG_UST_ABI_FILTER
:
1314 ret
= lttng_event_enabler_attach_filter_bytecode(enabler
,
1315 (struct lttng_ust_bytecode_node
**) arg
);
1320 case LTTNG_UST_ABI_EXCLUSION
:
1322 return lttng_event_enabler_attach_exclusion(enabler
,
1323 (struct lttng_ust_excluder_node
**) arg
);
1331 int lttng_event_enabler_release(int objd
)
1333 struct lttng_event_enabler
*event_enabler
= objd_private(objd
);
1336 return lttng_ust_abi_objd_unref(event_enabler
->chan
->priv
->parent
.objd
, 0);
1341 static const struct lttng_ust_abi_objd_ops lttng_event_enabler_ops
= {
1342 .release
= lttng_event_enabler_release
,
1343 .cmd
= lttng_event_enabler_cmd
,
1346 void lttng_ust_abi_exit(void)
1348 lttng_ust_abi_close_in_progress
= 1;
1350 objd_table_destroy();
1352 lttng_ust_abi_close_in_progress
= 0;