Refactor struct lttng_ust_lib_ring_buffer_ctx
[lttng-ust.git] / liblttng-ust / lttng-ring-buffer-metadata-client.h
CommitLineData
3d1fc7fd 1/*
c0c0989a 2 * SPDX-License-Identifier: LGPL-2.1-only
3d1fc7fd 3 *
e92f3e28
MD
4 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
c0c0989a 6 * LTTng lib ring buffer client template.
3d1fc7fd
MD
7 */
8
b4051ad8 9#include <stddef.h>
9f3fdbc6 10#include <stdint.h>
7753d283
MJ
11
12#include <ust-events-internal.h>
ae4b659d 13#include "ust-bitfield.h"
cd61d9bf 14#include "ust-compat.h"
7dd08bec 15#include "lttng-tracer.h"
9f3fdbc6 16#include "../libringbuffer/frontend_types.h"
3d1fc7fd
MD
17
18struct metadata_packet_header {
19 uint32_t magic; /* 0x75D11D57 */
19d8b1b3 20 uint8_t uuid[LTTNG_UST_UUID_LEN]; /* Unique Universal Identifier */
3d1fc7fd
MD
21 uint32_t checksum; /* 0 if unused */
22 uint32_t content_size; /* in bits */
23 uint32_t packet_size; /* in bits */
24 uint8_t compression_scheme; /* 0 if unused */
25 uint8_t encryption_scheme; /* 0 if unused */
26 uint8_t checksum_scheme; /* 0 if unused */
8a98a75d
MD
27 uint8_t major; /* CTF spec major version number */
28 uint8_t minor; /* CTF spec minor version number */
3d1fc7fd
MD
29 uint8_t header_end[0];
30};
31
32struct metadata_record_header {
33 uint8_t header_end[0]; /* End of header */
34};
35
4cfec15c 36static const struct lttng_ust_lib_ring_buffer_config client_config;
3d1fc7fd 37
23c8854a 38static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan)
3d1fc7fd
MD
39{
40 return 0;
41}
42
43static inline
8ca68914 44size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
3d1fc7fd
MD
45 struct channel *chan, size_t offset,
46 size_t *pre_header_padding,
e56bb47c
MD
47 struct lttng_ust_lib_ring_buffer_ctx *ctx,
48 void *client_ctx)
3d1fc7fd
MD
49{
50 return 0;
51}
52
9f3fdbc6 53#include "../libringbuffer/api.h"
82b9bde8 54#include "lttng-rb-clients.h"
3d1fc7fd 55
23c8854a 56static uint64_t client_ring_buffer_clock_read(struct channel *chan)
3d1fc7fd
MD
57{
58 return 0;
59}
60
61static
4cfec15c 62size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
3d1fc7fd
MD
63 struct channel *chan, size_t offset,
64 size_t *pre_header_padding,
e56bb47c
MD
65 struct lttng_ust_lib_ring_buffer_ctx *ctx,
66 void *client_ctx)
3d1fc7fd
MD
67{
68 return 0;
69}
70
71/**
72 * client_packet_header_size - called on buffer-switch to a new sub-buffer
73 *
74 * Return header size without padding after the structure. Don't use packed
75 * structure because gcc generates inefficient code on some architectures
76 * (powerpc, mips..)
77 */
78static size_t client_packet_header_size(void)
79{
80 return offsetof(struct metadata_packet_header, header_end);
81}
82
23c8854a 83static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
1d498196 84 unsigned int subbuf_idx,
38fae1d3 85 struct lttng_ust_shm_handle *handle)
3d1fc7fd 86{
1d498196 87 struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd
MD
88 struct metadata_packet_header *header =
89 (struct metadata_packet_header *)
90 lib_ring_buffer_offset_address(&buf->backend,
1d498196
MD
91 subbuf_idx * chan->backend.subbuf_size,
92 handle);
7dd08bec 93 struct lttng_channel *lttng_chan = channel_get_private(chan);
3d1fc7fd 94
34daae3e
MD
95 assert(header);
96 if (!header)
97 return;
3d1fc7fd 98 header->magic = TSDL_MAGIC_NUMBER;
7dd08bec 99 memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid));
3d1fc7fd
MD
100 header->checksum = 0; /* 0 if unused */
101 header->content_size = 0xFFFFFFFF; /* in bits, for debugging */
102 header->packet_size = 0xFFFFFFFF; /* in bits, for debugging */
103 header->compression_scheme = 0; /* 0 if unused */
104 header->encryption_scheme = 0; /* 0 if unused */
105 header->checksum_scheme = 0; /* 0 if unused */
8a98a75d
MD
106 header->major = CTF_SPEC_MAJOR;
107 header->minor = CTF_SPEC_MINOR;
3d1fc7fd
MD
108}
109
110/*
111 * offset is assumed to never be 0 here : never deliver a completely empty
112 * subbuffer. data_size is between 1 and subbuf_size.
113 */
23c8854a 114static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc,
1d498196 115 unsigned int subbuf_idx, unsigned long data_size,
38fae1d3 116 struct lttng_ust_shm_handle *handle)
3d1fc7fd 117{
1d498196 118 struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd
MD
119 struct metadata_packet_header *header =
120 (struct metadata_packet_header *)
121 lib_ring_buffer_offset_address(&buf->backend,
1d498196
MD
122 subbuf_idx * chan->backend.subbuf_size,
123 handle);
3d1fc7fd
MD
124 unsigned long records_lost = 0;
125
34daae3e
MD
126 assert(header);
127 if (!header)
128 return;
3d1fc7fd 129 header->content_size = data_size * CHAR_BIT; /* in bits */
b72687b8 130 header->packet_size = LTTNG_UST_PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
04489ab4
MD
131 /*
132 * We do not care about the records lost count, because the metadata
133 * channel waits and retry.
134 */
135 (void) lib_ring_buffer_get_records_lost_full(&client_config, buf);
3d1fc7fd
MD
136 records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
137 records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
138 WARN_ON_ONCE(records_lost != 0);
139}
140
4cfec15c 141static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv,
1d498196 142 int cpu, const char *name,
38fae1d3 143 struct lttng_ust_shm_handle *handle)
3d1fc7fd
MD
144{
145 return 0;
146}
147
4cfec15c 148static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf,
1d498196 149 void *priv, int cpu,
38fae1d3 150 struct lttng_ust_shm_handle *handle)
3d1fc7fd
MD
151{
152}
153
82b9bde8
JD
154static const
155struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = {
156 .parent = {
157 .ring_buffer_clock_read = client_ring_buffer_clock_read,
158 .record_header_size = client_record_header_size,
159 .subbuffer_header_size = client_packet_header_size,
160 .buffer_begin = client_buffer_begin,
161 .buffer_end = client_buffer_end,
162 .buffer_create = client_buffer_create,
163 .buffer_finalize = client_buffer_finalize,
164 },
165};
166
4cfec15c 167static const struct lttng_ust_lib_ring_buffer_config client_config = {
3d1fc7fd
MD
168 .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
169 .cb.record_header_size = client_record_header_size,
170 .cb.subbuffer_header_size = client_packet_header_size,
171 .cb.buffer_begin = client_buffer_begin,
172 .cb.buffer_end = client_buffer_end,
173 .cb.buffer_create = client_buffer_create,
174 .cb.buffer_finalize = client_buffer_finalize,
175
176 .tsc_bits = 0,
177 .alloc = RING_BUFFER_ALLOC_GLOBAL,
178 .sync = RING_BUFFER_SYNC_GLOBAL,
179 .mode = RING_BUFFER_MODE_TEMPLATE,
180 .backend = RING_BUFFER_PAGE,
5d61a504 181 .output = RING_BUFFER_MMAP,
3d1fc7fd 182 .oops = RING_BUFFER_OOPS_CONSISTENCY,
5d61a504
MD
183 .ipi = RING_BUFFER_NO_IPI_BARRIER,
184 .wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
c1fca457 185 .client_type = LTTNG_CLIENT_TYPE,
82b9bde8
JD
186
187 .cb_ptr = &client_cb.parent,
3d1fc7fd
MD
188};
189
190static
7dd08bec 191struct lttng_channel *_channel_create(const char *name,
a3f61e7f 192 void *buf_addr,
3d1fc7fd
MD
193 size_t subbuf_size, size_t num_subbuf,
194 unsigned int switch_timer_interval,
193183fb 195 unsigned int read_timer_interval,
6ca18e66 196 unsigned char *uuid,
a9ff648c 197 uint32_t chan_id,
b2c5f61a
MD
198 const int *stream_fds, int nr_stream_fds,
199 int64_t blocking_timeout)
3d1fc7fd 200{
74d81a6c 201 struct lttng_channel chan_priv_init;
a3f61e7f 202 struct lttng_ust_shm_handle *handle;
74d81a6c
MD
203 struct lttng_channel *lttng_chan;
204 void *priv;
a3f61e7f 205
74d81a6c
MD
206 memset(&chan_priv_init, 0, sizeof(chan_priv_init));
207 memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN);
6ca18e66 208 chan_priv_init.id = chan_id;
a3f61e7f 209 handle = channel_create(&client_config, name,
8824f307
MD
210 &priv, __alignof__(struct lttng_channel),
211 sizeof(struct lttng_channel),
74d81a6c 212 &chan_priv_init,
a3f61e7f 213 buf_addr, subbuf_size, num_subbuf,
a9ff648c 214 switch_timer_interval, read_timer_interval,
b2c5f61a 215 stream_fds, nr_stream_fds, blocking_timeout);
a3f61e7f 216 if (!handle)
1b2c2540 217 return NULL;
7dd08bec
MD
218 lttng_chan = priv;
219 lttng_chan->handle = handle;
74d81a6c 220 lttng_chan->chan = shmp(handle, handle->chan);
7dd08bec 221 return lttng_chan;
3d1fc7fd
MD
222}
223
224static
74d81a6c 225void lttng_channel_destroy(struct lttng_channel *chan)
3d1fc7fd 226{
74d81a6c 227 channel_destroy(chan->chan, chan->handle, 1);
3d1fc7fd
MD
228}
229
230static
7dd08bec 231int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id)
3d1fc7fd 232{
a3492932
MD
233 int ret;
234
e56bb47c 235 ret = lib_ring_buffer_reserve(&client_config, ctx, NULL);
a3492932
MD
236 if (ret)
237 return ret;
2b7080aa
MD
238 if (lib_ring_buffer_backend_get_pages(&client_config, ctx,
239 &ctx->backend_pages))
240 return -EPERM;
a3492932 241 return 0;
3d1fc7fd
MD
242}
243
244static
7dd08bec 245void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd
MD
246{
247 lib_ring_buffer_commit(&client_config, ctx);
248}
249
250static
7dd08bec 251void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
3d1fc7fd
MD
252 size_t len)
253{
254 lib_ring_buffer_write(&client_config, ctx, src, len);
255}
256
257static
7dd08bec 258size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle)
3d1fc7fd
MD
259{
260 unsigned long o_begin;
4cfec15c 261 struct lttng_ust_lib_ring_buffer *buf;
3d1fc7fd 262
1d498196 263 buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */
3d1fc7fd
MD
264 o_begin = v_read(&client_config, &buf->offset);
265 if (subbuf_offset(o_begin, chan) != 0) {
266 return chan->backend.subbuf_size - subbuf_offset(o_begin, chan);
267 } else {
268 return chan->backend.subbuf_size - subbuf_offset(o_begin, chan)
269 - sizeof(struct metadata_packet_header);
270 }
271}
272
9f3fdbc6 273#if 0
3d1fc7fd 274static
7dd08bec 275wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan)
3d1fc7fd
MD
276{
277 return &chan->read_wait;
278}
279
280static
7dd08bec 281wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan)
3d1fc7fd
MD
282{
283 return &chan->hp_wait;
284}
9f3fdbc6 285#endif //0
3d1fc7fd
MD
286
287static
7dd08bec 288int lttng_is_finalized(struct channel *chan)
3d1fc7fd
MD
289{
290 return lib_ring_buffer_channel_is_finalized(chan);
291}
292
293static
7dd08bec 294int lttng_is_disabled(struct channel *chan)
3d1fc7fd
MD
295{
296 return lib_ring_buffer_channel_is_disabled(chan);
297}
298
43861eab 299static
7dd08bec 300int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle)
43861eab 301{
4cfec15c 302 struct lttng_ust_lib_ring_buffer *buf;
74d81a6c
MD
303 int shm_fd, wait_fd, wakeup_fd;
304 uint64_t memory_map_size;
43861eab
MD
305
306 buf = channel_get_ring_buffer(&client_config, chan,
74d81a6c 307 0, handle, &shm_fd, &wait_fd, &wakeup_fd,
43861eab
MD
308 &memory_map_size);
309 lib_ring_buffer_switch(&client_config, buf,
310 SWITCH_ACTIVE, handle);
311 return 0;
312}
313
7dd08bec 314static struct lttng_transport lttng_relay_transport = {
818173b9 315 .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
3d1fc7fd
MD
316 .ops = {
317 .channel_create = _channel_create,
7dd08bec 318 .channel_destroy = lttng_channel_destroy,
7dd08bec
MD
319 .event_reserve = lttng_event_reserve,
320 .event_commit = lttng_event_commit,
321 .event_write = lttng_event_write,
322 .packet_avail_size = lttng_packet_avail_size,
323 //.get_reader_wait_queue = lttng_get_reader_wait_queue,
324 //.get_hp_wait_queue = lttng_get_hp_wait_queue,
325 .is_finalized = lttng_is_finalized,
326 .is_disabled = lttng_is_disabled,
327 .flush_buffer = lttng_flush_buffer,
3d1fc7fd 328 },
74d81a6c 329 .client_config = &client_config,
3d1fc7fd
MD
330};
331
edaa1431 332void RING_BUFFER_MODE_TEMPLATE_INIT(void)
3d1fc7fd 333{
34a91bdb
MD
334 DBG("LTT : ltt ring buffer client \"%s\" init\n",
335 "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap");
7dd08bec 336 lttng_transport_register(&lttng_relay_transport);
3d1fc7fd
MD
337}
338
edaa1431 339void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
3d1fc7fd 340{
34a91bdb
MD
341 DBG("LTT : ltt ring buffer client \"%s\" exit\n",
342 "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap");
7dd08bec 343 lttng_transport_unregister(&lttng_relay_transport);
3d1fc7fd 344}
This page took 0.051 seconds and 4 git commands to generate.