Implement field listing command
[lttng-ust.git] / liblttng-ust / lttng-ust-abi.c
CommitLineData
f4681817
MD
1/*
2 * lttng-ust-abi.c
3 *
f4681817
MD
4 * LTTng UST ABI
5 *
e92f3e28
MD
6 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; only
11 * version 2.1 of the License.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 *
f4681817
MD
23 * Mimic system calls for:
24 * - session creation, returns an object descriptor or failure.
25 * - channel creation, returns an object descriptor or failure.
26 * - Operates on a session object descriptor
27 * - Takes all channel options as parameters.
28 * - stream get, returns an object descriptor or failure.
29 * - Operates on a channel object descriptor.
30 * - stream notifier get, returns an object descriptor or failure.
31 * - Operates on a channel object descriptor.
32 * - event creation, returns an object descriptor or failure.
33 * - Operates on a channel object descriptor
34 * - Takes an event name as parameter
35 * - Takes an instrumentation source as parameter
36 * - e.g. tracepoints, dynamic_probes...
37 * - Takes instrumentation source specific arguments.
f4681817
MD
38 */
39
4318ae1b 40#include <lttng/ust-abi.h>
f4681817
MD
41#include <urcu/compiler.h>
42#include <urcu/list.h>
4318ae1b 43#include <lttng/ust-events.h>
23c8854a 44#include <lttng/ust-version.h>
902e1379 45#include <lttng/tracepoint.h>
d8de1354 46#include "tracepoint-internal.h"
44c72f10
MD
47#include <usterr-signal-safe.h>
48#include <helper.h>
f4681817 49#include "ltt-tracer.h"
4ab44fbe 50
45e9e699
MD
51static int lttng_ust_abi_close_in_progress;
52
51489cad
MD
53static
54int lttng_abi_tracepoint_list(void);
06d4f27e
MD
55static
56int lttng_abi_tracepoint_field_list(void);
51489cad 57
f4681817
MD
58/*
59 * Object descriptor table. Should be protected from concurrent access
60 * by the caller.
61 */
62
b61ce3b2 63struct lttng_ust_obj {
f4681817
MD
64 union {
65 struct {
66 void *private_data;
b61ce3b2 67 const struct lttng_ust_objd_ops *ops;
f4681817
MD
68 int f_count;
69 } s;
70 int freelist_next; /* offset freelist. end is -1. */
71 } u;
72};
73
b61ce3b2
MD
74struct lttng_ust_objd_table {
75 struct lttng_ust_obj *array;
f4681817
MD
76 unsigned int len, allocated_len;
77 int freelist_head; /* offset freelist head. end is -1 */
78};
79
b61ce3b2 80static struct lttng_ust_objd_table objd_table = {
f4681817
MD
81 .freelist_head = -1,
82};
83
84static
b61ce3b2 85int objd_alloc(void *private_data, const struct lttng_ust_objd_ops *ops)
f4681817 86{
b61ce3b2 87 struct lttng_ust_obj *obj;
f4681817
MD
88
89 if (objd_table.freelist_head != -1) {
90 obj = &objd_table.array[objd_table.freelist_head];
91 objd_table.freelist_head = obj->u.freelist_next;
92 goto end;
93 }
94
95 if (objd_table.len >= objd_table.allocated_len) {
96 unsigned int new_allocated_len, old_allocated_len;
b61ce3b2 97 struct lttng_ust_obj *new_table, *old_table;
f4681817
MD
98
99 old_allocated_len = objd_table.allocated_len;
100 old_table = objd_table.array;
101 if (!old_allocated_len)
102 new_allocated_len = 1;
103 else
104 new_allocated_len = old_allocated_len << 1;
b61ce3b2 105 new_table = zmalloc(sizeof(struct lttng_ust_obj) * new_allocated_len);
f4681817
MD
106 if (!new_table)
107 return -ENOMEM;
108 memcpy(new_table, old_table,
b61ce3b2 109 sizeof(struct lttng_ust_obj) * old_allocated_len);
f4681817
MD
110 free(old_table);
111 objd_table.array = new_table;
112 objd_table.allocated_len = new_allocated_len;
113 }
114 obj = &objd_table.array[objd_table.len];
115 objd_table.len++;
116end:
117 obj->u.s.private_data = private_data;
118 obj->u.s.ops = ops;
a4be8962
MD
119 obj->u.s.f_count = 2; /* count == 1 : object is allocated */
120 /* count == 2 : allocated + hold ref */
f4681817
MD
121 return obj - objd_table.array;
122}
123
124static
b61ce3b2 125struct lttng_ust_obj *_objd_get(int id)
f4681817
MD
126{
127 if (id >= objd_table.len)
128 return NULL;
a4be8962
MD
129 if (!objd_table.array[id].u.s.f_count)
130 return NULL;
f4681817
MD
131 return &objd_table.array[id];
132}
133
134static
135void *objd_private(int id)
136{
b61ce3b2 137 struct lttng_ust_obj *obj = _objd_get(id);
f4681817
MD
138 assert(obj);
139 return obj->u.s.private_data;
140}
141
142static
143void objd_set_private(int id, void *private_data)
144{
b61ce3b2 145 struct lttng_ust_obj *obj = _objd_get(id);
f4681817
MD
146 assert(obj);
147 obj->u.s.private_data = private_data;
148}
149
b61ce3b2 150const struct lttng_ust_objd_ops *objd_ops(int id)
f4681817 151{
b61ce3b2 152 struct lttng_ust_obj *obj = _objd_get(id);
46050b1a 153
a4be8962
MD
154 if (!obj)
155 return NULL;
f4681817
MD
156 return obj->u.s.ops;
157}
158
159static
160void objd_free(int id)
161{
b61ce3b2 162 struct lttng_ust_obj *obj = _objd_get(id);
f4681817
MD
163
164 assert(obj);
165 obj->u.freelist_next = objd_table.freelist_head;
166 objd_table.freelist_head = obj - objd_table.array;
a4be8962
MD
167 assert(obj->u.s.f_count == 1);
168 obj->u.s.f_count = 0; /* deallocated */
f4681817
MD
169}
170
171static
172void objd_ref(int id)
173{
b61ce3b2 174 struct lttng_ust_obj *obj = _objd_get(id);
f4681817
MD
175 obj->u.s.f_count++;
176}
177
d4419b81 178int lttng_ust_objd_unref(int id)
f4681817 179{
b61ce3b2 180 struct lttng_ust_obj *obj = _objd_get(id);
f4681817 181
1ea11eab
MD
182 if (!obj)
183 return -EINVAL;
a4be8962
MD
184 if (obj->u.s.f_count == 1) {
185 ERR("Reference counting error\n");
186 return -EINVAL;
187 }
188 if ((--obj->u.s.f_count) == 1) {
b61ce3b2 189 const struct lttng_ust_objd_ops *ops = objd_ops(id);
a4be8962 190
f4681817
MD
191 if (ops->release)
192 ops->release(id);
193 objd_free(id);
194 }
1ea11eab 195 return 0;
f4681817
MD
196}
197
198static
199void objd_table_destroy(void)
200{
a4be8962
MD
201 int i;
202
fb50c39d 203 for (i = 0; i < objd_table.allocated_len; i++)
d4419b81 204 (void) lttng_ust_objd_unref(i);
f4681817 205 free(objd_table.array);
02fb3381
MD
206 objd_table.array = NULL;
207 objd_table.len = 0;
208 objd_table.allocated_len = 0;
17dfb34b 209 objd_table.freelist_head = -1;
f4681817
MD
210}
211
212/*
213 * This is LTTng's own personal way to create an ABI for sessiond.
214 * We send commands over a socket.
215 */
216
b61ce3b2
MD
217static const struct lttng_ust_objd_ops lttng_ops;
218static const struct lttng_ust_objd_ops lttng_session_ops;
219static const struct lttng_ust_objd_ops lttng_channel_ops;
220static const struct lttng_ust_objd_ops lttng_metadata_ops;
221static const struct lttng_ust_objd_ops lttng_event_ops;
e6c12e3d 222static const struct lttng_ust_objd_ops lttng_wildcard_ops;
b61ce3b2 223static const struct lttng_ust_objd_ops lib_ring_buffer_objd_ops;
51489cad 224static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops;
06d4f27e 225static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops;
f4681817
MD
226
227enum channel_type {
228 PER_CPU_CHANNEL,
229 METADATA_CHANNEL,
230};
231
46050b1a
MD
232int lttng_abi_create_root_handle(void)
233{
234 int root_handle;
235
236 root_handle = objd_alloc(NULL, &lttng_ops);
46050b1a
MD
237 return root_handle;
238}
239
818173b9 240static
f4681817
MD
241int lttng_abi_create_session(void)
242{
243 struct ltt_session *session;
244 int session_objd, ret;
245
246 session = ltt_session_create();
247 if (!session)
248 return -ENOMEM;
249 session_objd = objd_alloc(session, &lttng_session_ops);
250 if (session_objd < 0) {
251 ret = session_objd;
252 goto objd_error;
253 }
254 session->objd = session_objd;
255 return session_objd;
256
257objd_error:
258 ltt_session_destroy(session);
259 return ret;
260}
261
f4681817
MD
262static
263long lttng_abi_tracer_version(int objd,
264 struct lttng_ust_tracer_version *v)
265{
23c8854a
MD
266 v->major = LTTNG_UST_MAJOR_VERSION;
267 v->minor = LTTNG_UST_MINOR_VERSION;
268 v->patchlevel = LTTNG_UST_PATCHLEVEL_VERSION;
f4681817
MD
269 return 0;
270}
271
272static
273long lttng_abi_add_context(int objd,
274 struct lttng_ust_context *context_param,
275 struct lttng_ctx **ctx, struct ltt_session *session)
276{
277 if (session->been_active)
278 return -EPERM;
279
280 switch (context_param->ctx) {
8de38cf7
MD
281 case LTTNG_UST_CONTEXT_PTHREAD_ID:
282 return lttng_add_pthread_id_to_ctx(ctx);
3b402b40
MD
283 case LTTNG_UST_CONTEXT_VTID:
284 return lttng_add_vtid_to_ctx(ctx);
c1ef86f0
MD
285 case LTTNG_UST_CONTEXT_VPID:
286 return lttng_add_vpid_to_ctx(ctx);
4847e9bb
MD
287 case LTTNG_UST_CONTEXT_PROCNAME:
288 return lttng_add_procname_to_ctx(ctx);
f4681817
MD
289 default:
290 return -EINVAL;
291 }
292}
293
294/**
295 * lttng_cmd - lttng control through socket commands
296 *
297 * @objd: the object descriptor
298 * @cmd: the command
299 * @arg: command arg
ef9ff354 300 * @uargs: UST arguments (internal)
f4681817
MD
301 *
302 * This descriptor implements lttng commands:
303 * LTTNG_UST_SESSION
304 * Returns a LTTng trace session object descriptor
305 * LTTNG_UST_TRACER_VERSION
306 * Returns the LTTng kernel tracer version
307 * LTTNG_UST_TRACEPOINT_LIST
308 * Returns a file descriptor listing available tracepoints
06d4f27e
MD
309 * LTTNG_UST_TRACEPOINT_FIELD_LIST
310 * Returns a file descriptor listing available tracepoint fields
f4681817
MD
311 * LTTNG_UST_WAIT_QUIESCENT
312 * Returns after all previously running probes have completed
313 *
314 * The returned session will be deleted when its file descriptor is closed.
315 */
316static
ef9ff354
MD
317long lttng_cmd(int objd, unsigned int cmd, unsigned long arg,
318 union ust_args *uargs)
f4681817
MD
319{
320 switch (cmd) {
321 case LTTNG_UST_SESSION:
322 return lttng_abi_create_session();
323 case LTTNG_UST_TRACER_VERSION:
324 return lttng_abi_tracer_version(objd,
325 (struct lttng_ust_tracer_version *) arg);
326 case LTTNG_UST_TRACEPOINT_LIST:
51489cad 327 return lttng_abi_tracepoint_list();
06d4f27e
MD
328 case LTTNG_UST_TRACEPOINT_FIELD_LIST:
329 return lttng_abi_tracepoint_field_list();
f4681817
MD
330 case LTTNG_UST_WAIT_QUIESCENT:
331 synchronize_trace();
332 return 0;
333 default:
334 return -EINVAL;
335 }
336}
337
b61ce3b2 338static const struct lttng_ust_objd_ops lttng_ops = {
f4681817
MD
339 .cmd = lttng_cmd,
340};
341
342/*
343 * We tolerate no failure in this function (if one happens, we print a dmesg
344 * error, but cannot return any error, because the channel information is
345 * invariant.
346 */
347static
348void lttng_metadata_create_events(int channel_objd)
349{
350 struct ltt_channel *channel = objd_private(channel_objd);
351 static struct lttng_ust_event metadata_params = {
352 .instrumentation = LTTNG_UST_TRACEPOINT,
a4ada9b8 353 .name = "lttng_ust:metadata",
457a6b58
MD
354 .loglevel_type = LTTNG_UST_LOGLEVEL_ALL,
355 .loglevel = TRACE_DEFAULT,
f4681817
MD
356 };
357 struct ltt_event *event;
576599a0 358 int ret;
f4681817
MD
359
360 /*
361 * We tolerate no failure path after event creation. It will stay
362 * invariant for the rest of the session.
363 */
576599a0
MD
364 ret = ltt_event_create(channel, &metadata_params, NULL, &event);
365 if (ret < 0) {
f4681817
MD
366 goto create_error;
367 }
368 return;
369
370create_error:
371 WARN_ON(1);
372 return; /* not allowed to return error */
373}
374
f4681817
MD
375int lttng_abi_create_channel(int session_objd,
376 struct lttng_ust_channel *chan_param,
ef9ff354
MD
377 enum channel_type channel_type,
378 union ust_args *uargs)
f4681817
MD
379{
380 struct ltt_session *session = objd_private(session_objd);
b61ce3b2 381 const struct lttng_ust_objd_ops *ops;
f4681817
MD
382 const char *transport_name;
383 struct ltt_channel *chan;
384 int chan_objd;
385 int ret = 0;
d028eddb 386 struct ltt_channel chan_priv_init;
f4681817 387
f4681817
MD
388 switch (channel_type) {
389 case PER_CPU_CHANNEL:
390 if (chan_param->output == LTTNG_UST_MMAP) {
391 transport_name = chan_param->overwrite ?
392 "relay-overwrite-mmap" : "relay-discard-mmap";
393 } else {
394 return -EINVAL;
395 }
396 ops = &lttng_channel_ops;
397 break;
398 case METADATA_CHANNEL:
399 if (chan_param->output == LTTNG_UST_MMAP)
400 transport_name = "relay-metadata-mmap";
401 else
402 return -EINVAL;
403 ops = &lttng_metadata_ops;
404 break;
405 default:
406 transport_name = "<unknown>";
fe38d4af
MD
407 return -EINVAL;
408 }
409 chan_objd = objd_alloc(NULL, ops);
410 if (chan_objd < 0) {
411 ret = chan_objd;
412 goto objd_error;
f4681817 413 }
d028eddb
MD
414 memset(&chan_priv_init, 0, sizeof(chan_priv_init));
415 /* Copy of session UUID for consumer (availability through shm) */
416 memcpy(chan_priv_init.uuid, session->uuid, sizeof(session->uuid));
417
f4681817
MD
418 /*
419 * We tolerate no failure path after channel creation. It will stay
420 * invariant for the rest of the session.
421 */
422 chan = ltt_channel_create(session, transport_name, NULL,
423 chan_param->subbuf_size,
424 chan_param->num_subbuf,
425 chan_param->switch_timer_interval,
193183fb 426 chan_param->read_timer_interval,
ef9ff354
MD
427 &uargs->channel.shm_fd,
428 &uargs->channel.wait_fd,
429 &uargs->channel.memory_map_size,
d028eddb 430 &chan_priv_init);
f4681817
MD
431 if (!chan) {
432 ret = -EINVAL;
433 goto chan_error;
434 }
435 objd_set_private(chan_objd, chan);
436 chan->objd = chan_objd;
437 if (channel_type == METADATA_CHANNEL) {
438 session->metadata = chan;
439 lttng_metadata_create_events(chan_objd);
440 }
f4681817
MD
441 /* The channel created holds a reference on the session */
442 objd_ref(session_objd);
443
444 return chan_objd;
445
446chan_error:
1ea11eab
MD
447 {
448 int err;
449
d4419b81 450 err = lttng_ust_objd_unref(chan_objd);
1ea11eab
MD
451 assert(!err);
452 }
f4681817
MD
453objd_error:
454 return ret;
455}
456
457/**
458 * lttng_session_cmd - lttng session object command
459 *
460 * @obj: the object
461 * @cmd: the command
462 * @arg: command arg
ef9ff354 463 * @uargs: UST arguments (internal)
f4681817
MD
464 *
465 * This descriptor implements lttng commands:
466 * LTTNG_UST_CHANNEL
467 * Returns a LTTng channel object descriptor
468 * LTTNG_UST_ENABLE
469 * Enables tracing for a session (weak enable)
470 * LTTNG_UST_DISABLE
471 * Disables tracing for a session (strong disable)
472 * LTTNG_UST_METADATA
473 * Returns a LTTng metadata object descriptor
474 *
475 * The returned channel will be deleted when its file descriptor is closed.
476 */
477static
ef9ff354
MD
478long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg,
479 union ust_args *uargs)
f4681817
MD
480{
481 struct ltt_session *session = objd_private(objd);
482
483 switch (cmd) {
484 case LTTNG_UST_CHANNEL:
485 return lttng_abi_create_channel(objd,
486 (struct lttng_ust_channel *) arg,
ef9ff354 487 PER_CPU_CHANNEL, uargs);
f4681817
MD
488 case LTTNG_UST_SESSION_START:
489 case LTTNG_UST_ENABLE:
490 return ltt_session_enable(session);
491 case LTTNG_UST_SESSION_STOP:
492 case LTTNG_UST_DISABLE:
493 return ltt_session_disable(session);
494 case LTTNG_UST_METADATA:
495 return lttng_abi_create_channel(objd,
496 (struct lttng_ust_channel *) arg,
ef9ff354 497 METADATA_CHANNEL, uargs);
f4681817
MD
498 default:
499 return -EINVAL;
500 }
501}
502
503/*
504 * Called when the last file reference is dropped.
505 *
506 * Big fat note: channels and events are invariant for the whole session after
507 * their creation. So this session destruction also destroys all channel and
508 * event structures specific to this session (they are not destroyed when their
509 * individual file is released).
510 */
511static
1ea11eab 512int lttng_release_session(int objd)
f4681817
MD
513{
514 struct ltt_session *session = objd_private(objd);
515
1ea11eab 516 if (session) {
f4681817 517 ltt_session_destroy(session);
1ea11eab
MD
518 return 0;
519 } else {
520 return -EINVAL;
521 }
f4681817
MD
522}
523
b61ce3b2 524static const struct lttng_ust_objd_ops lttng_session_ops = {
1ea11eab 525 .release = lttng_release_session,
f4681817
MD
526 .cmd = lttng_session_cmd,
527};
528
51489cad 529static
ef9ff354
MD
530long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg,
531 union ust_args *uargs)
51489cad 532{
c8fcf224 533 struct lttng_ust_tracepoint_list *list = objd_private(objd);
cbef6901
MD
534 struct lttng_ust_tracepoint_iter *tp =
535 (struct lttng_ust_tracepoint_iter *) arg;
c8fcf224 536 struct lttng_ust_tracepoint_iter *iter;
51489cad
MD
537
538 switch (cmd) {
539 case LTTNG_UST_TRACEPOINT_LIST_GET:
c8fcf224
MD
540 {
541 retry:
542 iter = lttng_ust_tracepoint_list_get_iter_next(list);
543 if (!iter)
b115631f 544 return -ENOENT;
c8fcf224
MD
545 if (!strcmp(iter->name, "lttng_ust:metadata"))
546 goto retry;
547 memcpy(tp, iter, sizeof(*tp));
51489cad 548 return 0;
c8fcf224 549 }
51489cad
MD
550 default:
551 return -EINVAL;
552 }
553}
554
555static
556int lttng_abi_tracepoint_list(void)
557{
558 int list_objd, ret;
c8fcf224 559 struct lttng_ust_tracepoint_list *list;
51489cad
MD
560
561 list_objd = objd_alloc(NULL, &lttng_tracepoint_list_ops);
562 if (list_objd < 0) {
563 ret = list_objd;
564 goto objd_error;
565 }
566 list = zmalloc(sizeof(*list));
567 if (!list) {
568 ret = -ENOMEM;
569 goto alloc_error;
570 }
571 objd_set_private(list_objd, list);
572
c8fcf224
MD
573 /* populate list by walking on all registered probes. */
574 ret = ltt_probes_get_event_list(list);
575 if (ret) {
576 goto list_error;
577 }
51489cad
MD
578 return list_objd;
579
c8fcf224
MD
580list_error:
581 free(list);
51489cad
MD
582alloc_error:
583 {
584 int err;
585
586 err = lttng_ust_objd_unref(list_objd);
587 assert(!err);
588 }
589objd_error:
590 return ret;
591}
592
593static
594int lttng_release_tracepoint_list(int objd)
595{
c8fcf224 596 struct lttng_ust_tracepoint_list *list = objd_private(objd);
51489cad
MD
597
598 if (list) {
c8fcf224 599 ltt_probes_prune_event_list(list);
51489cad
MD
600 free(list);
601 return 0;
602 } else {
603 return -EINVAL;
604 }
605}
606
607static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops = {
608 .release = lttng_release_tracepoint_list,
609 .cmd = lttng_tracepoint_list_cmd,
610};
611
06d4f27e
MD
612static
613long lttng_tracepoint_field_list_cmd(int objd, unsigned int cmd,
614 unsigned long arg, union ust_args *uargs)
615{
616 struct lttng_ust_field_list *list = objd_private(objd);
617 struct lttng_ust_field_iter *tp =
618 (struct lttng_ust_field_iter *) arg;
619 struct lttng_ust_field_iter *iter;
620
621 switch (cmd) {
622 case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET:
623 {
624 retry:
625 iter = lttng_ust_field_list_get_iter_next(list);
626 if (!iter)
627 return -ENOENT;
628 if (!strcmp(iter->event_name, "lttng_ust:metadata"))
629 goto retry;
630 memcpy(tp, iter, sizeof(*tp));
631 return 0;
632 }
633 default:
634 return -EINVAL;
635 }
636}
637
638static
639int lttng_abi_tracepoint_field_list(void)
640{
641 int list_objd, ret;
642 struct lttng_ust_field_list *list;
643
644 list_objd = objd_alloc(NULL, &lttng_tracepoint_field_list_ops);
645 if (list_objd < 0) {
646 ret = list_objd;
647 goto objd_error;
648 }
649 list = zmalloc(sizeof(*list));
650 if (!list) {
651 ret = -ENOMEM;
652 goto alloc_error;
653 }
654 objd_set_private(list_objd, list);
655
656 /* populate list by walking on all registered probes. */
657 ret = ltt_probes_get_field_list(list);
658 if (ret) {
659 goto list_error;
660 }
661 return list_objd;
662
663list_error:
664 free(list);
665alloc_error:
666 {
667 int err;
668
669 err = lttng_ust_objd_unref(list_objd);
670 assert(!err);
671 }
672objd_error:
673 return ret;
674}
675
676static
677int lttng_release_tracepoint_field_list(int objd)
678{
679 struct lttng_ust_field_list *list = objd_private(objd);
680
681 if (list) {
682 ltt_probes_prune_field_list(list);
683 free(list);
684 return 0;
685 } else {
686 return -EINVAL;
687 }
688}
689
690static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops = {
691 .release = lttng_release_tracepoint_field_list,
692 .cmd = lttng_tracepoint_field_list_cmd,
693};
694
381c0f1e 695struct stream_priv_data {
4cfec15c 696 struct lttng_ust_lib_ring_buffer *buf;
381c0f1e
MD
697 struct ltt_channel *ltt_chan;
698};
699
f4681817 700static
ef9ff354
MD
701int lttng_abi_open_stream(int channel_objd, struct lttng_ust_stream *info,
702 union ust_args *uargs)
f4681817
MD
703{
704 struct ltt_channel *channel = objd_private(channel_objd);
4cfec15c 705 struct lttng_ust_lib_ring_buffer *buf;
381c0f1e 706 struct stream_priv_data *priv;
f4681817
MD
707 int stream_objd, ret;
708
381c0f1e 709 buf = channel->ops->buffer_read_open(channel->chan, channel->handle,
ef9ff354
MD
710 &uargs->stream.shm_fd,
711 &uargs->stream.wait_fd,
712 &uargs->stream.memory_map_size);
f4681817
MD
713 if (!buf)
714 return -ENOENT;
715
381c0f1e
MD
716 priv = zmalloc(sizeof(*priv));
717 if (!priv) {
718 ret = -ENOMEM;
719 goto alloc_error;
720 }
721 priv->buf = buf;
722 priv->ltt_chan = channel;
723 stream_objd = objd_alloc(priv, &lib_ring_buffer_objd_ops);
f4681817
MD
724 if (stream_objd < 0) {
725 ret = stream_objd;
726 goto objd_error;
727 }
381c0f1e
MD
728 /* Hold a reference on the channel object descriptor */
729 objd_ref(channel_objd);
f4681817
MD
730 return stream_objd;
731
732objd_error:
381c0f1e
MD
733 free(priv);
734alloc_error:
735 channel->ops->buffer_read_close(buf, channel->handle);
f4681817
MD
736 return ret;
737}
f4681817
MD
738
739static
740int lttng_abi_create_event(int channel_objd,
741 struct lttng_ust_event *event_param)
742{
743 struct ltt_channel *channel = objd_private(channel_objd);
744 struct ltt_event *event;
745 int event_objd, ret;
746
747 event_param->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
748 event_objd = objd_alloc(NULL, &lttng_event_ops);
749 if (event_objd < 0) {
750 ret = event_objd;
751 goto objd_error;
752 }
753 /*
754 * We tolerate no failure path after event creation. It will stay
755 * invariant for the rest of the session.
756 */
576599a0
MD
757 ret = ltt_event_create(channel, event_param, NULL, &event);
758 if (ret < 0) {
f4681817
MD
759 goto event_error;
760 }
761 objd_set_private(event_objd, event);
762 /* The event holds a reference on the channel */
763 objd_ref(channel_objd);
764 return event_objd;
765
766event_error:
1ea11eab
MD
767 {
768 int err;
769
d4419b81 770 err = lttng_ust_objd_unref(event_objd);
1ea11eab
MD
771 assert(!err);
772 }
f4681817
MD
773objd_error:
774 return ret;
775}
776
e6c12e3d
MD
777static
778int lttng_abi_create_wildcard(int channel_objd,
779 struct lttng_ust_event *event_param)
780{
781 struct ltt_channel *channel = objd_private(channel_objd);
782 struct session_wildcard *wildcard;
783 int wildcard_objd, ret;
784
785 event_param->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
786 wildcard_objd = objd_alloc(NULL, &lttng_wildcard_ops);
787 if (wildcard_objd < 0) {
788 ret = wildcard_objd;
789 goto objd_error;
790 }
791 /*
792 * We tolerate no failure path after wildcard creation. It will
793 * stay invariant for the rest of the session.
794 */
795 ret = ltt_wildcard_create(channel, event_param, &wildcard);
796 if (ret < 0) {
797 goto wildcard_error;
798 }
799 objd_set_private(wildcard_objd, wildcard);
800 /* The wildcard holds a reference on the channel */
801 objd_ref(channel_objd);
802 return wildcard_objd;
803
804wildcard_error:
805 {
806 int err;
807
808 err = lttng_ust_objd_unref(wildcard_objd);
809 assert(!err);
810 }
811objd_error:
812 return ret;
813}
814
f4681817
MD
815/**
816 * lttng_channel_cmd - lttng control through object descriptors
817 *
818 * @objd: the object descriptor
819 * @cmd: the command
820 * @arg: command arg
ef9ff354 821 * @uargs: UST arguments (internal)
f4681817
MD
822 *
823 * This object descriptor implements lttng commands:
824 * LTTNG_UST_STREAM
825 * Returns an event stream object descriptor or failure.
826 * (typically, one event stream records events from one CPU)
827 * LTTNG_UST_EVENT
828 * Returns an event object descriptor or failure.
829 * LTTNG_UST_CONTEXT
830 * Prepend a context field to each event in the channel
831 * LTTNG_UST_ENABLE
832 * Enable recording for events in this channel (weak enable)
833 * LTTNG_UST_DISABLE
834 * Disable recording for events in this channel (strong disable)
835 *
836 * Channel and event file descriptors also hold a reference on the session.
837 */
838static
ef9ff354
MD
839long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg,
840 union ust_args *uargs)
f4681817
MD
841{
842 struct ltt_channel *channel = objd_private(objd);
843
844 switch (cmd) {
845 case LTTNG_UST_STREAM:
381c0f1e
MD
846 {
847 struct lttng_ust_stream *stream;
848
849 stream = (struct lttng_ust_stream *) arg;
850 /* stream used as output */
ef9ff354 851 return lttng_abi_open_stream(objd, stream, uargs);
381c0f1e 852 }
f4681817 853 case LTTNG_UST_EVENT:
1f18504e
MD
854 {
855 struct lttng_ust_event *event_param =
856 (struct lttng_ust_event *) arg;
6b0e60f1
MD
857 if (event_param->name[strlen(event_param->name) - 1] == '*') {
858 /* If ends with wildcard, create wildcard. */
859 return lttng_abi_create_wildcard(objd, event_param);
1f18504e 860 } else {
6b0e60f1 861 return lttng_abi_create_event(objd, event_param);
1f18504e
MD
862 }
863 }
f4681817
MD
864 case LTTNG_UST_CONTEXT:
865 return lttng_abi_add_context(objd,
866 (struct lttng_ust_context *) arg,
867 &channel->ctx, channel->session);
868 case LTTNG_UST_ENABLE:
869 return ltt_channel_enable(channel);
870 case LTTNG_UST_DISABLE:
871 return ltt_channel_disable(channel);
43d330a4
MD
872 case LTTNG_UST_FLUSH_BUFFER:
873 return channel->ops->flush_buffer(channel->chan, channel->handle);
f4681817
MD
874 default:
875 return -EINVAL;
876 }
877}
878
879/**
880 * lttng_metadata_cmd - lttng control through object descriptors
881 *
882 * @objd: the object descriptor
883 * @cmd: the command
884 * @arg: command arg
ef9ff354 885 * @uargs: UST arguments (internal)
f4681817
MD
886 *
887 * This object descriptor implements lttng commands:
888 * LTTNG_UST_STREAM
889 * Returns an event stream file descriptor or failure.
890 *
891 * Channel and event file descriptors also hold a reference on the session.
892 */
893static
ef9ff354
MD
894long lttng_metadata_cmd(int objd, unsigned int cmd, unsigned long arg,
895 union ust_args *uargs)
f4681817 896{
43861eab
MD
897 struct ltt_channel *channel = objd_private(objd);
898
f4681817
MD
899 switch (cmd) {
900 case LTTNG_UST_STREAM:
381c0f1e
MD
901 {
902 struct lttng_ust_stream *stream;
903
904 stream = (struct lttng_ust_stream *) arg;
905 /* stream used as output */
ef9ff354 906 return lttng_abi_open_stream(objd, stream, uargs);
381c0f1e 907 }
43d330a4
MD
908 case LTTNG_UST_FLUSH_BUFFER:
909 return channel->ops->flush_buffer(channel->chan, channel->handle);
f4681817
MD
910 default:
911 return -EINVAL;
912 }
913}
914
915#if 0
916/**
917 * lttng_channel_poll - lttng stream addition/removal monitoring
918 *
919 * @file: the file
920 * @wait: poll table
921 */
922unsigned int lttng_channel_poll(struct file *file, poll_table *wait)
923{
924 struct ltt_channel *channel = file->private_data;
925 unsigned int mask = 0;
926
927 if (file->f_mode & FMODE_READ) {
928 poll_wait_set_exclusive(wait);
929 poll_wait(file, channel->ops->get_hp_wait_queue(channel->chan),
930 wait);
931
932 if (channel->ops->is_disabled(channel->chan))
933 return POLLERR;
934 if (channel->ops->is_finalized(channel->chan))
935 return POLLHUP;
936 if (channel->ops->buffer_has_read_closed_stream(channel->chan))
937 return POLLIN | POLLRDNORM;
938 return 0;
939 }
940 return mask;
941
942}
943#endif //0
944
945static
946int lttng_channel_release(int objd)
947{
948 struct ltt_channel *channel = objd_private(objd);
949
950 if (channel)
d4419b81 951 return lttng_ust_objd_unref(channel->session->objd);
f4681817
MD
952 return 0;
953}
954
b61ce3b2 955static const struct lttng_ust_objd_ops lttng_channel_ops = {
f4681817
MD
956 .release = lttng_channel_release,
957 //.poll = lttng_channel_poll,
958 .cmd = lttng_channel_cmd,
959};
960
b61ce3b2 961static const struct lttng_ust_objd_ops lttng_metadata_ops = {
f4681817
MD
962 .release = lttng_channel_release,
963 .cmd = lttng_metadata_cmd,
964};
965
381c0f1e
MD
966/**
967 * lttng_rb_cmd - lttng ring buffer control through object descriptors
968 *
969 * @objd: the object descriptor
970 * @cmd: the command
971 * @arg: command arg
ef9ff354 972 * @uargs: UST arguments (internal)
381c0f1e
MD
973 *
974 * This object descriptor implements lttng commands:
975 * (None for now. Access is done directly though shm.)
381c0f1e
MD
976 */
977static
ef9ff354
MD
978long lttng_rb_cmd(int objd, unsigned int cmd, unsigned long arg,
979 union ust_args *uargs)
381c0f1e 980{
381c0f1e
MD
981 switch (cmd) {
982 default:
983 return -EINVAL;
984 }
985}
986
987static
988int lttng_rb_release(int objd)
989{
990 struct stream_priv_data *priv = objd_private(objd);
4cfec15c 991 struct lttng_ust_lib_ring_buffer *buf;
381c0f1e
MD
992 struct ltt_channel *channel;
993
994 if (priv) {
995 buf = priv->buf;
996 channel = priv->ltt_chan;
997 free(priv);
45e9e699
MD
998 /*
999 * If we are at ABI exit, we don't want to close the
1000 * buffer opened for read: it is being shared between
1001 * the parent and child (right after fork), and we don't
1002 * want the child to close it for the parent. For a real
1003 * exit, we don't care about marking it as closed, as
1004 * the consumer daemon (if there is one) will do fine
1005 * even if we don't mark it as "closed" for reading on
1006 * our side.
1007 * We only mark it as closed if it is being explicitely
1008 * released by the session daemon with an explicit
1009 * release command.
1010 */
1011 if (!lttng_ust_abi_close_in_progress)
1012 channel->ops->buffer_read_close(buf, channel->handle);
381c0f1e 1013
d4419b81 1014 return lttng_ust_objd_unref(channel->objd);
381c0f1e
MD
1015 }
1016 return 0;
1017}
1018
b61ce3b2 1019static const struct lttng_ust_objd_ops lib_ring_buffer_objd_ops = {
381c0f1e
MD
1020 .release = lttng_rb_release,
1021 .cmd = lttng_rb_cmd,
1022};
1023
f4681817
MD
1024/**
1025 * lttng_event_cmd - lttng control through object descriptors
1026 *
1027 * @objd: the object descriptor
1028 * @cmd: the command
1029 * @arg: command arg
ef9ff354 1030 * @uargs: UST arguments (internal)
f4681817
MD
1031 *
1032 * This object descriptor implements lttng commands:
1033 * LTTNG_UST_CONTEXT
1034 * Prepend a context field to each record of this event
1035 * LTTNG_UST_ENABLE
1036 * Enable recording for this event (weak enable)
1037 * LTTNG_UST_DISABLE
1038 * Disable recording for this event (strong disable)
1039 */
1040static
ef9ff354
MD
1041long lttng_event_cmd(int objd, unsigned int cmd, unsigned long arg,
1042 union ust_args *uargs)
f4681817
MD
1043{
1044 struct ltt_event *event = objd_private(objd);
1045
1046 switch (cmd) {
1047 case LTTNG_UST_CONTEXT:
1048 return lttng_abi_add_context(objd,
1049 (struct lttng_ust_context *) arg,
1050 &event->ctx, event->chan->session);
1051 case LTTNG_UST_ENABLE:
1052 return ltt_event_enable(event);
1053 case LTTNG_UST_DISABLE:
1054 return ltt_event_disable(event);
1055 default:
1056 return -EINVAL;
1057 }
1058}
1059
1060static
1061int lttng_event_release(int objd)
1062{
1063 struct ltt_event *event = objd_private(objd);
1064
1065 if (event)
d4419b81 1066 return lttng_ust_objd_unref(event->chan->objd);
f4681817
MD
1067 return 0;
1068}
1069
1070/* TODO: filter control ioctl */
b61ce3b2 1071static const struct lttng_ust_objd_ops lttng_event_ops = {
f4681817
MD
1072 .release = lttng_event_release,
1073 .cmd = lttng_event_cmd,
1074};
1075
e6c12e3d
MD
1076/**
1077 * lttng_wildcard_cmd - lttng control through object descriptors
1078 *
1079 * @objd: the object descriptor
1080 * @cmd: the command
1081 * @arg: command arg
ef9ff354 1082 * @uargs: UST arguments (internal)
e6c12e3d
MD
1083 *
1084 * This object descriptor implements lttng commands:
1085 * LTTNG_UST_CONTEXT
1086 * Prepend a context field to each record of events of this
1087 * wildcard.
1088 * LTTNG_UST_ENABLE
1089 * Enable recording for these wildcard events (weak enable)
1090 * LTTNG_UST_DISABLE
1091 * Disable recording for these wildcard events (strong disable)
1092 */
1093static
ef9ff354
MD
1094long lttng_wildcard_cmd(int objd, unsigned int cmd, unsigned long arg,
1095 union ust_args *uargs)
e6c12e3d
MD
1096{
1097 struct session_wildcard *wildcard = objd_private(objd);
1098
1099 switch (cmd) {
1100 case LTTNG_UST_CONTEXT:
1101 return -ENOSYS; /* not implemented yet */
1102#if 0
1103 return lttng_abi_add_context(objd,
1104 (struct lttng_ust_context *) arg,
1105 &wildcard->ctx, wildcard->chan->session);
1106#endif
1107 case LTTNG_UST_ENABLE:
1108 return ltt_wildcard_enable(wildcard);
1109 case LTTNG_UST_DISABLE:
1110 return ltt_wildcard_disable(wildcard);
1111 default:
1112 return -EINVAL;
1113 }
1114}
1115
1116static
1117int lttng_wildcard_release(int objd)
1118{
1119 struct session_wildcard *wildcard = objd_private(objd);
1120
1121 if (wildcard)
1122 return lttng_ust_objd_unref(wildcard->chan->objd);
1123 return 0;
1124}
1125
1126/* TODO: filter control ioctl */
1127static const struct lttng_ust_objd_ops lttng_wildcard_ops = {
1128 .release = lttng_wildcard_release,
1129 .cmd = lttng_wildcard_cmd,
1130};
1131
b35d179d 1132void lttng_ust_abi_exit(void)
f4681817 1133{
45e9e699 1134 lttng_ust_abi_close_in_progress = 1;
f4681817 1135 objd_table_destroy();
45e9e699 1136 lttng_ust_abi_close_in_progress = 0;
f4681817 1137}
This page took 0.075016 seconds and 4 git commands to generate.