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; | |
3d1fc7fd MD |
113 | } |
114 | ||
115 | /* | |
116 | * offset is assumed to never be 0 here : never deliver a completely empty | |
117 | * subbuffer. data_size is between 1 and subbuf_size. | |
118 | */ | |
23c8854a | 119 | static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc, |
1d498196 | 120 | unsigned int subbuf_idx, unsigned long data_size, |
38fae1d3 | 121 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd | 122 | { |
1d498196 | 123 | struct channel *chan = shmp(handle, buf->backend.chan); |
3d1fc7fd MD |
124 | struct metadata_packet_header *header = |
125 | (struct metadata_packet_header *) | |
126 | lib_ring_buffer_offset_address(&buf->backend, | |
1d498196 MD |
127 | subbuf_idx * chan->backend.subbuf_size, |
128 | handle); | |
3d1fc7fd MD |
129 | unsigned long records_lost = 0; |
130 | ||
131 | header->content_size = data_size * CHAR_BIT; /* in bits */ | |
132 | header->packet_size = PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */ | |
04489ab4 MD |
133 | /* |
134 | * We do not care about the records lost count, because the metadata | |
135 | * channel waits and retry. | |
136 | */ | |
137 | (void) lib_ring_buffer_get_records_lost_full(&client_config, buf); | |
3d1fc7fd MD |
138 | records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf); |
139 | records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf); | |
140 | WARN_ON_ONCE(records_lost != 0); | |
141 | } | |
142 | ||
4cfec15c | 143 | static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv, |
1d498196 | 144 | int cpu, const char *name, |
38fae1d3 | 145 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
146 | { |
147 | return 0; | |
148 | } | |
149 | ||
4cfec15c | 150 | static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf, |
1d498196 | 151 | void *priv, int cpu, |
38fae1d3 | 152 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
153 | { |
154 | } | |
155 | ||
4cfec15c | 156 | static const struct lttng_ust_lib_ring_buffer_config client_config = { |
3d1fc7fd MD |
157 | .cb.ring_buffer_clock_read = client_ring_buffer_clock_read, |
158 | .cb.record_header_size = client_record_header_size, | |
159 | .cb.subbuffer_header_size = client_packet_header_size, | |
160 | .cb.buffer_begin = client_buffer_begin, | |
161 | .cb.buffer_end = client_buffer_end, | |
162 | .cb.buffer_create = client_buffer_create, | |
163 | .cb.buffer_finalize = client_buffer_finalize, | |
164 | ||
165 | .tsc_bits = 0, | |
166 | .alloc = RING_BUFFER_ALLOC_GLOBAL, | |
167 | .sync = RING_BUFFER_SYNC_GLOBAL, | |
168 | .mode = RING_BUFFER_MODE_TEMPLATE, | |
169 | .backend = RING_BUFFER_PAGE, | |
5d61a504 | 170 | .output = RING_BUFFER_MMAP, |
3d1fc7fd | 171 | .oops = RING_BUFFER_OOPS_CONSISTENCY, |
5d61a504 MD |
172 | .ipi = RING_BUFFER_NO_IPI_BARRIER, |
173 | .wakeup = RING_BUFFER_WAKEUP_BY_WRITER, | |
c1fca457 | 174 | .client_type = LTTNG_CLIENT_TYPE, |
3d1fc7fd MD |
175 | }; |
176 | ||
7a784989 | 177 | const struct lttng_ust_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_config.cb; |
c1fca457 | 178 | |
3d1fc7fd | 179 | static |
7dd08bec | 180 | struct lttng_channel *_channel_create(const char *name, |
a3f61e7f | 181 | void *buf_addr, |
3d1fc7fd MD |
182 | size_t subbuf_size, size_t num_subbuf, |
183 | unsigned int switch_timer_interval, | |
193183fb | 184 | unsigned int read_timer_interval, |
6ca18e66 MD |
185 | unsigned char *uuid, |
186 | uint32_t chan_id) | |
3d1fc7fd | 187 | { |
74d81a6c | 188 | struct lttng_channel chan_priv_init; |
a3f61e7f | 189 | struct lttng_ust_shm_handle *handle; |
74d81a6c MD |
190 | struct lttng_channel *lttng_chan; |
191 | void *priv; | |
a3f61e7f | 192 | |
74d81a6c MD |
193 | memset(&chan_priv_init, 0, sizeof(chan_priv_init)); |
194 | memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN); | |
6ca18e66 | 195 | chan_priv_init.id = chan_id; |
a3f61e7f | 196 | handle = channel_create(&client_config, name, |
8824f307 MD |
197 | &priv, __alignof__(struct lttng_channel), |
198 | sizeof(struct lttng_channel), | |
74d81a6c | 199 | &chan_priv_init, |
a3f61e7f | 200 | buf_addr, subbuf_size, num_subbuf, |
74d81a6c | 201 | switch_timer_interval, read_timer_interval); |
a3f61e7f | 202 | if (!handle) |
1b2c2540 | 203 | return NULL; |
7dd08bec MD |
204 | lttng_chan = priv; |
205 | lttng_chan->handle = handle; | |
74d81a6c | 206 | lttng_chan->chan = shmp(handle, handle->chan); |
7dd08bec | 207 | return lttng_chan; |
3d1fc7fd MD |
208 | } |
209 | ||
210 | static | |
74d81a6c | 211 | void lttng_channel_destroy(struct lttng_channel *chan) |
3d1fc7fd | 212 | { |
74d81a6c | 213 | channel_destroy(chan->chan, chan->handle, 1); |
3d1fc7fd MD |
214 | } |
215 | ||
216 | static | |
7dd08bec | 217 | int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, uint32_t event_id) |
3d1fc7fd MD |
218 | { |
219 | return lib_ring_buffer_reserve(&client_config, ctx); | |
220 | } | |
221 | ||
222 | static | |
7dd08bec | 223 | void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx) |
3d1fc7fd MD |
224 | { |
225 | lib_ring_buffer_commit(&client_config, ctx); | |
226 | } | |
227 | ||
228 | static | |
7dd08bec | 229 | void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src, |
3d1fc7fd MD |
230 | size_t len) |
231 | { | |
232 | lib_ring_buffer_write(&client_config, ctx, src, len); | |
233 | } | |
234 | ||
235 | static | |
7dd08bec | 236 | size_t lttng_packet_avail_size(struct channel *chan, struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
237 | |
238 | { | |
239 | unsigned long o_begin; | |
4cfec15c | 240 | struct lttng_ust_lib_ring_buffer *buf; |
3d1fc7fd | 241 | |
1d498196 | 242 | buf = shmp(handle, chan->backend.buf[0].shmp); /* Only for global buffer ! */ |
3d1fc7fd MD |
243 | o_begin = v_read(&client_config, &buf->offset); |
244 | if (subbuf_offset(o_begin, chan) != 0) { | |
245 | return chan->backend.subbuf_size - subbuf_offset(o_begin, chan); | |
246 | } else { | |
247 | return chan->backend.subbuf_size - subbuf_offset(o_begin, chan) | |
248 | - sizeof(struct metadata_packet_header); | |
249 | } | |
250 | } | |
251 | ||
9f3fdbc6 | 252 | #if 0 |
3d1fc7fd | 253 | static |
7dd08bec | 254 | wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan) |
3d1fc7fd MD |
255 | { |
256 | return &chan->read_wait; | |
257 | } | |
258 | ||
259 | static | |
7dd08bec | 260 | wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan) |
3d1fc7fd MD |
261 | { |
262 | return &chan->hp_wait; | |
263 | } | |
9f3fdbc6 | 264 | #endif //0 |
3d1fc7fd MD |
265 | |
266 | static | |
7dd08bec | 267 | int lttng_is_finalized(struct channel *chan) |
3d1fc7fd MD |
268 | { |
269 | return lib_ring_buffer_channel_is_finalized(chan); | |
270 | } | |
271 | ||
272 | static | |
7dd08bec | 273 | int lttng_is_disabled(struct channel *chan) |
3d1fc7fd MD |
274 | { |
275 | return lib_ring_buffer_channel_is_disabled(chan); | |
276 | } | |
277 | ||
43861eab | 278 | static |
7dd08bec | 279 | int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle) |
43861eab | 280 | { |
4cfec15c | 281 | struct lttng_ust_lib_ring_buffer *buf; |
74d81a6c MD |
282 | int shm_fd, wait_fd, wakeup_fd; |
283 | uint64_t memory_map_size; | |
43861eab MD |
284 | |
285 | buf = channel_get_ring_buffer(&client_config, chan, | |
74d81a6c | 286 | 0, handle, &shm_fd, &wait_fd, &wakeup_fd, |
43861eab MD |
287 | &memory_map_size); |
288 | lib_ring_buffer_switch(&client_config, buf, | |
289 | SWITCH_ACTIVE, handle); | |
290 | return 0; | |
291 | } | |
292 | ||
7dd08bec | 293 | static struct lttng_transport lttng_relay_transport = { |
818173b9 | 294 | .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap", |
3d1fc7fd MD |
295 | .ops = { |
296 | .channel_create = _channel_create, | |
7dd08bec | 297 | .channel_destroy = lttng_channel_destroy, |
7dd08bec MD |
298 | .event_reserve = lttng_event_reserve, |
299 | .event_commit = lttng_event_commit, | |
300 | .event_write = lttng_event_write, | |
301 | .packet_avail_size = lttng_packet_avail_size, | |
302 | //.get_reader_wait_queue = lttng_get_reader_wait_queue, | |
303 | //.get_hp_wait_queue = lttng_get_hp_wait_queue, | |
304 | .is_finalized = lttng_is_finalized, | |
305 | .is_disabled = lttng_is_disabled, | |
306 | .flush_buffer = lttng_flush_buffer, | |
3d1fc7fd | 307 | }, |
74d81a6c | 308 | .client_config = &client_config, |
3d1fc7fd MD |
309 | }; |
310 | ||
edaa1431 | 311 | void RING_BUFFER_MODE_TEMPLATE_INIT(void) |
3d1fc7fd | 312 | { |
34a91bdb MD |
313 | DBG("LTT : ltt ring buffer client \"%s\" init\n", |
314 | "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); | |
7dd08bec | 315 | lttng_transport_register(<tng_relay_transport); |
3d1fc7fd MD |
316 | } |
317 | ||
edaa1431 | 318 | void RING_BUFFER_MODE_TEMPLATE_EXIT(void) |
3d1fc7fd | 319 | { |
34a91bdb MD |
320 | DBG("LTT : ltt ring buffer client \"%s\" exit\n", |
321 | "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); | |
7dd08bec | 322 | lttng_transport_unregister(<tng_relay_transport); |
3d1fc7fd | 323 | } |