Fix: update writeback instrumentation for kernel 4.14
[lttng-modules.git] / lttng-ring-buffer-client.h
CommitLineData
7514523f 1/*
a90917c3 2 * lttng-ring-buffer-client.h
7514523f 3 *
3d084699 4 * LTTng lib ring buffer client template.
7514523f 5 *
886d51a3
MD
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
7514523f
MD
21 */
22
23#include <linux/module.h>
c0e31d2e 24#include <linux/types.h>
bbd023d6
MD
25#include <lib/bitfield.h>
26#include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_all() */
27#include <wrapper/trace-clock.h>
28#include <lttng-events.h>
29#include <lttng-tracer.h>
30#include <wrapper/ringbuffer/frontend_types.h>
7514523f 31
a2ef1c03
MD
32#define LTTNG_COMPACT_EVENT_BITS 5
33#define LTTNG_COMPACT_TSC_BITS 27
34
dd5a0db3
MD
35static struct lttng_transport lttng_relay_transport;
36
d793d5e1
MD
37/*
38 * Keep the natural field alignment for _each field_ within this structure if
39 * you ever add/remove a field from this header. Packed attribute is not used
40 * because gcc generates poor code on at least powerpc and mips. Don't ever
41 * let gcc add padding between the structure elements.
fcf74578
MD
42 *
43 * The guarantee we have with timestamps is that all the events in a
44 * packet are included (inclusive) within the begin/end timestamps of
45 * the packet. Another guarantee we have is that the "timestamp begin",
46 * as well as the event timestamps, are monotonically increasing (never
47 * decrease) when moving forward in a stream (physically). But this
48 * guarantee does not apply to "timestamp end", because it is sampled at
49 * commit time, which is not ordered with respect to space reservation.
d793d5e1 50 */
9115fbdc 51
d793d5e1 52struct packet_header {
9115fbdc 53 /* Trace packet header */
d793d5e1
MD
54 uint32_t magic; /*
55 * Trace magic number.
56 * contains endianness information.
57 */
1ec3f75a 58 uint8_t uuid[16];
d793d5e1 59 uint32_t stream_id;
5594698f 60 uint64_t stream_instance_id;
9115fbdc
MD
61
62 struct {
63 /* Stream packet context */
64 uint64_t timestamp_begin; /* Cycle count at subbuffer start */
65 uint64_t timestamp_end; /* Cycle count at subbuffer end */
576ca06a
MD
66 uint64_t content_size; /* Size of data in subbuffer */
67 uint64_t packet_size; /* Subbuffer size (include padding) */
5b3cf4f9 68 uint64_t packet_seq_num; /* Packet sequence number */
a9afe705 69 unsigned long events_discarded; /*
9115fbdc
MD
70 * Events lost in this subbuffer since
71 * the beginning of the trace.
72 * (may overflow)
73 */
9115fbdc
MD
74 uint32_t cpu_id; /* CPU id associated with stream */
75 uint8_t header_end; /* End of header */
76 } ctx;
d793d5e1
MD
77};
78
cc62f29e
MD
79struct lttng_client_ctx {
80 size_t packet_context_len;
81 size_t event_context_len;
82};
d793d5e1 83
881833e3
MD
84static inline notrace u64 lib_ring_buffer_clock_read(struct channel *chan)
85{
86 return trace_clock_read64();
87}
88
f1676205 89static inline
cc62f29e
MD
90size_t ctx_get_aligned_size(size_t offset, struct lttng_ctx *ctx,
91 size_t ctx_len)
f1676205 92{
f1676205
MD
93 size_t orig_offset = offset;
94
95 if (likely(!ctx))
96 return 0;
a9dd15da 97 offset += lib_ring_buffer_align(offset, ctx->largest_align);
cc62f29e
MD
98 offset += ctx_len;
99 return offset - orig_offset;
100}
101
102static inline
103void ctx_get_struct_size(struct lttng_ctx *ctx, size_t *ctx_len)
104{
105 int i;
106 size_t offset = 0;
107
108 if (likely(!ctx)) {
109 *ctx_len = 0;
110 return;
111 }
f1676205
MD
112 for (i = 0; i < ctx->nr_fields; i++)
113 offset += ctx->fields[i].get_size(offset);
cc62f29e 114 *ctx_len = offset;
f1676205
MD
115}
116
117static inline
118void ctx_record(struct lib_ring_buffer_ctx *bufctx,
a90917c3 119 struct lttng_channel *chan,
f1676205
MD
120 struct lttng_ctx *ctx)
121{
122 int i;
123
124 if (likely(!ctx))
125 return;
a9dd15da 126 lib_ring_buffer_align_ctx(bufctx, ctx->largest_align);
f1676205
MD
127 for (i = 0; i < ctx->nr_fields; i++)
128 ctx->fields[i].record(&ctx->fields[i], bufctx, chan);
129}
130
881833e3
MD
131/*
132 * record_header_size - Calculate the header size and padding necessary.
133 * @config: ring buffer instance configuration
134 * @chan: channel
135 * @offset: offset in the write buffer
881833e3 136 * @pre_header_padding: padding to add before the header (output)
881833e3
MD
137 * @ctx: reservation context
138 *
139 * Returns the event header size (including padding).
140 *
881833e3
MD
141 * The payload must itself determine its own alignment from the biggest type it
142 * contains.
143 */
144static __inline__
c1cc82b8 145size_t record_header_size(const struct lib_ring_buffer_config *config,
881833e3 146 struct channel *chan, size_t offset,
64c796d8 147 size_t *pre_header_padding,
cc62f29e
MD
148 struct lib_ring_buffer_ctx *ctx,
149 struct lttng_client_ctx *client_ctx)
881833e3 150{
a90917c3 151 struct lttng_channel *lttng_chan = channel_get_private(chan);
79150a49
JD
152 struct lttng_probe_ctx *lttng_probe_ctx = ctx->priv;
153 struct lttng_event *event = lttng_probe_ctx->event;
881833e3
MD
154 size_t orig_offset = offset;
155 size_t padding;
156
a90917c3 157 switch (lttng_chan->header_type) {
9115fbdc 158 case 1: /* compact */
a90917c3 159 padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
9115fbdc 160 offset += padding;
a90917c3 161 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
9115fbdc
MD
162 offset += sizeof(uint32_t); /* id and timestamp */
163 } else {
a2ef1c03
MD
164 /* Minimum space taken by LTTNG_COMPACT_EVENT_BITS id */
165 offset += (LTTNG_COMPACT_EVENT_BITS + CHAR_BIT - 1) / CHAR_BIT;
9115fbdc 166 /* Align extended struct on largest member */
a90917c3 167 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
9115fbdc 168 offset += sizeof(uint32_t); /* id */
a90917c3 169 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
9115fbdc
MD
170 offset += sizeof(uint64_t); /* timestamp */
171 }
172 break;
173 case 2: /* large */
a90917c3 174 padding = lib_ring_buffer_align(offset, lttng_alignof(uint16_t));
9115fbdc
MD
175 offset += padding;
176 offset += sizeof(uint16_t);
a90917c3
MD
177 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
178 offset += lib_ring_buffer_align(offset, lttng_alignof(uint32_t));
9115fbdc
MD
179 offset += sizeof(uint32_t); /* timestamp */
180 } else {
181 /* Align extended struct on largest member */
a90917c3 182 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
9115fbdc 183 offset += sizeof(uint32_t); /* id */
a90917c3 184 offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t));
9115fbdc 185 offset += sizeof(uint64_t); /* timestamp */
881833e3 186 }
9115fbdc
MD
187 break;
188 default:
1b2e041f 189 padding = 0;
64c796d8 190 WARN_ON_ONCE(1);
881833e3 191 }
cc62f29e
MD
192 offset += ctx_get_aligned_size(offset, lttng_chan->ctx,
193 client_ctx->packet_context_len);
194 offset += ctx_get_aligned_size(offset, event->ctx,
195 client_ctx->event_context_len);
881833e3
MD
196
197 *pre_header_padding = padding;
198 return offset - orig_offset;
199}
200
bbd023d6 201#include <wrapper/ringbuffer/api.h>
881833e3 202
eb9a7857 203static
a90917c3 204void lttng_write_event_header_slow(const struct lib_ring_buffer_config *config,
881833e3 205 struct lib_ring_buffer_ctx *ctx,
64c796d8 206 uint32_t event_id);
881833e3
MD
207
208/*
a90917c3 209 * lttng_write_event_header
881833e3
MD
210 *
211 * Writes the event header to the offset (already aligned on 32-bits).
212 *
213 * @config: ring buffer instance configuration
214 * @ctx: reservation context
4e1f08f4 215 * @event_id: event ID
881833e3
MD
216 */
217static __inline__
a90917c3 218void lttng_write_event_header(const struct lib_ring_buffer_config *config,
881833e3 219 struct lib_ring_buffer_ctx *ctx,
64c796d8 220 uint32_t event_id)
881833e3 221{
a90917c3 222 struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
79150a49
JD
223 struct lttng_probe_ctx *lttng_probe_ctx = ctx->priv;
224 struct lttng_event *event = lttng_probe_ctx->event;
881833e3
MD
225
226 if (unlikely(ctx->rflags))
227 goto slow_path;
228
a90917c3 229 switch (lttng_chan->header_type) {
9115fbdc
MD
230 case 1: /* compact */
231 {
232 uint32_t id_time = 0;
233
a2ef1c03
MD
234 bt_bitfield_write(&id_time, uint32_t,
235 0,
236 LTTNG_COMPACT_EVENT_BITS,
237 event_id);
238 bt_bitfield_write(&id_time, uint32_t,
239 LTTNG_COMPACT_EVENT_BITS,
240 LTTNG_COMPACT_TSC_BITS,
241 ctx->tsc);
9115fbdc
MD
242 lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
243 break;
244 }
245 case 2: /* large */
246 {
9115fbdc 247 uint32_t timestamp = (uint32_t) ctx->tsc;
7e855749 248 uint16_t id = event_id;
9115fbdc 249
7e855749 250 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
a90917c3 251 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
9115fbdc
MD
252 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
253 break;
254 }
255 default:
64c796d8 256 WARN_ON_ONCE(1);
9115fbdc 257 }
f1676205 258
a90917c3
MD
259 ctx_record(ctx, lttng_chan, lttng_chan->ctx);
260 ctx_record(ctx, lttng_chan, event->ctx);
c595c36f 261 lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
f1676205 262
9115fbdc 263 return;
881833e3
MD
264
265slow_path:
a90917c3 266 lttng_write_event_header_slow(config, ctx, event_id);
881833e3
MD
267}
268
eb9a7857 269static
a90917c3 270void lttng_write_event_header_slow(const struct lib_ring_buffer_config *config,
64c796d8
MD
271 struct lib_ring_buffer_ctx *ctx,
272 uint32_t event_id)
881833e3 273{
a90917c3 274 struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
79150a49
JD
275 struct lttng_probe_ctx *lttng_probe_ctx = ctx->priv;
276 struct lttng_event *event = lttng_probe_ctx->event;
9115fbdc 277
a90917c3 278 switch (lttng_chan->header_type) {
9115fbdc 279 case 1: /* compact */
a90917c3 280 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
9115fbdc
MD
281 uint32_t id_time = 0;
282
a2ef1c03
MD
283 bt_bitfield_write(&id_time, uint32_t,
284 0,
285 LTTNG_COMPACT_EVENT_BITS,
286 event_id);
287 bt_bitfield_write(&id_time, uint32_t,
288 LTTNG_COMPACT_EVENT_BITS,
289 LTTNG_COMPACT_TSC_BITS, ctx->tsc);
9115fbdc
MD
290 lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time));
291 } else {
292 uint8_t id = 0;
9115fbdc
MD
293 uint64_t timestamp = ctx->tsc;
294
a2ef1c03
MD
295 bt_bitfield_write(&id, uint8_t,
296 0,
297 LTTNG_COMPACT_EVENT_BITS,
298 31);
9115fbdc
MD
299 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
300 /* Align extended struct on largest member */
a90917c3 301 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
9115fbdc 302 lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
a90917c3 303 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
9115fbdc
MD
304 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
305 }
881833e3 306 break;
9115fbdc
MD
307 case 2: /* large */
308 {
a90917c3 309 if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) {
9115fbdc 310 uint32_t timestamp = (uint32_t) ctx->tsc;
7e855749 311 uint16_t id = event_id;
9115fbdc 312
7e855749 313 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
a90917c3 314 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t));
9115fbdc
MD
315 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
316 } else {
64c796d8 317 uint16_t id = 65535;
9115fbdc
MD
318 uint64_t timestamp = ctx->tsc;
319
64c796d8 320 lib_ring_buffer_write(config, ctx, &id, sizeof(id));
9115fbdc 321 /* Align extended struct on largest member */
a90917c3 322 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
64c796d8 323 lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id));
a90917c3 324 lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t));
9115fbdc
MD
325 lib_ring_buffer_write(config, ctx, &timestamp, sizeof(timestamp));
326 }
881833e3 327 break;
881833e3 328 }
9115fbdc 329 default:
64c796d8 330 WARN_ON_ONCE(1);
881833e3 331 }
a90917c3
MD
332 ctx_record(ctx, lttng_chan, lttng_chan->ctx);
333 ctx_record(ctx, lttng_chan, event->ctx);
c595c36f 334 lib_ring_buffer_align_ctx(ctx, ctx->largest_align);
881833e3
MD
335}
336
7514523f
MD
337static const struct lib_ring_buffer_config client_config;
338
339static u64 client_ring_buffer_clock_read(struct channel *chan)
340{
341 return lib_ring_buffer_clock_read(chan);
342}
343
1e2015dc 344static
7514523f
MD
345size_t client_record_header_size(const struct lib_ring_buffer_config *config,
346 struct channel *chan, size_t offset,
7514523f 347 size_t *pre_header_padding,
cc62f29e
MD
348 struct lib_ring_buffer_ctx *ctx,
349 void *client_ctx)
7514523f 350{
64c796d8 351 return record_header_size(config, chan, offset,
cc62f29e 352 pre_header_padding, ctx, client_ctx);
7514523f
MD
353}
354
355/**
1c25284c 356 * client_packet_header_size - called on buffer-switch to a new sub-buffer
7514523f
MD
357 *
358 * Return header size without padding after the structure. Don't use packed
359 * structure because gcc generates inefficient code on some architectures
360 * (powerpc, mips..)
361 */
1c25284c 362static size_t client_packet_header_size(void)
7514523f 363{
9115fbdc 364 return offsetof(struct packet_header, ctx.header_end);
7514523f
MD
365}
366
367static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
368 unsigned int subbuf_idx)
369{
370 struct channel *chan = buf->backend.chan;
1c25284c
MD
371 struct packet_header *header =
372 (struct packet_header *)
7514523f
MD
373 lib_ring_buffer_offset_address(&buf->backend,
374 subbuf_idx * chan->backend.subbuf_size);
a90917c3
MD
375 struct lttng_channel *lttng_chan = channel_get_private(chan);
376 struct lttng_session *session = lttng_chan->session;
7514523f 377
d793d5e1 378 header->magic = CTF_MAGIC_NUMBER;
1ec3f75a 379 memcpy(header->uuid, session->uuid.b, sizeof(session->uuid));
a90917c3 380 header->stream_id = lttng_chan->id;
5594698f 381 header->stream_instance_id = buf->backend.cpu;
9115fbdc
MD
382 header->ctx.timestamp_begin = tsc;
383 header->ctx.timestamp_end = 0;
576ca06a
MD
384 header->ctx.content_size = ~0ULL; /* for debugging */
385 header->ctx.packet_size = ~0ULL;
5b3cf4f9
JD
386 header->ctx.packet_seq_num = chan->backend.num_subbuf * \
387 buf->backend.buf_cnt[subbuf_idx].seq_cnt + \
388 subbuf_idx;
9115fbdc 389 header->ctx.events_discarded = 0;
9115fbdc 390 header->ctx.cpu_id = buf->backend.cpu;
7514523f
MD
391}
392
393/*
394 * offset is assumed to never be 0 here : never deliver a completely empty
395 * subbuffer. data_size is between 1 and subbuf_size.
396 */
397static void client_buffer_end(struct lib_ring_buffer *buf, u64 tsc,
398 unsigned int subbuf_idx, unsigned long data_size)
399{
400 struct channel *chan = buf->backend.chan;
1c25284c
MD
401 struct packet_header *header =
402 (struct packet_header *)
7514523f
MD
403 lib_ring_buffer_offset_address(&buf->backend,
404 subbuf_idx * chan->backend.subbuf_size);
405 unsigned long records_lost = 0;
406
9115fbdc 407 header->ctx.timestamp_end = tsc;
f9e4e1b9
MD
408 header->ctx.content_size =
409 (uint64_t) data_size * CHAR_BIT; /* in bits */
410 header->ctx.packet_size =
411 (uint64_t) PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
7514523f
MD
412 records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
413 records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
414 records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
9115fbdc 415 header->ctx.events_discarded = records_lost;
7514523f
MD
416}
417
418static int client_buffer_create(struct lib_ring_buffer *buf, void *priv,
419 int cpu, const char *name)
420{
1c25284c 421 return 0;
7514523f
MD
422}
423
424static void client_buffer_finalize(struct lib_ring_buffer *buf, void *priv, int cpu)
425{
7514523f
MD
426}
427
3b731ab1
JD
428static struct packet_header *client_packet_header(
429 const struct lib_ring_buffer_config *config,
430 struct lib_ring_buffer *buf)
431{
53700162 432 return lib_ring_buffer_read_offset_address(&buf->backend, 0);
3b731ab1
JD
433}
434
435static int client_timestamp_begin(const struct lib_ring_buffer_config *config,
436 struct lib_ring_buffer *buf,
437 uint64_t *timestamp_begin)
438{
439 struct packet_header *header = client_packet_header(config, buf);
440 *timestamp_begin = header->ctx.timestamp_begin;
441
442 return 0;
443}
444
445static int client_timestamp_end(const struct lib_ring_buffer_config *config,
446 struct lib_ring_buffer *buf,
447 uint64_t *timestamp_end)
448{
449 struct packet_header *header = client_packet_header(config, buf);
450 *timestamp_end = header->ctx.timestamp_end;
451
452 return 0;
453}
454
455static int client_events_discarded(const struct lib_ring_buffer_config *config,
456 struct lib_ring_buffer *buf,
457 uint64_t *events_discarded)
458{
459 struct packet_header *header = client_packet_header(config, buf);
460 *events_discarded = header->ctx.events_discarded;
461
462 return 0;
463}
464
465static int client_content_size(const struct lib_ring_buffer_config *config,
466 struct lib_ring_buffer *buf,
467 uint64_t *content_size)
468{
469 struct packet_header *header = client_packet_header(config, buf);
470 *content_size = header->ctx.content_size;
471
472 return 0;
473}
474
475static int client_packet_size(const struct lib_ring_buffer_config *config,
476 struct lib_ring_buffer *buf,
477 uint64_t *packet_size)
478{
479 struct packet_header *header = client_packet_header(config, buf);
480 *packet_size = header->ctx.packet_size;
481
482 return 0;
483}
484
485static int client_stream_id(const struct lib_ring_buffer_config *config,
486 struct lib_ring_buffer *buf,
487 uint64_t *stream_id)
488{
489 struct packet_header *header = client_packet_header(config, buf);
490 *stream_id = header->stream_id;
491
492 return 0;
493}
494
2348ca17
JD
495static int client_current_timestamp(const struct lib_ring_buffer_config *config,
496 struct lib_ring_buffer *bufb,
497 uint64_t *ts)
498{
499 *ts = config->cb.ring_buffer_clock_read(bufb->backend.chan);
500
501 return 0;
502}
503
5b3cf4f9
JD
504static int client_sequence_number(const struct lib_ring_buffer_config *config,
505 struct lib_ring_buffer *buf,
506 uint64_t *seq)
507{
508 struct packet_header *header = client_packet_header(config, buf);
509
510 *seq = header->ctx.packet_seq_num;
511
512 return 0;
513}
514
5594698f
JD
515static
516int client_instance_id(const struct lib_ring_buffer_config *config,
517 struct lib_ring_buffer *buf,
518 uint64_t *id)
519{
520 struct packet_header *header = client_packet_header(config, buf);
521 *id = header->stream_instance_id;
522
523 return 0;
524}
525
7514523f
MD
526static const struct lib_ring_buffer_config client_config = {
527 .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
528 .cb.record_header_size = client_record_header_size,
1c25284c 529 .cb.subbuffer_header_size = client_packet_header_size,
7514523f
MD
530 .cb.buffer_begin = client_buffer_begin,
531 .cb.buffer_end = client_buffer_end,
532 .cb.buffer_create = client_buffer_create,
533 .cb.buffer_finalize = client_buffer_finalize,
534
a2ef1c03 535 .tsc_bits = LTTNG_COMPACT_TSC_BITS,
7514523f
MD
536 .alloc = RING_BUFFER_ALLOC_PER_CPU,
537 .sync = RING_BUFFER_SYNC_PER_CPU,
3d084699 538 .mode = RING_BUFFER_MODE_TEMPLATE,
7514523f 539 .backend = RING_BUFFER_PAGE,
2db1399a 540 .output = RING_BUFFER_OUTPUT_TEMPLATE,
7514523f
MD
541 .oops = RING_BUFFER_OOPS_CONSISTENCY,
542 .ipi = RING_BUFFER_IPI_BARRIER,
543 .wakeup = RING_BUFFER_WAKEUP_BY_TIMER,
544};
545
dd5a0db3
MD
546static
547void release_priv_ops(void *priv_ops)
548{
549 module_put(THIS_MODULE);
550}
551
552static
553void lttng_channel_destroy(struct channel *chan)
554{
555 channel_destroy(chan);
556}
557
1e2015dc 558static
1c25284c 559struct channel *_channel_create(const char *name,
a90917c3 560 struct lttng_channel *lttng_chan, void *buf_addr,
1c25284c
MD
561 size_t subbuf_size, size_t num_subbuf,
562 unsigned int switch_timer_interval,
563 unsigned int read_timer_interval)
7514523f 564{
dd5a0db3
MD
565 struct channel *chan;
566
567 chan = channel_create(&client_config, name, lttng_chan, buf_addr,
7514523f
MD
568 subbuf_size, num_subbuf, switch_timer_interval,
569 read_timer_interval);
dd5a0db3
MD
570 if (chan) {
571 /*
572 * Ensure this module is not unloaded before we finish
573 * using lttng_relay_transport.ops.
574 */
575 if (!try_module_get(THIS_MODULE)) {
576 printk(KERN_WARNING "LTT : Can't lock transport module.\n");
577 goto error;
578 }
579 chan->backend.priv_ops = &lttng_relay_transport.ops;
580 chan->backend.release_priv_ops = release_priv_ops;
581 }
582 return chan;
7514523f 583
dd5a0db3
MD
584error:
585 lttng_channel_destroy(chan);
586 return NULL;
7514523f
MD
587}
588
ad1c05e1 589static
a90917c3 590struct lib_ring_buffer *lttng_buffer_read_open(struct channel *chan)
ad1c05e1
MD
591{
592 struct lib_ring_buffer *buf;
593 int cpu;
594
1c25284c
MD
595 for_each_channel_cpu(cpu, chan) {
596 buf = channel_get_ring_buffer(&client_config, chan, cpu);
ad1c05e1
MD
597 if (!lib_ring_buffer_open_read(buf))
598 return buf;
599 }
600 return NULL;
601}
602
f71ecafa 603static
a90917c3 604int lttng_buffer_has_read_closed_stream(struct channel *chan)
f71ecafa
MD
605{
606 struct lib_ring_buffer *buf;
607 int cpu;
608
609 for_each_channel_cpu(cpu, chan) {
610 buf = channel_get_ring_buffer(&client_config, chan, cpu);
611 if (!atomic_long_read(&buf->active_readers))
612 return 1;
613 }
614 return 0;
615}
616
ad1c05e1 617static
a90917c3 618void lttng_buffer_read_close(struct lib_ring_buffer *buf)
ad1c05e1
MD
619{
620 lib_ring_buffer_release_read(buf);
1c25284c
MD
621}
622
c099397a 623static
a90917c3 624int lttng_event_reserve(struct lib_ring_buffer_ctx *ctx,
64c796d8 625 uint32_t event_id)
1c25284c 626{
a90917c3 627 struct lttng_channel *lttng_chan = channel_get_private(ctx->chan);
cc62f29e
MD
628 struct lttng_probe_ctx *lttng_probe_ctx = ctx->priv;
629 struct lttng_event *event = lttng_probe_ctx->event;
630 struct lttng_client_ctx client_ctx;
1c25284c
MD
631 int ret, cpu;
632
cc62f29e
MD
633 /* Compute internal size of context structures. */
634 ctx_get_struct_size(lttng_chan->ctx, &client_ctx.packet_context_len);
635 ctx_get_struct_size(event->ctx, &client_ctx.event_context_len);
636
1c25284c 637 cpu = lib_ring_buffer_get_cpu(&client_config);
5ebb028f 638 if (unlikely(cpu < 0))
1c25284c
MD
639 return -EPERM;
640 ctx->cpu = cpu;
641
a90917c3 642 switch (lttng_chan->header_type) {
64c796d8
MD
643 case 1: /* compact */
644 if (event_id > 30)
a90917c3 645 ctx->rflags |= LTTNG_RFLAG_EXTENDED;
64c796d8
MD
646 break;
647 case 2: /* large */
648 if (event_id > 65534)
a90917c3 649 ctx->rflags |= LTTNG_RFLAG_EXTENDED;
64c796d8
MD
650 break;
651 default:
652 WARN_ON_ONCE(1);
653 }
654
cc62f29e 655 ret = lib_ring_buffer_reserve(&client_config, ctx, &client_ctx);
5ebb028f 656 if (unlikely(ret))
1c25284c 657 goto put;
85a07c33
MD
658 lib_ring_buffer_backend_get_pages(&client_config, ctx,
659 &ctx->backend_pages);
a90917c3 660 lttng_write_event_header(&client_config, ctx, event_id);
4e1f08f4 661 return 0;
1c25284c
MD
662put:
663 lib_ring_buffer_put_cpu(&client_config);
664 return ret;
ad1c05e1
MD
665}
666
c099397a 667static
a90917c3 668void lttng_event_commit(struct lib_ring_buffer_ctx *ctx)
1c25284c
MD
669{
670 lib_ring_buffer_commit(&client_config, ctx);
671 lib_ring_buffer_put_cpu(&client_config);
672}
673
c099397a 674static
a90917c3 675void lttng_event_write(struct lib_ring_buffer_ctx *ctx, const void *src,
e763dbf5
MD
676 size_t len)
677{
678 lib_ring_buffer_write(&client_config, ctx, src, len);
679}
1c25284c 680
4ea00e4f 681static
a90917c3 682void lttng_event_write_from_user(struct lib_ring_buffer_ctx *ctx,
4ea00e4f
JD
683 const void __user *src, size_t len)
684{
7b8ea3a5 685 lib_ring_buffer_copy_from_user_inatomic(&client_config, ctx, src, len);
4ea00e4f
JD
686}
687
58aa5d24 688static
a90917c3 689void lttng_event_memset(struct lib_ring_buffer_ctx *ctx,
58aa5d24
MD
690 int c, size_t len)
691{
692 lib_ring_buffer_memset(&client_config, ctx, c, len);
693}
694
16f78f3a
MD
695static
696void lttng_event_strcpy(struct lib_ring_buffer_ctx *ctx, const char *src,
697 size_t len)
698{
699 lib_ring_buffer_strcpy(&client_config, ctx, src, len, '#');
700}
701
702static
703void lttng_event_strcpy_from_user(struct lib_ring_buffer_ctx *ctx,
704 const char __user *src, size_t len)
705{
706 lib_ring_buffer_strcpy_from_user_inatomic(&client_config, ctx, src,
707 len, '#');
708}
709
c099397a 710static
a90917c3 711wait_queue_head_t *lttng_get_writer_buf_wait_queue(struct channel *chan, int cpu)
c099397a 712{
71c1d843
MD
713 struct lib_ring_buffer *buf = channel_get_ring_buffer(&client_config,
714 chan, cpu);
715 return &buf->write_wait;
24cedcfe
MD
716}
717
718static
a90917c3 719wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan)
24cedcfe
MD
720{
721 return &chan->hp_wait;
722}
723
724static
a90917c3 725int lttng_is_finalized(struct channel *chan)
24cedcfe
MD
726{
727 return lib_ring_buffer_channel_is_finalized(chan);
c099397a
MD
728}
729
254ec7bc 730static
a90917c3 731int lttng_is_disabled(struct channel *chan)
254ec7bc
MD
732{
733 return lib_ring_buffer_channel_is_disabled(chan);
734}
735
a90917c3 736static struct lttng_transport lttng_relay_transport = {
3d084699 737 .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING,
7514523f
MD
738 .owner = THIS_MODULE,
739 .ops = {
1c25284c 740 .channel_create = _channel_create,
a90917c3
MD
741 .channel_destroy = lttng_channel_destroy,
742 .buffer_read_open = lttng_buffer_read_open,
f71ecafa 743 .buffer_has_read_closed_stream =
a90917c3
MD
744 lttng_buffer_has_read_closed_stream,
745 .buffer_read_close = lttng_buffer_read_close,
746 .event_reserve = lttng_event_reserve,
747 .event_commit = lttng_event_commit,
748 .event_write = lttng_event_write,
749 .event_write_from_user = lttng_event_write_from_user,
750 .event_memset = lttng_event_memset,
16f78f3a
MD
751 .event_strcpy = lttng_event_strcpy,
752 .event_strcpy_from_user = lttng_event_strcpy_from_user,
1ec3f75a 753 .packet_avail_size = NULL, /* Would be racy anyway */
a90917c3
MD
754 .get_writer_buf_wait_queue = lttng_get_writer_buf_wait_queue,
755 .get_hp_wait_queue = lttng_get_hp_wait_queue,
756 .is_finalized = lttng_is_finalized,
757 .is_disabled = lttng_is_disabled,
67a80835
MD
758 .timestamp_begin = client_timestamp_begin,
759 .timestamp_end = client_timestamp_end,
760 .events_discarded = client_events_discarded,
761 .content_size = client_content_size,
762 .packet_size = client_packet_size,
763 .stream_id = client_stream_id,
764 .current_timestamp = client_current_timestamp,
5b3cf4f9 765 .sequence_number = client_sequence_number,
5594698f 766 .instance_id = client_instance_id,
7514523f
MD
767 },
768};
769
a90917c3 770static int __init lttng_ring_buffer_client_init(void)
7514523f 771{
a509e133
MD
772 /*
773 * This vmalloc sync all also takes care of the lib ring buffer
774 * vmalloc'd module pages when it is built as a module into LTTng.
775 */
6d2a620c 776 wrapper_vmalloc_sync_all();
a90917c3 777 lttng_transport_register(&lttng_relay_transport);
7514523f
MD
778 return 0;
779}
780
a90917c3 781module_init(lttng_ring_buffer_client_init);
1c25284c 782
a90917c3 783static void __exit lttng_ring_buffer_client_exit(void)
7514523f 784{
a90917c3 785 lttng_transport_unregister(&lttng_relay_transport);
7514523f
MD
786}
787
a90917c3 788module_exit(lttng_ring_buffer_client_exit);
1c25284c 789
7514523f
MD
790MODULE_LICENSE("GPL and additional rights");
791MODULE_AUTHOR("Mathieu Desnoyers");
3d084699
MD
792MODULE_DESCRIPTION("LTTng ring buffer " RING_BUFFER_MODE_TEMPLATE_STRING
793 " client");
This page took 0.078677 seconds and 4 git commands to generate.