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