linux/include/linux/proc_fs.h
<<
>>
Prefs
   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 <linux/atomic.h>
   9
  10struct net;
  11struct completion;
  12struct mm_struct;
  13
  14/*
  15 * The proc filesystem constants/structures
  16 */
  17
  18/*
  19 * Offset of the first process in the /proc root directory..
  20 */
  21#define FIRST_PROCESS_ENTRY 256
  22
  23/* Worst case buffer size needed for holding an integer. */
  24#define PROC_NUMBUF 13
  25
  26/*
  27 * We always define these enumerators
  28 */
  29
  30enum {
  31        PROC_ROOT_INO           = 1,
  32        PROC_IPC_INIT_INO       = 0xEFFFFFFFU,
  33        PROC_UTS_INIT_INO       = 0xEFFFFFFEU,
  34        PROC_USER_INIT_INO      = 0xEFFFFFFDU,
  35        PROC_PID_INIT_INO       = 0xEFFFFFFCU,
  36};
  37
  38/*
  39 * This is not completely implemented yet. The idea is to
  40 * create an in-memory tree (like the actual /proc filesystem
  41 * tree) of these proc_dir_entries, so that we can dynamically
  42 * add new files to /proc.
  43 *
  44 * The "next" pointer creates a linked list of one /proc directory,
  45 * while parent/subdir create the directory structure (every
  46 * /proc file has a parent, but "subdir" is NULL for all
  47 * non-directory entries).
  48 */
  49
  50typedef int (read_proc_t)(char *page, char **start, off_t off,
  51                          int count, int *eof, void *data);
  52typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  53                           unsigned long count, void *data);
  54
  55struct proc_dir_entry {
  56        unsigned int low_ino;
  57        umode_t mode;
  58        nlink_t nlink;
  59        kuid_t uid;
  60        kgid_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        struct proc_dir_entry *next, *parent, *subdir;
  73        void *data;
  74        read_proc_t *read_proc;
  75        write_proc_t *write_proc;
  76        atomic_t count;         /* use count */
  77        int pde_users;  /* number of callers into module in progress */
  78        struct completion *pde_unload_completion;
  79        struct list_head pde_openers;   /* who did ->open, but not ->release */
  80        spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  81        u8 namelen;
  82        char name[];
  83};
  84
  85enum kcore_type {
  86        KCORE_TEXT,
  87        KCORE_VMALLOC,
  88        KCORE_RAM,
  89        KCORE_VMEMMAP,
  90        KCORE_OTHER,
  91};
  92
  93struct kcore_list {
  94        struct list_head list;
  95        unsigned long addr;
  96        size_t size;
  97        int type;
  98};
  99
 100struct 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
 109extern void proc_root_init(void);
 110
 111void proc_flush_task(struct task_struct *task);
 112
 113extern struct proc_dir_entry *create_proc_entry(const char *name, umode_t mode,
 114                                                struct proc_dir_entry *parent);
 115struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
 116                                struct proc_dir_entry *parent,
 117                                const struct file_operations *proc_fops,
 118                                void *data);
 119extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 120
 121struct pid_namespace;
 122
 123extern int pid_ns_prepare_proc(struct pid_namespace *ns);
 124extern void pid_ns_release_proc(struct pid_namespace *ns);
 125
 126/*
 127 * proc_tty.c
 128 */
 129struct tty_driver;
 130extern void proc_tty_init(void);
 131extern void proc_tty_register_driver(struct tty_driver *driver);
 132extern void proc_tty_unregister_driver(struct tty_driver *driver);
 133
 134/*
 135 * proc_devtree.c
 136 */
 137#ifdef CONFIG_PROC_DEVICETREE
 138struct device_node;
 139struct property;
 140extern void proc_device_tree_init(void);
 141extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 142extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 143extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 144                                         struct property *prop);
 145extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 146                                         struct property *newprop,
 147                                         struct property *oldprop);
 148#endif /* CONFIG_PROC_DEVICETREE */
 149
 150extern struct proc_dir_entry *proc_symlink(const char *,
 151                struct proc_dir_entry *, const char *);
 152extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 153extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
 154                        struct proc_dir_entry *parent);
 155
 156static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
 157        struct proc_dir_entry *parent, const struct file_operations *proc_fops)
 158{
 159        return proc_create_data(name, mode, parent, proc_fops, NULL);
 160}
 161
 162static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 163        umode_t mode, struct proc_dir_entry *base, 
 164        read_proc_t *read_proc, void * data)
 165{
 166        struct proc_dir_entry *res=create_proc_entry(name,mode,base);
 167        if (res) {
 168                res->read_proc=read_proc;
 169                res->data=data;
 170        }
 171        return res;
 172}
 173 
 174extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
 175        const char *name, umode_t mode, const struct file_operations *fops);
 176extern void proc_net_remove(struct net *net, const char *name);
 177extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
 178        struct proc_dir_entry *parent);
 179
 180extern struct file *proc_ns_fget(int fd);
 181extern bool proc_ns_inode(struct inode *inode);
 182
 183extern int proc_alloc_inum(unsigned int *pino);
 184extern void proc_free_inum(unsigned int inum);
 185#else
 186
 187#define proc_net_fops_create(net, name, mode, fops)  ({ (void)(mode), NULL; })
 188static inline void proc_net_remove(struct net *net, const char *name) {}
 189
 190static inline void proc_flush_task(struct task_struct *task)
 191{
 192}
 193
 194static inline struct proc_dir_entry *create_proc_entry(const char *name,
 195        umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 196static inline struct proc_dir_entry *proc_create(const char *name,
 197        umode_t mode, struct proc_dir_entry *parent,
 198        const struct file_operations *proc_fops)
 199{
 200        return NULL;
 201}
 202static inline struct proc_dir_entry *proc_create_data(const char *name,
 203        umode_t mode, struct proc_dir_entry *parent,
 204        const struct file_operations *proc_fops, void *data)
 205{
 206        return NULL;
 207}
 208#define remove_proc_entry(name, parent) do {} while (0)
 209
 210static inline struct proc_dir_entry *proc_symlink(const char *name,
 211                struct proc_dir_entry *parent,const char *dest) {return NULL;}
 212static inline struct proc_dir_entry *proc_mkdir(const char *name,
 213        struct proc_dir_entry *parent) {return NULL;}
 214static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
 215        umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 216
 217static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
 218        umode_t mode, struct proc_dir_entry *base, 
 219        read_proc_t *read_proc, void * data) { return NULL; }
 220
 221struct tty_driver;
 222static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 223static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 224
 225static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
 226{
 227        return 0;
 228}
 229
 230static inline void pid_ns_release_proc(struct pid_namespace *ns)
 231{
 232}
 233
 234static inline struct file *proc_ns_fget(int fd)
 235{
 236        return ERR_PTR(-EINVAL);
 237}
 238
 239static inline bool proc_ns_inode(struct inode *inode)
 240{
 241        return false;
 242}
 243
 244static inline int proc_alloc_inum(unsigned int *inum)
 245{
 246        *inum = 1;
 247        return 0;
 248}
 249static inline void proc_free_inum(unsigned int inum)
 250{
 251}
 252#endif /* CONFIG_PROC_FS */
 253
 254#if !defined(CONFIG_PROC_KCORE)
 255static inline void
 256kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
 257{
 258}
 259#else
 260extern void kclist_add(struct kcore_list *, void *, size_t, int type);
 261#endif
 262
 263struct nsproxy;
 264struct proc_ns_operations {
 265        const char *name;
 266        int type;
 267        void *(*get)(struct task_struct *task);
 268        void (*put)(void *ns);
 269        int (*install)(struct nsproxy *nsproxy, void *ns);
 270        unsigned int (*inum)(void *ns);
 271};
 272extern const struct proc_ns_operations netns_operations;
 273extern const struct proc_ns_operations utsns_operations;
 274extern const struct proc_ns_operations ipcns_operations;
 275extern const struct proc_ns_operations pidns_operations;
 276extern const struct proc_ns_operations userns_operations;
 277extern const struct proc_ns_operations mntns_operations;
 278
 279union proc_op {
 280        int (*proc_get_link)(struct dentry *, struct path *);
 281        int (*proc_read)(struct task_struct *task, char *page);
 282        int (*proc_show)(struct seq_file *m,
 283                struct pid_namespace *ns, struct pid *pid,
 284                struct task_struct *task);
 285};
 286
 287struct ctl_table_header;
 288struct ctl_table;
 289
 290struct proc_inode {
 291        struct pid *pid;
 292        int fd;
 293        union proc_op op;
 294        struct proc_dir_entry *pde;
 295        struct ctl_table_header *sysctl;
 296        struct ctl_table *sysctl_entry;
 297        void *ns;
 298        const struct proc_ns_operations *ns_ops;
 299        struct inode vfs_inode;
 300};
 301
 302static inline struct proc_inode *PROC_I(const struct inode *inode)
 303{
 304        return container_of(inode, struct proc_inode, vfs_inode);
 305}
 306
 307static inline struct proc_dir_entry *PDE(const struct inode *inode)
 308{
 309        return PROC_I(inode)->pde;
 310}
 311
 312static inline struct net *PDE_NET(struct proc_dir_entry *pde)
 313{
 314        return pde->parent->data;
 315}
 316
 317#include <linux/signal.h>
 318
 319void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
 320#endif /* _LINUX_PROC_FS_H */
 321
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.