Cleanup: remove old comments
[lttng-ust.git] / liblttng-ust / lttng-ust-abi.c
1 /*
2 * SPDX-License-Identifier: LGPL-2.1-only
3 *
4 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * LTTng UST ABI
7 *
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.
23 */
24
25 #define _LGPL_SOURCE
26 #include <fcntl.h>
27 #include <stdint.h>
28 #include <unistd.h>
29
30 #include <urcu/compiler.h>
31 #include <urcu/list.h>
32
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>
38 #include <ust-fd.h>
39 #include <usterr-signal-safe.h>
40
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"
50
51 #define OBJ_NAME_LEN 16
52
53 static int lttng_ust_abi_close_in_progress;
54
55 static
56 int lttng_abi_tracepoint_list(void *owner);
57 static
58 int lttng_abi_tracepoint_field_list(void *owner);
59
60 /*
61 * Object descriptor table. Should be protected from concurrent access
62 * by the caller.
63 */
64
65 struct lttng_ust_abi_obj {
66 union {
67 struct {
68 void *private_data;
69 const struct lttng_ust_abi_objd_ops *ops;
70 int f_count;
71 int owner_ref; /* has ref from owner */
72 void *owner;
73 char name[OBJ_NAME_LEN];
74 } s;
75 int freelist_next; /* offset freelist. end is -1. */
76 } u;
77 };
78
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 */
83 };
84
85 static struct lttng_ust_abi_objd_table objd_table = {
86 .freelist_head = -1,
87 };
88
89 static
90 int objd_alloc(void *private_data, const struct lttng_ust_abi_objd_ops *ops,
91 void *owner, const char *name)
92 {
93 struct lttng_ust_abi_obj *obj;
94
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;
98 goto end;
99 }
100
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;
104
105 old_allocated_len = objd_table.allocated_len;
106 old_table = objd_table.array;
107 if (!old_allocated_len)
108 new_allocated_len = 1;
109 else
110 new_allocated_len = old_allocated_len << 1;
111 new_table = zmalloc(sizeof(struct lttng_ust_abi_obj) * new_allocated_len);
112 if (!new_table)
113 return -ENOMEM;
114 memcpy(new_table, old_table,
115 sizeof(struct lttng_ust_abi_obj) * old_allocated_len);
116 free(old_table);
117 objd_table.array = new_table;
118 objd_table.allocated_len = new_allocated_len;
119 }
120 obj = &objd_table.array[objd_table.len];
121 objd_table.len++;
122 end:
123 obj->u.s.private_data = private_data;
124 obj->u.s.ops = ops;
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;
132 }
133
134 static
135 struct lttng_ust_abi_obj *_objd_get(int id)
136 {
137 if (id >= objd_table.len)
138 return NULL;
139 if (!objd_table.array[id].u.s.f_count)
140 return NULL;
141 return &objd_table.array[id];
142 }
143
144 static
145 void *objd_private(int id)
146 {
147 struct lttng_ust_abi_obj *obj = _objd_get(id);
148 assert(obj);
149 return obj->u.s.private_data;
150 }
151
152 static
153 void objd_set_private(int id, void *private_data)
154 {
155 struct lttng_ust_abi_obj *obj = _objd_get(id);
156 assert(obj);
157 obj->u.s.private_data = private_data;
158 }
159
160 const struct lttng_ust_abi_objd_ops *lttng_ust_abi_objd_ops(int id)
161 {
162 struct lttng_ust_abi_obj *obj = _objd_get(id);
163
164 if (!obj)
165 return NULL;
166 return obj->u.s.ops;
167 }
168
169 static
170 void objd_free(int id)
171 {
172 struct lttng_ust_abi_obj *obj = _objd_get(id);
173
174 assert(obj);
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 */
179 }
180
181 static
182 void objd_ref(int id)
183 {
184 struct lttng_ust_abi_obj *obj = _objd_get(id);
185 assert(obj != NULL);
186 obj->u.s.f_count++;
187 }
188
189 int lttng_ust_abi_objd_unref(int id, int is_owner)
190 {
191 struct lttng_ust_abi_obj *obj = _objd_get(id);
192
193 if (!obj)
194 return -EINVAL;
195 if (obj->u.s.f_count == 1) {
196 ERR("Reference counting error\n");
197 return -EINVAL;
198 }
199 if (is_owner) {
200 if (!obj->u.s.owner_ref) {
201 ERR("Error decrementing owner reference");
202 return -EINVAL;
203 }
204 obj->u.s.owner_ref--;
205 }
206 if ((--obj->u.s.f_count) == 1) {
207 const struct lttng_ust_abi_objd_ops *ops = lttng_ust_abi_objd_ops(id);
208
209 if (ops->release)
210 ops->release(id);
211 objd_free(id);
212 }
213 return 0;
214 }
215
216 static
217 void objd_table_destroy(void)
218 {
219 int i;
220
221 for (i = 0; i < objd_table.allocated_len; i++) {
222 struct lttng_ust_abi_obj *obj;
223
224 obj = _objd_get(i);
225 if (!obj)
226 continue;
227 if (!obj->u.s.owner_ref)
228 continue; /* only unref owner ref. */
229 (void) lttng_ust_abi_objd_unref(i, 1);
230 }
231 free(objd_table.array);
232 objd_table.array = NULL;
233 objd_table.len = 0;
234 objd_table.allocated_len = 0;
235 objd_table.freelist_head = -1;
236 }
237
238 const char *lttng_ust_obj_get_name(int id)
239 {
240 struct lttng_ust_abi_obj *obj = _objd_get(id);
241
242 if (!obj)
243 return NULL;
244 return obj->u.s.name;
245 }
246
247 void lttng_ust_abi_objd_table_owner_cleanup(void *owner)
248 {
249 int i;
250
251 for (i = 0; i < objd_table.allocated_len; i++) {
252 struct lttng_ust_abi_obj *obj;
253
254 obj = _objd_get(i);
255 if (!obj)
256 continue;
257 if (!obj->u.s.owner)
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);
263 }
264 }
265
266 /*
267 * This is LTTng's own personal way to create an ABI for sessiond.
268 * We send commands over a socket.
269 */
270
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;
279
280 int lttng_abi_create_root_handle(void)
281 {
282 int root_handle;
283
284 /* root handles have NULL owners */
285 root_handle = objd_alloc(NULL, &lttng_ops, NULL, "root");
286 return root_handle;
287 }
288
289 static
290 int lttng_is_channel_ready(struct lttng_ust_channel_buffer *lttng_chan)
291 {
292 struct lttng_ust_lib_ring_buffer_channel *chan;
293 unsigned int nr_streams, exp_streams;
294
295 chan = lttng_chan->chan;
296 nr_streams = channel_handle_get_nr_streams(lttng_chan->handle);
297 exp_streams = chan->nr_streams;
298 return nr_streams == exp_streams;
299 }
300
301 static
302 int lttng_abi_create_session(void *owner)
303 {
304 struct lttng_ust_session *session;
305 int session_objd, ret;
306
307 session = lttng_session_create();
308 if (!session)
309 return -ENOMEM;
310 session_objd = objd_alloc(session, &lttng_session_ops, owner, "session");
311 if (session_objd < 0) {
312 ret = session_objd;
313 goto objd_error;
314 }
315 session->priv->objd = session_objd;
316 session->priv->owner = owner;
317 return session_objd;
318
319 objd_error:
320 lttng_session_destroy(session);
321 return ret;
322 }
323
324 static
325 long lttng_abi_tracer_version(int objd,
326 struct lttng_ust_abi_tracer_version *v)
327 {
328 v->major = LTTNG_UST_MAJOR_VERSION;
329 v->minor = LTTNG_UST_MINOR_VERSION;
330 v->patchlevel = LTTNG_UST_PATCHLEVEL_VERSION;
331 return 0;
332 }
333
334 static
335 int lttng_abi_event_notifier_send_fd(void *owner, int *event_notifier_notif_fd)
336 {
337 struct lttng_event_notifier_group *event_notifier_group;
338 int event_notifier_group_objd, ret, fd_flag;
339
340 event_notifier_group = lttng_event_notifier_group_create();
341 if (!event_notifier_group)
342 return -ENOMEM;
343
344 /*
345 * Set this file descriptor as NON-BLOCKING.
346 */
347 fd_flag = fcntl(*event_notifier_notif_fd, F_GETFL);
348
349 fd_flag |= O_NONBLOCK;
350
351 ret = fcntl(*event_notifier_notif_fd, F_SETFL, fd_flag);
352 if (ret) {
353 ret = -errno;
354 goto fd_error;
355 }
356
357 event_notifier_group_objd = objd_alloc(event_notifier_group,
358 &lttng_event_notifier_group_ops, owner, "event_notifier_group");
359 if (event_notifier_group_objd < 0) {
360 ret = event_notifier_group_objd;
361 goto objd_error;
362 }
363
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;
369
370 return event_notifier_group_objd;
371
372 objd_error:
373 lttng_event_notifier_group_destroy(event_notifier_group);
374 fd_error:
375 return ret;
376 }
377
378 static
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)
383 {
384 return lttng_attach_context(context_param, uargs, ctx, session);
385 }
386
387 /**
388 * lttng_cmd - lttng control through socket commands
389 *
390 * @objd: the object descriptor
391 * @cmd: the command
392 * @arg: command arg
393 * @uargs: UST arguments (internal)
394 * @owner: objd owner
395 *
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
407 *
408 * The returned session will be deleted when its file descriptor is closed.
409 */
410 static
411 long lttng_cmd(int objd, unsigned int cmd, unsigned long arg,
412 union lttng_ust_abi_args *uargs, void *owner)
413 {
414 switch (cmd) {
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();
426 return 0;
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);
430 default:
431 return -EINVAL;
432 }
433 }
434
435 static const struct lttng_ust_abi_objd_ops lttng_ops = {
436 .cmd = lttng_cmd,
437 };
438
439 static
440 int lttng_abi_map_channel(int session_objd,
441 struct lttng_ust_abi_channel *ust_chan,
442 union lttng_ust_abi_args *uargs,
443 void *owner)
444 {
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;
449 int chan_objd;
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;
455 void *chan_data;
456 int wakeup_fd;
457 uint64_t len;
458 int ret;
459 enum lttng_ust_abi_chan_type type;
460
461 chan_data = uargs->channel.chan_data;
462 wakeup_fd = uargs->channel.wakeup_fd;
463 len = ust_chan->len;
464 type = ust_chan->type;
465
466 switch (type) {
467 case LTTNG_UST_ABI_CHAN_PER_CPU:
468 break;
469 default:
470 ret = -EINVAL;
471 goto invalid;
472 }
473
474 if (session->priv->been_active) {
475 ret = -EBUSY;
476 goto active; /* Refuse to add channel to active session */
477 }
478
479 lttng_chan_buf = lttng_ust_alloc_channel_buffer();
480 if (!lttng_chan_buf) {
481 ret = -ENOMEM;
482 goto lttng_chan_buf_error;
483 }
484
485 channel_handle = channel_handle_create(chan_data, len, wakeup_fd);
486 if (!channel_handle) {
487 ret = -EINVAL;
488 goto handle_error;
489 }
490
491 /* Ownership of chan_data and wakeup_fd taken by channel handle. */
492 uargs->channel.chan_data = NULL;
493 uargs->channel.wakeup_fd = -1;
494
495 chan = shmp(channel_handle, channel_handle->chan);
496 assert(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) {
501 ret = -EINVAL;
502 goto alloc_error;
503 }
504
505 /* Lookup transport name */
506 switch (type) {
507 case LTTNG_UST_ABI_CHAN_PER_CPU:
508 if (config->output == RING_BUFFER_MMAP) {
509 if (config->mode == RING_BUFFER_OVERWRITE) {
510 if (config->wakeup == RING_BUFFER_WAKEUP_BY_WRITER) {
511 transport_name = "relay-overwrite-mmap";
512 } else {
513 transport_name = "relay-overwrite-rt-mmap";
514 }
515 } else {
516 if (config->wakeup == RING_BUFFER_WAKEUP_BY_WRITER) {
517 transport_name = "relay-discard-mmap";
518 } else {
519 transport_name = "relay-discard-rt-mmap";
520 }
521 }
522 } else {
523 ret = -EINVAL;
524 goto notransport;
525 }
526 chan_name = "channel";
527 break;
528 default:
529 ret = -EINVAL;
530 goto notransport;
531 }
532 transport = lttng_ust_transport_find(transport_name);
533 if (!transport) {
534 DBG("LTTng transport %s not found\n",
535 transport_name);
536 ret = -EINVAL;
537 goto notransport;
538 }
539
540 chan_objd = objd_alloc(NULL, &lttng_channel_ops, owner, chan_name);
541 if (chan_objd < 0) {
542 ret = chan_objd;
543 goto objd_error;
544 }
545
546 /* Initialize our lttng chan */
547 lttng_chan_buf->parent->enabled = 1;
548 lttng_chan_buf->parent->session = session;
549
550 lttng_chan_buf->priv->parent.tstate = 1;
551 lttng_chan_buf->priv->ctx = NULL;
552
553 lttng_chan_buf->ops = &transport->ops;
554 lttng_chan_buf->chan = chan;
555 lttng_chan_buf->handle = channel_handle;
556
557 memcpy(&chan->backend.config,
558 transport->client_config,
559 sizeof(chan->backend.config));
560 cds_list_add(&lttng_chan_buf->priv->node, &session->priv->chan_head);
561 lttng_chan_buf->priv->header_type = 0;
562 lttng_chan_buf->priv->type = type;
563 /* Copy fields from lttng ust chan config. */
564 lttng_chan_buf->priv->id = lttng_chan_config->id;
565 memcpy(lttng_chan_buf->priv->uuid, lttng_chan_config->uuid, LTTNG_UST_UUID_LEN);
566 channel_set_private(chan, lttng_chan_buf);
567
568 /*
569 * We tolerate no failure path after channel creation. It will stay
570 * invariant for the rest of the session.
571 */
572 objd_set_private(chan_objd, lttng_chan_buf);
573 lttng_chan_buf->priv->parent.objd = chan_objd;
574 /* The channel created holds a reference on the session */
575 objd_ref(session_objd);
576 return chan_objd;
577
578 /* error path after channel was created */
579 objd_error:
580 notransport:
581 alloc_error:
582 channel_destroy(chan, channel_handle, 0);
583 lttng_ust_free_channel_common(lttng_chan_buf->parent);
584 return ret;
585
586 handle_error:
587 lttng_ust_free_channel_common(lttng_chan_buf->parent);
588 lttng_chan_buf_error:
589 active:
590 invalid:
591 return ret;
592 }
593
594 /**
595 * lttng_session_cmd - lttng session object command
596 *
597 * @obj: the object
598 * @cmd: the command
599 * @arg: command arg
600 * @uargs: UST arguments (internal)
601 * @owner: objd owner
602 *
603 * This descriptor implements lttng commands:
604 * LTTNG_UST_ABI_CHANNEL
605 * Returns a LTTng channel object descriptor
606 * LTTNG_UST_ABI_ENABLE
607 * Enables tracing for a session (weak enable)
608 * LTTNG_UST_ABI_DISABLE
609 * Disables tracing for a session (strong disable)
610 *
611 * The returned channel will be deleted when its file descriptor is closed.
612 */
613 static
614 long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg,
615 union lttng_ust_abi_args *uargs, void *owner)
616 {
617 struct lttng_ust_session *session = objd_private(objd);
618
619 switch (cmd) {
620 case LTTNG_UST_ABI_CHANNEL:
621 return lttng_abi_map_channel(objd,
622 (struct lttng_ust_abi_channel *) arg,
623 uargs, owner);
624 case LTTNG_UST_ABI_SESSION_START:
625 case LTTNG_UST_ABI_ENABLE:
626 return lttng_session_enable(session);
627 case LTTNG_UST_ABI_SESSION_STOP:
628 case LTTNG_UST_ABI_DISABLE:
629 return lttng_session_disable(session);
630 case LTTNG_UST_ABI_SESSION_STATEDUMP:
631 return lttng_session_statedump(session);
632 case LTTNG_UST_ABI_COUNTER:
633 case LTTNG_UST_ABI_COUNTER_GLOBAL:
634 case LTTNG_UST_ABI_COUNTER_CPU:
635 /* Not implemented yet. */
636 return -EINVAL;
637 default:
638 return -EINVAL;
639 }
640 }
641
642 /*
643 * Called when the last file reference is dropped.
644 *
645 * Big fat note: channels and events are invariant for the whole session after
646 * their creation. So this session destruction also destroys all channel and
647 * event structures specific to this session (they are not destroyed when their
648 * individual file is released).
649 */
650 static
651 int lttng_release_session(int objd)
652 {
653 struct lttng_ust_session *session = objd_private(objd);
654
655 if (session) {
656 lttng_session_destroy(session);
657 return 0;
658 } else {
659 return -EINVAL;
660 }
661 }
662
663 static const struct lttng_ust_abi_objd_ops lttng_session_ops = {
664 .release = lttng_release_session,
665 .cmd = lttng_session_cmd,
666 };
667
668 static int lttng_ust_event_notifier_enabler_create(int event_notifier_group_obj,
669 void *owner, struct lttng_ust_abi_event_notifier *event_notifier_param,
670 enum lttng_enabler_format_type type)
671 {
672 struct lttng_event_notifier_group *event_notifier_group =
673 objd_private(event_notifier_group_obj);
674 struct lttng_event_notifier_enabler *event_notifier_enabler;
675 int event_notifier_objd, ret;
676
677 event_notifier_param->event.name[LTTNG_UST_ABI_SYM_NAME_LEN - 1] = '\0';
678 event_notifier_objd = objd_alloc(NULL, &lttng_event_notifier_enabler_ops, owner,
679 "event_notifier enabler");
680 if (event_notifier_objd < 0) {
681 ret = event_notifier_objd;
682 goto objd_error;
683 }
684
685 event_notifier_enabler = lttng_event_notifier_enabler_create(
686 event_notifier_group, type, event_notifier_param);
687 if (!event_notifier_enabler) {
688 ret = -ENOMEM;
689 goto event_notifier_error;
690 }
691
692 objd_set_private(event_notifier_objd, event_notifier_enabler);
693 /* The event_notifier holds a reference on the event_notifier group. */
694 objd_ref(event_notifier_enabler->group->objd);
695
696 return event_notifier_objd;
697
698 event_notifier_error:
699 {
700 int err;
701
702 err = lttng_ust_abi_objd_unref(event_notifier_objd, 1);
703 assert(!err);
704 }
705 objd_error:
706 return ret;
707 }
708
709 static
710 long lttng_event_notifier_enabler_cmd(int objd, unsigned int cmd, unsigned long arg,
711 union lttng_ust_abi_args *uargs, void *owner)
712 {
713 struct lttng_event_notifier_enabler *event_notifier_enabler = objd_private(objd);
714 switch (cmd) {
715 case LTTNG_UST_ABI_FILTER:
716 return lttng_event_notifier_enabler_attach_filter_bytecode(
717 event_notifier_enabler,
718 (struct lttng_ust_bytecode_node **) arg);
719 case LTTNG_UST_ABI_EXCLUSION:
720 return lttng_event_notifier_enabler_attach_exclusion(event_notifier_enabler,
721 (struct lttng_ust_excluder_node **) arg);
722 case LTTNG_UST_ABI_CAPTURE:
723 return lttng_event_notifier_enabler_attach_capture_bytecode(
724 event_notifier_enabler,
725 (struct lttng_ust_bytecode_node **) arg);
726 case LTTNG_UST_ABI_ENABLE:
727 return lttng_event_notifier_enabler_enable(event_notifier_enabler);
728 case LTTNG_UST_ABI_DISABLE:
729 return lttng_event_notifier_enabler_disable(event_notifier_enabler);
730 default:
731 return -EINVAL;
732 }
733 }
734
735 /**
736 * lttng_event_notifier_group_error_counter_cmd - lttng event_notifier group error counter object command
737 *
738 * @obj: the object
739 * @cmd: the command
740 * @arg: command arg
741 * @uargs: UST arguments (internal)
742 * @owner: objd owner
743 *
744 * This descriptor implements lttng commands:
745 * LTTNG_UST_ABI_COUNTER_GLOBAL
746 * Return negative error code on error, 0 on success.
747 * LTTNG_UST_ABI_COUNTER_CPU
748 * Return negative error code on error, 0 on success.
749 */
750 static
751 long lttng_event_notifier_group_error_counter_cmd(int objd, unsigned int cmd, unsigned long arg,
752 union lttng_ust_abi_args *uargs, void *owner)
753 {
754 int ret;
755 struct lttng_counter *counter = objd_private(objd);
756
757 switch (cmd) {
758 case LTTNG_UST_ABI_COUNTER_GLOBAL:
759 ret = -EINVAL; /* Unimplemented. */
760 break;
761 case LTTNG_UST_ABI_COUNTER_CPU:
762 {
763 struct lttng_ust_abi_counter_cpu *counter_cpu =
764 (struct lttng_ust_abi_counter_cpu *)arg;
765
766 ret = lttng_counter_set_cpu_shm(counter->counter,
767 counter_cpu->cpu_nr, uargs->counter_shm.shm_fd);
768 if (!ret) {
769 /* Take ownership of the shm_fd. */
770 uargs->counter_shm.shm_fd = -1;
771 }
772 break;
773 }
774 default:
775 ret = -EINVAL;
776 break;
777 }
778
779 return ret;
780 }
781
782 __attribute__((visibility("hidden")))
783 int lttng_release_event_notifier_group_error_counter(int objd)
784 {
785 struct lttng_counter *counter = objd_private(objd);
786
787 if (counter) {
788 return lttng_ust_abi_objd_unref(counter->event_notifier_group->objd, 0);
789 } else {
790 return -EINVAL;
791 }
792 }
793
794 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_group_error_counter_ops = {
795 .release = lttng_release_event_notifier_group_error_counter,
796 .cmd = lttng_event_notifier_group_error_counter_cmd,
797 };
798
799 static
800 int lttng_ust_event_notifier_group_create_error_counter(int event_notifier_group_objd, void *owner,
801 struct lttng_ust_abi_counter_conf *error_counter_conf)
802 {
803 const char *counter_transport_name;
804 struct lttng_event_notifier_group *event_notifier_group =
805 objd_private(event_notifier_group_objd);
806 struct lttng_counter *counter;
807 int counter_objd, ret;
808 struct lttng_counter_dimension dimensions[1];
809 size_t counter_len;
810
811 if (event_notifier_group->error_counter)
812 return -EBUSY;
813
814 if (error_counter_conf->arithmetic != LTTNG_UST_ABI_COUNTER_ARITHMETIC_MODULAR)
815 return -EINVAL;
816
817 if (error_counter_conf->number_dimensions != 1)
818 return -EINVAL;
819
820 switch (error_counter_conf->bitness) {
821 case LTTNG_UST_ABI_COUNTER_BITNESS_64:
822 counter_transport_name = "counter-per-cpu-64-modular";
823 break;
824 case LTTNG_UST_ABI_COUNTER_BITNESS_32:
825 counter_transport_name = "counter-per-cpu-32-modular";
826 break;
827 default:
828 return -EINVAL;
829 }
830
831 counter_objd = objd_alloc(NULL, &lttng_event_notifier_group_error_counter_ops, owner,
832 "event_notifier group error counter");
833 if (counter_objd < 0) {
834 ret = counter_objd;
835 goto objd_error;
836 }
837
838 counter_len = error_counter_conf->dimensions[0].size;
839 dimensions[0].size = counter_len;
840 dimensions[0].underflow_index = 0;
841 dimensions[0].overflow_index = 0;
842 dimensions[0].has_underflow = 0;
843 dimensions[0].has_overflow = 0;
844
845 counter = lttng_ust_counter_create(counter_transport_name, 1, dimensions);
846 if (!counter) {
847 ret = -EINVAL;
848 goto create_error;
849 }
850
851 event_notifier_group->error_counter_len = counter_len;
852 /*
853 * store-release to publish error counter matches load-acquire
854 * in record_error. Ensures the counter is created and the
855 * error_counter_len is set before they are used.
856 * Currently a full memory barrier is used, which could be
857 * turned into acquire-release barriers.
858 */
859 cmm_smp_mb();
860 CMM_STORE_SHARED(event_notifier_group->error_counter, counter);
861
862 counter->objd = counter_objd;
863 counter->event_notifier_group = event_notifier_group; /* owner */
864
865 objd_set_private(counter_objd, counter);
866 /* The error counter holds a reference on the event_notifier group. */
867 objd_ref(event_notifier_group->objd);
868
869 return counter_objd;
870
871 create_error:
872 {
873 int err;
874
875 err = lttng_ust_abi_objd_unref(counter_objd, 1);
876 assert(!err);
877 }
878 objd_error:
879 return ret;
880 }
881
882 static
883 long lttng_event_notifier_group_cmd(int objd, unsigned int cmd, unsigned long arg,
884 union lttng_ust_abi_args *uargs, void *owner)
885 {
886 switch (cmd) {
887 case LTTNG_UST_ABI_EVENT_NOTIFIER_CREATE:
888 {
889 struct lttng_ust_abi_event_notifier *event_notifier_param =
890 (struct lttng_ust_abi_event_notifier *) arg;
891 if (strutils_is_star_glob_pattern(event_notifier_param->event.name)) {
892 /*
893 * If the event name is a star globbing pattern,
894 * we create the special star globbing enabler.
895 */
896 return lttng_ust_event_notifier_enabler_create(objd,
897 owner, event_notifier_param,
898 LTTNG_ENABLER_FORMAT_STAR_GLOB);
899 } else {
900 return lttng_ust_event_notifier_enabler_create(objd,
901 owner, event_notifier_param,
902 LTTNG_ENABLER_FORMAT_EVENT);
903 }
904 }
905 case LTTNG_UST_ABI_COUNTER:
906 {
907 struct lttng_ust_abi_counter_conf *counter_conf =
908 (struct lttng_ust_abi_counter_conf *) uargs->counter.counter_data;
909 return lttng_ust_event_notifier_group_create_error_counter(
910 objd, owner, counter_conf);
911 }
912 default:
913 return -EINVAL;
914 }
915 }
916
917 static
918 int lttng_event_notifier_enabler_release(int objd)
919 {
920 struct lttng_event_notifier_enabler *event_notifier_enabler = objd_private(objd);
921
922 if (event_notifier_enabler)
923 return lttng_ust_abi_objd_unref(event_notifier_enabler->group->objd, 0);
924 return 0;
925 }
926
927 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_enabler_ops = {
928 .release = lttng_event_notifier_enabler_release,
929 .cmd = lttng_event_notifier_enabler_cmd,
930 };
931
932 static
933 int lttng_release_event_notifier_group(int objd)
934 {
935 struct lttng_event_notifier_group *event_notifier_group = objd_private(objd);
936
937 if (event_notifier_group) {
938 lttng_event_notifier_group_destroy(event_notifier_group);
939 return 0;
940 } else {
941 return -EINVAL;
942 }
943 }
944
945 static const struct lttng_ust_abi_objd_ops lttng_event_notifier_group_ops = {
946 .release = lttng_release_event_notifier_group,
947 .cmd = lttng_event_notifier_group_cmd,
948 };
949
950 static
951 long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg,
952 union lttng_ust_abi_args *uargs, void *owner)
953 {
954 struct lttng_ust_tracepoint_list *list = objd_private(objd);
955 struct lttng_ust_abi_tracepoint_iter *tp =
956 (struct lttng_ust_abi_tracepoint_iter *) arg;
957 struct lttng_ust_abi_tracepoint_iter *iter;
958
959 switch (cmd) {
960 case LTTNG_UST_ABI_TRACEPOINT_LIST_GET:
961 {
962 iter = lttng_ust_tracepoint_list_get_iter_next(list);
963 if (!iter)
964 return -LTTNG_UST_ERR_NOENT;
965 memcpy(tp, iter, sizeof(*tp));
966 return 0;
967 }
968 default:
969 return -EINVAL;
970 }
971 }
972
973 static
974 int lttng_abi_tracepoint_list(void *owner)
975 {
976 int list_objd, ret;
977 struct lttng_ust_tracepoint_list *list;
978
979 list_objd = objd_alloc(NULL, &lttng_tracepoint_list_ops, owner, "tp_list");
980 if (list_objd < 0) {
981 ret = list_objd;
982 goto objd_error;
983 }
984 list = zmalloc(sizeof(*list));
985 if (!list) {
986 ret = -ENOMEM;
987 goto alloc_error;
988 }
989 objd_set_private(list_objd, list);
990
991 /* populate list by walking on all registered probes. */
992 ret = lttng_probes_get_event_list(list);
993 if (ret) {
994 goto list_error;
995 }
996 return list_objd;
997
998 list_error:
999 free(list);
1000 alloc_error:
1001 {
1002 int err;
1003
1004 err = lttng_ust_abi_objd_unref(list_objd, 1);
1005 assert(!err);
1006 }
1007 objd_error:
1008 return ret;
1009 }
1010
1011 static
1012 int lttng_release_tracepoint_list(int objd)
1013 {
1014 struct lttng_ust_tracepoint_list *list = objd_private(objd);
1015
1016 if (list) {
1017 lttng_probes_prune_event_list(list);
1018 free(list);
1019 return 0;
1020 } else {
1021 return -EINVAL;
1022 }
1023 }
1024
1025 static const struct lttng_ust_abi_objd_ops lttng_tracepoint_list_ops = {
1026 .release = lttng_release_tracepoint_list,
1027 .cmd = lttng_tracepoint_list_cmd,
1028 };
1029
1030 static
1031 long lttng_tracepoint_field_list_cmd(int objd, unsigned int cmd,
1032 unsigned long arg, union lttng_ust_abi_args *uargs, void *owner)
1033 {
1034 struct lttng_ust_field_list *list = objd_private(objd);
1035 struct lttng_ust_abi_field_iter *tp = &uargs->field_list.entry;
1036 struct lttng_ust_abi_field_iter *iter;
1037
1038 switch (cmd) {
1039 case LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST_GET:
1040 {
1041 iter = lttng_ust_field_list_get_iter_next(list);
1042 if (!iter)
1043 return -LTTNG_UST_ERR_NOENT;
1044 memcpy(tp, iter, sizeof(*tp));
1045 return 0;
1046 }
1047 default:
1048 return -EINVAL;
1049 }
1050 }
1051
1052 static
1053 int lttng_abi_tracepoint_field_list(void *owner)
1054 {
1055 int list_objd, ret;
1056 struct lttng_ust_field_list *list;
1057
1058 list_objd = objd_alloc(NULL, &lttng_tracepoint_field_list_ops, owner,
1059 "tp_field_list");
1060 if (list_objd < 0) {
1061 ret = list_objd;
1062 goto objd_error;
1063 }
1064 list = zmalloc(sizeof(*list));
1065 if (!list) {
1066 ret = -ENOMEM;
1067 goto alloc_error;
1068 }
1069 objd_set_private(list_objd, list);
1070
1071 /* populate list by walking on all registered probes. */
1072 ret = lttng_probes_get_field_list(list);
1073 if (ret) {
1074 goto list_error;
1075 }
1076 return list_objd;
1077
1078 list_error:
1079 free(list);
1080 alloc_error:
1081 {
1082 int err;
1083
1084 err = lttng_ust_abi_objd_unref(list_objd, 1);
1085 assert(!err);
1086 }
1087 objd_error:
1088 return ret;
1089 }
1090
1091 static
1092 int lttng_release_tracepoint_field_list(int objd)
1093 {
1094 struct lttng_ust_field_list *list = objd_private(objd);
1095
1096 if (list) {
1097 lttng_probes_prune_field_list(list);
1098 free(list);
1099 return 0;
1100 } else {
1101 return -EINVAL;
1102 }
1103 }
1104
1105 static const struct lttng_ust_abi_objd_ops lttng_tracepoint_field_list_ops = {
1106 .release = lttng_release_tracepoint_field_list,
1107 .cmd = lttng_tracepoint_field_list_cmd,
1108 };
1109
1110 static
1111 int lttng_abi_map_stream(int channel_objd, struct lttng_ust_abi_stream *info,
1112 union lttng_ust_abi_args *uargs, void *owner)
1113 {
1114 struct lttng_ust_channel_buffer *lttng_chan_buf = objd_private(channel_objd);
1115 int ret;
1116
1117 ret = channel_handle_add_stream(lttng_chan_buf->handle,
1118 uargs->stream.shm_fd, uargs->stream.wakeup_fd,
1119 info->stream_nr, info->len);
1120 if (ret)
1121 goto error_add_stream;
1122 /* Take ownership of shm_fd and wakeup_fd. */
1123 uargs->stream.shm_fd = -1;
1124 uargs->stream.wakeup_fd = -1;
1125
1126 return 0;
1127
1128 error_add_stream:
1129 return ret;
1130 }
1131
1132 static
1133 int lttng_abi_create_event_enabler(int channel_objd,
1134 struct lttng_ust_abi_event *event_param,
1135 void *owner,
1136 enum lttng_enabler_format_type format_type)
1137 {
1138 struct lttng_ust_channel_buffer *channel = objd_private(channel_objd);
1139 struct lttng_event_enabler *enabler;
1140 int event_objd, ret;
1141
1142 event_param->name[LTTNG_UST_ABI_SYM_NAME_LEN - 1] = '\0';
1143 event_objd = objd_alloc(NULL, &lttng_event_enabler_ops, owner,
1144 "event enabler");
1145 if (event_objd < 0) {
1146 ret = event_objd;
1147 goto objd_error;
1148 }
1149 /*
1150 * We tolerate no failure path after event creation. It will stay
1151 * invariant for the rest of the session.
1152 */
1153 enabler = lttng_event_enabler_create(format_type, event_param, channel);
1154 if (!enabler) {
1155 ret = -ENOMEM;
1156 goto event_error;
1157 }
1158 objd_set_private(event_objd, enabler);
1159 /* The event holds a reference on the channel */
1160 objd_ref(channel_objd);
1161 return event_objd;
1162
1163 event_error:
1164 {
1165 int err;
1166
1167 err = lttng_ust_abi_objd_unref(event_objd, 1);
1168 assert(!err);
1169 }
1170 objd_error:
1171 return ret;
1172 }
1173
1174 /**
1175 * lttng_channel_cmd - lttng control through object descriptors
1176 *
1177 * @objd: the object descriptor
1178 * @cmd: the command
1179 * @arg: command arg
1180 * @uargs: UST arguments (internal)
1181 * @owner: objd owner
1182 *
1183 * This object descriptor implements lttng commands:
1184 * LTTNG_UST_ABI_STREAM
1185 * Returns an event stream object descriptor or failure.
1186 * (typically, one event stream records events from one CPU)
1187 * LTTNG_UST_ABI_EVENT
1188 * Returns an event object descriptor or failure.
1189 * LTTNG_UST_ABI_CONTEXT
1190 * Prepend a context field to each event in the channel
1191 * LTTNG_UST_ABI_ENABLE
1192 * Enable recording for events in this channel (weak enable)
1193 * LTTNG_UST_ABI_DISABLE
1194 * Disable recording for events in this channel (strong disable)
1195 *
1196 * Channel and event file descriptors also hold a reference on the session.
1197 */
1198 static
1199 long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg,
1200 union lttng_ust_abi_args *uargs, void *owner)
1201 {
1202 struct lttng_ust_channel_buffer *lttng_chan_buf = objd_private(objd);
1203
1204 if (cmd != LTTNG_UST_ABI_STREAM) {
1205 /*
1206 * Check if channel received all streams.
1207 */
1208 if (!lttng_is_channel_ready(lttng_chan_buf))
1209 return -EPERM;
1210 }
1211
1212 switch (cmd) {
1213 case LTTNG_UST_ABI_STREAM:
1214 {
1215 struct lttng_ust_abi_stream *stream;
1216
1217 stream = (struct lttng_ust_abi_stream *) arg;
1218 /* stream used as output */
1219 return lttng_abi_map_stream(objd, stream, uargs, owner);
1220 }
1221 case LTTNG_UST_ABI_EVENT:
1222 {
1223 struct lttng_ust_abi_event *event_param =
1224 (struct lttng_ust_abi_event *) arg;
1225
1226 if (strutils_is_star_glob_pattern(event_param->name)) {
1227 /*
1228 * If the event name is a star globbing pattern,
1229 * we create the special star globbing enabler.
1230 */
1231 return lttng_abi_create_event_enabler(objd, event_param,
1232 owner, LTTNG_ENABLER_FORMAT_STAR_GLOB);
1233 } else {
1234 return lttng_abi_create_event_enabler(objd, event_param,
1235 owner, LTTNG_ENABLER_FORMAT_EVENT);
1236 }
1237 }
1238 case LTTNG_UST_ABI_CONTEXT:
1239 return lttng_abi_add_context(objd,
1240 (struct lttng_ust_abi_context *) arg, uargs,
1241 &lttng_chan_buf->priv->ctx,
1242 lttng_chan_buf->parent->session);
1243 case LTTNG_UST_ABI_ENABLE:
1244 return lttng_channel_enable(lttng_chan_buf->parent);
1245 case LTTNG_UST_ABI_DISABLE:
1246 return lttng_channel_disable(lttng_chan_buf->parent);
1247 case LTTNG_UST_ABI_FLUSH_BUFFER:
1248 return lttng_chan_buf->ops->priv->flush_buffer(lttng_chan_buf->chan,
1249 lttng_chan_buf->handle);
1250 default:
1251 return -EINVAL;
1252 }
1253 }
1254
1255 static
1256 int lttng_channel_release(int objd)
1257 {
1258 struct lttng_ust_channel_buffer *lttng_chan_buf = objd_private(objd);
1259
1260 if (lttng_chan_buf)
1261 return lttng_ust_abi_objd_unref(lttng_chan_buf->parent->session->priv->objd, 0);
1262 return 0;
1263 }
1264
1265 static const struct lttng_ust_abi_objd_ops lttng_channel_ops = {
1266 .release = lttng_channel_release,
1267 .cmd = lttng_channel_cmd,
1268 };
1269
1270 /**
1271 * lttng_enabler_cmd - lttng control through object descriptors
1272 *
1273 * @objd: the object descriptor
1274 * @cmd: the command
1275 * @arg: command arg
1276 * @uargs: UST arguments (internal)
1277 * @owner: objd owner
1278 *
1279 * This object descriptor implements lttng commands:
1280 * LTTNG_UST_ABI_CONTEXT
1281 * Prepend a context field to each record of events of this
1282 * enabler.
1283 * LTTNG_UST_ABI_ENABLE
1284 * Enable recording for this enabler
1285 * LTTNG_UST_ABI_DISABLE
1286 * Disable recording for this enabler
1287 * LTTNG_UST_ABI_FILTER
1288 * Attach a filter to an enabler.
1289 * LTTNG_UST_ABI_EXCLUSION
1290 * Attach exclusions to an enabler.
1291 */
1292 static
1293 long lttng_event_enabler_cmd(int objd, unsigned int cmd, unsigned long arg,
1294 union lttng_ust_abi_args *uargs, void *owner)
1295 {
1296 struct lttng_event_enabler *enabler = objd_private(objd);
1297
1298 switch (cmd) {
1299 case LTTNG_UST_ABI_CONTEXT:
1300 return lttng_event_enabler_attach_context(enabler,
1301 (struct lttng_ust_abi_context *) arg);
1302 case LTTNG_UST_ABI_ENABLE:
1303 return lttng_event_enabler_enable(enabler);
1304 case LTTNG_UST_ABI_DISABLE:
1305 return lttng_event_enabler_disable(enabler);
1306 case LTTNG_UST_ABI_FILTER:
1307 {
1308 int ret;
1309
1310 ret = lttng_event_enabler_attach_filter_bytecode(enabler,
1311 (struct lttng_ust_bytecode_node **) arg);
1312 if (ret)
1313 return ret;
1314 return 0;
1315 }
1316 case LTTNG_UST_ABI_EXCLUSION:
1317 {
1318 return lttng_event_enabler_attach_exclusion(enabler,
1319 (struct lttng_ust_excluder_node **) arg);
1320 }
1321 default:
1322 return -EINVAL;
1323 }
1324 }
1325
1326 static
1327 int lttng_event_enabler_release(int objd)
1328 {
1329 struct lttng_event_enabler *event_enabler = objd_private(objd);
1330
1331 if (event_enabler)
1332 return lttng_ust_abi_objd_unref(event_enabler->chan->priv->parent.objd, 0);
1333
1334 return 0;
1335 }
1336
1337 static const struct lttng_ust_abi_objd_ops lttng_event_enabler_ops = {
1338 .release = lttng_event_enabler_release,
1339 .cmd = lttng_event_enabler_cmd,
1340 };
1341
1342 void lttng_ust_abi_exit(void)
1343 {
1344 lttng_ust_abi_close_in_progress = 1;
1345 ust_lock_nocheck();
1346 objd_table_destroy();
1347 ust_unlock();
1348 lttng_ust_abi_close_in_progress = 0;
1349 }
This page took 0.055954 seconds and 4 git commands to generate.