Move struct ltt_channel to shm for consumer flush
[lttng-ust.git] / liblttng-ust / ltt-ring-buffer-metadata-client.h
CommitLineData
3d1fc7fd
MD
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
9f3fdbc6 11#include <stdint.h>
4318ae1b
MD
12#include <lttng/ust-events.h>
13#include "lttng/bitfield.h"
3d1fc7fd 14#include "ltt-tracer.h"
9f3fdbc6 15#include "../libringbuffer/frontend_types.h"
3d1fc7fd
MD
16
17struct metadata_packet_header {
18 uint32_t magic; /* 0x75D11D57 */
19 uint8_t uuid[16]; /* Unique Universal Identifier */
20 uint32_t checksum; /* 0 if unused */
21 uint32_t content_size; /* in bits */
22 uint32_t packet_size; /* in bits */
23 uint8_t compression_scheme; /* 0 if unused */
24 uint8_t encryption_scheme; /* 0 if unused */
25 uint8_t checksum_scheme; /* 0 if unused */
8a98a75d
MD
26 uint8_t major; /* CTF spec major version number */
27 uint8_t minor; /* CTF spec minor version number */
3d1fc7fd
MD
28 uint8_t header_end[0];
29};
30
31struct metadata_record_header {
32 uint8_t header_end[0]; /* End of header */
33};
34
4cfec15c 35static const struct lttng_ust_lib_ring_buffer_config client_config;
3d1fc7fd
MD
36
37static inline
38u64 lib_ring_buffer_clock_read(struct channel *chan)
39{
40 return 0;
41}
42
43static inline
4cfec15c 44unsigned char 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,
4cfec15c 47 struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd
MD
48{
49 return 0;
50}
51
9f3fdbc6 52#include "../libringbuffer/api.h"
3d1fc7fd
MD
53
54static u64 client_ring_buffer_clock_read(struct channel *chan)
55{
56 return 0;
57}
58
59static
4cfec15c 60size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config,
3d1fc7fd
MD
61 struct channel *chan, size_t offset,
62 size_t *pre_header_padding,
4cfec15c 63 struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd
MD
64{
65 return 0;
66}
67
68/**
69 * client_packet_header_size - called on buffer-switch to a new sub-buffer
70 *
71 * Return header size without padding after the structure. Don't use packed
72 * structure because gcc generates inefficient code on some architectures
73 * (powerpc, mips..)
74 */
75static size_t client_packet_header_size(void)
76{
77 return offsetof(struct metadata_packet_header, header_end);
78}
79
4cfec15c 80static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, u64 tsc,
1d498196 81 unsigned int subbuf_idx,
38fae1d3 82 struct lttng_ust_shm_handle *handle)
3d1fc7fd 83{
1d498196 84 struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd
MD
85 struct metadata_packet_header *header =
86 (struct metadata_packet_header *)
87 lib_ring_buffer_offset_address(&buf->backend,
1d498196
MD
88 subbuf_idx * chan->backend.subbuf_size,
89 handle);
3d1fc7fd 90 struct ltt_channel *ltt_chan = channel_get_private(chan);
3d1fc7fd
MD
91
92 header->magic = TSDL_MAGIC_NUMBER;
a3f61e7f 93 memcpy(header->uuid, ltt_chan->uuid, sizeof(ltt_chan->uuid));
3d1fc7fd
MD
94 header->checksum = 0; /* 0 if unused */
95 header->content_size = 0xFFFFFFFF; /* in bits, for debugging */
96 header->packet_size = 0xFFFFFFFF; /* in bits, for debugging */
97 header->compression_scheme = 0; /* 0 if unused */
98 header->encryption_scheme = 0; /* 0 if unused */
99 header->checksum_scheme = 0; /* 0 if unused */
8a98a75d
MD
100 header->major = CTF_SPEC_MAJOR;
101 header->minor = CTF_SPEC_MINOR;
102
3d1fc7fd
MD
103}
104
105/*
106 * offset is assumed to never be 0 here : never deliver a completely empty
107 * subbuffer. data_size is between 1 and subbuf_size.
108 */
4cfec15c 109static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, u64 tsc,
1d498196 110 unsigned int subbuf_idx, unsigned long data_size,
38fae1d3 111 struct lttng_ust_shm_handle *handle)
3d1fc7fd 112{
1d498196 113 struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd
MD
114 struct metadata_packet_header *header =
115 (struct metadata_packet_header *)
116 lib_ring_buffer_offset_address(&buf->backend,
1d498196
MD
117 subbuf_idx * chan->backend.subbuf_size,
118 handle);
3d1fc7fd
MD
119 unsigned long records_lost = 0;
120
121 header->content_size = data_size * CHAR_BIT; /* in bits */
122 header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
123 records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
124 records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
125 records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
126 WARN_ON_ONCE(records_lost != 0);
127}
128
4cfec15c 129static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv,
1d498196 130 int cpu, const char *name,
38fae1d3 131 struct lttng_ust_shm_handle *handle)
3d1fc7fd
MD
132{
133 return 0;
134}
135
4cfec15c 136static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf,
1d498196 137 void *priv, int cpu,
38fae1d3 138 struct lttng_ust_shm_handle *handle)
3d1fc7fd
MD
139{
140}
141
4cfec15c 142static const struct lttng_ust_lib_ring_buffer_config client_config = {
3d1fc7fd
MD
143 .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
144 .cb.record_header_size = client_record_header_size,
145 .cb.subbuffer_header_size = client_packet_header_size,
146 .cb.buffer_begin = client_buffer_begin,
147 .cb.buffer_end = client_buffer_end,
148 .cb.buffer_create = client_buffer_create,
149 .cb.buffer_finalize = client_buffer_finalize,
150
151 .tsc_bits = 0,
152 .alloc = RING_BUFFER_ALLOC_GLOBAL,
153 .sync = RING_BUFFER_SYNC_GLOBAL,
154 .mode = RING_BUFFER_MODE_TEMPLATE,
155 .backend = RING_BUFFER_PAGE,
5d61a504 156 .output = RING_BUFFER_MMAP,
3d1fc7fd 157 .oops = RING_BUFFER_OOPS_CONSISTENCY,
5d61a504
MD
158 .ipi = RING_BUFFER_NO_IPI_BARRIER,
159 .wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
c1fca457 160 .client_type = LTTNG_CLIENT_TYPE,
3d1fc7fd
MD
161};
162
7a784989 163const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb;
c1fca457 164
3d1fc7fd 165static
1d498196 166struct ltt_channel *_channel_create(const char *name,
a3f61e7f 167 void *buf_addr,
3d1fc7fd
MD
168 size_t subbuf_size, size_t num_subbuf,
169 unsigned int switch_timer_interval,
193183fb
MD
170 unsigned int read_timer_interval,
171 int *shm_fd, int *wait_fd,
172 uint64_t *memory_map_size)
3d1fc7fd 173{
a3f61e7f
MD
174 void *priv;
175 struct ltt_channel *ltt_chan = NULL;
176 struct lttng_ust_shm_handle *handle;
177
178 handle = channel_create(&client_config, name,
179 &priv, __alignof__(*ltt_chan), sizeof(*ltt_chan),
180 buf_addr, subbuf_size, num_subbuf,
181 switch_timer_interval, read_timer_interval,
182 shm_fd, wait_fd, memory_map_size);
183 if (!handle)
1b2c2540 184 return NULL;
a3f61e7f
MD
185 ltt_chan = priv;
186 ltt_chan->handle = handle;
1b2c2540 187 ltt_chan->chan = shmp(ltt_chan->handle, ltt_chan->handle->chan);
1d498196 188 return ltt_chan;
3d1fc7fd
MD
189}
190
191static
1d498196 192void ltt_channel_destroy(struct ltt_channel *ltt_chan)
3d1fc7fd 193{
824f40b8 194 channel_destroy(ltt_chan->chan, ltt_chan->handle, 0);
3d1fc7fd
MD
195}
196
197static
4cfec15c 198struct lttng_ust_lib_ring_buffer *ltt_buffer_read_open(struct channel *chan,
38fae1d3 199 struct lttng_ust_shm_handle *handle,
381c0f1e
MD
200 int *shm_fd, int *wait_fd,
201 uint64_t *memory_map_size)
3d1fc7fd 202{
4cfec15c 203 struct lttng_ust_lib_ring_buffer *buf;
3d1fc7fd 204
381c0f1e
MD
205 buf = channel_get_ring_buffer(&client_config, chan,
206 0, handle, shm_fd, wait_fd, memory_map_size);
824f40b8 207 if (!lib_ring_buffer_open_read(buf, handle, 0))
3d1fc7fd
MD
208 return buf;
209 return NULL;
210}
211
212static
4cfec15c 213void ltt_buffer_read_close(struct lttng_ust_lib_ring_buffer *buf,
38fae1d3 214 struct lttng_ust_shm_handle *handle)
3d1fc7fd 215{
824f40b8 216 lib_ring_buffer_release_read(buf, handle, 0);
3d1fc7fd
MD
217}
218
219static
4cfec15c 220int ltt_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id)
3d1fc7fd
MD
221{
222 return lib_ring_buffer_reserve(&client_config, ctx);
223}
224
225static
4cfec15c 226void ltt_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx)
3d1fc7fd
MD
227{
228 lib_ring_buffer_commit(&client_config, ctx);
229}
230
231static
4cfec15c 232void ltt_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
3d1fc7fd
MD
233 size_t len)
234{
235 lib_ring_buffer_write(&client_config, ctx, src, len);
236}
237
238static
38fae1d3 239size_t ltt_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle)
3d1fc7fd
MD
240
241{
242 unsigned long o_begin;
4cfec15c 243 struct lttng_ust_lib_ring_buffer *buf;
3d1fc7fd 244
1d498196 245 buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */
3d1fc7fd
MD
246 o_begin = v_read(&client_config, &buf->offset);
247 if (subbuf_offset(o_begin, chan) != 0) {
248 return chan->backend.subbuf_size - subbuf_offset(o_begin, chan);
249 } else {
250 return chan->backend.subbuf_size - subbuf_offset(o_begin, chan)
251 - sizeof(struct metadata_packet_header);
252 }
253}
254
9f3fdbc6 255#if 0
3d1fc7fd
MD
256static
257wait_queue_head_t *ltt_get_reader_wait_queue(struct channel *chan)
258{
259 return &chan->read_wait;
260}
261
262static
263wait_queue_head_t *ltt_get_hp_wait_queue(struct channel *chan)
264{
265 return &chan->hp_wait;
266}
9f3fdbc6 267#endif //0
3d1fc7fd
MD
268
269static
270int ltt_is_finalized(struct channel *chan)
271{
272 return lib_ring_buffer_channel_is_finalized(chan);
273}
274
275static
276int ltt_is_disabled(struct channel *chan)
277{
278 return lib_ring_buffer_channel_is_disabled(chan);
279}
280
43861eab 281static
38fae1d3 282int ltt_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle)
43861eab 283{
4cfec15c 284 struct lttng_ust_lib_ring_buffer *buf;
43861eab
MD
285 int shm_fd, wait_fd;
286 uint64_t memory_map_size;
287
288 buf = channel_get_ring_buffer(&client_config, chan,
289 0, handle, &shm_fd, &wait_fd,
290 &memory_map_size);
291 lib_ring_buffer_switch(&client_config, buf,
292 SWITCH_ACTIVE, handle);
293 return 0;
294}
295
3d1fc7fd 296static struct ltt_transport ltt_relay_transport = {
818173b9 297 .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
3d1fc7fd
MD
298 .ops = {
299 .channel_create = _channel_create,
300 .channel_destroy = ltt_channel_destroy,
301 .buffer_read_open = ltt_buffer_read_open,
302 .buffer_read_close = ltt_buffer_read_close,
303 .event_reserve = ltt_event_reserve,
304 .event_commit = ltt_event_commit,
305 .event_write = ltt_event_write,
306 .packet_avail_size = ltt_packet_avail_size,
9f3fdbc6
MD
307 //.get_reader_wait_queue = ltt_get_reader_wait_queue,
308 //.get_hp_wait_queue = ltt_get_hp_wait_queue,
3d1fc7fd
MD
309 .is_finalized = ltt_is_finalized,
310 .is_disabled = ltt_is_disabled,
43d330a4 311 .flush_buffer = ltt_flush_buffer,
3d1fc7fd
MD
312 },
313};
314
edaa1431 315void RING_BUFFER_MODE_TEMPLATE_INIT(void)
3d1fc7fd 316{
18c1cd87 317 DBG("LTT : ltt ring buffer client init\n");
3d1fc7fd 318 ltt_transport_register(&ltt_relay_transport);
3d1fc7fd
MD
319}
320
edaa1431 321void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
3d1fc7fd 322{
18c1cd87 323 DBG("LTT : ltt ring buffer client exit\n");
3d1fc7fd
MD
324 ltt_transport_unregister(&ltt_relay_transport);
325}
This page took 0.038912 seconds and 4 git commands to generate.