splice: implement pipe to pipe splicing
[linux-block.git] / fs / pipe.c
CommitLineData
1da177e4
LT
1/*
2 * linux/fs/pipe.c
3 *
4 * Copyright (C) 1991, 1992, 1999 Linus Torvalds
5 */
6
7#include <linux/mm.h>
8#include <linux/file.h>
9#include <linux/poll.h>
10#include <linux/slab.h>
11#include <linux/module.h>
12#include <linux/init.h>
13#include <linux/fs.h>
14#include <linux/mount.h>
15#include <linux/pipe_fs_i.h>
16#include <linux/uio.h>
17#include <linux/highmem.h>
5274f052 18#include <linux/pagemap.h>
db349509 19#include <linux/audit.h>
ba719bae 20#include <linux/syscalls.h>
1da177e4
LT
21
22#include <asm/uaccess.h>
23#include <asm/ioctls.h>
24
25/*
26 * We use a start+len construction, which provides full use of the
27 * allocated memory.
28 * -- Florian Coosmann (FGC)
29 *
30 * Reads with count = 0 should always return 0.
31 * -- Julian Bradfield 1999-06-07.
32 *
33 * FIFOs and Pipes now generate SIGIO for both readers and writers.
34 * -- Jeremy Elson <jelson@circlemud.org> 2001-08-16
35 *
36 * pipe_read & write cleanup
37 * -- Manfred Spraul <manfred@colorfullife.com> 2002-05-09
38 */
39
61e0d47c
MS
40static void pipe_lock_nested(struct pipe_inode_info *pipe, int subclass)
41{
42 if (pipe->inode)
43 mutex_lock_nested(&pipe->inode->i_mutex, subclass);
44}
45
46void pipe_lock(struct pipe_inode_info *pipe)
47{
48 /*
49 * pipe_lock() nests non-pipe inode locks (for writing to a file)
50 */
51 pipe_lock_nested(pipe, I_MUTEX_PARENT);
52}
53EXPORT_SYMBOL(pipe_lock);
54
55void pipe_unlock(struct pipe_inode_info *pipe)
56{
57 if (pipe->inode)
58 mutex_unlock(&pipe->inode->i_mutex);
59}
60EXPORT_SYMBOL(pipe_unlock);
61
62void pipe_double_lock(struct pipe_inode_info *pipe1,
63 struct pipe_inode_info *pipe2)
64{
65 BUG_ON(pipe1 == pipe2);
66
67 if (pipe1 < pipe2) {
68 pipe_lock_nested(pipe1, I_MUTEX_PARENT);
69 pipe_lock_nested(pipe2, I_MUTEX_CHILD);
70 } else {
71 pipe_lock_nested(pipe2, I_MUTEX_CHILD);
72 pipe_lock_nested(pipe1, I_MUTEX_PARENT);
73 }
74}
75
1da177e4 76/* Drop the inode semaphore and wait for a pipe event, atomically */
3a326a2c 77void pipe_wait(struct pipe_inode_info *pipe)
1da177e4
LT
78{
79 DEFINE_WAIT(wait);
80
d79fc0fc
IM
81 /*
82 * Pipes are system-local resources, so sleeping on them
83 * is considered a noninteractive wait:
84 */
af927232 85 prepare_to_wait(&pipe->wait, &wait, TASK_INTERRUPTIBLE);
61e0d47c 86 pipe_unlock(pipe);
1da177e4 87 schedule();
3a326a2c 88 finish_wait(&pipe->wait, &wait);
61e0d47c 89 pipe_lock(pipe);
1da177e4
LT
90}
91
858119e1 92static int
f6762b7a
JA
93pipe_iov_copy_from_user(void *to, struct iovec *iov, unsigned long len,
94 int atomic)
1da177e4
LT
95{
96 unsigned long copy;
97
98 while (len > 0) {
99 while (!iov->iov_len)
100 iov++;
101 copy = min_t(unsigned long, len, iov->iov_len);
102
f6762b7a
JA
103 if (atomic) {
104 if (__copy_from_user_inatomic(to, iov->iov_base, copy))
105 return -EFAULT;
106 } else {
107 if (copy_from_user(to, iov->iov_base, copy))
108 return -EFAULT;
109 }
1da177e4
LT
110 to += copy;
111 len -= copy;
112 iov->iov_base += copy;
113 iov->iov_len -= copy;
114 }
115 return 0;
116}
117
858119e1 118static int
f6762b7a
JA
119pipe_iov_copy_to_user(struct iovec *iov, const void *from, unsigned long len,
120 int atomic)
1da177e4
LT
121{
122 unsigned long copy;
123
124 while (len > 0) {
125 while (!iov->iov_len)
126 iov++;
127 copy = min_t(unsigned long, len, iov->iov_len);
128
f6762b7a
JA
129 if (atomic) {
130 if (__copy_to_user_inatomic(iov->iov_base, from, copy))
131 return -EFAULT;
132 } else {
133 if (copy_to_user(iov->iov_base, from, copy))
134 return -EFAULT;
135 }
1da177e4
LT
136 from += copy;
137 len -= copy;
138 iov->iov_base += copy;
139 iov->iov_len -= copy;
140 }
141 return 0;
142}
143
f6762b7a
JA
144/*
145 * Attempt to pre-fault in the user memory, so we can use atomic copies.
146 * Returns the number of bytes not faulted in.
147 */
148static int iov_fault_in_pages_write(struct iovec *iov, unsigned long len)
149{
150 while (!iov->iov_len)
151 iov++;
152
153 while (len > 0) {
154 unsigned long this_len;
155
156 this_len = min_t(unsigned long, len, iov->iov_len);
157 if (fault_in_pages_writeable(iov->iov_base, this_len))
158 break;
159
160 len -= this_len;
161 iov++;
162 }
163
164 return len;
165}
166
167/*
168 * Pre-fault in the user memory, so we can use atomic copies.
169 */
170static void iov_fault_in_pages_read(struct iovec *iov, unsigned long len)
171{
172 while (!iov->iov_len)
173 iov++;
174
175 while (len > 0) {
176 unsigned long this_len;
177
178 this_len = min_t(unsigned long, len, iov->iov_len);
179 fault_in_pages_readable(iov->iov_base, this_len);
180 len -= this_len;
181 iov++;
182 }
183}
184
341b446b
IM
185static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
186 struct pipe_buffer *buf)
1da177e4
LT
187{
188 struct page *page = buf->page;
189
5274f052
JA
190 /*
191 * If nobody else uses this page, and we don't already have a
192 * temporary page, let's keep track of it as a one-deep
341b446b 193 * allocation cache. (Otherwise just release our reference to it)
5274f052 194 */
341b446b 195 if (page_count(page) == 1 && !pipe->tmp_page)
923f4f23 196 pipe->tmp_page = page;
341b446b
IM
197 else
198 page_cache_release(page);
1da177e4
LT
199}
200
0845718d
JA
201/**
202 * generic_pipe_buf_map - virtually map a pipe buffer
203 * @pipe: the pipe that the buffer belongs to
204 * @buf: the buffer that should be mapped
205 * @atomic: whether to use an atomic map
206 *
207 * Description:
208 * This function returns a kernel virtual address mapping for the
b51d63c6 209 * pipe_buffer passed in @buf. If @atomic is set, an atomic map is provided
0845718d
JA
210 * and the caller has to be careful not to fault before calling
211 * the unmap function.
212 *
213 * Note that this function occupies KM_USER0 if @atomic != 0.
214 */
f84d7519 215void *generic_pipe_buf_map(struct pipe_inode_info *pipe,
f6762b7a 216 struct pipe_buffer *buf, int atomic)
1da177e4 217{
f6762b7a
JA
218 if (atomic) {
219 buf->flags |= PIPE_BUF_FLAG_ATOMIC;
220 return kmap_atomic(buf->page, KM_USER0);
221 }
222
1da177e4
LT
223 return kmap(buf->page);
224}
225
0845718d
JA
226/**
227 * generic_pipe_buf_unmap - unmap a previously mapped pipe buffer
228 * @pipe: the pipe that the buffer belongs to
229 * @buf: the buffer that should be unmapped
230 * @map_data: the data that the mapping function returned
231 *
232 * Description:
233 * This function undoes the mapping that ->map() provided.
234 */
f84d7519 235void generic_pipe_buf_unmap(struct pipe_inode_info *pipe,
f6762b7a 236 struct pipe_buffer *buf, void *map_data)
1da177e4 237{
f6762b7a
JA
238 if (buf->flags & PIPE_BUF_FLAG_ATOMIC) {
239 buf->flags &= ~PIPE_BUF_FLAG_ATOMIC;
240 kunmap_atomic(map_data, KM_USER0);
241 } else
242 kunmap(buf->page);
1da177e4
LT
243}
244
0845718d 245/**
b51d63c6 246 * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
0845718d
JA
247 * @pipe: the pipe that the buffer belongs to
248 * @buf: the buffer to attempt to steal
249 *
250 * Description:
b51d63c6 251 * This function attempts to steal the &struct page attached to
0845718d
JA
252 * @buf. If successful, this function returns 0 and returns with
253 * the page locked. The caller may then reuse the page for whatever
b51d63c6 254 * he wishes; the typical use is insertion into a different file
0845718d
JA
255 * page cache.
256 */
330ab716
JA
257int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
258 struct pipe_buffer *buf)
5abc97aa 259{
46e678c9
JA
260 struct page *page = buf->page;
261
0845718d
JA
262 /*
263 * A reference of one is golden, that means that the owner of this
264 * page is the only one holding a reference to it. lock the page
265 * and return OK.
266 */
46e678c9 267 if (page_count(page) == 1) {
46e678c9
JA
268 lock_page(page);
269 return 0;
270 }
271
272 return 1;
5abc97aa
JA
273}
274
0845718d 275/**
b51d63c6 276 * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
0845718d
JA
277 * @pipe: the pipe that the buffer belongs to
278 * @buf: the buffer to get a reference to
279 *
280 * Description:
281 * This function grabs an extra reference to @buf. It's used in
282 * in the tee() system call, when we duplicate the buffers in one
283 * pipe into another.
284 */
285void generic_pipe_buf_get(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
70524490
JA
286{
287 page_cache_get(buf->page);
288}
289
0845718d
JA
290/**
291 * generic_pipe_buf_confirm - verify contents of the pipe buffer
79685b8d 292 * @info: the pipe that the buffer belongs to
0845718d
JA
293 * @buf: the buffer to confirm
294 *
295 * Description:
296 * This function does nothing, because the generic pipe code uses
297 * pages that are always good when inserted into the pipe.
298 */
cac36bb0
JA
299int generic_pipe_buf_confirm(struct pipe_inode_info *info,
300 struct pipe_buffer *buf)
f84d7519
JA
301{
302 return 0;
303}
304
d4c3cca9 305static const struct pipe_buf_operations anon_pipe_buf_ops = {
1da177e4 306 .can_merge = 1,
f84d7519
JA
307 .map = generic_pipe_buf_map,
308 .unmap = generic_pipe_buf_unmap,
cac36bb0 309 .confirm = generic_pipe_buf_confirm,
1da177e4 310 .release = anon_pipe_buf_release,
330ab716 311 .steal = generic_pipe_buf_steal,
f84d7519 312 .get = generic_pipe_buf_get,
1da177e4
LT
313};
314
315static ssize_t
ee0b3e67
BP
316pipe_read(struct kiocb *iocb, const struct iovec *_iov,
317 unsigned long nr_segs, loff_t pos)
1da177e4 318{
ee0b3e67 319 struct file *filp = iocb->ki_filp;
0f7fc9e4 320 struct inode *inode = filp->f_path.dentry->d_inode;
923f4f23 321 struct pipe_inode_info *pipe;
1da177e4
LT
322 int do_wakeup;
323 ssize_t ret;
324 struct iovec *iov = (struct iovec *)_iov;
325 size_t total_len;
326
327 total_len = iov_length(iov, nr_segs);
328 /* Null read succeeds. */
329 if (unlikely(total_len == 0))
330 return 0;
331
332 do_wakeup = 0;
333 ret = 0;
9aeedfc4 334 mutex_lock(&inode->i_mutex);
923f4f23 335 pipe = inode->i_pipe;
1da177e4 336 for (;;) {
923f4f23 337 int bufs = pipe->nrbufs;
1da177e4 338 if (bufs) {
923f4f23
IM
339 int curbuf = pipe->curbuf;
340 struct pipe_buffer *buf = pipe->bufs + curbuf;
d4c3cca9 341 const struct pipe_buf_operations *ops = buf->ops;
1da177e4
LT
342 void *addr;
343 size_t chars = buf->len;
f6762b7a 344 int error, atomic;
1da177e4
LT
345
346 if (chars > total_len)
347 chars = total_len;
348
cac36bb0 349 error = ops->confirm(pipe, buf);
f84d7519 350 if (error) {
5274f052 351 if (!ret)
f84d7519 352 error = ret;
5274f052
JA
353 break;
354 }
f84d7519 355
f6762b7a
JA
356 atomic = !iov_fault_in_pages_write(iov, chars);
357redo:
358 addr = ops->map(pipe, buf, atomic);
359 error = pipe_iov_copy_to_user(iov, addr + buf->offset, chars, atomic);
360 ops->unmap(pipe, buf, addr);
1da177e4 361 if (unlikely(error)) {
f6762b7a
JA
362 /*
363 * Just retry with the slow path if we failed.
364 */
365 if (atomic) {
366 atomic = 0;
367 goto redo;
368 }
341b446b 369 if (!ret)
f6762b7a 370 ret = error;
1da177e4
LT
371 break;
372 }
373 ret += chars;
374 buf->offset += chars;
375 buf->len -= chars;
376 if (!buf->len) {
377 buf->ops = NULL;
923f4f23 378 ops->release(pipe, buf);
1da177e4 379 curbuf = (curbuf + 1) & (PIPE_BUFFERS-1);
923f4f23
IM
380 pipe->curbuf = curbuf;
381 pipe->nrbufs = --bufs;
1da177e4
LT
382 do_wakeup = 1;
383 }
384 total_len -= chars;
385 if (!total_len)
386 break; /* common path: read succeeded */
387 }
388 if (bufs) /* More to do? */
389 continue;
923f4f23 390 if (!pipe->writers)
1da177e4 391 break;
923f4f23 392 if (!pipe->waiting_writers) {
1da177e4
LT
393 /* syscall merging: Usually we must not sleep
394 * if O_NONBLOCK is set, or if we got some data.
395 * But if a writer sleeps in kernel space, then
396 * we can wait for that data without violating POSIX.
397 */
398 if (ret)
399 break;
400 if (filp->f_flags & O_NONBLOCK) {
401 ret = -EAGAIN;
402 break;
403 }
404 }
405 if (signal_pending(current)) {
341b446b
IM
406 if (!ret)
407 ret = -ERESTARTSYS;
1da177e4
LT
408 break;
409 }
410 if (do_wakeup) {
923f4f23
IM
411 wake_up_interruptible_sync(&pipe->wait);
412 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4 413 }
923f4f23 414 pipe_wait(pipe);
1da177e4 415 }
9aeedfc4 416 mutex_unlock(&inode->i_mutex);
341b446b
IM
417
418 /* Signal writers asynchronously that there is more room. */
1da177e4 419 if (do_wakeup) {
71e20f18 420 wake_up_interruptible_sync(&pipe->wait);
923f4f23 421 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4
LT
422 }
423 if (ret > 0)
424 file_accessed(filp);
425 return ret;
426}
427
428static ssize_t
ee0b3e67
BP
429pipe_write(struct kiocb *iocb, const struct iovec *_iov,
430 unsigned long nr_segs, loff_t ppos)
1da177e4 431{
ee0b3e67 432 struct file *filp = iocb->ki_filp;
0f7fc9e4 433 struct inode *inode = filp->f_path.dentry->d_inode;
923f4f23 434 struct pipe_inode_info *pipe;
1da177e4
LT
435 ssize_t ret;
436 int do_wakeup;
437 struct iovec *iov = (struct iovec *)_iov;
438 size_t total_len;
439 ssize_t chars;
440
441 total_len = iov_length(iov, nr_segs);
442 /* Null write succeeds. */
443 if (unlikely(total_len == 0))
444 return 0;
445
446 do_wakeup = 0;
447 ret = 0;
9aeedfc4 448 mutex_lock(&inode->i_mutex);
923f4f23 449 pipe = inode->i_pipe;
1da177e4 450
923f4f23 451 if (!pipe->readers) {
1da177e4
LT
452 send_sig(SIGPIPE, current, 0);
453 ret = -EPIPE;
454 goto out;
455 }
456
457 /* We try to merge small writes */
458 chars = total_len & (PAGE_SIZE-1); /* size of the last buffer */
923f4f23 459 if (pipe->nrbufs && chars != 0) {
341b446b
IM
460 int lastbuf = (pipe->curbuf + pipe->nrbufs - 1) &
461 (PIPE_BUFFERS-1);
923f4f23 462 struct pipe_buffer *buf = pipe->bufs + lastbuf;
d4c3cca9 463 const struct pipe_buf_operations *ops = buf->ops;
1da177e4 464 int offset = buf->offset + buf->len;
341b446b 465
1da177e4 466 if (ops->can_merge && offset + chars <= PAGE_SIZE) {
f6762b7a 467 int error, atomic = 1;
5274f052 468 void *addr;
5274f052 469
cac36bb0 470 error = ops->confirm(pipe, buf);
f84d7519 471 if (error)
5274f052 472 goto out;
f84d7519 473
f6762b7a
JA
474 iov_fault_in_pages_read(iov, chars);
475redo1:
476 addr = ops->map(pipe, buf, atomic);
5274f052 477 error = pipe_iov_copy_from_user(offset + addr, iov,
f6762b7a
JA
478 chars, atomic);
479 ops->unmap(pipe, buf, addr);
1da177e4
LT
480 ret = error;
481 do_wakeup = 1;
f6762b7a
JA
482 if (error) {
483 if (atomic) {
484 atomic = 0;
485 goto redo1;
486 }
1da177e4 487 goto out;
f6762b7a 488 }
1da177e4
LT
489 buf->len += chars;
490 total_len -= chars;
491 ret = chars;
492 if (!total_len)
493 goto out;
494 }
495 }
496
497 for (;;) {
498 int bufs;
341b446b 499
923f4f23 500 if (!pipe->readers) {
1da177e4 501 send_sig(SIGPIPE, current, 0);
341b446b
IM
502 if (!ret)
503 ret = -EPIPE;
1da177e4
LT
504 break;
505 }
923f4f23 506 bufs = pipe->nrbufs;
1da177e4 507 if (bufs < PIPE_BUFFERS) {
923f4f23
IM
508 int newbuf = (pipe->curbuf + bufs) & (PIPE_BUFFERS-1);
509 struct pipe_buffer *buf = pipe->bufs + newbuf;
510 struct page *page = pipe->tmp_page;
f6762b7a
JA
511 char *src;
512 int error, atomic = 1;
1da177e4
LT
513
514 if (!page) {
515 page = alloc_page(GFP_HIGHUSER);
516 if (unlikely(!page)) {
517 ret = ret ? : -ENOMEM;
518 break;
519 }
923f4f23 520 pipe->tmp_page = page;
1da177e4 521 }
341b446b 522 /* Always wake up, even if the copy fails. Otherwise
1da177e4
LT
523 * we lock up (O_NONBLOCK-)readers that sleep due to
524 * syscall merging.
525 * FIXME! Is this really true?
526 */
527 do_wakeup = 1;
528 chars = PAGE_SIZE;
529 if (chars > total_len)
530 chars = total_len;
531
f6762b7a
JA
532 iov_fault_in_pages_read(iov, chars);
533redo2:
534 if (atomic)
535 src = kmap_atomic(page, KM_USER0);
536 else
537 src = kmap(page);
538
539 error = pipe_iov_copy_from_user(src, iov, chars,
540 atomic);
541 if (atomic)
542 kunmap_atomic(src, KM_USER0);
543 else
544 kunmap(page);
545
1da177e4 546 if (unlikely(error)) {
f6762b7a
JA
547 if (atomic) {
548 atomic = 0;
549 goto redo2;
550 }
341b446b 551 if (!ret)
f6762b7a 552 ret = error;
1da177e4
LT
553 break;
554 }
555 ret += chars;
556
557 /* Insert it into the buffer array */
558 buf->page = page;
559 buf->ops = &anon_pipe_buf_ops;
560 buf->offset = 0;
561 buf->len = chars;
923f4f23
IM
562 pipe->nrbufs = ++bufs;
563 pipe->tmp_page = NULL;
1da177e4
LT
564
565 total_len -= chars;
566 if (!total_len)
567 break;
568 }
569 if (bufs < PIPE_BUFFERS)
570 continue;
571 if (filp->f_flags & O_NONBLOCK) {
341b446b
IM
572 if (!ret)
573 ret = -EAGAIN;
1da177e4
LT
574 break;
575 }
576 if (signal_pending(current)) {
341b446b
IM
577 if (!ret)
578 ret = -ERESTARTSYS;
1da177e4
LT
579 break;
580 }
581 if (do_wakeup) {
923f4f23
IM
582 wake_up_interruptible_sync(&pipe->wait);
583 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1da177e4
LT
584 do_wakeup = 0;
585 }
923f4f23
IM
586 pipe->waiting_writers++;
587 pipe_wait(pipe);
588 pipe->waiting_writers--;
1da177e4
LT
589 }
590out:
9aeedfc4 591 mutex_unlock(&inode->i_mutex);
1da177e4 592 if (do_wakeup) {
71e20f18 593 wake_up_interruptible_sync(&pipe->wait);
923f4f23 594 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1da177e4
LT
595 }
596 if (ret > 0)
870f4817 597 file_update_time(filp);
1da177e4
LT
598 return ret;
599}
600
1da177e4
LT
601static ssize_t
602bad_pipe_r(struct file *filp, char __user *buf, size_t count, loff_t *ppos)
603{
604 return -EBADF;
605}
606
607static ssize_t
341b446b
IM
608bad_pipe_w(struct file *filp, const char __user *buf, size_t count,
609 loff_t *ppos)
1da177e4
LT
610{
611 return -EBADF;
612}
613
d59d0b1b 614static long pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1da177e4 615{
0f7fc9e4 616 struct inode *inode = filp->f_path.dentry->d_inode;
923f4f23 617 struct pipe_inode_info *pipe;
1da177e4
LT
618 int count, buf, nrbufs;
619
620 switch (cmd) {
621 case FIONREAD:
9aeedfc4 622 mutex_lock(&inode->i_mutex);
923f4f23 623 pipe = inode->i_pipe;
1da177e4 624 count = 0;
923f4f23
IM
625 buf = pipe->curbuf;
626 nrbufs = pipe->nrbufs;
1da177e4 627 while (--nrbufs >= 0) {
923f4f23 628 count += pipe->bufs[buf].len;
1da177e4
LT
629 buf = (buf+1) & (PIPE_BUFFERS-1);
630 }
9aeedfc4 631 mutex_unlock(&inode->i_mutex);
923f4f23 632
1da177e4
LT
633 return put_user(count, (int __user *)arg);
634 default:
635 return -EINVAL;
636 }
637}
638
639/* No kernel lock held - fine */
640static unsigned int
641pipe_poll(struct file *filp, poll_table *wait)
642{
643 unsigned int mask;
0f7fc9e4 644 struct inode *inode = filp->f_path.dentry->d_inode;
923f4f23 645 struct pipe_inode_info *pipe = inode->i_pipe;
1da177e4
LT
646 int nrbufs;
647
923f4f23 648 poll_wait(filp, &pipe->wait, wait);
1da177e4
LT
649
650 /* Reading only -- no need for acquiring the semaphore. */
923f4f23 651 nrbufs = pipe->nrbufs;
1da177e4
LT
652 mask = 0;
653 if (filp->f_mode & FMODE_READ) {
654 mask = (nrbufs > 0) ? POLLIN | POLLRDNORM : 0;
923f4f23 655 if (!pipe->writers && filp->f_version != pipe->w_counter)
1da177e4
LT
656 mask |= POLLHUP;
657 }
658
659 if (filp->f_mode & FMODE_WRITE) {
660 mask |= (nrbufs < PIPE_BUFFERS) ? POLLOUT | POLLWRNORM : 0;
5e5d7a22
PE
661 /*
662 * Most Unices do not set POLLERR for FIFOs but on Linux they
663 * behave exactly like pipes for poll().
664 */
923f4f23 665 if (!pipe->readers)
1da177e4
LT
666 mask |= POLLERR;
667 }
668
669 return mask;
670}
671
1da177e4
LT
672static int
673pipe_release(struct inode *inode, int decr, int decw)
674{
923f4f23
IM
675 struct pipe_inode_info *pipe;
676
9aeedfc4 677 mutex_lock(&inode->i_mutex);
923f4f23
IM
678 pipe = inode->i_pipe;
679 pipe->readers -= decr;
680 pipe->writers -= decw;
341b446b 681
923f4f23 682 if (!pipe->readers && !pipe->writers) {
1da177e4
LT
683 free_pipe_info(inode);
684 } else {
71e20f18 685 wake_up_interruptible_sync(&pipe->wait);
923f4f23
IM
686 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
687 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4 688 }
9aeedfc4 689 mutex_unlock(&inode->i_mutex);
1da177e4
LT
690
691 return 0;
692}
693
694static int
695pipe_read_fasync(int fd, struct file *filp, int on)
696{
0f7fc9e4 697 struct inode *inode = filp->f_path.dentry->d_inode;
1da177e4
LT
698 int retval;
699
9aeedfc4
IM
700 mutex_lock(&inode->i_mutex);
701 retval = fasync_helper(fd, filp, on, &inode->i_pipe->fasync_readers);
702 mutex_unlock(&inode->i_mutex);
1da177e4 703
60aa4924 704 return retval;
1da177e4
LT
705}
706
707
708static int
709pipe_write_fasync(int fd, struct file *filp, int on)
710{
0f7fc9e4 711 struct inode *inode = filp->f_path.dentry->d_inode;
1da177e4
LT
712 int retval;
713
9aeedfc4
IM
714 mutex_lock(&inode->i_mutex);
715 retval = fasync_helper(fd, filp, on, &inode->i_pipe->fasync_writers);
716 mutex_unlock(&inode->i_mutex);
1da177e4 717
60aa4924 718 return retval;
1da177e4
LT
719}
720
721
722static int
723pipe_rdwr_fasync(int fd, struct file *filp, int on)
724{
0f7fc9e4 725 struct inode *inode = filp->f_path.dentry->d_inode;
341b446b 726 struct pipe_inode_info *pipe = inode->i_pipe;
1da177e4
LT
727 int retval;
728
9aeedfc4 729 mutex_lock(&inode->i_mutex);
341b446b 730 retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
e5bc49ba 731 if (retval >= 0) {
341b446b 732 retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
e5bc49ba
ON
733 if (retval < 0) /* this can happen only if on == T */
734 fasync_helper(-1, filp, 0, &pipe->fasync_readers);
735 }
9aeedfc4 736 mutex_unlock(&inode->i_mutex);
60aa4924 737 return retval;
1da177e4
LT
738}
739
740
741static int
742pipe_read_release(struct inode *inode, struct file *filp)
743{
1da177e4
LT
744 return pipe_release(inode, 1, 0);
745}
746
747static int
748pipe_write_release(struct inode *inode, struct file *filp)
749{
1da177e4
LT
750 return pipe_release(inode, 0, 1);
751}
752
753static int
754pipe_rdwr_release(struct inode *inode, struct file *filp)
755{
756 int decr, decw;
757
1da177e4
LT
758 decr = (filp->f_mode & FMODE_READ) != 0;
759 decw = (filp->f_mode & FMODE_WRITE) != 0;
760 return pipe_release(inode, decr, decw);
761}
762
763static int
764pipe_read_open(struct inode *inode, struct file *filp)
765{
766 /* We could have perhaps used atomic_t, but this and friends
767 below are the only places. So it doesn't seem worthwhile. */
9aeedfc4
IM
768 mutex_lock(&inode->i_mutex);
769 inode->i_pipe->readers++;
770 mutex_unlock(&inode->i_mutex);
1da177e4
LT
771
772 return 0;
773}
774
775static int
776pipe_write_open(struct inode *inode, struct file *filp)
777{
9aeedfc4
IM
778 mutex_lock(&inode->i_mutex);
779 inode->i_pipe->writers++;
780 mutex_unlock(&inode->i_mutex);
1da177e4
LT
781
782 return 0;
783}
784
785static int
786pipe_rdwr_open(struct inode *inode, struct file *filp)
787{
9aeedfc4 788 mutex_lock(&inode->i_mutex);
1da177e4 789 if (filp->f_mode & FMODE_READ)
9aeedfc4 790 inode->i_pipe->readers++;
1da177e4 791 if (filp->f_mode & FMODE_WRITE)
9aeedfc4
IM
792 inode->i_pipe->writers++;
793 mutex_unlock(&inode->i_mutex);
1da177e4
LT
794
795 return 0;
796}
797
798/*
799 * The file_operations structs are not static because they
800 * are also used in linux/fs/fifo.c to do operations on FIFOs.
d2d9648e
DV
801 *
802 * Pipes reuse fifos' file_operations structs.
1da177e4 803 */
d2d9648e 804const struct file_operations read_pipefifo_fops = {
1da177e4 805 .llseek = no_llseek,
ee0b3e67
BP
806 .read = do_sync_read,
807 .aio_read = pipe_read,
1da177e4
LT
808 .write = bad_pipe_w,
809 .poll = pipe_poll,
d59d0b1b 810 .unlocked_ioctl = pipe_ioctl,
1da177e4
LT
811 .open = pipe_read_open,
812 .release = pipe_read_release,
813 .fasync = pipe_read_fasync,
814};
815
d2d9648e 816const struct file_operations write_pipefifo_fops = {
1da177e4
LT
817 .llseek = no_llseek,
818 .read = bad_pipe_r,
ee0b3e67
BP
819 .write = do_sync_write,
820 .aio_write = pipe_write,
1da177e4 821 .poll = pipe_poll,
d59d0b1b 822 .unlocked_ioctl = pipe_ioctl,
1da177e4
LT
823 .open = pipe_write_open,
824 .release = pipe_write_release,
825 .fasync = pipe_write_fasync,
826};
827
d2d9648e 828const struct file_operations rdwr_pipefifo_fops = {
1da177e4 829 .llseek = no_llseek,
ee0b3e67
BP
830 .read = do_sync_read,
831 .aio_read = pipe_read,
832 .write = do_sync_write,
833 .aio_write = pipe_write,
1da177e4 834 .poll = pipe_poll,
d59d0b1b 835 .unlocked_ioctl = pipe_ioctl,
1da177e4
LT
836 .open = pipe_rdwr_open,
837 .release = pipe_rdwr_release,
838 .fasync = pipe_rdwr_fasync,
839};
840
3a326a2c
IM
841struct pipe_inode_info * alloc_pipe_info(struct inode *inode)
842{
923f4f23 843 struct pipe_inode_info *pipe;
3a326a2c 844
923f4f23
IM
845 pipe = kzalloc(sizeof(struct pipe_inode_info), GFP_KERNEL);
846 if (pipe) {
847 init_waitqueue_head(&pipe->wait);
848 pipe->r_counter = pipe->w_counter = 1;
849 pipe->inode = inode;
3a326a2c
IM
850 }
851
923f4f23 852 return pipe;
3a326a2c
IM
853}
854
923f4f23 855void __free_pipe_info(struct pipe_inode_info *pipe)
1da177e4
LT
856{
857 int i;
1da177e4 858
1da177e4 859 for (i = 0; i < PIPE_BUFFERS; i++) {
923f4f23 860 struct pipe_buffer *buf = pipe->bufs + i;
1da177e4 861 if (buf->ops)
923f4f23 862 buf->ops->release(pipe, buf);
1da177e4 863 }
923f4f23
IM
864 if (pipe->tmp_page)
865 __free_page(pipe->tmp_page);
866 kfree(pipe);
1da177e4
LT
867}
868
b92ce558
JA
869void free_pipe_info(struct inode *inode)
870{
871 __free_pipe_info(inode->i_pipe);
872 inode->i_pipe = NULL;
873}
874
fa3536cc 875static struct vfsmount *pipe_mnt __read_mostly;
1da177e4
LT
876static int pipefs_delete_dentry(struct dentry *dentry)
877{
d18de5a2
ED
878 /*
879 * At creation time, we pretended this dentry was hashed
880 * (by clearing DCACHE_UNHASHED bit in d_flags)
881 * At delete time, we restore the truth : not hashed.
882 * (so that dput() can proceed correctly)
883 */
884 dentry->d_flags |= DCACHE_UNHASHED;
885 return 0;
1da177e4 886}
341b446b 887
c23fbb6b
ED
888/*
889 * pipefs_dname() is called from d_path().
890 */
891static char *pipefs_dname(struct dentry *dentry, char *buffer, int buflen)
892{
893 return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
894 dentry->d_inode->i_ino);
895}
896
3ba13d17 897static const struct dentry_operations pipefs_dentry_operations = {
1da177e4 898 .d_delete = pipefs_delete_dentry,
c23fbb6b 899 .d_dname = pipefs_dname,
1da177e4
LT
900};
901
902static struct inode * get_pipe_inode(void)
903{
904 struct inode *inode = new_inode(pipe_mnt->mnt_sb);
923f4f23 905 struct pipe_inode_info *pipe;
1da177e4
LT
906
907 if (!inode)
908 goto fail_inode;
909
923f4f23
IM
910 pipe = alloc_pipe_info(inode);
911 if (!pipe)
1da177e4 912 goto fail_iput;
923f4f23 913 inode->i_pipe = pipe;
3a326a2c 914
923f4f23 915 pipe->readers = pipe->writers = 1;
d2d9648e 916 inode->i_fop = &rdwr_pipefifo_fops;
1da177e4
LT
917
918 /*
919 * Mark the inode dirty from the very beginning,
920 * that way it will never be moved to the dirty
921 * list because "mark_inode_dirty()" will think
922 * that it already _is_ on the dirty list.
923 */
924 inode->i_state = I_DIRTY;
925 inode->i_mode = S_IFIFO | S_IRUSR | S_IWUSR;
da9592ed
DH
926 inode->i_uid = current_fsuid();
927 inode->i_gid = current_fsgid();
1da177e4 928 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
923f4f23 929
1da177e4
LT
930 return inode;
931
932fail_iput:
933 iput(inode);
341b446b 934
1da177e4
LT
935fail_inode:
936 return NULL;
937}
938
be61a86d 939struct file *create_write_pipe(int flags)
1da177e4 940{
d6cbd281
AK
941 int err;
942 struct inode *inode;
943 struct file *f;
1da177e4 944 struct dentry *dentry;
c23fbb6b 945 struct qstr name = { .name = "" };
1da177e4 946
d6cbd281 947 err = -ENFILE;
1da177e4
LT
948 inode = get_pipe_inode();
949 if (!inode)
430e285e 950 goto err;
1da177e4 951
d6cbd281 952 err = -ENOMEM;
c23fbb6b 953 dentry = d_alloc(pipe_mnt->mnt_sb->s_root, &name);
1da177e4 954 if (!dentry)
d6cbd281 955 goto err_inode;
341b446b 956
1da177e4 957 dentry->d_op = &pipefs_dentry_operations;
d18de5a2
ED
958 /*
959 * We dont want to publish this dentry into global dentry hash table.
960 * We pretend dentry is already hashed, by unsetting DCACHE_UNHASHED
961 * This permits a working /proc/$pid/fd/XXX on pipes
962 */
963 dentry->d_flags &= ~DCACHE_UNHASHED;
964 d_instantiate(dentry, inode);
430e285e
DH
965
966 err = -ENFILE;
d2d9648e 967 f = alloc_file(pipe_mnt, dentry, FMODE_WRITE, &write_pipefifo_fops);
430e285e
DH
968 if (!f)
969 goto err_dentry;
d6cbd281 970 f->f_mapping = inode->i_mapping;
341b446b 971
be61a86d 972 f->f_flags = O_WRONLY | (flags & O_NONBLOCK);
d6cbd281
AK
973 f->f_version = 0;
974
975 return f;
1da177e4 976
430e285e 977 err_dentry:
ed152437 978 free_pipe_info(inode);
430e285e 979 dput(dentry);
ed152437
AV
980 return ERR_PTR(err);
981
d6cbd281 982 err_inode:
1da177e4
LT
983 free_pipe_info(inode);
984 iput(inode);
430e285e 985 err:
d6cbd281
AK
986 return ERR_PTR(err);
987}
988
989void free_write_pipe(struct file *f)
990{
5ccac88e 991 free_pipe_info(f->f_dentry->d_inode);
c8e7f449 992 path_put(&f->f_path);
d6cbd281
AK
993 put_filp(f);
994}
995
be61a86d 996struct file *create_read_pipe(struct file *wrf, int flags)
d6cbd281
AK
997{
998 struct file *f = get_empty_filp();
999 if (!f)
1000 return ERR_PTR(-ENFILE);
1001
1002 /* Grab pipe from the writer */
c8e7f449
JB
1003 f->f_path = wrf->f_path;
1004 path_get(&wrf->f_path);
0f7fc9e4 1005 f->f_mapping = wrf->f_path.dentry->d_inode->i_mapping;
d6cbd281
AK
1006
1007 f->f_pos = 0;
be61a86d 1008 f->f_flags = O_RDONLY | (flags & O_NONBLOCK);
d2d9648e 1009 f->f_op = &read_pipefifo_fops;
d6cbd281
AK
1010 f->f_mode = FMODE_READ;
1011 f->f_version = 0;
1012
1013 return f;
1014}
1015
ed8cae8b 1016int do_pipe_flags(int *fd, int flags)
d6cbd281
AK
1017{
1018 struct file *fw, *fr;
1019 int error;
1020 int fdw, fdr;
1021
be61a86d 1022 if (flags & ~(O_CLOEXEC | O_NONBLOCK))
ed8cae8b
UD
1023 return -EINVAL;
1024
be61a86d 1025 fw = create_write_pipe(flags);
d6cbd281
AK
1026 if (IS_ERR(fw))
1027 return PTR_ERR(fw);
be61a86d 1028 fr = create_read_pipe(fw, flags);
d6cbd281
AK
1029 error = PTR_ERR(fr);
1030 if (IS_ERR(fr))
1031 goto err_write_pipe;
1032
ed8cae8b 1033 error = get_unused_fd_flags(flags);
d6cbd281
AK
1034 if (error < 0)
1035 goto err_read_pipe;
1036 fdr = error;
1037
ed8cae8b 1038 error = get_unused_fd_flags(flags);
d6cbd281
AK
1039 if (error < 0)
1040 goto err_fdr;
1041 fdw = error;
1042
157cf649 1043 audit_fd_pair(fdr, fdw);
d6cbd281
AK
1044 fd_install(fdr, fr);
1045 fd_install(fdw, fw);
1046 fd[0] = fdr;
1047 fd[1] = fdw;
1048
1049 return 0;
1050
1051 err_fdr:
1052 put_unused_fd(fdr);
1053 err_read_pipe:
c8e7f449 1054 path_put(&fr->f_path);
d6cbd281
AK
1055 put_filp(fr);
1056 err_write_pipe:
1057 free_write_pipe(fw);
1058 return error;
1da177e4
LT
1059}
1060
d35c7b0e
UD
1061/*
1062 * sys_pipe() is the normal C calling standard for creating
1063 * a pipe. It's not the way Unix traditionally does this, though.
1064 */
d4e82042 1065SYSCALL_DEFINE2(pipe2, int __user *, fildes, int, flags)
d35c7b0e
UD
1066{
1067 int fd[2];
1068 int error;
1069
ed8cae8b 1070 error = do_pipe_flags(fd, flags);
d35c7b0e 1071 if (!error) {
ba719bae
UD
1072 if (copy_to_user(fildes, fd, sizeof(fd))) {
1073 sys_close(fd[0]);
1074 sys_close(fd[1]);
d35c7b0e 1075 error = -EFAULT;
ba719bae 1076 }
d35c7b0e
UD
1077 }
1078 return error;
1079}
1080
2b664219 1081SYSCALL_DEFINE1(pipe, int __user *, fildes)
ed8cae8b
UD
1082{
1083 return sys_pipe2(fildes, 0);
1084}
1085
1da177e4
LT
1086/*
1087 * pipefs should _never_ be mounted by userland - too much of security hassle,
1088 * no real gain from having the whole whorehouse mounted. So we don't need
1089 * any operations on the root directory. However, we need a non-trivial
1090 * d_name - pipe: will go nicely and kill the special-casing in procfs.
1091 */
454e2398
DH
1092static int pipefs_get_sb(struct file_system_type *fs_type,
1093 int flags, const char *dev_name, void *data,
1094 struct vfsmount *mnt)
1da177e4 1095{
454e2398 1096 return get_sb_pseudo(fs_type, "pipe:", NULL, PIPEFS_MAGIC, mnt);
1da177e4
LT
1097}
1098
1099static struct file_system_type pipe_fs_type = {
1100 .name = "pipefs",
1101 .get_sb = pipefs_get_sb,
1102 .kill_sb = kill_anon_super,
1103};
1104
1105static int __init init_pipe_fs(void)
1106{
1107 int err = register_filesystem(&pipe_fs_type);
341b446b 1108
1da177e4
LT
1109 if (!err) {
1110 pipe_mnt = kern_mount(&pipe_fs_type);
1111 if (IS_ERR(pipe_mnt)) {
1112 err = PTR_ERR(pipe_mnt);
1113 unregister_filesystem(&pipe_fs_type);
1114 }
1115 }
1116 return err;
1117}
1118
1119static void __exit exit_pipe_fs(void)
1120{
1121 unregister_filesystem(&pipe_fs_type);
1122 mntput(pipe_mnt);
1123}
1124
1125fs_initcall(init_pipe_fs);
1126module_exit(exit_pipe_fs);