]>
Commit | Line | Data |
---|---|---|
5274f052 JA |
1 | /* |
2 | * "splice": joining two ropes together by interweaving their strands. | |
3 | * | |
4 | * This is the "extended pipe" functionality, where a pipe is used as | |
5 | * an arbitrary in-memory buffer. Think of a pipe as a small kernel | |
6 | * buffer that you can use to transfer data from one end to the other. | |
7 | * | |
8 | * The traditional unix read/write is extended with a "splice()" operation | |
9 | * that transfers data buffers to or from a pipe buffer. | |
10 | * | |
11 | * Named by Larry McVoy, original implementation from Linus, extended by | |
c2058e06 JA |
12 | * Jens to support splicing to files, network, direct splicing, etc and |
13 | * fixing lots of bugs. | |
5274f052 | 14 | * |
c2058e06 JA |
15 | * Copyright (C) 2005-2006 Jens Axboe <[email protected]> |
16 | * Copyright (C) 2005-2006 Linus Torvalds <[email protected]> | |
17 | * Copyright (C) 2006 Ingo Molnar <[email protected]> | |
5274f052 JA |
18 | * |
19 | */ | |
20 | #include <linux/fs.h> | |
21 | #include <linux/file.h> | |
22 | #include <linux/pagemap.h> | |
23 | #include <linux/pipe_fs_i.h> | |
24 | #include <linux/mm_inline.h> | |
5abc97aa | 25 | #include <linux/swap.h> |
4f6f0bd2 JA |
26 | #include <linux/writeback.h> |
27 | #include <linux/buffer_head.h> | |
a0f06780 | 28 | #include <linux/module.h> |
4f6f0bd2 | 29 | #include <linux/syscalls.h> |
912d35f8 | 30 | #include <linux/uio.h> |
5274f052 | 31 | |
912d35f8 JA |
32 | struct partial_page { |
33 | unsigned int offset; | |
34 | unsigned int len; | |
35 | }; | |
36 | ||
37 | /* | |
00522fb4 | 38 | * Passed to splice_to_pipe |
912d35f8 JA |
39 | */ |
40 | struct splice_pipe_desc { | |
41 | struct page **pages; /* page map */ | |
42 | struct partial_page *partial; /* pages[] may not be contig */ | |
43 | int nr_pages; /* number of pages in map */ | |
44 | unsigned int flags; /* splice flags */ | |
45 | struct pipe_buf_operations *ops;/* ops associated with output pipe */ | |
46 | }; | |
47 | ||
83f9135b JA |
48 | /* |
49 | * Attempt to steal a page from a pipe buffer. This should perhaps go into | |
50 | * a vm helper function, it's already simplified quite a bit by the | |
51 | * addition of remove_mapping(). If success is returned, the caller may | |
52 | * attempt to reuse this page for another destination. | |
53 | */ | |
76ad4d11 | 54 | static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe, |
5abc97aa JA |
55 | struct pipe_buffer *buf) |
56 | { | |
57 | struct page *page = buf->page; | |
4f6f0bd2 | 58 | struct address_space *mapping = page_mapping(page); |
5abc97aa | 59 | |
9e0267c2 JA |
60 | lock_page(page); |
61 | ||
5abc97aa JA |
62 | WARN_ON(!PageUptodate(page)); |
63 | ||
ad8d6f0a JA |
64 | /* |
65 | * At least for ext2 with nobh option, we need to wait on writeback | |
66 | * completing on this page, since we'll remove it from the pagecache. | |
67 | * Otherwise truncate wont wait on the page, allowing the disk | |
68 | * blocks to be reused by someone else before we actually wrote our | |
69 | * data to them. fs corruption ensues. | |
70 | */ | |
71 | wait_on_page_writeback(page); | |
72 | ||
4f6f0bd2 JA |
73 | if (PagePrivate(page)) |
74 | try_to_release_page(page, mapping_gfp_mask(mapping)); | |
75 | ||
9e0267c2 JA |
76 | if (!remove_mapping(mapping, page)) { |
77 | unlock_page(page); | |
5abc97aa | 78 | return 1; |
9e0267c2 | 79 | } |
5abc97aa | 80 | |
1432873a | 81 | buf->flags |= PIPE_BUF_FLAG_LRU; |
5abc97aa JA |
82 | return 0; |
83 | } | |
84 | ||
76ad4d11 | 85 | static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe, |
5274f052 JA |
86 | struct pipe_buffer *buf) |
87 | { | |
88 | page_cache_release(buf->page); | |
1432873a | 89 | buf->flags &= ~PIPE_BUF_FLAG_LRU; |
5274f052 JA |
90 | } |
91 | ||
76ad4d11 | 92 | static int page_cache_pipe_buf_pin(struct pipe_inode_info *pipe, |
f84d7519 | 93 | struct pipe_buffer *buf) |
5274f052 JA |
94 | { |
95 | struct page *page = buf->page; | |
49d0b21b | 96 | int err; |
5274f052 JA |
97 | |
98 | if (!PageUptodate(page)) { | |
49d0b21b JA |
99 | lock_page(page); |
100 | ||
101 | /* | |
102 | * Page got truncated/unhashed. This will cause a 0-byte | |
73d62d83 | 103 | * splice, if this is the first page. |
49d0b21b JA |
104 | */ |
105 | if (!page->mapping) { | |
106 | err = -ENODATA; | |
107 | goto error; | |
108 | } | |
5274f052 | 109 | |
49d0b21b | 110 | /* |
73d62d83 | 111 | * Uh oh, read-error from disk. |
49d0b21b JA |
112 | */ |
113 | if (!PageUptodate(page)) { | |
114 | err = -EIO; | |
115 | goto error; | |
116 | } | |
117 | ||
118 | /* | |
f84d7519 | 119 | * Page is ok afterall, we are done. |
49d0b21b | 120 | */ |
5274f052 | 121 | unlock_page(page); |
5274f052 JA |
122 | } |
123 | ||
f84d7519 | 124 | return 0; |
49d0b21b JA |
125 | error: |
126 | unlock_page(page); | |
f84d7519 | 127 | return err; |
70524490 JA |
128 | } |
129 | ||
5274f052 JA |
130 | static struct pipe_buf_operations page_cache_pipe_buf_ops = { |
131 | .can_merge = 0, | |
f84d7519 JA |
132 | .map = generic_pipe_buf_map, |
133 | .unmap = generic_pipe_buf_unmap, | |
134 | .pin = page_cache_pipe_buf_pin, | |
5274f052 | 135 | .release = page_cache_pipe_buf_release, |
5abc97aa | 136 | .steal = page_cache_pipe_buf_steal, |
f84d7519 | 137 | .get = generic_pipe_buf_get, |
5274f052 JA |
138 | }; |
139 | ||
912d35f8 JA |
140 | static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe, |
141 | struct pipe_buffer *buf) | |
142 | { | |
7afa6fd0 JA |
143 | if (!(buf->flags & PIPE_BUF_FLAG_GIFT)) |
144 | return 1; | |
145 | ||
1432873a | 146 | buf->flags |= PIPE_BUF_FLAG_LRU; |
330ab716 | 147 | return generic_pipe_buf_steal(pipe, buf); |
912d35f8 JA |
148 | } |
149 | ||
150 | static struct pipe_buf_operations user_page_pipe_buf_ops = { | |
151 | .can_merge = 0, | |
f84d7519 JA |
152 | .map = generic_pipe_buf_map, |
153 | .unmap = generic_pipe_buf_unmap, | |
154 | .pin = generic_pipe_buf_pin, | |
912d35f8 JA |
155 | .release = page_cache_pipe_buf_release, |
156 | .steal = user_page_pipe_buf_steal, | |
f84d7519 | 157 | .get = generic_pipe_buf_get, |
912d35f8 JA |
158 | }; |
159 | ||
83f9135b JA |
160 | /* |
161 | * Pipe output worker. This sets up our pipe format with the page cache | |
162 | * pipe buffer operations. Otherwise very similar to the regular pipe_writev(). | |
163 | */ | |
00522fb4 JA |
164 | static ssize_t splice_to_pipe(struct pipe_inode_info *pipe, |
165 | struct splice_pipe_desc *spd) | |
5274f052 | 166 | { |
912d35f8 | 167 | int ret, do_wakeup, page_nr; |
5274f052 JA |
168 | |
169 | ret = 0; | |
170 | do_wakeup = 0; | |
912d35f8 | 171 | page_nr = 0; |
5274f052 | 172 | |
3a326a2c IM |
173 | if (pipe->inode) |
174 | mutex_lock(&pipe->inode->i_mutex); | |
5274f052 | 175 | |
5274f052 | 176 | for (;;) { |
3a326a2c | 177 | if (!pipe->readers) { |
5274f052 JA |
178 | send_sig(SIGPIPE, current, 0); |
179 | if (!ret) | |
180 | ret = -EPIPE; | |
181 | break; | |
182 | } | |
183 | ||
6f767b04 JA |
184 | if (pipe->nrbufs < PIPE_BUFFERS) { |
185 | int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1); | |
3a326a2c | 186 | struct pipe_buffer *buf = pipe->bufs + newbuf; |
5274f052 | 187 | |
912d35f8 JA |
188 | buf->page = spd->pages[page_nr]; |
189 | buf->offset = spd->partial[page_nr].offset; | |
190 | buf->len = spd->partial[page_nr].len; | |
191 | buf->ops = spd->ops; | |
7afa6fd0 JA |
192 | if (spd->flags & SPLICE_F_GIFT) |
193 | buf->flags |= PIPE_BUF_FLAG_GIFT; | |
194 | ||
6f767b04 | 195 | pipe->nrbufs++; |
912d35f8 JA |
196 | page_nr++; |
197 | ret += buf->len; | |
198 | ||
6f767b04 JA |
199 | if (pipe->inode) |
200 | do_wakeup = 1; | |
5274f052 | 201 | |
912d35f8 | 202 | if (!--spd->nr_pages) |
5274f052 | 203 | break; |
6f767b04 | 204 | if (pipe->nrbufs < PIPE_BUFFERS) |
5274f052 JA |
205 | continue; |
206 | ||
207 | break; | |
208 | } | |
209 | ||
912d35f8 | 210 | if (spd->flags & SPLICE_F_NONBLOCK) { |
29e35094 LT |
211 | if (!ret) |
212 | ret = -EAGAIN; | |
213 | break; | |
214 | } | |
215 | ||
5274f052 JA |
216 | if (signal_pending(current)) { |
217 | if (!ret) | |
218 | ret = -ERESTARTSYS; | |
219 | break; | |
220 | } | |
221 | ||
222 | if (do_wakeup) { | |
c0bd1f65 | 223 | smp_mb(); |
3a326a2c IM |
224 | if (waitqueue_active(&pipe->wait)) |
225 | wake_up_interruptible_sync(&pipe->wait); | |
226 | kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN); | |
5274f052 JA |
227 | do_wakeup = 0; |
228 | } | |
229 | ||
3a326a2c IM |
230 | pipe->waiting_writers++; |
231 | pipe_wait(pipe); | |
232 | pipe->waiting_writers--; | |
5274f052 JA |
233 | } |
234 | ||
3a326a2c IM |
235 | if (pipe->inode) |
236 | mutex_unlock(&pipe->inode->i_mutex); | |
5274f052 JA |
237 | |
238 | if (do_wakeup) { | |
c0bd1f65 | 239 | smp_mb(); |
3a326a2c IM |
240 | if (waitqueue_active(&pipe->wait)) |
241 | wake_up_interruptible(&pipe->wait); | |
242 | kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN); | |
5274f052 JA |
243 | } |
244 | ||
912d35f8 JA |
245 | while (page_nr < spd->nr_pages) |
246 | page_cache_release(spd->pages[page_nr++]); | |
5274f052 JA |
247 | |
248 | return ret; | |
249 | } | |
250 | ||
3a326a2c | 251 | static int |
cbb7e577 JA |
252 | __generic_file_splice_read(struct file *in, loff_t *ppos, |
253 | struct pipe_inode_info *pipe, size_t len, | |
254 | unsigned int flags) | |
5274f052 JA |
255 | { |
256 | struct address_space *mapping = in->f_mapping; | |
912d35f8 | 257 | unsigned int loff, nr_pages; |
16c523dd | 258 | struct page *pages[PIPE_BUFFERS]; |
912d35f8 | 259 | struct partial_page partial[PIPE_BUFFERS]; |
5274f052 | 260 | struct page *page; |
91ad66ef JA |
261 | pgoff_t index, end_index; |
262 | loff_t isize; | |
912d35f8 | 263 | size_t total_len; |
eb20796b | 264 | int error, page_nr; |
912d35f8 JA |
265 | struct splice_pipe_desc spd = { |
266 | .pages = pages, | |
267 | .partial = partial, | |
268 | .flags = flags, | |
269 | .ops = &page_cache_pipe_buf_ops, | |
270 | }; | |
5274f052 | 271 | |
cbb7e577 | 272 | index = *ppos >> PAGE_CACHE_SHIFT; |
912d35f8 JA |
273 | loff = *ppos & ~PAGE_CACHE_MASK; |
274 | nr_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT; | |
5274f052 JA |
275 | |
276 | if (nr_pages > PIPE_BUFFERS) | |
277 | nr_pages = PIPE_BUFFERS; | |
278 | ||
279 | /* | |
73d62d83 | 280 | * Initiate read-ahead on this page range. however, don't call into |
0b749ce3 JA |
281 | * read-ahead if this is a non-zero offset (we are likely doing small |
282 | * chunk splice and the page is already there) for a single page. | |
5274f052 | 283 | */ |
eb645a24 JA |
284 | if (!loff || nr_pages > 1) |
285 | page_cache_readahead(mapping, &in->f_ra, in, index, nr_pages); | |
5274f052 | 286 | |
5274f052 | 287 | /* |
73d62d83 | 288 | * Now fill in the holes: |
5274f052 | 289 | */ |
7480a904 | 290 | error = 0; |
912d35f8 | 291 | total_len = 0; |
82aa5d61 | 292 | |
eb20796b JA |
293 | /* |
294 | * Lookup the (hopefully) full range of pages we need. | |
295 | */ | |
296 | spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, pages); | |
82aa5d61 | 297 | |
eb20796b JA |
298 | /* |
299 | * If find_get_pages_contig() returned fewer pages than we needed, | |
300 | * allocate the rest. | |
301 | */ | |
302 | index += spd.nr_pages; | |
303 | while (spd.nr_pages < nr_pages) { | |
82aa5d61 | 304 | /* |
eb20796b JA |
305 | * Page could be there, find_get_pages_contig() breaks on |
306 | * the first hole. | |
5274f052 | 307 | */ |
7480a904 JA |
308 | page = find_get_page(mapping, index); |
309 | if (!page) { | |
e27dedd8 JA |
310 | /* |
311 | * Make sure the read-ahead engine is notified | |
312 | * about this failure. | |
313 | */ | |
314 | handle_ra_miss(mapping, &in->f_ra, index); | |
315 | ||
7480a904 | 316 | /* |
eb20796b | 317 | * page didn't exist, allocate one. |
7480a904 JA |
318 | */ |
319 | page = page_cache_alloc_cold(mapping); | |
320 | if (!page) | |
321 | break; | |
322 | ||
323 | error = add_to_page_cache_lru(page, mapping, index, | |
eb20796b | 324 | mapping_gfp_mask(mapping)); |
7480a904 JA |
325 | if (unlikely(error)) { |
326 | page_cache_release(page); | |
a0548871 JA |
327 | if (error == -EEXIST) |
328 | continue; | |
7480a904 JA |
329 | break; |
330 | } | |
eb20796b JA |
331 | /* |
332 | * add_to_page_cache() locks the page, unlock it | |
333 | * to avoid convoluting the logic below even more. | |
334 | */ | |
335 | unlock_page(page); | |
7480a904 JA |
336 | } |
337 | ||
eb20796b JA |
338 | pages[spd.nr_pages++] = page; |
339 | index++; | |
340 | } | |
341 | ||
342 | /* | |
343 | * Now loop over the map and see if we need to start IO on any | |
344 | * pages, fill in the partial map, etc. | |
345 | */ | |
346 | index = *ppos >> PAGE_CACHE_SHIFT; | |
347 | nr_pages = spd.nr_pages; | |
348 | spd.nr_pages = 0; | |
349 | for (page_nr = 0; page_nr < nr_pages; page_nr++) { | |
350 | unsigned int this_len; | |
351 | ||
352 | if (!len) | |
353 | break; | |
354 | ||
355 | /* | |
356 | * this_len is the max we'll use from this page | |
357 | */ | |
358 | this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff); | |
359 | page = pages[page_nr]; | |
360 | ||
7480a904 JA |
361 | /* |
362 | * If the page isn't uptodate, we may need to start io on it | |
363 | */ | |
364 | if (!PageUptodate(page)) { | |
c4f895cb JA |
365 | /* |
366 | * If in nonblock mode then dont block on waiting | |
367 | * for an in-flight io page | |
368 | */ | |
369 | if (flags & SPLICE_F_NONBLOCK) | |
370 | break; | |
371 | ||
7480a904 JA |
372 | lock_page(page); |
373 | ||
374 | /* | |
375 | * page was truncated, stop here. if this isn't the | |
376 | * first page, we'll just complete what we already | |
377 | * added | |
378 | */ | |
379 | if (!page->mapping) { | |
380 | unlock_page(page); | |
7480a904 JA |
381 | break; |
382 | } | |
383 | /* | |
384 | * page was already under io and is now done, great | |
385 | */ | |
386 | if (PageUptodate(page)) { | |
387 | unlock_page(page); | |
388 | goto fill_it; | |
389 | } | |
5274f052 | 390 | |
7480a904 JA |
391 | /* |
392 | * need to read in the page | |
393 | */ | |
394 | error = mapping->a_ops->readpage(in, page); | |
5274f052 | 395 | if (unlikely(error)) { |
eb20796b JA |
396 | /* |
397 | * We really should re-lookup the page here, | |
398 | * but it complicates things a lot. Instead | |
399 | * lets just do what we already stored, and | |
400 | * we'll get it the next time we are called. | |
401 | */ | |
7480a904 | 402 | if (error == AOP_TRUNCATED_PAGE) |
eb20796b JA |
403 | error = 0; |
404 | ||
5274f052 JA |
405 | break; |
406 | } | |
91ad66ef JA |
407 | |
408 | /* | |
409 | * i_size must be checked after ->readpage(). | |
410 | */ | |
411 | isize = i_size_read(mapping->host); | |
412 | end_index = (isize - 1) >> PAGE_CACHE_SHIFT; | |
eb20796b | 413 | if (unlikely(!isize || index > end_index)) |
91ad66ef | 414 | break; |
91ad66ef JA |
415 | |
416 | /* | |
417 | * if this is the last page, see if we need to shrink | |
418 | * the length and stop | |
419 | */ | |
420 | if (end_index == index) { | |
421 | loff = PAGE_CACHE_SIZE - (isize & ~PAGE_CACHE_MASK); | |
eb20796b | 422 | if (total_len + loff > isize) |
91ad66ef | 423 | break; |
91ad66ef JA |
424 | /* |
425 | * force quit after adding this page | |
426 | */ | |
eb20796b | 427 | len = this_len; |
82aa5d61 | 428 | this_len = min(this_len, loff); |
912d35f8 | 429 | loff = 0; |
91ad66ef | 430 | } |
5274f052 | 431 | } |
7480a904 | 432 | fill_it: |
eb20796b JA |
433 | partial[page_nr].offset = loff; |
434 | partial[page_nr].len = this_len; | |
82aa5d61 | 435 | len -= this_len; |
912d35f8 | 436 | total_len += this_len; |
91ad66ef | 437 | loff = 0; |
eb20796b JA |
438 | spd.nr_pages++; |
439 | index++; | |
5274f052 JA |
440 | } |
441 | ||
eb20796b JA |
442 | /* |
443 | * Release any pages at the end, if we quit early. 'i' is how far | |
444 | * we got, 'nr_pages' is how many pages are in the map. | |
445 | */ | |
446 | while (page_nr < nr_pages) | |
447 | page_cache_release(pages[page_nr++]); | |
448 | ||
912d35f8 | 449 | if (spd.nr_pages) |
00522fb4 | 450 | return splice_to_pipe(pipe, &spd); |
5274f052 | 451 | |
7480a904 | 452 | return error; |
5274f052 JA |
453 | } |
454 | ||
83f9135b JA |
455 | /** |
456 | * generic_file_splice_read - splice data from file to a pipe | |
457 | * @in: file to splice from | |
458 | * @pipe: pipe to splice to | |
459 | * @len: number of bytes to splice | |
460 | * @flags: splice modifier flags | |
461 | * | |
462 | * Will read pages from given file and fill them into a pipe. | |
83f9135b | 463 | */ |
cbb7e577 JA |
464 | ssize_t generic_file_splice_read(struct file *in, loff_t *ppos, |
465 | struct pipe_inode_info *pipe, size_t len, | |
466 | unsigned int flags) | |
5274f052 JA |
467 | { |
468 | ssize_t spliced; | |
469 | int ret; | |
470 | ||
471 | ret = 0; | |
472 | spliced = 0; | |
3a326a2c | 473 | |
5274f052 | 474 | while (len) { |
cbb7e577 | 475 | ret = __generic_file_splice_read(in, ppos, pipe, len, flags); |
5274f052 | 476 | |
c4f895cb | 477 | if (ret < 0) |
5274f052 | 478 | break; |
c4f895cb JA |
479 | else if (!ret) { |
480 | if (spliced) | |
481 | break; | |
482 | if (flags & SPLICE_F_NONBLOCK) { | |
483 | ret = -EAGAIN; | |
484 | break; | |
485 | } | |
486 | } | |
5274f052 | 487 | |
cbb7e577 | 488 | *ppos += ret; |
5274f052 JA |
489 | len -= ret; |
490 | spliced += ret; | |
491 | } | |
492 | ||
493 | if (spliced) | |
494 | return spliced; | |
495 | ||
496 | return ret; | |
497 | } | |
498 | ||
059a8f37 JA |
499 | EXPORT_SYMBOL(generic_file_splice_read); |
500 | ||
5274f052 | 501 | /* |
4f6f0bd2 | 502 | * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos' |
016b661e | 503 | * using sendpage(). Return the number of bytes sent. |
5274f052 | 504 | */ |
76ad4d11 | 505 | static int pipe_to_sendpage(struct pipe_inode_info *pipe, |
5274f052 JA |
506 | struct pipe_buffer *buf, struct splice_desc *sd) |
507 | { | |
508 | struct file *file = sd->file; | |
509 | loff_t pos = sd->pos; | |
f84d7519 | 510 | int ret, more; |
5274f052 | 511 | |
76ad4d11 | 512 | ret = buf->ops->pin(pipe, buf); |
f84d7519 JA |
513 | if (!ret) { |
514 | more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len; | |
5274f052 | 515 | |
f84d7519 JA |
516 | ret = file->f_op->sendpage(file, buf->page, buf->offset, |
517 | sd->len, &pos, more); | |
518 | } | |
5274f052 | 519 | |
016b661e | 520 | return ret; |
5274f052 JA |
521 | } |
522 | ||
523 | /* | |
524 | * This is a little more tricky than the file -> pipe splicing. There are | |
525 | * basically three cases: | |
526 | * | |
527 | * - Destination page already exists in the address space and there | |
528 | * are users of it. For that case we have no other option that | |
529 | * copying the data. Tough luck. | |
530 | * - Destination page already exists in the address space, but there | |
531 | * are no users of it. Make sure it's uptodate, then drop it. Fall | |
532 | * through to last case. | |
533 | * - Destination page does not exist, we can add the pipe page to | |
534 | * the page cache and avoid the copy. | |
535 | * | |
83f9135b JA |
536 | * If asked to move pages to the output file (SPLICE_F_MOVE is set in |
537 | * sd->flags), we attempt to migrate pages from the pipe to the output | |
538 | * file address space page cache. This is possible if no one else has | |
539 | * the pipe page referenced outside of the pipe and page cache. If | |
540 | * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create | |
541 | * a new page in the output file page cache and fill/dirty that. | |
5274f052 | 542 | */ |
76ad4d11 | 543 | static int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf, |
5274f052 JA |
544 | struct splice_desc *sd) |
545 | { | |
546 | struct file *file = sd->file; | |
547 | struct address_space *mapping = file->f_mapping; | |
3e7ee3e7 | 548 | gfp_t gfp_mask = mapping_gfp_mask(mapping); |
016b661e | 549 | unsigned int offset, this_len; |
5274f052 | 550 | struct page *page; |
5274f052 | 551 | pgoff_t index; |
3e7ee3e7 | 552 | int ret; |
5274f052 JA |
553 | |
554 | /* | |
49d0b21b | 555 | * make sure the data in this buffer is uptodate |
5274f052 | 556 | */ |
76ad4d11 | 557 | ret = buf->ops->pin(pipe, buf); |
f84d7519 JA |
558 | if (unlikely(ret)) |
559 | return ret; | |
5274f052 JA |
560 | |
561 | index = sd->pos >> PAGE_CACHE_SHIFT; | |
562 | offset = sd->pos & ~PAGE_CACHE_MASK; | |
563 | ||
016b661e JA |
564 | this_len = sd->len; |
565 | if (this_len + offset > PAGE_CACHE_SIZE) | |
566 | this_len = PAGE_CACHE_SIZE - offset; | |
567 | ||
5274f052 | 568 | /* |
0568b409 JA |
569 | * Reuse buf page, if SPLICE_F_MOVE is set and we are doing a full |
570 | * page. | |
5274f052 | 571 | */ |
0568b409 | 572 | if ((sd->flags & SPLICE_F_MOVE) && this_len == PAGE_CACHE_SIZE) { |
83f9135b | 573 | /* |
1432873a JA |
574 | * If steal succeeds, buf->page is now pruned from the |
575 | * pagecache and we can reuse it. The page will also be | |
576 | * locked on successful return. | |
83f9135b | 577 | */ |
76ad4d11 | 578 | if (buf->ops->steal(pipe, buf)) |
5abc97aa JA |
579 | goto find_page; |
580 | ||
581 | page = buf->page; | |
46e678c9 JA |
582 | if (add_to_page_cache(page, mapping, index, gfp_mask)) { |
583 | unlock_page(page); | |
5abc97aa | 584 | goto find_page; |
46e678c9 | 585 | } |
1432873a JA |
586 | |
587 | page_cache_get(page); | |
588 | ||
589 | if (!(buf->flags & PIPE_BUF_FLAG_LRU)) | |
590 | lru_cache_add(page); | |
5abc97aa JA |
591 | } else { |
592 | find_page: | |
9e0267c2 JA |
593 | page = find_lock_page(mapping, index); |
594 | if (!page) { | |
595 | ret = -ENOMEM; | |
596 | page = page_cache_alloc_cold(mapping); | |
597 | if (unlikely(!page)) | |
598 | goto out_nomem; | |
599 | ||
600 | /* | |
601 | * This will also lock the page | |
602 | */ | |
603 | ret = add_to_page_cache_lru(page, mapping, index, | |
604 | gfp_mask); | |
605 | if (unlikely(ret)) | |
606 | goto out; | |
607 | } | |
5abc97aa JA |
608 | |
609 | /* | |
9e0267c2 JA |
610 | * We get here with the page locked. If the page is also |
611 | * uptodate, we don't need to do more. If it isn't, we | |
612 | * may need to bring it in if we are not going to overwrite | |
613 | * the full page. | |
5abc97aa JA |
614 | */ |
615 | if (!PageUptodate(page)) { | |
016b661e | 616 | if (this_len < PAGE_CACHE_SIZE) { |
5abc97aa JA |
617 | ret = mapping->a_ops->readpage(file, page); |
618 | if (unlikely(ret)) | |
619 | goto out; | |
620 | ||
621 | lock_page(page); | |
622 | ||
623 | if (!PageUptodate(page)) { | |
624 | /* | |
73d62d83 | 625 | * Page got invalidated, repeat. |
5abc97aa JA |
626 | */ |
627 | if (!page->mapping) { | |
628 | unlock_page(page); | |
629 | page_cache_release(page); | |
630 | goto find_page; | |
631 | } | |
632 | ret = -EIO; | |
633 | goto out; | |
5274f052 | 634 | } |
9e0267c2 | 635 | } else |
5abc97aa | 636 | SetPageUptodate(page); |
5274f052 JA |
637 | } |
638 | } | |
639 | ||
016b661e | 640 | ret = mapping->a_ops->prepare_write(file, page, offset, offset+this_len); |
bfc4ee39 JA |
641 | if (unlikely(ret)) { |
642 | loff_t isize = i_size_read(mapping->host); | |
643 | ||
644 | if (ret != AOP_TRUNCATED_PAGE) | |
645 | unlock_page(page); | |
4f6f0bd2 | 646 | page_cache_release(page); |
bfc4ee39 JA |
647 | if (ret == AOP_TRUNCATED_PAGE) |
648 | goto find_page; | |
649 | ||
650 | /* | |
651 | * prepare_write() may have instantiated a few blocks | |
652 | * outside i_size. Trim these off again. | |
653 | */ | |
654 | if (sd->pos + this_len > isize) | |
655 | vmtruncate(mapping->host, isize); | |
656 | ||
5274f052 | 657 | goto out; |
bfc4ee39 | 658 | } |
5274f052 | 659 | |
0568b409 | 660 | if (buf->page != page) { |
f84d7519 JA |
661 | /* |
662 | * Careful, ->map() uses KM_USER0! | |
663 | */ | |
76ad4d11 | 664 | char *src = buf->ops->map(pipe, buf, 1); |
f84d7519 | 665 | char *dst = kmap_atomic(page, KM_USER1); |
5abc97aa | 666 | |
016b661e | 667 | memcpy(dst + offset, src + buf->offset, this_len); |
5abc97aa | 668 | flush_dcache_page(page); |
f84d7519 | 669 | kunmap_atomic(dst, KM_USER1); |
76ad4d11 | 670 | buf->ops->unmap(pipe, buf, src); |
5abc97aa | 671 | } |
5274f052 | 672 | |
016b661e | 673 | ret = mapping->a_ops->commit_write(file, page, offset, offset+this_len); |
0568b409 JA |
674 | if (!ret) { |
675 | /* | |
676 | * Return the number of bytes written and mark page as | |
677 | * accessed, we are now done! | |
678 | */ | |
679 | ret = this_len; | |
680 | mark_page_accessed(page); | |
681 | balance_dirty_pages_ratelimited(mapping); | |
682 | } else if (ret == AOP_TRUNCATED_PAGE) { | |
4f6f0bd2 JA |
683 | page_cache_release(page); |
684 | goto find_page; | |
0568b409 | 685 | } |
5274f052 | 686 | out: |
0568b409 | 687 | page_cache_release(page); |
9e0267c2 | 688 | unlock_page(page); |
9aefe431 | 689 | out_nomem: |
5274f052 JA |
690 | return ret; |
691 | } | |
692 | ||
83f9135b JA |
693 | /* |
694 | * Pipe input worker. Most of this logic works like a regular pipe, the | |
695 | * key here is the 'actor' worker passed in that actually moves the data | |
696 | * to the wanted destination. See pipe_to_file/pipe_to_sendpage above. | |
697 | */ | |
00522fb4 JA |
698 | ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out, |
699 | loff_t *ppos, size_t len, unsigned int flags, | |
700 | splice_actor *actor) | |
5274f052 | 701 | { |
5274f052 JA |
702 | int ret, do_wakeup, err; |
703 | struct splice_desc sd; | |
704 | ||
705 | ret = 0; | |
706 | do_wakeup = 0; | |
707 | ||
708 | sd.total_len = len; | |
709 | sd.flags = flags; | |
710 | sd.file = out; | |
cbb7e577 | 711 | sd.pos = *ppos; |
5274f052 | 712 | |
3a326a2c IM |
713 | if (pipe->inode) |
714 | mutex_lock(&pipe->inode->i_mutex); | |
5274f052 | 715 | |
5274f052 | 716 | for (;;) { |
6f767b04 JA |
717 | if (pipe->nrbufs) { |
718 | struct pipe_buffer *buf = pipe->bufs + pipe->curbuf; | |
5274f052 JA |
719 | struct pipe_buf_operations *ops = buf->ops; |
720 | ||
721 | sd.len = buf->len; | |
722 | if (sd.len > sd.total_len) | |
723 | sd.len = sd.total_len; | |
724 | ||
3a326a2c | 725 | err = actor(pipe, buf, &sd); |
016b661e | 726 | if (err <= 0) { |
5274f052 JA |
727 | if (!ret && err != -ENODATA) |
728 | ret = err; | |
729 | ||
730 | break; | |
731 | } | |
732 | ||
016b661e JA |
733 | ret += err; |
734 | buf->offset += err; | |
735 | buf->len -= err; | |
736 | ||
737 | sd.len -= err; | |
738 | sd.pos += err; | |
739 | sd.total_len -= err; | |
740 | if (sd.len) | |
741 | continue; | |
73d62d83 | 742 | |
5274f052 JA |
743 | if (!buf->len) { |
744 | buf->ops = NULL; | |
3a326a2c | 745 | ops->release(pipe, buf); |
6f767b04 JA |
746 | pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1); |
747 | pipe->nrbufs--; | |
748 | if (pipe->inode) | |
749 | do_wakeup = 1; | |
5274f052 JA |
750 | } |
751 | ||
5274f052 JA |
752 | if (!sd.total_len) |
753 | break; | |
754 | } | |
755 | ||
6f767b04 | 756 | if (pipe->nrbufs) |
5274f052 | 757 | continue; |
3a326a2c | 758 | if (!pipe->writers) |
5274f052 | 759 | break; |
3a326a2c | 760 | if (!pipe->waiting_writers) { |
5274f052 JA |
761 | if (ret) |
762 | break; | |
763 | } | |
764 | ||
29e35094 LT |
765 | if (flags & SPLICE_F_NONBLOCK) { |
766 | if (!ret) | |
767 | ret = -EAGAIN; | |
768 | break; | |
769 | } | |
770 | ||
5274f052 JA |
771 | if (signal_pending(current)) { |
772 | if (!ret) | |
773 | ret = -ERESTARTSYS; | |
774 | break; | |
775 | } | |
776 | ||
777 | if (do_wakeup) { | |
c0bd1f65 | 778 | smp_mb(); |
3a326a2c IM |
779 | if (waitqueue_active(&pipe->wait)) |
780 | wake_up_interruptible_sync(&pipe->wait); | |
781 | kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT); | |
5274f052 JA |
782 | do_wakeup = 0; |
783 | } | |
784 | ||
3a326a2c | 785 | pipe_wait(pipe); |
5274f052 JA |
786 | } |
787 | ||
3a326a2c IM |
788 | if (pipe->inode) |
789 | mutex_unlock(&pipe->inode->i_mutex); | |
5274f052 JA |
790 | |
791 | if (do_wakeup) { | |
c0bd1f65 | 792 | smp_mb(); |
3a326a2c IM |
793 | if (waitqueue_active(&pipe->wait)) |
794 | wake_up_interruptible(&pipe->wait); | |
795 | kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT); | |
5274f052 JA |
796 | } |
797 | ||
5274f052 | 798 | return ret; |
5274f052 JA |
799 | } |
800 | ||
83f9135b JA |
801 | /** |
802 | * generic_file_splice_write - splice data from a pipe to a file | |
3a326a2c | 803 | * @pipe: pipe info |
83f9135b JA |
804 | * @out: file to write to |
805 | * @len: number of bytes to splice | |
806 | * @flags: splice modifier flags | |
807 | * | |
808 | * Will either move or copy pages (determined by @flags options) from | |
809 | * the given pipe inode to the given file. | |
810 | * | |
811 | */ | |
3a326a2c IM |
812 | ssize_t |
813 | generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out, | |
cbb7e577 | 814 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 815 | { |
4f6f0bd2 | 816 | struct address_space *mapping = out->f_mapping; |
3a326a2c IM |
817 | ssize_t ret; |
818 | ||
00522fb4 | 819 | ret = splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_file); |
a4514ebd | 820 | if (ret > 0) { |
4f6f0bd2 | 821 | struct inode *inode = mapping->host; |
4f6f0bd2 | 822 | |
a4514ebd JA |
823 | *ppos += ret; |
824 | ||
825 | /* | |
826 | * If file or inode is SYNC and we actually wrote some data, | |
827 | * sync it. | |
828 | */ | |
829 | if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) { | |
830 | int err; | |
831 | ||
832 | mutex_lock(&inode->i_mutex); | |
833 | err = generic_osync_inode(inode, mapping, | |
834 | OSYNC_METADATA|OSYNC_DATA); | |
835 | mutex_unlock(&inode->i_mutex); | |
4f6f0bd2 | 836 | |
a4514ebd JA |
837 | if (err) |
838 | ret = err; | |
839 | } | |
4f6f0bd2 JA |
840 | } |
841 | ||
842 | return ret; | |
5274f052 JA |
843 | } |
844 | ||
059a8f37 JA |
845 | EXPORT_SYMBOL(generic_file_splice_write); |
846 | ||
83f9135b JA |
847 | /** |
848 | * generic_splice_sendpage - splice data from a pipe to a socket | |
849 | * @inode: pipe inode | |
850 | * @out: socket to write to | |
851 | * @len: number of bytes to splice | |
852 | * @flags: splice modifier flags | |
853 | * | |
854 | * Will send @len bytes from the pipe to a network socket. No data copying | |
855 | * is involved. | |
856 | * | |
857 | */ | |
3a326a2c | 858 | ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out, |
cbb7e577 | 859 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 860 | { |
00522fb4 | 861 | return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage); |
5274f052 JA |
862 | } |
863 | ||
059a8f37 | 864 | EXPORT_SYMBOL(generic_splice_sendpage); |
a0f06780 | 865 | |
83f9135b JA |
866 | /* |
867 | * Attempt to initiate a splice from pipe to file. | |
868 | */ | |
3a326a2c | 869 | static long do_splice_from(struct pipe_inode_info *pipe, struct file *out, |
cbb7e577 | 870 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 871 | { |
5274f052 JA |
872 | int ret; |
873 | ||
49570e9b | 874 | if (unlikely(!out->f_op || !out->f_op->splice_write)) |
5274f052 JA |
875 | return -EINVAL; |
876 | ||
49570e9b | 877 | if (unlikely(!(out->f_mode & FMODE_WRITE))) |
5274f052 JA |
878 | return -EBADF; |
879 | ||
cbb7e577 | 880 | ret = rw_verify_area(WRITE, out, ppos, len); |
5274f052 JA |
881 | if (unlikely(ret < 0)) |
882 | return ret; | |
883 | ||
cbb7e577 | 884 | return out->f_op->splice_write(pipe, out, ppos, len, flags); |
5274f052 JA |
885 | } |
886 | ||
83f9135b JA |
887 | /* |
888 | * Attempt to initiate a splice from a file to a pipe. | |
889 | */ | |
cbb7e577 JA |
890 | static long do_splice_to(struct file *in, loff_t *ppos, |
891 | struct pipe_inode_info *pipe, size_t len, | |
892 | unsigned int flags) | |
5274f052 | 893 | { |
cbb7e577 | 894 | loff_t isize, left; |
5274f052 JA |
895 | int ret; |
896 | ||
49570e9b | 897 | if (unlikely(!in->f_op || !in->f_op->splice_read)) |
5274f052 JA |
898 | return -EINVAL; |
899 | ||
49570e9b | 900 | if (unlikely(!(in->f_mode & FMODE_READ))) |
5274f052 JA |
901 | return -EBADF; |
902 | ||
cbb7e577 | 903 | ret = rw_verify_area(READ, in, ppos, len); |
5274f052 JA |
904 | if (unlikely(ret < 0)) |
905 | return ret; | |
906 | ||
907 | isize = i_size_read(in->f_mapping->host); | |
cbb7e577 | 908 | if (unlikely(*ppos >= isize)) |
5274f052 JA |
909 | return 0; |
910 | ||
cbb7e577 | 911 | left = isize - *ppos; |
49570e9b | 912 | if (unlikely(left < len)) |
5274f052 JA |
913 | len = left; |
914 | ||
cbb7e577 | 915 | return in->f_op->splice_read(in, ppos, pipe, len, flags); |
5274f052 JA |
916 | } |
917 | ||
cbb7e577 JA |
918 | long do_splice_direct(struct file *in, loff_t *ppos, struct file *out, |
919 | size_t len, unsigned int flags) | |
b92ce558 JA |
920 | { |
921 | struct pipe_inode_info *pipe; | |
922 | long ret, bytes; | |
cbb7e577 | 923 | loff_t out_off; |
b92ce558 JA |
924 | umode_t i_mode; |
925 | int i; | |
926 | ||
927 | /* | |
928 | * We require the input being a regular file, as we don't want to | |
929 | * randomly drop data for eg socket -> socket splicing. Use the | |
930 | * piped splicing for that! | |
931 | */ | |
932 | i_mode = in->f_dentry->d_inode->i_mode; | |
933 | if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode))) | |
934 | return -EINVAL; | |
935 | ||
936 | /* | |
937 | * neither in nor out is a pipe, setup an internal pipe attached to | |
938 | * 'out' and transfer the wanted data from 'in' to 'out' through that | |
939 | */ | |
940 | pipe = current->splice_pipe; | |
49570e9b | 941 | if (unlikely(!pipe)) { |
b92ce558 JA |
942 | pipe = alloc_pipe_info(NULL); |
943 | if (!pipe) | |
944 | return -ENOMEM; | |
945 | ||
946 | /* | |
947 | * We don't have an immediate reader, but we'll read the stuff | |
00522fb4 | 948 | * out of the pipe right after the splice_to_pipe(). So set |
b92ce558 JA |
949 | * PIPE_READERS appropriately. |
950 | */ | |
951 | pipe->readers = 1; | |
952 | ||
953 | current->splice_pipe = pipe; | |
954 | } | |
955 | ||
956 | /* | |
73d62d83 | 957 | * Do the splice. |
b92ce558 JA |
958 | */ |
959 | ret = 0; | |
960 | bytes = 0; | |
cbb7e577 | 961 | out_off = 0; |
b92ce558 JA |
962 | |
963 | while (len) { | |
964 | size_t read_len, max_read_len; | |
965 | ||
966 | /* | |
967 | * Do at most PIPE_BUFFERS pages worth of transfer: | |
968 | */ | |
969 | max_read_len = min(len, (size_t)(PIPE_BUFFERS*PAGE_SIZE)); | |
970 | ||
cbb7e577 | 971 | ret = do_splice_to(in, ppos, pipe, max_read_len, flags); |
b92ce558 JA |
972 | if (unlikely(ret < 0)) |
973 | goto out_release; | |
974 | ||
975 | read_len = ret; | |
976 | ||
977 | /* | |
978 | * NOTE: nonblocking mode only applies to the input. We | |
979 | * must not do the output in nonblocking mode as then we | |
980 | * could get stuck data in the internal pipe: | |
981 | */ | |
cbb7e577 | 982 | ret = do_splice_from(pipe, out, &out_off, read_len, |
b92ce558 JA |
983 | flags & ~SPLICE_F_NONBLOCK); |
984 | if (unlikely(ret < 0)) | |
985 | goto out_release; | |
986 | ||
987 | bytes += ret; | |
988 | len -= ret; | |
989 | ||
990 | /* | |
991 | * In nonblocking mode, if we got back a short read then | |
992 | * that was due to either an IO error or due to the | |
993 | * pagecache entry not being there. In the IO error case | |
994 | * the _next_ splice attempt will produce a clean IO error | |
995 | * return value (not a short read), so in both cases it's | |
996 | * correct to break out of the loop here: | |
997 | */ | |
998 | if ((flags & SPLICE_F_NONBLOCK) && (read_len < max_read_len)) | |
999 | break; | |
1000 | } | |
1001 | ||
1002 | pipe->nrbufs = pipe->curbuf = 0; | |
1003 | ||
1004 | return bytes; | |
1005 | ||
1006 | out_release: | |
1007 | /* | |
1008 | * If we did an incomplete transfer we must release | |
1009 | * the pipe buffers in question: | |
1010 | */ | |
1011 | for (i = 0; i < PIPE_BUFFERS; i++) { | |
1012 | struct pipe_buffer *buf = pipe->bufs + i; | |
1013 | ||
1014 | if (buf->ops) { | |
1015 | buf->ops->release(pipe, buf); | |
1016 | buf->ops = NULL; | |
1017 | } | |
1018 | } | |
1019 | pipe->nrbufs = pipe->curbuf = 0; | |
1020 | ||
1021 | /* | |
1022 | * If we transferred some data, return the number of bytes: | |
1023 | */ | |
1024 | if (bytes > 0) | |
1025 | return bytes; | |
1026 | ||
1027 | return ret; | |
1028 | } | |
1029 | ||
1030 | EXPORT_SYMBOL(do_splice_direct); | |
1031 | ||
83f9135b JA |
1032 | /* |
1033 | * Determine where to splice to/from. | |
1034 | */ | |
529565dc IM |
1035 | static long do_splice(struct file *in, loff_t __user *off_in, |
1036 | struct file *out, loff_t __user *off_out, | |
1037 | size_t len, unsigned int flags) | |
5274f052 | 1038 | { |
3a326a2c | 1039 | struct pipe_inode_info *pipe; |
cbb7e577 | 1040 | loff_t offset, *off; |
a4514ebd | 1041 | long ret; |
5274f052 | 1042 | |
3a326a2c | 1043 | pipe = in->f_dentry->d_inode->i_pipe; |
529565dc IM |
1044 | if (pipe) { |
1045 | if (off_in) | |
1046 | return -ESPIPE; | |
b92ce558 JA |
1047 | if (off_out) { |
1048 | if (out->f_op->llseek == no_llseek) | |
1049 | return -EINVAL; | |
cbb7e577 | 1050 | if (copy_from_user(&offset, off_out, sizeof(loff_t))) |
b92ce558 | 1051 | return -EFAULT; |
cbb7e577 JA |
1052 | off = &offset; |
1053 | } else | |
1054 | off = &out->f_pos; | |
529565dc | 1055 | |
a4514ebd JA |
1056 | ret = do_splice_from(pipe, out, off, len, flags); |
1057 | ||
1058 | if (off_out && copy_to_user(off_out, off, sizeof(loff_t))) | |
1059 | ret = -EFAULT; | |
1060 | ||
1061 | return ret; | |
529565dc | 1062 | } |
5274f052 | 1063 | |
3a326a2c | 1064 | pipe = out->f_dentry->d_inode->i_pipe; |
529565dc IM |
1065 | if (pipe) { |
1066 | if (off_out) | |
1067 | return -ESPIPE; | |
b92ce558 JA |
1068 | if (off_in) { |
1069 | if (in->f_op->llseek == no_llseek) | |
1070 | return -EINVAL; | |
cbb7e577 | 1071 | if (copy_from_user(&offset, off_in, sizeof(loff_t))) |
b92ce558 | 1072 | return -EFAULT; |
cbb7e577 JA |
1073 | off = &offset; |
1074 | } else | |
1075 | off = &in->f_pos; | |
529565dc | 1076 | |
a4514ebd JA |
1077 | ret = do_splice_to(in, off, pipe, len, flags); |
1078 | ||
1079 | if (off_in && copy_to_user(off_in, off, sizeof(loff_t))) | |
1080 | ret = -EFAULT; | |
1081 | ||
1082 | return ret; | |
529565dc | 1083 | } |
5274f052 JA |
1084 | |
1085 | return -EINVAL; | |
1086 | } | |
1087 | ||
912d35f8 JA |
1088 | /* |
1089 | * Map an iov into an array of pages and offset/length tupples. With the | |
1090 | * partial_page structure, we can map several non-contiguous ranges into | |
1091 | * our ones pages[] map instead of splitting that operation into pieces. | |
1092 | * Could easily be exported as a generic helper for other users, in which | |
1093 | * case one would probably want to add a 'max_nr_pages' parameter as well. | |
1094 | */ | |
1095 | static int get_iovec_page_array(const struct iovec __user *iov, | |
1096 | unsigned int nr_vecs, struct page **pages, | |
7afa6fd0 | 1097 | struct partial_page *partial, int aligned) |
912d35f8 JA |
1098 | { |
1099 | int buffers = 0, error = 0; | |
1100 | ||
1101 | /* | |
1102 | * It's ok to take the mmap_sem for reading, even | |
1103 | * across a "get_user()". | |
1104 | */ | |
1105 | down_read(¤t->mm->mmap_sem); | |
1106 | ||
1107 | while (nr_vecs) { | |
1108 | unsigned long off, npages; | |
1109 | void __user *base; | |
1110 | size_t len; | |
1111 | int i; | |
1112 | ||
1113 | /* | |
1114 | * Get user address base and length for this iovec. | |
1115 | */ | |
1116 | error = get_user(base, &iov->iov_base); | |
1117 | if (unlikely(error)) | |
1118 | break; | |
1119 | error = get_user(len, &iov->iov_len); | |
1120 | if (unlikely(error)) | |
1121 | break; | |
1122 | ||
1123 | /* | |
1124 | * Sanity check this iovec. 0 read succeeds. | |
1125 | */ | |
1126 | if (unlikely(!len)) | |
1127 | break; | |
1128 | error = -EFAULT; | |
1129 | if (unlikely(!base)) | |
1130 | break; | |
1131 | ||
1132 | /* | |
1133 | * Get this base offset and number of pages, then map | |
1134 | * in the user pages. | |
1135 | */ | |
1136 | off = (unsigned long) base & ~PAGE_MASK; | |
7afa6fd0 JA |
1137 | |
1138 | /* | |
1139 | * If asked for alignment, the offset must be zero and the | |
1140 | * length a multiple of the PAGE_SIZE. | |
1141 | */ | |
1142 | error = -EINVAL; | |
1143 | if (aligned && (off || len & ~PAGE_MASK)) | |
1144 | break; | |
1145 | ||
912d35f8 JA |
1146 | npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT; |
1147 | if (npages > PIPE_BUFFERS - buffers) | |
1148 | npages = PIPE_BUFFERS - buffers; | |
1149 | ||
1150 | error = get_user_pages(current, current->mm, | |
1151 | (unsigned long) base, npages, 0, 0, | |
1152 | &pages[buffers], NULL); | |
1153 | ||
1154 | if (unlikely(error <= 0)) | |
1155 | break; | |
1156 | ||
1157 | /* | |
1158 | * Fill this contiguous range into the partial page map. | |
1159 | */ | |
1160 | for (i = 0; i < error; i++) { | |
7591489a | 1161 | const int plen = min_t(size_t, len, PAGE_SIZE - off); |
912d35f8 JA |
1162 | |
1163 | partial[buffers].offset = off; | |
1164 | partial[buffers].len = plen; | |
1165 | ||
1166 | off = 0; | |
1167 | len -= plen; | |
1168 | buffers++; | |
1169 | } | |
1170 | ||
1171 | /* | |
1172 | * We didn't complete this iov, stop here since it probably | |
1173 | * means we have to move some of this into a pipe to | |
1174 | * be able to continue. | |
1175 | */ | |
1176 | if (len) | |
1177 | break; | |
1178 | ||
1179 | /* | |
1180 | * Don't continue if we mapped fewer pages than we asked for, | |
1181 | * or if we mapped the max number of pages that we have | |
1182 | * room for. | |
1183 | */ | |
1184 | if (error < npages || buffers == PIPE_BUFFERS) | |
1185 | break; | |
1186 | ||
1187 | nr_vecs--; | |
1188 | iov++; | |
1189 | } | |
1190 | ||
1191 | up_read(¤t->mm->mmap_sem); | |
1192 | ||
1193 | if (buffers) | |
1194 | return buffers; | |
1195 | ||
1196 | return error; | |
1197 | } | |
1198 | ||
1199 | /* | |
1200 | * vmsplice splices a user address range into a pipe. It can be thought of | |
1201 | * as splice-from-memory, where the regular splice is splice-from-file (or | |
1202 | * to file). In both cases the output is a pipe, naturally. | |
1203 | * | |
1204 | * Note that vmsplice only supports splicing _from_ user memory to a pipe, | |
1205 | * not the other way around. Splicing from user memory is a simple operation | |
1206 | * that can be supported without any funky alignment restrictions or nasty | |
1207 | * vm tricks. We simply map in the user memory and fill them into a pipe. | |
1208 | * The reverse isn't quite as easy, though. There are two possible solutions | |
1209 | * for that: | |
1210 | * | |
1211 | * - memcpy() the data internally, at which point we might as well just | |
1212 | * do a regular read() on the buffer anyway. | |
1213 | * - Lots of nasty vm tricks, that are neither fast nor flexible (it | |
1214 | * has restriction limitations on both ends of the pipe). | |
1215 | * | |
1216 | * Alas, it isn't here. | |
1217 | * | |
1218 | */ | |
1219 | static long do_vmsplice(struct file *file, const struct iovec __user *iov, | |
1220 | unsigned long nr_segs, unsigned int flags) | |
1221 | { | |
1222 | struct pipe_inode_info *pipe = file->f_dentry->d_inode->i_pipe; | |
1223 | struct page *pages[PIPE_BUFFERS]; | |
1224 | struct partial_page partial[PIPE_BUFFERS]; | |
1225 | struct splice_pipe_desc spd = { | |
1226 | .pages = pages, | |
1227 | .partial = partial, | |
1228 | .flags = flags, | |
1229 | .ops = &user_page_pipe_buf_ops, | |
1230 | }; | |
1231 | ||
1232 | if (unlikely(!pipe)) | |
1233 | return -EBADF; | |
1234 | if (unlikely(nr_segs > UIO_MAXIOV)) | |
1235 | return -EINVAL; | |
1236 | else if (unlikely(!nr_segs)) | |
1237 | return 0; | |
1238 | ||
7afa6fd0 JA |
1239 | spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial, |
1240 | flags & SPLICE_F_GIFT); | |
912d35f8 JA |
1241 | if (spd.nr_pages <= 0) |
1242 | return spd.nr_pages; | |
1243 | ||
00522fb4 | 1244 | return splice_to_pipe(pipe, &spd); |
912d35f8 JA |
1245 | } |
1246 | ||
1247 | asmlinkage long sys_vmsplice(int fd, const struct iovec __user *iov, | |
1248 | unsigned long nr_segs, unsigned int flags) | |
1249 | { | |
1250 | struct file *file; | |
1251 | long error; | |
1252 | int fput; | |
1253 | ||
1254 | error = -EBADF; | |
1255 | file = fget_light(fd, &fput); | |
1256 | if (file) { | |
1257 | if (file->f_mode & FMODE_WRITE) | |
1258 | error = do_vmsplice(file, iov, nr_segs, flags); | |
1259 | ||
1260 | fput_light(file, fput); | |
1261 | } | |
1262 | ||
1263 | return error; | |
1264 | } | |
1265 | ||
529565dc IM |
1266 | asmlinkage long sys_splice(int fd_in, loff_t __user *off_in, |
1267 | int fd_out, loff_t __user *off_out, | |
1268 | size_t len, unsigned int flags) | |
5274f052 JA |
1269 | { |
1270 | long error; | |
1271 | struct file *in, *out; | |
1272 | int fput_in, fput_out; | |
1273 | ||
1274 | if (unlikely(!len)) | |
1275 | return 0; | |
1276 | ||
1277 | error = -EBADF; | |
529565dc | 1278 | in = fget_light(fd_in, &fput_in); |
5274f052 JA |
1279 | if (in) { |
1280 | if (in->f_mode & FMODE_READ) { | |
529565dc | 1281 | out = fget_light(fd_out, &fput_out); |
5274f052 JA |
1282 | if (out) { |
1283 | if (out->f_mode & FMODE_WRITE) | |
529565dc IM |
1284 | error = do_splice(in, off_in, |
1285 | out, off_out, | |
1286 | len, flags); | |
5274f052 JA |
1287 | fput_light(out, fput_out); |
1288 | } | |
1289 | } | |
1290 | ||
1291 | fput_light(in, fput_in); | |
1292 | } | |
1293 | ||
1294 | return error; | |
1295 | } | |
70524490 JA |
1296 | |
1297 | /* | |
1298 | * Link contents of ipipe to opipe. | |
1299 | */ | |
1300 | static int link_pipe(struct pipe_inode_info *ipipe, | |
1301 | struct pipe_inode_info *opipe, | |
1302 | size_t len, unsigned int flags) | |
1303 | { | |
1304 | struct pipe_buffer *ibuf, *obuf; | |
2a27250e JA |
1305 | int ret, do_wakeup, i, ipipe_first; |
1306 | ||
1307 | ret = do_wakeup = ipipe_first = 0; | |
70524490 JA |
1308 | |
1309 | /* | |
1310 | * Potential ABBA deadlock, work around it by ordering lock | |
1311 | * grabbing by inode address. Otherwise two different processes | |
1312 | * could deadlock (one doing tee from A -> B, the other from B -> A). | |
1313 | */ | |
1314 | if (ipipe->inode < opipe->inode) { | |
2a27250e | 1315 | ipipe_first = 1; |
70524490 JA |
1316 | mutex_lock(&ipipe->inode->i_mutex); |
1317 | mutex_lock(&opipe->inode->i_mutex); | |
1318 | } else { | |
1319 | mutex_lock(&opipe->inode->i_mutex); | |
1320 | mutex_lock(&ipipe->inode->i_mutex); | |
1321 | } | |
1322 | ||
1323 | for (i = 0;; i++) { | |
1324 | if (!opipe->readers) { | |
1325 | send_sig(SIGPIPE, current, 0); | |
1326 | if (!ret) | |
1327 | ret = -EPIPE; | |
1328 | break; | |
1329 | } | |
1330 | if (ipipe->nrbufs - i) { | |
1331 | ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1)); | |
1332 | ||
1333 | /* | |
1334 | * If we have room, fill this buffer | |
1335 | */ | |
1336 | if (opipe->nrbufs < PIPE_BUFFERS) { | |
1337 | int nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1); | |
1338 | ||
1339 | /* | |
1340 | * Get a reference to this pipe buffer, | |
1341 | * so we can copy the contents over. | |
1342 | */ | |
1343 | ibuf->ops->get(ipipe, ibuf); | |
1344 | ||
1345 | obuf = opipe->bufs + nbuf; | |
1346 | *obuf = *ibuf; | |
1347 | ||
7afa6fd0 JA |
1348 | /* |
1349 | * Don't inherit the gift flag, we need to | |
1350 | * prevent multiple steals of this page. | |
1351 | */ | |
1352 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; | |
1353 | ||
70524490 JA |
1354 | if (obuf->len > len) |
1355 | obuf->len = len; | |
1356 | ||
1357 | opipe->nrbufs++; | |
1358 | do_wakeup = 1; | |
1359 | ret += obuf->len; | |
1360 | len -= obuf->len; | |
1361 | ||
1362 | if (!len) | |
1363 | break; | |
1364 | if (opipe->nrbufs < PIPE_BUFFERS) | |
1365 | continue; | |
1366 | } | |
1367 | ||
1368 | /* | |
1369 | * We have input available, but no output room. | |
2a27250e JA |
1370 | * If we already copied data, return that. If we |
1371 | * need to drop the opipe lock, it must be ordered | |
1372 | * last to avoid deadlocks. | |
70524490 | 1373 | */ |
2a27250e | 1374 | if ((flags & SPLICE_F_NONBLOCK) || !ipipe_first) { |
70524490 JA |
1375 | if (!ret) |
1376 | ret = -EAGAIN; | |
1377 | break; | |
1378 | } | |
1379 | if (signal_pending(current)) { | |
1380 | if (!ret) | |
1381 | ret = -ERESTARTSYS; | |
1382 | break; | |
1383 | } | |
1384 | if (do_wakeup) { | |
1385 | smp_mb(); | |
1386 | if (waitqueue_active(&opipe->wait)) | |
1387 | wake_up_interruptible(&opipe->wait); | |
1388 | kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN); | |
1389 | do_wakeup = 0; | |
1390 | } | |
1391 | ||
1392 | opipe->waiting_writers++; | |
1393 | pipe_wait(opipe); | |
1394 | opipe->waiting_writers--; | |
1395 | continue; | |
1396 | } | |
1397 | ||
1398 | /* | |
1399 | * No input buffers, do the usual checks for available | |
1400 | * writers and blocking and wait if necessary | |
1401 | */ | |
1402 | if (!ipipe->writers) | |
1403 | break; | |
1404 | if (!ipipe->waiting_writers) { | |
1405 | if (ret) | |
1406 | break; | |
1407 | } | |
2a27250e JA |
1408 | /* |
1409 | * pipe_wait() drops the ipipe mutex. To avoid deadlocks | |
1410 | * with another process, we can only safely do that if | |
1411 | * the ipipe lock is ordered last. | |
1412 | */ | |
1413 | if ((flags & SPLICE_F_NONBLOCK) || ipipe_first) { | |
70524490 JA |
1414 | if (!ret) |
1415 | ret = -EAGAIN; | |
1416 | break; | |
1417 | } | |
1418 | if (signal_pending(current)) { | |
1419 | if (!ret) | |
1420 | ret = -ERESTARTSYS; | |
1421 | break; | |
1422 | } | |
1423 | ||
1424 | if (waitqueue_active(&ipipe->wait)) | |
1425 | wake_up_interruptible_sync(&ipipe->wait); | |
1426 | kill_fasync(&ipipe->fasync_writers, SIGIO, POLL_OUT); | |
1427 | ||
1428 | pipe_wait(ipipe); | |
1429 | } | |
1430 | ||
1431 | mutex_unlock(&ipipe->inode->i_mutex); | |
1432 | mutex_unlock(&opipe->inode->i_mutex); | |
1433 | ||
1434 | if (do_wakeup) { | |
1435 | smp_mb(); | |
1436 | if (waitqueue_active(&opipe->wait)) | |
1437 | wake_up_interruptible(&opipe->wait); | |
1438 | kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN); | |
1439 | } | |
1440 | ||
1441 | return ret; | |
1442 | } | |
1443 | ||
1444 | /* | |
1445 | * This is a tee(1) implementation that works on pipes. It doesn't copy | |
1446 | * any data, it simply references the 'in' pages on the 'out' pipe. | |
1447 | * The 'flags' used are the SPLICE_F_* variants, currently the only | |
1448 | * applicable one is SPLICE_F_NONBLOCK. | |
1449 | */ | |
1450 | static long do_tee(struct file *in, struct file *out, size_t len, | |
1451 | unsigned int flags) | |
1452 | { | |
1453 | struct pipe_inode_info *ipipe = in->f_dentry->d_inode->i_pipe; | |
1454 | struct pipe_inode_info *opipe = out->f_dentry->d_inode->i_pipe; | |
1455 | ||
1456 | /* | |
1457 | * Link ipipe to the two output pipes, consuming as we go along. | |
1458 | */ | |
1459 | if (ipipe && opipe) | |
1460 | return link_pipe(ipipe, opipe, len, flags); | |
1461 | ||
1462 | return -EINVAL; | |
1463 | } | |
1464 | ||
1465 | asmlinkage long sys_tee(int fdin, int fdout, size_t len, unsigned int flags) | |
1466 | { | |
1467 | struct file *in; | |
1468 | int error, fput_in; | |
1469 | ||
1470 | if (unlikely(!len)) | |
1471 | return 0; | |
1472 | ||
1473 | error = -EBADF; | |
1474 | in = fget_light(fdin, &fput_in); | |
1475 | if (in) { | |
1476 | if (in->f_mode & FMODE_READ) { | |
1477 | int fput_out; | |
1478 | struct file *out = fget_light(fdout, &fput_out); | |
1479 | ||
1480 | if (out) { | |
1481 | if (out->f_mode & FMODE_WRITE) | |
1482 | error = do_tee(in, out, len, flags); | |
1483 | fput_light(out, fput_out); | |
1484 | } | |
1485 | } | |
1486 | fput_light(in, fput_in); | |
1487 | } | |
1488 | ||
1489 | return error; | |
1490 | } |