Commit | Line | Data |
---|---|---|
f3bc08c5 MD |
1 | /* |
2 | * ring_buffer_iterator.c | |
3 | * | |
4 | * (C) Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
5 | * | |
6 | * Ring buffer and channel iterators. Get each event of a channel in order. Uses | |
7 | * a prio heap for per-cpu buffers, giving a O(log(NR_CPUS)) algorithmic | |
8 | * complexity for the "get next event" operation. | |
9 | * | |
10 | * Author: | |
11 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
12 | * | |
13 | * Dual LGPL v2.1/GPL v2 license. | |
14 | */ | |
15 | ||
16 | #include "../../wrapper/ringbuffer/iterator.h" | |
17 | #include <linux/jiffies.h> | |
18 | #include <linux/delay.h> | |
19 | #include <linux/module.h> | |
20 | ||
21 | /* | |
22 | * Safety factor taking into account internal kernel interrupt latency. | |
23 | * Assuming 250ms worse-case latency. | |
24 | */ | |
25 | #define MAX_SYSTEM_LATENCY 250 | |
26 | ||
27 | /* | |
28 | * Maximum delta expected between trace clocks. At most 1 jiffy delta. | |
29 | */ | |
30 | #define MAX_CLOCK_DELTA (jiffies_to_usecs(1) * 1000) | |
31 | ||
32 | /** | |
33 | * lib_ring_buffer_get_next_record - Get the next record in a buffer. | |
34 | * @chan: channel | |
35 | * @buf: buffer | |
36 | * | |
37 | * Returns the size of the event read, -EAGAIN if buffer is empty, -ENODATA if | |
38 | * buffer is empty and finalized. The buffer must already be opened for reading. | |
39 | */ | |
40 | ssize_t lib_ring_buffer_get_next_record(struct channel *chan, | |
41 | struct lib_ring_buffer *buf) | |
42 | { | |
43 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
44 | struct lib_ring_buffer_iter *iter = &buf->iter; | |
45 | int ret; | |
46 | ||
47 | restart: | |
48 | switch (iter->state) { | |
49 | case ITER_GET_SUBBUF: | |
50 | ret = lib_ring_buffer_get_next_subbuf(buf); | |
51 | if (ret && !ACCESS_ONCE(buf->finalized) | |
52 | && config->alloc == RING_BUFFER_ALLOC_GLOBAL) { | |
53 | /* | |
54 | * Use "pull" scheme for global buffers. The reader | |
55 | * itself flushes the buffer to "pull" data not visible | |
56 | * to readers yet. Flush current subbuffer and re-try. | |
57 | * | |
58 | * Per-CPU buffers rather use a "push" scheme because | |
59 | * the IPI needed to flush all CPU's buffers is too | |
60 | * costly. In the "push" scheme, the reader waits for | |
61 | * the writer periodic deferrable timer to flush the | |
62 | * buffers (keeping track of a quiescent state | |
63 | * timestamp). Therefore, the writer "pushes" data out | |
64 | * of the buffers rather than letting the reader "pull" | |
65 | * data from the buffer. | |
66 | */ | |
67 | lib_ring_buffer_switch_slow(buf, SWITCH_ACTIVE); | |
68 | ret = lib_ring_buffer_get_next_subbuf(buf); | |
69 | } | |
70 | if (ret) | |
71 | return ret; | |
72 | iter->consumed = buf->cons_snapshot; | |
73 | iter->data_size = lib_ring_buffer_get_read_data_size(config, buf); | |
74 | iter->read_offset = iter->consumed; | |
75 | /* skip header */ | |
76 | iter->read_offset += config->cb.subbuffer_header_size(); | |
77 | iter->state = ITER_TEST_RECORD; | |
78 | goto restart; | |
79 | case ITER_TEST_RECORD: | |
80 | if (iter->read_offset - iter->consumed >= iter->data_size) { | |
81 | iter->state = ITER_PUT_SUBBUF; | |
82 | } else { | |
83 | CHAN_WARN_ON(chan, !config->cb.record_get); | |
84 | config->cb.record_get(config, chan, buf, | |
85 | iter->read_offset, | |
86 | &iter->header_len, | |
87 | &iter->payload_len, | |
88 | &iter->timestamp); | |
89 | iter->read_offset += iter->header_len; | |
90 | subbuffer_consume_record(config, &buf->backend); | |
91 | iter->state = ITER_NEXT_RECORD; | |
92 | return iter->payload_len; | |
93 | } | |
94 | goto restart; | |
95 | case ITER_NEXT_RECORD: | |
96 | iter->read_offset += iter->payload_len; | |
97 | iter->state = ITER_TEST_RECORD; | |
98 | goto restart; | |
99 | case ITER_PUT_SUBBUF: | |
100 | lib_ring_buffer_put_next_subbuf(buf); | |
101 | iter->state = ITER_GET_SUBBUF; | |
102 | goto restart; | |
103 | default: | |
104 | CHAN_WARN_ON(chan, 1); /* Should not happen */ | |
105 | return -EPERM; | |
106 | } | |
107 | } | |
108 | EXPORT_SYMBOL_GPL(lib_ring_buffer_get_next_record); | |
109 | ||
110 | static int buf_is_higher(void *a, void *b) | |
111 | { | |
112 | struct lib_ring_buffer *bufa = a; | |
113 | struct lib_ring_buffer *bufb = b; | |
114 | ||
115 | /* Consider lowest timestamps to be at the top of the heap */ | |
116 | return (bufa->iter.timestamp < bufb->iter.timestamp); | |
117 | } | |
118 | ||
119 | static | |
120 | void lib_ring_buffer_get_empty_buf_records(const struct lib_ring_buffer_config *config, | |
121 | struct channel *chan) | |
122 | { | |
a88db018 | 123 | struct lttng_ptr_heap *heap = &chan->iter.heap; |
f3bc08c5 MD |
124 | struct lib_ring_buffer *buf, *tmp; |
125 | ssize_t len; | |
126 | ||
127 | list_for_each_entry_safe(buf, tmp, &chan->iter.empty_head, | |
128 | iter.empty_node) { | |
129 | len = lib_ring_buffer_get_next_record(chan, buf); | |
130 | ||
131 | /* | |
132 | * Deal with -EAGAIN and -ENODATA. | |
133 | * len >= 0 means record contains data. | |
134 | * -EBUSY should never happen, because we support only one | |
135 | * reader. | |
136 | */ | |
137 | switch (len) { | |
138 | case -EAGAIN: | |
139 | /* Keep node in empty list */ | |
140 | break; | |
141 | case -ENODATA: | |
142 | /* | |
143 | * Buffer is finalized. Don't add to list of empty | |
144 | * buffer, because it has no more data to provide, ever. | |
145 | */ | |
146 | list_del(&buf->iter.empty_node); | |
147 | break; | |
148 | case -EBUSY: | |
149 | CHAN_WARN_ON(chan, 1); | |
150 | break; | |
151 | default: | |
152 | /* | |
153 | * Insert buffer into the heap, remove from empty buffer | |
ab2277d6 | 154 | * list. |
f3bc08c5 MD |
155 | */ |
156 | CHAN_WARN_ON(chan, len < 0); | |
157 | list_del(&buf->iter.empty_node); | |
a88db018 | 158 | CHAN_WARN_ON(chan, lttng_heap_insert(heap, buf)); |
f3bc08c5 MD |
159 | } |
160 | } | |
161 | } | |
162 | ||
163 | static | |
164 | void lib_ring_buffer_wait_for_qs(const struct lib_ring_buffer_config *config, | |
165 | struct channel *chan) | |
166 | { | |
167 | u64 timestamp_qs; | |
168 | unsigned long wait_msecs; | |
169 | ||
170 | /* | |
171 | * No need to wait if no empty buffers are present. | |
172 | */ | |
173 | if (list_empty(&chan->iter.empty_head)) | |
174 | return; | |
175 | ||
176 | timestamp_qs = config->cb.ring_buffer_clock_read(chan); | |
177 | /* | |
178 | * We need to consider previously empty buffers. | |
179 | * Do a get next buf record on each of them. Add them to | |
180 | * the heap if they have data. If at least one of them | |
181 | * don't have data, we need to wait for | |
182 | * switch_timer_interval + MAX_SYSTEM_LATENCY (so we are sure the | |
183 | * buffers have been switched either by the timer or idle entry) and | |
184 | * check them again, adding them if they have data. | |
185 | */ | |
186 | lib_ring_buffer_get_empty_buf_records(config, chan); | |
187 | ||
188 | /* | |
189 | * No need to wait if no empty buffers are present. | |
190 | */ | |
191 | if (list_empty(&chan->iter.empty_head)) | |
192 | return; | |
193 | ||
194 | /* | |
195 | * We need to wait for the buffer switch timer to run. If the | |
196 | * CPU is idle, idle entry performed the switch. | |
197 | * TODO: we could optimize further by skipping the sleep if all | |
198 | * empty buffers belong to idle or offline cpus. | |
199 | */ | |
200 | wait_msecs = jiffies_to_msecs(chan->switch_timer_interval); | |
201 | wait_msecs += MAX_SYSTEM_LATENCY; | |
202 | msleep(wait_msecs); | |
203 | lib_ring_buffer_get_empty_buf_records(config, chan); | |
204 | /* | |
205 | * Any buffer still in the empty list here cannot possibly | |
206 | * contain an event with a timestamp prior to "timestamp_qs". | |
207 | * The new quiescent state timestamp is the one we grabbed | |
208 | * before waiting for buffer data. It is therefore safe to | |
209 | * ignore empty buffers up to last_qs timestamp for fusion | |
210 | * merge. | |
211 | */ | |
212 | chan->iter.last_qs = timestamp_qs; | |
213 | } | |
214 | ||
215 | /** | |
216 | * channel_get_next_record - Get the next record in a channel. | |
217 | * @chan: channel | |
218 | * @ret_buf: the buffer in which the event is located (output) | |
219 | * | |
220 | * Returns the size of new current event, -EAGAIN if all buffers are empty, | |
221 | * -ENODATA if all buffers are empty and finalized. The channel must already be | |
222 | * opened for reading. | |
223 | */ | |
224 | ||
225 | ssize_t channel_get_next_record(struct channel *chan, | |
226 | struct lib_ring_buffer **ret_buf) | |
227 | { | |
228 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
229 | struct lib_ring_buffer *buf; | |
a88db018 | 230 | struct lttng_ptr_heap *heap; |
f3bc08c5 MD |
231 | ssize_t len; |
232 | ||
233 | if (config->alloc == RING_BUFFER_ALLOC_GLOBAL) { | |
234 | *ret_buf = channel_get_ring_buffer(config, chan, 0); | |
235 | return lib_ring_buffer_get_next_record(chan, *ret_buf); | |
236 | } | |
237 | ||
238 | heap = &chan->iter.heap; | |
239 | ||
240 | /* | |
241 | * get next record for topmost buffer. | |
242 | */ | |
a88db018 | 243 | buf = lttng_heap_maximum(heap); |
f3bc08c5 MD |
244 | if (buf) { |
245 | len = lib_ring_buffer_get_next_record(chan, buf); | |
246 | /* | |
247 | * Deal with -EAGAIN and -ENODATA. | |
248 | * len >= 0 means record contains data. | |
249 | */ | |
250 | switch (len) { | |
251 | case -EAGAIN: | |
252 | buf->iter.timestamp = 0; | |
253 | list_add(&buf->iter.empty_node, &chan->iter.empty_head); | |
254 | /* Remove topmost buffer from the heap */ | |
a88db018 | 255 | CHAN_WARN_ON(chan, lttng_heap_remove(heap) != buf); |
f3bc08c5 MD |
256 | break; |
257 | case -ENODATA: | |
258 | /* | |
259 | * Buffer is finalized. Remove buffer from heap and | |
260 | * don't add to list of empty buffer, because it has no | |
261 | * more data to provide, ever. | |
262 | */ | |
a88db018 | 263 | CHAN_WARN_ON(chan, lttng_heap_remove(heap) != buf); |
f3bc08c5 MD |
264 | break; |
265 | case -EBUSY: | |
266 | CHAN_WARN_ON(chan, 1); | |
267 | break; | |
268 | default: | |
269 | /* | |
270 | * Reinsert buffer into the heap. Note that heap can be | |
271 | * partially empty, so we need to use | |
a88db018 | 272 | * lttng_heap_replace_max(). |
f3bc08c5 MD |
273 | */ |
274 | CHAN_WARN_ON(chan, len < 0); | |
a88db018 | 275 | CHAN_WARN_ON(chan, lttng_heap_replace_max(heap, buf) != buf); |
f3bc08c5 MD |
276 | break; |
277 | } | |
278 | } | |
279 | ||
a88db018 | 280 | buf = lttng_heap_maximum(heap); |
f3bc08c5 MD |
281 | if (!buf || buf->iter.timestamp > chan->iter.last_qs) { |
282 | /* | |
283 | * Deal with buffers previously showing no data. | |
284 | * Add buffers containing data to the heap, update | |
285 | * last_qs. | |
286 | */ | |
287 | lib_ring_buffer_wait_for_qs(config, chan); | |
288 | } | |
289 | ||
a88db018 | 290 | *ret_buf = buf = lttng_heap_maximum(heap); |
f3bc08c5 MD |
291 | if (buf) { |
292 | /* | |
293 | * If this warning triggers, you probably need to check your | |
294 | * system interrupt latency. Typical causes: too many printk() | |
295 | * output going to a serial console with interrupts off. | |
296 | * Allow for MAX_CLOCK_DELTA ns timestamp delta going backward. | |
297 | * Observed on SMP KVM setups with trace_clock(). | |
298 | */ | |
299 | if (chan->iter.last_timestamp | |
300 | > (buf->iter.timestamp + MAX_CLOCK_DELTA)) { | |
301 | printk(KERN_WARNING "ring_buffer: timestamps going " | |
302 | "backward. Last time %llu ns, cpu %d, " | |
303 | "current time %llu ns, cpu %d, " | |
304 | "delta %llu ns.\n", | |
305 | chan->iter.last_timestamp, chan->iter.last_cpu, | |
306 | buf->iter.timestamp, buf->backend.cpu, | |
307 | chan->iter.last_timestamp - buf->iter.timestamp); | |
308 | CHAN_WARN_ON(chan, 1); | |
309 | } | |
310 | chan->iter.last_timestamp = buf->iter.timestamp; | |
311 | chan->iter.last_cpu = buf->backend.cpu; | |
312 | return buf->iter.payload_len; | |
313 | } else { | |
314 | /* Heap is empty */ | |
315 | if (list_empty(&chan->iter.empty_head)) | |
316 | return -ENODATA; /* All buffers finalized */ | |
317 | else | |
318 | return -EAGAIN; /* Temporarily empty */ | |
319 | } | |
320 | } | |
321 | EXPORT_SYMBOL_GPL(channel_get_next_record); | |
322 | ||
323 | static | |
324 | void lib_ring_buffer_iterator_init(struct channel *chan, struct lib_ring_buffer *buf) | |
325 | { | |
326 | if (buf->iter.allocated) | |
327 | return; | |
328 | ||
329 | buf->iter.allocated = 1; | |
330 | if (chan->iter.read_open && !buf->iter.read_open) { | |
331 | CHAN_WARN_ON(chan, lib_ring_buffer_open_read(buf) != 0); | |
332 | buf->iter.read_open = 1; | |
333 | } | |
334 | ||
335 | /* Add to list of buffers without any current record */ | |
336 | if (chan->backend.config->alloc == RING_BUFFER_ALLOC_PER_CPU) | |
337 | list_add(&buf->iter.empty_node, &chan->iter.empty_head); | |
338 | } | |
339 | ||
340 | #ifdef CONFIG_HOTPLUG_CPU | |
341 | static | |
342 | int __cpuinit channel_iterator_cpu_hotplug(struct notifier_block *nb, | |
343 | unsigned long action, | |
344 | void *hcpu) | |
345 | { | |
346 | unsigned int cpu = (unsigned long)hcpu; | |
347 | struct channel *chan = container_of(nb, struct channel, | |
348 | hp_iter_notifier); | |
349 | struct lib_ring_buffer *buf = per_cpu_ptr(chan->backend.buf, cpu); | |
350 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
351 | ||
352 | if (!chan->hp_iter_enable) | |
353 | return NOTIFY_DONE; | |
354 | ||
355 | CHAN_WARN_ON(chan, config->alloc == RING_BUFFER_ALLOC_GLOBAL); | |
356 | ||
357 | switch (action) { | |
358 | case CPU_DOWN_FAILED: | |
359 | case CPU_DOWN_FAILED_FROZEN: | |
360 | case CPU_ONLINE: | |
361 | case CPU_ONLINE_FROZEN: | |
362 | lib_ring_buffer_iterator_init(chan, buf); | |
363 | return NOTIFY_OK; | |
364 | default: | |
365 | return NOTIFY_DONE; | |
366 | } | |
367 | } | |
368 | #endif | |
369 | ||
370 | int channel_iterator_init(struct channel *chan) | |
371 | { | |
372 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
373 | struct lib_ring_buffer *buf; | |
374 | ||
375 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) { | |
376 | int cpu, ret; | |
377 | ||
378 | INIT_LIST_HEAD(&chan->iter.empty_head); | |
a88db018 | 379 | ret = lttng_heap_init(&chan->iter.heap, |
41affe31 | 380 | num_possible_cpus(), |
f3bc08c5 MD |
381 | GFP_KERNEL, buf_is_higher); |
382 | if (ret) | |
383 | return ret; | |
384 | /* | |
385 | * In case of non-hotplug cpu, if the ring-buffer is allocated | |
386 | * in early initcall, it will not be notified of secondary cpus. | |
387 | * In that off case, we need to allocate for all possible cpus. | |
388 | */ | |
389 | #ifdef CONFIG_HOTPLUG_CPU | |
390 | chan->hp_iter_notifier.notifier_call = | |
391 | channel_iterator_cpu_hotplug; | |
392 | chan->hp_iter_notifier.priority = 10; | |
393 | register_cpu_notifier(&chan->hp_iter_notifier); | |
394 | get_online_cpus(); | |
395 | for_each_online_cpu(cpu) { | |
396 | buf = per_cpu_ptr(chan->backend.buf, cpu); | |
397 | lib_ring_buffer_iterator_init(chan, buf); | |
398 | } | |
399 | chan->hp_iter_enable = 1; | |
400 | put_online_cpus(); | |
401 | #else | |
402 | for_each_possible_cpu(cpu) { | |
403 | buf = per_cpu_ptr(chan->backend.buf, cpu); | |
404 | lib_ring_buffer_iterator_init(chan, buf); | |
405 | } | |
406 | #endif | |
407 | } else { | |
408 | buf = channel_get_ring_buffer(config, chan, 0); | |
409 | lib_ring_buffer_iterator_init(chan, buf); | |
410 | } | |
411 | return 0; | |
412 | } | |
413 | ||
414 | void channel_iterator_unregister_notifiers(struct channel *chan) | |
415 | { | |
416 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
417 | ||
418 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) { | |
419 | chan->hp_iter_enable = 0; | |
420 | unregister_cpu_notifier(&chan->hp_iter_notifier); | |
421 | } | |
422 | } | |
423 | ||
424 | void channel_iterator_free(struct channel *chan) | |
425 | { | |
426 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
427 | ||
428 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) | |
a88db018 | 429 | lttng_heap_free(&chan->iter.heap); |
f3bc08c5 MD |
430 | } |
431 | ||
432 | int lib_ring_buffer_iterator_open(struct lib_ring_buffer *buf) | |
433 | { | |
434 | struct channel *chan = buf->backend.chan; | |
435 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
436 | CHAN_WARN_ON(chan, config->output != RING_BUFFER_ITERATOR); | |
437 | return lib_ring_buffer_open_read(buf); | |
438 | } | |
439 | EXPORT_SYMBOL_GPL(lib_ring_buffer_iterator_open); | |
440 | ||
441 | /* | |
442 | * Note: Iterators must not be mixed with other types of outputs, because an | |
443 | * iterator can leave the buffer in "GET" state, which is not consistent with | |
444 | * other types of output (mmap, splice, raw data read). | |
445 | */ | |
446 | void lib_ring_buffer_iterator_release(struct lib_ring_buffer *buf) | |
447 | { | |
448 | lib_ring_buffer_release_read(buf); | |
449 | } | |
450 | EXPORT_SYMBOL_GPL(lib_ring_buffer_iterator_release); | |
451 | ||
452 | int channel_iterator_open(struct channel *chan) | |
453 | { | |
454 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
455 | struct lib_ring_buffer *buf; | |
456 | int ret = 0, cpu; | |
457 | ||
458 | CHAN_WARN_ON(chan, config->output != RING_BUFFER_ITERATOR); | |
459 | ||
460 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) { | |
461 | get_online_cpus(); | |
462 | /* Allow CPU hotplug to keep track of opened reader */ | |
463 | chan->iter.read_open = 1; | |
464 | for_each_channel_cpu(cpu, chan) { | |
465 | buf = channel_get_ring_buffer(config, chan, cpu); | |
466 | ret = lib_ring_buffer_iterator_open(buf); | |
467 | if (ret) | |
468 | goto error; | |
469 | buf->iter.read_open = 1; | |
470 | } | |
471 | put_online_cpus(); | |
472 | } else { | |
473 | buf = channel_get_ring_buffer(config, chan, 0); | |
474 | ret = lib_ring_buffer_iterator_open(buf); | |
475 | } | |
476 | return ret; | |
477 | error: | |
478 | /* Error should always happen on CPU 0, hence no close is required. */ | |
479 | CHAN_WARN_ON(chan, cpu != 0); | |
480 | put_online_cpus(); | |
481 | return ret; | |
482 | } | |
483 | EXPORT_SYMBOL_GPL(channel_iterator_open); | |
484 | ||
485 | void channel_iterator_release(struct channel *chan) | |
486 | { | |
487 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
488 | struct lib_ring_buffer *buf; | |
489 | int cpu; | |
490 | ||
491 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) { | |
492 | get_online_cpus(); | |
493 | for_each_channel_cpu(cpu, chan) { | |
494 | buf = channel_get_ring_buffer(config, chan, cpu); | |
495 | if (buf->iter.read_open) { | |
496 | lib_ring_buffer_iterator_release(buf); | |
497 | buf->iter.read_open = 0; | |
498 | } | |
499 | } | |
500 | chan->iter.read_open = 0; | |
501 | put_online_cpus(); | |
502 | } else { | |
503 | buf = channel_get_ring_buffer(config, chan, 0); | |
504 | lib_ring_buffer_iterator_release(buf); | |
505 | } | |
506 | } | |
507 | EXPORT_SYMBOL_GPL(channel_iterator_release); | |
508 | ||
509 | void lib_ring_buffer_iterator_reset(struct lib_ring_buffer *buf) | |
510 | { | |
511 | struct channel *chan = buf->backend.chan; | |
512 | ||
513 | if (buf->iter.state != ITER_GET_SUBBUF) | |
514 | lib_ring_buffer_put_next_subbuf(buf); | |
515 | buf->iter.state = ITER_GET_SUBBUF; | |
516 | /* Remove from heap (if present). */ | |
a88db018 | 517 | if (lttng_heap_cherrypick(&chan->iter.heap, buf)) |
f3bc08c5 MD |
518 | list_add(&buf->iter.empty_node, &chan->iter.empty_head); |
519 | buf->iter.timestamp = 0; | |
520 | buf->iter.header_len = 0; | |
521 | buf->iter.payload_len = 0; | |
522 | buf->iter.consumed = 0; | |
523 | buf->iter.read_offset = 0; | |
524 | buf->iter.data_size = 0; | |
525 | /* Don't reset allocated and read_open */ | |
526 | } | |
527 | ||
528 | void channel_iterator_reset(struct channel *chan) | |
529 | { | |
530 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
531 | struct lib_ring_buffer *buf; | |
532 | int cpu; | |
533 | ||
534 | /* Empty heap, put into empty_head */ | |
a88db018 | 535 | while ((buf = lttng_heap_remove(&chan->iter.heap)) != NULL) |
f3bc08c5 MD |
536 | list_add(&buf->iter.empty_node, &chan->iter.empty_head); |
537 | ||
538 | for_each_channel_cpu(cpu, chan) { | |
539 | buf = channel_get_ring_buffer(config, chan, cpu); | |
540 | lib_ring_buffer_iterator_reset(buf); | |
541 | } | |
542 | /* Don't reset read_open */ | |
543 | chan->iter.last_qs = 0; | |
544 | chan->iter.last_timestamp = 0; | |
545 | chan->iter.last_cpu = 0; | |
546 | chan->iter.len_left = 0; | |
547 | } | |
548 | ||
549 | /* | |
550 | * Ring buffer payload extraction read() implementation. | |
551 | */ | |
552 | static | |
553 | ssize_t channel_ring_buffer_file_read(struct file *filp, | |
554 | char __user *user_buf, | |
555 | size_t count, | |
556 | loff_t *ppos, | |
557 | struct channel *chan, | |
558 | struct lib_ring_buffer *buf, | |
559 | int fusionmerge) | |
560 | { | |
561 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
562 | size_t read_count = 0, read_offset; | |
563 | ssize_t len; | |
564 | ||
565 | might_sleep(); | |
566 | if (!access_ok(VERIFY_WRITE, user_buf, count)) | |
567 | return -EFAULT; | |
568 | ||
569 | /* Finish copy of previous record */ | |
570 | if (*ppos != 0) { | |
571 | if (read_count < count) { | |
572 | len = chan->iter.len_left; | |
573 | read_offset = *ppos; | |
574 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU | |
575 | && fusionmerge) | |
a88db018 | 576 | buf = lttng_heap_maximum(&chan->iter.heap); |
f3bc08c5 MD |
577 | CHAN_WARN_ON(chan, !buf); |
578 | goto skip_get_next; | |
579 | } | |
580 | } | |
581 | ||
582 | while (read_count < count) { | |
583 | size_t copy_len, space_left; | |
584 | ||
585 | if (fusionmerge) | |
586 | len = channel_get_next_record(chan, &buf); | |
587 | else | |
588 | len = lib_ring_buffer_get_next_record(chan, buf); | |
589 | len_test: | |
590 | if (len < 0) { | |
591 | /* | |
592 | * Check if buffer is finalized (end of file). | |
593 | */ | |
594 | if (len == -ENODATA) { | |
595 | /* A 0 read_count will tell about end of file */ | |
596 | goto nodata; | |
597 | } | |
598 | if (filp->f_flags & O_NONBLOCK) { | |
599 | if (!read_count) | |
600 | read_count = -EAGAIN; | |
601 | goto nodata; | |
602 | } else { | |
603 | int error; | |
604 | ||
605 | /* | |
606 | * No data available at the moment, return what | |
607 | * we got. | |
608 | */ | |
609 | if (read_count) | |
610 | goto nodata; | |
611 | ||
612 | /* | |
613 | * Wait for returned len to be >= 0 or -ENODATA. | |
614 | */ | |
615 | if (fusionmerge) | |
616 | error = wait_event_interruptible( | |
617 | chan->read_wait, | |
618 | ((len = channel_get_next_record(chan, | |
619 | &buf)), len != -EAGAIN)); | |
620 | else | |
621 | error = wait_event_interruptible( | |
622 | buf->read_wait, | |
623 | ((len = lib_ring_buffer_get_next_record( | |
624 | chan, buf)), len != -EAGAIN)); | |
625 | CHAN_WARN_ON(chan, len == -EBUSY); | |
626 | if (error) { | |
627 | read_count = error; | |
628 | goto nodata; | |
629 | } | |
630 | CHAN_WARN_ON(chan, len < 0 && len != -ENODATA); | |
631 | goto len_test; | |
632 | } | |
633 | } | |
634 | read_offset = buf->iter.read_offset; | |
635 | skip_get_next: | |
636 | space_left = count - read_count; | |
637 | if (len <= space_left) { | |
638 | copy_len = len; | |
639 | chan->iter.len_left = 0; | |
640 | *ppos = 0; | |
641 | } else { | |
642 | copy_len = space_left; | |
643 | chan->iter.len_left = len - copy_len; | |
644 | *ppos = read_offset + copy_len; | |
645 | } | |
646 | if (__lib_ring_buffer_copy_to_user(&buf->backend, read_offset, | |
647 | &user_buf[read_count], | |
648 | copy_len)) { | |
649 | /* | |
650 | * Leave the len_left and ppos values at their current | |
651 | * state, as we currently have a valid event to read. | |
652 | */ | |
653 | return -EFAULT; | |
654 | } | |
655 | read_count += copy_len; | |
656 | }; | |
657 | return read_count; | |
658 | ||
659 | nodata: | |
660 | *ppos = 0; | |
661 | chan->iter.len_left = 0; | |
662 | return read_count; | |
663 | } | |
664 | ||
665 | /** | |
666 | * lib_ring_buffer_file_read - Read buffer record payload. | |
667 | * @filp: file structure pointer. | |
668 | * @buffer: user buffer to read data into. | |
669 | * @count: number of bytes to read. | |
670 | * @ppos: file read position. | |
671 | * | |
672 | * Returns a negative value on error, or the number of bytes read on success. | |
673 | * ppos is used to save the position _within the current record_ between calls | |
674 | * to read(). | |
675 | */ | |
676 | static | |
677 | ssize_t lib_ring_buffer_file_read(struct file *filp, | |
678 | char __user *user_buf, | |
679 | size_t count, | |
680 | loff_t *ppos) | |
681 | { | |
682 | struct inode *inode = filp->f_dentry->d_inode; | |
683 | struct lib_ring_buffer *buf = inode->i_private; | |
684 | struct channel *chan = buf->backend.chan; | |
685 | ||
686 | return channel_ring_buffer_file_read(filp, user_buf, count, ppos, | |
687 | chan, buf, 0); | |
688 | } | |
689 | ||
690 | /** | |
691 | * channel_file_read - Read channel record payload. | |
692 | * @filp: file structure pointer. | |
693 | * @buffer: user buffer to read data into. | |
694 | * @count: number of bytes to read. | |
695 | * @ppos: file read position. | |
696 | * | |
697 | * Returns a negative value on error, or the number of bytes read on success. | |
698 | * ppos is used to save the position _within the current record_ between calls | |
699 | * to read(). | |
700 | */ | |
701 | static | |
702 | ssize_t channel_file_read(struct file *filp, | |
703 | char __user *user_buf, | |
704 | size_t count, | |
705 | loff_t *ppos) | |
706 | { | |
707 | struct inode *inode = filp->f_dentry->d_inode; | |
708 | struct channel *chan = inode->i_private; | |
709 | const struct lib_ring_buffer_config *config = chan->backend.config; | |
710 | ||
711 | if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) | |
712 | return channel_ring_buffer_file_read(filp, user_buf, count, | |
713 | ppos, chan, NULL, 1); | |
714 | else { | |
715 | struct lib_ring_buffer *buf = | |
716 | channel_get_ring_buffer(config, chan, 0); | |
717 | return channel_ring_buffer_file_read(filp, user_buf, count, | |
718 | ppos, chan, buf, 0); | |
719 | } | |
720 | } | |
721 | ||
722 | static | |
723 | int lib_ring_buffer_file_open(struct inode *inode, struct file *file) | |
724 | { | |
725 | struct lib_ring_buffer *buf = inode->i_private; | |
726 | int ret; | |
727 | ||
728 | ret = lib_ring_buffer_iterator_open(buf); | |
729 | if (ret) | |
730 | return ret; | |
731 | ||
732 | file->private_data = buf; | |
733 | ret = nonseekable_open(inode, file); | |
734 | if (ret) | |
735 | goto release_iter; | |
736 | return 0; | |
737 | ||
738 | release_iter: | |
739 | lib_ring_buffer_iterator_release(buf); | |
740 | return ret; | |
741 | } | |
742 | ||
743 | static | |
744 | int lib_ring_buffer_file_release(struct inode *inode, struct file *file) | |
745 | { | |
746 | struct lib_ring_buffer *buf = inode->i_private; | |
747 | ||
748 | lib_ring_buffer_iterator_release(buf); | |
749 | return 0; | |
750 | } | |
751 | ||
752 | static | |
753 | int channel_file_open(struct inode *inode, struct file *file) | |
754 | { | |
755 | struct channel *chan = inode->i_private; | |
756 | int ret; | |
757 | ||
758 | ret = channel_iterator_open(chan); | |
759 | if (ret) | |
760 | return ret; | |
761 | ||
762 | file->private_data = chan; | |
763 | ret = nonseekable_open(inode, file); | |
764 | if (ret) | |
765 | goto release_iter; | |
766 | return 0; | |
767 | ||
768 | release_iter: | |
769 | channel_iterator_release(chan); | |
770 | return ret; | |
771 | } | |
772 | ||
773 | static | |
774 | int channel_file_release(struct inode *inode, struct file *file) | |
775 | { | |
776 | struct channel *chan = inode->i_private; | |
777 | ||
778 | channel_iterator_release(chan); | |
779 | return 0; | |
780 | } | |
781 | ||
782 | const struct file_operations channel_payload_file_operations = { | |
a33c9927 | 783 | .owner = THIS_MODULE, |
f3bc08c5 MD |
784 | .open = channel_file_open, |
785 | .release = channel_file_release, | |
786 | .read = channel_file_read, | |
787 | .llseek = lib_ring_buffer_no_llseek, | |
788 | }; | |
789 | EXPORT_SYMBOL_GPL(channel_payload_file_operations); | |
790 | ||
791 | const struct file_operations lib_ring_buffer_payload_file_operations = { | |
a33c9927 | 792 | .owner = THIS_MODULE, |
f3bc08c5 MD |
793 | .open = lib_ring_buffer_file_open, |
794 | .release = lib_ring_buffer_file_release, | |
795 | .read = lib_ring_buffer_file_read, | |
796 | .llseek = lib_ring_buffer_no_llseek, | |
797 | }; | |
798 | EXPORT_SYMBOL_GPL(lib_ring_buffer_payload_file_operations); |