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