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