cifs: switch to ->read_iter()
[linux-2.6-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>
35f3d14d 14#include <linux/log2.h>
1da177e4 15#include <linux/mount.h>
b502bd11 16#include <linux/magic.h>
1da177e4
LT
17#include <linux/pipe_fs_i.h>
18#include <linux/uio.h>
19#include <linux/highmem.h>
5274f052 20#include <linux/pagemap.h>
db349509 21#include <linux/audit.h>
ba719bae 22#include <linux/syscalls.h>
b492e95b 23#include <linux/fcntl.h>
a27bb332 24#include <linux/aio.h>
1da177e4
LT
25
26#include <asm/uaccess.h>
27#include <asm/ioctls.h>
28
599a0ac1
AV
29#include "internal.h"
30
b492e95b
JA
31/*
32 * The max size that a non-root user is allowed to grow the pipe. Can
ff9da691 33 * be set by root in /proc/sys/fs/pipe-max-size
b492e95b 34 */
ff9da691
JA
35unsigned int pipe_max_size = 1048576;
36
37/*
38 * Minimum pipe size, as required by POSIX
39 */
40unsigned int pipe_min_size = PAGE_SIZE;
b492e95b 41
1da177e4
LT
42/*
43 * We use a start+len construction, which provides full use of the
44 * allocated memory.
45 * -- Florian Coosmann (FGC)
46 *
47 * Reads with count = 0 should always return 0.
48 * -- Julian Bradfield 1999-06-07.
49 *
50 * FIFOs and Pipes now generate SIGIO for both readers and writers.
51 * -- Jeremy Elson <jelson@circlemud.org> 2001-08-16
52 *
53 * pipe_read & write cleanup
54 * -- Manfred Spraul <manfred@colorfullife.com> 2002-05-09
55 */
56
61e0d47c
MS
57static void pipe_lock_nested(struct pipe_inode_info *pipe, int subclass)
58{
6447a3cf 59 if (pipe->files)
72b0d9aa 60 mutex_lock_nested(&pipe->mutex, subclass);
61e0d47c
MS
61}
62
63void pipe_lock(struct pipe_inode_info *pipe)
64{
65 /*
66 * pipe_lock() nests non-pipe inode locks (for writing to a file)
67 */
68 pipe_lock_nested(pipe, I_MUTEX_PARENT);
69}
70EXPORT_SYMBOL(pipe_lock);
71
72void pipe_unlock(struct pipe_inode_info *pipe)
73{
6447a3cf 74 if (pipe->files)
72b0d9aa 75 mutex_unlock(&pipe->mutex);
61e0d47c
MS
76}
77EXPORT_SYMBOL(pipe_unlock);
78
ebec73f4
AV
79static inline void __pipe_lock(struct pipe_inode_info *pipe)
80{
81 mutex_lock_nested(&pipe->mutex, I_MUTEX_PARENT);
82}
83
84static inline void __pipe_unlock(struct pipe_inode_info *pipe)
85{
86 mutex_unlock(&pipe->mutex);
87}
88
61e0d47c
MS
89void pipe_double_lock(struct pipe_inode_info *pipe1,
90 struct pipe_inode_info *pipe2)
91{
92 BUG_ON(pipe1 == pipe2);
93
94 if (pipe1 < pipe2) {
95 pipe_lock_nested(pipe1, I_MUTEX_PARENT);
96 pipe_lock_nested(pipe2, I_MUTEX_CHILD);
97 } else {
023d43c7
PZ
98 pipe_lock_nested(pipe2, I_MUTEX_PARENT);
99 pipe_lock_nested(pipe1, I_MUTEX_CHILD);
61e0d47c
MS
100 }
101}
102
1da177e4 103/* Drop the inode semaphore and wait for a pipe event, atomically */
3a326a2c 104void pipe_wait(struct pipe_inode_info *pipe)
1da177e4
LT
105{
106 DEFINE_WAIT(wait);
107
d79fc0fc
IM
108 /*
109 * Pipes are system-local resources, so sleeping on them
110 * is considered a noninteractive wait:
111 */
af927232 112 prepare_to_wait(&pipe->wait, &wait, TASK_INTERRUPTIBLE);
61e0d47c 113 pipe_unlock(pipe);
1da177e4 114 schedule();
3a326a2c 115 finish_wait(&pipe->wait, &wait);
61e0d47c 116 pipe_lock(pipe);
1da177e4
LT
117}
118
858119e1 119static int
f6762b7a
JA
120pipe_iov_copy_from_user(void *to, struct iovec *iov, unsigned long len,
121 int atomic)
1da177e4
LT
122{
123 unsigned long copy;
124
125 while (len > 0) {
126 while (!iov->iov_len)
127 iov++;
128 copy = min_t(unsigned long, len, iov->iov_len);
129
f6762b7a
JA
130 if (atomic) {
131 if (__copy_from_user_inatomic(to, iov->iov_base, copy))
132 return -EFAULT;
133 } else {
134 if (copy_from_user(to, iov->iov_base, copy))
135 return -EFAULT;
136 }
1da177e4
LT
137 to += copy;
138 len -= copy;
139 iov->iov_base += copy;
140 iov->iov_len -= copy;
141 }
142 return 0;
143}
144
f6762b7a
JA
145/*
146 * Pre-fault in the user memory, so we can use atomic copies.
147 */
148static void iov_fault_in_pages_read(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 fault_in_pages_readable(iov->iov_base, this_len);
158 len -= this_len;
159 iov++;
160 }
161}
162
341b446b
IM
163static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
164 struct pipe_buffer *buf)
1da177e4
LT
165{
166 struct page *page = buf->page;
167
5274f052
JA
168 /*
169 * If nobody else uses this page, and we don't already have a
170 * temporary page, let's keep track of it as a one-deep
341b446b 171 * allocation cache. (Otherwise just release our reference to it)
5274f052 172 */
341b446b 173 if (page_count(page) == 1 && !pipe->tmp_page)
923f4f23 174 pipe->tmp_page = page;
341b446b
IM
175 else
176 page_cache_release(page);
1da177e4
LT
177}
178
0845718d 179/**
b51d63c6 180 * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
0845718d
JA
181 * @pipe: the pipe that the buffer belongs to
182 * @buf: the buffer to attempt to steal
183 *
184 * Description:
b51d63c6 185 * This function attempts to steal the &struct page attached to
0845718d
JA
186 * @buf. If successful, this function returns 0 and returns with
187 * the page locked. The caller may then reuse the page for whatever
b51d63c6 188 * he wishes; the typical use is insertion into a different file
0845718d
JA
189 * page cache.
190 */
330ab716
JA
191int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
192 struct pipe_buffer *buf)
5abc97aa 193{
46e678c9
JA
194 struct page *page = buf->page;
195
0845718d
JA
196 /*
197 * A reference of one is golden, that means that the owner of this
198 * page is the only one holding a reference to it. lock the page
199 * and return OK.
200 */
46e678c9 201 if (page_count(page) == 1) {
46e678c9
JA
202 lock_page(page);
203 return 0;
204 }
205
206 return 1;
5abc97aa 207}
51921cb7 208EXPORT_SYMBOL(generic_pipe_buf_steal);
5abc97aa 209
0845718d 210/**
b51d63c6 211 * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
0845718d
JA
212 * @pipe: the pipe that the buffer belongs to
213 * @buf: the buffer to get a reference to
214 *
215 * Description:
216 * This function grabs an extra reference to @buf. It's used in
217 * in the tee() system call, when we duplicate the buffers in one
218 * pipe into another.
219 */
220void generic_pipe_buf_get(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
70524490
JA
221{
222 page_cache_get(buf->page);
223}
51921cb7 224EXPORT_SYMBOL(generic_pipe_buf_get);
70524490 225
0845718d
JA
226/**
227 * generic_pipe_buf_confirm - verify contents of the pipe buffer
79685b8d 228 * @info: the pipe that the buffer belongs to
0845718d
JA
229 * @buf: the buffer to confirm
230 *
231 * Description:
232 * This function does nothing, because the generic pipe code uses
233 * pages that are always good when inserted into the pipe.
234 */
cac36bb0
JA
235int generic_pipe_buf_confirm(struct pipe_inode_info *info,
236 struct pipe_buffer *buf)
f84d7519
JA
237{
238 return 0;
239}
51921cb7 240EXPORT_SYMBOL(generic_pipe_buf_confirm);
f84d7519 241
6818173b
MS
242/**
243 * generic_pipe_buf_release - put a reference to a &struct pipe_buffer
244 * @pipe: the pipe that the buffer belongs to
245 * @buf: the buffer to put a reference to
246 *
247 * Description:
248 * This function releases a reference to @buf.
249 */
250void generic_pipe_buf_release(struct pipe_inode_info *pipe,
251 struct pipe_buffer *buf)
252{
253 page_cache_release(buf->page);
254}
51921cb7 255EXPORT_SYMBOL(generic_pipe_buf_release);
6818173b 256
d4c3cca9 257static const struct pipe_buf_operations anon_pipe_buf_ops = {
1da177e4 258 .can_merge = 1,
cac36bb0 259 .confirm = generic_pipe_buf_confirm,
1da177e4 260 .release = anon_pipe_buf_release,
330ab716 261 .steal = generic_pipe_buf_steal,
f84d7519 262 .get = generic_pipe_buf_get,
1da177e4
LT
263};
264
9883035a
LT
265static const struct pipe_buf_operations packet_pipe_buf_ops = {
266 .can_merge = 0,
9883035a
LT
267 .confirm = generic_pipe_buf_confirm,
268 .release = anon_pipe_buf_release,
269 .steal = generic_pipe_buf_steal,
270 .get = generic_pipe_buf_get,
271};
272
1da177e4 273static ssize_t
ee0b3e67
BP
274pipe_read(struct kiocb *iocb, const struct iovec *_iov,
275 unsigned long nr_segs, loff_t pos)
1da177e4 276{
ee0b3e67 277 struct file *filp = iocb->ki_filp;
de32ec4c 278 struct pipe_inode_info *pipe = filp->private_data;
1da177e4
LT
279 int do_wakeup;
280 ssize_t ret;
281 struct iovec *iov = (struct iovec *)_iov;
282 size_t total_len;
637b58c2 283 struct iov_iter iter;
1da177e4
LT
284
285 total_len = iov_length(iov, nr_segs);
286 /* Null read succeeds. */
287 if (unlikely(total_len == 0))
288 return 0;
289
71d8e532 290 iov_iter_init(&iter, READ, iov, nr_segs, total_len);
637b58c2 291
1da177e4
LT
292 do_wakeup = 0;
293 ret = 0;
ebec73f4 294 __pipe_lock(pipe);
1da177e4 295 for (;;) {
923f4f23 296 int bufs = pipe->nrbufs;
1da177e4 297 if (bufs) {
923f4f23
IM
298 int curbuf = pipe->curbuf;
299 struct pipe_buffer *buf = pipe->bufs + curbuf;
d4c3cca9 300 const struct pipe_buf_operations *ops = buf->ops;
1da177e4 301 size_t chars = buf->len;
637b58c2
AV
302 size_t written;
303 int error;
1da177e4
LT
304
305 if (chars > total_len)
306 chars = total_len;
307
cac36bb0 308 error = ops->confirm(pipe, buf);
f84d7519 309 if (error) {
5274f052 310 if (!ret)
e5953cbd 311 ret = error;
5274f052
JA
312 break;
313 }
f84d7519 314
637b58c2
AV
315 written = copy_page_to_iter(buf->page, buf->offset, chars, &iter);
316 if (unlikely(written < chars)) {
341b446b 317 if (!ret)
637b58c2 318 ret = -EFAULT;
1da177e4
LT
319 break;
320 }
321 ret += chars;
322 buf->offset += chars;
323 buf->len -= chars;
9883035a
LT
324
325 /* Was it a packet buffer? Clean up and exit */
326 if (buf->flags & PIPE_BUF_FLAG_PACKET) {
327 total_len = chars;
328 buf->len = 0;
329 }
330
1da177e4
LT
331 if (!buf->len) {
332 buf->ops = NULL;
923f4f23 333 ops->release(pipe, buf);
35f3d14d 334 curbuf = (curbuf + 1) & (pipe->buffers - 1);
923f4f23
IM
335 pipe->curbuf = curbuf;
336 pipe->nrbufs = --bufs;
1da177e4
LT
337 do_wakeup = 1;
338 }
339 total_len -= chars;
340 if (!total_len)
341 break; /* common path: read succeeded */
342 }
343 if (bufs) /* More to do? */
344 continue;
923f4f23 345 if (!pipe->writers)
1da177e4 346 break;
923f4f23 347 if (!pipe->waiting_writers) {
1da177e4
LT
348 /* syscall merging: Usually we must not sleep
349 * if O_NONBLOCK is set, or if we got some data.
350 * But if a writer sleeps in kernel space, then
351 * we can wait for that data without violating POSIX.
352 */
353 if (ret)
354 break;
355 if (filp->f_flags & O_NONBLOCK) {
356 ret = -EAGAIN;
357 break;
358 }
359 }
360 if (signal_pending(current)) {
341b446b
IM
361 if (!ret)
362 ret = -ERESTARTSYS;
1da177e4
LT
363 break;
364 }
365 if (do_wakeup) {
28e58ee8 366 wake_up_interruptible_sync_poll(&pipe->wait, POLLOUT | POLLWRNORM);
923f4f23 367 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4 368 }
923f4f23 369 pipe_wait(pipe);
1da177e4 370 }
ebec73f4 371 __pipe_unlock(pipe);
341b446b
IM
372
373 /* Signal writers asynchronously that there is more room. */
1da177e4 374 if (do_wakeup) {
28e58ee8 375 wake_up_interruptible_sync_poll(&pipe->wait, POLLOUT | POLLWRNORM);
923f4f23 376 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4
LT
377 }
378 if (ret > 0)
379 file_accessed(filp);
380 return ret;
381}
382
9883035a
LT
383static inline int is_packetized(struct file *file)
384{
385 return (file->f_flags & O_DIRECT) != 0;
386}
387
1da177e4 388static ssize_t
ee0b3e67
BP
389pipe_write(struct kiocb *iocb, const struct iovec *_iov,
390 unsigned long nr_segs, loff_t ppos)
1da177e4 391{
ee0b3e67 392 struct file *filp = iocb->ki_filp;
de32ec4c 393 struct pipe_inode_info *pipe = filp->private_data;
1da177e4
LT
394 ssize_t ret;
395 int do_wakeup;
396 struct iovec *iov = (struct iovec *)_iov;
397 size_t total_len;
398 ssize_t chars;
399
400 total_len = iov_length(iov, nr_segs);
401 /* Null write succeeds. */
402 if (unlikely(total_len == 0))
403 return 0;
404
405 do_wakeup = 0;
406 ret = 0;
ebec73f4 407 __pipe_lock(pipe);
1da177e4 408
923f4f23 409 if (!pipe->readers) {
1da177e4
LT
410 send_sig(SIGPIPE, current, 0);
411 ret = -EPIPE;
412 goto out;
413 }
414
415 /* We try to merge small writes */
416 chars = total_len & (PAGE_SIZE-1); /* size of the last buffer */
923f4f23 417 if (pipe->nrbufs && chars != 0) {
341b446b 418 int lastbuf = (pipe->curbuf + pipe->nrbufs - 1) &
35f3d14d 419 (pipe->buffers - 1);
923f4f23 420 struct pipe_buffer *buf = pipe->bufs + lastbuf;
d4c3cca9 421 const struct pipe_buf_operations *ops = buf->ops;
1da177e4 422 int offset = buf->offset + buf->len;
341b446b 423
1da177e4 424 if (ops->can_merge && offset + chars <= PAGE_SIZE) {
f6762b7a 425 int error, atomic = 1;
5274f052 426 void *addr;
5274f052 427
cac36bb0 428 error = ops->confirm(pipe, buf);
f84d7519 429 if (error)
5274f052 430 goto out;
f84d7519 431
f6762b7a
JA
432 iov_fault_in_pages_read(iov, chars);
433redo1:
fbb32750
AV
434 if (atomic)
435 addr = kmap_atomic(buf->page);
436 else
437 addr = kmap(buf->page);
5274f052 438 error = pipe_iov_copy_from_user(offset + addr, iov,
f6762b7a 439 chars, atomic);
fbb32750
AV
440 if (atomic)
441 kunmap_atomic(addr);
442 else
443 kunmap(buf->page);
1da177e4
LT
444 ret = error;
445 do_wakeup = 1;
f6762b7a
JA
446 if (error) {
447 if (atomic) {
448 atomic = 0;
449 goto redo1;
450 }
1da177e4 451 goto out;
f6762b7a 452 }
1da177e4
LT
453 buf->len += chars;
454 total_len -= chars;
455 ret = chars;
456 if (!total_len)
457 goto out;
458 }
459 }
460
461 for (;;) {
462 int bufs;
341b446b 463
923f4f23 464 if (!pipe->readers) {
1da177e4 465 send_sig(SIGPIPE, current, 0);
341b446b
IM
466 if (!ret)
467 ret = -EPIPE;
1da177e4
LT
468 break;
469 }
923f4f23 470 bufs = pipe->nrbufs;
35f3d14d
JA
471 if (bufs < pipe->buffers) {
472 int newbuf = (pipe->curbuf + bufs) & (pipe->buffers-1);
923f4f23
IM
473 struct pipe_buffer *buf = pipe->bufs + newbuf;
474 struct page *page = pipe->tmp_page;
f6762b7a
JA
475 char *src;
476 int error, atomic = 1;
1da177e4
LT
477
478 if (!page) {
479 page = alloc_page(GFP_HIGHUSER);
480 if (unlikely(!page)) {
481 ret = ret ? : -ENOMEM;
482 break;
483 }
923f4f23 484 pipe->tmp_page = page;
1da177e4 485 }
341b446b 486 /* Always wake up, even if the copy fails. Otherwise
1da177e4
LT
487 * we lock up (O_NONBLOCK-)readers that sleep due to
488 * syscall merging.
489 * FIXME! Is this really true?
490 */
491 do_wakeup = 1;
492 chars = PAGE_SIZE;
493 if (chars > total_len)
494 chars = total_len;
495
f6762b7a
JA
496 iov_fault_in_pages_read(iov, chars);
497redo2:
498 if (atomic)
e8e3c3d6 499 src = kmap_atomic(page);
f6762b7a
JA
500 else
501 src = kmap(page);
502
503 error = pipe_iov_copy_from_user(src, iov, chars,
504 atomic);
505 if (atomic)
e8e3c3d6 506 kunmap_atomic(src);
f6762b7a
JA
507 else
508 kunmap(page);
509
1da177e4 510 if (unlikely(error)) {
f6762b7a
JA
511 if (atomic) {
512 atomic = 0;
513 goto redo2;
514 }
341b446b 515 if (!ret)
f6762b7a 516 ret = error;
1da177e4
LT
517 break;
518 }
519 ret += chars;
520
521 /* Insert it into the buffer array */
522 buf->page = page;
523 buf->ops = &anon_pipe_buf_ops;
524 buf->offset = 0;
525 buf->len = chars;
9883035a
LT
526 buf->flags = 0;
527 if (is_packetized(filp)) {
528 buf->ops = &packet_pipe_buf_ops;
529 buf->flags = PIPE_BUF_FLAG_PACKET;
530 }
923f4f23
IM
531 pipe->nrbufs = ++bufs;
532 pipe->tmp_page = NULL;
1da177e4
LT
533
534 total_len -= chars;
535 if (!total_len)
536 break;
537 }
35f3d14d 538 if (bufs < pipe->buffers)
1da177e4
LT
539 continue;
540 if (filp->f_flags & O_NONBLOCK) {
341b446b
IM
541 if (!ret)
542 ret = -EAGAIN;
1da177e4
LT
543 break;
544 }
545 if (signal_pending(current)) {
341b446b
IM
546 if (!ret)
547 ret = -ERESTARTSYS;
1da177e4
LT
548 break;
549 }
550 if (do_wakeup) {
28e58ee8 551 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLRDNORM);
923f4f23 552 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1da177e4
LT
553 do_wakeup = 0;
554 }
923f4f23
IM
555 pipe->waiting_writers++;
556 pipe_wait(pipe);
557 pipe->waiting_writers--;
1da177e4
LT
558 }
559out:
ebec73f4 560 __pipe_unlock(pipe);
1da177e4 561 if (do_wakeup) {
28e58ee8 562 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLRDNORM);
923f4f23 563 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1da177e4 564 }
7e775f46 565 if (ret > 0 && sb_start_write_trylock(file_inode(filp)->i_sb)) {
c3b2da31
JB
566 int err = file_update_time(filp);
567 if (err)
568 ret = err;
7e775f46 569 sb_end_write(file_inode(filp)->i_sb);
c3b2da31 570 }
1da177e4
LT
571 return ret;
572}
573
d59d0b1b 574static long pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1da177e4 575{
de32ec4c 576 struct pipe_inode_info *pipe = filp->private_data;
1da177e4
LT
577 int count, buf, nrbufs;
578
579 switch (cmd) {
580 case FIONREAD:
ebec73f4 581 __pipe_lock(pipe);
1da177e4 582 count = 0;
923f4f23
IM
583 buf = pipe->curbuf;
584 nrbufs = pipe->nrbufs;
1da177e4 585 while (--nrbufs >= 0) {
923f4f23 586 count += pipe->bufs[buf].len;
35f3d14d 587 buf = (buf+1) & (pipe->buffers - 1);
1da177e4 588 }
ebec73f4 589 __pipe_unlock(pipe);
923f4f23 590
1da177e4
LT
591 return put_user(count, (int __user *)arg);
592 default:
46ce341b 593 return -ENOIOCTLCMD;
1da177e4
LT
594 }
595}
596
597/* No kernel lock held - fine */
598static unsigned int
599pipe_poll(struct file *filp, poll_table *wait)
600{
601 unsigned int mask;
de32ec4c 602 struct pipe_inode_info *pipe = filp->private_data;
1da177e4
LT
603 int nrbufs;
604
923f4f23 605 poll_wait(filp, &pipe->wait, wait);
1da177e4
LT
606
607 /* Reading only -- no need for acquiring the semaphore. */
923f4f23 608 nrbufs = pipe->nrbufs;
1da177e4
LT
609 mask = 0;
610 if (filp->f_mode & FMODE_READ) {
611 mask = (nrbufs > 0) ? POLLIN | POLLRDNORM : 0;
923f4f23 612 if (!pipe->writers && filp->f_version != pipe->w_counter)
1da177e4
LT
613 mask |= POLLHUP;
614 }
615
616 if (filp->f_mode & FMODE_WRITE) {
35f3d14d 617 mask |= (nrbufs < pipe->buffers) ? POLLOUT | POLLWRNORM : 0;
5e5d7a22
PE
618 /*
619 * Most Unices do not set POLLERR for FIFOs but on Linux they
620 * behave exactly like pipes for poll().
621 */
923f4f23 622 if (!pipe->readers)
1da177e4
LT
623 mask |= POLLERR;
624 }
625
626 return mask;
627}
628
b0d8d229
LT
629static void put_pipe_info(struct inode *inode, struct pipe_inode_info *pipe)
630{
631 int kill = 0;
632
633 spin_lock(&inode->i_lock);
634 if (!--pipe->files) {
635 inode->i_pipe = NULL;
636 kill = 1;
637 }
638 spin_unlock(&inode->i_lock);
639
640 if (kill)
641 free_pipe_info(pipe);
642}
643
1da177e4 644static int
599a0ac1 645pipe_release(struct inode *inode, struct file *file)
1da177e4 646{
b0d8d229 647 struct pipe_inode_info *pipe = file->private_data;
923f4f23 648
ebec73f4 649 __pipe_lock(pipe);
599a0ac1
AV
650 if (file->f_mode & FMODE_READ)
651 pipe->readers--;
652 if (file->f_mode & FMODE_WRITE)
653 pipe->writers--;
341b446b 654
ba5bb147 655 if (pipe->readers || pipe->writers) {
28e58ee8 656 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM | POLLERR | POLLHUP);
923f4f23
IM
657 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
658 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4 659 }
ebec73f4 660 __pipe_unlock(pipe);
ba5bb147 661
b0d8d229 662 put_pipe_info(inode, pipe);
1da177e4
LT
663 return 0;
664}
665
666static int
599a0ac1 667pipe_fasync(int fd, struct file *filp, int on)
1da177e4 668{
de32ec4c 669 struct pipe_inode_info *pipe = filp->private_data;
599a0ac1 670 int retval = 0;
1da177e4 671
ebec73f4 672 __pipe_lock(pipe);
599a0ac1
AV
673 if (filp->f_mode & FMODE_READ)
674 retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
675 if ((filp->f_mode & FMODE_WRITE) && retval >= 0) {
341b446b 676 retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
599a0ac1
AV
677 if (retval < 0 && (filp->f_mode & FMODE_READ))
678 /* this can happen only if on == T */
e5bc49ba
ON
679 fasync_helper(-1, filp, 0, &pipe->fasync_readers);
680 }
ebec73f4 681 __pipe_unlock(pipe);
60aa4924 682 return retval;
1da177e4
LT
683}
684
7bee130e 685struct pipe_inode_info *alloc_pipe_info(void)
3a326a2c 686{
923f4f23 687 struct pipe_inode_info *pipe;
3a326a2c 688
923f4f23
IM
689 pipe = kzalloc(sizeof(struct pipe_inode_info), GFP_KERNEL);
690 if (pipe) {
35f3d14d
JA
691 pipe->bufs = kzalloc(sizeof(struct pipe_buffer) * PIPE_DEF_BUFFERS, GFP_KERNEL);
692 if (pipe->bufs) {
693 init_waitqueue_head(&pipe->wait);
694 pipe->r_counter = pipe->w_counter = 1;
35f3d14d 695 pipe->buffers = PIPE_DEF_BUFFERS;
72b0d9aa 696 mutex_init(&pipe->mutex);
35f3d14d
JA
697 return pipe;
698 }
699 kfree(pipe);
3a326a2c
IM
700 }
701
35f3d14d 702 return NULL;
3a326a2c
IM
703}
704
4b8a8f1e 705void free_pipe_info(struct pipe_inode_info *pipe)
1da177e4
LT
706{
707 int i;
1da177e4 708
35f3d14d 709 for (i = 0; i < pipe->buffers; i++) {
923f4f23 710 struct pipe_buffer *buf = pipe->bufs + i;
1da177e4 711 if (buf->ops)
923f4f23 712 buf->ops->release(pipe, buf);
1da177e4 713 }
923f4f23
IM
714 if (pipe->tmp_page)
715 __free_page(pipe->tmp_page);
35f3d14d 716 kfree(pipe->bufs);
923f4f23 717 kfree(pipe);
1da177e4
LT
718}
719
fa3536cc 720static struct vfsmount *pipe_mnt __read_mostly;
341b446b 721
c23fbb6b
ED
722/*
723 * pipefs_dname() is called from d_path().
724 */
725static char *pipefs_dname(struct dentry *dentry, char *buffer, int buflen)
726{
727 return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
728 dentry->d_inode->i_ino);
729}
730
3ba13d17 731static const struct dentry_operations pipefs_dentry_operations = {
c23fbb6b 732 .d_dname = pipefs_dname,
1da177e4
LT
733};
734
735static struct inode * get_pipe_inode(void)
736{
a209dfc7 737 struct inode *inode = new_inode_pseudo(pipe_mnt->mnt_sb);
923f4f23 738 struct pipe_inode_info *pipe;
1da177e4
LT
739
740 if (!inode)
741 goto fail_inode;
742
85fe4025
CH
743 inode->i_ino = get_next_ino();
744
7bee130e 745 pipe = alloc_pipe_info();
923f4f23 746 if (!pipe)
1da177e4 747 goto fail_iput;
3a326a2c 748
ba5bb147
AV
749 inode->i_pipe = pipe;
750 pipe->files = 2;
923f4f23 751 pipe->readers = pipe->writers = 1;
599a0ac1 752 inode->i_fop = &pipefifo_fops;
1da177e4
LT
753
754 /*
755 * Mark the inode dirty from the very beginning,
756 * that way it will never be moved to the dirty
757 * list because "mark_inode_dirty()" will think
758 * that it already _is_ on the dirty list.
759 */
760 inode->i_state = I_DIRTY;
761 inode->i_mode = S_IFIFO | S_IRUSR | S_IWUSR;
da9592ed
DH
762 inode->i_uid = current_fsuid();
763 inode->i_gid = current_fsgid();
1da177e4 764 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
923f4f23 765
1da177e4
LT
766 return inode;
767
768fail_iput:
769 iput(inode);
341b446b 770
1da177e4
LT
771fail_inode:
772 return NULL;
773}
774
e4fad8e5 775int create_pipe_files(struct file **res, int flags)
1da177e4 776{
d6cbd281 777 int err;
e4fad8e5 778 struct inode *inode = get_pipe_inode();
d6cbd281 779 struct file *f;
2c48b9c4 780 struct path path;
e4fad8e5 781 static struct qstr name = { .name = "" };
1da177e4 782
1da177e4 783 if (!inode)
e4fad8e5 784 return -ENFILE;
1da177e4 785
d6cbd281 786 err = -ENOMEM;
4b936885 787 path.dentry = d_alloc_pseudo(pipe_mnt->mnt_sb, &name);
2c48b9c4 788 if (!path.dentry)
d6cbd281 789 goto err_inode;
2c48b9c4 790 path.mnt = mntget(pipe_mnt);
341b446b 791
2c48b9c4 792 d_instantiate(path.dentry, inode);
430e285e
DH
793
794 err = -ENFILE;
599a0ac1 795 f = alloc_file(&path, FMODE_WRITE, &pipefifo_fops);
39b65252 796 if (IS_ERR(f))
430e285e 797 goto err_dentry;
341b446b 798
9883035a 799 f->f_flags = O_WRONLY | (flags & (O_NONBLOCK | O_DIRECT));
de32ec4c 800 f->private_data = inode->i_pipe;
d6cbd281 801
599a0ac1 802 res[0] = alloc_file(&path, FMODE_READ, &pipefifo_fops);
39b65252 803 if (IS_ERR(res[0]))
e4fad8e5
AV
804 goto err_file;
805
806 path_get(&path);
de32ec4c 807 res[0]->private_data = inode->i_pipe;
e4fad8e5
AV
808 res[0]->f_flags = O_RDONLY | (flags & O_NONBLOCK);
809 res[1] = f;
810 return 0;
1da177e4 811
e4fad8e5
AV
812err_file:
813 put_filp(f);
814err_dentry:
4b8a8f1e 815 free_pipe_info(inode->i_pipe);
2c48b9c4 816 path_put(&path);
e4fad8e5 817 return err;
ed152437 818
e4fad8e5 819err_inode:
4b8a8f1e 820 free_pipe_info(inode->i_pipe);
1da177e4 821 iput(inode);
e4fad8e5 822 return err;
d6cbd281
AK
823}
824
5b249b1b 825static int __do_pipe_flags(int *fd, struct file **files, int flags)
d6cbd281 826{
d6cbd281
AK
827 int error;
828 int fdw, fdr;
829
9883035a 830 if (flags & ~(O_CLOEXEC | O_NONBLOCK | O_DIRECT))
ed8cae8b
UD
831 return -EINVAL;
832
e4fad8e5
AV
833 error = create_pipe_files(files, flags);
834 if (error)
835 return error;
d6cbd281 836
ed8cae8b 837 error = get_unused_fd_flags(flags);
d6cbd281
AK
838 if (error < 0)
839 goto err_read_pipe;
840 fdr = error;
841
ed8cae8b 842 error = get_unused_fd_flags(flags);
d6cbd281
AK
843 if (error < 0)
844 goto err_fdr;
845 fdw = error;
846
157cf649 847 audit_fd_pair(fdr, fdw);
d6cbd281
AK
848 fd[0] = fdr;
849 fd[1] = fdw;
d6cbd281
AK
850 return 0;
851
852 err_fdr:
853 put_unused_fd(fdr);
854 err_read_pipe:
e4fad8e5
AV
855 fput(files[0]);
856 fput(files[1]);
d6cbd281 857 return error;
1da177e4
LT
858}
859
5b249b1b
AV
860int do_pipe_flags(int *fd, int flags)
861{
862 struct file *files[2];
863 int error = __do_pipe_flags(fd, files, flags);
864 if (!error) {
865 fd_install(fd[0], files[0]);
866 fd_install(fd[1], files[1]);
867 }
868 return error;
869}
870
d35c7b0e
UD
871/*
872 * sys_pipe() is the normal C calling standard for creating
873 * a pipe. It's not the way Unix traditionally does this, though.
874 */
d4e82042 875SYSCALL_DEFINE2(pipe2, int __user *, fildes, int, flags)
d35c7b0e 876{
5b249b1b 877 struct file *files[2];
d35c7b0e
UD
878 int fd[2];
879 int error;
880
5b249b1b 881 error = __do_pipe_flags(fd, files, flags);
d35c7b0e 882 if (!error) {
5b249b1b
AV
883 if (unlikely(copy_to_user(fildes, fd, sizeof(fd)))) {
884 fput(files[0]);
885 fput(files[1]);
886 put_unused_fd(fd[0]);
887 put_unused_fd(fd[1]);
d35c7b0e 888 error = -EFAULT;
5b249b1b
AV
889 } else {
890 fd_install(fd[0], files[0]);
891 fd_install(fd[1], files[1]);
ba719bae 892 }
d35c7b0e
UD
893 }
894 return error;
895}
896
2b664219 897SYSCALL_DEFINE1(pipe, int __user *, fildes)
ed8cae8b
UD
898{
899 return sys_pipe2(fildes, 0);
900}
901
fc7478a2 902static int wait_for_partner(struct pipe_inode_info *pipe, unsigned int *cnt)
f776c738
AV
903{
904 int cur = *cnt;
905
906 while (cur == *cnt) {
fc7478a2 907 pipe_wait(pipe);
f776c738
AV
908 if (signal_pending(current))
909 break;
910 }
911 return cur == *cnt ? -ERESTARTSYS : 0;
912}
913
fc7478a2 914static void wake_up_partner(struct pipe_inode_info *pipe)
f776c738 915{
fc7478a2 916 wake_up_interruptible(&pipe->wait);
f776c738
AV
917}
918
919static int fifo_open(struct inode *inode, struct file *filp)
920{
921 struct pipe_inode_info *pipe;
599a0ac1 922 bool is_pipe = inode->i_sb->s_magic == PIPEFS_MAGIC;
f776c738
AV
923 int ret;
924
ba5bb147
AV
925 filp->f_version = 0;
926
927 spin_lock(&inode->i_lock);
928 if (inode->i_pipe) {
929 pipe = inode->i_pipe;
930 pipe->files++;
931 spin_unlock(&inode->i_lock);
932 } else {
933 spin_unlock(&inode->i_lock);
7bee130e 934 pipe = alloc_pipe_info();
f776c738 935 if (!pipe)
ba5bb147
AV
936 return -ENOMEM;
937 pipe->files = 1;
938 spin_lock(&inode->i_lock);
939 if (unlikely(inode->i_pipe)) {
940 inode->i_pipe->files++;
941 spin_unlock(&inode->i_lock);
4b8a8f1e 942 free_pipe_info(pipe);
ba5bb147
AV
943 pipe = inode->i_pipe;
944 } else {
945 inode->i_pipe = pipe;
946 spin_unlock(&inode->i_lock);
947 }
f776c738 948 }
de32ec4c 949 filp->private_data = pipe;
ba5bb147
AV
950 /* OK, we have a pipe and it's pinned down */
951
ebec73f4 952 __pipe_lock(pipe);
f776c738
AV
953
954 /* We can only do regular read/write on fifos */
955 filp->f_mode &= (FMODE_READ | FMODE_WRITE);
956
957 switch (filp->f_mode) {
958 case FMODE_READ:
959 /*
960 * O_RDONLY
961 * POSIX.1 says that O_NONBLOCK means return with the FIFO
962 * opened, even when there is no process writing the FIFO.
963 */
f776c738
AV
964 pipe->r_counter++;
965 if (pipe->readers++ == 0)
fc7478a2 966 wake_up_partner(pipe);
f776c738 967
599a0ac1 968 if (!is_pipe && !pipe->writers) {
f776c738
AV
969 if ((filp->f_flags & O_NONBLOCK)) {
970 /* suppress POLLHUP until we have
971 * seen a writer */
972 filp->f_version = pipe->w_counter;
973 } else {
fc7478a2 974 if (wait_for_partner(pipe, &pipe->w_counter))
f776c738
AV
975 goto err_rd;
976 }
977 }
978 break;
979
980 case FMODE_WRITE:
981 /*
982 * O_WRONLY
983 * POSIX.1 says that O_NONBLOCK means return -1 with
984 * errno=ENXIO when there is no process reading the FIFO.
985 */
986 ret = -ENXIO;
599a0ac1 987 if (!is_pipe && (filp->f_flags & O_NONBLOCK) && !pipe->readers)
f776c738
AV
988 goto err;
989
f776c738
AV
990 pipe->w_counter++;
991 if (!pipe->writers++)
fc7478a2 992 wake_up_partner(pipe);
f776c738 993
599a0ac1 994 if (!is_pipe && !pipe->readers) {
fc7478a2 995 if (wait_for_partner(pipe, &pipe->r_counter))
f776c738
AV
996 goto err_wr;
997 }
998 break;
999
1000 case FMODE_READ | FMODE_WRITE:
1001 /*
1002 * O_RDWR
1003 * POSIX.1 leaves this case "undefined" when O_NONBLOCK is set.
1004 * This implementation will NEVER block on a O_RDWR open, since
1005 * the process can at least talk to itself.
1006 */
f776c738
AV
1007
1008 pipe->readers++;
1009 pipe->writers++;
1010 pipe->r_counter++;
1011 pipe->w_counter++;
1012 if (pipe->readers == 1 || pipe->writers == 1)
fc7478a2 1013 wake_up_partner(pipe);
f776c738
AV
1014 break;
1015
1016 default:
1017 ret = -EINVAL;
1018 goto err;
1019 }
1020
1021 /* Ok! */
ebec73f4 1022 __pipe_unlock(pipe);
f776c738
AV
1023 return 0;
1024
1025err_rd:
1026 if (!--pipe->readers)
1027 wake_up_interruptible(&pipe->wait);
1028 ret = -ERESTARTSYS;
1029 goto err;
1030
1031err_wr:
1032 if (!--pipe->writers)
1033 wake_up_interruptible(&pipe->wait);
1034 ret = -ERESTARTSYS;
1035 goto err;
1036
1037err:
ebec73f4 1038 __pipe_unlock(pipe);
b0d8d229
LT
1039
1040 put_pipe_info(inode, pipe);
f776c738
AV
1041 return ret;
1042}
1043
599a0ac1
AV
1044const struct file_operations pipefifo_fops = {
1045 .open = fifo_open,
1046 .llseek = no_llseek,
1047 .read = do_sync_read,
1048 .aio_read = pipe_read,
1049 .write = do_sync_write,
1050 .aio_write = pipe_write,
1051 .poll = pipe_poll,
1052 .unlocked_ioctl = pipe_ioctl,
1053 .release = pipe_release,
1054 .fasync = pipe_fasync,
f776c738
AV
1055};
1056
35f3d14d
JA
1057/*
1058 * Allocate a new array of pipe buffers and copy the info over. Returns the
1059 * pipe size if successful, or return -ERROR on error.
1060 */
b9598db3 1061static long pipe_set_size(struct pipe_inode_info *pipe, unsigned long nr_pages)
35f3d14d
JA
1062{
1063 struct pipe_buffer *bufs;
1064
35f3d14d
JA
1065 /*
1066 * We can shrink the pipe, if arg >= pipe->nrbufs. Since we don't
1067 * expect a lot of shrink+grow operations, just free and allocate
1068 * again like we would do for growing. If the pipe currently
1069 * contains more buffers than arg, then return busy.
1070 */
b9598db3 1071 if (nr_pages < pipe->nrbufs)
35f3d14d
JA
1072 return -EBUSY;
1073
2ccd4f4d 1074 bufs = kcalloc(nr_pages, sizeof(*bufs), GFP_KERNEL | __GFP_NOWARN);
35f3d14d
JA
1075 if (unlikely(!bufs))
1076 return -ENOMEM;
1077
1078 /*
1079 * The pipe array wraps around, so just start the new one at zero
1080 * and adjust the indexes.
1081 */
1082 if (pipe->nrbufs) {
1d862f41
MS
1083 unsigned int tail;
1084 unsigned int head;
35f3d14d 1085
1d862f41
MS
1086 tail = pipe->curbuf + pipe->nrbufs;
1087 if (tail < pipe->buffers)
1088 tail = 0;
1089 else
1090 tail &= (pipe->buffers - 1);
1091
1092 head = pipe->nrbufs - tail;
35f3d14d
JA
1093 if (head)
1094 memcpy(bufs, pipe->bufs + pipe->curbuf, head * sizeof(struct pipe_buffer));
1095 if (tail)
1d862f41 1096 memcpy(bufs + head, pipe->bufs, tail * sizeof(struct pipe_buffer));
35f3d14d
JA
1097 }
1098
1099 pipe->curbuf = 0;
1100 kfree(pipe->bufs);
1101 pipe->bufs = bufs;
b9598db3
JA
1102 pipe->buffers = nr_pages;
1103 return nr_pages * PAGE_SIZE;
35f3d14d
JA
1104}
1105
ff9da691
JA
1106/*
1107 * Currently we rely on the pipe array holding a power-of-2 number
1108 * of pages.
1109 */
1110static inline unsigned int round_pipe_size(unsigned int size)
1111{
1112 unsigned long nr_pages;
1113
1114 nr_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
1115 return roundup_pow_of_two(nr_pages) << PAGE_SHIFT;
1116}
1117
1118/*
1119 * This should work even if CONFIG_PROC_FS isn't set, as proc_dointvec_minmax
1120 * will return an error.
1121 */
1122int pipe_proc_fn(struct ctl_table *table, int write, void __user *buf,
1123 size_t *lenp, loff_t *ppos)
1124{
1125 int ret;
1126
1127 ret = proc_dointvec_minmax(table, write, buf, lenp, ppos);
1128 if (ret < 0 || !write)
1129 return ret;
1130
1131 pipe_max_size = round_pipe_size(pipe_max_size);
1132 return ret;
1133}
1134
72083646
LT
1135/*
1136 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1137 * location, so checking ->i_pipe is not enough to verify that this is a
1138 * pipe.
1139 */
1140struct pipe_inode_info *get_pipe_info(struct file *file)
1141{
de32ec4c 1142 return file->f_op == &pipefifo_fops ? file->private_data : NULL;
72083646
LT
1143}
1144
35f3d14d
JA
1145long pipe_fcntl(struct file *file, unsigned int cmd, unsigned long arg)
1146{
1147 struct pipe_inode_info *pipe;
1148 long ret;
1149
c66fb347 1150 pipe = get_pipe_info(file);
35f3d14d
JA
1151 if (!pipe)
1152 return -EBADF;
1153
ebec73f4 1154 __pipe_lock(pipe);
35f3d14d
JA
1155
1156 switch (cmd) {
b9598db3 1157 case F_SETPIPE_SZ: {
ff9da691 1158 unsigned int size, nr_pages;
b9598db3 1159
ff9da691
JA
1160 size = round_pipe_size(arg);
1161 nr_pages = size >> PAGE_SHIFT;
b9598db3 1162
6db40cf0
MS
1163 ret = -EINVAL;
1164 if (!nr_pages)
1165 goto out;
1166
ff9da691 1167 if (!capable(CAP_SYS_RESOURCE) && size > pipe_max_size) {
b4ca7615 1168 ret = -EPERM;
cc967be5 1169 goto out;
cc967be5 1170 }
ff9da691 1171 ret = pipe_set_size(pipe, nr_pages);
35f3d14d 1172 break;
b9598db3 1173 }
35f3d14d 1174 case F_GETPIPE_SZ:
b9598db3 1175 ret = pipe->buffers * PAGE_SIZE;
35f3d14d
JA
1176 break;
1177 default:
1178 ret = -EINVAL;
1179 break;
1180 }
1181
cc967be5 1182out:
ebec73f4 1183 __pipe_unlock(pipe);
35f3d14d
JA
1184 return ret;
1185}
1186
ff0c7d15
NP
1187static const struct super_operations pipefs_ops = {
1188 .destroy_inode = free_inode_nonrcu,
d70ef97b 1189 .statfs = simple_statfs,
ff0c7d15
NP
1190};
1191
1da177e4
LT
1192/*
1193 * pipefs should _never_ be mounted by userland - too much of security hassle,
1194 * no real gain from having the whole whorehouse mounted. So we don't need
1195 * any operations on the root directory. However, we need a non-trivial
1196 * d_name - pipe: will go nicely and kill the special-casing in procfs.
1197 */
51139ada
AV
1198static struct dentry *pipefs_mount(struct file_system_type *fs_type,
1199 int flags, const char *dev_name, void *data)
1da177e4 1200{
c74a1cbb
AV
1201 return mount_pseudo(fs_type, "pipe:", &pipefs_ops,
1202 &pipefs_dentry_operations, PIPEFS_MAGIC);
1da177e4
LT
1203}
1204
1205static struct file_system_type pipe_fs_type = {
1206 .name = "pipefs",
51139ada 1207 .mount = pipefs_mount,
1da177e4
LT
1208 .kill_sb = kill_anon_super,
1209};
1210
1211static int __init init_pipe_fs(void)
1212{
1213 int err = register_filesystem(&pipe_fs_type);
341b446b 1214
1da177e4
LT
1215 if (!err) {
1216 pipe_mnt = kern_mount(&pipe_fs_type);
1217 if (IS_ERR(pipe_mnt)) {
1218 err = PTR_ERR(pipe_mnt);
1219 unregister_filesystem(&pipe_fs_type);
1220 }
1221 }
1222 return err;
1223}
1224
1da177e4 1225fs_initcall(init_pipe_fs);