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 <linux/atomic.h>
   9 #include <linux/proc_ns.h>
  10
  11 struct net;
  12 struct completion;
  13 struct mm_struct;
  14
  15 /*
  16  * The proc filesystem constants/structures
  17  */
  18
  19 /*
  20  * Offset of the first process in the /proc root directory..
  21  */
  22 #define FIRST_PROCESS_ENTRY 256
  23
  24 /* Worst case buffer size needed for holding an integer. */
  25 #define PROC_NUMBUF 13
  26
  27 /*
  28  * This is not completely implemented yet. The idea is to
  29  * create an in-memory tree (like the actual /proc filesystem
  30  * tree) of these proc_dir_entries, so that we can dynamically
  31  * add new files to /proc.
  32  *
  33  * The "next" pointer creates a linked list of one /proc directory,
  34  * while parent/subdir create the directory structure (every
  35  * /proc file has a parent, but "subdir" is NULL for all
  36  * non-directory entries).
  37  */
  38
  39 struct proc_dir_entry {
  40         unsigned int low_ino;
  41         umode_t mode;
  42         nlink_t nlink;
  43         kuid_t uid;
  44         kgid_t gid;
  45         loff_t size;
  46         const struct inode_operations *proc_iops;
  47         const struct file_operations *proc_fops;
  48         struct proc_dir_entry *next, *parent, *subdir;
  49         void *data;
  50         atomic_t count;         /* use count */
  51         atomic_t in_use;        /* number of callers into module in progress; */
  52                         /* negative -> it's going away RSN */
  53         struct completion *pde_unload_completion;
  54         struct list_head pde_openers;   /* who did ->open, but not ->release */
  55         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  56         u8 namelen;
  57         char name[];
  58 };
  59
  60 #ifdef CONFIG_PROC_FS
  61
  62 extern void proc_root_init(void);
  63
  64 void proc_flush_task(struct task_struct *task);
  65
  66 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
  67                                 struct proc_dir_entry *parent,
  68                                 const struct file_operations *proc_fops,
  69                                 void *data);
  70 extern void proc_remove(struct proc_dir_entry *);
  71 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
  72 extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
  73
  74 extern struct proc_dir_entry *proc_symlink(const char *,
  75                 struct proc_dir_entry *, const char *);
  76 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
  77 extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
  78                                               struct proc_dir_entry *, void *);
  79 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
  80                         struct proc_dir_entry *parent);
  81
  82 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
  83         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
  84 {
  85         return proc_create_data(name, mode, parent, proc_fops, NULL);
  86 }
  87
  88 extern void proc_set_size(struct proc_dir_entry *, loff_t);
  89 extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
  90 extern void *proc_get_parent_data(const struct inode *);
  91 #else
  92
  93 static inline void proc_flush_task(struct task_struct *task)
  94 {
  95 }
  96
  97 #define proc_create(name, mode, parent, fops)  ({ (void)(mode), NULL; })
  98
  99 static inline struct proc_dir_entry *proc_create_data(const char *name,
 100         umode_t mode, struct proc_dir_entry *parent,
 101         const struct file_operations *proc_fops, void *data)
 102 {
 103         return NULL;
 104 }
 105 static inline void proc_remove(struct proc_dir_entry *de) {}
 106 #define remove_proc_entry(name, parent) do {} while (0)
 107 #define remove_proc_subtree(name, parent) do {} while (0)
 108
 109 static inline struct proc_dir_entry *proc_symlink(const char *name,
 110                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 111 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 112         struct proc_dir_entry *parent) {return NULL;}
 113 static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
 114         umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
 115 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
 116         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 117 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
 118 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
 119
 120 #endif /* CONFIG_PROC_FS */
 121
 122
 123 union proc_op {
 124         int (*proc_get_link)(struct dentry *, struct path *);
 125         int (*proc_read)(struct task_struct *task, char *page);
 126         int (*proc_show)(struct seq_file *m,
 127                 struct pid_namespace *ns, struct pid *pid,
 128                 struct task_struct *task);
 129 };
 130
 131 struct ctl_table_header;
 132 struct ctl_table;
 133
 134 struct proc_inode {
 135         struct pid *pid;
 136         int fd;
 137         union proc_op op;
 138         struct proc_dir_entry *pde;
 139         struct ctl_table_header *sysctl;
 140         struct ctl_table *sysctl_entry;
 141         struct proc_ns ns;
 142         struct inode vfs_inode;
 143 };
 144
 145 static inline struct proc_inode *PROC_I(const struct inode *inode)
 146 {
 147         return container_of(inode, struct proc_inode, vfs_inode);
 148 }
 149
 150 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 151 {
 152         return PROC_I(inode)->pde;
 153 }
 154
 155 static inline void *PDE_DATA(const struct inode *inode)
 156 {
 157         return PROC_I(inode)->pde->data;
 158 }
 159
 160 static inline struct proc_dir_entry *proc_net_mkdir(
 161         struct net *net, const char *name, struct proc_dir_entry *parent)
 162 {
 163         return proc_mkdir_data(name, 0, parent, net);
 164 }
 165
 166 #endif /* _LINUX_PROC_FS_H */