fs/proc/internal.h

   1 /* Internal procfs definitions
   2  *
   3  * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/proc_fs.h>
  13 #include <linux/proc_ns.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/atomic.h>
  16 #include <linux/binfmts.h>
  17
  18 struct ctl_table_header;
  19 struct mempolicy;
  20
  21 /*
  22  * This is not completely implemented yet. The idea is to
  23  * create an in-memory tree (like the actual /proc filesystem
  24  * tree) of these proc_dir_entries, so that we can dynamically
  25  * add new files to /proc.
  26  *
  27  * parent/subdir are used for the directory structure (every /proc file has a
  28  * parent, but "subdir" is empty for all non-directory entries).
  29  * subdir_node is used to build the rb tree "subdir" of the parent.
  30  */
  31 struct proc_dir_entry {
  32         unsigned int low_ino;
  33         umode_t mode;
  34         nlink_t nlink;
  35         kuid_t uid;
  36         kgid_t gid;
  37         loff_t size;
  38         const struct inode_operations *proc_iops;
  39         const struct file_operations *proc_fops;
  40         struct proc_dir_entry *parent;
  41         struct rb_root subdir;
  42         struct rb_node subdir_node;
  43         void *data;
  44         atomic_t count;         /* use count */
  45         atomic_t in_use;        /* number of callers into module in progress; */
  46                         /* negative -> it's going away RSN */
  47         struct completion *pde_unload_completion;
  48         struct list_head pde_openers;   /* who did ->open, but not ->release */
  49         spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
  50         u8 namelen;
  51         char name[];
  52 };
  53
  54 union proc_op {
  55         int (*proc_get_link)(struct dentry *, struct path *);
  56         int (*proc_show)(struct seq_file *m,
  57                 struct pid_namespace *ns, struct pid *pid,
  58                 struct task_struct *task);
  59 };
  60
  61 struct proc_inode {
  62         struct pid *pid;
  63         unsigned int fd;
  64         union proc_op op;
  65         struct proc_dir_entry *pde;
  66         struct ctl_table_header *sysctl;
  67         struct ctl_table *sysctl_entry;
  68         struct hlist_node sysctl_inodes;
  69         const struct proc_ns_operations *ns_ops;
  70         struct inode vfs_inode;
  71 };
  72
  73 /*
  74  * General functions
  75  */
  76 static inline struct proc_inode *PROC_I(const struct inode *inode)
  77 {
  78         return container_of(inode, struct proc_inode, vfs_inode);
  79 }
  80
  81 static inline struct proc_dir_entry *PDE(const struct inode *inode)
  82 {
  83         return PROC_I(inode)->pde;
  84 }
  85
  86 static inline void *__PDE_DATA(const struct inode *inode)
  87 {
  88         return PDE(inode)->data;
  89 }
  90
  91 static inline struct pid *proc_pid(struct inode *inode)
  92 {
  93         return PROC_I(inode)->pid;
  94 }
  95
  96 static inline struct task_struct *get_proc_task(struct inode *inode)
  97 {
  98         return get_pid_task(proc_pid(inode), PIDTYPE_PID);
  99 }
 100
 101 static inline int task_dumpable(struct task_struct *task)
 102 {
 103         int dumpable = 0;
 104         struct mm_struct *mm;
 105
 106         task_lock(task);
 107         mm = task->mm;
 108         if (mm)
 109                 dumpable = get_dumpable(mm);
 110         task_unlock(task);
 111         if (dumpable == SUID_DUMP_USER)
 112                 return 1;
 113         return 0;
 114 }
 115
 116 static inline unsigned name_to_int(const struct qstr *qstr)
 117 {
 118         const char *name = qstr->name;
 119         int len = qstr->len;
 120         unsigned n = 0;
 121
 122         if (len > 1 && *name == '0')
 123                 goto out;
 124         while (len-- > 0) {
 125                 unsigned c = *name++ - '0';
 126                 if (c > 9)
 127                         goto out;
 128                 if (n >= (~0U-9)/10)
 129                         goto out;
 130                 n *= 10;
 131                 n += c;
 132         }
 133         return n;
 134 out:
 135         return ~0U;
 136 }
 137
 138 /*
 139  * Offset of the first process in the /proc root directory..
 140  */
 141 #define FIRST_PROCESS_ENTRY 256
 142
 143 /* Worst case buffer size needed for holding an integer. */
 144 #define PROC_NUMBUF 13
 145
 146 /*
 147  * array.c
 148  */
 149 extern const struct file_operations proc_tid_children_operations;
 150
 151 extern int proc_tid_stat(struct seq_file *, struct pid_namespace *,
 152                          struct pid *, struct task_struct *);
 153 extern int proc_tgid_stat(struct seq_file *, struct pid_namespace *,
 154                           struct pid *, struct task_struct *);
 155 extern int proc_pid_status(struct seq_file *, struct pid_namespace *,
 156                            struct pid *, struct task_struct *);
 157 extern int proc_pid_statm(struct seq_file *, struct pid_namespace *,
 158                           struct pid *, struct task_struct *);
 159
 160 /*
 161  * base.c
 162  */
 163 extern const struct dentry_operations pid_dentry_operations;
 164 extern int pid_getattr(struct vfsmount *, struct dentry *, struct kstat *);
 165 extern int proc_setattr(struct dentry *, struct iattr *);
 166 extern struct inode *proc_pid_make_inode(struct super_block *, struct task_struct *, umode_t);
 167 extern int pid_revalidate(struct dentry *, unsigned int);
 168 extern int pid_delete_dentry(const struct dentry *);
 169 extern int proc_pid_readdir(struct file *, struct dir_context *);
 170 extern struct dentry *proc_pid_lookup(struct inode *, struct dentry *, unsigned int);
 171 extern loff_t mem_lseek(struct file *, loff_t, int);
 172
 173 /* Lookups */
 174 typedef int instantiate_t(struct inode *, struct dentry *,
 175                                      struct task_struct *, const void *);
 176 extern bool proc_fill_cache(struct file *, struct dir_context *, const char *, int,
 177                            instantiate_t, struct task_struct *, const void *);
 178
 179 /*
 180  * generic.c
 181  */
 182 extern struct dentry *proc_lookup(struct inode *, struct dentry *, unsigned int);
 183 extern struct dentry *proc_lookup_de(struct proc_dir_entry *, struct inode *,
 184                                      struct dentry *);
 185 extern int proc_readdir(struct file *, struct dir_context *);
 186 extern int proc_readdir_de(struct proc_dir_entry *, struct file *, struct dir_context *);
 187
 188 static inline struct proc_dir_entry *pde_get(struct proc_dir_entry *pde)
 189 {
 190         atomic_inc(&pde->count);
 191         return pde;
 192 }
 193 extern void pde_put(struct proc_dir_entry *);
 194
 195 static inline bool is_empty_pde(const struct proc_dir_entry *pde)
 196 {
 197         return S_ISDIR(pde->mode) && !pde->proc_iops;
 198 }
 199 struct proc_dir_entry *proc_create_mount_point(const char *name);
 200
 201 /*
 202  * inode.c
 203  */
 204 struct pde_opener {
 205         struct file *file;
 206         struct list_head lh;
 207         int closing;
 208         struct completion *c;
 209 };
 210 extern const struct inode_operations proc_link_inode_operations;
 211
 212 extern const struct inode_operations proc_pid_link_inode_operations;
 213
 214 extern void proc_init_inodecache(void);
 215 extern struct inode *proc_get_inode(struct super_block *, struct proc_dir_entry *);
 216 extern int proc_fill_super(struct super_block *, void *data, int flags);
 217 extern void proc_entry_rundown(struct proc_dir_entry *);
 218
 219 /*
 220  * proc_namespaces.c
 221  */
 222 extern const struct inode_operations proc_ns_dir_inode_operations;
 223 extern const struct file_operations proc_ns_dir_operations;
 224
 225 /*
 226  * proc_net.c
 227  */
 228 extern const struct file_operations proc_net_operations;
 229 extern const struct inode_operations proc_net_inode_operations;
 230
 231 #ifdef CONFIG_NET
 232 extern int proc_net_init(void);
 233 #else
 234 static inline int proc_net_init(void) { return 0; }
 235 #endif
 236
 237 /*
 238  * proc_self.c
 239  */
 240 extern int proc_setup_self(struct super_block *);
 241
 242 /*
 243  * proc_thread_self.c
 244  */
 245 extern int proc_setup_thread_self(struct super_block *);
 246 extern void proc_thread_self_init(void);
 247
 248 /*
 249  * proc_sysctl.c
 250  */
 251 #ifdef CONFIG_PROC_SYSCTL
 252 extern int proc_sys_init(void);
 253 extern void proc_sys_evict_inode(struct inode *inode,
 254                                  struct ctl_table_header *head);
 255 #else
 256 static inline void proc_sys_init(void) { }
 257 static inline void proc_sys_evict_inode(struct  inode *inode,
 258                                         struct ctl_table_header *head) { }
 259 #endif
 260
 261 /*
 262  * proc_tty.c
 263  */
 264 #ifdef CONFIG_TTY
 265 extern void proc_tty_init(void);
 266 #else
 267 static inline void proc_tty_init(void) {}
 268 #endif
 269
 270 /*
 271  * root.c
 272  */
 273 extern struct proc_dir_entry proc_root;
 274 extern int proc_parse_options(char *options, struct pid_namespace *pid);
 275
 276 extern void proc_self_init(void);
 277 extern int proc_remount(struct super_block *, int *, char *);
 278
 279 /*
 280  * task_[no]mmu.c
 281  */
 282 struct proc_maps_private {
 283         struct inode *inode;
 284         struct task_struct *task;
 285         struct mm_struct *mm;
 286 #ifdef CONFIG_MMU
 287         struct vm_area_struct *tail_vma;
 288 #endif
 289 #ifdef CONFIG_NUMA
 290         struct mempolicy *task_mempolicy;
 291 #endif
 292 };
 293
 294 struct mm_struct *proc_mem_open(struct inode *inode, unsigned int mode);
 295
 296 extern const struct file_operations proc_pid_maps_operations;
 297 extern const struct file_operations proc_tid_maps_operations;
 298 extern const struct file_operations proc_pid_numa_maps_operations;
 299 extern const struct file_operations proc_tid_numa_maps_operations;
 300 extern const struct file_operations proc_pid_smaps_operations;
 301 extern const struct file_operations proc_tid_smaps_operations;
 302 extern const struct file_operations proc_clear_refs_operations;
 303 extern const struct file_operations proc_pagemap_operations;
 304
 305 extern unsigned long task_vsize(struct mm_struct *);
 306 extern unsigned long task_statm(struct mm_struct *,
 307                                 unsigned long *, unsigned long *,
 308                                 unsigned long *, unsigned long *);
 309 extern void task_mem(struct seq_file *, struct mm_struct *);