git.oblomov.eu Git - linux-2.6/blob - 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 struct net;
  11 struct completion;
  12 /*
  13  * The proc filesystem constants/structures
  14  */
  15
  16 /*
  17  * Offset of the first process in the /proc root directory..
  18  */
  19 #define FIRST_PROCESS_ENTRY 256
  20
  21 /* Worst case buffer size needed for holding an integer. */
  22 #define PROC_NUMBUF 13
  23
  24 /*
  25  * We always define these enumerators
  26  */
  27
  28 enum {
  29         PROC_ROOT_INO = 1,
  30 };
  31
  32 /*
  33  * This is not completely implemented yet. The idea is to
  34  * create an in-memory tree (like the actual /proc filesystem
  35  * tree) of these proc_dir_entries, so that we can dynamically
  36  * add new files to /proc.
  37  *
  38  * The "next" pointer creates a linked list of one /proc directory,
  39  * while parent/subdir create the directory structure (every
  40  * /proc file has a parent, but "subdir" is NULL for all
  41  * non-directory entries).
  42  *
  43  * "get_info" is called at "read", while "owner" is used to protect module
  44  * from unloading while proc_dir_entry is in use
  45  */
  46
  47 typedef int (read_proc_t)(char *page, char **start, off_t off,
  48                           int count, int *eof, void *data);
  49 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  50                            unsigned long count, void *data);
  51 typedef int (get_info_t)(char *, char **, off_t, int);
  52
  53 struct proc_dir_entry {
  54         unsigned int low_ino;
  55         unsigned short namelen;
  56         const char *name;
  57         mode_t mode;
  58         nlink_t nlink;
  59         uid_t uid;
  60         gid_t gid;
  61         loff_t size;
  62         const struct inode_operations *proc_iops;
  63         /*
  64          * NULL ->proc_fops means "PDE is going away RSN" or
  65          * "PDE is just created". In either case, e.g. ->read_proc won't be
  66          * called because it's too late or too early, respectively.
  67          *
  68          * If you're allocating ->proc_fops dynamically, save a pointer
  69          * somewhere.
  70          */
  71         const struct file_operations *proc_fops;
  72         get_info_t *get_info;
  73         struct module *owner;
  74         struct proc_dir_entry *next, *parent, *subdir;
  75         void *data;
  76         read_proc_t *read_proc;
  77         write_proc_t *write_proc;
  78         atomic_t count;         /* use count */
  79         int pde_users;  /* number of callers into module in progress */
  80         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  81         struct completion *pde_unload_completion;
  82 };
  83
  84 struct kcore_list {
  85         struct kcore_list *next;
  86         unsigned long addr;
  87         size_t size;
  88 };
  89
  90 struct vmcore {
  91         struct list_head list;
  92         unsigned long long paddr;
  93         unsigned long long size;
  94         loff_t offset;
  95 };
  96
  97 #ifdef CONFIG_PROC_FS
  98
  99 extern struct proc_dir_entry proc_root;
 100 extern struct proc_dir_entry *proc_root_driver;
 101 extern struct proc_dir_entry *proc_root_kcore;
 102
 103 extern spinlock_t proc_subdir_lock;
 104
 105 extern void proc_root_init(void);
 106 extern void proc_misc_init(void);
 107
 108 struct mm_struct;
 109
 110 void proc_flush_task(struct task_struct *task);
 111 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
 112 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
 113 unsigned long task_vsize(struct mm_struct *);
 114 int task_statm(struct mm_struct *, int *, int *, int *, int *);
 115 void task_mem(struct seq_file *, struct mm_struct *);
 116 void clear_refs_smap(struct mm_struct *mm);
 117
 118 struct proc_dir_entry *de_get(struct proc_dir_entry *de);
 119 void de_put(struct proc_dir_entry *de);
 120
 121 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 122                                                 struct proc_dir_entry *parent);
 123 struct proc_dir_entry *proc_create(const char *name, mode_t mode,
 124                                 struct proc_dir_entry *parent,
 125                                 const struct file_operations *proc_fops);
 126 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 127
 128 extern struct vfsmount *proc_mnt;
 129 struct pid_namespace;
 130 extern int proc_fill_super(struct super_block *);
 131 extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
 132
 133 /*
 134  * These are generic /proc routines that use the internal
 135  * "struct proc_dir_entry" tree to traverse the filesystem.
 136  *
 137  * The /proc root directory has extended versions to take care
 138  * of the /proc/<pid> subdirectories.
 139  */
 140 extern int proc_readdir(struct file *, void *, filldir_t);
 141 extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
 142
 143 extern const struct file_operations proc_kcore_operations;
 144 extern const struct file_operations proc_kmsg_operations;
 145 extern const struct file_operations ppc_htab_operations;
 146
 147 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
 148 extern void pid_ns_release_proc(struct pid_namespace *ns);
 149
 150 /*
 151  * proc_tty.c
 152  */
 153 struct tty_driver;
 154 extern void proc_tty_init(void);
 155 extern void proc_tty_register_driver(struct tty_driver *driver);
 156 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 157
 158 /*
 159  * proc_devtree.c
 160  */
 161 #ifdef CONFIG_PROC_DEVICETREE
 162 struct device_node;
 163 struct property;
 164 extern void proc_device_tree_init(void);
 165 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 166 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 167 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 168                                          struct property *prop);
 169 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 170                                          struct property *newprop,
 171                                          struct property *oldprop);
 172 #endif /* CONFIG_PROC_DEVICETREE */
 173
 174 extern struct proc_dir_entry *proc_symlink(const char *,
 175                 struct proc_dir_entry *, const char *);
 176 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 177 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 178                         struct proc_dir_entry *parent);
 179
 180 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 181         mode_t mode, struct proc_dir_entry *base,
 182         read_proc_t *read_proc, void * data)
 183 {
 184         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 185         if (res) {
 186                 res->read_proc=read_proc;
 187                 res->data=data;
 188         }
 189         return res;
 190 }
 191
 192 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 193         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 194 {
 195         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 196         if (res) res->get_info=get_info;
 197         return res;
 198 }
 199
 200 extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
 201         const char *name, mode_t mode, const struct file_operations *fops);
 202 extern void proc_net_remove(struct net *net, const char *name);
 203 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
 204         struct proc_dir_entry *parent);
 205
 206 /* While the {get|set|dup}_mm_exe_file functions are for mm_structs, they are
 207  * only needed to implement /proc/<pid>|self/exe so we define them here. */
 208 extern void set_mm_exe_file(struct mm_struct *mm, struct file *new_exe_file);
 209 extern struct file *get_mm_exe_file(struct mm_struct *mm);
 210 extern void dup_mm_exe_file(struct mm_struct *oldmm, struct mm_struct *newmm);
 211
 212 #else
 213
 214 #define proc_root_driver NULL
 215
 216 #define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
 217 static inline void proc_net_remove(struct net *net, const char *name) {}
 218
 219 static inline void proc_flush_task(struct task_struct *task)
 220 {
 221 }
 222
 223 static inline struct proc_dir_entry *create_proc_entry(const char *name,
 224         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
 225 static inline struct proc_dir_entry *proc_create(const char *name,
 226         mode_t mode, struct proc_dir_entry *parent,
 227         const struct file_operations *proc_fops)
 228 {
 229         return NULL;
 230 }
 231 #define remove_proc_entry(name, parent) do {} while (0)
 232
 233 static inline struct proc_dir_entry *proc_symlink(const char *name,
 234                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 235 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 236         struct proc_dir_entry *parent) {return NULL;}
 237
 238 static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 239         mode_t mode, struct proc_dir_entry *base,
 240         read_proc_t *read_proc, void * data) { return NULL; }
 241 static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 242         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 243         { return NULL; }
 244
 245 struct tty_driver;
 246 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 247 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 248
 249 extern struct proc_dir_entry proc_root;
 250
 251 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
 252 {
 253         return 0;
 254 }
 255
 256 static inline void pid_ns_release_proc(struct pid_namespace *ns)
 257 {
 258 }
 259
 260 static inline void set_mm_exe_file(struct mm_struct *mm,
 261                                    struct file *new_exe_file)
 262 {}
 263
 264 static inline struct file *get_mm_exe_file(struct mm_struct *mm)
 265 {
 266         return NULL;
 267 }
 268
 269 static inline void dup_mm_exe_file(struct mm_struct *oldmm,
 270                                    struct mm_struct *newmm)
 271 {}
 272
 273 #endif /* CONFIG_PROC_FS */
 274
 275 #if !defined(CONFIG_PROC_KCORE)
 276 static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
 277 {
 278 }
 279 #else
 280 extern void kclist_add(struct kcore_list *, void *, size_t);
 281 #endif
 282
 283 union proc_op {
 284         int (*proc_get_link)(struct inode *, struct path *);
 285         int (*proc_read)(struct task_struct *task, char *page);
 286         int (*proc_show)(struct seq_file *m,
 287                 struct pid_namespace *ns, struct pid *pid,
 288                 struct task_struct *task);
 289 };
 290
 291 struct proc_inode {
 292         struct pid *pid;
 293         int fd;
 294         union proc_op op;
 295         struct proc_dir_entry *pde;
 296         struct inode vfs_inode;
 297 };
 298
 299 static inline struct proc_inode *PROC_I(const struct inode *inode)
 300 {
 301         return container_of(inode, struct proc_inode, vfs_inode);
 302 }
 303
 304 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 305 {
 306         return PROC_I(inode)->pde;
 307 }
 308
 309 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
 310 {
 311         return pde->parent->data;
 312 }
 313
 314 struct net *get_proc_net(const struct inode *inode);
 315
 316 struct proc_maps_private {
 317         struct pid *pid;
 318         struct task_struct *task;
 319 #ifdef CONFIG_MMU
 320         struct vm_area_struct *tail_vma;
 321 #endif
 322 };
 323
 324 #endif /* _LINUX_PROC_FS_H */