liblttng-ust/ltt-events.c

   1 /*
   2  * ltt-events.c
   3  *
   4  * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  *
   6  * Holds LTTng per-session event registry.
   7  *
   8  * Dual LGPL v2.1/GPL v2 license.
   9  */
  10
  11 #define _GNU_SOURCE
  12 #include <stdio.h>
  13 #include <endian.h>
  14 #include <urcu/list.h>
  15 #include <urcu/hlist.h>
  16 #include <pthread.h>
  17 #include <uuid/uuid.h>
  18 #include <errno.h>
  19 #include <sys/shm.h>
  20 #include <sys/ipc.h>
  21 #include <stdint.h>
  22 #include <stddef.h>
  23
  24 #include <urcu-bp.h>
  25 #include <urcu/compiler.h>
  26 #include <urcu/uatomic.h>
  27 #include <urcu/arch.h>
  28
  29 #include <lttng/tracepoint.h>
  30 #include <lttng/ust-events.h>
  31
  32 #include <usterr-signal-safe.h>
  33 #include <helper.h>
  34
  35 #include "ltt-tracer.h"
  36 #include "ltt-tracer-core.h"
  37 #include "wait.h"
  38 #include "../libringbuffer/shm.h"
  39 #include "jhash.h"
  40
  41 /*
  42  * The sessions mutex is the centralized mutex across UST tracing
  43  * control and probe registration. All operations within this file are
  44  * called by the communication thread, under ust_lock protection.
  45  */
  46 static pthread_mutex_t sessions_mutex = PTHREAD_MUTEX_INITIALIZER;
  47
  48 void ust_lock(void)
  49 {
  50         pthread_mutex_lock(&sessions_mutex);
  51 }
  52
  53 void ust_unlock(void)
  54 {
  55         pthread_mutex_unlock(&sessions_mutex);
  56 }
  57
  58 static CDS_LIST_HEAD(sessions);
  59
  60 /*
  61  * Pending probes hash table, containing the registered ltt events for
  62  * which tracepoint probes are still missing. Protected by the sessions
  63  * mutex.
  64  */
  65 #define PENDING_PROBE_HASH_BITS         6
  66 #define PENDING_PROBE_HASH_SIZE         (1 << PENDING_PROBE_HASH_BITS)
  67 static struct cds_hlist_head pending_probe_table[PENDING_PROBE_HASH_SIZE];
  68
  69 struct ust_pending_probe {
  70         struct ltt_event *event;
  71         struct cds_hlist_node node;
  72         char name[];
  73 };
  74
  75 static void _ltt_event_destroy(struct ltt_event *event);
  76 static void _ltt_channel_destroy(struct ltt_channel *chan);
  77 static int _ltt_event_unregister(struct ltt_event *event);
  78 static
  79 int _ltt_event_metadata_statedump(struct ltt_session *session,
  80                                   struct ltt_channel *chan,
  81                                   struct ltt_event *event);
  82 static
  83 int _ltt_session_metadata_statedump(struct ltt_session *session);
  84
  85 /*
  86  * called at event creation if probe is missing.
  87  * called with session mutex held.
  88  */
  89 static
  90 int add_pending_probe(struct ltt_event *event, const char *name)
  91 {
  92         struct cds_hlist_head *head;
  93         struct ust_pending_probe *e;
  94         size_t name_len = strlen(name) + 1;
  95         uint32_t hash = jhash(name, name_len - 1, 0);
  96
  97         head = &pending_probe_table[hash & (PENDING_PROBE_HASH_SIZE - 1)];
  98         e = zmalloc(sizeof(struct ust_pending_probe) + name_len);
  99         if (!e)
 100                 return -ENOMEM;
 101         memcpy(&e->name[0], name, name_len);
 102         cds_hlist_add_head(&e->node, head);
 103         e->event = event;
 104         event->pending_probe = e;
 105         return 0;
 106 }
 107
 108 /*
 109  * remove a pending probe. called when at event teardown and when an
 110  * event is fixed (probe is loaded).
 111  * called with session mutex held.
 112  */
 113 static
 114 void remove_pending_probe(struct ust_pending_probe *e)
 115 {
 116         if (!e)
 117                 return;
 118         cds_hlist_del(&e->node);
 119         free(e);
 120 }
 121
 122 /*
 123  * Called at library load: connect the probe on the events pending on
 124  * probe load.
 125  * called with session mutex held.
 126  */
 127 int pending_probe_fix_events(const struct lttng_event_desc *desc)
 128 {
 129         struct cds_hlist_head *head;
 130         struct cds_hlist_node *node, *p;
 131         struct ust_pending_probe *e;
 132         const char *name = desc->name;
 133         size_t name_len = strlen(name) + 1;
 134         uint32_t hash = jhash(name, name_len - 1, 0);
 135         int ret = 0;
 136
 137         head = &pending_probe_table[hash & (PENDING_PROBE_HASH_SIZE - 1)];
 138         cds_hlist_for_each_entry_safe(e, node, p, head, node) {
 139                 struct ltt_event *event;
 140                 struct ltt_channel *chan;
 141
 142                 if (strcmp(name, e->name))
 143                         continue;
 144                 event = e->event;
 145                 chan = event->chan;
 146                 assert(!event->desc);
 147                 event->desc = desc;
 148                 event->pending_probe = NULL;
 149                 remove_pending_probe(e);
 150                 ret |= __tracepoint_probe_register(name,
 151                                 event->desc->probe_callback,
 152                                 event);
 153                 if (ret)
 154                         continue;
 155                 event->id = chan->free_event_id++;
 156                 ret |= _ltt_event_metadata_statedump(chan->session, chan,
 157                                 event);
 158         }
 159         return ret;
 160 }
 161
 162 void synchronize_trace(void)
 163 {
 164         synchronize_rcu();
 165 }
 166
 167 struct ltt_session *ltt_session_create(void)
 168 {
 169         struct ltt_session *session;
 170
 171         session = zmalloc(sizeof(struct ltt_session));
 172         if (!session)
 173                 return NULL;
 174         CDS_INIT_LIST_HEAD(&session->chan);
 175         CDS_INIT_LIST_HEAD(&session->events);
 176         uuid_generate(session->uuid);
 177         cds_list_add(&session->list, &sessions);
 178         return session;
 179 }
 180
 181 void ltt_session_destroy(struct ltt_session *session)
 182 {
 183         struct ltt_channel *chan, *tmpchan;
 184         struct ltt_event *event, *tmpevent;
 185         int ret;
 186
 187         CMM_ACCESS_ONCE(session->active) = 0;
 188         cds_list_for_each_entry(event, &session->events, list) {
 189                 ret = _ltt_event_unregister(event);
 190                 WARN_ON(ret);
 191         }
 192         synchronize_trace();    /* Wait for in-flight events to complete */
 193         cds_list_for_each_entry_safe(event, tmpevent, &session->events, list)
 194                 _ltt_event_destroy(event);
 195         cds_list_for_each_entry_safe(chan, tmpchan, &session->chan, list)
 196                 _ltt_channel_destroy(chan);
 197         cds_list_del(&session->list);
 198         free(session);
 199 }
 200
 201 int ltt_session_enable(struct ltt_session *session)
 202 {
 203         int ret = 0;
 204         struct ltt_channel *chan;
 205
 206         if (session->active) {
 207                 ret = -EBUSY;
 208                 goto end;
 209         }
 210
 211         /*
 212          * Snapshot the number of events per channel to know the type of header
 213          * we need to use.
 214          */
 215         cds_list_for_each_entry(chan, &session->chan, list) {
 216                 if (chan->header_type)
 217                         continue;               /* don't change it if session stop/restart */
 218                 if (chan->free_event_id < 31)
 219                         chan->header_type = 1;  /* compact */
 220                 else
 221                         chan->header_type = 2;  /* large */
 222         }
 223
 224         CMM_ACCESS_ONCE(session->active) = 1;
 225         CMM_ACCESS_ONCE(session->been_active) = 1;
 226         ret = _ltt_session_metadata_statedump(session);
 227         if (ret)
 228                 CMM_ACCESS_ONCE(session->active) = 0;
 229 end:
 230         return ret;
 231 }
 232
 233 int ltt_session_disable(struct ltt_session *session)
 234 {
 235         int ret = 0;
 236
 237         if (!session->active) {
 238                 ret = -EBUSY;
 239                 goto end;
 240         }
 241         CMM_ACCESS_ONCE(session->active) = 0;
 242 end:
 243         return ret;
 244 }
 245
 246 int ltt_channel_enable(struct ltt_channel *channel)
 247 {
 248         int old;
 249
 250         if (channel == channel->session->metadata)
 251                 return -EPERM;
 252         old = uatomic_xchg(&channel->enabled, 1);
 253         if (old)
 254                 return -EEXIST;
 255         return 0;
 256 }
 257
 258 int ltt_channel_disable(struct ltt_channel *channel)
 259 {
 260         int old;
 261
 262         if (channel == channel->session->metadata)
 263                 return -EPERM;
 264         old = uatomic_xchg(&channel->enabled, 0);
 265         if (!old)
 266                 return -EEXIST;
 267         return 0;
 268 }
 269
 270 int ltt_event_enable(struct ltt_event *event)
 271 {
 272         int old;
 273
 274         if (event->chan == event->chan->session->metadata)
 275                 return -EPERM;
 276         old = uatomic_xchg(&event->enabled, 1);
 277         if (old)
 278                 return -EEXIST;
 279         return 0;
 280 }
 281
 282 int ltt_event_disable(struct ltt_event *event)
 283 {
 284         int old;
 285
 286         if (event->chan == event->chan->session->metadata)
 287                 return -EPERM;
 288         old = uatomic_xchg(&event->enabled, 0);
 289         if (!old)
 290                 return -EEXIST;
 291         return 0;
 292 }
 293
 294 struct ltt_channel *ltt_channel_create(struct ltt_session *session,
 295                                        const char *transport_name,
 296                                        void *buf_addr,
 297                                        size_t subbuf_size, size_t num_subbuf,
 298                                        unsigned int switch_timer_interval,
 299                                        unsigned int read_timer_interval,
 300                                        int *shm_fd, int *wait_fd,
 301                                        uint64_t *memory_map_size,
 302                                        struct ltt_channel *chan_priv_init)
 303 {
 304         struct ltt_channel *chan = NULL;
 305         struct ltt_transport *transport;
 306
 307         if (session->been_active)
 308                 goto active;    /* Refuse to add channel to active session */
 309         transport = ltt_transport_find(transport_name);
 310         if (!transport) {
 311                 DBG("LTTng transport %s not found\n",
 312                        transport_name);
 313                 goto notransport;
 314         }
 315         chan_priv_init->id = session->free_chan_id++;
 316         chan_priv_init->session = session;
 317         /*
 318          * Note: the channel creation op already writes into the packet
 319          * headers. Therefore the "chan" information used as input
 320          * should be already accessible.
 321          */
 322         chan = transport->ops.channel_create("[lttng]", buf_addr,
 323                         subbuf_size, num_subbuf, switch_timer_interval,
 324                         read_timer_interval, shm_fd, wait_fd,
 325                         memory_map_size, chan_priv_init);
 326         if (!chan)
 327                 goto create_error;
 328         chan->enabled = 1;
 329         chan->ops = &transport->ops;
 330         cds_list_add(&chan->list, &session->chan);
 331         return chan;
 332
 333 create_error:
 334 notransport:
 335 active:
 336         return NULL;
 337 }
 338
 339 /*
 340  * Only used internally at session destruction.
 341  */
 342 static
 343 void _ltt_channel_destroy(struct ltt_channel *chan)
 344 {
 345         cds_list_del(&chan->list);
 346         lttng_destroy_context(chan->ctx);
 347         chan->ops->channel_destroy(chan);
 348 }
 349
 350 /*
 351  * Supports event creation while tracing session is active.
 352  */
 353 int ltt_event_create(struct ltt_channel *chan,
 354                 struct lttng_ust_event *event_param,
 355                 void *filter,
 356                 struct ltt_event **_event)
 357 {
 358         struct ltt_event *event;
 359         int ret = 0;
 360
 361         if (chan->used_event_id == -1UL) {
 362                 ret = -ENOMEM;
 363                 goto full;
 364         }
 365         /*
 366          * This is O(n^2) (for each event, the loop is called at event
 367          * creation). Might require a hash if we have lots of events.
 368          */
 369         cds_list_for_each_entry(event, &chan->session->events, list) {
 370                 if (event->desc && !strcmp(event->desc->name, event_param->name)) {
 371                         ret = -EEXIST;
 372                         goto exist;
 373                 }
 374         }
 375         event = zmalloc(sizeof(struct ltt_event));
 376         if (!event) {
 377                 ret = -ENOMEM;
 378                 goto cache_error;
 379         }
 380         event->chan = chan;
 381         event->filter = filter;
 382         /*
 383          * used_event_id counts the maximum number of event IDs that can
 384          * register if all probes register.
 385          */
 386         chan->used_event_id++;
 387         event->enabled = 1;
 388         event->instrumentation = event_param->instrumentation;
 389         /* Populate ltt_event structure before tracepoint registration. */
 390         cmm_smp_wmb();
 391         switch (event_param->instrumentation) {
 392         case LTTNG_UST_TRACEPOINT:
 393                 event->desc = ltt_event_get(event_param->name);
 394                 if (event->desc) {
 395                         ret = __tracepoint_probe_register(event_param->name,
 396                                         event->desc->probe_callback,
 397                                         event);
 398                         if (ret)
 399                                 goto register_error;
 400                         event->id = chan->free_event_id++;
 401                 } else {
 402                         /*
 403                          * If the probe is not present, event->desc stays NULL,
 404                          * waiting for the probe to register, and the event->id
 405                          * stays unallocated.
 406                          */
 407                         ret = add_pending_probe(event, event_param->name);
 408                         if (ret)
 409                                 goto add_pending_error;
 410                 }
 411                 break;
 412         default:
 413                 WARN_ON_ONCE(1);
 414         }
 415         if (event->desc) {
 416                 ret = _ltt_event_metadata_statedump(chan->session, chan, event);
 417                 if (ret)
 418                         goto statedump_error;
 419         }
 420         cds_list_add(&event->list, &chan->session->events);
 421         *_event = event;
 422         return 0;
 423
 424 statedump_error:
 425         if (event->desc) {
 426                 WARN_ON_ONCE(__tracepoint_probe_unregister(event_param->name,
 427                                         event->desc->probe_callback,
 428                                         event));
 429                 ltt_event_put(event->desc);
 430         }
 431 add_pending_error:
 432 register_error:
 433         free(event);
 434 cache_error:
 435 exist:
 436 full:
 437         return ret;
 438 }
 439
 440 /*
 441  * Only used internally at session destruction.
 442  */
 443 int _ltt_event_unregister(struct ltt_event *event)
 444 {
 445         int ret = -EINVAL;
 446
 447         switch (event->instrumentation) {
 448         case LTTNG_UST_TRACEPOINT:
 449                 if (event->desc) {
 450                         ret = __tracepoint_probe_unregister(event->desc->name,
 451                                                           event->desc->probe_callback,
 452                                                           event);
 453                         if (ret)
 454                                 return ret;
 455                 } else {
 456                         remove_pending_probe(event->pending_probe);
 457                         ret = 0;
 458                 }
 459                 break;
 460         default:
 461                 WARN_ON_ONCE(1);
 462         }
 463         return ret;
 464 }
 465
 466 /*
 467  * Only used internally at session destruction.
 468  */
 469 static
 470 void _ltt_event_destroy(struct ltt_event *event)
 471 {
 472         switch (event->instrumentation) {
 473         case LTTNG_UST_TRACEPOINT:
 474                 if (event->desc) {
 475                         ltt_event_put(event->desc);
 476                 }
 477                 break;
 478         default:
 479                 WARN_ON_ONCE(1);
 480         }
 481         cds_list_del(&event->list);
 482         lttng_destroy_context(event->ctx);
 483         free(event);
 484 }
 485
 486 /*
 487  * We have exclusive access to our metadata buffer (protected by the
 488  * ust_lock), so we can do racy operations such as looking for
 489  * remaining space left in packet and write, since mutual exclusion
 490  * protects us from concurrent writes.
 491  */
 492 int lttng_metadata_printf(struct ltt_session *session,
 493                           const char *fmt, ...)
 494 {
 495         struct lttng_ust_lib_ring_buffer_ctx ctx;
 496         struct ltt_channel *chan = session->metadata;
 497         char *str = NULL;
 498         int ret = 0, waitret;
 499         size_t len, reserve_len, pos;
 500         va_list ap;
 501
 502         WARN_ON_ONCE(!CMM_ACCESS_ONCE(session->active));
 503
 504         va_start(ap, fmt);
 505         ret = vasprintf(&str, fmt, ap);
 506         va_end(ap);
 507         if (ret < 0)
 508                 return -ENOMEM;
 509
 510         len = strlen(str);
 511         pos = 0;
 512
 513         for (pos = 0; pos < len; pos += reserve_len) {
 514                 reserve_len = min_t(size_t,
 515                                 chan->ops->packet_avail_size(chan->chan, chan->handle),
 516                                 len - pos);
 517                 lib_ring_buffer_ctx_init(&ctx, chan->chan, NULL, reserve_len,
 518                                          sizeof(char), -1, chan->handle);
 519                 /*
 520                  * We don't care about metadata buffer's records lost
 521                  * count, because we always retry here. Report error if
 522                  * we need to bail out after timeout or being
 523                  * interrupted.
 524                  */
 525                 waitret = wait_cond_interruptible_timeout(
 526                         ({
 527                                 ret = chan->ops->event_reserve(&ctx, 0);
 528                                 ret != -ENOBUFS || !ret;
 529                         }),
 530                         LTTNG_METADATA_TIMEOUT_MSEC);
 531                 if (waitret == -ETIMEDOUT || waitret == -EINTR || ret) {
 532                         DBG("LTTng: Failure to write metadata to buffers (%s)\n",
 533                                 waitret == -EINTR ? "interrupted" :
 534                                         (ret == -ENOBUFS ? "timeout" : "I/O error"));
 535                         if (waitret == -EINTR)
 536                                 ret = waitret;
 537                         goto end;
 538                 }
 539                 chan->ops->event_write(&ctx, &str[pos], reserve_len);
 540                 chan->ops->event_commit(&ctx);
 541         }
 542 end:
 543         free(str);
 544         return ret;
 545 }
 546
 547 static
 548 int _ltt_field_statedump(struct ltt_session *session,
 549                          const struct lttng_event_field *field)
 550 {
 551         int ret = 0;
 552
 553         switch (field->type.atype) {
 554         case atype_integer:
 555                 ret = lttng_metadata_printf(session,
 556                         "               integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s;\n",
 557                         field->type.u.basic.integer.size,
 558                         field->type.u.basic.integer.alignment,
 559                         field->type.u.basic.integer.signedness,
 560                         (field->type.u.basic.integer.encoding == lttng_encode_none)
 561                                 ? "none"
 562                                 : (field->type.u.basic.integer.encoding == lttng_encode_UTF8)
 563                                         ? "UTF8"
 564                                         : "ASCII",
 565                         field->type.u.basic.integer.base,
 566 #if (BYTE_ORDER == BIG_ENDIAN)
 567                         field->type.u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
 568 #else
 569                         field->type.u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
 570 #endif
 571                         field->name);
 572                 break;
 573         case atype_float:
 574                 ret = lttng_metadata_printf(session,
 575                         "               floating_point { exp_dig = %u; mant_dig = %u; align = %u;%s } _%s;\n",
 576                         field->type.u.basic._float.exp_dig,
 577                         field->type.u.basic._float.mant_dig,
 578                         field->type.u.basic._float.alignment,
 579 #if (BYTE_ORDER == BIG_ENDIAN)
 580                         field->type.u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
 581 #else
 582                         field->type.u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
 583 #endif
 584                         field->name);
 585                 break;
 586         case atype_enum:
 587                 ret = lttng_metadata_printf(session,
 588                         "               %s %s;\n",
 589                         field->type.u.basic.enumeration.name,
 590                         field->name);
 591                 break;
 592         case atype_array:
 593         {
 594                 const struct lttng_basic_type *elem_type;
 595
 596                 elem_type = &field->type.u.array.elem_type;
 597                 ret = lttng_metadata_printf(session,
 598                         "               integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[%u];\n",
 599                         elem_type->u.basic.integer.size,
 600                         elem_type->u.basic.integer.alignment,
 601                         elem_type->u.basic.integer.signedness,
 602                         (elem_type->u.basic.integer.encoding == lttng_encode_none)
 603                                 ? "none"
 604                                 : (elem_type->u.basic.integer.encoding == lttng_encode_UTF8)
 605                                         ? "UTF8"
 606                                         : "ASCII",
 607                         elem_type->u.basic.integer.base,
 608 #if (BYTE_ORDER == BIG_ENDIAN)
 609                         elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
 610 #else
 611                         elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
 612 #endif
 613                         field->name, field->type.u.array.length);
 614                 break;
 615         }
 616         case atype_sequence:
 617         {
 618                 const struct lttng_basic_type *elem_type;
 619                 const struct lttng_basic_type *length_type;
 620
 621                 elem_type = &field->type.u.sequence.elem_type;
 622                 length_type = &field->type.u.sequence.length_type;
 623                 ret = lttng_metadata_printf(session,
 624                         "               integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } __%s_length;\n",
 625                         length_type->u.basic.integer.size,
 626                         (unsigned int) length_type->u.basic.integer.alignment,
 627                         length_type->u.basic.integer.signedness,
 628                         (length_type->u.basic.integer.encoding == lttng_encode_none)
 629                                 ? "none"
 630                                 : ((length_type->u.basic.integer.encoding == lttng_encode_UTF8)
 631                                         ? "UTF8"
 632                                         : "ASCII"),
 633                         length_type->u.basic.integer.base,
 634 #if (BYTE_ORDER == BIG_ENDIAN)
 635                         length_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
 636 #else
 637                         length_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
 638 #endif
 639                         field->name);
 640                 if (ret)
 641                         return ret;
 642
 643                 ret = lttng_metadata_printf(session,
 644                         "               integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s } _%s[ __%s_length ];\n",
 645                         elem_type->u.basic.integer.size,
 646                         (unsigned int) elem_type->u.basic.integer.alignment,
 647                         elem_type->u.basic.integer.signedness,
 648                         (elem_type->u.basic.integer.encoding == lttng_encode_none)
 649                                 ? "none"
 650                                 : ((elem_type->u.basic.integer.encoding == lttng_encode_UTF8)
 651                                         ? "UTF8"
 652                                         : "ASCII"),
 653                         elem_type->u.basic.integer.base,
 654 #if (BYTE_ORDER == BIG_ENDIAN)
 655                         elem_type->u.basic.integer.reverse_byte_order ? " byte_order = le;" : "",
 656 #else
 657                         elem_type->u.basic.integer.reverse_byte_order ? " byte_order = be;" : "",
 658 #endif
 659                         field->name,
 660                         field->name);
 661                 break;
 662         }
 663
 664         case atype_string:
 665                 /* Default encoding is UTF8 */
 666                 ret = lttng_metadata_printf(session,
 667                         "               string%s _%s;\n",
 668                         field->type.u.basic.string.encoding == lttng_encode_ASCII ?
 669                                 " { encoding = ASCII; }" : "",
 670                         field->name);
 671                 break;
 672         default:
 673                 WARN_ON_ONCE(1);
 674                 return -EINVAL;
 675         }
 676         return ret;
 677 }
 678
 679 static
 680 int _ltt_context_metadata_statedump(struct ltt_session *session,
 681                                     struct lttng_ctx *ctx)
 682 {
 683         int ret = 0;
 684         int i;
 685
 686         if (!ctx)
 687                 return 0;
 688         for (i = 0; i < ctx->nr_fields; i++) {
 689                 const struct lttng_ctx_field *field = &ctx->fields[i];
 690
 691                 ret = _ltt_field_statedump(session, &field->event_field);
 692                 if (ret)
 693                         return ret;
 694         }
 695         return ret;
 696 }
 697
 698 static
 699 int _ltt_fields_metadata_statedump(struct ltt_session *session,
 700                                    struct ltt_event *event)
 701 {
 702         const struct lttng_event_desc *desc = event->desc;
 703         int ret = 0;
 704         int i;
 705
 706         for (i = 0; i < desc->nr_fields; i++) {
 707                 const struct lttng_event_field *field = &desc->fields[i];
 708
 709                 ret = _ltt_field_statedump(session, field);
 710                 if (ret)
 711                         return ret;
 712         }
 713         return ret;
 714 }
 715
 716 static
 717 int _ltt_event_metadata_statedump(struct ltt_session *session,
 718                                   struct ltt_channel *chan,
 719                                   struct ltt_event *event)
 720 {
 721         int ret = 0;
 722
 723         if (event->metadata_dumped || !CMM_ACCESS_ONCE(session->active))
 724                 return 0;
 725         if (chan == session->metadata)
 726                 return 0;
 727         /*
 728          * Don't print events for which probe load is pending.
 729          */
 730         if (!event->desc)
 731                 return 0;
 732
 733         ret = lttng_metadata_printf(session,
 734                 "event {\n"
 735                 "       name = \"%s\";\n"
 736                 "       id = %u;\n"
 737                 "       stream_id = %u;\n",
 738                 event->desc->name,
 739                 event->id,
 740                 event->chan->id);
 741         if (ret)
 742                 goto end;
 743
 744         if (event->ctx) {
 745                 ret = lttng_metadata_printf(session,
 746                         "       context := struct {\n");
 747                 if (ret)
 748                         goto end;
 749         }
 750         ret = _ltt_context_metadata_statedump(session, event->ctx);
 751         if (ret)
 752                 goto end;
 753         if (event->ctx) {
 754                 ret = lttng_metadata_printf(session,
 755                         "       };\n");
 756                 if (ret)
 757                         goto end;
 758         }
 759
 760         ret = lttng_metadata_printf(session,
 761                 "       fields := struct {\n"
 762                 );
 763         if (ret)
 764                 goto end;
 765
 766         ret = _ltt_fields_metadata_statedump(session, event);
 767         if (ret)
 768                 goto end;
 769
 770         /*
 771          * LTTng space reservation can only reserve multiples of the
 772          * byte size.
 773          */
 774         ret = lttng_metadata_printf(session,
 775                 "       };\n"
 776                 "};\n\n");
 777         if (ret)
 778                 goto end;
 779
 780         event->metadata_dumped = 1;
 781 end:
 782         return ret;
 783
 784 }
 785
 786 static
 787 int _ltt_channel_metadata_statedump(struct ltt_session *session,
 788                                     struct ltt_channel *chan)
 789 {
 790         int ret = 0;
 791
 792         if (chan->metadata_dumped || !CMM_ACCESS_ONCE(session->active))
 793                 return 0;
 794         if (chan == session->metadata)
 795                 return 0;
 796
 797         WARN_ON_ONCE(!chan->header_type);
 798         ret = lttng_metadata_printf(session,
 799                 "stream {\n"
 800                 "       id = %u;\n"
 801                 "       event.header := %s;\n"
 802                 "       packet.context := struct packet_context;\n",
 803                 chan->id,
 804                 chan->header_type == 1 ? "struct event_header_compact" :
 805                         "struct event_header_large");
 806         if (ret)
 807                 goto end;
 808
 809         if (chan->ctx) {
 810                 ret = lttng_metadata_printf(session,
 811                         "       event.context := struct {\n");
 812                 if (ret)
 813                         goto end;
 814         }
 815         ret = _ltt_context_metadata_statedump(session, chan->ctx);
 816         if (ret)
 817                 goto end;
 818         if (chan->ctx) {
 819                 ret = lttng_metadata_printf(session,
 820                         "       };\n");
 821                 if (ret)
 822                         goto end;
 823         }
 824
 825         ret = lttng_metadata_printf(session,
 826                 "};\n\n");
 827
 828         chan->metadata_dumped = 1;
 829 end:
 830         return ret;
 831 }
 832
 833 static
 834 int _ltt_stream_packet_context_declare(struct ltt_session *session)
 835 {
 836         return lttng_metadata_printf(session,
 837                 "struct packet_context {\n"
 838                 "       uint64_t timestamp_begin;\n"
 839                 "       uint64_t timestamp_end;\n"
 840                 "       uint32_t events_discarded;\n"
 841                 "       uint32_t content_size;\n"
 842                 "       uint32_t packet_size;\n"
 843                 "       uint32_t cpu_id;\n"
 844                 "};\n\n"
 845                 );
 846 }
 847
 848 /*
 849  * Compact header:
 850  * id: range: 0 - 30.
 851  * id 31 is reserved to indicate an extended header.
 852  *
 853  * Large header:
 854  * id: range: 0 - 65534.
 855  * id 65535 is reserved to indicate an extended header.
 856  */
 857 static
 858 int _ltt_event_header_declare(struct ltt_session *session)
 859 {
 860         return lttng_metadata_printf(session,
 861         "struct event_header_compact {\n"
 862         "       enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
 863         "       variant <id> {\n"
 864         "               struct {\n"
 865         "                       uint27_t timestamp;\n"
 866         "               } compact;\n"
 867         "               struct {\n"
 868         "                       uint32_t id;\n"
 869         "                       uint64_t timestamp;\n"
 870         "               } extended;\n"
 871         "       } v;\n"
 872         "} align(%u);\n"
 873         "\n"
 874         "struct event_header_large {\n"
 875         "       enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
 876         "       variant <id> {\n"
 877         "               struct {\n"
 878         "                       uint32_t timestamp;\n"
 879         "               } compact;\n"
 880         "               struct {\n"
 881         "                       uint32_t id;\n"
 882         "                       uint64_t timestamp;\n"
 883         "               } extended;\n"
 884         "       } v;\n"
 885         "} align(%u);\n\n",
 886         lttng_alignof(uint32_t) * CHAR_BIT,
 887         lttng_alignof(uint16_t) * CHAR_BIT
 888         );
 889 }
 890
 891 /*
 892  * Output metadata into this session's metadata buffers.
 893  */
 894 static
 895 int _ltt_session_metadata_statedump(struct ltt_session *session)
 896 {
 897         unsigned char *uuid_c = session->uuid;
 898         char uuid_s[37];
 899         struct ltt_channel *chan;
 900         struct ltt_event *event;
 901         int ret = 0;
 902
 903         if (!CMM_ACCESS_ONCE(session->active))
 904                 return 0;
 905         if (session->metadata_dumped)
 906                 goto skip_session;
 907         if (!session->metadata) {
 908                 DBG("LTTng: attempt to start tracing, but metadata channel is not found. Operation abort.\n");
 909                 return -EPERM;
 910         }
 911
 912         snprintf(uuid_s, sizeof(uuid_s),
 913                 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
 914                 uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3],
 915                 uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7],
 916                 uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11],
 917                 uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]);
 918
 919         ret = lttng_metadata_printf(session,
 920                 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
 921                 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
 922                 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
 923                 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
 924                 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
 925                 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
 926                 "\n"
 927                 "trace {\n"
 928                 "       major = %u;\n"
 929                 "       minor = %u;\n"
 930                 "       uuid = \"%s\";\n"
 931                 "       byte_order = %s;\n"
 932                 "       packet.header := struct {\n"
 933                 "               uint32_t magic;\n"
 934                 "               uint8_t  uuid[16];\n"
 935                 "               uint32_t stream_id;\n"
 936                 "       };\n"
 937                 "};\n\n",
 938                 lttng_alignof(uint8_t) * CHAR_BIT,
 939                 lttng_alignof(uint16_t) * CHAR_BIT,
 940                 lttng_alignof(uint32_t) * CHAR_BIT,
 941                 lttng_alignof(uint64_t) * CHAR_BIT,
 942                 CTF_VERSION_MAJOR,
 943                 CTF_VERSION_MINOR,
 944                 uuid_s,
 945 #if (BYTE_ORDER == BIG_ENDIAN)
 946                 "be"
 947 #else
 948                 "le"
 949 #endif
 950                 );
 951         if (ret)
 952                 goto end;
 953
 954         ret = _ltt_stream_packet_context_declare(session);
 955         if (ret)
 956                 goto end;
 957
 958         ret = _ltt_event_header_declare(session);
 959         if (ret)
 960                 goto end;
 961
 962 skip_session:
 963         cds_list_for_each_entry(chan, &session->chan, list) {
 964                 ret = _ltt_channel_metadata_statedump(session, chan);
 965                 if (ret)
 966                         goto end;
 967         }
 968
 969         cds_list_for_each_entry(event, &session->events, list) {
 970                 ret = _ltt_event_metadata_statedump(session, event->chan, event);
 971                 if (ret)
 972                         goto end;
 973         }
 974         session->metadata_dumped = 1;
 975 end:
 976         return ret;
 977 }
 978
 979 void lttng_ust_events_exit(void)
 980 {
 981         struct ltt_session *session, *tmpsession;
 982
 983         cds_list_for_each_entry_safe(session, tmpsession, &sessions, list)
 984                 ltt_session_destroy(session);
 985 }