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
  10 struct net;
  11 struct completion;
  12 struct 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
  30 enum {
  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
  50 typedef int (read_proc_t)(char *page, char **start, off_t off,
  51                           int count, int *eof, void *data);
  52 typedef int (write_proc_t)(struct file *file, const char __user *buffer,
  53                            unsigned long count, void *data);
  54
  55 struct 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         const struct file_operations *proc_fops;
  64         struct proc_dir_entry *next, *parent, *subdir;
  65         void *data;
  66         read_proc_t *read_proc;
  67         atomic_t count;         /* use count */
  68         atomic_t in_use;        /* number of callers into module in progress; */
  69                         /* negative -> it's going away RSN */
  70         struct completion *pde_unload_completion;
  71         struct list_head pde_openers;   /* who did ->open, but not ->release */
  72         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  73         u8 namelen;
  74         char name[];
  75 };
  76
  77 enum kcore_type {
  78         KCORE_TEXT,
  79         KCORE_VMALLOC,
  80         KCORE_RAM,
  81         KCORE_VMEMMAP,
  82         KCORE_OTHER,
  83 };
  84
  85 struct kcore_list {
  86         struct list_head list;
  87         unsigned long addr;
  88         size_t size;
  89         int type;
  90 };
  91
  92 struct vmcore {
  93         struct list_head list;
  94         unsigned long long paddr;
  95         unsigned long long size;
  96         loff_t offset;
  97 };
  98
  99 #ifdef CONFIG_PROC_FS
 100
 101 extern void proc_root_init(void);
 102
 103 void proc_flush_task(struct task_struct *task);
 104
 105 struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
 106                                 struct proc_dir_entry *parent,
 107                                 const struct file_operations *proc_fops,
 108                                 void *data);
 109 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 110 extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
 111
 112 struct pid_namespace;
 113
 114 extern int pid_ns_prepare_proc(struct pid_namespace *ns);
 115 extern void pid_ns_release_proc(struct pid_namespace *ns);
 116
 117 /*
 118  * proc_tty.c
 119  */
 120 struct tty_driver;
 121 #ifdef CONFIG_TTY
 122 extern void proc_tty_init(void);
 123 #else
 124 static inline void proc_tty_init(void)
 125 { }
 126 #endif
 127 extern void proc_tty_register_driver(struct tty_driver *driver);
 128 extern void proc_tty_unregister_driver(struct tty_driver *driver);
 129
 130 /*
 131  * proc_devtree.c
 132  */
 133 #ifdef CONFIG_PROC_DEVICETREE
 134 struct device_node;
 135 struct property;
 136 extern void proc_device_tree_init(void);
 137 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
 138 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
 139 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
 140                                          struct property *prop);
 141 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
 142                                          struct property *newprop,
 143                                          struct property *oldprop);
 144 #endif /* CONFIG_PROC_DEVICETREE */
 145
 146 extern struct proc_dir_entry *proc_symlink(const char *,
 147                 struct proc_dir_entry *, const char *);
 148 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
 149 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
 150                         struct proc_dir_entry *parent);
 151
 152 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
 153         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
 154 {
 155         return proc_create_data(name, mode, parent, proc_fops, NULL);
 156 }
 157
 158 extern __deprecated
 159 struct proc_dir_entry *create_proc_read_entry(const char *name,
 160         umode_t mode, struct proc_dir_entry *base,
 161         read_proc_t *read_proc, void *data);
 162
 163 extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
 164         struct proc_dir_entry *parent);
 165
 166 extern struct file *proc_ns_fget(int fd);
 167 extern bool proc_ns_inode(struct inode *inode);
 168
 169 extern int proc_alloc_inum(unsigned int *pino);
 170 extern void proc_free_inum(unsigned int inum);
 171 #else
 172
 173 static inline void proc_flush_task(struct task_struct *task)
 174 {
 175 }
 176
 177 #define proc_create(name, mode, parent, fops)  ({ (void)(mode), NULL; })
 178
 179 static inline struct proc_dir_entry *proc_create_data(const char *name,
 180         umode_t mode, struct proc_dir_entry *parent,
 181         const struct file_operations *proc_fops, void *data)
 182 {
 183         return NULL;
 184 }
 185 #define remove_proc_entry(name, parent) do {} while (0)
 186 #define remove_proc_subtree(name, parent) do {} while (0)
 187
 188 static inline struct proc_dir_entry *proc_symlink(const char *name,
 189                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 190 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 191         struct proc_dir_entry *parent) {return NULL;}
 192 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
 193         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 194
 195 static inline __deprecated
 196 struct proc_dir_entry *create_proc_read_entry(const char *name,
 197         umode_t mode, struct proc_dir_entry *base,
 198         read_proc_t *read_proc, void * data) { return NULL; }
 199
 200 struct tty_driver;
 201 static inline void proc_tty_register_driver(struct tty_driver *driver) {};
 202 static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
 203
 204 static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
 205 {
 206         return 0;
 207 }
 208
 209 static inline void pid_ns_release_proc(struct pid_namespace *ns)
 210 {
 211 }
 212
 213 static inline struct file *proc_ns_fget(int fd)
 214 {
 215         return ERR_PTR(-EINVAL);
 216 }
 217
 218 static inline bool proc_ns_inode(struct inode *inode)
 219 {
 220         return false;
 221 }
 222
 223 static inline int proc_alloc_inum(unsigned int *inum)
 224 {
 225         *inum = 1;
 226         return 0;
 227 }
 228 static inline void proc_free_inum(unsigned int inum)
 229 {
 230 }
 231 #endif /* CONFIG_PROC_FS */
 232
 233 #if !defined(CONFIG_PROC_KCORE)
 234 static inline void
 235 kclist_add(struct kcore_list *new, void *addr, size_t size, int type)
 236 {
 237 }
 238 #else
 239 extern void kclist_add(struct kcore_list *, void *, size_t, int type);
 240 #endif
 241
 242 struct nsproxy;
 243 struct proc_ns_operations {
 244         const char *name;
 245         int type;
 246         void *(*get)(struct task_struct *task);
 247         void (*put)(void *ns);
 248         int (*install)(struct nsproxy *nsproxy, void *ns);
 249         unsigned int (*inum)(void *ns);
 250 };
 251 extern const struct proc_ns_operations netns_operations;
 252 extern const struct proc_ns_operations utsns_operations;
 253 extern const struct proc_ns_operations ipcns_operations;
 254 extern const struct proc_ns_operations pidns_operations;
 255 extern const struct proc_ns_operations userns_operations;
 256 extern const struct proc_ns_operations mntns_operations;
 257
 258 union proc_op {
 259         int (*proc_get_link)(struct dentry *, struct path *);
 260         int (*proc_read)(struct task_struct *task, char *page);
 261         int (*proc_show)(struct seq_file *m,
 262                 struct pid_namespace *ns, struct pid *pid,
 263                 struct task_struct *task);
 264 };
 265
 266 struct ctl_table_header;
 267 struct ctl_table;
 268
 269 struct proc_inode {
 270         struct pid *pid;
 271         int fd;
 272         union proc_op op;
 273         struct proc_dir_entry *pde;
 274         struct ctl_table_header *sysctl;
 275         struct ctl_table *sysctl_entry;
 276         void *ns;
 277         const struct proc_ns_operations *ns_ops;
 278         struct inode vfs_inode;
 279 };
 280
 281 static inline struct proc_inode *PROC_I(const struct inode *inode)
 282 {
 283         return container_of(inode, struct proc_inode, vfs_inode);
 284 }
 285
 286 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 287 {
 288         return PROC_I(inode)->pde;
 289 }
 290
 291 static inline void *PDE_DATA(const struct inode *inode)
 292 {
 293         return PROC_I(inode)->pde->data;
 294 }
 295
 296 static inline struct net *PDE_NET(struct proc_dir_entry *pde)
 297 {
 298         return pde->parent->data;
 299 }
 300
 301 #include <linux/signal.h>
 302
 303 void render_sigset_t(struct seq_file *m, const char *header, sigset_t *set);
 304 #endif /* _LINUX_PROC_FS_H */