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 | |
4cfec15c | 55 | unsigned 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 | 65 | static uint64_t client_ring_buffer_clock_read(struct channel *chan) |
3d1fc7fd MD |
66 | { |
67 | return 0; | |
68 | } | |
69 | ||
70 | static | |
4cfec15c | 71 | size_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 | */ | |
86 | static size_t client_packet_header_size(void) | |
87 | { | |
88 | return offsetof(struct metadata_packet_header, header_end); | |
89 | } | |
90 | ||
23c8854a | 91 | static 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); | |
7dd08bec | 101 | struct lttng_channel *lttng_chan = channel_get_private(chan); |
3d1fc7fd MD |
102 | |
103 | header->magic = TSDL_MAGIC_NUMBER; | |
7dd08bec | 104 | memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_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 | 120 | static 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 | 144 | static 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 | 151 | static 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 | 157 | static 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 | 178 | const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb; |
c1fca457 | 179 | |
3d1fc7fd | 180 | static |
7dd08bec | 181 | struct lttng_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, |
ef9ff354 MD |
186 | int **shm_fd, int **wait_fd, |
187 | uint64_t **memory_map_size, | |
7dd08bec | 188 | struct lttng_channel *chan_priv_init) |
3d1fc7fd | 189 | { |
a3f61e7f | 190 | void *priv; |
7dd08bec | 191 | struct lttng_channel *lttng_chan = NULL; |
a3f61e7f MD |
192 | struct lttng_ust_shm_handle *handle; |
193 | ||
194 | handle = channel_create(&client_config, name, | |
7dd08bec | 195 | &priv, __alignof__(*lttng_chan), sizeof(*lttng_chan), |
d028eddb | 196 | chan_priv_init, |
a3f61e7f MD |
197 | buf_addr, subbuf_size, num_subbuf, |
198 | switch_timer_interval, read_timer_interval, | |
199 | shm_fd, wait_fd, memory_map_size); | |
200 | if (!handle) | |
1b2c2540 | 201 | return NULL; |
7dd08bec MD |
202 | lttng_chan = priv; |
203 | lttng_chan->handle = handle; | |
204 | lttng_chan->chan = shmp(lttng_chan->handle, lttng_chan->handle->chan); | |
205 | return lttng_chan; | |
3d1fc7fd MD |
206 | } |
207 | ||
208 | static | |
7dd08bec | 209 | void lttng_channel_destroy(struct lttng_channel *lttng_chan) |
3d1fc7fd | 210 | { |
7dd08bec | 211 | channel_destroy(lttng_chan->chan, lttng_chan->handle, 0); |
3d1fc7fd MD |
212 | } |
213 | ||
214 | static | |
7dd08bec | 215 | struct lttng_ust_lib_ring_buffer *lttng_buffer_read_open(struct channel *chan, |
38fae1d3 | 216 | struct lttng_ust_shm_handle *handle, |
ef9ff354 MD |
217 | int **shm_fd, int **wait_fd, |
218 | uint64_t **memory_map_size) | |
3d1fc7fd | 219 | { |
4cfec15c | 220 | struct lttng_ust_lib_ring_buffer *buf; |
3d1fc7fd | 221 | |
381c0f1e MD |
222 | buf = channel_get_ring_buffer(&client_config, chan, |
223 | 0, handle, shm_fd, wait_fd, memory_map_size); | |
824f40b8 | 224 | if (!lib_ring_buffer_open_read(buf, handle, 0)) |
3d1fc7fd MD |
225 | return buf; |
226 | return NULL; | |
227 | } | |
228 | ||
229 | static | |
7dd08bec | 230 | void lttng_buffer_read_close(struct lttng_ust_lib_ring_buffer *buf, |
38fae1d3 | 231 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd | 232 | { |
824f40b8 | 233 | lib_ring_buffer_release_read(buf, handle, 0); |
3d1fc7fd MD |
234 | } |
235 | ||
236 | static | |
7dd08bec | 237 | int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id) |
3d1fc7fd MD |
238 | { |
239 | return lib_ring_buffer_reserve(&client_config, ctx); | |
240 | } | |
241 | ||
242 | static | |
7dd08bec | 243 | void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx) |
3d1fc7fd MD |
244 | { |
245 | lib_ring_buffer_commit(&client_config, ctx); | |
246 | } | |
247 | ||
248 | static | |
7dd08bec | 249 | void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src, |
3d1fc7fd MD |
250 | size_t len) |
251 | { | |
252 | lib_ring_buffer_write(&client_config, ctx, src, len); | |
253 | } | |
254 | ||
255 | static | |
7dd08bec | 256 | size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
257 | |
258 | { | |
259 | unsigned long o_begin; | |
4cfec15c | 260 | struct lttng_ust_lib_ring_buffer *buf; |
3d1fc7fd | 261 | |
1d498196 | 262 | buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */ |
3d1fc7fd MD |
263 | o_begin = v_read(&client_config, &buf->offset); |
264 | if (subbuf_offset(o_begin, chan) != 0) { | |
265 | return chan->backend.subbuf_size - subbuf_offset(o_begin, chan); | |
266 | } else { | |
267 | return chan->backend.subbuf_size - subbuf_offset(o_begin, chan) | |
268 | - sizeof(struct metadata_packet_header); | |
269 | } | |
270 | } | |
271 | ||
9f3fdbc6 | 272 | #if 0 |
3d1fc7fd | 273 | static |
7dd08bec | 274 | wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan) |
3d1fc7fd MD |
275 | { |
276 | return &chan->read_wait; | |
277 | } | |
278 | ||
279 | static | |
7dd08bec | 280 | wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan) |
3d1fc7fd MD |
281 | { |
282 | return &chan->hp_wait; | |
283 | } | |
9f3fdbc6 | 284 | #endif //0 |
3d1fc7fd MD |
285 | |
286 | static | |
7dd08bec | 287 | int lttng_is_finalized(struct channel *chan) |
3d1fc7fd MD |
288 | { |
289 | return lib_ring_buffer_channel_is_finalized(chan); | |
290 | } | |
291 | ||
292 | static | |
7dd08bec | 293 | int lttng_is_disabled(struct channel *chan) |
3d1fc7fd MD |
294 | { |
295 | return lib_ring_buffer_channel_is_disabled(chan); | |
296 | } | |
297 | ||
43861eab | 298 | static |
7dd08bec | 299 | int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle) |
43861eab | 300 | { |
4cfec15c | 301 | struct lttng_ust_lib_ring_buffer *buf; |
ef9ff354 MD |
302 | int *shm_fd, *wait_fd; |
303 | uint64_t *memory_map_size; | |
43861eab MD |
304 | |
305 | buf = channel_get_ring_buffer(&client_config, chan, | |
306 | 0, handle, &shm_fd, &wait_fd, | |
307 | &memory_map_size); | |
308 | lib_ring_buffer_switch(&client_config, buf, | |
309 | SWITCH_ACTIVE, handle); | |
310 | return 0; | |
311 | } | |
312 | ||
7dd08bec | 313 | static struct lttng_transport lttng_relay_transport = { |
818173b9 | 314 | .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap", |
3d1fc7fd MD |
315 | .ops = { |
316 | .channel_create = _channel_create, | |
7dd08bec MD |
317 | .channel_destroy = lttng_channel_destroy, |
318 | .buffer_read_open = lttng_buffer_read_open, | |
319 | .buffer_read_close = lttng_buffer_read_close, | |
320 | .event_reserve = lttng_event_reserve, | |
321 | .event_commit = lttng_event_commit, | |
322 | .event_write = lttng_event_write, | |
323 | .packet_avail_size = lttng_packet_avail_size, | |
324 | //.get_reader_wait_queue = lttng_get_reader_wait_queue, | |
325 | //.get_hp_wait_queue = lttng_get_hp_wait_queue, | |
326 | .is_finalized = lttng_is_finalized, | |
327 | .is_disabled = lttng_is_disabled, | |
328 | .flush_buffer = lttng_flush_buffer, | |
3d1fc7fd MD |
329 | }, |
330 | }; | |
331 | ||
edaa1431 | 332 | void RING_BUFFER_MODE_TEMPLATE_INIT(void) |
3d1fc7fd | 333 | { |
18c1cd87 | 334 | DBG("LTT : ltt ring buffer client init\n"); |
7dd08bec | 335 | lttng_transport_register(<tng_relay_transport); |
3d1fc7fd MD |
336 | } |
337 | ||
edaa1431 | 338 | void RING_BUFFER_MODE_TEMPLATE_EXIT(void) |
3d1fc7fd | 339 | { |
18c1cd87 | 340 | DBG("LTT : ltt ring buffer client exit\n"); |
7dd08bec | 341 | lttng_transport_unregister(<tng_relay_transport); |
3d1fc7fd | 342 | } |