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