Commit | Line | Data |
---|---|---|
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 | |
17 | struct 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 | ||
31 | struct metadata_record_header { | |
32 | uint8_t header_end[0]; /* End of header */ | |
33 | }; | |
34 | ||
4cfec15c | 35 | static const struct lttng_ust_lib_ring_buffer_config client_config; |
3d1fc7fd MD |
36 | |
37 | static inline | |
38 | u64 lib_ring_buffer_clock_read(struct channel *chan) | |
39 | { | |
40 | return 0; | |
41 | } | |
42 | ||
43 | static inline | |
4cfec15c | 44 | unsigned 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 | |
54 | static u64 client_ring_buffer_clock_read(struct channel *chan) | |
55 | { | |
56 | return 0; | |
57 | } | |
58 | ||
59 | static | |
4cfec15c | 60 | size_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 | */ | |
75 | static size_t client_packet_header_size(void) | |
76 | { | |
77 | return offsetof(struct metadata_packet_header, header_end); | |
78 | } | |
79 | ||
4cfec15c | 80 | static 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 | 109 | static 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 | 129 | static 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 | 136 | static 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 | 142 | static 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 | 163 | const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb; |
c1fca457 | 164 | |
3d1fc7fd | 165 | static |
1d498196 | 166 | struct 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, | |
d028eddb MD |
172 | uint64_t *memory_map_size, |
173 | struct ltt_channel *chan_priv_init) | |
3d1fc7fd | 174 | { |
a3f61e7f MD |
175 | void *priv; |
176 | struct ltt_channel *ltt_chan = NULL; | |
177 | struct lttng_ust_shm_handle *handle; | |
178 | ||
179 | handle = channel_create(&client_config, name, | |
180 | &priv, __alignof__(*ltt_chan), sizeof(*ltt_chan), | |
d028eddb | 181 | chan_priv_init, |
a3f61e7f MD |
182 | buf_addr, subbuf_size, num_subbuf, |
183 | switch_timer_interval, read_timer_interval, | |
184 | shm_fd, wait_fd, memory_map_size); | |
185 | if (!handle) | |
1b2c2540 | 186 | return NULL; |
a3f61e7f MD |
187 | ltt_chan = priv; |
188 | ltt_chan->handle = handle; | |
1b2c2540 | 189 | ltt_chan->chan = shmp(ltt_chan->handle, ltt_chan->handle->chan); |
1d498196 | 190 | return ltt_chan; |
3d1fc7fd MD |
191 | } |
192 | ||
193 | static | |
1d498196 | 194 | void ltt_channel_destroy(struct ltt_channel *ltt_chan) |
3d1fc7fd | 195 | { |
824f40b8 | 196 | channel_destroy(ltt_chan->chan, ltt_chan->handle, 0); |
3d1fc7fd MD |
197 | } |
198 | ||
199 | static | |
4cfec15c | 200 | struct lttng_ust_lib_ring_buffer *ltt_buffer_read_open(struct channel *chan, |
38fae1d3 | 201 | struct lttng_ust_shm_handle *handle, |
381c0f1e MD |
202 | int *shm_fd, int *wait_fd, |
203 | uint64_t *memory_map_size) | |
3d1fc7fd | 204 | { |
4cfec15c | 205 | struct lttng_ust_lib_ring_buffer *buf; |
3d1fc7fd | 206 | |
381c0f1e MD |
207 | buf = channel_get_ring_buffer(&client_config, chan, |
208 | 0, handle, shm_fd, wait_fd, memory_map_size); | |
824f40b8 | 209 | if (!lib_ring_buffer_open_read(buf, handle, 0)) |
3d1fc7fd MD |
210 | return buf; |
211 | return NULL; | |
212 | } | |
213 | ||
214 | static | |
4cfec15c | 215 | void ltt_buffer_read_close(struct lttng_ust_lib_ring_buffer *buf, |
38fae1d3 | 216 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd | 217 | { |
824f40b8 | 218 | lib_ring_buffer_release_read(buf, handle, 0); |
3d1fc7fd MD |
219 | } |
220 | ||
221 | static | |
4cfec15c | 222 | int ltt_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id) |
3d1fc7fd MD |
223 | { |
224 | return lib_ring_buffer_reserve(&client_config, ctx); | |
225 | } | |
226 | ||
227 | static | |
4cfec15c | 228 | void ltt_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx) |
3d1fc7fd MD |
229 | { |
230 | lib_ring_buffer_commit(&client_config, ctx); | |
231 | } | |
232 | ||
233 | static | |
4cfec15c | 234 | void ltt_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src, |
3d1fc7fd MD |
235 | size_t len) |
236 | { | |
237 | lib_ring_buffer_write(&client_config, ctx, src, len); | |
238 | } | |
239 | ||
240 | static | |
38fae1d3 | 241 | size_t ltt_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
242 | |
243 | { | |
244 | unsigned long o_begin; | |
4cfec15c | 245 | struct lttng_ust_lib_ring_buffer *buf; |
3d1fc7fd | 246 | |
1d498196 | 247 | buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */ |
3d1fc7fd MD |
248 | o_begin = v_read(&client_config, &buf->offset); |
249 | if (subbuf_offset(o_begin, chan) != 0) { | |
250 | return chan->backend.subbuf_size - subbuf_offset(o_begin, chan); | |
251 | } else { | |
252 | return chan->backend.subbuf_size - subbuf_offset(o_begin, chan) | |
253 | - sizeof(struct metadata_packet_header); | |
254 | } | |
255 | } | |
256 | ||
9f3fdbc6 | 257 | #if 0 |
3d1fc7fd MD |
258 | static |
259 | wait_queue_head_t *ltt_get_reader_wait_queue(struct channel *chan) | |
260 | { | |
261 | return &chan->read_wait; | |
262 | } | |
263 | ||
264 | static | |
265 | wait_queue_head_t *ltt_get_hp_wait_queue(struct channel *chan) | |
266 | { | |
267 | return &chan->hp_wait; | |
268 | } | |
9f3fdbc6 | 269 | #endif //0 |
3d1fc7fd MD |
270 | |
271 | static | |
272 | int ltt_is_finalized(struct channel *chan) | |
273 | { | |
274 | return lib_ring_buffer_channel_is_finalized(chan); | |
275 | } | |
276 | ||
277 | static | |
278 | int ltt_is_disabled(struct channel *chan) | |
279 | { | |
280 | return lib_ring_buffer_channel_is_disabled(chan); | |
281 | } | |
282 | ||
43861eab | 283 | static |
38fae1d3 | 284 | int ltt_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle) |
43861eab | 285 | { |
4cfec15c | 286 | struct lttng_ust_lib_ring_buffer *buf; |
43861eab MD |
287 | int shm_fd, wait_fd; |
288 | uint64_t memory_map_size; | |
289 | ||
290 | buf = channel_get_ring_buffer(&client_config, chan, | |
291 | 0, handle, &shm_fd, &wait_fd, | |
292 | &memory_map_size); | |
293 | lib_ring_buffer_switch(&client_config, buf, | |
294 | SWITCH_ACTIVE, handle); | |
295 | return 0; | |
296 | } | |
297 | ||
3d1fc7fd | 298 | static struct ltt_transport ltt_relay_transport = { |
818173b9 | 299 | .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap", |
3d1fc7fd MD |
300 | .ops = { |
301 | .channel_create = _channel_create, | |
302 | .channel_destroy = ltt_channel_destroy, | |
303 | .buffer_read_open = ltt_buffer_read_open, | |
304 | .buffer_read_close = ltt_buffer_read_close, | |
305 | .event_reserve = ltt_event_reserve, | |
306 | .event_commit = ltt_event_commit, | |
307 | .event_write = ltt_event_write, | |
308 | .packet_avail_size = ltt_packet_avail_size, | |
9f3fdbc6 MD |
309 | //.get_reader_wait_queue = ltt_get_reader_wait_queue, |
310 | //.get_hp_wait_queue = ltt_get_hp_wait_queue, | |
3d1fc7fd MD |
311 | .is_finalized = ltt_is_finalized, |
312 | .is_disabled = ltt_is_disabled, | |
43d330a4 | 313 | .flush_buffer = ltt_flush_buffer, |
3d1fc7fd MD |
314 | }, |
315 | }; | |
316 | ||
edaa1431 | 317 | void RING_BUFFER_MODE_TEMPLATE_INIT(void) |
3d1fc7fd | 318 | { |
18c1cd87 | 319 | DBG("LTT : ltt ring buffer client init\n"); |
3d1fc7fd | 320 | ltt_transport_register(<t_relay_transport); |
3d1fc7fd MD |
321 | } |
322 | ||
edaa1431 | 323 | void RING_BUFFER_MODE_TEMPLATE_EXIT(void) |
3d1fc7fd | 324 | { |
18c1cd87 | 325 | DBG("LTT : ltt ring buffer client exit\n"); |
3d1fc7fd MD |
326 | ltt_transport_unregister(<t_relay_transport); |
327 | } |