Add flush buffers command
[lttng-ust.git] / libust / 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>
f4681817 12#include <ust/lttng-events.h>
9f3fdbc6 13#include "ust/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
35static const struct lib_ring_buffer_config client_config;
36
37static inline
38u64 lib_ring_buffer_clock_read(struct channel *chan)
39{
40 return 0;
41}
42
43static inline
44unsigned char record_header_size(const struct lib_ring_buffer_config *config,
45 struct channel *chan, size_t offset,
46 size_t *pre_header_padding,
47 struct lib_ring_buffer_ctx *ctx)
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
60size_t client_record_header_size(const struct lib_ring_buffer_config *config,
61 struct channel *chan, size_t offset,
62 size_t *pre_header_padding,
63 struct lib_ring_buffer_ctx *ctx)
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
80static void client_buffer_begin(struct lib_ring_buffer *buf, u64 tsc,
1d498196
MD
81 unsigned int subbuf_idx,
82 struct 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
MD
90 struct ltt_channel *ltt_chan = channel_get_private(chan);
91 struct ltt_session *session = ltt_chan->session;
92
93 header->magic = TSDL_MAGIC_NUMBER;
9f3fdbc6 94 memcpy(header->uuid, session->uuid, sizeof(session->uuid));
3d1fc7fd
MD
95 header->checksum = 0; /* 0 if unused */
96 header->content_size = 0xFFFFFFFF; /* in bits, for debugging */
97 header->packet_size = 0xFFFFFFFF; /* in bits, for debugging */
98 header->compression_scheme = 0; /* 0 if unused */
99 header->encryption_scheme = 0; /* 0 if unused */
100 header->checksum_scheme = 0; /* 0 if unused */
8a98a75d
MD
101 header->major = CTF_SPEC_MAJOR;
102 header->minor = CTF_SPEC_MINOR;
103
3d1fc7fd
MD
104}
105
106/*
107 * offset is assumed to never be 0 here : never deliver a completely empty
108 * subbuffer. data_size is between 1 and subbuf_size.
109 */
110static void client_buffer_end(struct lib_ring_buffer *buf, u64 tsc,
1d498196
MD
111 unsigned int subbuf_idx, unsigned long data_size,
112 struct shm_handle *handle)
3d1fc7fd 113{
1d498196 114 struct channel *chan = shmp(handle, buf->backend.chan);
3d1fc7fd
MD
115 struct metadata_packet_header *header =
116 (struct metadata_packet_header *)
117 lib_ring_buffer_offset_address(&buf->backend,
1d498196
MD
118 subbuf_idx * chan->backend.subbuf_size,
119 handle);
3d1fc7fd
MD
120 unsigned long records_lost = 0;
121
122 header->content_size = data_size * CHAR_BIT; /* in bits */
123 header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */
124 records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf);
125 records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf);
126 records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf);
127 WARN_ON_ONCE(records_lost != 0);
128}
129
130static int client_buffer_create(struct lib_ring_buffer *buf, void *priv,
1d498196
MD
131 int cpu, const char *name,
132 struct shm_handle *handle)
3d1fc7fd
MD
133{
134 return 0;
135}
136
1d498196
MD
137static void client_buffer_finalize(struct lib_ring_buffer *buf,
138 void *priv, int cpu,
139 struct shm_handle *handle)
3d1fc7fd
MD
140{
141}
142
143static const struct lib_ring_buffer_config client_config = {
144 .cb.ring_buffer_clock_read = client_ring_buffer_clock_read,
145 .cb.record_header_size = client_record_header_size,
146 .cb.subbuffer_header_size = client_packet_header_size,
147 .cb.buffer_begin = client_buffer_begin,
148 .cb.buffer_end = client_buffer_end,
149 .cb.buffer_create = client_buffer_create,
150 .cb.buffer_finalize = client_buffer_finalize,
151
152 .tsc_bits = 0,
153 .alloc = RING_BUFFER_ALLOC_GLOBAL,
154 .sync = RING_BUFFER_SYNC_GLOBAL,
155 .mode = RING_BUFFER_MODE_TEMPLATE,
156 .backend = RING_BUFFER_PAGE,
5d61a504 157 .output = RING_BUFFER_MMAP,
3d1fc7fd 158 .oops = RING_BUFFER_OOPS_CONSISTENCY,
5d61a504
MD
159 .ipi = RING_BUFFER_NO_IPI_BARRIER,
160 .wakeup = RING_BUFFER_WAKEUP_BY_WRITER,
3d1fc7fd
MD
161};
162
163static
1d498196 164struct ltt_channel *_channel_create(const char *name,
3d1fc7fd
MD
165 struct ltt_channel *ltt_chan, void *buf_addr,
166 size_t subbuf_size, size_t num_subbuf,
167 unsigned int switch_timer_interval,
193183fb
MD
168 unsigned int read_timer_interval,
169 int *shm_fd, int *wait_fd,
170 uint64_t *memory_map_size)
3d1fc7fd 171{
1d498196 172 ltt_chan->handle = channel_create(&client_config, name, ltt_chan, buf_addr,
3d1fc7fd 173 subbuf_size, num_subbuf, switch_timer_interval,
193183fb
MD
174 read_timer_interval, shm_fd, wait_fd,
175 memory_map_size);
1b2c2540
MD
176 if (!ltt_chan->handle)
177 return NULL;
178 ltt_chan->chan = shmp(ltt_chan->handle, ltt_chan->handle->chan);
1d498196 179 return ltt_chan;
3d1fc7fd
MD
180}
181
182static
1d498196 183void ltt_channel_destroy(struct ltt_channel *ltt_chan)
3d1fc7fd 184{
824f40b8 185 channel_destroy(ltt_chan->chan, ltt_chan->handle, 0);
3d1fc7fd
MD
186}
187
188static
1d498196 189struct lib_ring_buffer *ltt_buffer_read_open(struct channel *chan,
381c0f1e
MD
190 struct shm_handle *handle,
191 int *shm_fd, int *wait_fd,
192 uint64_t *memory_map_size)
3d1fc7fd
MD
193{
194 struct lib_ring_buffer *buf;
195
381c0f1e
MD
196 buf = channel_get_ring_buffer(&client_config, chan,
197 0, handle, shm_fd, wait_fd, memory_map_size);
824f40b8 198 if (!lib_ring_buffer_open_read(buf, handle, 0))
3d1fc7fd
MD
199 return buf;
200 return NULL;
201}
202
203static
1d498196
MD
204void ltt_buffer_read_close(struct lib_ring_buffer *buf,
205 struct shm_handle *handle)
3d1fc7fd 206{
824f40b8 207 lib_ring_buffer_release_read(buf, handle, 0);
3d1fc7fd
MD
208}
209
210static
211int ltt_event_reserve(struct lib_ring_buffer_ctx *ctx, uint32_t event_id)
212{
213 return lib_ring_buffer_reserve(&client_config, ctx);
214}
215
216static
217void ltt_event_commit(struct lib_ring_buffer_ctx *ctx)
218{
219 lib_ring_buffer_commit(&client_config, ctx);
220}
221
222static
223void ltt_event_write(struct lib_ring_buffer_ctx *ctx, const void *src,
224 size_t len)
225{
226 lib_ring_buffer_write(&client_config, ctx, src, len);
227}
228
229static
1d498196 230size_t ltt_packet_avail_size(struct channel *chan, struct shm_handle *handle)
3d1fc7fd
MD
231
232{
233 unsigned long o_begin;
234 struct lib_ring_buffer *buf;
235
1d498196 236 buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */
3d1fc7fd
MD
237 o_begin = v_read(&client_config, &buf->offset);
238 if (subbuf_offset(o_begin, chan) != 0) {
239 return chan->backend.subbuf_size - subbuf_offset(o_begin, chan);
240 } else {
241 return chan->backend.subbuf_size - subbuf_offset(o_begin, chan)
242 - sizeof(struct metadata_packet_header);
243 }
244}
245
9f3fdbc6 246#if 0
3d1fc7fd
MD
247static
248wait_queue_head_t *ltt_get_reader_wait_queue(struct channel *chan)
249{
250 return &chan->read_wait;
251}
252
253static
254wait_queue_head_t *ltt_get_hp_wait_queue(struct channel *chan)
255{
256 return &chan->hp_wait;
257}
9f3fdbc6 258#endif //0
3d1fc7fd
MD
259
260static
261int ltt_is_finalized(struct channel *chan)
262{
263 return lib_ring_buffer_channel_is_finalized(chan);
264}
265
266static
267int ltt_is_disabled(struct channel *chan)
268{
269 return lib_ring_buffer_channel_is_disabled(chan);
270}
271
43861eab
MD
272static
273int ltt_flush_buffers(struct channel *chan, struct shm_handle *handle)
274{
275 struct lib_ring_buffer *buf;
276 int shm_fd, wait_fd;
277 uint64_t memory_map_size;
278
279 buf = channel_get_ring_buffer(&client_config, chan,
280 0, handle, &shm_fd, &wait_fd,
281 &memory_map_size);
282 lib_ring_buffer_switch(&client_config, buf,
283 SWITCH_ACTIVE, handle);
284 return 0;
285}
286
3d1fc7fd 287static struct ltt_transport ltt_relay_transport = {
818173b9 288 .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap",
3d1fc7fd
MD
289 .ops = {
290 .channel_create = _channel_create,
291 .channel_destroy = ltt_channel_destroy,
292 .buffer_read_open = ltt_buffer_read_open,
293 .buffer_read_close = ltt_buffer_read_close,
294 .event_reserve = ltt_event_reserve,
295 .event_commit = ltt_event_commit,
296 .event_write = ltt_event_write,
297 .packet_avail_size = ltt_packet_avail_size,
9f3fdbc6
MD
298 //.get_reader_wait_queue = ltt_get_reader_wait_queue,
299 //.get_hp_wait_queue = ltt_get_hp_wait_queue,
3d1fc7fd
MD
300 .is_finalized = ltt_is_finalized,
301 .is_disabled = ltt_is_disabled,
43861eab 302 .flush_buffers = ltt_flush_buffers,
3d1fc7fd
MD
303 },
304};
305
edaa1431 306void RING_BUFFER_MODE_TEMPLATE_INIT(void)
3d1fc7fd 307{
18c1cd87 308 DBG("LTT : ltt ring buffer client init\n");
3d1fc7fd 309 ltt_transport_register(&ltt_relay_transport);
3d1fc7fd
MD
310}
311
edaa1431 312void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
3d1fc7fd 313{
18c1cd87 314 DBG("LTT : ltt ring buffer client exit\n");
3d1fc7fd
MD
315 ltt_transport_unregister(&ltt_relay_transport);
316}
This page took 0.036382 seconds and 4 git commands to generate.