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 <asm/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 };
  33
  34 /*
  35  * This is not completely implemented yet. The idea is to
  36  * create an in-memory tree (like the actual /proc filesystem
  37  * tree) of these proc_dir_entries, so that we can dynamically
  38  * add new files to /proc.
  39  *
  40  * The "next" pointer creates a linked list of one /proc directory,
  41  * while parent/subdir create the directory structure (every
  42  * /proc file has a parent, but "subdir" is NULL for all
  43  * non-directory entries).
  44  */
  45
  46 typedef int (read_proc_t)(char *page, char **start, off_t off,
  47                           int count, int *eof, void *data);
  48 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  49                            unsigned long count, void *data);
  50
  51 struct proc_dir_entry {
  52         unsigned int low_ino;
  53         unsigned short namelen;
  54         const char *name;
  55         mode_t mode;
  56         nlink_t nlink;
  57         uid_t uid;
  58         gid_t gid;
  59         loff_t size;
  60         const struct inode_operations *proc_iops;
  61         /*
  62          * NULL ->proc_fops means "PDE is going away RSN" or
  63          * "PDE is just created". In either case, e.g. ->read_proc won't be
  64          * called because it's too late or too early, respectively.
  65          *
  66          * If you're allocating ->proc_fops dynamically, save a pointer
  67          * somewhere.
  68          */
  69         const struct file_operations *proc_fops;
  70         struct proc_dir_entry *next, *parent, *subdir;
  71         void *data;
  72         read_proc_t *read_proc;
  73         write_proc_t *write_proc;
  74         atomic_t count;         /* use count */
  75         int pde_users;  /* number of callers into module in progress */
  76         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  77         struct completion *pde_unload_completion;
  78         struct list_head pde_openers;   /* who did ->open, but not ->release */
  79 };
  80
  81 struct kcore_list {
  82         struct kcore_list *next;
  83         unsigned long addr;
  84         size_t size;
  85 };
  86
  87 struct vmcore {
  88         struct list_head list;
  89         unsigned long long paddr;
  90         unsigned long long size;
  91         loff_t offset;
  92 };
  93
  94 #ifdef CONFIG_PROC_FS
  95
  96 extern spinlock_t proc_subdir_lock;
  97
  98 extern void proc_root_init(void);
  99
 100 void proc_flush_task(struct task_struct *task);
 101 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
 102 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
 103 unsigned long task_vsize(struct mm_struct *);
 104 int task_statm(struct mm_struct *, int *, int *, int *, int *);
 105 void task_mem(struct seq_file *, struct mm_struct *);
 106 void clear_refs_smap(struct mm_struct *mm);
 107
 108 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
 109 void de_put(struct proc_dir_entry *de);
 110
 111 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 112                                                 struct proc_dir_entry *parent);
 113 struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
 114                                 struct proc_dir_entry *parent,
 115                                 const struct file_operations *proc_fops,
 116                                 void *data);
 117 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 118
 119 extern struct vfsmount *proc_mnt;
 120 struct pid_namespace;
 121 extern int proc_fill_super(struct super_block *);
 122 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
 123
 124 /*
 125  * These are generic /proc routines that use the internal
 126  * "struct proc_dir_entry" tree to traverse the filesystem.
 127  *
 128  * The /proc root directory has extended versions to take care
 129  * of the /proc/<pid> subdirectories.
 130  */
 131 extern int proc_readdir(struct file *, void *, filldir_t);
 132 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
 133
 134 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
 135 extern void pid_ns_release_proc(struct pid_namespace *ns);
 136
 137 /*
 138  * proc_tty.c
 139  */
 140 struct tty_driver;
 141 extern void proc_tty_init(void);
 142 extern void proc_tty_register_driver(struct tty_driver *driver);
 143 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 144
 145 /*
 146  * proc_devtree.c
 147  */
 148 #ifdef CONFIG_PROC_DEVICETREE
 149 struct device_node;
 150 struct property;
 151 extern void proc_device_tree_init(void);
 152 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 153 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 154 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 155                                          struct property *prop);
 156 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 157                                          struct property *newprop,
 158                                          struct property *oldprop);
 159 #endif /* CONFIG_PROC_DEVICETREE */
 160
 161 extern struct proc_dir_entry *proc_symlink(const char *,
 162                 struct proc_dir_entry *, const char *);
 163 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 164 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 165                         struct proc_dir_entry *parent);
 166
 167 static inline struct proc_dir_entry *proc_create(const char *name, mode_t mode,
 168         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
 169 {
 170         return proc_create_data(name, mode, parent, proc_fops, NULL);
 171 }
 172
 173 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 174         mode_t mode, struct proc_dir_entry *base,
 175         read_proc_t *read_proc, void * data)
 176 {
 177         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 178         if (res) {
 179                 res->read_proc=read_proc;
 180                 res->data=data;
 181         }
 182         return res;
 183 }
 184
 185 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
 186         const char *name, mode_t mode, const struct file_operations *fops);
 187 extern void proc_net_remove(struct net *net, const char *name);
 188 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
 189         struct proc_dir_entry *parent);
 190
 191 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
 192  * only needed to implement /proc/<pid>|self/exe so we define them here. */
 193 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
 194 extern struct file *get_mm_exe_file(struct mm_struct *mm);
 195 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
 196
 197 #else
 198
 199 #define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
 200 static inline void proc_net_remove(struct net *net, const char *name) {}
 201
 202 static inline void proc_flush_task(struct task_struct *task)
 203 {
 204 }
 205
 206 static inline struct proc_dir_entry *create_proc_entry(const char *name,
 207         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
 208 static inline struct proc_dir_entry *proc_create(const char *name,
 209         mode_t mode, struct proc_dir_entry *parent,
 210         const struct file_operations *proc_fops)
 211 {
 212         return NULL;
 213 }
 214 static inline struct proc_dir_entry *proc_create_data(const char *name,
 215         mode_t mode, struct proc_dir_entry *parent,
 216         const struct file_operations *proc_fops, void *data)
 217 {
 218         return NULL;
 219 }
 220 #define remove_proc_entry(name, parent) do {} while (0)
 221
 222 static inline struct proc_dir_entry *proc_symlink(const char *name,
 223                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 224 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 225         struct proc_dir_entry *parent) {return NULL;}
 226
 227 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 228         mode_t mode, struct proc_dir_entry *base,
 229         read_proc_t *read_proc, void * data) { return NULL; }
 230
 231 struct tty_driver;
 232 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 233 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 234
 235 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
 236 {
 237         return 0;
 238 }
 239
 240 static inline void pid_ns_release_proc(struct pid_namespace *ns)
 241 {
 242 }
 243
 244 static inline void set_mm_exe_file(struct mm_struct *mm,
 245                                    struct file *new_exe_file)
 246 {}
 247
 248 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
 249 {
 250         return NULL;
 251 }
 252
 253 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
 254                                    struct mm_struct *newmm)
 255 {}
 256
 257 #endif /* CONFIG_PROC_FS */
 258
 259 #if !defined(CONFIG_PROC_KCORE)
 260 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
 261 {
 262 }
 263 #else
 264 extern void kclist_add(struct kcore_list *, void *, size_t);
 265 #endif
 266
 267 union proc_op {
 268         int (*proc_get_link)(struct inode *, struct path *);
 269         int (*proc_read)(struct task_struct *task, char *page);
 270         int (*proc_show)(struct seq_file *m,
 271                 struct pid_namespace *ns, struct pid *pid,
 272                 struct task_struct *task);
 273 };
 274
 275 struct ctl_table_header;
 276 struct ctl_table;
 277
 278 struct proc_inode {
 279         struct pid *pid;
 280         int fd;
 281         union proc_op op;
 282         struct proc_dir_entry *pde;
 283         struct ctl_table_header *sysctl;
 284         struct ctl_table *sysctl_entry;
 285         struct inode vfs_inode;
 286 };
 287
 288 static inline struct proc_inode *PROC_I(const struct inode *inode)
 289 {
 290         return container_of(inode, struct proc_inode, vfs_inode);
 291 }
 292
 293 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 294 {
 295         return PROC_I(inode)->pde;
 296 }
 297
 298 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
 299 {
 300         return pde->parent->data;
 301 }
 302
 303 struct proc_maps_private {
 304         struct pid *pid;
 305         struct task_struct *task;
 306 #ifdef CONFIG_MMU
 307         struct vm_area_struct *tail_vma;
 308 #endif
 309 };
 310
 311 #endif /* _LINUX_PROC_FS_H */