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