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