Cleanup: add lttng_/lttng-/LTTNG_ prefixes
[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-client.h
1 /*
2 * lttng-ring-buffer-client.h
3 *
4 * LTTng lib ring buffer client template.
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 #include <stdint.h>
24 #include <lttng/ust-events.h>
25 #include "lttng/bitfield.h"
26 #include "clock.h"
27 #include "lttng-ust-uuid.h"
28 #include "lttng-tracer.h"
29 #include "../libringbuffer/frontend_types.h"
30
31 #define LTTNG_COMPACT_EVENT_BITS 5
32 #define LTTNG_COMPACT_TSC_BITS 27
33
34 /*
35 * Keep the natural field alignment for _each field_ within this structure if
36 * you ever add/remove a field from this header. Packed attribute is not used
37 * because gcc generates poor code on at least powerpc and mips. Don't ever
38 * let gcc add padding between the structure elements.
39 */
40
41 struct packet_header {
42 /* Trace packet header */
43 uint32_t magic; /*
44 * Trace magic number.
45 * contains endianness information.
46 */
47 uint8_t uuid[LTTNG_UST_UUID_LEN];
48 uint32_t stream_id;
49
50 struct {
51 /* Stream packet context */
52 uint64_t timestamp_begin; /* Cycle count at subbuffer start */
53 uint64_t timestamp_end; /* Cycle count at subbuffer end */
54 uint64_t content_size; /* Size of data in subbuffer */
55 uint64_t packet_size; /* Subbuffer size (include padding) */
56 unsigned long events_discarded; /*
57 * Events lost in this subbuffer since
58 * the beginning of the trace.
59 * (may overflow)
60 */
61 uint32_t cpu_id; /* CPU id associated with stream */
62 uint8_t header_end; /* End of header */
63 } ctx;
64 };
65
66
67 static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
68 {
69 return trace_clock_read64();
70 }
71
72 static inline
73 size_t ctx_get_size(size_t offset, struct lttng_ctx *ctx)
74 {
75 int i;
76 size_t orig_offset = offset;
77
78 if (caa_likely(!ctx))
79 return 0;
80 for (i = 0; i < ctx->nr_fields; i++)
81 offset += ctx->fields[i].get_size(offset);
82 return offset - orig_offset;
83 }
84
85 static inline
86 void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx,
87 struct lttng_channel *chan,
88 struct lttng_ctx *ctx)
89 {
90 int i;
91
92 if (caa_likely(!ctx))
93 return;
94 for (i = 0; i < ctx->nr_fields; i++)
95 ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
96 }
97
98 /*
99 * record_header_size - Calculate the header size and padding necessary.
100 * @config: ring buffer instance configuration
101 * @chan: channel
102 * @offset: offset in the write buffer
103 * @pre_header_padding: padding to add before the header (output)
104 * @ctx: reservation context
105 *
106 * Returns the event header size (including padding).
107 *
108 * The payload must itself determine its own alignment from the biggest type it
109 * contains.
110 */
111 static __inline__
112 unsigned char record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
113 struct channel *chan, size_t offset,
114 size_t *pre_header_padding,
115 struct lttng_ust_lib_ring_buffer_ctx *ctx)
116 {
117 struct lttng_channel *lttng_chan = channel_get_private(chan);
118 struct lttng_event *event = ctx->priv;
119 size_t orig_offset = offset;
120 size_t padding;
121
122 switch (lttng_chan->header_type) {
123 case 1: /* compact */
124 padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
125 offset += padding;
126 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
127 offset += sizeof(uint32_t); /* id and timestamp */
128 } else {
129 /* Minimum space taken by LTTNG_COMPACT_EVENT_BITS id */
130 offset += (LTTNG_COMPACT_EVENT_BITS + CHAR_BIT - 1) / CHAR_BIT;
131 /* Align extended struct on largest member */
132 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
133 offset += sizeof(uint32_t); /* id */
134 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
135 offset += sizeof(uint64_t); /* timestamp */
136 }
137 break;
138 case 2: /* large */
139 padding = lib_ring_buffer_align(offset, lttng_alignof(uint16_t));
140 offset += padding;
141 offset += sizeof(uint16_t);
142 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
143 offset += lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
144 offset += sizeof(uint32_t); /* timestamp */
145 } else {
146 /* Align extended struct on largest member */
147 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
148 offset += sizeof(uint32_t); /* id */
149 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
150 offset += sizeof(uint64_t); /* timestamp */
151 }
152 break;
153 default:
154 padding = 0;
155 WARN_ON_ONCE(1);
156 }
157 offset += ctx_get_size(offset, event->ctx);
158 offset += ctx_get_size(offset, lttng_chan->ctx);
159
160 *pre_header_padding = padding;
161 return offset - orig_offset;
162 }
163
164 #include "../libringbuffer/api.h"
165
166 static
167 void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config,
168 struct lttng_ust_lib_ring_buffer_ctx *ctx,
169 uint32_t event_id);
170
171 /*
172 * lttng_write_event_header
173 *
174 * Writes the event header to the offset (already aligned on 32-bits).
175 *
176 * @config: ring buffer instance configuration
177 * @ctx: reservation context
178 * @event_id: event ID
179 */
180 static __inline__
181 void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *config,
182 struct lttng_ust_lib_ring_buffer_ctx *ctx,
183 uint32_t event_id)
184 {
185 struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
186 struct lttng_event *event = ctx->priv;
187
188 if (caa_unlikely(ctx->rflags))
189 goto slow_path;
190
191 switch (lttng_chan->header_type) {
192 case 1: /* compact */
193 {
194 uint32_t id_time = 0;
195
196 bt_bitfield_write(&id_time, uint32_t,
197 0,
198 LTTNG_COMPACT_EVENT_BITS,
199 event_id);
200 bt_bitfield_write(&id_time, uint32_t,
201 LTTNG_COMPACT_EVENT_BITS,
202 LTTNG_COMPACT_TSC_BITS,
203 ctx->tsc);
204 lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
205 break;
206 }
207 case 2: /* large */
208 {
209 uint32_t timestamp = (uint32_t) ctx->tsc;
210 uint16_t id = event_id;
211
212 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
213 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
214 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
215 break;
216 }
217 default:
218 WARN_ON_ONCE(1);
219 }
220
221 ctx_record(ctx, lttng_chan, lttng_chan->ctx);
222 ctx_record(ctx, lttng_chan, event->ctx);
223 lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
224
225 return;
226
227 slow_path:
228 lttng_write_event_header_slow(config, ctx, event_id);
229 }
230
231 static
232 void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config,
233 struct lttng_ust_lib_ring_buffer_ctx *ctx,
234 uint32_t event_id)
235 {
236 struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
237 struct lttng_event *event = ctx->priv;
238
239 switch (lttng_chan->header_type) {
240 case 1: /* compact */
241 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
242 uint32_t id_time = 0;
243
244 bt_bitfield_write(&id_time, uint32_t,
245 0,
246 LTTNG_COMPACT_EVENT_BITS,
247 event_id);
248 bt_bitfield_write(&id_time, uint32_t,
249 LTTNG_COMPACT_EVENT_BITS,
250 LTTNG_COMPACT_TSC_BITS,
251 ctx->tsc);
252 lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
253 } else {
254 uint8_t id = 0;
255 uint64_t timestamp = ctx->tsc;
256
257 bt_bitfield_write(&id, uint8_t,
258 0,
259 LTTNG_COMPACT_EVENT_BITS,
260 31);
261 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
262 /* Align extended struct on largest member */
263 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
264 lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
265 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
266 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
267 }
268 break;
269 case 2: /* large */
270 {
271 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
272 uint32_t timestamp = (uint32_t) ctx->tsc;
273 uint16_t id = event_id;
274
275 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
276 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
277 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
278 } else {
279 uint16_t id = 65535;
280 uint64_t timestamp = ctx->tsc;
281
282 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
283 /* Align extended struct on largest member */
284 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
285 lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
286 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
287 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
288 }
289 break;
290 }
291 default:
292 WARN_ON_ONCE(1);
293 }
294 ctx_record(ctx, lttng_chan, lttng_chan->ctx);
295 ctx_record(ctx, lttng_chan, event->ctx);
296 lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
297 }
298
299 static const struct lttng_ust_lib_ring_buffer_config client_config;
300
301 static uint64_t client_ring_buffer_clock_read(struct channel *chan)
302 {
303 return lib_ring_buffer_clock_read(chan);
304 }
305
306 static
307 size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
308 struct channel *chan, size_t offset,
309 size_t *pre_header_padding,
310 struct lttng_ust_lib_ring_buffer_ctx *ctx)
311 {
312 return record_header_size(config, chan, offset,
313 pre_header_padding, ctx);
314 }
315
316 /**
317 * client_packet_header_size - called on buffer-switch to a new sub-buffer
318 *
319 * Return header size without padding after the structure. Don't use packed
320 * structure because gcc generates inefficient code on some architectures
321 * (powerpc, mips..)
322 */
323 static size_t client_packet_header_size(void)
324 {
325 return offsetof(struct packet_header, ctx.header_end);
326 }
327
328 static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
329 unsigned int subbuf_idx,
330 struct lttng_ust_shm_handle *handle)
331 {
332 struct channel *chan = shmp(handle, buf->backend.chan);
333 struct packet_header *header =
334 (struct packet_header *)
335 lib_ring_buffer_offset_address(&buf->backend,
336 subbuf_idx * chan->backend.subbuf_size,
337 handle);
338 struct lttng_channel *lttng_chan = channel_get_private(chan);
339
340 header->magic = CTF_MAGIC_NUMBER;
341 memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid));
342 header->stream_id = lttng_chan->id;
343 header->ctx.timestamp_begin = tsc;
344 header->ctx.timestamp_end = 0;
345 header->ctx.content_size = ~0ULL; /* for debugging */
346 header->ctx.packet_size = ~0ULL;
347 header->ctx.events_discarded = 0;
348 header->ctx.cpu_id = buf->backend.cpu;
349 }
350
351 /*
352 * offset is assumed to never be 0 here : never deliver a completely empty
353 * subbuffer. data_size is between 1 and subbuf_size.
354 */
355 static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
356 unsigned int subbuf_idx, unsigned long data_size,
357 struct lttng_ust_shm_handle *handle)
358 {
359 struct channel *chan = shmp(handle, buf->backend.chan);
360 struct packet_header *header =
361 (struct packet_header *)
362 lib_ring_buffer_offset_address(&buf->backend,
363 subbuf_idx * chan->backend.subbuf_size,
364 handle);
365 unsigned long records_lost = 0;
366
367 header->ctx.timestamp_end = tsc;
368 header->ctx.content_size =
369 (uint64_t) data_size * CHAR_BIT; /* in bits */
370 header->ctx.packet_size =
371 (uint64_t) PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
372
373 records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
374 records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
375 records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
376 header->ctx.events_discarded = records_lost;
377 }
378
379 static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv,
380 int cpu, const char *name, struct lttng_ust_shm_handle *handle)
381 {
382 return 0;
383 }
384
385 static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf, void *priv, int cpu, struct lttng_ust_shm_handle *handle)
386 {
387 }
388
389 static const struct lttng_ust_lib_ring_buffer_config client_config = {
390 .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
391 .cb.record_header_size = client_record_header_size,
392 .cb.subbuffer_header_size = client_packet_header_size,
393 .cb.buffer_begin = client_buffer_begin,
394 .cb.buffer_end = client_buffer_end,
395 .cb.buffer_create = client_buffer_create,
396 .cb.buffer_finalize = client_buffer_finalize,
397
398 .tsc_bits = LTTNG_COMPACT_TSC_BITS,
399 .alloc = RING_BUFFER_ALLOC_PER_CPU,
400 .sync = RING_BUFFER_SYNC_GLOBAL,
401 .mode = RING_BUFFER_MODE_TEMPLATE,
402 .backend = RING_BUFFER_PAGE,
403 .output = RING_BUFFER_MMAP,
404 .oops = RING_BUFFER_OOPS_CONSISTENCY,
405 .ipi = RING_BUFFER_NO_IPI_BARRIER,
406 .wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
407 .client_type = LTTNG_CLIENT_TYPE,
408 };
409
410 const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb;
411
412 static
413 struct lttng_channel *_channel_create(const char *name,
414 void *buf_addr,
415 size_t subbuf_size, size_t num_subbuf,
416 unsigned int switch_timer_interval,
417 unsigned int read_timer_interval,
418 int **shm_fd, int **wait_fd,
419 uint64_t **memory_map_size,
420 struct lttng_channel *chan_priv_init)
421 {
422 void *priv;
423 struct lttng_channel *lttng_chan = NULL;
424 struct lttng_ust_shm_handle *handle;
425
426 handle = channel_create(&client_config, name,
427 &priv, __alignof__(*lttng_chan), sizeof(*lttng_chan),
428 chan_priv_init,
429 buf_addr, subbuf_size, num_subbuf,
430 switch_timer_interval, read_timer_interval,
431 shm_fd, wait_fd, memory_map_size);
432 if (!handle)
433 return NULL;
434 lttng_chan = priv;
435 lttng_chan->handle = handle;
436 lttng_chan->chan = shmp(lttng_chan->handle, lttng_chan->handle->chan);
437 return lttng_chan;
438 }
439
440 static
441 void lttng_channel_destroy(struct lttng_channel *lttng_chan)
442 {
443 channel_destroy(lttng_chan->chan, lttng_chan->handle, 0);
444 }
445
446 static
447 struct lttng_ust_lib_ring_buffer *lttng_buffer_read_open(struct channel *chan,
448 struct lttng_ust_shm_handle *handle,
449 int **shm_fd, int **wait_fd,
450 uint64_t **memory_map_size)
451 {
452 struct lttng_ust_lib_ring_buffer *buf;
453 int cpu;
454
455 for_each_channel_cpu(cpu, chan) {
456 buf = channel_get_ring_buffer(&client_config, chan,
457 cpu, handle, shm_fd, wait_fd,
458 memory_map_size);
459 if (!lib_ring_buffer_open_read(buf, handle, 0))
460 return buf;
461 }
462 return NULL;
463 }
464
465 static
466 void lttng_buffer_read_close(struct lttng_ust_lib_ring_buffer *buf,
467 struct lttng_ust_shm_handle *handle)
468 {
469 lib_ring_buffer_release_read(buf, handle, 0);
470 }
471
472 static
473 int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx,
474 uint32_t event_id)
475 {
476 struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
477 int ret, cpu;
478
479 cpu = lib_ring_buffer_get_cpu(&client_config);
480 if (cpu < 0)
481 return -EPERM;
482 ctx->cpu = cpu;
483
484 switch (lttng_chan->header_type) {
485 case 1: /* compact */
486 if (event_id > 30)
487 ctx->rflags |= LTTNG_RFLAG_EXTENDED;
488 break;
489 case 2: /* large */
490 if (event_id > 65534)
491 ctx->rflags |= LTTNG_RFLAG_EXTENDED;
492 break;
493 default:
494 WARN_ON_ONCE(1);
495 }
496
497 ret = lib_ring_buffer_reserve(&client_config, ctx);
498 if (ret)
499 goto put;
500 lttng_write_event_header(&client_config, ctx, event_id);
501 return 0;
502 put:
503 lib_ring_buffer_put_cpu(&client_config);
504 return ret;
505 }
506
507 static
508 void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
509 {
510 lib_ring_buffer_commit(&client_config, ctx);
511 lib_ring_buffer_put_cpu(&client_config);
512 }
513
514 static
515 void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
516 size_t len)
517 {
518 lib_ring_buffer_write(&client_config, ctx, src, len);
519 }
520
521 #if 0
522 static
523 wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan)
524 {
525 return &chan->read_wait;
526 }
527
528 static
529 wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan)
530 {
531 return &chan->hp_wait;
532 }
533 #endif //0
534
535 static
536 int lttng_is_finalized(struct channel *chan)
537 {
538 return lib_ring_buffer_channel_is_finalized(chan);
539 }
540
541 static
542 int lttng_is_disabled(struct channel *chan)
543 {
544 return lib_ring_buffer_channel_is_disabled(chan);
545 }
546
547 static
548 int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle)
549 {
550 struct lttng_ust_lib_ring_buffer *buf;
551 int cpu;
552
553 for_each_channel_cpu(cpu, chan) {
554 int *shm_fd, *wait_fd;
555 uint64_t *memory_map_size;
556
557 buf = channel_get_ring_buffer(&client_config, chan,
558 cpu, handle, &shm_fd, &wait_fd,
559 &memory_map_size);
560 lib_ring_buffer_switch(&client_config, buf,
561 SWITCH_ACTIVE, handle);
562 }
563 return 0;
564 }
565
566 static struct lttng_transport lttng_relay_transport = {
567 .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
568 .ops = {
569 .channel_create = _channel_create,
570 .channel_destroy = lttng_channel_destroy,
571 .buffer_read_open = lttng_buffer_read_open,
572 .buffer_read_close = lttng_buffer_read_close,
573 .event_reserve = lttng_event_reserve,
574 .event_commit = lttng_event_commit,
575 .event_write = lttng_event_write,
576 .packet_avail_size = NULL, /* Would be racy anyway */
577 //.get_reader_wait_queue = lttng_get_reader_wait_queue,
578 //.get_hp_wait_queue = lttng_get_hp_wait_queue,
579 .is_finalized = lttng_is_finalized,
580 .is_disabled = lttng_is_disabled,
581 .flush_buffer = lttng_flush_buffer,
582 },
583 };
584
585 void RING_BUFFER_MODE_TEMPLATE_INIT(void)
586 {
587 DBG("LTT : ltt ring buffer client init\n");
588 lttng_transport_register(&lttng_relay_transport);
589 }
590
591 void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
592 {
593 DBG("LTT : ltt ring buffer client exit\n");
594 lttng_transport_unregister(&lttng_relay_transport);
595 }
This page took 0.042945 seconds and 5 git commands to generate.