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         void *set;
  71 };
  72
  73 struct kcore_list {
  74         struct kcore_list *next;
  75         unsigned long addr;
  76         size_t size;
  77 };
  78
  79 struct vmcore {
  80         struct list_head list;
  81         unsigned long long paddr;
  82         unsigned long long size;
  83         loff_t offset;
  84 };
  85
  86 #ifdef CONFIG_PROC_FS
  87
  88 extern struct proc_dir_entry proc_root;
  89 extern struct proc_dir_entry *proc_root_fs;
  90 extern struct proc_dir_entry *proc_net;
  91 extern struct proc_dir_entry *proc_net_stat;
  92 extern struct proc_dir_entry *proc_bus;
  93 extern struct proc_dir_entry *proc_root_driver;
  94 extern struct proc_dir_entry *proc_root_kcore;
  95
  96 extern void proc_root_init(void);
  97 extern void proc_misc_init(void);
  98
  99 struct mm_struct;
 100
 101 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
 102 struct dentry *proc_pid_unhash(struct task_struct *p);
 103 void proc_pid_flush(struct dentry *proc_dentry);
 104 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
 105 unsigned long task_vsize(struct mm_struct *);
 106 int task_statm(struct mm_struct *, int *, int *, int *, int *);
 107 char *task_mem(struct mm_struct *, char *);
 108
 109 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 110                                                 struct proc_dir_entry *parent);
 111 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 112
 113 extern struct vfsmount *proc_mnt;
 114 extern int proc_fill_super(struct super_block *,void *,int);
 115 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
 116
 117 extern int proc_match(int, const char *,struct proc_dir_entry *);
 118
 119 /*
 120  * These are generic /proc routines that use the internal
 121  * "struct proc_dir_entry" tree to traverse the filesystem.
 122  *
 123  * The /proc root directory has extended versions to take care
 124  * of the /proc/<pid> subdirectories.
 125  */
 126 extern int proc_readdir(struct file *, void *, filldir_t);
 127 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
 128
 129 extern struct file_operations proc_kcore_operations;
 130 extern struct file_operations proc_kmsg_operations;
 131 extern struct file_operations ppc_htab_operations;
 132
 133 /*
 134  * proc_tty.c
 135  */
 136 struct tty_driver;
 137 extern void proc_tty_init(void);
 138 extern void proc_tty_register_driver(struct tty_driver *driver);
 139 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 140
 141 /*
 142  * proc_devtree.c
 143  */
 144 #ifdef CONFIG_PROC_DEVICETREE
 145 struct device_node;
 146 struct property;
 147 extern void proc_device_tree_init(void);
 148 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 149 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 150 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 151                                          struct property *prop);
 152 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 153                                          struct property *newprop,
 154                                          struct property *oldprop);
 155 #endif /* CONFIG_PROC_DEVICETREE */
 156
 157 extern struct proc_dir_entry *proc_symlink(const char *,
 158                 struct proc_dir_entry *, const char *);
 159 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 160 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 161                         struct proc_dir_entry *parent);
 162
 163 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 164         mode_t mode, struct proc_dir_entry *base,
 165         read_proc_t *read_proc, void * data)
 166 {
 167         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 168         if (res) {
 169                 res->read_proc=read_proc;
 170                 res->data=data;
 171         }
 172         return res;
 173 }
 174
 175 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 176         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 177 {
 178         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 179         if (res) res->get_info=get_info;
 180         return res;
 181 }
 182
 183 static inline struct proc_dir_entry *proc_net_create(const char *name,
 184         mode_t mode, get_info_t *get_info)
 185 {
 186         return create_proc_info_entry(name,mode,proc_net,get_info);
 187 }
 188
 189 static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
 190         mode_t mode, struct file_operations *fops)
 191 {
 192         struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
 193         if (res)
 194                 res->proc_fops = fops;
 195         return res;
 196 }
 197
 198 static inline void proc_net_remove(const char *name)
 199 {
 200         remove_proc_entry(name,proc_net);
 201 }
 202
 203 #else
 204
 205 #define proc_root_driver NULL
 206 #define proc_net NULL
 207 #define proc_bus NULL
 208
 209 #define proc_net_fops_create(name, mode, fops)  ({ (void)(mode), NULL; })
 210 #define proc_net_create(name, mode, info)       ({ (void)(mode), NULL; })
 211 static inline void proc_net_remove(const char *name) {}
 212
 213 static inline struct dentry *proc_pid_unhash(struct task_struct *p) { return NULL; }
 214 static inline void proc_pid_flush(struct dentry *proc_dentry) { }
 215
 216 static inline struct proc_dir_entry *create_proc_entry(const char *name,
 217         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
 218
 219 #define remove_proc_entry(name, parent) do {} while (0)
 220
 221 static inline struct proc_dir_entry *proc_symlink(const char *name,
 222                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 223 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 224         struct proc_dir_entry *parent) {return NULL;}
 225
 226 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 227         mode_t mode, struct proc_dir_entry *base,
 228         read_proc_t *read_proc, void * data) { return NULL; }
 229 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 230         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 231         { return NULL; }
 232
 233 struct tty_driver;
 234 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 235 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 236
 237 extern struct proc_dir_entry proc_root;
 238
 239 #endif /* CONFIG_PROC_FS */
 240
 241 #if !defined(CONFIG_PROC_KCORE)
 242 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
 243 {
 244 }
 245 #else
 246 extern void kclist_add(struct kcore_list *, void *, size_t);
 247 #endif
 248
 249 struct proc_inode {
 250         struct task_struct *task;
 251         int type;
 252         int vx_flags;
 253         union {
 254                 int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
 255                 int (*proc_read)(struct task_struct *task, char *page);
 256                 int (*proc_vid_read)(int vid, char *page);
 257         } op;
 258         struct proc_dir_entry *pde;
 259         struct inode vfs_inode;
 260 };
 261
 262 static inline struct proc_inode *PROC_I(const struct inode *inode)
 263 {
 264         return container_of(inode, struct proc_inode, vfs_inode);
 265 }
 266
 267 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 268 {
 269         return PROC_I(inode)->pde;
 270 }
 271
 272 #endif /* _LINUX_PROC_FS_H */