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