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