proc_fs.h 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  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. typedef int (read_proc_t)(char *page, char **start, off_t off,
  42. int count, int *eof, void *data);
  43. typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  44. unsigned long count, void *data);
  45. struct proc_dir_entry {
  46. unsigned int low_ino;
  47. umode_t mode;
  48. nlink_t nlink;
  49. kuid_t uid;
  50. kgid_t gid;
  51. loff_t size;
  52. const struct inode_operations *proc_iops;
  53. const struct file_operations *proc_fops;
  54. struct proc_dir_entry *next, *parent, *subdir;
  55. void *data;
  56. read_proc_t *read_proc;
  57. atomic_t count; /* use count */
  58. atomic_t in_use; /* number of callers into module in progress; */
  59. /* negative -> it's going away RSN */
  60. struct completion *pde_unload_completion;
  61. struct list_head pde_openers; /* who did ->open, but not ->release */
  62. spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  63. u8 namelen;
  64. char name[];
  65. };
  66. enum kcore_type {
  67. KCORE_TEXT,
  68. KCORE_VMALLOC,
  69. KCORE_RAM,
  70. KCORE_VMEMMAP,
  71. KCORE_OTHER,
  72. };
  73. struct kcore_list {
  74. struct list_head list;
  75. unsigned long addr;
  76. size_t size;
  77. int type;
  78. };
  79. struct vmcore {
  80. struct list_head list;
  81. unsigned long long paddr;
  82. unsigned long long size;
  83. loff_t offset;
  84. };
  85. #ifdef CONFIG_PROC_FS
  86. extern void proc_root_init(void);
  87. void proc_flush_task(struct task_struct *task);
  88. struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
  89. struct proc_dir_entry *parent,
  90. const struct file_operations *proc_fops,
  91. void *data);
  92. extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
  93. extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
  94. struct pid_namespace;
  95. extern int pid_ns_prepare_proc(struct pid_namespace *ns);
  96. extern void pid_ns_release_proc(struct pid_namespace *ns);
  97. /*
  98. * proc_tty.c
  99. */
  100. struct tty_driver;
  101. #ifdef CONFIG_TTY
  102. extern void proc_tty_init(void);
  103. #else
  104. static inline void proc_tty_init(void)
  105. { }
  106. #endif
  107. extern void proc_tty_register_driver(struct tty_driver *driver);
  108. extern void proc_tty_unregister_driver(struct tty_driver *driver);
  109. /*
  110. * proc_devtree.c
  111. */
  112. #ifdef CONFIG_PROC_DEVICETREE
  113. struct device_node;
  114. struct property;
  115. extern void proc_device_tree_init(void);
  116. extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
  117. extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
  118. extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
  119. struct property *prop);
  120. extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
  121. struct property *newprop,
  122. struct property *oldprop);
  123. #endif /* CONFIG_PROC_DEVICETREE */
  124. extern struct proc_dir_entry *proc_symlink(const char *,
  125. struct proc_dir_entry *, const char *);
  126. extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
  127. extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
  128. struct proc_dir_entry *parent);
  129. static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
  130. struct proc_dir_entry *parent, const struct file_operations *proc_fops)
  131. {
  132. return proc_create_data(name, mode, parent, proc_fops, NULL);
  133. }
  134. extern __deprecated
  135. struct proc_dir_entry *create_proc_read_entry(const char *name,
  136. umode_t mode, struct proc_dir_entry *base,
  137. read_proc_t *read_proc, void *data);
  138. extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
  139. struct proc_dir_entry *parent);
  140. extern struct file *proc_ns_fget(int fd);
  141. extern bool proc_ns_inode(struct inode *inode);
  142. extern int proc_alloc_inum(unsigned int *pino);
  143. extern void proc_free_inum(unsigned int inum);
  144. #else
  145. static inline void proc_flush_task(struct task_struct *task)
  146. {
  147. }
  148. #define proc_create(name, mode, parent, fops) ({ (void)(mode), NULL; })
  149. static inline struct proc_dir_entry *proc_create_data(const char *name,
  150. umode_t mode, struct proc_dir_entry *parent,
  151. const struct file_operations *proc_fops, void *data)
  152. {
  153. return NULL;
  154. }
  155. #define remove_proc_entry(name, parent) do {} while (0)
  156. #define remove_proc_subtree(name, parent) do {} while (0)
  157. static inline struct proc_dir_entry *proc_symlink(const char *name,
  158. struct proc_dir_entry *parent,const char *dest) {return NULL;}
  159. static inline struct proc_dir_entry *proc_mkdir(const char *name,
  160. struct proc_dir_entry *parent) {return NULL;}
  161. static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
  162. umode_t mode, struct proc_dir_entry *parent) { return NULL; }
  163. static inline __deprecated
  164. struct proc_dir_entry *create_proc_read_entry(const char *name,
  165. umode_t mode, struct proc_dir_entry *base,
  166. read_proc_t *read_proc, void * data) { return NULL; }
  167. struct tty_driver;
  168. static inline void proc_tty_register_driver(struct tty_driver *driver) {};
  169. static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
  170. static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
  171. {
  172. return 0;
  173. }
  174. static inline void pid_ns_release_proc(struct pid_namespace *ns)
  175. {
  176. }
  177. static inline struct file *proc_ns_fget(int fd)
  178. {
  179. return ERR_PTR(-EINVAL);
  180. }
  181. static inline bool proc_ns_inode(struct inode *inode)
  182. {
  183. return false;
  184. }
  185. static inline int proc_alloc_inum(unsigned int *inum)
  186. {
  187. *inum = 1;
  188. return 0;
  189. }
  190. static inline void proc_free_inum(unsigned int inum)
  191. {
  192. }
  193. #endif /* CONFIG_PROC_FS */
  194. #if !defined(CONFIG_PROC_KCORE)
  195. static inline void
  196. kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
  197. {
  198. }
  199. #else
  200. extern void kclist_add(struct kcore_list *, void *, size_t, int type);
  201. #endif
  202. struct nsproxy;
  203. struct proc_ns_operations {
  204. const char *name;
  205. int type;
  206. void *(*get)(struct task_struct *task);
  207. void (*put)(void *ns);
  208. int (*install)(struct nsproxy *nsproxy, void *ns);
  209. unsigned int (*inum)(void *ns);
  210. };
  211. extern const struct proc_ns_operations netns_operations;
  212. extern const struct proc_ns_operations utsns_operations;
  213. extern const struct proc_ns_operations ipcns_operations;
  214. extern const struct proc_ns_operations pidns_operations;
  215. extern const struct proc_ns_operations userns_operations;
  216. extern const struct proc_ns_operations mntns_operations;
  217. union proc_op {
  218. int (*proc_get_link)(struct dentry *, struct path *);
  219. int (*proc_read)(struct task_struct *task, char *page);
  220. int (*proc_show)(struct seq_file *m,
  221. struct pid_namespace *ns, struct pid *pid,
  222. struct task_struct *task);
  223. };
  224. struct ctl_table_header;
  225. struct ctl_table;
  226. struct proc_inode {
  227. struct pid *pid;
  228. int fd;
  229. union proc_op op;
  230. struct proc_dir_entry *pde;
  231. struct ctl_table_header *sysctl;
  232. struct ctl_table *sysctl_entry;
  233. void *ns;
  234. const struct proc_ns_operations *ns_ops;
  235. struct inode vfs_inode;
  236. };
  237. static inline struct proc_inode *PROC_I(const struct inode *inode)
  238. {
  239. return container_of(inode, struct proc_inode, vfs_inode);
  240. }
  241. static inline struct proc_dir_entry *PDE(const struct inode *inode)
  242. {
  243. return PROC_I(inode)->pde;
  244. }
  245. static inline void *PDE_DATA(const struct inode *inode)
  246. {
  247. return PROC_I(inode)->pde->data;
  248. }
  249. static inline struct net *PDE_NET(struct proc_dir_entry *pde)
  250. {
  251. return pde->parent->data;
  252. }
  253. #include <linux/signal.h>
  254. void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
  255. #endif /* _LINUX_PROC_FS_H */