include/linux/proc_fs.h

   1 #ifndef _LINUX_PROC_FS_H
   2 #define _LINUX_PROC_FS_H
   3
   4 #include <linux/config.h>
   5 #include <linux/slab.h>
   6 #include <linux/fs.h>
   7 #include <asm/atomic.h>
   8
   9 /*
  10  * The proc filesystem constants/structures
  11  */
  12
  13 /*
  14  * Offset of the first process in the /proc root directory..
  15  */
  16 #define FIRST_PROCESS_ENTRY 256
  17
  18
  19 /*
  20  * We always define these enumerators
  21  */
  22
  23 enum {
  24         PROC_ROOT_INO = 1,
  25 };
  26
  27 #define PROC_SUPER_MAGIC 0x9fa0
  28
  29 /*
  30  * This is not completely implemented yet. The idea is to
  31  * create an in-memory tree (like the actual /proc filesystem
  32  * tree) of these proc_dir_entries, so that we can dynamically
  33  * add new files to /proc.
  34  *
  35  * The "next" pointer creates a linked list of one /proc directory,
  36  * while parent/subdir create the directory structure (every
  37  * /proc file has a parent, but "subdir" is NULL for all
  38  * non-directory entries).
  39  *
  40  * "get_info" is called at "read", while "owner" is used to protect module
  41  * from unloading while proc_dir_entry is in use
  42  */
  43
  44 typedef int (read_proc_t)(char *page, char **start, off_t off,
  45                           int count, int *eof, void *data);
  46 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  47                            unsigned long count, void *data);
  48 typedef int (get_info_t)(char *, char **, off_t, int);
  49
  50 struct proc_dir_entry {
  51         unsigned int low_ino;
  52         unsigned short namelen;
  53         const char *name;
  54         mode_t mode;
  55         nlink_t nlink;
  56         uid_t uid;
  57         gid_t gid;
  58         int vx_flags;
  59         unsigned long size;
  60         struct inode_operations * proc_iops;
  61         struct file_operations * proc_fops;
  62         get_info_t *get_info;
  63         struct module *owner;
  64         struct proc_dir_entry *next, *parent, *subdir;
  65         void *data;
  66         read_proc_t *read_proc;
  67         write_proc_t *write_proc;
  68         atomic_t count;         /* use count */
  69         int deleted;            /* delete flag */
  70 };
  71
  72 struct kcore_list {
  73         struct kcore_list *next;
  74         unsigned long addr;
  75         size_t size;
  76 };
  77
  78 #ifdef CONFIG_PROC_FS
  79
  80 extern struct proc_dir_entry proc_root;
  81 extern struct proc_dir_entry *proc_root_fs;
  82 extern struct proc_dir_entry *proc_net;
  83 extern struct proc_dir_entry *proc_net_stat;
  84 extern struct proc_dir_entry *proc_bus;
  85 extern struct proc_dir_entry *proc_root_driver;
  86 extern struct proc_dir_entry *proc_root_kcore;
  87
  88 extern void proc_root_init(void);
  89 extern void proc_misc_init(void);
  90
  91 struct mm_struct;
  92
  93 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
  94 struct dentry *proc_pid_unhash(struct task_struct *p);
  95 void proc_pid_flush(struct dentry *proc_dentry);
  96 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
  97 unsigned long task_vsize(struct mm_struct *);
  98 int task_statm(struct mm_struct *, int *, int *, int *, int *);
  99 char *task_mem(struct mm_struct *, char *);
 100
 101 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 102                                                 struct proc_dir_entry *parent);
 103 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 104
 105 extern struct vfsmount *proc_mnt;
 106 extern int proc_fill_super(struct super_block *,void *,int);
 107 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
 108
 109 extern int proc_match(int, const char *,struct proc_dir_entry *);
 110
 111 /*
 112  * These are generic /proc routines that use the internal
 113  * "struct proc_dir_entry" tree to traverse the filesystem.
 114  *
 115  * The /proc root directory has extended versions to take care
 116  * of the /proc/<pid> subdirectories.
 117  */
 118 extern int proc_readdir(struct file *, void *, filldir_t);
 119 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
 120
 121 extern struct file_operations proc_kcore_operations;
 122 extern struct file_operations proc_kmsg_operations;
 123 extern struct file_operations ppc_htab_operations;
 124
 125 /*
 126  * proc_tty.c
 127  */
 128 struct tty_driver;
 129 extern void proc_tty_init(void);
 130 extern void proc_tty_register_driver(struct tty_driver *driver);
 131 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 132
 133 /*
 134  * proc_devtree.c
 135  */
 136 struct device_node;
 137 extern void proc_device_tree_init(void);
 138 #ifdef CONFIG_PROC_DEVICETREE
 139 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 140 #else /* !CONFIG_PROC_DEVICETREE */
 141 static inline void proc_device_tree_add_node(struct device_node *np, struct proc_dir_entry *pde)
 142 {
 143         return;
 144 }
 145 #endif /* CONFIG_PROC_DEVICETREE */
 146
 147 extern struct proc_dir_entry *proc_symlink(const char *,
 148                 struct proc_dir_entry *, const char *);
 149 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 150 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 151                         struct proc_dir_entry *parent);
 152
 153 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 154         mode_t mode, struct proc_dir_entry *base,
 155         read_proc_t *read_proc, void * data)
 156 {
 157         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 158         if (res) {
 159                 res->read_proc=read_proc;
 160                 res->data=data;
 161         }
 162         return res;
 163 }
 164
 165 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 166         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 167 {
 168         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 169         if (res) res->get_info=get_info;
 170         return res;
 171 }
 172
 173 static inline struct proc_dir_entry *proc_net_create(const char *name,
 174         mode_t mode, get_info_t *get_info)
 175 {
 176         return create_proc_info_entry(name,mode,proc_net,get_info);
 177 }
 178
 179 static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
 180         mode_t mode, struct file_operations *fops)
 181 {
 182         struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
 183         if (res)
 184                 res->proc_fops = fops;
 185         return res;
 186 }
 187
 188 static inline void proc_net_remove(const char *name)
 189 {
 190         remove_proc_entry(name,proc_net);
 191 }
 192
 193 #else
 194
 195 #define proc_root_driver NULL
 196 #define proc_net NULL
 197 #define proc_bus NULL
 198
 199 #define proc_net_fops_create(name, mode, fops)  ({ (void)(mode), NULL; })
 200 #define proc_net_create(name, mode, info)       ({ (void)(mode), NULL; })
 201 static inline void proc_net_remove(const char *name) {}
 202
 203 static inline struct dentry *proc_pid_unhash(struct task_struct *p) { return NULL; }
 204 static inline void proc_pid_flush(struct dentry *proc_dentry) { }
 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
 209 #define remove_proc_entry(name, parent) do {} while (0)
 210
 211 static inline struct proc_dir_entry *proc_symlink(const char *name,
 212                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 213 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 214         struct proc_dir_entry *parent) {return NULL;}
 215
 216 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 217         mode_t mode, struct proc_dir_entry *base,
 218         read_proc_t *read_proc, void * data) { return NULL; }
 219 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 220         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 221         { return NULL; }
 222
 223 struct tty_driver;
 224 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 225 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 226
 227 extern struct proc_dir_entry proc_root;
 228
 229 #endif /* CONFIG_PROC_FS */
 230
 231 #if !defined(CONFIG_PROC_KCORE)
 232 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
 233 {
 234 }
 235 #else
 236 extern void kclist_add(struct kcore_list *, void *, size_t);
 237 #endif
 238
 239 struct proc_inode {
 240         struct task_struct *task;
 241         int type;
 242         int vx_flags;
 243         union {
 244                 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
 245                 int (*proc_read)(struct task_struct *task, char *page);
 246                 int (*proc_vid_read)(int vid, char *page);
 247         } op;
 248         struct proc_dir_entry *pde;
 249         struct inode vfs_inode;
 250 };
 251
 252 static inline struct proc_inode *PROC_I(const struct inode *inode)
 253 {
 254         return container_of(inode, struct proc_inode, vfs_inode);
 255 }
 256
 257 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 258 {
 259         return PROC_I(inode)->pde;
 260 }
 261
 262 #endif /* _LINUX_PROC_FS_H */