Commit | Line | Data |
---|---|---|
9f36eaed MJ |
1 | /* SPDX-License-Identifier: (GPL-2.0 OR LGPL-2.1) |
2 | * | |
f3bc08c5 MD |
3 | * ring_buffer_vfs.c |
4 | * | |
f3bc08c5 MD |
5 | * Ring Buffer VFS file operations. |
6 | * | |
886d51a3 | 7 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
f3bc08c5 MD |
8 | */ |
9 | ||
10 | #include <linux/module.h> | |
11 | #include <linux/fs.h> | |
12 | #include <linux/compat.h> | |
13 | ||
c075712b MD |
14 | #include <wrapper/ringbuffer/backend.h> |
15 | #include <wrapper/ringbuffer/frontend.h> | |
16 | #include <wrapper/ringbuffer/vfs.h> | |
17 | #include <wrapper/poll.h> | |
18 | #include <lttng-tracer.h> | |
f3bc08c5 MD |
19 | |
20 | static int put_ulong(unsigned long val, unsigned long arg) | |
21 | { | |
22 | return put_user(val, (unsigned long __user *)arg); | |
23 | } | |
24 | ||
25 | #ifdef CONFIG_COMPAT | |
26 | static int compat_put_ulong(compat_ulong_t val, unsigned long arg) | |
27 | { | |
28 | return put_user(val, (compat_ulong_t __user *)compat_ptr(arg)); | |
29 | } | |
30 | #endif | |
31 | ||
b3b8072b MD |
32 | /* |
33 | * This is not used by anonymous file descriptors. This code is left | |
34 | * there if we ever want to implement an inode with open() operation. | |
35 | */ | |
d83004aa JD |
36 | int lib_ring_buffer_open(struct inode *inode, struct file *file, |
37 | struct lib_ring_buffer *buf) | |
f3bc08c5 | 38 | { |
f3bc08c5 MD |
39 | int ret; |
40 | ||
733ce41d MD |
41 | if (!buf) |
42 | return -EINVAL; | |
43 | ||
f3bc08c5 MD |
44 | ret = lib_ring_buffer_open_read(buf); |
45 | if (ret) | |
46 | return ret; | |
47 | ||
f3bc08c5 MD |
48 | ret = nonseekable_open(inode, file); |
49 | if (ret) | |
50 | goto release_read; | |
51 | return 0; | |
52 | ||
53 | release_read: | |
54 | lib_ring_buffer_release_read(buf); | |
55 | return ret; | |
56 | } | |
d83004aa | 57 | EXPORT_SYMBOL_GPL(lib_ring_buffer_open); |
f3bc08c5 MD |
58 | |
59 | /** | |
d83004aa | 60 | * vfs_lib_ring_buffer_open - ring buffer open file operation |
f3bc08c5 MD |
61 | * @inode: opened inode |
62 | * @file: opened file | |
63 | * | |
d83004aa JD |
64 | * Open implementation. Makes sure only one open instance of a buffer is |
65 | * done at a given moment. | |
f3bc08c5 | 66 | */ |
d83004aa JD |
67 | static |
68 | int vfs_lib_ring_buffer_open(struct inode *inode, struct file *file) | |
f3bc08c5 | 69 | { |
d83004aa JD |
70 | struct lib_ring_buffer *buf = inode->i_private; |
71 | ||
72 | file->private_data = buf; | |
73 | return lib_ring_buffer_open(inode, file, buf); | |
74 | } | |
f3bc08c5 | 75 | |
d83004aa JD |
76 | int lib_ring_buffer_release(struct inode *inode, struct file *file, |
77 | struct lib_ring_buffer *buf) | |
78 | { | |
f3bc08c5 MD |
79 | lib_ring_buffer_release_read(buf); |
80 | ||
81 | return 0; | |
82 | } | |
d83004aa | 83 | EXPORT_SYMBOL_GPL(lib_ring_buffer_release); |
f3bc08c5 MD |
84 | |
85 | /** | |
d83004aa JD |
86 | * vfs_lib_ring_buffer_release - ring buffer release file operation |
87 | * @inode: opened inode | |
88 | * @file: opened file | |
f3bc08c5 | 89 | * |
d83004aa | 90 | * Release implementation. |
f3bc08c5 | 91 | */ |
d83004aa JD |
92 | static |
93 | int vfs_lib_ring_buffer_release(struct inode *inode, struct file *file) | |
94 | { | |
95 | struct lib_ring_buffer *buf = file->private_data; | |
96 | ||
97 | return lib_ring_buffer_release(inode, file, buf); | |
98 | } | |
99 | ||
100 | unsigned int lib_ring_buffer_poll(struct file *filp, poll_table *wait, | |
101 | struct lib_ring_buffer *buf) | |
f3bc08c5 MD |
102 | { |
103 | unsigned int mask = 0; | |
f3bc08c5 | 104 | struct channel *chan = buf->backend.chan; |
5a8fd222 | 105 | const struct lib_ring_buffer_config *config = &chan->backend.config; |
254ec7bc | 106 | int finalized, disabled; |
f3bc08c5 MD |
107 | |
108 | if (filp->f_mode & FMODE_READ) { | |
a33e44a6 | 109 | poll_wait_set_exclusive(wait); |
f3bc08c5 MD |
110 | poll_wait(filp, &buf->read_wait, wait); |
111 | ||
112 | finalized = lib_ring_buffer_is_finalized(config, buf); | |
254ec7bc MD |
113 | disabled = lib_ring_buffer_channel_is_disabled(chan); |
114 | ||
f3bc08c5 MD |
115 | /* |
116 | * lib_ring_buffer_is_finalized() contains a smp_rmb() ordering | |
117 | * finalized load before offsets loads. | |
118 | */ | |
119 | WARN_ON(atomic_long_read(&buf->active_readers) != 1); | |
120 | retry: | |
254ec7bc MD |
121 | if (disabled) |
122 | return POLLERR; | |
123 | ||
f3bc08c5 MD |
124 | if (subbuf_trunc(lib_ring_buffer_get_offset(config, buf), chan) |
125 | - subbuf_trunc(lib_ring_buffer_get_consumed(config, buf), chan) | |
126 | == 0) { | |
127 | if (finalized) | |
128 | return POLLHUP; | |
129 | else { | |
130 | /* | |
131 | * The memory barriers | |
132 | * __wait_event()/wake_up_interruptible() take | |
133 | * care of "raw_spin_is_locked" memory ordering. | |
134 | */ | |
135 | if (raw_spin_is_locked(&buf->raw_tick_nohz_spinlock)) | |
136 | goto retry; | |
137 | else | |
138 | return 0; | |
139 | } | |
140 | } else { | |
141 | if (subbuf_trunc(lib_ring_buffer_get_offset(config, buf), | |
142 | chan) | |
143 | - subbuf_trunc(lib_ring_buffer_get_consumed(config, buf), | |
144 | chan) | |
145 | >= chan->backend.buf_size) | |
146 | return POLLPRI | POLLRDBAND; | |
147 | else | |
148 | return POLLIN | POLLRDNORM; | |
149 | } | |
150 | } | |
151 | return mask; | |
152 | } | |
d83004aa | 153 | EXPORT_SYMBOL_GPL(lib_ring_buffer_poll); |
f3bc08c5 MD |
154 | |
155 | /** | |
d83004aa | 156 | * vfs_lib_ring_buffer_poll - ring buffer poll file operation |
f3bc08c5 | 157 | * @filp: the file |
d83004aa | 158 | * @wait: poll table |
f3bc08c5 | 159 | * |
d83004aa | 160 | * Poll implementation. |
f3bc08c5 | 161 | */ |
d83004aa JD |
162 | static |
163 | unsigned int vfs_lib_ring_buffer_poll(struct file *filp, poll_table *wait) | |
f3bc08c5 MD |
164 | { |
165 | struct lib_ring_buffer *buf = filp->private_data; | |
d83004aa JD |
166 | |
167 | return lib_ring_buffer_poll(filp, wait, buf); | |
168 | } | |
169 | ||
170 | long lib_ring_buffer_ioctl(struct file *filp, unsigned int cmd, | |
171 | unsigned long arg, struct lib_ring_buffer *buf) | |
172 | { | |
f3bc08c5 | 173 | struct channel *chan = buf->backend.chan; |
5a8fd222 | 174 | const struct lib_ring_buffer_config *config = &chan->backend.config; |
f3bc08c5 | 175 | |
254ec7bc MD |
176 | if (lib_ring_buffer_channel_is_disabled(chan)) |
177 | return -EIO; | |
178 | ||
f3bc08c5 MD |
179 | switch (cmd) { |
180 | case RING_BUFFER_SNAPSHOT: | |
181 | return lib_ring_buffer_snapshot(buf, &buf->cons_snapshot, | |
182 | &buf->prod_snapshot); | |
4dce5a48 JG |
183 | case RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS: |
184 | return lib_ring_buffer_snapshot_sample_positions(buf, | |
185 | &buf->cons_snapshot, &buf->prod_snapshot); | |
f3bc08c5 MD |
186 | case RING_BUFFER_SNAPSHOT_GET_CONSUMED: |
187 | return put_ulong(buf->cons_snapshot, arg); | |
188 | case RING_BUFFER_SNAPSHOT_GET_PRODUCED: | |
189 | return put_ulong(buf->prod_snapshot, arg); | |
190 | case RING_BUFFER_GET_SUBBUF: | |
191 | { | |
192 | unsigned long uconsume; | |
193 | long ret; | |
194 | ||
195 | ret = get_user(uconsume, (unsigned long __user *) arg); | |
196 | if (ret) | |
197 | return ret; /* will return -EFAULT */ | |
198 | ret = lib_ring_buffer_get_subbuf(buf, uconsume); | |
199 | if (!ret) { | |
200 | /* Set file position to zero at each successful "get" */ | |
201 | filp->f_pos = 0; | |
202 | } | |
203 | return ret; | |
204 | } | |
205 | case RING_BUFFER_PUT_SUBBUF: | |
206 | lib_ring_buffer_put_subbuf(buf); | |
207 | return 0; | |
208 | ||
209 | case RING_BUFFER_GET_NEXT_SUBBUF: | |
210 | { | |
211 | long ret; | |
212 | ||
213 | ret = lib_ring_buffer_get_next_subbuf(buf); | |
214 | if (!ret) { | |
215 | /* Set file position to zero at each successful "get" */ | |
216 | filp->f_pos = 0; | |
217 | } | |
218 | return ret; | |
219 | } | |
220 | case RING_BUFFER_PUT_NEXT_SUBBUF: | |
221 | lib_ring_buffer_put_next_subbuf(buf); | |
222 | return 0; | |
223 | case RING_BUFFER_GET_SUBBUF_SIZE: | |
224 | return put_ulong(lib_ring_buffer_get_read_data_size(config, buf), | |
225 | arg); | |
226 | case RING_BUFFER_GET_PADDED_SUBBUF_SIZE: | |
227 | { | |
228 | unsigned long size; | |
229 | ||
230 | size = lib_ring_buffer_get_read_data_size(config, buf); | |
231 | size = PAGE_ALIGN(size); | |
232 | return put_ulong(size, arg); | |
233 | } | |
234 | case RING_BUFFER_GET_MAX_SUBBUF_SIZE: | |
235 | return put_ulong(chan->backend.subbuf_size, arg); | |
236 | case RING_BUFFER_GET_MMAP_LEN: | |
237 | { | |
238 | unsigned long mmap_buf_len; | |
239 | ||
240 | if (config->output != RING_BUFFER_MMAP) | |
241 | return -EINVAL; | |
242 | mmap_buf_len = chan->backend.buf_size; | |
243 | if (chan->backend.extra_reader_sb) | |
244 | mmap_buf_len += chan->backend.subbuf_size; | |
245 | if (mmap_buf_len > INT_MAX) | |
246 | return -EFBIG; | |
247 | return put_ulong(mmap_buf_len, arg); | |
248 | } | |
249 | case RING_BUFFER_GET_MMAP_READ_OFFSET: | |
250 | { | |
251 | unsigned long sb_bindex; | |
252 | ||
253 | if (config->output != RING_BUFFER_MMAP) | |
254 | return -EINVAL; | |
255 | sb_bindex = subbuffer_id_get_index(config, | |
256 | buf->backend.buf_rsb.id); | |
257 | return put_ulong(buf->backend.array[sb_bindex]->mmap_offset, | |
258 | arg); | |
259 | } | |
5c055266 | 260 | case RING_BUFFER_FLUSH: |
5e391252 | 261 | lib_ring_buffer_switch_remote(buf); |
5c055266 | 262 | return 0; |
c6f05468 MD |
263 | case RING_BUFFER_FLUSH_EMPTY: |
264 | lib_ring_buffer_switch_remote_empty(buf); | |
265 | return 0; | |
f3bc08c5 MD |
266 | default: |
267 | return -ENOIOCTLCMD; | |
268 | } | |
269 | } | |
d83004aa JD |
270 | EXPORT_SYMBOL_GPL(lib_ring_buffer_ioctl); |
271 | ||
272 | /** | |
273 | * vfs_lib_ring_buffer_ioctl - control ring buffer reader synchronization | |
274 | * | |
275 | * @filp: the file | |
276 | * @cmd: the command | |
277 | * @arg: command arg | |
278 | * | |
279 | * This ioctl implements commands necessary for producer/consumer | |
280 | * and flight recorder reader interaction : | |
281 | * RING_BUFFER_GET_NEXT_SUBBUF | |
282 | * Get the next sub-buffer that can be read. It never blocks. | |
283 | * RING_BUFFER_PUT_NEXT_SUBBUF | |
284 | * Release the currently read sub-buffer. | |
285 | * RING_BUFFER_GET_SUBBUF_SIZE | |
286 | * returns the size of the current sub-buffer. | |
287 | * RING_BUFFER_GET_MAX_SUBBUF_SIZE | |
288 | * returns the maximum size for sub-buffers. | |
289 | * RING_BUFFER_GET_NUM_SUBBUF | |
290 | * returns the number of reader-visible sub-buffers in the per cpu | |
291 | * channel (for mmap). | |
292 | * RING_BUFFER_GET_MMAP_READ_OFFSET | |
293 | * returns the offset of the subbuffer belonging to the reader. | |
294 | * Should only be used for mmap clients. | |
295 | */ | |
296 | static | |
297 | long vfs_lib_ring_buffer_ioctl(struct file *filp, unsigned int cmd, unsigned long arg) | |
298 | { | |
299 | struct lib_ring_buffer *buf = filp->private_data; | |
300 | ||
301 | return lib_ring_buffer_ioctl(filp, cmd, arg, buf); | |
302 | } | |
f3bc08c5 MD |
303 | |
304 | #ifdef CONFIG_COMPAT | |
305 | long lib_ring_buffer_compat_ioctl(struct file *filp, unsigned int cmd, | |
d83004aa | 306 | unsigned long arg, struct lib_ring_buffer *buf) |
f3bc08c5 | 307 | { |
f3bc08c5 | 308 | struct channel *chan = buf->backend.chan; |
5a8fd222 | 309 | const struct lib_ring_buffer_config *config = &chan->backend.config; |
254ec7bc MD |
310 | |
311 | if (lib_ring_buffer_channel_is_disabled(chan)) | |
312 | return -EIO; | |
f3bc08c5 MD |
313 | |
314 | switch (cmd) { | |
216f7feb | 315 | case RING_BUFFER_COMPAT_SNAPSHOT: |
f3bc08c5 MD |
316 | return lib_ring_buffer_snapshot(buf, &buf->cons_snapshot, |
317 | &buf->prod_snapshot); | |
4dce5a48 JG |
318 | case RING_BUFFER_COMPAT_SNAPSHOT_SAMPLE_POSITIONS: |
319 | return lib_ring_buffer_snapshot_sample_positions(buf, | |
320 | &buf->cons_snapshot, &buf->prod_snapshot); | |
216f7feb | 321 | case RING_BUFFER_COMPAT_SNAPSHOT_GET_CONSUMED: |
f3bc08c5 | 322 | return compat_put_ulong(buf->cons_snapshot, arg); |
216f7feb | 323 | case RING_BUFFER_COMPAT_SNAPSHOT_GET_PRODUCED: |
f3bc08c5 | 324 | return compat_put_ulong(buf->prod_snapshot, arg); |
216f7feb | 325 | case RING_BUFFER_COMPAT_GET_SUBBUF: |
f3bc08c5 MD |
326 | { |
327 | __u32 uconsume; | |
328 | unsigned long consume; | |
329 | long ret; | |
330 | ||
331 | ret = get_user(uconsume, (__u32 __user *) arg); | |
332 | if (ret) | |
333 | return ret; /* will return -EFAULT */ | |
334 | consume = buf->cons_snapshot; | |
335 | consume &= ~0xFFFFFFFFL; | |
336 | consume |= uconsume; | |
337 | ret = lib_ring_buffer_get_subbuf(buf, consume); | |
338 | if (!ret) { | |
339 | /* Set file position to zero at each successful "get" */ | |
340 | filp->f_pos = 0; | |
341 | } | |
342 | return ret; | |
343 | } | |
216f7feb | 344 | case RING_BUFFER_COMPAT_PUT_SUBBUF: |
f3bc08c5 MD |
345 | lib_ring_buffer_put_subbuf(buf); |
346 | return 0; | |
347 | ||
216f7feb | 348 | case RING_BUFFER_COMPAT_GET_NEXT_SUBBUF: |
f3bc08c5 MD |
349 | { |
350 | long ret; | |
351 | ||
352 | ret = lib_ring_buffer_get_next_subbuf(buf); | |
353 | if (!ret) { | |
354 | /* Set file position to zero at each successful "get" */ | |
355 | filp->f_pos = 0; | |
356 | } | |
357 | return ret; | |
358 | } | |
216f7feb | 359 | case RING_BUFFER_COMPAT_PUT_NEXT_SUBBUF: |
f3bc08c5 MD |
360 | lib_ring_buffer_put_next_subbuf(buf); |
361 | return 0; | |
216f7feb | 362 | case RING_BUFFER_COMPAT_GET_SUBBUF_SIZE: |
f3bc08c5 MD |
363 | { |
364 | unsigned long data_size; | |
365 | ||
366 | data_size = lib_ring_buffer_get_read_data_size(config, buf); | |
367 | if (data_size > UINT_MAX) | |
368 | return -EFBIG; | |
4343ec8e | 369 | return compat_put_ulong(data_size, arg); |
f3bc08c5 | 370 | } |
216f7feb | 371 | case RING_BUFFER_COMPAT_GET_PADDED_SUBBUF_SIZE: |
f3bc08c5 MD |
372 | { |
373 | unsigned long size; | |
374 | ||
375 | size = lib_ring_buffer_get_read_data_size(config, buf); | |
376 | size = PAGE_ALIGN(size); | |
377 | if (size > UINT_MAX) | |
378 | return -EFBIG; | |
4343ec8e | 379 | return compat_put_ulong(size, arg); |
f3bc08c5 | 380 | } |
216f7feb | 381 | case RING_BUFFER_COMPAT_GET_MAX_SUBBUF_SIZE: |
f3bc08c5 MD |
382 | if (chan->backend.subbuf_size > UINT_MAX) |
383 | return -EFBIG; | |
4343ec8e | 384 | return compat_put_ulong(chan->backend.subbuf_size, arg); |
216f7feb | 385 | case RING_BUFFER_COMPAT_GET_MMAP_LEN: |
f3bc08c5 MD |
386 | { |
387 | unsigned long mmap_buf_len; | |
388 | ||
389 | if (config->output != RING_BUFFER_MMAP) | |
390 | return -EINVAL; | |
391 | mmap_buf_len = chan->backend.buf_size; | |
392 | if (chan->backend.extra_reader_sb) | |
393 | mmap_buf_len += chan->backend.subbuf_size; | |
394 | if (mmap_buf_len > UINT_MAX) | |
395 | return -EFBIG; | |
4343ec8e | 396 | return compat_put_ulong(mmap_buf_len, arg); |
f3bc08c5 | 397 | } |
216f7feb | 398 | case RING_BUFFER_COMPAT_GET_MMAP_READ_OFFSET: |
f3bc08c5 MD |
399 | { |
400 | unsigned long sb_bindex, read_offset; | |
401 | ||
402 | if (config->output != RING_BUFFER_MMAP) | |
403 | return -EINVAL; | |
404 | sb_bindex = subbuffer_id_get_index(config, | |
405 | buf->backend.buf_rsb.id); | |
406 | read_offset = buf->backend.array[sb_bindex]->mmap_offset; | |
407 | if (read_offset > UINT_MAX) | |
408 | return -EINVAL; | |
4343ec8e | 409 | return compat_put_ulong(read_offset, arg); |
f3bc08c5 | 410 | } |
216f7feb | 411 | case RING_BUFFER_COMPAT_FLUSH: |
5e391252 | 412 | lib_ring_buffer_switch_remote(buf); |
5c055266 | 413 | return 0; |
c6f05468 MD |
414 | case RING_BUFFER_COMPAT_FLUSH_EMPTY: |
415 | lib_ring_buffer_switch_remote_empty(buf); | |
416 | return 0; | |
f3bc08c5 MD |
417 | default: |
418 | return -ENOIOCTLCMD; | |
419 | } | |
420 | } | |
d83004aa JD |
421 | EXPORT_SYMBOL_GPL(lib_ring_buffer_compat_ioctl); |
422 | ||
423 | static | |
424 | long vfs_lib_ring_buffer_compat_ioctl(struct file *filp, unsigned int cmd, | |
425 | unsigned long arg) | |
426 | { | |
427 | struct lib_ring_buffer *buf = filp->private_data; | |
428 | ||
429 | return lib_ring_buffer_compat_ioctl(filp, cmd, arg, buf); | |
430 | } | |
f3bc08c5 MD |
431 | #endif |
432 | ||
433 | const struct file_operations lib_ring_buffer_file_operations = { | |
a33c9927 | 434 | .owner = THIS_MODULE, |
d83004aa JD |
435 | .open = vfs_lib_ring_buffer_open, |
436 | .release = vfs_lib_ring_buffer_release, | |
437 | .poll = vfs_lib_ring_buffer_poll, | |
438 | .splice_read = vfs_lib_ring_buffer_splice_read, | |
439 | .mmap = vfs_lib_ring_buffer_mmap, | |
440 | .unlocked_ioctl = vfs_lib_ring_buffer_ioctl, | |
441 | .llseek = vfs_lib_ring_buffer_no_llseek, | |
f3bc08c5 | 442 | #ifdef CONFIG_COMPAT |
d83004aa | 443 | .compat_ioctl = vfs_lib_ring_buffer_compat_ioctl, |
f3bc08c5 MD |
444 | #endif |
445 | }; | |
446 | EXPORT_SYMBOL_GPL(lib_ring_buffer_file_operations); | |
447 | ||
448 | MODULE_LICENSE("GPL and additional rights"); | |
1c124020 MJ |
449 | MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>"); |
450 | MODULE_DESCRIPTION("LTTng ring buffer library"); | |
13ab8b0a MD |
451 | MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "." |
452 | __stringify(LTTNG_MODULES_MINOR_VERSION) "." | |
453 | __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION) | |
454 | LTTNG_MODULES_EXTRAVERSION); |