proc_fs.h 8.6 KB

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