include/linux/proc_fs.h

   1 #ifndef _LINUX_PROC_FS_H
   2 #define _LINUX_PROC_FS_H
   3
   4 #include <linux/slab.h>
   5 #include <linux/fs.h>
   6 #include <linux/spinlock.h>
   7 #include <linux/magic.h>
   8 #include <linux/atomic.h>
   9
  10 struct net;
  11 struct completion;
  12 struct mm_struct;
  13
  14 /*
  15  * The proc filesystem constants/structures
  16  */
  17
  18 /*
  19  * Offset of the first process in the /proc root directory..
  20  */
  21 #define FIRST_PROCESS_ENTRY 256
  22
  23 /* Worst case buffer size needed for holding an integer. */
  24 #define PROC_NUMBUF 13
  25
  26 /*
  27  * We always define these enumerators
  28  */
  29
  30 enum {
  31         PROC_ROOT_INO           = 1,
  32         PROC_IPC_INIT_INO       = 0xEFFFFFFFU,
  33         PROC_UTS_INIT_INO       = 0xEFFFFFFEU,
  34         PROC_USER_INIT_INO      = 0xEFFFFFFDU,
  35         PROC_PID_INIT_INO       = 0xEFFFFFFCU,
  36 };
  37
  38 /*
  39  * This is not completely implemented yet. The idea is to
  40  * create an in-memory tree (like the actual /proc filesystem
  41  * tree) of these proc_dir_entries, so that we can dynamically
  42  * add new files to /proc.
  43  *
  44  * The "next" pointer creates a linked list of one /proc directory,
  45  * while parent/subdir create the directory structure (every
  46  * /proc file has a parent, but "subdir" is NULL for all
  47  * non-directory entries).
  48  */
  49
  50 typedef int (read_proc_t)(char *page, char **start, off_t off,
  51                           int count, int *eof, void *data);
  52 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  53                            unsigned long count, void *data);
  54
  55 struct proc_dir_entry {
  56         unsigned int low_ino;
  57         umode_t mode;
  58         nlink_t nlink;
  59         kuid_t uid;
  60         kgid_t gid;
  61         loff_t size;
  62         const struct inode_operations *proc_iops;
  63         /*
  64          * NULL ->proc_fops means "PDE is going away RSN" or
  65          * "PDE is just created". In either case, e.g. ->read_proc won't be
  66          * called because it's too late or too early, respectively.
  67          *
  68          * If you're allocating ->proc_fops dynamically, save a pointer
  69          * somewhere.
  70          */
  71         const struct file_operations *proc_fops;
  72         struct proc_dir_entry *next, *parent, *subdir;
  73         void *data;
  74         read_proc_t *read_proc;
  75         atomic_t count;         /* use count */
  76         int pde_users;  /* number of callers into module in progress */
  77         struct completion *pde_unload_completion;
  78         struct list_head pde_openers;   /* who did ->open, but not ->release */
  79         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  80         u8 namelen;
  81         char name[];
  82 };
  83
  84 enum kcore_type {
  85         KCORE_TEXT,
  86         KCORE_VMALLOC,
  87         KCORE_RAM,
  88         KCORE_VMEMMAP,
  89         KCORE_OTHER,
  90 };
  91
  92 struct kcore_list {
  93         struct list_head list;
  94         unsigned long addr;
  95         size_t size;
  96         int type;
  97 };
  98
  99 struct vmcore {
 100         struct list_head list;
 101         unsigned long long paddr;
 102         unsigned long long size;
 103         loff_t offset;
 104 };
 105
 106 #ifdef CONFIG_PROC_FS
 107
 108 extern void proc_root_init(void);
 109
 110 void proc_flush_task(struct task_struct *task);
 111
 112 extern struct proc_dir_entry *create_proc_entry(const char *name, umode_t mode,
 113                                                 struct proc_dir_entry *parent);
 114 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
 115                                 struct proc_dir_entry *parent,
 116                                 const struct file_operations *proc_fops,
 117                                 void *data);
 118 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 119 extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
 120
 121 struct pid_namespace;
 122
 123 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
 124 extern void pid_ns_release_proc(struct pid_namespace *ns);
 125
 126 /*
 127  * proc_tty.c
 128  */
 129 struct tty_driver;
 130 #ifdef CONFIG_TTY
 131 extern void proc_tty_init(void);
 132 #else
 133 static inline void proc_tty_init(void)
 134 { }
 135 #endif
 136 extern void proc_tty_register_driver(struct tty_driver *driver);
 137 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 138
 139 /*
 140  * proc_devtree.c
 141  */
 142 #ifdef CONFIG_PROC_DEVICETREE
 143 struct device_node;
 144 struct property;
 145 extern void proc_device_tree_init(void);
 146 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 147 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 148 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 149                                          struct property *prop);
 150 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 151                                          struct property *newprop,
 152                                          struct property *oldprop);
 153 #endif /* CONFIG_PROC_DEVICETREE */
 154
 155 extern struct proc_dir_entry *proc_symlink(const char *,
 156                 struct proc_dir_entry *, const char *);
 157 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 158 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
 159                         struct proc_dir_entry *parent);
 160
 161 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
 162         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
 163 {
 164         return proc_create_data(name, mode, parent, proc_fops, NULL);
 165 }
 166
 167 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 168         umode_t mode, struct proc_dir_entry *base,
 169         read_proc_t *read_proc, void * data)
 170 {
 171         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 172         if (res) {
 173                 res->read_proc=read_proc;
 174                 res->data=data;
 175         }
 176         return res;
 177 }
 178
 179 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
 180         struct proc_dir_entry *parent);
 181
 182 extern struct file *proc_ns_fget(int fd);
 183 extern bool proc_ns_inode(struct inode *inode);
 184
 185 extern int proc_alloc_inum(unsigned int *pino);
 186 extern void proc_free_inum(unsigned int inum);
 187 #else
 188
 189 static inline void proc_flush_task(struct task_struct *task)
 190 {
 191 }
 192
 193 static inline struct proc_dir_entry *create_proc_entry(const char *name,
 194         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 195
 196 #define proc_create(name, mode, parent, fops)  ({ (void)(mode), NULL; })
 197
 198 static inline struct proc_dir_entry *proc_create_data(const char *name,
 199         umode_t mode, struct proc_dir_entry *parent,
 200         const struct file_operations *proc_fops, void *data)
 201 {
 202         return NULL;
 203 }
 204 #define remove_proc_entry(name, parent) do {} while (0)
 205 #define remove_proc_subtree(name, parent) do {} while (0)
 206
 207 static inline struct proc_dir_entry *proc_symlink(const char *name,
 208                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 209 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 210         struct proc_dir_entry *parent) {return NULL;}
 211 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
 212         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 213
 214 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 215         umode_t mode, struct proc_dir_entry *base,
 216         read_proc_t *read_proc, void * data) { return NULL; }
 217
 218 struct tty_driver;
 219 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 220 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 221
 222 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
 223 {
 224         return 0;
 225 }
 226
 227 static inline void pid_ns_release_proc(struct pid_namespace *ns)
 228 {
 229 }
 230
 231 static inline struct file *proc_ns_fget(int fd)
 232 {
 233         return ERR_PTR(-EINVAL);
 234 }
 235
 236 static inline bool proc_ns_inode(struct inode *inode)
 237 {
 238         return false;
 239 }
 240
 241 static inline int proc_alloc_inum(unsigned int *inum)
 242 {
 243         *inum = 1;
 244         return 0;
 245 }
 246 static inline void proc_free_inum(unsigned int inum)
 247 {
 248 }
 249 #endif /* CONFIG_PROC_FS */
 250
 251 #if !defined(CONFIG_PROC_KCORE)
 252 static inline void
 253 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
 254 {
 255 }
 256 #else
 257 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
 258 #endif
 259
 260 struct nsproxy;
 261 struct proc_ns_operations {
 262         const char *name;
 263         int type;
 264         void *(*get)(struct task_struct *task);
 265         void (*put)(void *ns);
 266         int (*install)(struct nsproxy *nsproxy, void *ns);
 267         unsigned int (*inum)(void *ns);
 268 };
 269 extern const struct proc_ns_operations netns_operations;
 270 extern const struct proc_ns_operations utsns_operations;
 271 extern const struct proc_ns_operations ipcns_operations;
 272 extern const struct proc_ns_operations pidns_operations;
 273 extern const struct proc_ns_operations userns_operations;
 274 extern const struct proc_ns_operations mntns_operations;
 275
 276 union proc_op {
 277         int (*proc_get_link)(struct dentry *, struct path *);
 278         int (*proc_read)(struct task_struct *task, char *page);
 279         int (*proc_show)(struct seq_file *m,
 280                 struct pid_namespace *ns, struct pid *pid,
 281                 struct task_struct *task);
 282 };
 283
 284 struct ctl_table_header;
 285 struct ctl_table;
 286
 287 struct proc_inode {
 288         struct pid *pid;
 289         int fd;
 290         union proc_op op;
 291         struct proc_dir_entry *pde;
 292         struct ctl_table_header *sysctl;
 293         struct ctl_table *sysctl_entry;
 294         void *ns;
 295         const struct proc_ns_operations *ns_ops;
 296         struct inode vfs_inode;
 297 };
 298
 299 static inline struct proc_inode *PROC_I(const struct inode *inode)
 300 {
 301         return container_of(inode, struct proc_inode, vfs_inode);
 302 }
 303
 304 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 305 {
 306         return PROC_I(inode)->pde;
 307 }
 308
 309 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
 310 {
 311         return pde->parent->data;
 312 }
 313
 314 #include <linux/signal.h>
 315
 316 void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
 317 #endif /* _LINUX_PROC_FS_H */