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         int deleted;            /* delete flag */
  68         void *set;
  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 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 spinlock_t proc_subdir_lock;
  95
  96 extern void proc_root_init(void);
  97 extern void proc_misc_init(void);
  98
  99 struct mm_struct;
 100
 101 void proc_flush_task(struct task_struct *task);
 102 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
 103 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
 104 unsigned long task_vsize(struct mm_struct *);
 105 int task_statm(struct mm_struct *, int *, int *, int *, int *);
 106 char *task_mem(struct mm_struct *, char *);
 107 void clear_refs_smap(struct mm_struct *mm);
 108
 109 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 110                                                 struct proc_dir_entry *parent);
 111 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 112
 113 extern struct vfsmount *proc_mnt;
 114 extern int proc_fill_super(struct super_block *,void *,int);
 115 extern struct inode *proc_get_inode(struct super_block *, unsigned int, 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 const struct file_operations proc_kcore_operations;
 128 extern const struct file_operations proc_kmsg_operations;
 129 extern const 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 #ifdef CONFIG_PROC_DEVICETREE
 143 struct device_node;
 144 struct property;
 145 extern void proc_device_tree_init(void);
 146 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 147 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 148 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 149                                          struct property *prop);
 150 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 151                                          struct property *newprop,
 152                                          struct property *oldprop);
 153 #endif /* CONFIG_PROC_DEVICETREE */
 154
 155 extern struct proc_dir_entry *proc_symlink(const char *,
 156                 struct proc_dir_entry *, const char *);
 157 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 158 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 159                         struct proc_dir_entry *parent);
 160
 161 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 162         mode_t mode, struct proc_dir_entry *base,
 163         read_proc_t *read_proc, void * data)
 164 {
 165         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 166         if (res) {
 167                 res->read_proc=read_proc;
 168                 res->data=data;
 169         }
 170         return res;
 171 }
 172
 173 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 174         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 175 {
 176         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 177         if (res) res->get_info=get_info;
 178         return res;
 179 }
 180
 181 static inline struct proc_dir_entry *proc_net_create(const char *name,
 182         mode_t mode, get_info_t *get_info)
 183 {
 184         return create_proc_info_entry(name,mode,proc_net,get_info);
 185 }
 186
 187 static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
 188         mode_t mode, const struct file_operations *fops)
 189 {
 190         struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
 191         if (res)
 192                 res->proc_fops = fops;
 193         return res;
 194 }
 195
 196 static inline void proc_net_remove(const char *name)
 197 {
 198         remove_proc_entry(name,proc_net);
 199 }
 200
 201 #else
 202
 203 #define proc_root_driver NULL
 204 #define proc_net NULL
 205 #define proc_bus NULL
 206
 207 #define proc_net_fops_create(name, mode, fops)  ({ (void)(mode), NULL; })
 208 #define proc_net_create(name, mode, info)       ({ (void)(mode), NULL; })
 209 static inline void proc_net_remove(const char *name) {}
 210
 211 static inline void proc_flush_task(struct task_struct *task) { }
 212
 213 static inline struct proc_dir_entry *create_proc_entry(const char *name,
 214         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
 215
 216 #define remove_proc_entry(name, parent) do {} while (0)
 217
 218 static inline struct proc_dir_entry *proc_symlink(const char *name,
 219                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 220 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 221         struct proc_dir_entry *parent) {return NULL;}
 222
 223 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 224         mode_t mode, struct proc_dir_entry *base,
 225         read_proc_t *read_proc, void * data) { return NULL; }
 226 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 227         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 228         { return NULL; }
 229
 230 struct tty_driver;
 231 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 232 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 233
 234 extern struct proc_dir_entry proc_root;
 235
 236 #endif /* CONFIG_PROC_FS */
 237
 238 #if !defined(CONFIG_PROC_KCORE)
 239 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
 240 {
 241 }
 242 #else
 243 extern void kclist_add(struct kcore_list *, void *, size_t);
 244 #endif
 245
 246 union proc_op {
 247         int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
 248         int (*proc_read)(struct task_struct *task, char *page);
 249 };
 250
 251 struct proc_inode {
 252         struct pid *pid;
 253         int fd;
 254         union proc_op op;
 255         struct proc_dir_entry *pde;
 256         struct inode vfs_inode;
 257 };
 258
 259 static inline struct proc_inode *PROC_I(const struct inode *inode)
 260 {
 261         return container_of(inode, struct proc_inode, vfs_inode);
 262 }
 263
 264 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 265 {
 266         return PROC_I(inode)->pde;
 267 }
 268
 269 struct proc_maps_private {
 270         struct pid *pid;
 271         struct task_struct *task;
 272 #ifdef CONFIG_MMU
 273         struct vm_area_struct *tail_vma;
 274 #endif
 275 };
 276
 277 #endif /* _LINUX_PROC_FS_H */