liblttng-ust/lttng-ust-abi.c

   1 /*
   2  * lttng-ust-abi.c
   3  *
   4  * LTTng UST ABI
   5  *
   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  *
  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.
  38  */
  39
  40 #include <lttng/ust-abi.h>
  41 #include <lttng/ust-error.h>
  42 #include <urcu/compiler.h>
  43 #include <urcu/list.h>
  44 #include <lttng/ust-events.h>
  45 #include <lttng/ust-version.h>
  46 #include <lttng/tracepoint.h>
  47 #include "tracepoint-internal.h"
  48 #include <usterr-signal-safe.h>
  49 #include <helper.h>
  50 #include "lttng-tracer.h"
  51 #include "../libringbuffer/shm.h"
  52 #include "../libringbuffer/frontend_types.h"
  53
  54 #define OBJ_NAME_LEN    16
  55
  56 static int lttng_ust_abi_close_in_progress;
  57
  58 static
  59 int lttng_abi_tracepoint_list(void *owner);
  60 static
  61 int lttng_abi_tracepoint_field_list(void *owner);
  62
  63 /*
  64  * Object descriptor table. Should be protected from concurrent access
  65  * by the caller.
  66  */
  67
  68 struct lttng_ust_obj {
  69         union {
  70                 struct {
  71                         void *private_data;
  72                         const struct lttng_ust_objd_ops *ops;
  73                         int f_count;
  74                         int owner_ref;  /* has ref from owner */
  75                         void *owner;
  76                         char name[OBJ_NAME_LEN];
  77                 } s;
  78                 int freelist_next;      /* offset freelist. end is -1. */
  79         } u;
  80 };
  81
  82 struct lttng_ust_objd_table {
  83         struct lttng_ust_obj *array;
  84         unsigned int len, allocated_len;
  85         int freelist_head;              /* offset freelist head. end is -1 */
  86 };
  87
  88 static struct lttng_ust_objd_table objd_table = {
  89         .freelist_head = -1,
  90 };
  91
  92 static
  93 int objd_alloc(void *private_data, const struct lttng_ust_objd_ops *ops,
  94                 void *owner, const char *name)
  95 {
  96         struct lttng_ust_obj *obj;
  97
  98         if (objd_table.freelist_head != -1) {
  99                 obj = &objd_table.array[objd_table.freelist_head];
 100                 objd_table.freelist_head = obj->u.freelist_next;
 101                 goto end;
 102         }
 103
 104         if (objd_table.len >= objd_table.allocated_len) {
 105                 unsigned int new_allocated_len, old_allocated_len;
 106                 struct lttng_ust_obj *new_table, *old_table;
 107
 108                 old_allocated_len = objd_table.allocated_len;
 109                 old_table = objd_table.array;
 110                 if (!old_allocated_len)
 111                         new_allocated_len = 1;
 112                 else
 113                         new_allocated_len = old_allocated_len << 1;
 114                 new_table = zmalloc(sizeof(struct lttng_ust_obj) * new_allocated_len);
 115                 if (!new_table)
 116                         return -ENOMEM;
 117                 memcpy(new_table, old_table,
 118                        sizeof(struct lttng_ust_obj) * old_allocated_len);
 119                 free(old_table);
 120                 objd_table.array = new_table;
 121                 objd_table.allocated_len = new_allocated_len;
 122         }
 123         obj = &objd_table.array[objd_table.len];
 124         objd_table.len++;
 125 end:
 126         obj->u.s.private_data = private_data;
 127         obj->u.s.ops = ops;
 128         obj->u.s.f_count = 2;   /* count == 1 : object is allocated */
 129                                 /* count == 2 : allocated + hold ref */
 130         obj->u.s.owner_ref = 1; /* One owner reference */
 131         obj->u.s.owner = owner;
 132         strncpy(obj->u.s.name, name, OBJ_NAME_LEN);
 133         obj->u.s.name[OBJ_NAME_LEN - 1] = '\0';
 134         return obj - objd_table.array;
 135 }
 136
 137 static
 138 struct lttng_ust_obj *_objd_get(int id)
 139 {
 140         if (id >= objd_table.len)
 141                 return NULL;
 142         if (!objd_table.array[id].u.s.f_count)
 143                 return NULL;
 144         return &objd_table.array[id];
 145 }
 146
 147 static
 148 void *objd_private(int id)
 149 {
 150         struct lttng_ust_obj *obj = _objd_get(id);
 151         assert(obj);
 152         return obj->u.s.private_data;
 153 }
 154
 155 static
 156 void objd_set_private(int id, void *private_data)
 157 {
 158         struct lttng_ust_obj *obj = _objd_get(id);
 159         assert(obj);
 160         obj->u.s.private_data = private_data;
 161 }
 162
 163 const struct lttng_ust_objd_ops *objd_ops(int id)
 164 {
 165         struct lttng_ust_obj *obj = _objd_get(id);
 166
 167         if (!obj)
 168                 return NULL;
 169         return obj->u.s.ops;
 170 }
 171
 172 static
 173 void objd_free(int id)
 174 {
 175         struct lttng_ust_obj *obj = _objd_get(id);
 176
 177         assert(obj);
 178         obj->u.freelist_next = objd_table.freelist_head;
 179         objd_table.freelist_head = obj - objd_table.array;
 180         assert(obj->u.s.f_count == 1);
 181         obj->u.s.f_count = 0;   /* deallocated */
 182 }
 183
 184 static
 185 void objd_ref(int id)
 186 {
 187         struct lttng_ust_obj *obj = _objd_get(id);
 188         assert(obj != NULL);
 189         obj->u.s.f_count++;
 190 }
 191
 192 int lttng_ust_objd_unref(int id, int is_owner)
 193 {
 194         struct lttng_ust_obj *obj = _objd_get(id);
 195
 196         if (!obj)
 197                 return -EINVAL;
 198         if (obj->u.s.f_count == 1) {
 199                 ERR("Reference counting error\n");
 200                 return -EINVAL;
 201         }
 202         if (is_owner) {
 203                 if (!obj->u.s.owner_ref) {
 204                         ERR("Error decrementing owner reference");
 205                         return -EINVAL;
 206                 }
 207                 obj->u.s.owner_ref--;
 208         }
 209         if ((--obj->u.s.f_count) == 1) {
 210                 const struct lttng_ust_objd_ops *ops = objd_ops(id);
 211
 212                 if (ops->release)
 213                         ops->release(id);
 214                 objd_free(id);
 215         }
 216         return 0;
 217 }
 218
 219 static
 220 void objd_table_destroy(void)
 221 {
 222         int i;
 223
 224         for (i = 0; i < objd_table.allocated_len; i++) {
 225                 struct lttng_ust_obj *obj;
 226
 227                 obj = _objd_get(i);
 228                 if (!obj)
 229                         continue;
 230                 if (!obj->u.s.owner_ref)
 231                         continue;       /* only unref owner ref. */
 232                 (void) lttng_ust_objd_unref(i, 1);
 233         }
 234         free(objd_table.array);
 235         objd_table.array = NULL;
 236         objd_table.len = 0;
 237         objd_table.allocated_len = 0;
 238         objd_table.freelist_head = -1;
 239 }
 240
 241 const char *lttng_ust_obj_get_name(int id)
 242 {
 243         struct lttng_ust_obj *obj = _objd_get(id);
 244
 245         if (!obj)
 246                 return NULL;
 247         return obj->u.s.name;
 248 }
 249
 250 void lttng_ust_objd_table_owner_cleanup(void *owner)
 251 {
 252         int i;
 253
 254         for (i = 0; i < objd_table.allocated_len; i++) {
 255                 struct lttng_ust_obj *obj;
 256
 257                 obj = _objd_get(i);
 258                 if (!obj)
 259                         continue;
 260                 if (!obj->u.s.owner)
 261                         continue;       /* skip root handles */
 262                 if (!obj->u.s.owner_ref)
 263                         continue;       /* only unref owner ref. */
 264                 if (obj->u.s.owner == owner)
 265                         (void) lttng_ust_objd_unref(i, 1);
 266         }
 267 }
 268
 269 /*
 270  * This is LTTng's own personal way to create an ABI for sessiond.
 271  * We send commands over a socket.
 272  */
 273
 274 static const struct lttng_ust_objd_ops lttng_ops;
 275 static const struct lttng_ust_objd_ops lttng_session_ops;
 276 static const struct lttng_ust_objd_ops lttng_channel_ops;
 277 static const struct lttng_ust_objd_ops lttng_enabler_ops;
 278 static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops;
 279 static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops;
 280
 281 int lttng_abi_create_root_handle(void)
 282 {
 283         int root_handle;
 284
 285         /* root handles have NULL owners */
 286         root_handle = objd_alloc(NULL, &lttng_ops, NULL, "root");
 287         return root_handle;
 288 }
 289
 290 static
 291 int lttng_is_channel_ready(struct lttng_channel *lttng_chan)
 292 {
 293         struct channel *chan;
 294         unsigned int nr_streams, exp_streams;
 295
 296         chan = lttng_chan->chan;
 297         nr_streams = channel_handle_get_nr_streams(lttng_chan->handle);
 298         exp_streams = chan->nr_streams;
 299         return nr_streams == exp_streams;
 300 }
 301
 302 static
 303 int lttng_abi_create_session(void *owner)
 304 {
 305         struct lttng_session *session;
 306         int session_objd, ret;
 307
 308         session = lttng_session_create();
 309         if (!session)
 310                 return -ENOMEM;
 311         session_objd = objd_alloc(session, &lttng_session_ops, owner, "session");
 312         if (session_objd < 0) {
 313                 ret = session_objd;
 314                 goto objd_error;
 315         }
 316         session->objd = session_objd;
 317         session->owner = owner;
 318         return session_objd;
 319
 320 objd_error:
 321         lttng_session_destroy(session);
 322         return ret;
 323 }
 324
 325 static
 326 long lttng_abi_tracer_version(int objd,
 327         struct lttng_ust_tracer_version *v)
 328 {
 329         v->major = LTTNG_UST_MAJOR_VERSION;
 330         v->minor = LTTNG_UST_MINOR_VERSION;
 331         v->patchlevel = LTTNG_UST_PATCHLEVEL_VERSION;
 332         return 0;
 333 }
 334
 335 static
 336 long lttng_abi_add_context(int objd,
 337         struct lttng_ust_context *context_param,
 338         struct lttng_ctx **ctx, struct lttng_session *session)
 339 {
 340         return lttng_attach_context(context_param, ctx, session);
 341 }
 342
 343 /**
 344  *      lttng_cmd - lttng control through socket commands
 345  *
 346  *      @objd: the object descriptor
 347  *      @cmd: the command
 348  *      @arg: command arg
 349  *      @uargs: UST arguments (internal)
 350  *      @owner: objd owner
 351  *
 352  *      This descriptor implements lttng commands:
 353  *      LTTNG_UST_SESSION
 354  *              Returns a LTTng trace session object descriptor
 355  *      LTTNG_UST_TRACER_VERSION
 356  *              Returns the LTTng kernel tracer version
 357  *      LTTNG_UST_TRACEPOINT_LIST
 358  *              Returns a file descriptor listing available tracepoints
 359  *      LTTNG_UST_TRACEPOINT_FIELD_LIST
 360  *              Returns a file descriptor listing available tracepoint fields
 361  *      LTTNG_UST_WAIT_QUIESCENT
 362  *              Returns after all previously running probes have completed
 363  *
 364  * The returned session will be deleted when its file descriptor is closed.
 365  */
 366 static
 367 long lttng_cmd(int objd, unsigned int cmd, unsigned long arg,
 368         union ust_args *uargs, void *owner)
 369 {
 370         switch (cmd) {
 371         case LTTNG_UST_SESSION:
 372                 return lttng_abi_create_session(owner);
 373         case LTTNG_UST_TRACER_VERSION:
 374                 return lttng_abi_tracer_version(objd,
 375                                 (struct lttng_ust_tracer_version *) arg);
 376         case LTTNG_UST_TRACEPOINT_LIST:
 377                 return lttng_abi_tracepoint_list(owner);
 378         case LTTNG_UST_TRACEPOINT_FIELD_LIST:
 379                 return lttng_abi_tracepoint_field_list(owner);
 380         case LTTNG_UST_WAIT_QUIESCENT:
 381                 synchronize_trace();
 382                 return 0;
 383         default:
 384                 return -EINVAL;
 385         }
 386 }
 387
 388 static const struct lttng_ust_objd_ops lttng_ops = {
 389         .cmd = lttng_cmd,
 390 };
 391
 392 int lttng_abi_map_channel(int session_objd,
 393                 struct lttng_ust_channel *ust_chan,
 394                 union ust_args *uargs,
 395                 void *owner)
 396 {
 397         struct lttng_session *session = objd_private(session_objd);
 398         const char *transport_name;
 399         const struct lttng_transport *transport;
 400         const char *chan_name;
 401         int chan_objd;
 402         struct lttng_ust_shm_handle *channel_handle;
 403         struct lttng_channel *lttng_chan;
 404         struct channel *chan;
 405         struct lttng_ust_lib_ring_buffer_config *config;
 406         void *chan_data;
 407         int wakeup_fd;
 408         uint64_t len;
 409         int ret;
 410         enum lttng_ust_chan_type type;
 411
 412         chan_data = uargs->channel.chan_data;
 413         wakeup_fd = uargs->channel.wakeup_fd;
 414         len = ust_chan->len;
 415         type = ust_chan->type;
 416
 417         switch (type) {
 418         case LTTNG_UST_CHAN_PER_CPU:
 419                 break;
 420         default:
 421                 ret = -EINVAL;
 422                 goto invalid;
 423         }
 424
 425         if (session->been_active) {
 426                 ret = -EBUSY;
 427                 goto active;    /* Refuse to add channel to active session */
 428         }
 429
 430         channel_handle = channel_handle_create(chan_data, len, wakeup_fd);
 431         if (!channel_handle) {
 432                 ret = -EINVAL;
 433                 goto handle_error;
 434         }
 435
 436         chan = shmp(channel_handle, channel_handle->chan);
 437         assert(chan);
 438         chan->handle = channel_handle;
 439         config = &chan->backend.config;
 440         lttng_chan = channel_get_private(chan);
 441         if (!lttng_chan) {
 442                 ret = -EINVAL;
 443                 goto alloc_error;
 444         }
 445
 446         /* Lookup transport name */
 447         switch (type) {
 448         case LTTNG_UST_CHAN_PER_CPU:
 449                 if (config->output == RING_BUFFER_MMAP) {
 450                         if (config->mode == RING_BUFFER_OVERWRITE) {
 451                                 if (config->wakeup == RING_BUFFER_WAKEUP_BY_WRITER) {
 452                                         transport_name = "relay-overwrite-mmap";
 453                                 } else {
 454                                         transport_name = "relay-overwrite-rt-mmap";
 455                                 }
 456                         } else {
 457                                 if (config->wakeup == RING_BUFFER_WAKEUP_BY_WRITER) {
 458                                         transport_name = "relay-discard-mmap";
 459                                 } else {
 460                                         transport_name = "relay-discard-rt-mmap";
 461                                 }
 462                         }
 463                 } else {
 464                         ret = -EINVAL;
 465                         goto notransport;
 466                 }
 467                 chan_name = "channel";
 468                 break;
 469         default:
 470                 ret = -EINVAL;
 471                 goto notransport;
 472         }
 473         transport = lttng_transport_find(transport_name);
 474         if (!transport) {
 475                 DBG("LTTng transport %s not found\n",
 476                        transport_name);
 477                 ret = -EINVAL;
 478                 goto notransport;
 479         }
 480
 481         chan_objd = objd_alloc(NULL, &lttng_channel_ops, owner, chan_name);
 482         if (chan_objd < 0) {
 483                 ret = chan_objd;
 484                 goto objd_error;
 485         }
 486
 487         /* Initialize our lttng chan */
 488         lttng_chan->chan = chan;
 489         lttng_chan->tstate = 1;
 490         lttng_chan->enabled = 1;
 491         lttng_chan->ctx = NULL;
 492         lttng_chan->session = session;
 493         lttng_chan->ops = &transport->ops;
 494         memcpy(&lttng_chan->chan->backend.config,
 495                 transport->client_config,
 496                 sizeof(lttng_chan->chan->backend.config));
 497         cds_list_add(&lttng_chan->node, &session->chan_head);
 498         lttng_chan->header_type = 0;
 499         lttng_chan->handle = channel_handle;
 500         lttng_chan->type = type;
 501
 502         /*
 503          * We tolerate no failure path after channel creation. It will stay
 504          * invariant for the rest of the session.
 505          */
 506         objd_set_private(chan_objd, lttng_chan);
 507         lttng_chan->objd = chan_objd;
 508         /* The channel created holds a reference on the session */
 509         objd_ref(session_objd);
 510         return chan_objd;
 511
 512         /* error path after channel was created */
 513 objd_error:
 514 notransport:
 515 alloc_error:
 516         channel_destroy(chan, channel_handle, 0);
 517         return ret;
 518
 519         /*
 520          * error path before channel creation (owning chan_data and
 521          * wakeup_fd).
 522          */
 523 handle_error:
 524 active:
 525 invalid:
 526         {
 527                 int close_ret;
 528
 529                 close_ret = close(wakeup_fd);
 530                 if (close_ret) {
 531                         PERROR("close");
 532                 }
 533         }
 534         free(chan_data);
 535         return ret;
 536 }
 537
 538 /**
 539  *      lttng_session_cmd - lttng session object command
 540  *
 541  *      @obj: the object
 542  *      @cmd: the command
 543  *      @arg: command arg
 544  *      @uargs: UST arguments (internal)
 545  *      @owner: objd owner
 546  *
 547  *      This descriptor implements lttng commands:
 548  *      LTTNG_UST_CHANNEL
 549  *              Returns a LTTng channel object descriptor
 550  *      LTTNG_UST_ENABLE
 551  *              Enables tracing for a session (weak enable)
 552  *      LTTNG_UST_DISABLE
 553  *              Disables tracing for a session (strong disable)
 554  *
 555  * The returned channel will be deleted when its file descriptor is closed.
 556  */
 557 static
 558 long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg,
 559         union ust_args *uargs, void *owner)
 560 {
 561         struct lttng_session *session = objd_private(objd);
 562
 563         switch (cmd) {
 564         case LTTNG_UST_CHANNEL:
 565                 return lttng_abi_map_channel(objd,
 566                                 (struct lttng_ust_channel *) arg,
 567                                 uargs, owner);
 568         case LTTNG_UST_SESSION_START:
 569         case LTTNG_UST_ENABLE:
 570                 return lttng_session_enable(session);
 571         case LTTNG_UST_SESSION_STOP:
 572         case LTTNG_UST_DISABLE:
 573                 return lttng_session_disable(session);
 574         default:
 575                 return -EINVAL;
 576         }
 577 }
 578
 579 /*
 580  * Called when the last file reference is dropped.
 581  *
 582  * Big fat note: channels and events are invariant for the whole session after
 583  * their creation. So this session destruction also destroys all channel and
 584  * event structures specific to this session (they are not destroyed when their
 585  * individual file is released).
 586  */
 587 static
 588 int lttng_release_session(int objd)
 589 {
 590         struct lttng_session *session = objd_private(objd);
 591
 592         if (session) {
 593                 lttng_session_destroy(session);
 594                 return 0;
 595         } else {
 596                 return -EINVAL;
 597         }
 598 }
 599
 600 static const struct lttng_ust_objd_ops lttng_session_ops = {
 601         .release = lttng_release_session,
 602         .cmd = lttng_session_cmd,
 603 };
 604
 605 static
 606 long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg,
 607         union ust_args *uargs, void *owner)
 608 {
 609         struct lttng_ust_tracepoint_list *list = objd_private(objd);
 610         struct lttng_ust_tracepoint_iter *tp =
 611                 (struct lttng_ust_tracepoint_iter *) arg;
 612         struct lttng_ust_tracepoint_iter *iter;
 613
 614         switch (cmd) {
 615         case LTTNG_UST_TRACEPOINT_LIST_GET:
 616         {
 617                 iter = lttng_ust_tracepoint_list_get_iter_next(list);
 618                 if (!iter)
 619                         return -LTTNG_UST_ERR_NOENT;
 620                 memcpy(tp, iter, sizeof(*tp));
 621                 return 0;
 622         }
 623         default:
 624                 return -EINVAL;
 625         }
 626 }
 627
 628 static
 629 int lttng_abi_tracepoint_list(void *owner)
 630 {
 631         int list_objd, ret;
 632         struct lttng_ust_tracepoint_list *list;
 633
 634         list_objd = objd_alloc(NULL, &lttng_tracepoint_list_ops, owner, "tp_list");
 635         if (list_objd < 0) {
 636                 ret = list_objd;
 637                 goto objd_error;
 638         }
 639         list = zmalloc(sizeof(*list));
 640         if (!list) {
 641                 ret = -ENOMEM;
 642                 goto alloc_error;
 643         }
 644         objd_set_private(list_objd, list);
 645
 646         /* populate list by walking on all registered probes. */
 647         ret = lttng_probes_get_event_list(list);
 648         if (ret) {
 649                 goto list_error;
 650         }
 651         return list_objd;
 652
 653 list_error:
 654         free(list);
 655 alloc_error:
 656         {
 657                 int err;
 658
 659                 err = lttng_ust_objd_unref(list_objd, 1);
 660                 assert(!err);
 661         }
 662 objd_error:
 663         return ret;
 664 }
 665
 666 static
 667 int lttng_release_tracepoint_list(int objd)
 668 {
 669         struct lttng_ust_tracepoint_list *list = objd_private(objd);
 670
 671         if (list) {
 672                 lttng_probes_prune_event_list(list);
 673                 free(list);
 674                 return 0;
 675         } else {
 676                 return -EINVAL;
 677         }
 678 }
 679
 680 static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops = {
 681         .release = lttng_release_tracepoint_list,
 682         .cmd = lttng_tracepoint_list_cmd,
 683 };
 684
 685 static
 686 long lttng_tracepoint_field_list_cmd(int objd, unsigned int cmd,
 687         unsigned long arg, union ust_args *uargs, void *owner)
 688 {
 689         struct lttng_ust_field_list *list = objd_private(objd);
 690         struct lttng_ust_field_iter *tp = &uargs->field_list.entry;
 691         struct lttng_ust_field_iter *iter;
 692
 693         switch (cmd) {
 694         case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET:
 695         {
 696                 iter = lttng_ust_field_list_get_iter_next(list);
 697                 if (!iter)
 698                         return -LTTNG_UST_ERR_NOENT;
 699                 memcpy(tp, iter, sizeof(*tp));
 700                 return 0;
 701         }
 702         default:
 703                 return -EINVAL;
 704         }
 705 }
 706
 707 static
 708 int lttng_abi_tracepoint_field_list(void *owner)
 709 {
 710         int list_objd, ret;
 711         struct lttng_ust_field_list *list;
 712
 713         list_objd = objd_alloc(NULL, &lttng_tracepoint_field_list_ops, owner,
 714                         "tp_field_list");
 715         if (list_objd < 0) {
 716                 ret = list_objd;
 717                 goto objd_error;
 718         }
 719         list = zmalloc(sizeof(*list));
 720         if (!list) {
 721                 ret = -ENOMEM;
 722                 goto alloc_error;
 723         }
 724         objd_set_private(list_objd, list);
 725
 726         /* populate list by walking on all registered probes. */
 727         ret = lttng_probes_get_field_list(list);
 728         if (ret) {
 729                 goto list_error;
 730         }
 731         return list_objd;
 732
 733 list_error:
 734         free(list);
 735 alloc_error:
 736         {
 737                 int err;
 738
 739                 err = lttng_ust_objd_unref(list_objd, 1);
 740                 assert(!err);
 741         }
 742 objd_error:
 743         return ret;
 744 }
 745
 746 static
 747 int lttng_release_tracepoint_field_list(int objd)
 748 {
 749         struct lttng_ust_field_list *list = objd_private(objd);
 750
 751         if (list) {
 752                 lttng_probes_prune_field_list(list);
 753                 free(list);
 754                 return 0;
 755         } else {
 756                 return -EINVAL;
 757         }
 758 }
 759
 760 static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops = {
 761         .release = lttng_release_tracepoint_field_list,
 762         .cmd = lttng_tracepoint_field_list_cmd,
 763 };
 764
 765 static
 766 int lttng_abi_map_stream(int channel_objd, struct lttng_ust_stream *info,
 767                 union ust_args *uargs, void *owner)
 768 {
 769         struct lttng_channel *channel = objd_private(channel_objd);
 770         int ret;
 771
 772         ret = channel_handle_add_stream(channel->handle,
 773                 uargs->stream.shm_fd, uargs->stream.wakeup_fd,
 774                 info->stream_nr, info->len);
 775         if (ret)
 776                 goto error_add_stream;
 777
 778         return 0;
 779
 780 error_add_stream:
 781         return ret;
 782 }
 783
 784 static
 785 int lttng_abi_create_enabler(int channel_objd,
 786                            struct lttng_ust_event *event_param,
 787                            void *owner,
 788                            enum lttng_enabler_type type)
 789 {
 790         struct lttng_channel *channel = objd_private(channel_objd);
 791         struct lttng_enabler *enabler;
 792         int event_objd, ret;
 793
 794         event_param->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
 795         event_objd = objd_alloc(NULL, &lttng_enabler_ops, owner, "enabler");
 796         if (event_objd < 0) {
 797                 ret = event_objd;
 798                 goto objd_error;
 799         }
 800         /*
 801          * We tolerate no failure path after event creation. It will stay
 802          * invariant for the rest of the session.
 803          */
 804         enabler = lttng_enabler_create(type, event_param, channel);
 805         if (!enabler) {
 806                 ret = -ENOMEM;
 807                 goto event_error;
 808         }
 809         objd_set_private(event_objd, enabler);
 810         /* The event holds a reference on the channel */
 811         objd_ref(channel_objd);
 812         return event_objd;
 813
 814 event_error:
 815         {
 816                 int err;
 817
 818                 err = lttng_ust_objd_unref(event_objd, 1);
 819                 assert(!err);
 820         }
 821 objd_error:
 822         return ret;
 823 }
 824
 825 /**
 826  *      lttng_channel_cmd - lttng control through object descriptors
 827  *
 828  *      @objd: the object descriptor
 829  *      @cmd: the command
 830  *      @arg: command arg
 831  *      @uargs: UST arguments (internal)
 832  *      @owner: objd owner
 833  *
 834  *      This object descriptor implements lttng commands:
 835  *      LTTNG_UST_STREAM
 836  *              Returns an event stream object descriptor or failure.
 837  *              (typically, one event stream records events from one CPU)
 838  *      LTTNG_UST_EVENT
 839  *              Returns an event object descriptor or failure.
 840  *      LTTNG_UST_CONTEXT
 841  *              Prepend a context field to each event in the channel
 842  *      LTTNG_UST_ENABLE
 843  *              Enable recording for events in this channel (weak enable)
 844  *      LTTNG_UST_DISABLE
 845  *              Disable recording for events in this channel (strong disable)
 846  *
 847  * Channel and event file descriptors also hold a reference on the session.
 848  */
 849 static
 850 long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg,
 851         union ust_args *uargs, void *owner)
 852 {
 853         struct lttng_channel *channel = objd_private(objd);
 854
 855         if (cmd != LTTNG_UST_STREAM) {
 856                 /*
 857                  * Check if channel received all streams.
 858                  */
 859                 if (!lttng_is_channel_ready(channel))
 860                         return -EPERM;
 861         }
 862
 863         switch (cmd) {
 864         case LTTNG_UST_STREAM:
 865         {
 866                 struct lttng_ust_stream *stream;
 867
 868                 stream = (struct lttng_ust_stream *) arg;
 869                 /* stream used as output */
 870                 return lttng_abi_map_stream(objd, stream, uargs, owner);
 871         }
 872         case LTTNG_UST_EVENT:
 873         {
 874                 struct lttng_ust_event *event_param =
 875                         (struct lttng_ust_event *) arg;
 876                 if (event_param->name[strlen(event_param->name) - 1] == '*') {
 877                         /* If ends with wildcard, create wildcard. */
 878                         return lttng_abi_create_enabler(objd, event_param,
 879                                         owner, LTTNG_ENABLER_WILDCARD);
 880                 } else {
 881                         return lttng_abi_create_enabler(objd, event_param,
 882                                         owner, LTTNG_ENABLER_EVENT);
 883                 }
 884         }
 885         case LTTNG_UST_CONTEXT:
 886                 return lttng_abi_add_context(objd,
 887                                 (struct lttng_ust_context *) arg,
 888                                 &channel->ctx, channel->session);
 889         case LTTNG_UST_ENABLE:
 890                 return lttng_channel_enable(channel);
 891         case LTTNG_UST_DISABLE:
 892                 return lttng_channel_disable(channel);
 893         case LTTNG_UST_FLUSH_BUFFER:
 894                 return channel->ops->flush_buffer(channel->chan, channel->handle);
 895         default:
 896                 return -EINVAL;
 897         }
 898 }
 899
 900 static
 901 int lttng_channel_release(int objd)
 902 {
 903         struct lttng_channel *channel = objd_private(objd);
 904
 905         if (channel)
 906                 return lttng_ust_objd_unref(channel->session->objd, 0);
 907         return 0;
 908 }
 909
 910 static const struct lttng_ust_objd_ops lttng_channel_ops = {
 911         .release = lttng_channel_release,
 912         .cmd = lttng_channel_cmd,
 913 };
 914
 915 /**
 916  *      lttng_enabler_cmd - lttng control through object descriptors
 917  *
 918  *      @objd: the object descriptor
 919  *      @cmd: the command
 920  *      @arg: command arg
 921  *      @uargs: UST arguments (internal)
 922  *      @owner: objd owner
 923  *
 924  *      This object descriptor implements lttng commands:
 925  *      LTTNG_UST_CONTEXT
 926  *              Prepend a context field to each record of events of this
 927  *              enabler.
 928  *      LTTNG_UST_ENABLE
 929  *              Enable recording for this enabler
 930  *      LTTNG_UST_DISABLE
 931  *              Disable recording for this enabler
 932  *      LTTNG_UST_FILTER
 933  *              Attach a filter to an enabler.
 934  *      LTTNG_UST_EXCLUSION
 935  *              Attach exclusions to an enabler.
 936  */
 937 static
 938 long lttng_enabler_cmd(int objd, unsigned int cmd, unsigned long arg,
 939         union ust_args *uargs, void *owner)
 940 {
 941         struct lttng_enabler *enabler = objd_private(objd);
 942
 943         switch (cmd) {
 944         case LTTNG_UST_CONTEXT:
 945                 return lttng_enabler_attach_context(enabler,
 946                                 (struct lttng_ust_context *) arg);
 947         case LTTNG_UST_ENABLE:
 948                 return lttng_enabler_enable(enabler);
 949         case LTTNG_UST_DISABLE:
 950                 return lttng_enabler_disable(enabler);
 951         case LTTNG_UST_FILTER:
 952         {
 953                 int ret;
 954
 955                 ret = lttng_enabler_attach_bytecode(enabler,
 956                                 (struct lttng_ust_filter_bytecode_node *) arg);
 957                 if (ret)
 958                         return ret;
 959                 return 0;
 960         }
 961         case LTTNG_UST_EXCLUSION:
 962         {
 963                 return lttng_enabler_attach_exclusion(enabler,
 964                                 (struct lttng_ust_excluder_node *) arg);
 965         }
 966         default:
 967                 return -EINVAL;
 968         }
 969 }
 970
 971 static
 972 int lttng_enabler_release(int objd)
 973 {
 974         struct lttng_enabler *enabler = objd_private(objd);
 975
 976         if (enabler)
 977                 return lttng_ust_objd_unref(enabler->chan->objd, 0);
 978         return 0;
 979 }
 980
 981 static const struct lttng_ust_objd_ops lttng_enabler_ops = {
 982         .release = lttng_enabler_release,
 983         .cmd = lttng_enabler_cmd,
 984 };
 985
 986 void lttng_ust_abi_exit(void)
 987 {
 988         lttng_ust_abi_close_in_progress = 1;
 989         ust_lock_nocheck();
 990         objd_table_destroy();
 991         ust_unlock();
 992         lttng_ust_abi_close_in_progress = 0;
 993 }