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