LXR linux/include/linux/proc

   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
  24enum {
  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
  43typedef int (read_proc_t)(char *page, char **start, off_t off,
  44                          int count, int *eof, void *data);
  45typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  46                           unsigned long count, void *data);
  47typedef int (get_info_t)(char *, char **, off_t, int);
  48
  49struct 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
  71struct kcore_list {
  72        struct kcore_list *next;
  73        unsigned long addr;
  74        size_t size;
  75};
  76
  77struct 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
  86extern struct proc_dir_entry proc_root;
  87extern struct proc_dir_entry *proc_root_fs;
  88extern struct proc_dir_entry *proc_net;
  89extern struct proc_dir_entry *proc_net_stat;
  90extern struct proc_dir_entry *proc_bus;
  91extern struct proc_dir_entry *proc_root_driver;
  92extern struct proc_dir_entry *proc_root_kcore;
  93
  94extern spinlock_t proc_subdir_lock;
  95
  96extern void proc_root_init(void);
  97extern void proc_misc_init(void);
  98
  99struct mm_struct;
 100
 101void proc_flush_task(struct task_struct *task);
 102struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
 103int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
 104unsigned long task_vsize(struct mm_struct *);
 105int task_statm(struct mm_struct *, int *, int *, int *, int *);
 106char *task_mem(struct mm_struct *, char *);
 107void clear_refs_smap(struct mm_struct *mm);
 108
 109struct proc_dir_entry *de_get(struct proc_dir_entry *de);
 110void de_put(struct proc_dir_entry *de);
 111
 112extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 113                                                struct proc_dir_entry *parent);
 114extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 115
 116extern struct vfsmount *proc_mnt;
 117extern int proc_fill_super(struct super_block *,void *,int);
 118extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
 119
 120/*
 121 * These are generic /proc routines that use the internal
 122 * "struct proc_dir_entry" tree to traverse the filesystem.
 123 *
 124 * The /proc root directory has extended versions to take care
 125 * of the /proc/<pid> subdirectories.
 126 */
 127extern int proc_readdir(struct file *, void *, filldir_t);
 128extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
 129
 130extern const struct file_operations proc_kcore_operations;
 131extern const struct file_operations proc_kmsg_operations;
 132extern const struct file_operations ppc_htab_operations;
 133
 134/*
 135 * proc_tty.c
 136 */
 137struct tty_driver;
 138extern void proc_tty_init(void);
 139extern void proc_tty_register_driver(struct tty_driver *driver);
 140extern void proc_tty_unregister_driver(struct tty_driver *driver);
 141
 142/*
 143 * proc_devtree.c
 144 */
 145#ifdef CONFIG_PROC_DEVICETREE
 146struct device_node;
 147struct property;
 148extern void proc_device_tree_init(void);
 149extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 150extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 151extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 152                                         struct property *prop);
 153extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 154                                         struct property *newprop,
 155                                         struct property *oldprop);
 156#endif /* CONFIG_PROC_DEVICETREE */
 157
 158extern struct proc_dir_entry *proc_symlink(const char *,
 159                struct proc_dir_entry *, const char *);
 160extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 161extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
 162                        struct proc_dir_entry *parent);
 163
 164static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 165        mode_t mode, struct proc_dir_entry *base, 
 166        read_proc_t *read_proc, void * data)
 167{
 168        struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 169        if (res) {
 170                res->read_proc=read_proc;
 171                res->data=data;
 172        }
 173        return res;
 174}
 175 
 176static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 177        mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 178{
 179        struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 180        if (res) res->get_info=get_info;
 181        return res;
 182}
 183 
 184static inline struct proc_dir_entry *proc_net_create(const char *name,
 185        mode_t mode, get_info_t *get_info)
 186{
 187        return create_proc_info_entry(name,mode,proc_net,get_info);
 188}
 189
 190static inline struct proc_dir_entry *proc_net_fops_create(const char *name,
 191        mode_t mode, const struct file_operations *fops)
 192{
 193        struct proc_dir_entry *res = create_proc_entry(name, mode, proc_net);
 194        if (res)
 195                res->proc_fops = fops;
 196        return res;
 197}
 198
 199static inline void proc_net_remove(const char *name)
 200{
 201        remove_proc_entry(name,proc_net);
 202}
 203
 204#else
 205
 206#define proc_root_driver NULL
 207#define proc_net NULL
 208#define proc_bus NULL
 209
 210#define proc_net_fops_create(name, mode, fops)  ({ (void)(mode), NULL; })
 211#define proc_net_create(name, mode, info)       ({ (void)(mode), NULL; })
 212static inline void proc_net_remove(const char *name) {}
 213
 214static inline void proc_flush_task(struct task_struct *task) { }
 215
 216static inline struct proc_dir_entry *create_proc_entry(const char *name,
 217        mode_t mode, struct proc_dir_entry *parent) { return NULL; }
 218
 219#define remove_proc_entry(name, parent) do {} while (0)
 220
 221static inline struct proc_dir_entry *proc_symlink(const char *name,
 222                struct proc_dir_entry *parent,const char *dest) {return NULL;}
 223static inline struct proc_dir_entry *proc_mkdir(const char *name,
 224        struct proc_dir_entry *parent) {return NULL;}
 225
 226static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 227        mode_t mode, struct proc_dir_entry *base, 
 228        read_proc_t *read_proc, void * data) { return NULL; }
 229static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
 230        mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
 231        { return NULL; }
 232
 233struct tty_driver;
 234static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 235static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 236
 237extern struct proc_dir_entry proc_root;
 238
 239#endif /* CONFIG_PROC_FS */
 240
 241#if !defined(CONFIG_PROC_KCORE)
 242static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
 243{
 244}
 245#else
 246extern void kclist_add(struct kcore_list *, void *, size_t);
 247#endif
 248
 249union proc_op {
 250        int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
 251        int (*proc_read)(struct task_struct *task, char *page);
 252};
 253
 254struct proc_inode {
 255        struct pid *pid;
 256        int fd;
 257        union proc_op op;
 258        struct proc_dir_entry *pde;
 259        struct inode vfs_inode;
 260};
 261
 262static inline struct proc_inode *PROC_I(const struct inode *inode)
 263{
 264        return container_of(inode, struct proc_inode, vfs_inode);
 265}
 266
 267static inline struct proc_dir_entry *PDE(const struct inode *inode)
 268{
 269        return PROC_I(inode)->pde;
 270}
 271
 272struct proc_maps_private {
 273        struct pid *pid;
 274        struct task_struct *task;
 275#ifdef CONFIG_MMU
 276        struct vm_area_struct *tail_vma;
 277#endif
 278};
 279
 280#endif /* _LINUX_PROC_FS_H */
 281