blob: dc5f4c040890e9c53ff888623068cc376b2da496 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Jens Axboe35f3d142010-05-20 10:43:18 +020014#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/mount.h>
Muthu Kumarb502bd12012-03-23 15:01:50 -070016#include <linux/magic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/pipe_fs_i.h>
18#include <linux/uio.h>
19#include <linux/highmem.h>
Jens Axboe5274f052006-03-30 15:15:30 +020020#include <linux/pagemap.h>
Al Virodb349502007-02-07 01:48:00 -050021#include <linux/audit.h>
Ulrich Drepperba719ba2008-05-06 20:42:38 -070022#include <linux/syscalls.h>
Jens Axboeb492e952010-05-19 21:03:16 +020023#include <linux/fcntl.h>
Vladimir Davydovd86133b2016-07-26 15:24:33 -070024#include <linux/memcontrol.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <asm/uaccess.h>
27#include <asm/ioctls.h>
28
Al Viro599a0ac2013-03-12 09:58:10 -040029#include "internal.h"
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/*
Jens Axboeb492e952010-05-19 21:03:16 +020032 * The max size that a non-root user is allowed to grow the pipe. Can
Jens Axboeff9da692010-06-03 14:54:39 +020033 * be set by root in /proc/sys/fs/pipe-max-size
Jens Axboeb492e952010-05-19 21:03:16 +020034 */
Jens Axboeff9da692010-06-03 14:54:39 +020035unsigned int pipe_max_size = 1048576;
36
37/*
38 * Minimum pipe size, as required by POSIX
39 */
40unsigned int pipe_min_size = PAGE_SIZE;
Jens Axboeb492e952010-05-19 21:03:16 +020041
Willy Tarreau759c0112016-01-18 16:36:09 +010042/* 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
Jens Axboeb492e952010-05-19 21:03:16 +020048/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 * 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
Miklos Szeredi61e0d472009-04-14 19:48:41 +020063static void pipe_lock_nested(struct pipe_inode_info *pipe, int subclass)
64{
Al Viro6447a3c2013-03-21 11:01:38 -040065 if (pipe->files)
Al Viro72b0d9a2013-03-21 02:32:24 -040066 mutex_lock_nested(&pipe->mutex, subclass);
Miklos Szeredi61e0d472009-04-14 19:48:41 +020067}
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{
Al Viro6447a3c2013-03-21 11:01:38 -040080 if (pipe->files)
Al Viro72b0d9a2013-03-21 02:32:24 -040081 mutex_unlock(&pipe->mutex);
Miklos Szeredi61e0d472009-04-14 19:48:41 +020082}
83EXPORT_SYMBOL(pipe_unlock);
84
Al Viroebec73f2013-03-21 12:24:01 -040085static 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
Miklos Szeredi61e0d472009-04-14 19:48:41 +020095void 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 {
Peter Zijlstra023d43c2009-07-21 10:09:23 +0200104 pipe_lock_nested(pipe2, I_MUTEX_PARENT);
105 pipe_lock_nested(pipe1, I_MUTEX_CHILD);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200106 }
107}
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109/* Drop the inode semaphore and wait for a pipe event, atomically */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200110void pipe_wait(struct pipe_inode_info *pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
112 DEFINE_WAIT(wait);
113
Ingo Molnard79fc0f2005-09-10 00:26:12 -0700114 /*
115 * Pipes are system-local resources, so sleeping on them
116 * is considered a noninteractive wait:
117 */
Mike Galbraithaf927232007-10-15 17:00:13 +0200118 prepare_to_wait(&pipe->wait, &wait, TASK_INTERRUPTIBLE);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200119 pipe_unlock(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 schedule();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200121 finish_wait(&pipe->wait, &wait);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200122 pipe_lock(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123}
124
Ingo Molnar341b4462006-04-11 13:57:45 +0200125static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
126 struct pipe_buffer *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
128 struct page *page = buf->page;
129
Jens Axboe5274f052006-03-30 15:15:30 +0200130 /*
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
Ingo Molnar341b4462006-04-11 13:57:45 +0200133 * allocation cache. (Otherwise just release our reference to it)
Jens Axboe5274f052006-03-30 15:15:30 +0200134 */
Ingo Molnar341b4462006-04-11 13:57:45 +0200135 if (page_count(page) == 1 && !pipe->tmp_page)
Ingo Molnar923f4f22006-04-11 13:53:33 +0200136 pipe->tmp_page = page;
Ingo Molnar341b4462006-04-11 13:57:45 +0200137 else
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300138 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139}
140
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700141static 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) {
Vladimir Davydovc4159a72016-08-08 23:03:12 +0300147 if (memcg_kmem_enabled())
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700148 memcg_kmem_uncharge(page, 0);
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700149 __SetPageLocked(page);
150 return 0;
151 }
152 return 1;
153}
154
Jens Axboe08457182007-06-12 20:51:32 +0200155/**
Randy Dunlapb51d63c2008-02-13 15:03:22 -0800156 * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
Jens Axboe08457182007-06-12 20:51:32 +0200157 * @pipe: the pipe that the buffer belongs to
158 * @buf: the buffer to attempt to steal
159 *
160 * Description:
Randy Dunlapb51d63c2008-02-13 15:03:22 -0800161 * This function attempts to steal the &struct page attached to
Jens Axboe08457182007-06-12 20:51:32 +0200162 * @buf. If successful, this function returns 0 and returns with
163 * the page locked. The caller may then reuse the page for whatever
Randy Dunlapb51d63c2008-02-13 15:03:22 -0800164 * he wishes; the typical use is insertion into a different file
Jens Axboe08457182007-06-12 20:51:32 +0200165 * page cache.
166 */
Jens Axboe330ab712006-05-02 15:29:57 +0200167int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
168 struct pipe_buffer *buf)
Jens Axboe5abc97a2006-03-30 15:16:46 +0200169{
Jens Axboe46e678c2006-04-30 16:36:32 +0200170 struct page *page = buf->page;
171
Jens Axboe08457182007-06-12 20:51:32 +0200172 /*
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 */
Jens Axboe46e678c2006-04-30 16:36:32 +0200177 if (page_count(page) == 1) {
Jens Axboe46e678c2006-04-30 16:36:32 +0200178 lock_page(page);
179 return 0;
180 }
181
182 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +0200183}
Miklos Szeredi51921cb2010-05-26 08:44:22 +0200184EXPORT_SYMBOL(generic_pipe_buf_steal);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200185
Jens Axboe08457182007-06-12 20:51:32 +0200186/**
Randy Dunlapb51d63c2008-02-13 15:03:22 -0800187 * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
Jens Axboe08457182007-06-12 20:51:32 +0200188 * @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)
Jens Axboe70524492006-04-11 15:51:17 +0200197{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300198 get_page(buf->page);
Jens Axboe70524492006-04-11 15:51:17 +0200199}
Miklos Szeredi51921cb2010-05-26 08:44:22 +0200200EXPORT_SYMBOL(generic_pipe_buf_get);
Jens Axboe70524492006-04-11 15:51:17 +0200201
Jens Axboe08457182007-06-12 20:51:32 +0200202/**
203 * generic_pipe_buf_confirm - verify contents of the pipe buffer
Randy Dunlap79685b82007-07-27 08:08:51 +0200204 * @info: the pipe that the buffer belongs to
Jens Axboe08457182007-06-12 20:51:32 +0200205 * @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 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200211int generic_pipe_buf_confirm(struct pipe_inode_info *info,
212 struct pipe_buffer *buf)
Jens Axboef84d7512006-05-01 19:59:03 +0200213{
214 return 0;
215}
Miklos Szeredi51921cb2010-05-26 08:44:22 +0200216EXPORT_SYMBOL(generic_pipe_buf_confirm);
Jens Axboef84d7512006-05-01 19:59:03 +0200217
Miklos Szeredi68181732009-05-07 15:37:36 +0200218/**
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{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300229 put_page(buf->page);
Miklos Szeredi68181732009-05-07 15:37:36 +0200230}
Miklos Szeredi51921cb2010-05-26 08:44:22 +0200231EXPORT_SYMBOL(generic_pipe_buf_release);
Miklos Szeredi68181732009-05-07 15:37:36 +0200232
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800233static const struct pipe_buf_operations anon_pipe_buf_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 .can_merge = 1,
Jens Axboecac36bb02007-06-14 13:10:48 +0200235 .confirm = generic_pipe_buf_confirm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 .release = anon_pipe_buf_release,
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700237 .steal = anon_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200238 .get = generic_pipe_buf_get,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239};
240
Linus Torvalds98830352012-04-29 13:12:42 -0700241static const struct pipe_buf_operations packet_pipe_buf_ops = {
242 .can_merge = 0,
Linus Torvalds98830352012-04-29 13:12:42 -0700243 .confirm = generic_pipe_buf_confirm,
244 .release = anon_pipe_buf_release,
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700245 .steal = anon_pipe_buf_steal,
Linus Torvalds98830352012-04-29 13:12:42 -0700246 .get = generic_pipe_buf_get,
247};
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249static ssize_t
Al Virofb9096a2014-04-02 19:56:54 -0400250pipe_read(struct kiocb *iocb, struct iov_iter *to)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
Al Virofb9096a2014-04-02 19:56:54 -0400252 size_t total_len = iov_iter_count(to);
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700253 struct file *filp = iocb->ki_filp;
Al Virode32ec42013-03-21 11:16:56 -0400254 struct pipe_inode_info *pipe = filp->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 int do_wakeup;
256 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 /* Null read succeeds. */
259 if (unlikely(total_len == 0))
260 return 0;
261
262 do_wakeup = 0;
263 ret = 0;
Al Viroebec73f2013-03-21 12:24:01 -0400264 __pipe_lock(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 for (;;) {
Ingo Molnar923f4f22006-04-11 13:53:33 +0200266 int bufs = pipe->nrbufs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 if (bufs) {
Ingo Molnar923f4f22006-04-11 13:53:33 +0200268 int curbuf = pipe->curbuf;
269 struct pipe_buffer *buf = pipe->bufs + curbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 size_t chars = buf->len;
Al Viro637b58c2014-02-03 19:11:42 -0500271 size_t written;
272 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274 if (chars > total_len)
275 chars = total_len;
276
Miklos Szeredifba597d2016-09-27 10:45:12 +0200277 error = pipe_buf_confirm(pipe, buf);
Jens Axboef84d7512006-05-01 19:59:03 +0200278 if (error) {
Jens Axboe5274f052006-03-30 15:15:30 +0200279 if (!ret)
Nicolas Kaisere5953cb2010-10-21 14:56:00 +0200280 ret = error;
Jens Axboe5274f052006-03-30 15:15:30 +0200281 break;
282 }
Jens Axboef84d7512006-05-01 19:59:03 +0200283
Al Virofb9096a2014-04-02 19:56:54 -0400284 written = copy_page_to_iter(buf->page, buf->offset, chars, to);
Al Viro637b58c2014-02-03 19:11:42 -0500285 if (unlikely(written < chars)) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200286 if (!ret)
Al Viro637b58c2014-02-03 19:11:42 -0500287 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 break;
289 }
290 ret += chars;
291 buf->offset += chars;
292 buf->len -= chars;
Linus Torvalds98830352012-04-29 13:12:42 -0700293
294 /* Was it a packet buffer? Clean up and exit */
295 if (buf->flags & PIPE_BUF_FLAG_PACKET) {
296 total_len = chars;
297 buf->len = 0;
298 }
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200301 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200302 curbuf = (curbuf + 1) & (pipe->buffers - 1);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200303 pipe->curbuf = curbuf;
304 pipe->nrbufs = --bufs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 do_wakeup = 1;
306 }
307 total_len -= chars;
308 if (!total_len)
309 break; /* common path: read succeeded */
310 }
311 if (bufs) /* More to do? */
312 continue;
Ingo Molnar923f4f22006-04-11 13:53:33 +0200313 if (!pipe->writers)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 break;
Ingo Molnar923f4f22006-04-11 13:53:33 +0200315 if (!pipe->waiting_writers) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 /* syscall merging: Usually we must not sleep
317 * if O_NONBLOCK is set, or if we got some data.
318 * But if a writer sleeps in kernel space, then
319 * we can wait for that data without violating POSIX.
320 */
321 if (ret)
322 break;
323 if (filp->f_flags & O_NONBLOCK) {
324 ret = -EAGAIN;
325 break;
326 }
327 }
328 if (signal_pending(current)) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200329 if (!ret)
330 ret = -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 break;
332 }
333 if (do_wakeup) {
Linus Torvalds28e58ee2011-01-20 16:21:59 -0800334 wake_up_interruptible_sync_poll(&pipe->wait, POLLOUT | POLLWRNORM);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200335 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 }
Ingo Molnar923f4f22006-04-11 13:53:33 +0200337 pipe_wait(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 }
Al Viroebec73f2013-03-21 12:24:01 -0400339 __pipe_unlock(pipe);
Ingo Molnar341b4462006-04-11 13:57:45 +0200340
341 /* Signal writers asynchronously that there is more room. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 if (do_wakeup) {
Linus Torvalds28e58ee2011-01-20 16:21:59 -0800343 wake_up_interruptible_sync_poll(&pipe->wait, POLLOUT | POLLWRNORM);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200344 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 }
346 if (ret > 0)
347 file_accessed(filp);
348 return ret;
349}
350
Linus Torvalds98830352012-04-29 13:12:42 -0700351static inline int is_packetized(struct file *file)
352{
353 return (file->f_flags & O_DIRECT) != 0;
354}
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356static ssize_t
Al Virof0d1bec2014-04-03 15:05:18 -0400357pipe_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358{
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700359 struct file *filp = iocb->ki_filp;
Al Virode32ec42013-03-21 11:16:56 -0400360 struct pipe_inode_info *pipe = filp->private_data;
Al Virof0d1bec2014-04-03 15:05:18 -0400361 ssize_t ret = 0;
362 int do_wakeup = 0;
363 size_t total_len = iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 ssize_t chars;
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 /* Null write succeeds. */
367 if (unlikely(total_len == 0))
368 return 0;
369
Al Viroebec73f2013-03-21 12:24:01 -0400370 __pipe_lock(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Ingo Molnar923f4f22006-04-11 13:53:33 +0200372 if (!pipe->readers) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 send_sig(SIGPIPE, current, 0);
374 ret = -EPIPE;
375 goto out;
376 }
377
378 /* We try to merge small writes */
379 chars = total_len & (PAGE_SIZE-1); /* size of the last buffer */
Ingo Molnar923f4f22006-04-11 13:53:33 +0200380 if (pipe->nrbufs && chars != 0) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200381 int lastbuf = (pipe->curbuf + pipe->nrbufs - 1) &
Jens Axboe35f3d142010-05-20 10:43:18 +0200382 (pipe->buffers - 1);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200383 struct pipe_buffer *buf = pipe->bufs + lastbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 int offset = buf->offset + buf->len;
Ingo Molnar341b4462006-04-11 13:57:45 +0200385
Miklos Szeredifba597d2016-09-27 10:45:12 +0200386 if (buf->ops->can_merge && offset + chars <= PAGE_SIZE) {
387 ret = pipe_buf_confirm(pipe, buf);
Eric Biggers6ae08062015-10-17 16:26:09 -0500388 if (ret)
Jens Axboe5274f052006-03-30 15:15:30 +0200389 goto out;
Jens Axboef84d7512006-05-01 19:59:03 +0200390
Al Virof0d1bec2014-04-03 15:05:18 -0400391 ret = copy_page_from_iter(buf->page, offset, chars, from);
392 if (unlikely(ret < chars)) {
Eric Biggers6ae08062015-10-17 16:26:09 -0500393 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 goto out;
Jens Axboef6762b72006-05-01 20:02:05 +0200395 }
Al Virof0d1bec2014-04-03 15:05:18 -0400396 do_wakeup = 1;
Eric Biggers6ae08062015-10-17 16:26:09 -0500397 buf->len += ret;
Al Virof0d1bec2014-04-03 15:05:18 -0400398 if (!iov_iter_count(from))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 goto out;
400 }
401 }
402
403 for (;;) {
404 int bufs;
Ingo Molnar341b4462006-04-11 13:57:45 +0200405
Ingo Molnar923f4f22006-04-11 13:53:33 +0200406 if (!pipe->readers) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 send_sig(SIGPIPE, current, 0);
Ingo Molnar341b4462006-04-11 13:57:45 +0200408 if (!ret)
409 ret = -EPIPE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 break;
411 }
Ingo Molnar923f4f22006-04-11 13:53:33 +0200412 bufs = pipe->nrbufs;
Jens Axboe35f3d142010-05-20 10:43:18 +0200413 if (bufs < pipe->buffers) {
414 int newbuf = (pipe->curbuf + bufs) & (pipe->buffers-1);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200415 struct pipe_buffer *buf = pipe->bufs + newbuf;
416 struct page *page = pipe->tmp_page;
Al Virof0d1bec2014-04-03 15:05:18 -0400417 int copied;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419 if (!page) {
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700420 page = alloc_page(GFP_HIGHUSER | __GFP_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 if (unlikely(!page)) {
422 ret = ret ? : -ENOMEM;
423 break;
424 }
Ingo Molnar923f4f22006-04-11 13:53:33 +0200425 pipe->tmp_page = page;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 }
Ingo Molnar341b4462006-04-11 13:57:45 +0200427 /* Always wake up, even if the copy fails. Otherwise
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 * we lock up (O_NONBLOCK-)readers that sleep due to
429 * syscall merging.
430 * FIXME! Is this really true?
431 */
432 do_wakeup = 1;
Al Virof0d1bec2014-04-03 15:05:18 -0400433 copied = copy_page_from_iter(page, 0, PAGE_SIZE, from);
434 if (unlikely(copied < PAGE_SIZE && iov_iter_count(from))) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200435 if (!ret)
Al Virof0d1bec2014-04-03 15:05:18 -0400436 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 break;
438 }
Al Virof0d1bec2014-04-03 15:05:18 -0400439 ret += copied;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
441 /* Insert it into the buffer array */
442 buf->page = page;
443 buf->ops = &anon_pipe_buf_ops;
444 buf->offset = 0;
Al Virof0d1bec2014-04-03 15:05:18 -0400445 buf->len = copied;
Linus Torvalds98830352012-04-29 13:12:42 -0700446 buf->flags = 0;
447 if (is_packetized(filp)) {
448 buf->ops = &packet_pipe_buf_ops;
449 buf->flags = PIPE_BUF_FLAG_PACKET;
450 }
Ingo Molnar923f4f22006-04-11 13:53:33 +0200451 pipe->nrbufs = ++bufs;
452 pipe->tmp_page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Al Virof0d1bec2014-04-03 15:05:18 -0400454 if (!iov_iter_count(from))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 break;
456 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200457 if (bufs < pipe->buffers)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 continue;
459 if (filp->f_flags & O_NONBLOCK) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200460 if (!ret)
461 ret = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 break;
463 }
464 if (signal_pending(current)) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200465 if (!ret)
466 ret = -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 break;
468 }
469 if (do_wakeup) {
Linus Torvalds28e58ee2011-01-20 16:21:59 -0800470 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLRDNORM);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200471 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 do_wakeup = 0;
473 }
Ingo Molnar923f4f22006-04-11 13:53:33 +0200474 pipe->waiting_writers++;
475 pipe_wait(pipe);
476 pipe->waiting_writers--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 }
478out:
Al Viroebec73f2013-03-21 12:24:01 -0400479 __pipe_unlock(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (do_wakeup) {
Linus Torvalds28e58ee2011-01-20 16:21:59 -0800481 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLRDNORM);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200482 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
Dmitry Monakhov7e775f42014-01-23 15:55:21 -0800484 if (ret > 0 && sb_start_write_trylock(file_inode(filp)->i_sb)) {
Josef Bacikc3b2da32012-03-26 09:59:21 -0400485 int err = file_update_time(filp);
486 if (err)
487 ret = err;
Dmitry Monakhov7e775f42014-01-23 15:55:21 -0800488 sb_end_write(file_inode(filp)->i_sb);
Josef Bacikc3b2da32012-03-26 09:59:21 -0400489 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 return ret;
491}
492
Andi Kleend59d0b12008-02-08 04:21:23 -0800493static long pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
Al Virode32ec42013-03-21 11:16:56 -0400495 struct pipe_inode_info *pipe = filp->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 int count, buf, nrbufs;
497
498 switch (cmd) {
499 case FIONREAD:
Al Viroebec73f2013-03-21 12:24:01 -0400500 __pipe_lock(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 count = 0;
Ingo Molnar923f4f22006-04-11 13:53:33 +0200502 buf = pipe->curbuf;
503 nrbufs = pipe->nrbufs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 while (--nrbufs >= 0) {
Ingo Molnar923f4f22006-04-11 13:53:33 +0200505 count += pipe->bufs[buf].len;
Jens Axboe35f3d142010-05-20 10:43:18 +0200506 buf = (buf+1) & (pipe->buffers - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 }
Al Viroebec73f2013-03-21 12:24:01 -0400508 __pipe_unlock(pipe);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 return put_user(count, (int __user *)arg);
511 default:
Will Deacon46ce3412012-05-25 11:39:13 +0100512 return -ENOIOCTLCMD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 }
514}
515
516/* No kernel lock held - fine */
517static unsigned int
518pipe_poll(struct file *filp, poll_table *wait)
519{
520 unsigned int mask;
Al Virode32ec42013-03-21 11:16:56 -0400521 struct pipe_inode_info *pipe = filp->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 int nrbufs;
523
Ingo Molnar923f4f22006-04-11 13:53:33 +0200524 poll_wait(filp, &pipe->wait, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526 /* Reading only -- no need for acquiring the semaphore. */
Ingo Molnar923f4f22006-04-11 13:53:33 +0200527 nrbufs = pipe->nrbufs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 mask = 0;
529 if (filp->f_mode & FMODE_READ) {
530 mask = (nrbufs > 0) ? POLLIN | POLLRDNORM : 0;
Ingo Molnar923f4f22006-04-11 13:53:33 +0200531 if (!pipe->writers && filp->f_version != pipe->w_counter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 mask |= POLLHUP;
533 }
534
535 if (filp->f_mode & FMODE_WRITE) {
Jens Axboe35f3d142010-05-20 10:43:18 +0200536 mask |= (nrbufs < pipe->buffers) ? POLLOUT | POLLWRNORM : 0;
Pekka Enberg5e5d7a22005-09-06 15:17:48 -0700537 /*
538 * Most Unices do not set POLLERR for FIFOs but on Linux they
539 * behave exactly like pipes for poll().
540 */
Ingo Molnar923f4f22006-04-11 13:53:33 +0200541 if (!pipe->readers)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 mask |= POLLERR;
543 }
544
545 return mask;
546}
547
Linus Torvaldsb0d8d222013-12-02 09:44:51 -0800548static void put_pipe_info(struct inode *inode, struct pipe_inode_info *pipe)
549{
550 int kill = 0;
551
552 spin_lock(&inode->i_lock);
553 if (!--pipe->files) {
554 inode->i_pipe = NULL;
555 kill = 1;
556 }
557 spin_unlock(&inode->i_lock);
558
559 if (kill)
560 free_pipe_info(pipe);
561}
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563static int
Al Viro599a0ac2013-03-12 09:58:10 -0400564pipe_release(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
Linus Torvaldsb0d8d222013-12-02 09:44:51 -0800566 struct pipe_inode_info *pipe = file->private_data;
Ingo Molnar923f4f22006-04-11 13:53:33 +0200567
Al Viroebec73f2013-03-21 12:24:01 -0400568 __pipe_lock(pipe);
Al Viro599a0ac2013-03-12 09:58:10 -0400569 if (file->f_mode & FMODE_READ)
570 pipe->readers--;
571 if (file->f_mode & FMODE_WRITE)
572 pipe->writers--;
Ingo Molnar341b4462006-04-11 13:57:45 +0200573
Al Viroba5bb142013-03-21 02:21:19 -0400574 if (pipe->readers || pipe->writers) {
Linus Torvalds28e58ee2011-01-20 16:21:59 -0800575 wake_up_interruptible_sync_poll(&pipe->wait, POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM | POLLERR | POLLHUP);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200576 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
577 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 }
Al Viroebec73f2013-03-21 12:24:01 -0400579 __pipe_unlock(pipe);
Al Viroba5bb142013-03-21 02:21:19 -0400580
Linus Torvaldsb0d8d222013-12-02 09:44:51 -0800581 put_pipe_info(inode, pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 return 0;
583}
584
585static int
Al Viro599a0ac2013-03-12 09:58:10 -0400586pipe_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
Al Virode32ec42013-03-21 11:16:56 -0400588 struct pipe_inode_info *pipe = filp->private_data;
Al Viro599a0ac2013-03-12 09:58:10 -0400589 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Al Viroebec73f2013-03-21 12:24:01 -0400591 __pipe_lock(pipe);
Al Viro599a0ac2013-03-12 09:58:10 -0400592 if (filp->f_mode & FMODE_READ)
593 retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
594 if ((filp->f_mode & FMODE_WRITE) && retval >= 0) {
Ingo Molnar341b4462006-04-11 13:57:45 +0200595 retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
Al Viro599a0ac2013-03-12 09:58:10 -0400596 if (retval < 0 && (filp->f_mode & FMODE_READ))
597 /* this can happen only if on == T */
Oleg Nesterove5bc49b2009-03-12 14:31:28 -0700598 fasync_helper(-1, filp, 0, &pipe->fasync_readers);
599 }
Al Viroebec73f2013-03-21 12:24:01 -0400600 __pipe_unlock(pipe);
Jonathan Corbet60aa4922009-02-01 14:52:56 -0700601 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
Michael Kerrisk (man-pages)3734a132016-10-11 13:53:28 -0700604static void account_pipe_buffers(struct user_struct *user,
Willy Tarreau759c0112016-01-18 16:36:09 +0100605 unsigned long old, unsigned long new)
606{
Michael Kerrisk (man-pages)3734a132016-10-11 13:53:28 -0700607 atomic_long_add(new - old, &user->pipe_bufs);
Willy Tarreau759c0112016-01-18 16:36:09 +0100608}
609
610static bool too_many_pipe_buffers_soft(struct user_struct *user)
611{
612 return pipe_user_pages_soft &&
613 atomic_long_read(&user->pipe_bufs) >= pipe_user_pages_soft;
614}
615
616static bool too_many_pipe_buffers_hard(struct user_struct *user)
617{
618 return pipe_user_pages_hard &&
619 atomic_long_read(&user->pipe_bufs) >= pipe_user_pages_hard;
620}
621
Al Viro7bee1302013-03-21 11:04:15 -0400622struct pipe_inode_info *alloc_pipe_info(void)
Ingo Molnar3a326a22006-04-10 15:18:35 +0200623{
Ingo Molnar923f4f22006-04-11 13:53:33 +0200624 struct pipe_inode_info *pipe;
Ingo Molnar3a326a22006-04-10 15:18:35 +0200625
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700626 pipe = kzalloc(sizeof(struct pipe_inode_info), GFP_KERNEL_ACCOUNT);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200627 if (pipe) {
Willy Tarreau759c0112016-01-18 16:36:09 +0100628 unsigned long pipe_bufs = PIPE_DEF_BUFFERS;
629 struct user_struct *user = get_current_user();
630
631 if (!too_many_pipe_buffers_hard(user)) {
632 if (too_many_pipe_buffers_soft(user))
633 pipe_bufs = 1;
Vladimir Davydovd86133b2016-07-26 15:24:33 -0700634 pipe->bufs = kcalloc(pipe_bufs,
635 sizeof(struct pipe_buffer),
636 GFP_KERNEL_ACCOUNT);
Willy Tarreau759c0112016-01-18 16:36:09 +0100637 }
638
Jens Axboe35f3d142010-05-20 10:43:18 +0200639 if (pipe->bufs) {
640 init_waitqueue_head(&pipe->wait);
641 pipe->r_counter = pipe->w_counter = 1;
Willy Tarreau759c0112016-01-18 16:36:09 +0100642 pipe->buffers = pipe_bufs;
643 pipe->user = user;
Michael Kerrisk (man-pages)3734a132016-10-11 13:53:28 -0700644 account_pipe_buffers(user, 0, pipe_bufs);
Al Viro72b0d9a2013-03-21 02:32:24 -0400645 mutex_init(&pipe->mutex);
Jens Axboe35f3d142010-05-20 10:43:18 +0200646 return pipe;
647 }
Willy Tarreau759c0112016-01-18 16:36:09 +0100648 free_uid(user);
Jens Axboe35f3d142010-05-20 10:43:18 +0200649 kfree(pipe);
Ingo Molnar3a326a22006-04-10 15:18:35 +0200650 }
651
Jens Axboe35f3d142010-05-20 10:43:18 +0200652 return NULL;
Ingo Molnar3a326a22006-04-10 15:18:35 +0200653}
654
Al Viro4b8a8f12013-03-21 11:06:46 -0400655void free_pipe_info(struct pipe_inode_info *pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
657 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Michael Kerrisk (man-pages)3734a132016-10-11 13:53:28 -0700659 account_pipe_buffers(pipe->user, pipe->buffers, 0);
Willy Tarreau759c0112016-01-18 16:36:09 +0100660 free_uid(pipe->user);
Jens Axboe35f3d142010-05-20 10:43:18 +0200661 for (i = 0; i < pipe->buffers; i++) {
Ingo Molnar923f4f22006-04-11 13:53:33 +0200662 struct pipe_buffer *buf = pipe->bufs + i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 if (buf->ops)
Miklos Szeredia7796382016-09-27 10:45:12 +0200664 pipe_buf_release(pipe, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 }
Ingo Molnar923f4f22006-04-11 13:53:33 +0200666 if (pipe->tmp_page)
667 __free_page(pipe->tmp_page);
Jens Axboe35f3d142010-05-20 10:43:18 +0200668 kfree(pipe->bufs);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200669 kfree(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800672static struct vfsmount *pipe_mnt __read_mostly;
Ingo Molnar341b4462006-04-11 13:57:45 +0200673
Eric Dumazetc23fbb62007-05-08 00:26:18 -0700674/*
675 * pipefs_dname() is called from d_path().
676 */
677static char *pipefs_dname(struct dentry *dentry, char *buffer, int buflen)
678{
679 return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
David Howells75c3cfa2015-03-17 22:26:12 +0000680 d_inode(dentry)->i_ino);
Eric Dumazetc23fbb62007-05-08 00:26:18 -0700681}
682
Al Viro3ba13d12009-02-20 06:02:22 +0000683static const struct dentry_operations pipefs_dentry_operations = {
Eric Dumazetc23fbb62007-05-08 00:26:18 -0700684 .d_dname = pipefs_dname,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685};
686
687static struct inode * get_pipe_inode(void)
688{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200689 struct inode *inode = new_inode_pseudo(pipe_mnt->mnt_sb);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200690 struct pipe_inode_info *pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
692 if (!inode)
693 goto fail_inode;
694
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400695 inode->i_ino = get_next_ino();
696
Al Viro7bee1302013-03-21 11:04:15 -0400697 pipe = alloc_pipe_info();
Ingo Molnar923f4f22006-04-11 13:53:33 +0200698 if (!pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 goto fail_iput;
Ingo Molnar3a326a22006-04-10 15:18:35 +0200700
Al Viroba5bb142013-03-21 02:21:19 -0400701 inode->i_pipe = pipe;
702 pipe->files = 2;
Ingo Molnar923f4f22006-04-11 13:53:33 +0200703 pipe->readers = pipe->writers = 1;
Al Viro599a0ac2013-03-12 09:58:10 -0400704 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
706 /*
707 * Mark the inode dirty from the very beginning,
708 * that way it will never be moved to the dirty
709 * list because "mark_inode_dirty()" will think
710 * that it already _is_ on the dirty list.
711 */
712 inode->i_state = I_DIRTY;
713 inode->i_mode = S_IFIFO | S_IRUSR | S_IWUSR;
David Howellsda9592e2008-11-14 10:39:05 +1100714 inode->i_uid = current_fsuid();
715 inode->i_gid = current_fsgid();
Deepa Dinamani078cd822016-09-14 07:48:04 -0700716 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
Ingo Molnar923f4f22006-04-11 13:53:33 +0200717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 return inode;
719
720fail_iput:
721 iput(inode);
Ingo Molnar341b4462006-04-11 13:57:45 +0200722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723fail_inode:
724 return NULL;
725}
726
Al Viroe4fad8e2012-07-21 15:33:25 +0400727int create_pipe_files(struct file **res, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
Andi Kleend6cbd282006-09-30 23:29:26 -0700729 int err;
Al Viroe4fad8e2012-07-21 15:33:25 +0400730 struct inode *inode = get_pipe_inode();
Andi Kleend6cbd282006-09-30 23:29:26 -0700731 struct file *f;
Al Viro2c48b9c2009-08-09 00:52:35 +0400732 struct path path;
Al Viroe4fad8e2012-07-21 15:33:25 +0400733 static struct qstr name = { .name = "" };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 if (!inode)
Al Viroe4fad8e2012-07-21 15:33:25 +0400736 return -ENFILE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Andi Kleend6cbd282006-09-30 23:29:26 -0700738 err = -ENOMEM;
Nick Piggin4b936882011-01-07 17:50:07 +1100739 path.dentry = d_alloc_pseudo(pipe_mnt->mnt_sb, &name);
Al Viro2c48b9c2009-08-09 00:52:35 +0400740 if (!path.dentry)
Andi Kleend6cbd282006-09-30 23:29:26 -0700741 goto err_inode;
Al Viro2c48b9c2009-08-09 00:52:35 +0400742 path.mnt = mntget(pipe_mnt);
Ingo Molnar341b4462006-04-11 13:57:45 +0200743
Al Viro2c48b9c2009-08-09 00:52:35 +0400744 d_instantiate(path.dentry, inode);
Dave Hansen430e2852008-02-15 14:37:26 -0800745
Al Viro599a0ac2013-03-12 09:58:10 -0400746 f = alloc_file(&path, FMODE_WRITE, &pipefifo_fops);
Eric Biggerse9bb1f92015-10-17 16:26:08 -0500747 if (IS_ERR(f)) {
748 err = PTR_ERR(f);
Dave Hansen430e2852008-02-15 14:37:26 -0800749 goto err_dentry;
Eric Biggerse9bb1f92015-10-17 16:26:08 -0500750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Linus Torvalds98830352012-04-29 13:12:42 -0700752 f->f_flags = O_WRONLY | (flags & (O_NONBLOCK | O_DIRECT));
Al Virode32ec42013-03-21 11:16:56 -0400753 f->private_data = inode->i_pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Al Viro599a0ac2013-03-12 09:58:10 -0400755 res[0] = alloc_file(&path, FMODE_READ, &pipefifo_fops);
Eric Biggerse9bb1f92015-10-17 16:26:08 -0500756 if (IS_ERR(res[0])) {
757 err = PTR_ERR(res[0]);
Al Viroe4fad8e2012-07-21 15:33:25 +0400758 goto err_file;
Eric Biggerse9bb1f92015-10-17 16:26:08 -0500759 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Al Viroe4fad8e2012-07-21 15:33:25 +0400761 path_get(&path);
Al Virode32ec42013-03-21 11:16:56 -0400762 res[0]->private_data = inode->i_pipe;
Al Viroe4fad8e2012-07-21 15:33:25 +0400763 res[0]->f_flags = O_RDONLY | (flags & O_NONBLOCK);
764 res[1] = f;
765 return 0;
766
767err_file:
768 put_filp(f);
769err_dentry:
Al Viro4b8a8f12013-03-21 11:06:46 -0400770 free_pipe_info(inode->i_pipe);
Al Viro2c48b9c2009-08-09 00:52:35 +0400771 path_put(&path);
Al Viroe4fad8e2012-07-21 15:33:25 +0400772 return err;
Al Viroed152432008-04-22 19:51:27 -0400773
Al Viroe4fad8e2012-07-21 15:33:25 +0400774err_inode:
Al Viro4b8a8f12013-03-21 11:06:46 -0400775 free_pipe_info(inode->i_pipe);
Andi Kleend6cbd282006-09-30 23:29:26 -0700776 iput(inode);
Al Viroe4fad8e2012-07-21 15:33:25 +0400777 return err;
Andi Kleend6cbd282006-09-30 23:29:26 -0700778}
779
Al Viro5b249b12012-08-19 12:17:29 -0400780static int __do_pipe_flags(int *fd, struct file **files, int flags)
Andi Kleend6cbd282006-09-30 23:29:26 -0700781{
Andi Kleend6cbd282006-09-30 23:29:26 -0700782 int error;
783 int fdw, fdr;
784
Linus Torvalds98830352012-04-29 13:12:42 -0700785 if (flags & ~(O_CLOEXEC | O_NONBLOCK | O_DIRECT))
Ulrich Dreppered8cae82008-07-23 21:29:30 -0700786 return -EINVAL;
787
Al Viroe4fad8e2012-07-21 15:33:25 +0400788 error = create_pipe_files(files, flags);
789 if (error)
790 return error;
Andi Kleend6cbd282006-09-30 23:29:26 -0700791
Ulrich Dreppered8cae82008-07-23 21:29:30 -0700792 error = get_unused_fd_flags(flags);
Andi Kleend6cbd282006-09-30 23:29:26 -0700793 if (error < 0)
794 goto err_read_pipe;
795 fdr = error;
796
Ulrich Dreppered8cae82008-07-23 21:29:30 -0700797 error = get_unused_fd_flags(flags);
Andi Kleend6cbd282006-09-30 23:29:26 -0700798 if (error < 0)
799 goto err_fdr;
800 fdw = error;
801
Al Viro157cf642008-12-14 04:57:47 -0500802 audit_fd_pair(fdr, fdw);
Andi Kleend6cbd282006-09-30 23:29:26 -0700803 fd[0] = fdr;
804 fd[1] = fdw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 return 0;
806
Andi Kleend6cbd282006-09-30 23:29:26 -0700807 err_fdr:
808 put_unused_fd(fdr);
809 err_read_pipe:
Al Viroe4fad8e2012-07-21 15:33:25 +0400810 fput(files[0]);
811 fput(files[1]);
Andi Kleend6cbd282006-09-30 23:29:26 -0700812 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813}
814
Al Viro5b249b12012-08-19 12:17:29 -0400815int do_pipe_flags(int *fd, int flags)
816{
817 struct file *files[2];
818 int error = __do_pipe_flags(fd, files, flags);
819 if (!error) {
820 fd_install(fd[0], files[0]);
821 fd_install(fd[1], files[1]);
822 }
823 return error;
824}
825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826/*
Ulrich Drepperd35c7b02008-05-03 15:10:37 -0400827 * sys_pipe() is the normal C calling standard for creating
828 * a pipe. It's not the way Unix traditionally does this, though.
829 */
Heiko Carstensd4e82042009-01-14 14:14:34 +0100830SYSCALL_DEFINE2(pipe2, int __user *, fildes, int, flags)
Ulrich Drepperd35c7b02008-05-03 15:10:37 -0400831{
Al Viro5b249b12012-08-19 12:17:29 -0400832 struct file *files[2];
Ulrich Drepperd35c7b02008-05-03 15:10:37 -0400833 int fd[2];
834 int error;
835
Al Viro5b249b12012-08-19 12:17:29 -0400836 error = __do_pipe_flags(fd, files, flags);
Ulrich Drepperd35c7b02008-05-03 15:10:37 -0400837 if (!error) {
Al Viro5b249b12012-08-19 12:17:29 -0400838 if (unlikely(copy_to_user(fildes, fd, sizeof(fd)))) {
839 fput(files[0]);
840 fput(files[1]);
841 put_unused_fd(fd[0]);
842 put_unused_fd(fd[1]);
Ulrich Drepperd35c7b02008-05-03 15:10:37 -0400843 error = -EFAULT;
Al Viro5b249b12012-08-19 12:17:29 -0400844 } else {
845 fd_install(fd[0], files[0]);
846 fd_install(fd[1], files[1]);
Ulrich Drepperba719ba2008-05-06 20:42:38 -0700847 }
Ulrich Drepperd35c7b02008-05-03 15:10:37 -0400848 }
849 return error;
850}
851
Heiko Carstens2b664212009-01-14 14:14:35 +0100852SYSCALL_DEFINE1(pipe, int __user *, fildes)
Ulrich Dreppered8cae82008-07-23 21:29:30 -0700853{
854 return sys_pipe2(fildes, 0);
855}
856
Al Virofc7478a2013-03-21 02:07:59 -0400857static int wait_for_partner(struct pipe_inode_info *pipe, unsigned int *cnt)
Al Virof776c732013-03-12 09:46:27 -0400858{
859 int cur = *cnt;
860
861 while (cur == *cnt) {
Al Virofc7478a2013-03-21 02:07:59 -0400862 pipe_wait(pipe);
Al Virof776c732013-03-12 09:46:27 -0400863 if (signal_pending(current))
864 break;
865 }
866 return cur == *cnt ? -ERESTARTSYS : 0;
867}
868
Al Virofc7478a2013-03-21 02:07:59 -0400869static void wake_up_partner(struct pipe_inode_info *pipe)
Al Virof776c732013-03-12 09:46:27 -0400870{
Al Virofc7478a2013-03-21 02:07:59 -0400871 wake_up_interruptible(&pipe->wait);
Al Virof776c732013-03-12 09:46:27 -0400872}
873
874static int fifo_open(struct inode *inode, struct file *filp)
875{
876 struct pipe_inode_info *pipe;
Al Viro599a0ac2013-03-12 09:58:10 -0400877 bool is_pipe = inode->i_sb->s_magic == PIPEFS_MAGIC;
Al Virof776c732013-03-12 09:46:27 -0400878 int ret;
879
Al Viroba5bb142013-03-21 02:21:19 -0400880 filp->f_version = 0;
881
882 spin_lock(&inode->i_lock);
883 if (inode->i_pipe) {
884 pipe = inode->i_pipe;
885 pipe->files++;
886 spin_unlock(&inode->i_lock);
887 } else {
888 spin_unlock(&inode->i_lock);
Al Viro7bee1302013-03-21 11:04:15 -0400889 pipe = alloc_pipe_info();
Al Virof776c732013-03-12 09:46:27 -0400890 if (!pipe)
Al Viroba5bb142013-03-21 02:21:19 -0400891 return -ENOMEM;
892 pipe->files = 1;
893 spin_lock(&inode->i_lock);
894 if (unlikely(inode->i_pipe)) {
895 inode->i_pipe->files++;
896 spin_unlock(&inode->i_lock);
Al Viro4b8a8f12013-03-21 11:06:46 -0400897 free_pipe_info(pipe);
Al Viroba5bb142013-03-21 02:21:19 -0400898 pipe = inode->i_pipe;
899 } else {
900 inode->i_pipe = pipe;
901 spin_unlock(&inode->i_lock);
902 }
Al Virof776c732013-03-12 09:46:27 -0400903 }
Al Virode32ec42013-03-21 11:16:56 -0400904 filp->private_data = pipe;
Al Viroba5bb142013-03-21 02:21:19 -0400905 /* OK, we have a pipe and it's pinned down */
906
Al Viroebec73f2013-03-21 12:24:01 -0400907 __pipe_lock(pipe);
Al Virof776c732013-03-12 09:46:27 -0400908
909 /* We can only do regular read/write on fifos */
910 filp->f_mode &= (FMODE_READ | FMODE_WRITE);
911
912 switch (filp->f_mode) {
913 case FMODE_READ:
914 /*
915 * O_RDONLY
916 * POSIX.1 says that O_NONBLOCK means return with the FIFO
917 * opened, even when there is no process writing the FIFO.
918 */
Al Virof776c732013-03-12 09:46:27 -0400919 pipe->r_counter++;
920 if (pipe->readers++ == 0)
Al Virofc7478a2013-03-21 02:07:59 -0400921 wake_up_partner(pipe);
Al Virof776c732013-03-12 09:46:27 -0400922
Al Viro599a0ac2013-03-12 09:58:10 -0400923 if (!is_pipe && !pipe->writers) {
Al Virof776c732013-03-12 09:46:27 -0400924 if ((filp->f_flags & O_NONBLOCK)) {
925 /* suppress POLLHUP until we have
926 * seen a writer */
927 filp->f_version = pipe->w_counter;
928 } else {
Al Virofc7478a2013-03-21 02:07:59 -0400929 if (wait_for_partner(pipe, &pipe->w_counter))
Al Virof776c732013-03-12 09:46:27 -0400930 goto err_rd;
931 }
932 }
933 break;
934
935 case FMODE_WRITE:
936 /*
937 * O_WRONLY
938 * POSIX.1 says that O_NONBLOCK means return -1 with
939 * errno=ENXIO when there is no process reading the FIFO.
940 */
941 ret = -ENXIO;
Al Viro599a0ac2013-03-12 09:58:10 -0400942 if (!is_pipe && (filp->f_flags & O_NONBLOCK) && !pipe->readers)
Al Virof776c732013-03-12 09:46:27 -0400943 goto err;
944
Al Virof776c732013-03-12 09:46:27 -0400945 pipe->w_counter++;
946 if (!pipe->writers++)
Al Virofc7478a2013-03-21 02:07:59 -0400947 wake_up_partner(pipe);
Al Virof776c732013-03-12 09:46:27 -0400948
Al Viro599a0ac2013-03-12 09:58:10 -0400949 if (!is_pipe && !pipe->readers) {
Al Virofc7478a2013-03-21 02:07:59 -0400950 if (wait_for_partner(pipe, &pipe->r_counter))
Al Virof776c732013-03-12 09:46:27 -0400951 goto err_wr;
952 }
953 break;
954
955 case FMODE_READ | FMODE_WRITE:
956 /*
957 * O_RDWR
958 * POSIX.1 leaves this case "undefined" when O_NONBLOCK is set.
959 * This implementation will NEVER block on a O_RDWR open, since
960 * the process can at least talk to itself.
961 */
Al Virof776c732013-03-12 09:46:27 -0400962
963 pipe->readers++;
964 pipe->writers++;
965 pipe->r_counter++;
966 pipe->w_counter++;
967 if (pipe->readers == 1 || pipe->writers == 1)
Al Virofc7478a2013-03-21 02:07:59 -0400968 wake_up_partner(pipe);
Al Virof776c732013-03-12 09:46:27 -0400969 break;
970
971 default:
972 ret = -EINVAL;
973 goto err;
974 }
975
976 /* Ok! */
Al Viroebec73f2013-03-21 12:24:01 -0400977 __pipe_unlock(pipe);
Al Virof776c732013-03-12 09:46:27 -0400978 return 0;
979
980err_rd:
981 if (!--pipe->readers)
982 wake_up_interruptible(&pipe->wait);
983 ret = -ERESTARTSYS;
984 goto err;
985
986err_wr:
987 if (!--pipe->writers)
988 wake_up_interruptible(&pipe->wait);
989 ret = -ERESTARTSYS;
990 goto err;
991
992err:
Al Viroebec73f2013-03-21 12:24:01 -0400993 __pipe_unlock(pipe);
Linus Torvaldsb0d8d222013-12-02 09:44:51 -0800994
995 put_pipe_info(inode, pipe);
Al Virof776c732013-03-12 09:46:27 -0400996 return ret;
997}
998
Al Viro599a0ac2013-03-12 09:58:10 -0400999const struct file_operations pipefifo_fops = {
1000 .open = fifo_open,
1001 .llseek = no_llseek,
Al Virofb9096a2014-04-02 19:56:54 -04001002 .read_iter = pipe_read,
Al Virof0d1bec2014-04-03 15:05:18 -04001003 .write_iter = pipe_write,
Al Viro599a0ac2013-03-12 09:58:10 -04001004 .poll = pipe_poll,
1005 .unlocked_ioctl = pipe_ioctl,
1006 .release = pipe_release,
1007 .fasync = pipe_fasync,
Al Virof776c732013-03-12 09:46:27 -04001008};
1009
Ulrich Drepperd35c7b02008-05-03 15:10:37 -04001010/*
Michael Kerrisk (man-pages)f491bd72016-10-11 13:53:22 -07001011 * Currently we rely on the pipe array holding a power-of-2 number
1012 * of pages.
1013 */
1014static inline unsigned int round_pipe_size(unsigned int size)
1015{
1016 unsigned long nr_pages;
1017
1018 nr_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
1019 return roundup_pow_of_two(nr_pages) << PAGE_SHIFT;
1020}
1021
1022/*
Jens Axboe35f3d142010-05-20 10:43:18 +02001023 * Allocate a new array of pipe buffers and copy the info over. Returns the
1024 * pipe size if successful, or return -ERROR on error.
1025 */
Michael Kerrisk (man-pages)d37d4162016-10-11 13:53:25 -07001026static long pipe_set_size(struct pipe_inode_info *pipe, unsigned long arg)
Jens Axboe35f3d142010-05-20 10:43:18 +02001027{
1028 struct pipe_buffer *bufs;
Michael Kerrisk (man-pages)d37d4162016-10-11 13:53:25 -07001029 unsigned int size, nr_pages;
Michael Kerrisk (man-pages)b0b91d12016-10-11 13:53:31 -07001030 long ret = 0;
Michael Kerrisk (man-pages)d37d4162016-10-11 13:53:25 -07001031
1032 size = round_pipe_size(arg);
1033 nr_pages = size >> PAGE_SHIFT;
1034
1035 if (!nr_pages)
1036 return -EINVAL;
1037
Michael Kerrisk (man-pages)b0b91d12016-10-11 13:53:31 -07001038 /*
1039 * If trying to increase the pipe capacity, check that an
1040 * unprivileged user is not trying to exceed various limits
1041 * (soft limit check here, hard limit check just below).
1042 * Decreasing the pipe capacity is always permitted, even
1043 * if the user is currently over a limit.
1044 */
1045 if (nr_pages > pipe->buffers &&
1046 size > pipe_max_size && !capable(CAP_SYS_RESOURCE))
Michael Kerrisk (man-pages)d37d4162016-10-11 13:53:25 -07001047 return -EPERM;
1048
Michael Kerrisk (man-pages)b0b91d12016-10-11 13:53:31 -07001049 account_pipe_buffers(pipe->user, pipe->buffers, nr_pages);
1050
1051 if (nr_pages > pipe->buffers &&
1052 (too_many_pipe_buffers_hard(pipe->user) ||
1053 too_many_pipe_buffers_soft(pipe->user)) &&
1054 !capable(CAP_SYS_RESOURCE) && !capable(CAP_SYS_ADMIN)) {
1055 ret = -EPERM;
1056 goto out_revert_acct;
1057 }
Jens Axboe35f3d142010-05-20 10:43:18 +02001058
1059 /*
Jens Axboe35f3d142010-05-20 10:43:18 +02001060 * We can shrink the pipe, if arg >= pipe->nrbufs. Since we don't
1061 * expect a lot of shrink+grow operations, just free and allocate
1062 * again like we would do for growing. If the pipe currently
1063 * contains more buffers than arg, then return busy.
1064 */
Michael Kerrisk (man-pages)b0b91d12016-10-11 13:53:31 -07001065 if (nr_pages < pipe->nrbufs) {
1066 ret = -EBUSY;
1067 goto out_revert_acct;
1068 }
Jens Axboe35f3d142010-05-20 10:43:18 +02001069
Vladimir Davydovd86133b2016-07-26 15:24:33 -07001070 bufs = kcalloc(nr_pages, sizeof(*bufs),
1071 GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
Michael Kerrisk (man-pages)b0b91d12016-10-11 13:53:31 -07001072 if (unlikely(!bufs)) {
1073 ret = -ENOMEM;
1074 goto out_revert_acct;
1075 }
Jens Axboe35f3d142010-05-20 10:43:18 +02001076
1077 /*
1078 * The pipe array wraps around, so just start the new one at zero
1079 * and adjust the indexes.
1080 */
1081 if (pipe->nrbufs) {
Miklos Szeredi1d862f42010-06-08 16:28:45 +02001082 unsigned int tail;
1083 unsigned int head;
Jens Axboe35f3d142010-05-20 10:43:18 +02001084
Miklos Szeredi1d862f42010-06-08 16:28:45 +02001085 tail = pipe->curbuf + pipe->nrbufs;
1086 if (tail < pipe->buffers)
1087 tail = 0;
1088 else
1089 tail &= (pipe->buffers - 1);
1090
1091 head = pipe->nrbufs - tail;
Jens Axboe35f3d142010-05-20 10:43:18 +02001092 if (head)
1093 memcpy(bufs, pipe->bufs + pipe->curbuf, head * sizeof(struct pipe_buffer));
1094 if (tail)
Miklos Szeredi1d862f42010-06-08 16:28:45 +02001095 memcpy(bufs + head, pipe->bufs, tail * sizeof(struct pipe_buffer));
Jens Axboe35f3d142010-05-20 10:43:18 +02001096 }
1097
1098 pipe->curbuf = 0;
1099 kfree(pipe->bufs);
1100 pipe->bufs = bufs;
Jens Axboeb9598db2010-05-24 19:34:43 +02001101 pipe->buffers = nr_pages;
1102 return nr_pages * PAGE_SIZE;
Michael Kerrisk (man-pages)b0b91d12016-10-11 13:53:31 -07001103
1104out_revert_acct:
1105 account_pipe_buffers(pipe->user, nr_pages, pipe->buffers);
1106 return ret;
Jens Axboe35f3d142010-05-20 10:43:18 +02001107}
1108
Jens Axboeff9da692010-06-03 14:54:39 +02001109/*
Jens Axboeff9da692010-06-03 14:54:39 +02001110 * This should work even if CONFIG_PROC_FS isn't set, as proc_dointvec_minmax
1111 * will return an error.
1112 */
1113int pipe_proc_fn(struct ctl_table *table, int write, void __user *buf,
1114 size_t *lenp, loff_t *ppos)
1115{
1116 int ret;
1117
1118 ret = proc_dointvec_minmax(table, write, buf, lenp, ppos);
1119 if (ret < 0 || !write)
1120 return ret;
1121
1122 pipe_max_size = round_pipe_size(pipe_max_size);
1123 return ret;
1124}
1125
Linus Torvalds72083642010-11-28 16:27:19 -08001126/*
1127 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1128 * location, so checking ->i_pipe is not enough to verify that this is a
1129 * pipe.
1130 */
1131struct pipe_inode_info *get_pipe_info(struct file *file)
1132{
Al Virode32ec42013-03-21 11:16:56 -04001133 return file->f_op == &pipefifo_fops ? file->private_data : NULL;
Linus Torvalds72083642010-11-28 16:27:19 -08001134}
1135
Jens Axboe35f3d142010-05-20 10:43:18 +02001136long pipe_fcntl(struct file *file, unsigned int cmd, unsigned long arg)
1137{
1138 struct pipe_inode_info *pipe;
1139 long ret;
1140
Linus Torvaldsc66fb342010-11-28 14:09:57 -08001141 pipe = get_pipe_info(file);
Jens Axboe35f3d142010-05-20 10:43:18 +02001142 if (!pipe)
1143 return -EBADF;
1144
Al Viroebec73f2013-03-21 12:24:01 -04001145 __pipe_lock(pipe);
Jens Axboe35f3d142010-05-20 10:43:18 +02001146
1147 switch (cmd) {
Michael Kerrisk (man-pages)d37d4162016-10-11 13:53:25 -07001148 case F_SETPIPE_SZ:
1149 ret = pipe_set_size(pipe, arg);
Jens Axboe35f3d142010-05-20 10:43:18 +02001150 break;
1151 case F_GETPIPE_SZ:
Jens Axboeb9598db2010-05-24 19:34:43 +02001152 ret = pipe->buffers * PAGE_SIZE;
Jens Axboe35f3d142010-05-20 10:43:18 +02001153 break;
1154 default:
1155 ret = -EINVAL;
1156 break;
1157 }
1158
Al Viroebec73f2013-03-21 12:24:01 -04001159 __pipe_unlock(pipe);
Jens Axboe35f3d142010-05-20 10:43:18 +02001160 return ret;
1161}
1162
Nick Pigginff0c7d12011-01-07 17:49:50 +11001163static const struct super_operations pipefs_ops = {
1164 .destroy_inode = free_inode_nonrcu,
Pavel Emelyanovd70ef972011-10-31 17:10:04 -07001165 .statfs = simple_statfs,
Nick Pigginff0c7d12011-01-07 17:49:50 +11001166};
1167
Jens Axboe35f3d142010-05-20 10:43:18 +02001168/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 * pipefs should _never_ be mounted by userland - too much of security hassle,
1170 * no real gain from having the whole whorehouse mounted. So we don't need
1171 * any operations on the root directory. However, we need a non-trivial
1172 * d_name - pipe: will go nicely and kill the special-casing in procfs.
1173 */
Al Viro51139ad2010-07-25 23:47:46 +04001174static struct dentry *pipefs_mount(struct file_system_type *fs_type,
1175 int flags, const char *dev_name, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176{
Al Viroc74a1cb2011-01-12 16:59:34 -05001177 return mount_pseudo(fs_type, "pipe:", &pipefs_ops,
1178 &pipefs_dentry_operations, PIPEFS_MAGIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179}
1180
1181static struct file_system_type pipe_fs_type = {
1182 .name = "pipefs",
Al Viro51139ad2010-07-25 23:47:46 +04001183 .mount = pipefs_mount,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 .kill_sb = kill_anon_super,
1185};
1186
1187static int __init init_pipe_fs(void)
1188{
1189 int err = register_filesystem(&pipe_fs_type);
Ingo Molnar341b4462006-04-11 13:57:45 +02001190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 if (!err) {
1192 pipe_mnt = kern_mount(&pipe_fs_type);
1193 if (IS_ERR(pipe_mnt)) {
1194 err = PTR_ERR(pipe_mnt);
1195 unregister_filesystem(&pipe_fs_type);
1196 }
1197 }
1198 return err;
1199}
1200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201fs_initcall(init_pipe_fs);