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