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