proc_fs.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. #ifndef _LINUX_PROC_FS_H
  2. #define _LINUX_PROC_FS_H
  3. #include <linux/slab.h>
  4. #include <linux/fs.h>
  5. #include <linux/spinlock.h>
  6. #include <linux/magic.h>
  7. #include <linux/atomic.h>
  8. struct net;
  9. struct completion;
  10. struct mm_struct;
  11. /*
  12. * The proc filesystem constants/structures
  13. */
  14. /*
  15. * Offset of the first process in the /proc root directory..
  16. */
  17. #define FIRST_PROCESS_ENTRY 256
  18. /* Worst case buffer size needed for holding an integer. */
  19. #define PROC_NUMBUF 13
  20. /*
  21. * We always define these enumerators
  22. */
  23. enum {
  24. PROC_ROOT_INO = 1,
  25. PROC_IPC_INIT_INO = 0xEFFFFFFFU,
  26. PROC_UTS_INIT_INO = 0xEFFFFFFEU,
  27. PROC_USER_INIT_INO = 0xEFFFFFFDU,
  28. PROC_PID_INIT_INO = 0xEFFFFFFCU,
  29. };
  30. /*
  31. * This is not completely implemented yet. The idea is to
  32. * create an in-memory tree (like the actual /proc filesystem
  33. * tree) of these proc_dir_entries, so that we can dynamically
  34. * add new files to /proc.
  35. *
  36. * The "next" pointer creates a linked list of one /proc directory,
  37. * while parent/subdir create the directory structure (every
  38. * /proc file has a parent, but "subdir" is NULL for all
  39. * non-directory entries).
  40. */
  41. struct proc_dir_entry {
  42. unsigned int low_ino;
  43. umode_t mode;
  44. nlink_t nlink;
  45. kuid_t uid;
  46. kgid_t gid;
  47. loff_t size;
  48. const struct inode_operations *proc_iops;
  49. const struct file_operations *proc_fops;
  50. struct proc_dir_entry *next, *parent, *subdir;
  51. void *data;
  52. atomic_t count; /* use count */
  53. atomic_t in_use; /* number of callers into module in progress; */
  54. /* negative -> it's going away RSN */
  55. struct completion *pde_unload_completion;
  56. struct list_head pde_openers; /* who did ->open, but not ->release */
  57. spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  58. u8 namelen;
  59. char name[];
  60. };
  61. #ifdef CONFIG_PROC_FS
  62. extern void proc_root_init(void);
  63. void proc_flush_task(struct task_struct *task);
  64. struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
  65. struct proc_dir_entry *parent,
  66. const struct file_operations *proc_fops,
  67. void *data);
  68. extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
  69. extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
  70. struct pid_namespace;
  71. extern int pid_ns_prepare_proc(struct pid_namespace *ns);
  72. extern void pid_ns_release_proc(struct pid_namespace *ns);
  73. /*
  74. * proc_tty.c
  75. */
  76. struct tty_driver;
  77. #ifdef CONFIG_TTY
  78. extern void proc_tty_init(void);
  79. #else
  80. static inline void proc_tty_init(void)
  81. { }
  82. #endif
  83. extern void proc_tty_register_driver(struct tty_driver *driver);
  84. extern void proc_tty_unregister_driver(struct tty_driver *driver);
  85. /*
  86. * proc_devtree.c
  87. */
  88. #ifdef CONFIG_PROC_DEVICETREE
  89. struct device_node;
  90. struct property;
  91. extern void proc_device_tree_init(void);
  92. extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
  93. extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
  94. extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
  95. struct property *prop);
  96. extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
  97. struct property *newprop,
  98. struct property *oldprop);
  99. #endif /* CONFIG_PROC_DEVICETREE */
  100. extern struct proc_dir_entry *proc_symlink(const char *,
  101. struct proc_dir_entry *, const char *);
  102. extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
  103. extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
  104. struct proc_dir_entry *parent);
  105. static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
  106. struct proc_dir_entry *parent, const struct file_operations *proc_fops)
  107. {
  108. return proc_create_data(name, mode, parent, proc_fops, NULL);
  109. }
  110. extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
  111. struct proc_dir_entry *parent);
  112. extern void proc_set_size(struct proc_dir_entry *, loff_t);
  113. extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
  114. extern struct file *proc_ns_fget(int fd);
  115. extern bool proc_ns_inode(struct inode *inode);
  116. extern int proc_alloc_inum(unsigned int *pino);
  117. extern void proc_free_inum(unsigned int inum);
  118. #else
  119. static inline void proc_flush_task(struct task_struct *task)
  120. {
  121. }
  122. #define proc_create(name, mode, parent, fops) ({ (void)(mode), NULL; })
  123. static inline struct proc_dir_entry *proc_create_data(const char *name,
  124. umode_t mode, struct proc_dir_entry *parent,
  125. const struct file_operations *proc_fops, void *data)
  126. {
  127. return NULL;
  128. }
  129. #define remove_proc_entry(name, parent) do {} while (0)
  130. #define remove_proc_subtree(name, parent) do {} while (0)
  131. static inline struct proc_dir_entry *proc_symlink(const char *name,
  132. struct proc_dir_entry *parent,const char *dest) {return NULL;}
  133. static inline struct proc_dir_entry *proc_mkdir(const char *name,
  134. struct proc_dir_entry *parent) {return NULL;}
  135. static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
  136. umode_t mode, struct proc_dir_entry *parent) { return NULL; }
  137. static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
  138. static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
  139. struct tty_driver;
  140. static inline void proc_tty_register_driver(struct tty_driver *driver) {};
  141. static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
  142. static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
  143. {
  144. return 0;
  145. }
  146. static inline void pid_ns_release_proc(struct pid_namespace *ns)
  147. {
  148. }
  149. static inline struct file *proc_ns_fget(int fd)
  150. {
  151. return ERR_PTR(-EINVAL);
  152. }
  153. static inline bool proc_ns_inode(struct inode *inode)
  154. {
  155. return false;
  156. }
  157. static inline int proc_alloc_inum(unsigned int *inum)
  158. {
  159. *inum = 1;
  160. return 0;
  161. }
  162. static inline void proc_free_inum(unsigned int inum)
  163. {
  164. }
  165. #endif /* CONFIG_PROC_FS */
  166. struct nsproxy;
  167. struct proc_ns_operations {
  168. const char *name;
  169. int type;
  170. void *(*get)(struct task_struct *task);
  171. void (*put)(void *ns);
  172. int (*install)(struct nsproxy *nsproxy, void *ns);
  173. unsigned int (*inum)(void *ns);
  174. };
  175. extern const struct proc_ns_operations netns_operations;
  176. extern const struct proc_ns_operations utsns_operations;
  177. extern const struct proc_ns_operations ipcns_operations;
  178. extern const struct proc_ns_operations pidns_operations;
  179. extern const struct proc_ns_operations userns_operations;
  180. extern const struct proc_ns_operations mntns_operations;
  181. union proc_op {
  182. int (*proc_get_link)(struct dentry *, struct path *);
  183. int (*proc_read)(struct task_struct *task, char *page);
  184. int (*proc_show)(struct seq_file *m,
  185. struct pid_namespace *ns, struct pid *pid,
  186. struct task_struct *task);
  187. };
  188. struct ctl_table_header;
  189. struct ctl_table;
  190. struct proc_inode {
  191. struct pid *pid;
  192. int fd;
  193. union proc_op op;
  194. struct proc_dir_entry *pde;
  195. struct ctl_table_header *sysctl;
  196. struct ctl_table *sysctl_entry;
  197. void *ns;
  198. const struct proc_ns_operations *ns_ops;
  199. struct inode vfs_inode;
  200. };
  201. static inline struct proc_inode *PROC_I(const struct inode *inode)
  202. {
  203. return container_of(inode, struct proc_inode, vfs_inode);
  204. }
  205. static inline struct proc_dir_entry *PDE(const struct inode *inode)
  206. {
  207. return PROC_I(inode)->pde;
  208. }
  209. static inline void *PDE_DATA(const struct inode *inode)
  210. {
  211. return PROC_I(inode)->pde->data;
  212. }
  213. static inline struct net *PDE_NET(struct proc_dir_entry *pde)
  214. {
  215. return pde->parent->data;
  216. }
  217. #include <linux/signal.h>
  218. void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
  219. #endif /* _LINUX_PROC_FS_H */