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 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
 113                                 struct proc_dir_entry *parent,
 114                                 const struct file_operations *proc_fops,
 115                                 void *data);
 116 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 117 extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
 118
 119 struct pid_namespace;
 120
 121 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
 122 extern void pid_ns_release_proc(struct pid_namespace *ns);
 123
 124 /*
 125  * proc_tty.c
 126  */
 127 struct tty_driver;
 128 #ifdef CONFIG_TTY
 129 extern void proc_tty_init(void);
 130 #else
 131 static inline void proc_tty_init(void)
 132 { }
 133 #endif
 134 extern void proc_tty_register_driver(struct tty_driver *driver);
 135 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 136
 137 /*
 138  * proc_devtree.c
 139  */
 140 #ifdef CONFIG_PROC_DEVICETREE
 141 struct device_node;
 142 struct property;
 143 extern void proc_device_tree_init(void);
 144 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 145 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 146 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 147                                          struct property *prop);
 148 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 149                                          struct property *newprop,
 150                                          struct property *oldprop);
 151 #endif /* CONFIG_PROC_DEVICETREE */
 152
 153 extern struct proc_dir_entry *proc_symlink(const char *,
 154                 struct proc_dir_entry *, const char *);
 155 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 156 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
 157                         struct proc_dir_entry *parent);
 158
 159 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
 160         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
 161 {
 162         return proc_create_data(name, mode, parent, proc_fops, NULL);
 163 }
 164
 165 extern struct proc_dir_entry *create_proc_read_entry(const char *name,
 166         umode_t mode, struct proc_dir_entry *base,
 167         read_proc_t *read_proc, void *data);
 168
 169 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
 170         struct proc_dir_entry *parent);
 171
 172 extern struct file *proc_ns_fget(int fd);
 173 extern bool proc_ns_inode(struct inode *inode);
 174
 175 extern int proc_alloc_inum(unsigned int *pino);
 176 extern void proc_free_inum(unsigned int inum);
 177 #else
 178
 179 static inline void proc_flush_task(struct task_struct *task)
 180 {
 181 }
 182
 183 #define proc_create(name, mode, parent, fops)  ({ (void)(mode), NULL; })
 184
 185 static inline struct proc_dir_entry *proc_create_data(const char *name,
 186         umode_t mode, struct proc_dir_entry *parent,
 187         const struct file_operations *proc_fops, void *data)
 188 {
 189         return NULL;
 190 }
 191 #define remove_proc_entry(name, parent) do {} while (0)
 192 #define remove_proc_subtree(name, parent) do {} while (0)
 193
 194 static inline struct proc_dir_entry *proc_symlink(const char *name,
 195                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 196 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 197         struct proc_dir_entry *parent) {return NULL;}
 198 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
 199         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 200
 201 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 202         umode_t mode, struct proc_dir_entry *base,
 203         read_proc_t *read_proc, void * data) { return NULL; }
 204
 205 struct tty_driver;
 206 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 207 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 208
 209 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
 210 {
 211         return 0;
 212 }
 213
 214 static inline void pid_ns_release_proc(struct pid_namespace *ns)
 215 {
 216 }
 217
 218 static inline struct file *proc_ns_fget(int fd)
 219 {
 220         return ERR_PTR(-EINVAL);
 221 }
 222
 223 static inline bool proc_ns_inode(struct inode *inode)
 224 {
 225         return false;
 226 }
 227
 228 static inline int proc_alloc_inum(unsigned int *inum)
 229 {
 230         *inum = 1;
 231         return 0;
 232 }
 233 static inline void proc_free_inum(unsigned int inum)
 234 {
 235 }
 236 #endif /* CONFIG_PROC_FS */
 237
 238 #if !defined(CONFIG_PROC_KCORE)
 239 static inline void
 240 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
 241 {
 242 }
 243 #else
 244 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
 245 #endif
 246
 247 struct nsproxy;
 248 struct proc_ns_operations {
 249         const char *name;
 250         int type;
 251         void *(*get)(struct task_struct *task);
 252         void (*put)(void *ns);
 253         int (*install)(struct nsproxy *nsproxy, void *ns);
 254         unsigned int (*inum)(void *ns);
 255 };
 256 extern const struct proc_ns_operations netns_operations;
 257 extern const struct proc_ns_operations utsns_operations;
 258 extern const struct proc_ns_operations ipcns_operations;
 259 extern const struct proc_ns_operations pidns_operations;
 260 extern const struct proc_ns_operations userns_operations;
 261 extern const struct proc_ns_operations mntns_operations;
 262
 263 union proc_op {
 264         int (*proc_get_link)(struct dentry *, struct path *);
 265         int (*proc_read)(struct task_struct *task, char *page);
 266         int (*proc_show)(struct seq_file *m,
 267                 struct pid_namespace *ns, struct pid *pid,
 268                 struct task_struct *task);
 269 };
 270
 271 struct ctl_table_header;
 272 struct ctl_table;
 273
 274 struct proc_inode {
 275         struct pid *pid;
 276         int fd;
 277         union proc_op op;
 278         struct proc_dir_entry *pde;
 279         struct ctl_table_header *sysctl;
 280         struct ctl_table *sysctl_entry;
 281         void *ns;
 282         const struct proc_ns_operations *ns_ops;
 283         struct inode vfs_inode;
 284 };
 285
 286 static inline struct proc_inode *PROC_I(const struct inode *inode)
 287 {
 288         return container_of(inode, struct proc_inode, vfs_inode);
 289 }
 290
 291 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 292 {
 293         return PROC_I(inode)->pde;
 294 }
 295
 296 static inline void *PDE_DATA(const struct inode *inode)
 297 {
 298         return PROC_I(inode)->pde->data;
 299 }
 300
 301 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
 302 {
 303         return pde->parent->data;
 304 }
 305
 306 #include <linux/signal.h>
 307
 308 void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
 309 #endif /* _LINUX_PROC_FS_H */