release/src-rt-6.x/linux/linux-2.6/include/linux/proc_fs.h

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