blob: 9aad373cf11d7362383c52f36dc836802626bd58 [file] [log] [blame]
David Howells59d80532013-04-11 13:34:43 +01001/* Internal procfs definitions
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
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>
David Howells59d80532013-04-11 13:34:43 +010013#include <linux/proc_ns.h>
14#include <linux/spinlock.h>
15#include <linux/atomic.h>
Kees Cooke579d2c2013-02-27 17:03:15 -080016#include <linux/binfmts.h>
Ingo Molnarf7ccbae2017-02-08 18:51:30 +010017#include <linux/sched/coredump.h>
Ingo Molnarf719ff92017-02-06 10:57:33 +010018#include <linux/sched/task.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
David Howells59d80532013-04-11 13:34:43 +010020struct ctl_table_header;
21struct mempolicy;
Eric W. Biederman77b14db2007-02-14 00:34:12 -080022
David Howells59d80532013-04-11 13:34:43 +010023/*
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 *
Nicolas Dichtel710585d2014-12-10 15:45:01 -080029 * 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.
David Howells59d80532013-04-11 13:34:43 +010032 */
33struct 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;
Nicolas Dichtel710585d2014-12-10 15:45:01 -080042 struct proc_dir_entry *parent;
Davidlohr Bueso410bd5e2017-09-08 16:15:15 -070043 struct rb_root_cached subdir;
Nicolas Dichtel710585d2014-12-10 15:45:01 -080044 struct rb_node subdir_node;
David Howells59d80532013-04-11 13:34:43 +010045 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[];
Kees Cook3859a272016-10-28 01:22:25 -070054} __randomize_layout;
Stephen Wilsonf2beb792011-05-24 17:12:48 -070055
David Howells59d80532013-04-11 13:34:43 +010056union proc_op {
57 int (*proc_get_link)(struct dentry *, struct path *);
David Howells59d80532013-04-11 13:34:43 +010058 int (*proc_show)(struct seq_file *m,
59 struct pid_namespace *ns, struct pid *pid,
60 struct task_struct *task);
61};
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
David Howells59d80532013-04-11 13:34:43 +010063struct proc_inode {
Eric W. Biederman13b41b02006-06-26 00:25:56 -070064 struct pid *pid;
Alexey Dobriyan771187d2016-09-02 00:42:02 +030065 unsigned int fd;
David Howells59d80532013-04-11 13:34:43 +010066 union proc_op op;
67 struct proc_dir_entry *pde;
68 struct ctl_table_header *sysctl;
69 struct ctl_table *sysctl_entry;
Eric W. Biederman2fd1d2c2017-07-06 08:41:06 -050070 struct hlist_node sysctl_inodes;
Al Viro3d3d35b2014-11-01 11:10:28 -040071 const struct proc_ns_operations *ns_ops;
David Howells59d80532013-04-11 13:34:43 +010072 struct inode vfs_inode;
Kees Cook3859a272016-10-28 01:22:25 -070073} __randomize_layout;
Eric W. Biederman99f89552006-06-26 00:25:55 -070074
David Howellsc30480b2013-04-12 18:03:36 +010075/*
76 * General functions
77 */
78static inline struct proc_inode *PROC_I(const struct inode *inode)
79{
80 return container_of(inode, struct proc_inode, vfs_inode);
81}
82
83static inline struct proc_dir_entry *PDE(const struct inode *inode)
84{
85 return PROC_I(inode)->pde;
86}
87
88static inline void *__PDE_DATA(const struct inode *inode)
89{
90 return PDE(inode)->data;
91}
Adrian Bunkfee781e2006-01-08 01:04:16 -080092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093static inline struct pid *proc_pid(struct inode *inode)
94{
Eric W. Biederman99f89552006-06-26 00:25:55 -070095 return PROC_I(inode)->pid;
96}
97
98static inline struct task_struct *get_proc_task(struct inode *inode)
99{
Eric W. Biederman13b41b02006-06-26 00:25:56 -0700100 return get_pid_task(proc_pid(inode), PIDTYPE_PID);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101}
102
Eric W. Biederman68eb94f2017-01-03 10:23:11 +1300103void task_dump_owner(struct task_struct *task, mode_t mode,
104 kuid_t *ruid, kgid_t *rgid);
Cyrill Gorcunovfaf60af2012-08-23 14:43:24 +0400105
Alexey Dobriyan3ee2a192017-11-17 15:26:49 -0800106unsigned name_to_int(const struct qstr *qstr);
David Howells1dd704b2013-04-12 01:08:50 +0100107/*
David Howells59d80532013-04-11 13:34:43 +0100108 * Offset of the first process in the /proc root directory..
109 */
110#define FIRST_PROCESS_ENTRY 256
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700111
David Howells59d80532013-04-11 13:34:43 +0100112/* Worst case buffer size needed for holding an integer. */
113#define PROC_NUMBUF 13
Al Viro3174c212009-04-07 13:19:18 -0400114
David Howells59d80532013-04-11 13:34:43 +0100115/*
116 * array.c
117 */
118extern const struct file_operations proc_tid_children_operations;
119
120extern int proc_tid_stat(struct seq_file *, struct pid_namespace *,
121 struct pid *, struct task_struct *);
122extern int proc_tgid_stat(struct seq_file *, struct pid_namespace *,
123 struct pid *, struct task_struct *);
124extern int proc_pid_status(struct seq_file *, struct pid_namespace *,
125 struct pid *, struct task_struct *);
126extern int proc_pid_statm(struct seq_file *, struct pid_namespace *,
127 struct pid *, struct task_struct *);
128
129/*
David Howells1dd704b2013-04-12 01:08:50 +0100130 * base.c
131 */
David Howells59d80532013-04-11 13:34:43 +0100132extern const struct dentry_operations pid_dentry_operations;
David Howellsa528d352017-01-31 16:46:22 +0000133extern int pid_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells59d80532013-04-11 13:34:43 +0100134extern int proc_setattr(struct dentry *, struct iattr *);
Andreas Gruenbacherdb978da2016-11-10 22:18:28 +0100135extern struct inode *proc_pid_make_inode(struct super_block *, struct task_struct *, umode_t);
David Howells59d80532013-04-11 13:34:43 +0100136extern int pid_revalidate(struct dentry *, unsigned int);
David Howells1dd704b2013-04-12 01:08:50 +0100137extern int pid_delete_dentry(const struct dentry *);
Al Virof0c3b502013-05-16 12:07:31 -0400138extern int proc_pid_readdir(struct file *, struct dir_context *);
David Howells59d80532013-04-11 13:34:43 +0100139extern struct dentry *proc_pid_lookup(struct inode *, struct dentry *, unsigned int);
140extern loff_t mem_lseek(struct file *, loff_t, int);
David Howells1dd704b2013-04-12 01:08:50 +0100141
David Howells59d80532013-04-11 13:34:43 +0100142/* Lookups */
Al Viroc52a47a2013-06-15 11:15:20 +0400143typedef int instantiate_t(struct inode *, struct dentry *,
David Howells59d80532013-04-11 13:34:43 +0100144 struct task_struct *, const void *);
Al Virof0c3b502013-05-16 12:07:31 -0400145extern bool proc_fill_cache(struct file *, struct dir_context *, const char *, int,
David Howells59d80532013-04-11 13:34:43 +0100146 instantiate_t, struct task_struct *, const void *);
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700147
David Howells59d80532013-04-11 13:34:43 +0100148/*
149 * generic.c
150 */
David Howells59d80532013-04-11 13:34:43 +0100151extern struct dentry *proc_lookup(struct inode *, struct dentry *, unsigned int);
152extern struct dentry *proc_lookup_de(struct proc_dir_entry *, struct inode *,
153 struct dentry *);
Al Virof0c3b502013-05-16 12:07:31 -0400154extern int proc_readdir(struct file *, struct dir_context *);
155extern int proc_readdir_de(struct proc_dir_entry *, struct file *, struct dir_context *);
Al Viro3174c212009-04-07 13:19:18 -0400156
Alexey Dobriyan135d5652009-12-15 16:45:39 -0800157static inline struct proc_dir_entry *pde_get(struct proc_dir_entry *pde)
158{
159 atomic_inc(&pde->count);
160 return pde;
161}
David Howells59d80532013-04-11 13:34:43 +0100162extern void pde_put(struct proc_dir_entry *);
Al Viro3174c212009-04-07 13:19:18 -0400163
Eric W. Biedermaneb6d38d2015-05-11 16:44:25 -0500164static inline bool is_empty_pde(const struct proc_dir_entry *pde)
165{
166 return S_ISDIR(pde->mode) && !pde->proc_iops;
167}
Eric W. Biedermaneb6d38d2015-05-11 16:44:25 -0500168
Al Viro3174c212009-04-07 13:19:18 -0400169/*
David Howells59d80532013-04-11 13:34:43 +0100170 * inode.c
Al Viro3174c212009-04-07 13:19:18 -0400171 */
Pavel Emelyanove9720ac2008-03-07 11:08:40 -0800172struct pde_opener {
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700173 struct file *file;
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700174 struct list_head lh;
Alexey Dobriyanf5887c712016-12-12 16:45:17 -0800175 bool closing;
Al Viro05c0ae22013-04-04 16:28:47 -0400176 struct completion *c;
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700177};
Al Viro7e0e9532015-02-21 22:16:11 -0500178extern const struct inode_operations proc_link_inode_operations;
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800179
David Howells59d80532013-04-11 13:34:43 +0100180extern const struct inode_operations proc_pid_link_inode_operations;
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800181
David Howells59d80532013-04-11 13:34:43 +0100182extern void proc_init_inodecache(void);
Alexey Dobriyan1270dd82016-12-12 16:45:32 -0800183void set_proc_pid_nlink(void);
David Howells59d80532013-04-11 13:34:43 +0100184extern struct inode *proc_get_inode(struct super_block *, struct proc_dir_entry *);
Eric W. Biedermane94591d2016-06-09 15:32:10 -0500185extern int proc_fill_super(struct super_block *, void *data, int flags);
David Howells59d80532013-04-11 13:34:43 +0100186extern void proc_entry_rundown(struct proc_dir_entry *);
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800187
Al Viro3174c212009-04-07 13:19:18 -0400188/*
David Howells59d80532013-04-11 13:34:43 +0100189 * proc_namespaces.c
190 */
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800191extern const struct inode_operations proc_ns_dir_inode_operations;
192extern const struct file_operations proc_ns_dir_operations;
193
David Howells59d80532013-04-11 13:34:43 +0100194/*
195 * proc_net.c
196 */
197extern const struct file_operations proc_net_operations;
198extern const struct inode_operations proc_net_inode_operations;
199
200#ifdef CONFIG_NET
201extern int proc_net_init(void);
202#else
203static inline int proc_net_init(void) { return 0; }
204#endif
205
206/*
207 * proc_self.c
208 */
209extern int proc_setup_self(struct super_block *);
210
211/*
Eric W. Biederman00978752014-07-31 03:10:50 -0700212 * proc_thread_self.c
213 */
214extern int proc_setup_thread_self(struct super_block *);
215extern void proc_thread_self_init(void);
216
217/*
David Howells59d80532013-04-11 13:34:43 +0100218 * proc_sysctl.c
219 */
220#ifdef CONFIG_PROC_SYSCTL
221extern int proc_sys_init(void);
Konstantin Khlebnikovd6cffbb2017-02-10 10:35:02 +0300222extern void proc_sys_evict_inode(struct inode *inode,
223 struct ctl_table_header *head);
David Howells59d80532013-04-11 13:34:43 +0100224#else
225static inline void proc_sys_init(void) { }
Konstantin Khlebnikovd6cffbb2017-02-10 10:35:02 +0300226static inline void proc_sys_evict_inode(struct inode *inode,
227 struct ctl_table_header *head) { }
David Howells59d80532013-04-11 13:34:43 +0100228#endif
David Howells34db8aa2013-04-12 02:29:19 +0100229
230/*
231 * proc_tty.c
232 */
233#ifdef CONFIG_TTY
234extern void proc_tty_init(void);
235#else
236static inline void proc_tty_init(void) {}
237#endif
David Howells59d80532013-04-11 13:34:43 +0100238
239/*
240 * root.c
241 */
242extern struct proc_dir_entry proc_root;
Eric W. Biedermane94591d2016-06-09 15:32:10 -0500243extern int proc_parse_options(char *options, struct pid_namespace *pid);
David Howells59d80532013-04-11 13:34:43 +0100244
245extern void proc_self_init(void);
246extern int proc_remount(struct super_block *, int *, char *);
247
248/*
249 * task_[no]mmu.c
250 */
Daniel Colascione493b0e92017-09-06 16:25:08 -0700251struct mem_size_stats;
David Howells59d80532013-04-11 13:34:43 +0100252struct proc_maps_private {
Oleg Nesterov2c033762014-10-09 15:25:51 -0700253 struct inode *inode;
David Howells59d80532013-04-11 13:34:43 +0100254 struct task_struct *task;
Oleg Nesterov29a40ac2014-10-09 15:25:26 -0700255 struct mm_struct *mm;
Daniel Colascione493b0e92017-09-06 16:25:08 -0700256 struct mem_size_stats *rollup;
David Howells59d80532013-04-11 13:34:43 +0100257#ifdef CONFIG_MMU
258 struct vm_area_struct *tail_vma;
259#endif
260#ifdef CONFIG_NUMA
261 struct mempolicy *task_mempolicy;
262#endif
Kees Cook3859a272016-10-28 01:22:25 -0700263} __randomize_layout;
David Howells59d80532013-04-11 13:34:43 +0100264
Oleg Nesterov5381e162014-10-09 15:25:24 -0700265struct mm_struct *proc_mem_open(struct inode *inode, unsigned int mode);
266
David Howells59d80532013-04-11 13:34:43 +0100267extern const struct file_operations proc_pid_maps_operations;
268extern const struct file_operations proc_tid_maps_operations;
269extern const struct file_operations proc_pid_numa_maps_operations;
270extern const struct file_operations proc_tid_numa_maps_operations;
271extern const struct file_operations proc_pid_smaps_operations;
Daniel Colascione493b0e92017-09-06 16:25:08 -0700272extern const struct file_operations proc_pid_smaps_rollup_operations;
David Howells59d80532013-04-11 13:34:43 +0100273extern const struct file_operations proc_tid_smaps_operations;
274extern const struct file_operations proc_clear_refs_operations;
275extern const struct file_operations proc_pagemap_operations;
276
277extern unsigned long task_vsize(struct mm_struct *);
278extern unsigned long task_statm(struct mm_struct *,
279 unsigned long *, unsigned long *,
280 unsigned long *, unsigned long *);
281extern void task_mem(struct seq_file *, struct mm_struct *);