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