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