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 remove_proc_entry(const char *name, struct proc_dir_entry *parent);
  71 extern int remove_proc_subtree(const char *name, struct proc_dir_entry *parent);
  72
  73 extern struct proc_dir_entry *proc_symlink(const char *,
  74                 struct proc_dir_entry *, const char *);
  75 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
  76 extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
  77                                               struct proc_dir_entry *, void *);
  78 extern struct proc_dir_entry *proc_mkdir_mode(const char *name, umode_t mode,
  79                         struct proc_dir_entry *parent);
  80
  81 static inline struct proc_dir_entry *proc_create(const char *name, umode_t mode,
  82         struct proc_dir_entry *parent, const struct file_operations *proc_fops)
  83 {
  84         return proc_create_data(name, mode, parent, proc_fops, NULL);
  85 }
  86
  87 extern void proc_set_size(struct proc_dir_entry *, loff_t);
  88 extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
  89 extern void *proc_get_parent_data(const struct inode *);
  90 #else
  91
  92 static inline void proc_flush_task(struct task_struct *task)
  93 {
  94 }
  95
  96 #define proc_create(name, mode, parent, fops)  ({ (void)(mode), NULL; })
  97
  98 static inline struct proc_dir_entry *proc_create_data(const char *name,
  99         umode_t mode, struct proc_dir_entry *parent,
 100         const struct file_operations *proc_fops, void *data)
 101 {
 102         return NULL;
 103 }
 104 #define remove_proc_entry(name, parent) do {} while (0)
 105 #define remove_proc_subtree(name, parent) do {} while (0)
 106
 107 static inline struct proc_dir_entry *proc_symlink(const char *name,
 108                 struct proc_dir_entry *parent,const char *dest) {return NULL;}
 109 static inline struct proc_dir_entry *proc_mkdir(const char *name,
 110         struct proc_dir_entry *parent) {return NULL;}
 111 static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
 112         umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
 113 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
 114         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
 115 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
 116 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
 117
 118 #endif /* CONFIG_PROC_FS */
 119
 120
 121 union proc_op {
 122         int (*proc_get_link)(struct dentry *, struct path *);
 123         int (*proc_read)(struct task_struct *task, char *page);
 124         int (*proc_show)(struct seq_file *m,
 125                 struct pid_namespace *ns, struct pid *pid,
 126                 struct task_struct *task);
 127 };
 128
 129 struct ctl_table_header;
 130 struct ctl_table;
 131
 132 struct proc_inode {
 133         struct pid *pid;
 134         int fd;
 135         union proc_op op;
 136         struct proc_dir_entry *pde;
 137         struct ctl_table_header *sysctl;
 138         struct ctl_table *sysctl_entry;
 139         struct proc_ns ns;
 140         struct inode vfs_inode;
 141 };
 142
 143 static inline struct proc_inode *PROC_I(const struct inode *inode)
 144 {
 145         return container_of(inode, struct proc_inode, vfs_inode);
 146 }
 147
 148 static inline struct proc_dir_entry *PDE(const struct inode *inode)
 149 {
 150         return PROC_I(inode)->pde;
 151 }
 152
 153 static inline void *PDE_DATA(const struct inode *inode)
 154 {
 155         return PROC_I(inode)->pde->data;
 156 }
 157
 158 static inline struct proc_dir_entry *proc_net_mkdir(
 159         struct net *net, const char *name, struct proc_dir_entry *parent)
 160 {
 161         return proc_mkdir_data(name, 0, parent, net);
 162 }
 163
 164 #endif /* _LINUX_PROC_FS_H */