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