include/linux/pipe_fs_i.h

   1 #ifndef _LINUX_PIPE_FS_I_H
   2 #define _LINUX_PIPE_FS_I_H
   3
   4 #define PIPEFS_MAGIC 0x50495045
   5
   6 #define PIPE_DEF_BUFFERS        16
   7
   8 #define PIPE_BUF_FLAG_LRU       0x01    /* page is on the LRU */
   9 #define PIPE_BUF_FLAG_ATOMIC    0x02    /* was atomically mapped */
  10 #define PIPE_BUF_FLAG_GIFT      0x04    /* page is a gift */
  11 #define PIPE_BUF_FLAG_PACKET    0x08    /* read() as a packet */
  12
  13 /**
  14  *      struct pipe_buffer - a linux kernel pipe buffer
  15  *      @page: the page containing the data for the pipe buffer
  16  *      @offset: offset of data inside the @page
  17  *      @len: length of data inside the @page
  18  *      @ops: operations associated with this buffer. See @pipe_buf_operations.
  19  *      @flags: pipe buffer flags. See above.
  20  *      @private: private data owned by the ops.
  21  **/
  22 struct pipe_buffer {
  23         struct page *page;
  24         unsigned int offset, len;
  25         const struct pipe_buf_operations *ops;
  26         unsigned int flags;
  27         unsigned long private;
  28 };
  29
  30 /**
  31  *      struct pipe_inode_info - a linux kernel pipe
  32  *      @wait: reader/writer wait point in case of empty/full pipe
  33  *      @nrbufs: the number of non-empty pipe buffers in this pipe
  34  *      @buffers: total number of buffers (should be a power of 2)
  35  *      @curbuf: the current pipe buffer entry
  36  *      @tmp_page: cached released page
  37  *      @readers: number of current readers of this pipe
  38  *      @writers: number of current writers of this pipe
  39  *      @waiting_writers: number of writers blocked waiting for room
  40  *      @r_counter: reader counter
  41  *      @w_counter: writer counter
  42  *      @fasync_readers: reader side fasync
  43  *      @fasync_writers: writer side fasync
  44  *      @inode: inode this pipe is attached to
  45  *      @bufs: the circular array of pipe buffers
  46  *      @user: the user who created this pipe
  47  **/
  48 struct pipe_inode_info {
  49         wait_queue_head_t wait;
  50         unsigned int nrbufs, curbuf, buffers;
  51         unsigned int readers;
  52         unsigned int writers;
  53         unsigned int waiting_writers;
  54         unsigned int r_counter;
  55         unsigned int w_counter;
  56         struct page *tmp_page;
  57         struct fasync_struct *fasync_readers;
  58         struct fasync_struct *fasync_writers;
  59         struct inode *inode;
  60         struct pipe_buffer *bufs;
  61         struct user_struct *user;
  62 };
  63
  64 /*
  65  * Note on the nesting of these functions:
  66  *
  67  * ->confirm()
  68  *      ->steal()
  69  *      ...
  70  *      ->map()
  71  *      ...
  72  *      ->unmap()
  73  *
  74  * That is, ->map() must be called on a confirmed buffer,
  75  * same goes for ->steal(). See below for the meaning of each
  76  * operation. Also see kerneldoc in fs/pipe.c for the pipe
  77  * and generic variants of these hooks.
  78  */
  79 struct pipe_buf_operations {
  80         /*
  81          * This is set to 1, if the generic pipe read/write may coalesce
  82          * data into an existing buffer. If this is set to 0, a new pipe
  83          * page segment is always used for new data.
  84          */
  85         int can_merge;
  86
  87         /*
  88          * ->map() returns a virtual address mapping of the pipe buffer.
  89          * The last integer flag reflects whether this should be an atomic
  90          * mapping or not. The atomic map is faster, however you can't take
  91          * page faults before calling ->unmap() again. So if you need to eg
  92          * access user data through copy_to/from_user(), then you must get
  93          * a non-atomic map. ->map() uses the KM_USER0 atomic slot for
  94          * atomic maps, so you can't map more than one pipe_buffer at once
  95          * and you have to be careful if mapping another page as source
  96          * or destination for a copy (IOW, it has to use something else
  97          * than KM_USER0).
  98          */
  99         void * (*map)(struct pipe_inode_info *, struct pipe_buffer *, int);
 100
 101         /*
 102          * Undoes ->map(), finishes the virtual mapping of the pipe buffer.
 103          */
 104         void (*unmap)(struct pipe_inode_info *, struct pipe_buffer *, void *);
 105
 106         /*
 107          * ->confirm() verifies that the data in the pipe buffer is there
 108          * and that the contents are good. If the pages in the pipe belong
 109          * to a file system, we may need to wait for IO completion in this
 110          * hook. Returns 0 for good, or a negative error value in case of
 111          * error.
 112          */
 113         int (*confirm)(struct pipe_inode_info *, struct pipe_buffer *);
 114
 115         /*
 116          * When the contents of this pipe buffer has been completely
 117          * consumed by a reader, ->release() is called.
 118          */
 119         void (*release)(struct pipe_inode_info *, struct pipe_buffer *);
 120
 121         /*
 122          * Attempt to take ownership of the pipe buffer and its contents.
 123          * ->steal() returns 0 for success, in which case the contents
 124          * of the pipe (the buf->page) is locked and now completely owned
 125          * by the caller. The page may then be transferred to a different
 126          * mapping, the most often used case is insertion into different
 127          * file address space cache.
 128          */
 129         int (*steal)(struct pipe_inode_info *, struct pipe_buffer *);
 130
 131         /*
 132          * Get a reference to the pipe buffer.
 133          */
 134         void (*get)(struct pipe_inode_info *, struct pipe_buffer *);
 135 };
 136
 137 /* Differs from PIPE_BUF in that PIPE_SIZE is the length of the actual
 138    memory allocation, whereas PIPE_BUF makes atomicity guarantees.  */
 139 #define PIPE_SIZE               PAGE_SIZE
 140
 141 /* Pipe lock and unlock operations */
 142 void pipe_lock(struct pipe_inode_info *);
 143 void pipe_unlock(struct pipe_inode_info *);
 144 void pipe_double_lock(struct pipe_inode_info *, struct pipe_inode_info *);
 145
 146 extern unsigned int pipe_max_size, pipe_min_size;
 147 extern unsigned long pipe_user_pages_hard;
 148 extern unsigned long pipe_user_pages_soft;
 149 int pipe_proc_fn(struct ctl_table *, int, void __user *, size_t *, loff_t *);
 150
 151
 152 /* Drop the inode semaphore and wait for a pipe event, atomically */
 153 void pipe_wait(struct pipe_inode_info *pipe);
 154
 155 struct pipe_inode_info * alloc_pipe_info(struct inode * inode);
 156 void free_pipe_info(struct inode * inode);
 157 void __free_pipe_info(struct pipe_inode_info *);
 158
 159 /* Generic pipe buffer ops functions */
 160 void *generic_pipe_buf_map(struct pipe_inode_info *, struct pipe_buffer *, int);
 161 void generic_pipe_buf_unmap(struct pipe_inode_info *, struct pipe_buffer *, void *);
 162 void generic_pipe_buf_get(struct pipe_inode_info *, struct pipe_buffer *);
 163 int generic_pipe_buf_confirm(struct pipe_inode_info *, struct pipe_buffer *);
 164 int generic_pipe_buf_steal(struct pipe_inode_info *, struct pipe_buffer *);
 165 void generic_pipe_buf_release(struct pipe_inode_info *, struct pipe_buffer *);
 166
 167 extern const struct pipe_buf_operations nosteal_pipe_buf_ops;
 168
 169 /* for F_SETPIPE_SZ and F_GETPIPE_SZ */
 170 long pipe_fcntl(struct file *, unsigned int, unsigned long arg);
 171 struct pipe_inode_info *get_pipe_info(struct file *file);
 172
 173 #endif