ltt-ring-buffer-client.h

   1 /*
   2  * ltt-ring-buffer-client.h
   3  *
   4  * Copyright (C) 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  *
   6  * LTTng lib ring buffer client template.
   7  *
   8  * Dual LGPL v2.1/GPL v2 license.
   9  */
  10
  11 #include <linux/module.h>
  12 #include <linux/types.h>
  13 #include "lib/bitfield.h"
  14 #include "wrapper/vmalloc.h"    /* for wrapper_vmalloc_sync_all() */
  15 #include "wrapper/trace-clock.h"
  16 #include "ltt-events.h"
  17 #include "ltt-tracer.h"
  18 #include "wrapper/ringbuffer/frontend_types.h"
  19
  20 /*
  21  * Keep the natural field alignment for _each field_ within this structure if
  22  * you ever add/remove a field from this header. Packed attribute is not used
  23  * because gcc generates poor code on at least powerpc and mips. Don't ever
  24  * let gcc add padding between the structure elements.
  25  */
  26
  27 struct packet_header {
  28         /* Trace packet header */
  29         uint32_t magic;                 /*
  30                                          * Trace magic number.
  31                                          * contains endianness information.
  32                                          */
  33         uint8_t uuid[16];
  34         uint32_t stream_id;
  35
  36         struct {
  37                 /* Stream packet context */
  38                 uint64_t timestamp_begin;       /* Cycle count at subbuffer start */
  39                 uint64_t timestamp_end;         /* Cycle count at subbuffer end */
  40                 uint32_t events_discarded;      /*
  41                                                  * Events lost in this subbuffer since
  42                                                  * the beginning of the trace.
  43                                                  * (may overflow)
  44                                                  */
  45                 uint32_t content_size;          /* Size of data in subbuffer */
  46                 uint32_t packet_size;           /* Subbuffer size (include padding) */
  47                 uint32_t cpu_id;                /* CPU id associated with stream */
  48                 uint8_t header_end;             /* End of header */
  49         } ctx;
  50 };
  51
  52
  53 static inline notrace u64 lib_ring_buffer_clock_read(struct channel *chan)
  54 {
  55         return trace_clock_read64();
  56 }
  57
  58 static inline
  59 size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx)
  60 {
  61         int i;
  62         size_t orig_offset = offset;
  63
  64         if (likely(!ctx))
  65                 return 0;
  66         for (i = 0; i < ctx->nr_fields; i++)
  67                 offset += ctx->fields[i].get_size(offset);
  68         return offset - orig_offset;
  69 }
  70
  71 static inline
  72 void ctx_record(struct lib_ring_buffer_ctx *bufctx,
  73                 struct ltt_channel *chan,
  74                 struct lttng_ctx *ctx)
  75 {
  76         int i;
  77
  78         if (likely(!ctx))
  79                 return;
  80         for (i = 0; i < ctx->nr_fields; i++)
  81                 ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
  82 }
  83
  84 /*
  85  * record_header_size - Calculate the header size and padding necessary.
  86  * @config: ring buffer instance configuration
  87  * @chan: channel
  88  * @offset: offset in the write buffer
  89  * @pre_header_padding: padding to add before the header (output)
  90  * @ctx: reservation context
  91  *
  92  * Returns the event header size (including padding).
  93  *
  94  * The payload must itself determine its own alignment from the biggest type it
  95  * contains.
  96  */
  97 static __inline__
  98 unsigned char record_header_size(const struct lib_ring_buffer_config *config,
  99                                  struct channel *chan, size_t offset,
 100                                  size_t *pre_header_padding,
 101                                  struct lib_ring_buffer_ctx *ctx)
 102 {
 103         struct ltt_channel *ltt_chan = channel_get_private(chan);
 104         struct ltt_event *event = ctx->priv;
 105         size_t orig_offset = offset;
 106         size_t padding;
 107
 108         switch (ltt_chan->header_type) {
 109         case 1: /* compact */
 110                 padding = lib_ring_buffer_align(offset, ltt_alignof(uint32_t));
 111                 offset += padding;
 112                 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTT_RFLAG_EXTENDED))) {
 113                         offset += sizeof(uint32_t);     /* id and timestamp */
 114                 } else {
 115                         /* Minimum space taken by 5-bit id */
 116                         offset += sizeof(uint8_t);
 117                         /* Align extended struct on largest member */
 118                         offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
 119                         offset += sizeof(uint32_t);     /* id */
 120                         offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
 121                         offset += sizeof(uint64_t);     /* timestamp */
 122                 }
 123                 break;
 124         case 2: /* large */
 125                 padding = lib_ring_buffer_align(offset, ltt_alignof(uint16_t));
 126                 offset += padding;
 127                 offset += sizeof(uint16_t);
 128                 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTT_RFLAG_EXTENDED))) {
 129                         offset += lib_ring_buffer_align(offset, ltt_alignof(uint32_t));
 130                         offset += sizeof(uint32_t);     /* timestamp */
 131                 } else {
 132                         /* Align extended struct on largest member */
 133                         offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
 134                         offset += sizeof(uint32_t);     /* id */
 135                         offset += lib_ring_buffer_align(offset, ltt_alignof(uint64_t));
 136                         offset += sizeof(uint64_t);     /* timestamp */
 137                 }
 138                 break;
 139         default:
 140                 padding = 0;
 141                 WARN_ON_ONCE(1);
 142         }
 143         offset += ctx_get_size(offset, event->ctx);
 144         offset += ctx_get_size(offset, ltt_chan->ctx);
 145
 146         *pre_header_padding = padding;
 147         return offset - orig_offset;
 148 }
 149
 150 #include "wrapper/ringbuffer/api.h"
 151
 152 extern
 153 void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
 154                                  struct lib_ring_buffer_ctx *ctx,
 155                                  uint32_t event_id);
 156
 157 /*
 158  * ltt_write_event_header
 159  *
 160  * Writes the event header to the offset (already aligned on 32-bits).
 161  *
 162  * @config: ring buffer instance configuration
 163  * @ctx: reservation context
 164  * @event_id: event ID
 165  */
 166 static __inline__
 167 void ltt_write_event_header(const struct lib_ring_buffer_config *config,
 168                             struct lib_ring_buffer_ctx *ctx,
 169                             uint32_t event_id)
 170 {
 171         struct ltt_channel *ltt_chan = channel_get_private(ctx->chan);
 172         struct ltt_event *event = ctx->priv;
 173
 174         if (unlikely(ctx->rflags))
 175                 goto slow_path;
 176
 177         switch (ltt_chan->header_type) {
 178         case 1: /* compact */
 179         {
 180                 uint32_t id_time = 0;
 181
 182                 bt_bitfield_write(&id_time, uint32_t, 0, 5, event_id);
 183                 bt_bitfield_write(&id_time, uint32_t, 5, 27, ctx->tsc);
 184                 lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
 185                 break;
 186         }
 187         case 2: /* large */
 188         {
 189                 uint32_t timestamp = (uint32_t) ctx->tsc;
 190                 uint16_t id = event_id;
 191
 192                 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
 193                 lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint32_t));
 194                 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
 195                 break;
 196         }
 197         default:
 198                 WARN_ON_ONCE(1);
 199         }
 200
 201         ctx_record(ctx, ltt_chan, event->ctx);
 202         ctx_record(ctx, ltt_chan, ltt_chan->ctx);
 203
 204         return;
 205
 206 slow_path:
 207         ltt_write_event_header_slow(config, ctx, event_id);
 208 }
 209
 210 void ltt_write_event_header_slow(const struct lib_ring_buffer_config *config,
 211                                  struct lib_ring_buffer_ctx *ctx,
 212                                  uint32_t event_id)
 213 {
 214         struct ltt_channel *ltt_chan = channel_get_private(ctx->chan);
 215         struct ltt_event *event = ctx->priv;
 216
 217         switch (ltt_chan->header_type) {
 218         case 1: /* compact */
 219                 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTT_RFLAG_EXTENDED))) {
 220                         uint32_t id_time = 0;
 221
 222                         bt_bitfield_write(&id_time, uint32_t, 0, 5, event_id);
 223                         bt_bitfield_write(&id_time, uint32_t, 5, 27, ctx->tsc);
 224                         lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
 225                 } else {
 226                         uint8_t id = 0;
 227                         uint64_t timestamp = ctx->tsc;
 228
 229                         bt_bitfield_write(&id, uint8_t, 0, 5, 31);
 230                         lib_ring_buffer_write(config, ctx, &id, sizeof(id));
 231                         /* Align extended struct on largest member */
 232                         lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
 233                         lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
 234                         lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
 235                         lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
 236                 }
 237                 break;
 238         case 2: /* large */
 239         {
 240                 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTT_RFLAG_EXTENDED))) {
 241                         uint32_t timestamp = (uint32_t) ctx->tsc;
 242                         uint16_t id = event_id;
 243
 244                         lib_ring_buffer_write(config, ctx, &id, sizeof(id));
 245                         lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint32_t));
 246                         lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
 247                 } else {
 248                         uint16_t id = 65535;
 249                         uint64_t timestamp = ctx->tsc;
 250
 251                         lib_ring_buffer_write(config, ctx, &id, sizeof(id));
 252                         /* Align extended struct on largest member */
 253                         lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
 254                         lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
 255                         lib_ring_buffer_align_ctx(ctx, ltt_alignof(uint64_t));
 256                         lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
 257                 }
 258                 break;
 259         }
 260         default:
 261                 WARN_ON_ONCE(1);
 262         }
 263         ctx_record(ctx, ltt_chan, event->ctx);
 264         ctx_record(ctx, ltt_chan, ltt_chan->ctx);
 265 }
 266
 267 static const struct lib_ring_buffer_config client_config;
 268
 269 static u64 client_ring_buffer_clock_read(struct channel *chan)
 270 {
 271         return lib_ring_buffer_clock_read(chan);
 272 }
 273
 274 static
 275 size_t client_record_header_size(const struct lib_ring_buffer_config *config,
 276                                  struct channel *chan, size_t offset,
 277                                  size_t *pre_header_padding,
 278                                  struct lib_ring_buffer_ctx *ctx)
 279 {
 280         return record_header_size(config, chan, offset,
 281                                   pre_header_padding, ctx);
 282 }
 283
 284 /**
 285  * client_packet_header_size - called on buffer-switch to a new sub-buffer
 286  *
 287  * Return header size without padding after the structure. Don't use packed
 288  * structure because gcc generates inefficient code on some architectures
 289  * (powerpc, mips..)
 290  */
 291 static size_t client_packet_header_size(void)
 292 {
 293         return offsetof(struct packet_header, ctx.header_end);
 294 }
 295
 296 static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
 297                                 unsigned int subbuf_idx)
 298 {
 299         struct channel *chan = buf->backend.chan;
 300         struct packet_header *header =
 301                 (struct packet_header *)
 302                         lib_ring_buffer_offset_address(&buf->backend,
 303                                 subbuf_idx * chan->backend.subbuf_size);
 304         struct ltt_channel *ltt_chan = channel_get_private(chan);
 305         struct ltt_session *session = ltt_chan->session;
 306
 307         header->magic = CTF_MAGIC_NUMBER;
 308         memcpy(header->uuid, session->uuid.b, sizeof(session->uuid));
 309         header->stream_id = ltt_chan->id;
 310         header->ctx.timestamp_begin = tsc;
 311         header->ctx.timestamp_end = 0;
 312         header->ctx.events_discarded = 0;
 313         header->ctx.content_size = 0xFFFFFFFF; /* for debugging */
 314         header->ctx.packet_size = 0xFFFFFFFF;
 315         header->ctx.cpu_id = buf->backend.cpu;
 316 }
 317
 318 /*
 319  * offset is assumed to never be 0 here : never deliver a completely empty
 320  * subbuffer. data_size is between 1 and subbuf_size.
 321  */
 322 static void client_buffer_end(struct lib_ring_buffer *buf, u64 tsc,
 323                               unsigned int subbuf_idx, unsigned long data_size)
 324 {
 325         struct channel *chan = buf->backend.chan;
 326         struct packet_header *header =
 327                 (struct packet_header *)
 328                         lib_ring_buffer_offset_address(&buf->backend,
 329                                 subbuf_idx * chan->backend.subbuf_size);
 330         unsigned long records_lost = 0;
 331
 332         header->ctx.timestamp_end = tsc;
 333         header->ctx.content_size = data_size * CHAR_BIT;        /* in bits */
 334         header->ctx.packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
 335         records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
 336         records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
 337         records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
 338         header->ctx.events_discarded = records_lost;
 339 }
 340
 341 static int client_buffer_create(struct lib_ring_buffer *buf, void *priv,
 342                                 int cpu, const char *name)
 343 {
 344         return 0;
 345 }
 346
 347 static void client_buffer_finalize(struct lib_ring_buffer *buf, void *priv, int cpu)
 348 {
 349 }
 350
 351 static const struct lib_ring_buffer_config client_config = {
 352         .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
 353         .cb.record_header_size = client_record_header_size,
 354         .cb.subbuffer_header_size = client_packet_header_size,
 355         .cb.buffer_begin = client_buffer_begin,
 356         .cb.buffer_end = client_buffer_end,
 357         .cb.buffer_create = client_buffer_create,
 358         .cb.buffer_finalize = client_buffer_finalize,
 359
 360         .tsc_bits = 32,
 361         .alloc = RING_BUFFER_ALLOC_PER_CPU,
 362         .sync = RING_BUFFER_SYNC_PER_CPU,
 363         .mode = RING_BUFFER_MODE_TEMPLATE,
 364         .backend = RING_BUFFER_PAGE,
 365         .output = RING_BUFFER_OUTPUT_TEMPLATE,
 366         .oops = RING_BUFFER_OOPS_CONSISTENCY,
 367         .ipi = RING_BUFFER_IPI_BARRIER,
 368         .wakeup = RING_BUFFER_WAKEUP_BY_TIMER,
 369 };
 370
 371 static
 372 struct channel *_channel_create(const char *name,
 373                                 struct ltt_channel *ltt_chan, void *buf_addr,
 374                                 size_t subbuf_size, size_t num_subbuf,
 375                                 unsigned int switch_timer_interval,
 376                                 unsigned int read_timer_interval)
 377 {
 378         return channel_create(&client_config, name, ltt_chan, buf_addr,
 379                               subbuf_size, num_subbuf, switch_timer_interval,
 380                               read_timer_interval);
 381 }
 382
 383 static
 384 void ltt_channel_destroy(struct channel *chan)
 385 {
 386         channel_destroy(chan);
 387 }
 388
 389 static
 390 struct lib_ring_buffer *ltt_buffer_read_open(struct channel *chan)
 391 {
 392         struct lib_ring_buffer *buf;
 393         int cpu;
 394
 395         for_each_channel_cpu(cpu, chan) {
 396                 buf = channel_get_ring_buffer(&client_config, chan, cpu);
 397                 if (!lib_ring_buffer_open_read(buf))
 398                         return buf;
 399         }
 400         return NULL;
 401 }
 402
 403 static
 404 int ltt_buffer_has_read_closed_stream(struct channel *chan)
 405 {
 406         struct lib_ring_buffer *buf;
 407         int cpu;
 408
 409         for_each_channel_cpu(cpu, chan) {
 410                 buf = channel_get_ring_buffer(&client_config, chan, cpu);
 411                 if (!atomic_long_read(&buf->active_readers))
 412                         return 1;
 413         }
 414         return 0;
 415 }
 416
 417 static
 418 void ltt_buffer_read_close(struct lib_ring_buffer *buf)
 419 {
 420         lib_ring_buffer_release_read(buf);
 421 }
 422
 423 static
 424 int ltt_event_reserve(struct lib_ring_buffer_ctx *ctx,
 425                       uint32_t event_id)
 426 {
 427         struct ltt_channel *ltt_chan = channel_get_private(ctx->chan);
 428         int ret, cpu;
 429
 430         cpu = lib_ring_buffer_get_cpu(&client_config);
 431         if (cpu < 0)
 432                 return -EPERM;
 433         ctx->cpu = cpu;
 434
 435         switch (ltt_chan->header_type) {
 436         case 1: /* compact */
 437                 if (event_id > 30)
 438                         ctx->rflags |= LTT_RFLAG_EXTENDED;
 439                 break;
 440         case 2: /* large */
 441                 if (event_id > 65534)
 442                         ctx->rflags |= LTT_RFLAG_EXTENDED;
 443                 break;
 444         default:
 445                 WARN_ON_ONCE(1);
 446         }
 447
 448         ret = lib_ring_buffer_reserve(&client_config, ctx);
 449         if (ret)
 450                 goto put;
 451         ltt_write_event_header(&client_config, ctx, event_id);
 452         return 0;
 453 put:
 454         lib_ring_buffer_put_cpu(&client_config);
 455         return ret;
 456 }
 457
 458 static
 459 void ltt_event_commit(struct lib_ring_buffer_ctx *ctx)
 460 {
 461         lib_ring_buffer_commit(&client_config, ctx);
 462         lib_ring_buffer_put_cpu(&client_config);
 463 }
 464
 465 static
 466 void ltt_event_write(struct lib_ring_buffer_ctx *ctx, const void *src,
 467                      size_t len)
 468 {
 469         lib_ring_buffer_write(&client_config, ctx, src, len);
 470 }
 471
 472 static
 473 wait_queue_head_t *ltt_get_reader_wait_queue(struct channel *chan)
 474 {
 475         return &chan->read_wait;
 476 }
 477
 478 static
 479 wait_queue_head_t *ltt_get_hp_wait_queue(struct channel *chan)
 480 {
 481         return &chan->hp_wait;
 482 }
 483
 484 static
 485 int ltt_is_finalized(struct channel *chan)
 486 {
 487         return lib_ring_buffer_channel_is_finalized(chan);
 488 }
 489
 490 static
 491 int ltt_is_disabled(struct channel *chan)
 492 {
 493         return lib_ring_buffer_channel_is_disabled(chan);
 494 }
 495
 496 static struct ltt_transport ltt_relay_transport = {
 497         .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING,
 498         .owner = THIS_MODULE,
 499         .ops = {
 500                 .channel_create = _channel_create,
 501                 .channel_destroy = ltt_channel_destroy,
 502                 .buffer_read_open = ltt_buffer_read_open,
 503                 .buffer_has_read_closed_stream =
 504                         ltt_buffer_has_read_closed_stream,
 505                 .buffer_read_close = ltt_buffer_read_close,
 506                 .event_reserve = ltt_event_reserve,
 507                 .event_commit = ltt_event_commit,
 508                 .event_write = ltt_event_write,
 509                 .packet_avail_size = NULL,      /* Would be racy anyway */
 510                 .get_reader_wait_queue = ltt_get_reader_wait_queue,
 511                 .get_hp_wait_queue = ltt_get_hp_wait_queue,
 512                 .is_finalized = ltt_is_finalized,
 513                 .is_disabled = ltt_is_disabled,
 514         },
 515 };
 516
 517 static int __init ltt_ring_buffer_client_init(void)
 518 {
 519         /*
 520          * This vmalloc sync all also takes care of the lib ring buffer
 521          * vmalloc'd module pages when it is built as a module into LTTng.
 522          */
 523         wrapper_vmalloc_sync_all();
 524         ltt_transport_register(&ltt_relay_transport);
 525         return 0;
 526 }
 527
 528 module_init(ltt_ring_buffer_client_init);
 529
 530 static void __exit ltt_ring_buffer_client_exit(void)
 531 {
 532         ltt_transport_unregister(&ltt_relay_transport);
 533 }
 534
 535 module_exit(ltt_ring_buffer_client_exit);
 536
 537 MODULE_LICENSE("GPL and additional rights");
 538 MODULE_AUTHOR("Mathieu Desnoyers");
 539 MODULE_DESCRIPTION("LTTng ring buffer " RING_BUFFER_MODE_TEMPLATE_STRING
 540                    " client");