include/linux/pipe_fs_i.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_PIPE_FS_I_H
   3 #define _LINUX_PIPE_FS_I_H
   4
   5 #define PIPE_DEF_BUFFERS        16
   6
   7 #define PIPE_BUF_FLAG_LRU       0x01    /* page is on the LRU */
   8 #define PIPE_BUF_FLAG_ATOMIC    0x02    /* was atomically mapped */
   9 #define PIPE_BUF_FLAG_GIFT      0x04    /* page is a gift */
  10 #define PIPE_BUF_FLAG_PACKET    0x08    /* read() as a packet */
  11 #define PIPE_BUF_FLAG_WHOLE     0x10    /* read() must return entire buffer or error */
  12 #ifdef CONFIG_WATCH_QUEUE
  13 #define PIPE_BUF_FLAG_LOSS      0x20    /* Message loss happened after this buffer */
  14 #endif
  15
  16 /**
  17  *      struct pipe_buffer - a linux kernel pipe buffer
  18  *      @page: the page containing the data for the pipe buffer
  19  *      @offset: offset of data inside the @page
  20  *      @len: length of data inside the @page
  21  *      @ops: operations associated with this buffer. See @pipe_buf_operations.
  22  *      @flags: pipe buffer flags. See above.
  23  *      @private: private data owned by the ops.
  24  **/
  25 struct pipe_buffer {
  26         struct page *page;
  27         unsigned int offset, len;
  28         const struct pipe_buf_operations *ops;
  29         unsigned int flags;
  30         unsigned long private;
  31 };
  32
  33 /**
  34  *      struct pipe_inode_info - a linux kernel pipe
  35  *      @mutex: mutex protecting the whole thing
  36  *      @rd_wait: reader wait point in case of empty pipe
  37  *      @wr_wait: writer wait point in case of full pipe
  38  *      @head: The point of buffer production
  39  *      @tail: The point of buffer consumption
  40  *      @note_loss: The next read() should insert a data-lost message
  41  *      @max_usage: The maximum number of slots that may be used in the ring
  42  *      @ring_size: total number of buffers (should be a power of 2)
  43  *      @nr_accounted: The amount this pipe accounts for in user->pipe_bufs
  44  *      @tmp_page: cached released page
  45  *      @readers: number of current readers of this pipe
  46  *      @writers: number of current writers of this pipe
  47  *      @files: number of struct file referring this pipe (protected by ->i_lock)
  48  *      @r_counter: reader counter
  49  *      @w_counter: writer counter
  50  *      @fasync_readers: reader side fasync
  51  *      @fasync_writers: writer side fasync
  52  *      @bufs: the circular array of pipe buffers
  53  *      @user: the user who created this pipe
  54  *      @watch_queue: If this pipe is a watch_queue, this is the stuff for that
  55  **/
  56 struct pipe_inode_info {
  57         struct mutex mutex;
  58         wait_queue_head_t rd_wait, wr_wait;
  59         unsigned int head;
  60         unsigned int tail;
  61         unsigned int max_usage;
  62         unsigned int ring_size;
  63 #ifdef CONFIG_WATCH_QUEUE
  64         bool note_loss;
  65 #endif
  66         unsigned int nr_accounted;
  67         unsigned int readers;
  68         unsigned int writers;
  69         unsigned int files;
  70         unsigned int r_counter;
  71         unsigned int w_counter;
  72         struct page *tmp_page;
  73         struct fasync_struct *fasync_readers;
  74         struct fasync_struct *fasync_writers;
  75         struct pipe_buffer *bufs;
  76         struct user_struct *user;
  77 #ifdef CONFIG_WATCH_QUEUE
  78         struct watch_queue *watch_queue;
  79 #endif
  80 };
  81
  82 /*
  83  * Note on the nesting of these functions:
  84  *
  85  * ->confirm()
  86  *      ->steal()
  87  *
  88  * That is, ->steal() must be called on a confirmed buffer.
  89  * See below for the meaning of each operation. Also see kerneldoc
  90  * in fs/pipe.c for the pipe and generic variants of these hooks.
  91  */
  92 struct pipe_buf_operations {
  93         /*
  94          * ->confirm() verifies that the data in the pipe buffer is there
  95          * and that the contents are good. If the pages in the pipe belong
  96          * to a file system, we may need to wait for IO completion in this
  97          * hook. Returns 0 for good, or a negative error value in case of
  98          * error.
  99          */
 100         int (*confirm)(struct pipe_inode_info *, struct pipe_buffer *);
 101
 102         /*
 103          * When the contents of this pipe buffer has been completely
 104          * consumed by a reader, ->release() is called.
 105          */
 106         void (*release)(struct pipe_inode_info *, struct pipe_buffer *);
 107
 108         /*
 109          * Attempt to take ownership of the pipe buffer and its contents.
 110          * ->steal() returns 0 for success, in which case the contents
 111          * of the pipe (the buf->page) is locked and now completely owned
 112          * by the caller. The page may then be transferred to a different
 113          * mapping, the most often used case is insertion into different
 114          * file address space cache.
 115          */
 116         int (*steal)(struct pipe_inode_info *, struct pipe_buffer *);
 117
 118         /*
 119          * Get a reference to the pipe buffer.
 120          */
 121         bool (*get)(struct pipe_inode_info *, struct pipe_buffer *);
 122 };
 123
 124 /**
 125  * pipe_empty - Return true if the pipe is empty
 126  * @head: The pipe ring head pointer
 127  * @tail: The pipe ring tail pointer
 128  */
 129 static inline bool pipe_empty(unsigned int head, unsigned int tail)
 130 {
 131         return head == tail;
 132 }
 133
 134 /**
 135  * pipe_occupancy - Return number of slots used in the pipe
 136  * @head: The pipe ring head pointer
 137  * @tail: The pipe ring tail pointer
 138  */
 139 static inline unsigned int pipe_occupancy(unsigned int head, unsigned int tail)
 140 {
 141         return head - tail;
 142 }
 143
 144 /**
 145  * pipe_full - Return true if the pipe is full
 146  * @head: The pipe ring head pointer
 147  * @tail: The pipe ring tail pointer
 148  * @limit: The maximum amount of slots available.
 149  */
 150 static inline bool pipe_full(unsigned int head, unsigned int tail,
 151                              unsigned int limit)
 152 {
 153         return pipe_occupancy(head, tail) >= limit;
 154 }
 155
 156 /**
 157  * pipe_space_for_user - Return number of slots available to userspace
 158  * @head: The pipe ring head pointer
 159  * @tail: The pipe ring tail pointer
 160  * @pipe: The pipe info structure
 161  */
 162 static inline unsigned int pipe_space_for_user(unsigned int head, unsigned int tail,
 163                                                struct pipe_inode_info *pipe)
 164 {
 165         unsigned int p_occupancy, p_space;
 166
 167         p_occupancy = pipe_occupancy(head, tail);
 168         if (p_occupancy >= pipe->max_usage)
 169                 return 0;
 170         p_space = pipe->ring_size - p_occupancy;
 171         if (p_space > pipe->max_usage)
 172                 p_space = pipe->max_usage;
 173         return p_space;
 174 }
 175
 176 /**
 177  * pipe_buf_get - get a reference to a pipe_buffer
 178  * @pipe:       the pipe that the buffer belongs to
 179  * @buf:        the buffer to get a reference to
 180  *
 181  * Return: %true if the reference was successfully obtained.
 182  */
 183 static inline __must_check bool pipe_buf_get(struct pipe_inode_info *pipe,
 184                                 struct pipe_buffer *buf)
 185 {
 186         return buf->ops->get(pipe, buf);
 187 }
 188
 189 /**
 190  * pipe_buf_release - put a reference to a pipe_buffer
 191  * @pipe:       the pipe that the buffer belongs to
 192  * @buf:        the buffer to put a reference to
 193  */
 194 static inline void pipe_buf_release(struct pipe_inode_info *pipe,
 195                                     struct pipe_buffer *buf)
 196 {
 197         const struct pipe_buf_operations *ops = buf->ops;
 198
 199         buf->ops = NULL;
 200         ops->release(pipe, buf);
 201 }
 202
 203 /**
 204  * pipe_buf_confirm - verify contents of the pipe buffer
 205  * @pipe:       the pipe that the buffer belongs to
 206  * @buf:        the buffer to confirm
 207  */
 208 static inline int pipe_buf_confirm(struct pipe_inode_info *pipe,
 209                                    struct pipe_buffer *buf)
 210 {
 211         return buf->ops->confirm(pipe, buf);
 212 }
 213
 214 /**
 215  * pipe_buf_steal - attempt to take ownership of a pipe_buffer
 216  * @pipe:       the pipe that the buffer belongs to
 217  * @buf:        the buffer to attempt to steal
 218  */
 219 static inline int pipe_buf_steal(struct pipe_inode_info *pipe,
 220                                  struct pipe_buffer *buf)
 221 {
 222         return buf->ops->steal(pipe, buf);
 223 }
 224
 225 /* Differs from PIPE_BUF in that PIPE_SIZE is the length of the actual
 226    memory allocation, whereas PIPE_BUF makes atomicity guarantees.  */
 227 #define PIPE_SIZE               PAGE_SIZE
 228
 229 /* Pipe lock and unlock operations */
 230 void pipe_lock(struct pipe_inode_info *);
 231 void pipe_unlock(struct pipe_inode_info *);
 232 void pipe_double_lock(struct pipe_inode_info *, struct pipe_inode_info *);
 233
 234 extern unsigned int pipe_max_size;
 235 extern unsigned long pipe_user_pages_hard;
 236 extern unsigned long pipe_user_pages_soft;
 237
 238 /* Drop the inode semaphore and wait for a pipe event, atomically */
 239 void pipe_wait(struct pipe_inode_info *pipe);
 240
 241 struct pipe_inode_info *alloc_pipe_info(void);
 242 void free_pipe_info(struct pipe_inode_info *);
 243
 244 /* Generic pipe buffer ops functions */
 245 bool generic_pipe_buf_get(struct pipe_inode_info *, struct pipe_buffer *);
 246 int generic_pipe_buf_confirm(struct pipe_inode_info *, struct pipe_buffer *);
 247 int generic_pipe_buf_steal(struct pipe_inode_info *, struct pipe_buffer *);
 248 int generic_pipe_buf_nosteal(struct pipe_inode_info *, struct pipe_buffer *);
 249 void generic_pipe_buf_release(struct pipe_inode_info *, struct pipe_buffer *);
 250 void pipe_buf_mark_unmergeable(struct pipe_buffer *buf);
 251
 252 extern const struct pipe_buf_operations nosteal_pipe_buf_ops;
 253
 254 #ifdef CONFIG_WATCH_QUEUE
 255 unsigned long account_pipe_buffers(struct user_struct *user,
 256                                    unsigned long old, unsigned long new);
 257 bool too_many_pipe_buffers_soft(unsigned long user_bufs);
 258 bool too_many_pipe_buffers_hard(unsigned long user_bufs);
 259 bool pipe_is_unprivileged_user(void);
 260 #endif
 261
 262 /* for F_SETPIPE_SZ and F_GETPIPE_SZ */
 263 #ifdef CONFIG_WATCH_QUEUE
 264 int pipe_resize_ring(struct pipe_inode_info *pipe, unsigned int nr_slots);
 265 #endif
 266 long pipe_fcntl(struct file *, unsigned int, unsigned long arg);
 267 struct pipe_inode_info *get_pipe_info(struct file *file, bool for_splice);
 268
 269 int create_pipe_files(struct file **, int);
 270 unsigned int round_pipe_size(unsigned long size);
 271
 272 #endif