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