]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/pipe.c
pipe: add pipe_buf_release() helper
[mirror_ubuntu-artful-kernel.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;
d4c3cca9 270 const struct pipe_buf_operations *ops = buf->ops;
1da177e4 271 size_t chars = buf->len;
637b58c2
AV
272 size_t written;
273 int error;
1da177e4
LT
274
275 if (chars > total_len)
276 chars = total_len;
277
cac36bb0 278 error = ops->confirm(pipe, buf);
f84d7519 279 if (error) {
5274f052 280 if (!ret)
e5953cbd 281 ret = error;
5274f052
JA
282 break;
283 }
f84d7519 284
fb9096a3 285 written = copy_page_to_iter(buf->page, buf->offset, chars, to);
637b58c2 286 if (unlikely(written < chars)) {
341b446b 287 if (!ret)
637b58c2 288 ret = -EFAULT;
1da177e4
LT
289 break;
290 }
291 ret += chars;
292 buf->offset += chars;
293 buf->len -= chars;
9883035a
LT
294
295 /* Was it a packet buffer? Clean up and exit */
296 if (buf->flags & PIPE_BUF_FLAG_PACKET) {
297 total_len = chars;
298 buf->len = 0;
299 }
300
1da177e4 301 if (!buf->len) {
a779638c 302 pipe_buf_release(pipe, buf);
35f3d14d 303 curbuf = (curbuf + 1) & (pipe->buffers - 1);
923f4f23
IM
304 pipe->curbuf = curbuf;
305 pipe->nrbufs = --bufs;
1da177e4
LT
306 do_wakeup = 1;
307 }
308 total_len -= chars;
309 if (!total_len)
310 break; /* common path: read succeeded */
311 }
312 if (bufs) /* More to do? */
313 continue;
923f4f23 314 if (!pipe->writers)
1da177e4 315 break;
923f4f23 316 if (!pipe->waiting_writers) {
1da177e4
LT
317 /* syscall merging: Usually we must not sleep
318 * if O_NONBLOCK is set, or if we got some data.
319 * But if a writer sleeps in kernel space, then
320 * we can wait for that data without violating POSIX.
321 */
322 if (ret)
323 break;
324 if (filp->f_flags & O_NONBLOCK) {
325 ret = -EAGAIN;
326 break;
327 }
328 }
329 if (signal_pending(current)) {
341b446b
IM
330 if (!ret)
331 ret = -ERESTARTSYS;
1da177e4
LT
332 break;
333 }
334 if (do_wakeup) {
28e58ee8 335 wake_up_interruptible_sync_poll(&pipe->wait, POLLOUT | POLLWRNORM);
923f4f23 336 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4 337 }
923f4f23 338 pipe_wait(pipe);
1da177e4 339 }
ebec73f4 340 __pipe_unlock(pipe);
341b446b
IM
341
342 /* Signal writers asynchronously that there is more room. */
1da177e4 343 if (do_wakeup) {
28e58ee8 344 wake_up_interruptible_sync_poll(&pipe->wait, POLLOUT | POLLWRNORM);
923f4f23 345 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4
LT
346 }
347 if (ret > 0)
348 file_accessed(filp);
349 return ret;
350}
351
9883035a
LT
352static inline int is_packetized(struct file *file)
353{
354 return (file->f_flags & O_DIRECT) != 0;
355}
356
1da177e4 357static ssize_t
f0d1bec9 358pipe_write(struct kiocb *iocb, struct iov_iter *from)
1da177e4 359{
ee0b3e67 360 struct file *filp = iocb->ki_filp;
de32ec4c 361 struct pipe_inode_info *pipe = filp->private_data;
f0d1bec9
AV
362 ssize_t ret = 0;
363 int do_wakeup = 0;
364 size_t total_len = iov_iter_count(from);
1da177e4
LT
365 ssize_t chars;
366
1da177e4
LT
367 /* Null write succeeds. */
368 if (unlikely(total_len == 0))
369 return 0;
370
ebec73f4 371 __pipe_lock(pipe);
1da177e4 372
923f4f23 373 if (!pipe->readers) {
1da177e4
LT
374 send_sig(SIGPIPE, current, 0);
375 ret = -EPIPE;
376 goto out;
377 }
378
379 /* We try to merge small writes */
380 chars = total_len & (PAGE_SIZE-1); /* size of the last buffer */
923f4f23 381 if (pipe->nrbufs && chars != 0) {
341b446b 382 int lastbuf = (pipe->curbuf + pipe->nrbufs - 1) &
35f3d14d 383 (pipe->buffers - 1);
923f4f23 384 struct pipe_buffer *buf = pipe->bufs + lastbuf;
d4c3cca9 385 const struct pipe_buf_operations *ops = buf->ops;
1da177e4 386 int offset = buf->offset + buf->len;
341b446b 387
1da177e4 388 if (ops->can_merge && offset + chars <= PAGE_SIZE) {
6ae08069
EB
389 ret = ops->confirm(pipe, buf);
390 if (ret)
5274f052 391 goto out;
f84d7519 392
f0d1bec9
AV
393 ret = copy_page_from_iter(buf->page, offset, chars, from);
394 if (unlikely(ret < chars)) {
6ae08069 395 ret = -EFAULT;
1da177e4 396 goto out;
f6762b7a 397 }
f0d1bec9 398 do_wakeup = 1;
6ae08069 399 buf->len += ret;
f0d1bec9 400 if (!iov_iter_count(from))
1da177e4
LT
401 goto out;
402 }
403 }
404
405 for (;;) {
406 int bufs;
341b446b 407
923f4f23 408 if (!pipe->readers) {
1da177e4 409 send_sig(SIGPIPE, current, 0);
341b446b
IM
410 if (!ret)
411 ret = -EPIPE;
1da177e4
LT
412 break;
413 }
923f4f23 414 bufs = pipe->nrbufs;
35f3d14d
JA
415 if (bufs < pipe->buffers) {
416 int newbuf = (pipe->curbuf + bufs) & (pipe->buffers-1);
923f4f23
IM
417 struct pipe_buffer *buf = pipe->bufs + newbuf;
418 struct page *page = pipe->tmp_page;
f0d1bec9 419 int copied;
1da177e4
LT
420
421 if (!page) {
d86133bd 422 page = alloc_page(GFP_HIGHUSER | __GFP_ACCOUNT);
1da177e4
LT
423 if (unlikely(!page)) {
424 ret = ret ? : -ENOMEM;
425 break;
426 }
923f4f23 427 pipe->tmp_page = page;
1da177e4 428 }
341b446b 429 /* Always wake up, even if the copy fails. Otherwise
1da177e4
LT
430 * we lock up (O_NONBLOCK-)readers that sleep due to
431 * syscall merging.
432 * FIXME! Is this really true?
433 */
434 do_wakeup = 1;
f0d1bec9
AV
435 copied = copy_page_from_iter(page, 0, PAGE_SIZE, from);
436 if (unlikely(copied < PAGE_SIZE && iov_iter_count(from))) {
341b446b 437 if (!ret)
f0d1bec9 438 ret = -EFAULT;
1da177e4
LT
439 break;
440 }
f0d1bec9 441 ret += copied;
1da177e4
LT
442
443 /* Insert it into the buffer array */
444 buf->page = page;
445 buf->ops = &anon_pipe_buf_ops;
446 buf->offset = 0;
f0d1bec9 447 buf->len = copied;
9883035a
LT
448 buf->flags = 0;
449 if (is_packetized(filp)) {
450 buf->ops = &packet_pipe_buf_ops;
451 buf->flags = PIPE_BUF_FLAG_PACKET;
452 }
923f4f23
IM
453 pipe->nrbufs = ++bufs;
454 pipe->tmp_page = NULL;
1da177e4 455
f0d1bec9 456 if (!iov_iter_count(from))
1da177e4
LT
457 break;
458 }
35f3d14d 459 if (bufs < pipe->buffers)
1da177e4
LT
460 continue;
461 if (filp->f_flags & O_NONBLOCK) {
341b446b
IM
462 if (!ret)
463 ret = -EAGAIN;
1da177e4
LT
464 break;
465 }
466 if (signal_pending(current)) {
341b446b
IM
467 if (!ret)
468 ret = -ERESTARTSYS;
1da177e4
LT
469 break;
470 }
471 if (do_wakeup) {
28e58ee8 472 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLRDNORM);
923f4f23 473 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1da177e4
LT
474 do_wakeup = 0;
475 }
923f4f23
IM
476 pipe->waiting_writers++;
477 pipe_wait(pipe);
478 pipe->waiting_writers--;
1da177e4
LT
479 }
480out:
ebec73f4 481 __pipe_unlock(pipe);
1da177e4 482 if (do_wakeup) {
28e58ee8 483 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLRDNORM);
923f4f23 484 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
1da177e4 485 }
7e775f46 486 if (ret > 0 && sb_start_write_trylock(file_inode(filp)->i_sb)) {
c3b2da31
JB
487 int err = file_update_time(filp);
488 if (err)
489 ret = err;
7e775f46 490 sb_end_write(file_inode(filp)->i_sb);
c3b2da31 491 }
1da177e4
LT
492 return ret;
493}
494
d59d0b1b 495static long pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1da177e4 496{
de32ec4c 497 struct pipe_inode_info *pipe = filp->private_data;
1da177e4
LT
498 int count, buf, nrbufs;
499
500 switch (cmd) {
501 case FIONREAD:
ebec73f4 502 __pipe_lock(pipe);
1da177e4 503 count = 0;
923f4f23
IM
504 buf = pipe->curbuf;
505 nrbufs = pipe->nrbufs;
1da177e4 506 while (--nrbufs >= 0) {
923f4f23 507 count += pipe->bufs[buf].len;
35f3d14d 508 buf = (buf+1) & (pipe->buffers - 1);
1da177e4 509 }
ebec73f4 510 __pipe_unlock(pipe);
923f4f23 511
1da177e4
LT
512 return put_user(count, (int __user *)arg);
513 default:
46ce341b 514 return -ENOIOCTLCMD;
1da177e4
LT
515 }
516}
517
518/* No kernel lock held - fine */
519static unsigned int
520pipe_poll(struct file *filp, poll_table *wait)
521{
522 unsigned int mask;
de32ec4c 523 struct pipe_inode_info *pipe = filp->private_data;
1da177e4
LT
524 int nrbufs;
525
923f4f23 526 poll_wait(filp, &pipe->wait, wait);
1da177e4
LT
527
528 /* Reading only -- no need for acquiring the semaphore. */
923f4f23 529 nrbufs = pipe->nrbufs;
1da177e4
LT
530 mask = 0;
531 if (filp->f_mode & FMODE_READ) {
532 mask = (nrbufs > 0) ? POLLIN | POLLRDNORM : 0;
923f4f23 533 if (!pipe->writers && filp->f_version != pipe->w_counter)
1da177e4
LT
534 mask |= POLLHUP;
535 }
536
537 if (filp->f_mode & FMODE_WRITE) {
35f3d14d 538 mask |= (nrbufs < pipe->buffers) ? POLLOUT | POLLWRNORM : 0;
5e5d7a22
PE
539 /*
540 * Most Unices do not set POLLERR for FIFOs but on Linux they
541 * behave exactly like pipes for poll().
542 */
923f4f23 543 if (!pipe->readers)
1da177e4
LT
544 mask |= POLLERR;
545 }
546
547 return mask;
548}
549
b0d8d229
LT
550static void put_pipe_info(struct inode *inode, struct pipe_inode_info *pipe)
551{
552 int kill = 0;
553
554 spin_lock(&inode->i_lock);
555 if (!--pipe->files) {
556 inode->i_pipe = NULL;
557 kill = 1;
558 }
559 spin_unlock(&inode->i_lock);
560
561 if (kill)
562 free_pipe_info(pipe);
563}
564
1da177e4 565static int
599a0ac1 566pipe_release(struct inode *inode, struct file *file)
1da177e4 567{
b0d8d229 568 struct pipe_inode_info *pipe = file->private_data;
923f4f23 569
ebec73f4 570 __pipe_lock(pipe);
599a0ac1
AV
571 if (file->f_mode & FMODE_READ)
572 pipe->readers--;
573 if (file->f_mode & FMODE_WRITE)
574 pipe->writers--;
341b446b 575
ba5bb147 576 if (pipe->readers || pipe->writers) {
28e58ee8 577 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM | POLLERR | POLLHUP);
923f4f23
IM
578 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
579 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
1da177e4 580 }
ebec73f4 581 __pipe_unlock(pipe);
ba5bb147 582
b0d8d229 583 put_pipe_info(inode, pipe);
1da177e4
LT
584 return 0;
585}
586
587static int
599a0ac1 588pipe_fasync(int fd, struct file *filp, int on)
1da177e4 589{
de32ec4c 590 struct pipe_inode_info *pipe = filp->private_data;
599a0ac1 591 int retval = 0;
1da177e4 592
ebec73f4 593 __pipe_lock(pipe);
599a0ac1
AV
594 if (filp->f_mode & FMODE_READ)
595 retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
596 if ((filp->f_mode & FMODE_WRITE) && retval >= 0) {
341b446b 597 retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
599a0ac1
AV
598 if (retval < 0 && (filp->f_mode & FMODE_READ))
599 /* this can happen only if on == T */
e5bc49ba
ON
600 fasync_helper(-1, filp, 0, &pipe->fasync_readers);
601 }
ebec73f4 602 __pipe_unlock(pipe);
60aa4924 603 return retval;
1da177e4
LT
604}
605
759c0114
WT
606static void account_pipe_buffers(struct pipe_inode_info *pipe,
607 unsigned long old, unsigned long new)
608{
609 atomic_long_add(new - old, &pipe->user->pipe_bufs);
610}
611
612static bool too_many_pipe_buffers_soft(struct user_struct *user)
613{
614 return pipe_user_pages_soft &&
615 atomic_long_read(&user->pipe_bufs) >= pipe_user_pages_soft;
616}
617
618static bool too_many_pipe_buffers_hard(struct user_struct *user)
619{
620 return pipe_user_pages_hard &&
621 atomic_long_read(&user->pipe_bufs) >= pipe_user_pages_hard;
622}
623
7bee130e 624struct pipe_inode_info *alloc_pipe_info(void)
3a326a2c 625{
923f4f23 626 struct pipe_inode_info *pipe;
3a326a2c 627
d86133bd 628 pipe = kzalloc(sizeof(struct pipe_inode_info), GFP_KERNEL_ACCOUNT);
923f4f23 629 if (pipe) {
759c0114
WT
630 unsigned long pipe_bufs = PIPE_DEF_BUFFERS;
631 struct user_struct *user = get_current_user();
632
633 if (!too_many_pipe_buffers_hard(user)) {
634 if (too_many_pipe_buffers_soft(user))
635 pipe_bufs = 1;
d86133bd
VD
636 pipe->bufs = kcalloc(pipe_bufs,
637 sizeof(struct pipe_buffer),
638 GFP_KERNEL_ACCOUNT);
759c0114
WT
639 }
640
35f3d14d
JA
641 if (pipe->bufs) {
642 init_waitqueue_head(&pipe->wait);
643 pipe->r_counter = pipe->w_counter = 1;
759c0114
WT
644 pipe->buffers = pipe_bufs;
645 pipe->user = user;
646 account_pipe_buffers(pipe, 0, pipe_bufs);
72b0d9aa 647 mutex_init(&pipe->mutex);
35f3d14d
JA
648 return pipe;
649 }
759c0114 650 free_uid(user);
35f3d14d 651 kfree(pipe);
3a326a2c
IM
652 }
653
35f3d14d 654 return NULL;
3a326a2c
IM
655}
656
4b8a8f1e 657void free_pipe_info(struct pipe_inode_info *pipe)
1da177e4
LT
658{
659 int i;
1da177e4 660
759c0114
WT
661 account_pipe_buffers(pipe, pipe->buffers, 0);
662 free_uid(pipe->user);
35f3d14d 663 for (i = 0; i < pipe->buffers; i++) {
923f4f23 664 struct pipe_buffer *buf = pipe->bufs + i;
1da177e4 665 if (buf->ops)
a779638c 666 pipe_buf_release(pipe, buf);
1da177e4 667 }
923f4f23
IM
668 if (pipe->tmp_page)
669 __free_page(pipe->tmp_page);
35f3d14d 670 kfree(pipe->bufs);
923f4f23 671 kfree(pipe);
1da177e4
LT
672}
673
fa3536cc 674static struct vfsmount *pipe_mnt __read_mostly;
341b446b 675
c23fbb6b
ED
676/*
677 * pipefs_dname() is called from d_path().
678 */
679static char *pipefs_dname(struct dentry *dentry, char *buffer, int buflen)
680{
681 return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
75c3cfa8 682 d_inode(dentry)->i_ino);
c23fbb6b
ED
683}
684
3ba13d17 685static const struct dentry_operations pipefs_dentry_operations = {
c23fbb6b 686 .d_dname = pipefs_dname,
1da177e4
LT
687};
688
689static struct inode * get_pipe_inode(void)
690{
a209dfc7 691 struct inode *inode = new_inode_pseudo(pipe_mnt->mnt_sb);
923f4f23 692 struct pipe_inode_info *pipe;
1da177e4
LT
693
694 if (!inode)
695 goto fail_inode;
696
85fe4025
CH
697 inode->i_ino = get_next_ino();
698
7bee130e 699 pipe = alloc_pipe_info();
923f4f23 700 if (!pipe)
1da177e4 701 goto fail_iput;
3a326a2c 702
ba5bb147
AV
703 inode->i_pipe = pipe;
704 pipe->files = 2;
923f4f23 705 pipe->readers = pipe->writers = 1;
599a0ac1 706 inode->i_fop = &pipefifo_fops;
1da177e4
LT
707
708 /*
709 * Mark the inode dirty from the very beginning,
710 * that way it will never be moved to the dirty
711 * list because "mark_inode_dirty()" will think
712 * that it already _is_ on the dirty list.
713 */
714 inode->i_state = I_DIRTY;
715 inode->i_mode = S_IFIFO | S_IRUSR | S_IWUSR;
da9592ed
DH
716 inode->i_uid = current_fsuid();
717 inode->i_gid = current_fsgid();
1da177e4 718 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
923f4f23 719
1da177e4
LT
720 return inode;
721
722fail_iput:
723 iput(inode);
341b446b 724
1da177e4
LT
725fail_inode:
726 return NULL;
727}
728
e4fad8e5 729int create_pipe_files(struct file **res, int flags)
1da177e4 730{
d6cbd281 731 int err;
e4fad8e5 732 struct inode *inode = get_pipe_inode();
d6cbd281 733 struct file *f;
2c48b9c4 734 struct path path;
e4fad8e5 735 static struct qstr name = { .name = "" };
1da177e4 736
1da177e4 737 if (!inode)
e4fad8e5 738 return -ENFILE;
1da177e4 739
d6cbd281 740 err = -ENOMEM;
4b936885 741 path.dentry = d_alloc_pseudo(pipe_mnt->mnt_sb, &name);
2c48b9c4 742 if (!path.dentry)
d6cbd281 743 goto err_inode;
2c48b9c4 744 path.mnt = mntget(pipe_mnt);
341b446b 745
2c48b9c4 746 d_instantiate(path.dentry, inode);
430e285e 747
599a0ac1 748 f = alloc_file(&path, FMODE_WRITE, &pipefifo_fops);
e9bb1f9b
EB
749 if (IS_ERR(f)) {
750 err = PTR_ERR(f);
430e285e 751 goto err_dentry;
e9bb1f9b 752 }
341b446b 753
9883035a 754 f->f_flags = O_WRONLY | (flags & (O_NONBLOCK | O_DIRECT));
de32ec4c 755 f->private_data = inode->i_pipe;
d6cbd281 756
599a0ac1 757 res[0] = alloc_file(&path, FMODE_READ, &pipefifo_fops);
e9bb1f9b
EB
758 if (IS_ERR(res[0])) {
759 err = PTR_ERR(res[0]);
e4fad8e5 760 goto err_file;
e9bb1f9b 761 }
e4fad8e5
AV
762
763 path_get(&path);
de32ec4c 764 res[0]->private_data = inode->i_pipe;
e4fad8e5
AV
765 res[0]->f_flags = O_RDONLY | (flags & O_NONBLOCK);
766 res[1] = f;
767 return 0;
1da177e4 768
e4fad8e5
AV
769err_file:
770 put_filp(f);
771err_dentry:
4b8a8f1e 772 free_pipe_info(inode->i_pipe);
2c48b9c4 773 path_put(&path);
e4fad8e5 774 return err;
ed152437 775
e4fad8e5 776err_inode:
4b8a8f1e 777 free_pipe_info(inode->i_pipe);
1da177e4 778 iput(inode);
e4fad8e5 779 return err;
d6cbd281
AK
780}
781
5b249b1b 782static int __do_pipe_flags(int *fd, struct file **files, int flags)
d6cbd281 783{
d6cbd281
AK
784 int error;
785 int fdw, fdr;
786
9883035a 787 if (flags & ~(O_CLOEXEC | O_NONBLOCK | O_DIRECT))
ed8cae8b
UD
788 return -EINVAL;
789
e4fad8e5
AV
790 error = create_pipe_files(files, flags);
791 if (error)
792 return error;
d6cbd281 793
ed8cae8b 794 error = get_unused_fd_flags(flags);
d6cbd281
AK
795 if (error < 0)
796 goto err_read_pipe;
797 fdr = error;
798
ed8cae8b 799 error = get_unused_fd_flags(flags);
d6cbd281
AK
800 if (error < 0)
801 goto err_fdr;
802 fdw = error;
803
157cf649 804 audit_fd_pair(fdr, fdw);
d6cbd281
AK
805 fd[0] = fdr;
806 fd[1] = fdw;
d6cbd281
AK
807 return 0;
808
809 err_fdr:
810 put_unused_fd(fdr);
811 err_read_pipe:
e4fad8e5
AV
812 fput(files[0]);
813 fput(files[1]);
d6cbd281 814 return error;
1da177e4
LT
815}
816
5b249b1b
AV
817int do_pipe_flags(int *fd, int flags)
818{
819 struct file *files[2];
820 int error = __do_pipe_flags(fd, files, flags);
821 if (!error) {
822 fd_install(fd[0], files[0]);
823 fd_install(fd[1], files[1]);
824 }
825 return error;
826}
827
d35c7b0e
UD
828/*
829 * sys_pipe() is the normal C calling standard for creating
830 * a pipe. It's not the way Unix traditionally does this, though.
831 */
d4e82042 832SYSCALL_DEFINE2(pipe2, int __user *, fildes, int, flags)
d35c7b0e 833{
5b249b1b 834 struct file *files[2];
d35c7b0e
UD
835 int fd[2];
836 int error;
837
5b249b1b 838 error = __do_pipe_flags(fd, files, flags);
d35c7b0e 839 if (!error) {
5b249b1b
AV
840 if (unlikely(copy_to_user(fildes, fd, sizeof(fd)))) {
841 fput(files[0]);
842 fput(files[1]);
843 put_unused_fd(fd[0]);
844 put_unused_fd(fd[1]);
d35c7b0e 845 error = -EFAULT;
5b249b1b
AV
846 } else {
847 fd_install(fd[0], files[0]);
848 fd_install(fd[1], files[1]);
ba719bae 849 }
d35c7b0e
UD
850 }
851 return error;
852}
853
2b664219 854SYSCALL_DEFINE1(pipe, int __user *, fildes)
ed8cae8b
UD
855{
856 return sys_pipe2(fildes, 0);
857}
858
fc7478a2 859static int wait_for_partner(struct pipe_inode_info *pipe, unsigned int *cnt)
f776c738
AV
860{
861 int cur = *cnt;
862
863 while (cur == *cnt) {
fc7478a2 864 pipe_wait(pipe);
f776c738
AV
865 if (signal_pending(current))
866 break;
867 }
868 return cur == *cnt ? -ERESTARTSYS : 0;
869}
870
fc7478a2 871static void wake_up_partner(struct pipe_inode_info *pipe)
f776c738 872{
fc7478a2 873 wake_up_interruptible(&pipe->wait);
f776c738
AV
874}
875
876static int fifo_open(struct inode *inode, struct file *filp)
877{
878 struct pipe_inode_info *pipe;
599a0ac1 879 bool is_pipe = inode->i_sb->s_magic == PIPEFS_MAGIC;
f776c738
AV
880 int ret;
881
ba5bb147
AV
882 filp->f_version = 0;
883
884 spin_lock(&inode->i_lock);
885 if (inode->i_pipe) {
886 pipe = inode->i_pipe;
887 pipe->files++;
888 spin_unlock(&inode->i_lock);
889 } else {
890 spin_unlock(&inode->i_lock);
7bee130e 891 pipe = alloc_pipe_info();
f776c738 892 if (!pipe)
ba5bb147
AV
893 return -ENOMEM;
894 pipe->files = 1;
895 spin_lock(&inode->i_lock);
896 if (unlikely(inode->i_pipe)) {
897 inode->i_pipe->files++;
898 spin_unlock(&inode->i_lock);
4b8a8f1e 899 free_pipe_info(pipe);
ba5bb147
AV
900 pipe = inode->i_pipe;
901 } else {
902 inode->i_pipe = pipe;
903 spin_unlock(&inode->i_lock);
904 }
f776c738 905 }
de32ec4c 906 filp->private_data = pipe;
ba5bb147
AV
907 /* OK, we have a pipe and it's pinned down */
908
ebec73f4 909 __pipe_lock(pipe);
f776c738
AV
910
911 /* We can only do regular read/write on fifos */
912 filp->f_mode &= (FMODE_READ | FMODE_WRITE);
913
914 switch (filp->f_mode) {
915 case FMODE_READ:
916 /*
917 * O_RDONLY
918 * POSIX.1 says that O_NONBLOCK means return with the FIFO
919 * opened, even when there is no process writing the FIFO.
920 */
f776c738
AV
921 pipe->r_counter++;
922 if (pipe->readers++ == 0)
fc7478a2 923 wake_up_partner(pipe);
f776c738 924
599a0ac1 925 if (!is_pipe && !pipe->writers) {
f776c738
AV
926 if ((filp->f_flags & O_NONBLOCK)) {
927 /* suppress POLLHUP until we have
928 * seen a writer */
929 filp->f_version = pipe->w_counter;
930 } else {
fc7478a2 931 if (wait_for_partner(pipe, &pipe->w_counter))
f776c738
AV
932 goto err_rd;
933 }
934 }
935 break;
936
937 case FMODE_WRITE:
938 /*
939 * O_WRONLY
940 * POSIX.1 says that O_NONBLOCK means return -1 with
941 * errno=ENXIO when there is no process reading the FIFO.
942 */
943 ret = -ENXIO;
599a0ac1 944 if (!is_pipe && (filp->f_flags & O_NONBLOCK) && !pipe->readers)
f776c738
AV
945 goto err;
946
f776c738
AV
947 pipe->w_counter++;
948 if (!pipe->writers++)
fc7478a2 949 wake_up_partner(pipe);
f776c738 950
599a0ac1 951 if (!is_pipe && !pipe->readers) {
fc7478a2 952 if (wait_for_partner(pipe, &pipe->r_counter))
f776c738
AV
953 goto err_wr;
954 }
955 break;
956
957 case FMODE_READ | FMODE_WRITE:
958 /*
959 * O_RDWR
960 * POSIX.1 leaves this case "undefined" when O_NONBLOCK is set.
961 * This implementation will NEVER block on a O_RDWR open, since
962 * the process can at least talk to itself.
963 */
f776c738
AV
964
965 pipe->readers++;
966 pipe->writers++;
967 pipe->r_counter++;
968 pipe->w_counter++;
969 if (pipe->readers == 1 || pipe->writers == 1)
fc7478a2 970 wake_up_partner(pipe);
f776c738
AV
971 break;
972
973 default:
974 ret = -EINVAL;
975 goto err;
976 }
977
978 /* Ok! */
ebec73f4 979 __pipe_unlock(pipe);
f776c738
AV
980 return 0;
981
982err_rd:
983 if (!--pipe->readers)
984 wake_up_interruptible(&pipe->wait);
985 ret = -ERESTARTSYS;
986 goto err;
987
988err_wr:
989 if (!--pipe->writers)
990 wake_up_interruptible(&pipe->wait);
991 ret = -ERESTARTSYS;
992 goto err;
993
994err:
ebec73f4 995 __pipe_unlock(pipe);
b0d8d229
LT
996
997 put_pipe_info(inode, pipe);
f776c738
AV
998 return ret;
999}
1000
599a0ac1
AV
1001const struct file_operations pipefifo_fops = {
1002 .open = fifo_open,
1003 .llseek = no_llseek,
fb9096a3 1004 .read_iter = pipe_read,
f0d1bec9 1005 .write_iter = pipe_write,
599a0ac1
AV
1006 .poll = pipe_poll,
1007 .unlocked_ioctl = pipe_ioctl,
1008 .release = pipe_release,
1009 .fasync = pipe_fasync,
f776c738
AV
1010};
1011
35f3d14d
JA
1012/*
1013 * Allocate a new array of pipe buffers and copy the info over. Returns the
1014 * pipe size if successful, or return -ERROR on error.
1015 */
b9598db3 1016static long pipe_set_size(struct pipe_inode_info *pipe, unsigned long nr_pages)
35f3d14d
JA
1017{
1018 struct pipe_buffer *bufs;
1019
35f3d14d
JA
1020 /*
1021 * We can shrink the pipe, if arg >= pipe->nrbufs. Since we don't
1022 * expect a lot of shrink+grow operations, just free and allocate
1023 * again like we would do for growing. If the pipe currently
1024 * contains more buffers than arg, then return busy.
1025 */
b9598db3 1026 if (nr_pages < pipe->nrbufs)
35f3d14d
JA
1027 return -EBUSY;
1028
d86133bd
VD
1029 bufs = kcalloc(nr_pages, sizeof(*bufs),
1030 GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
35f3d14d
JA
1031 if (unlikely(!bufs))
1032 return -ENOMEM;
1033
1034 /*
1035 * The pipe array wraps around, so just start the new one at zero
1036 * and adjust the indexes.
1037 */
1038 if (pipe->nrbufs) {
1d862f41
MS
1039 unsigned int tail;
1040 unsigned int head;
35f3d14d 1041
1d862f41
MS
1042 tail = pipe->curbuf + pipe->nrbufs;
1043 if (tail < pipe->buffers)
1044 tail = 0;
1045 else
1046 tail &= (pipe->buffers - 1);
1047
1048 head = pipe->nrbufs - tail;
35f3d14d
JA
1049 if (head)
1050 memcpy(bufs, pipe->bufs + pipe->curbuf, head * sizeof(struct pipe_buffer));
1051 if (tail)
1d862f41 1052 memcpy(bufs + head, pipe->bufs, tail * sizeof(struct pipe_buffer));
35f3d14d
JA
1053 }
1054
759c0114 1055 account_pipe_buffers(pipe, pipe->buffers, nr_pages);
35f3d14d
JA
1056 pipe->curbuf = 0;
1057 kfree(pipe->bufs);
1058 pipe->bufs = bufs;
b9598db3
JA
1059 pipe->buffers = nr_pages;
1060 return nr_pages * PAGE_SIZE;
35f3d14d
JA
1061}
1062
ff9da691
JA
1063/*
1064 * Currently we rely on the pipe array holding a power-of-2 number
1065 * of pages.
1066 */
1067static inline unsigned int round_pipe_size(unsigned int size)
1068{
1069 unsigned long nr_pages;
1070
1071 nr_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
1072 return roundup_pow_of_two(nr_pages) << PAGE_SHIFT;
1073}
1074
1075/*
1076 * This should work even if CONFIG_PROC_FS isn't set, as proc_dointvec_minmax
1077 * will return an error.
1078 */
1079int pipe_proc_fn(struct ctl_table *table, int write, void __user *buf,
1080 size_t *lenp, loff_t *ppos)
1081{
1082 int ret;
1083
1084 ret = proc_dointvec_minmax(table, write, buf, lenp, ppos);
1085 if (ret < 0 || !write)
1086 return ret;
1087
1088 pipe_max_size = round_pipe_size(pipe_max_size);
1089 return ret;
1090}
1091
72083646
LT
1092/*
1093 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1094 * location, so checking ->i_pipe is not enough to verify that this is a
1095 * pipe.
1096 */
1097struct pipe_inode_info *get_pipe_info(struct file *file)
1098{
de32ec4c 1099 return file->f_op == &pipefifo_fops ? file->private_data : NULL;
72083646
LT
1100}
1101
35f3d14d
JA
1102long pipe_fcntl(struct file *file, unsigned int cmd, unsigned long arg)
1103{
1104 struct pipe_inode_info *pipe;
1105 long ret;
1106
c66fb347 1107 pipe = get_pipe_info(file);
35f3d14d
JA
1108 if (!pipe)
1109 return -EBADF;
1110
ebec73f4 1111 __pipe_lock(pipe);
35f3d14d
JA
1112
1113 switch (cmd) {
b9598db3 1114 case F_SETPIPE_SZ: {
ff9da691 1115 unsigned int size, nr_pages;
b9598db3 1116
ff9da691
JA
1117 size = round_pipe_size(arg);
1118 nr_pages = size >> PAGE_SHIFT;
b9598db3 1119
6db40cf0
MS
1120 ret = -EINVAL;
1121 if (!nr_pages)
1122 goto out;
1123
ff9da691 1124 if (!capable(CAP_SYS_RESOURCE) && size > pipe_max_size) {
b4ca7615 1125 ret = -EPERM;
cc967be5 1126 goto out;
759c0114
WT
1127 } else if ((too_many_pipe_buffers_hard(pipe->user) ||
1128 too_many_pipe_buffers_soft(pipe->user)) &&
1129 !capable(CAP_SYS_RESOURCE) && !capable(CAP_SYS_ADMIN)) {
1130 ret = -EPERM;
1131 goto out;
cc967be5 1132 }
ff9da691 1133 ret = pipe_set_size(pipe, nr_pages);
35f3d14d 1134 break;
b9598db3 1135 }
35f3d14d 1136 case F_GETPIPE_SZ:
b9598db3 1137 ret = pipe->buffers * PAGE_SIZE;
35f3d14d
JA
1138 break;
1139 default:
1140 ret = -EINVAL;
1141 break;
1142 }
1143
cc967be5 1144out:
ebec73f4 1145 __pipe_unlock(pipe);
35f3d14d
JA
1146 return ret;
1147}
1148
ff0c7d15
NP
1149static const struct super_operations pipefs_ops = {
1150 .destroy_inode = free_inode_nonrcu,
d70ef97b 1151 .statfs = simple_statfs,
ff0c7d15
NP
1152};
1153
1da177e4
LT
1154/*
1155 * pipefs should _never_ be mounted by userland - too much of security hassle,
1156 * no real gain from having the whole whorehouse mounted. So we don't need
1157 * any operations on the root directory. However, we need a non-trivial
1158 * d_name - pipe: will go nicely and kill the special-casing in procfs.
1159 */
51139ada
AV
1160static struct dentry *pipefs_mount(struct file_system_type *fs_type,
1161 int flags, const char *dev_name, void *data)
1da177e4 1162{
c74a1cbb
AV
1163 return mount_pseudo(fs_type, "pipe:", &pipefs_ops,
1164 &pipefs_dentry_operations, PIPEFS_MAGIC);
1da177e4
LT
1165}
1166
1167static struct file_system_type pipe_fs_type = {
1168 .name = "pipefs",
51139ada 1169 .mount = pipefs_mount,
1da177e4
LT
1170 .kill_sb = kill_anon_super,
1171};
1172
1173static int __init init_pipe_fs(void)
1174{
1175 int err = register_filesystem(&pipe_fs_type);
341b446b 1176
1da177e4
LT
1177 if (!err) {
1178 pipe_mnt = kern_mount(&pipe_fs_type);
1179 if (IS_ERR(pipe_mnt)) {
1180 err = PTR_ERR(pipe_mnt);
1181 unregister_filesystem(&pipe_fs_type);
1182 }
1183 }
1184 return err;
1185}
1186
1da177e4 1187fs_initcall(init_pipe_fs);