pipe_fs_i.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. #ifndef _LINUX_PIPE_FS_I_H
  2. #define _LINUX_PIPE_FS_I_H
  3. #define PIPE_DEF_BUFFERS 16
  4. #define PIPE_BUF_FLAG_LRU 0x01 /* page is on the LRU */
  5. #define PIPE_BUF_FLAG_ATOMIC 0x02 /* was atomically mapped */
  6. #define PIPE_BUF_FLAG_GIFT 0x04 /* page is a gift */
  7. #define PIPE_BUF_FLAG_PACKET 0x08 /* read() as a packet */
  8. /**
  9. * struct pipe_buffer - a linux kernel pipe buffer
  10. * @page: the page containing the data for the pipe buffer
  11. * @offset: offset of data inside the @page
  12. * @len: length of data inside the @page
  13. * @ops: operations associated with this buffer. See @pipe_buf_operations.
  14. * @flags: pipe buffer flags. See above.
  15. * @private: private data owned by the ops.
  16. **/
  17. struct pipe_buffer {
  18. struct page *page;
  19. unsigned int offset, len;
  20. const struct pipe_buf_operations *ops;
  21. unsigned int flags;
  22. unsigned long private;
  23. };
  24. /**
  25. * struct pipe_inode_info - a linux kernel pipe
  26. * @mutex: mutex protecting the whole thing
  27. * @wait: reader/writer wait point in case of empty/full pipe
  28. * @nrbufs: the number of non-empty pipe buffers in this pipe
  29. * @buffers: total number of buffers (should be a power of 2)
  30. * @curbuf: the current pipe buffer entry
  31. * @tmp_page: cached released page
  32. * @readers: number of current readers of this pipe
  33. * @writers: number of current writers of this pipe
  34. * @files: number of struct file referring this pipe (protected by ->i_lock)
  35. * @waiting_writers: number of writers blocked waiting for room
  36. * @r_counter: reader counter
  37. * @w_counter: writer counter
  38. * @fasync_readers: reader side fasync
  39. * @fasync_writers: writer side fasync
  40. * @bufs: the circular array of pipe buffers
  41. **/
  42. struct pipe_inode_info {
  43. struct mutex mutex;
  44. wait_queue_head_t wait;
  45. unsigned int nrbufs, curbuf, buffers;
  46. unsigned int readers;
  47. unsigned int writers;
  48. unsigned int files;
  49. unsigned int waiting_writers;
  50. unsigned int r_counter;
  51. unsigned int w_counter;
  52. struct page *tmp_page;
  53. struct fasync_struct *fasync_readers;
  54. struct fasync_struct *fasync_writers;
  55. struct pipe_buffer *bufs;
  56. };
  57. /*
  58. * Note on the nesting of these functions:
  59. *
  60. * ->confirm()
  61. * ->steal()
  62. * ...
  63. * ->map()
  64. * ...
  65. * ->unmap()
  66. *
  67. * That is, ->map() must be called on a confirmed buffer,
  68. * same goes for ->steal(). See below for the meaning of each
  69. * operation. Also see kerneldoc in fs/pipe.c for the pipe
  70. * and generic variants of these hooks.
  71. */
  72. struct pipe_buf_operations {
  73. /*
  74. * This is set to 1, if the generic pipe read/write may coalesce
  75. * data into an existing buffer. If this is set to 0, a new pipe
  76. * page segment is always used for new data.
  77. */
  78. int can_merge;
  79. /*
  80. * ->confirm() verifies that the data in the pipe buffer is there
  81. * and that the contents are good. If the pages in the pipe belong
  82. * to a file system, we may need to wait for IO completion in this
  83. * hook. Returns 0 for good, or a negative error value in case of
  84. * error.
  85. */
  86. int (*confirm)(struct pipe_inode_info *, struct pipe_buffer *);
  87. /*
  88. * When the contents of this pipe buffer has been completely
  89. * consumed by a reader, ->release() is called.
  90. */
  91. void (*release)(struct pipe_inode_info *, struct pipe_buffer *);
  92. /*
  93. * Attempt to take ownership of the pipe buffer and its contents.
  94. * ->steal() returns 0 for success, in which case the contents
  95. * of the pipe (the buf->page) is locked and now completely owned
  96. * by the caller. The page may then be transferred to a different
  97. * mapping, the most often used case is insertion into different
  98. * file address space cache.
  99. */
  100. int (*steal)(struct pipe_inode_info *, struct pipe_buffer *);
  101. /*
  102. * Get a reference to the pipe buffer.
  103. */
  104. void (*get)(struct pipe_inode_info *, struct pipe_buffer *);
  105. };
  106. /* Differs from PIPE_BUF in that PIPE_SIZE is the length of the actual
  107. memory allocation, whereas PIPE_BUF makes atomicity guarantees. */
  108. #define PIPE_SIZE PAGE_SIZE
  109. /* Pipe lock and unlock operations */
  110. void pipe_lock(struct pipe_inode_info *);
  111. void pipe_unlock(struct pipe_inode_info *);
  112. void pipe_double_lock(struct pipe_inode_info *, struct pipe_inode_info *);
  113. extern unsigned int pipe_max_size, pipe_min_size;
  114. int pipe_proc_fn(struct ctl_table *, int, void __user *, size_t *, loff_t *);
  115. /* Drop the inode semaphore and wait for a pipe event, atomically */
  116. void pipe_wait(struct pipe_inode_info *pipe);
  117. struct pipe_inode_info *alloc_pipe_info(void);
  118. void free_pipe_info(struct pipe_inode_info *);
  119. /* Generic pipe buffer ops functions */
  120. void generic_pipe_buf_get(struct pipe_inode_info *, struct pipe_buffer *);
  121. int generic_pipe_buf_confirm(struct pipe_inode_info *, struct pipe_buffer *);
  122. int generic_pipe_buf_steal(struct pipe_inode_info *, struct pipe_buffer *);
  123. void generic_pipe_buf_release(struct pipe_inode_info *, struct pipe_buffer *);
  124. extern const struct pipe_buf_operations nosteal_pipe_buf_ops;
  125. /* for F_SETPIPE_SZ and F_GETPIPE_SZ */
  126. long pipe_fcntl(struct file *, unsigned int, unsigned long arg);
  127. struct pipe_inode_info *get_pipe_info(struct file *file);
  128. int create_pipe_files(struct file **, int);
  129. #endif