blob: aa2781095bd15f4d9e98b5bcf58fe77ba5576f09 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
David Howells59d80532013-04-11 13:34:43 +010018struct ctl_table_header;
19struct mempolicy;
Eric W. Biederman77b14db2007-02-14 00:34:12 -080020
David Howells59d80532013-04-11 13:34:43 +010021/*
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 *
Nicolas Dichtel710585d2014-12-10 15:45:01 -080027 * 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.
David Howells59d80532013-04-11 13:34:43 +010030 */
31struct 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;
Nicolas Dichtel710585d2014-12-10 15:45:01 -080040 struct proc_dir_entry *parent;
41 struct rb_root subdir;
42 struct rb_node subdir_node;
David Howells59d80532013-04-11 13:34:43 +010043 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[];
Stephen Wilsonf2beb792011-05-24 17:12:48 -070052};
53
David Howells59d80532013-04-11 13:34:43 +010054union proc_op {
55 int (*proc_get_link)(struct dentry *, struct path *);
David Howells59d80532013-04-11 13:34:43 +010056 int (*proc_show)(struct seq_file *m,
57 struct pid_namespace *ns, struct pid *pid,
58 struct task_struct *task);
59};
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
David Howells59d80532013-04-11 13:34:43 +010061struct proc_inode {
Eric W. Biederman13b41b02006-06-26 00:25:56 -070062 struct pid *pid;
David Howells59d80532013-04-11 13:34:43 +010063 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;
Al Viro3d3d35b2014-11-01 11:10:28 -040068 const struct proc_ns_operations *ns_ops;
David Howells59d80532013-04-11 13:34:43 +010069 struct inode vfs_inode;
Eric W. Biederman99f89552006-06-26 00:25:55 -070070};
71
David Howellsc30480b2013-04-12 18:03:36 +010072/*
73 * General functions
74 */
75static inline struct proc_inode *PROC_I(const struct inode *inode)
76{
77 return container_of(inode, struct proc_inode, vfs_inode);
78}
79
80static inline struct proc_dir_entry *PDE(const struct inode *inode)
81{
82 return PROC_I(inode)->pde;
83}
84
85static inline void *__PDE_DATA(const struct inode *inode)
86{
87 return PDE(inode)->data;
88}
Adrian Bunkfee781e2006-01-08 01:04:16 -080089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090static inline struct pid *proc_pid(struct inode *inode)
91{
Eric W. Biederman99f89552006-06-26 00:25:55 -070092 return PROC_I(inode)->pid;
93}
94
95static inline struct task_struct *get_proc_task(struct inode *inode)
96{
Eric W. Biederman13b41b02006-06-26 00:25:56 -070097 return get_pid_task(proc_pid(inode), PIDTYPE_PID);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098}
99
Cyrill Gorcunovfaf60af2012-08-23 14:43:24 +0400100static inline int task_dumpable(struct task_struct *task)
101{
102 int dumpable = 0;
103 struct mm_struct *mm;
104
105 task_lock(task);
106 mm = task->mm;
107 if (mm)
108 dumpable = get_dumpable(mm);
109 task_unlock(task);
Kees Cooke579d2c2013-02-27 17:03:15 -0800110 if (dumpable == SUID_DUMP_USER)
Cyrill Gorcunovfaf60af2012-08-23 14:43:24 +0400111 return 1;
112 return 0;
113}
114
Alexey Dobriyandbcdb502014-08-08 14:21:25 -0700115static inline unsigned name_to_int(const struct qstr *qstr)
Cyrill Gorcunovfaf60af2012-08-23 14:43:24 +0400116{
Alexey Dobriyandbcdb502014-08-08 14:21:25 -0700117 const char *name = qstr->name;
118 int len = qstr->len;
Cyrill Gorcunovfaf60af2012-08-23 14:43:24 +0400119 unsigned n = 0;
120
121 if (len > 1 && *name == '0')
122 goto out;
123 while (len-- > 0) {
124 unsigned c = *name++ - '0';
125 if (c > 9)
126 goto out;
127 if (n >= (~0U-9)/10)
128 goto out;
129 n *= 10;
130 n += c;
131 }
132 return n;
133out:
134 return ~0U;
135}
136
David Howells1dd704b2013-04-12 01:08:50 +0100137/*
David Howells59d80532013-04-11 13:34:43 +0100138 * Offset of the first process in the /proc root directory..
139 */
140#define FIRST_PROCESS_ENTRY 256
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700141
David Howells59d80532013-04-11 13:34:43 +0100142/* Worst case buffer size needed for holding an integer. */
143#define PROC_NUMBUF 13
Al Viro3174c212009-04-07 13:19:18 -0400144
David Howells59d80532013-04-11 13:34:43 +0100145/*
146 * array.c
147 */
148extern const struct file_operations proc_tid_children_operations;
149
150extern int proc_tid_stat(struct seq_file *, struct pid_namespace *,
151 struct pid *, struct task_struct *);
152extern int proc_tgid_stat(struct seq_file *, struct pid_namespace *,
153 struct pid *, struct task_struct *);
154extern int proc_pid_status(struct seq_file *, struct pid_namespace *,
155 struct pid *, struct task_struct *);
156extern int proc_pid_statm(struct seq_file *, struct pid_namespace *,
157 struct pid *, struct task_struct *);
158
159/*
David Howells1dd704b2013-04-12 01:08:50 +0100160 * base.c
161 */
David Howells59d80532013-04-11 13:34:43 +0100162extern const struct dentry_operations pid_dentry_operations;
163extern int pid_getattr(struct vfsmount *, struct dentry *, struct kstat *);
164extern int proc_setattr(struct dentry *, struct iattr *);
165extern struct inode *proc_pid_make_inode(struct super_block *, struct task_struct *);
166extern int pid_revalidate(struct dentry *, unsigned int);
David Howells1dd704b2013-04-12 01:08:50 +0100167extern int pid_delete_dentry(const struct dentry *);
Al Virof0c3b502013-05-16 12:07:31 -0400168extern int proc_pid_readdir(struct file *, struct dir_context *);
David Howells59d80532013-04-11 13:34:43 +0100169extern struct dentry *proc_pid_lookup(struct inode *, struct dentry *, unsigned int);
170extern loff_t mem_lseek(struct file *, loff_t, int);
David Howells1dd704b2013-04-12 01:08:50 +0100171
David Howells59d80532013-04-11 13:34:43 +0100172/* Lookups */
Al Viroc52a47a2013-06-15 11:15:20 +0400173typedef int instantiate_t(struct inode *, struct dentry *,
David Howells59d80532013-04-11 13:34:43 +0100174 struct task_struct *, const void *);
Al Virof0c3b502013-05-16 12:07:31 -0400175extern bool proc_fill_cache(struct file *, struct dir_context *, const char *, int,
David Howells59d80532013-04-11 13:34:43 +0100176 instantiate_t, struct task_struct *, const void *);
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700177
David Howells59d80532013-04-11 13:34:43 +0100178/*
179 * generic.c
180 */
David Howells59d80532013-04-11 13:34:43 +0100181extern struct dentry *proc_lookup(struct inode *, struct dentry *, unsigned int);
182extern struct dentry *proc_lookup_de(struct proc_dir_entry *, struct inode *,
183 struct dentry *);
Al Virof0c3b502013-05-16 12:07:31 -0400184extern int proc_readdir(struct file *, struct dir_context *);
185extern int proc_readdir_de(struct proc_dir_entry *, struct file *, struct dir_context *);
Al Viro3174c212009-04-07 13:19:18 -0400186
Alexey Dobriyan135d5652009-12-15 16:45:39 -0800187static inline struct proc_dir_entry *pde_get(struct proc_dir_entry *pde)
188{
189 atomic_inc(&pde->count);
190 return pde;
191}
David Howells59d80532013-04-11 13:34:43 +0100192extern void pde_put(struct proc_dir_entry *);
Al Viro3174c212009-04-07 13:19:18 -0400193
Eric W. Biedermaneb6d38d2015-05-11 16:44:25 -0500194static inline bool is_empty_pde(const struct proc_dir_entry *pde)
195{
196 return S_ISDIR(pde->mode) && !pde->proc_iops;
197}
198struct proc_dir_entry *proc_create_mount_point(const char *name);
199
Al Viro3174c212009-04-07 13:19:18 -0400200/*
David Howells59d80532013-04-11 13:34:43 +0100201 * inode.c
Al Viro3174c212009-04-07 13:19:18 -0400202 */
Pavel Emelyanove9720ac2008-03-07 11:08:40 -0800203struct pde_opener {
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700204 struct file *file;
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700205 struct list_head lh;
Al Viro05c0ae22013-04-04 16:28:47 -0400206 int closing;
207 struct completion *c;
Alexey Dobriyan881adb82008-07-25 01:48:29 -0700208};
Al Viro7e0e9532015-02-21 22:16:11 -0500209extern const struct inode_operations proc_link_inode_operations;
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800210
David Howells59d80532013-04-11 13:34:43 +0100211extern const struct inode_operations proc_pid_link_inode_operations;
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800212
David Howells59d80532013-04-11 13:34:43 +0100213extern void proc_init_inodecache(void);
214extern struct inode *proc_get_inode(struct super_block *, struct proc_dir_entry *);
215extern int proc_fill_super(struct super_block *);
216extern void proc_entry_rundown(struct proc_dir_entry *);
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800217
Al Viro3174c212009-04-07 13:19:18 -0400218/*
David Howells59d80532013-04-11 13:34:43 +0100219 * proc_namespaces.c
220 */
Eric W. Biederman6b4e3062010-03-07 16:41:34 -0800221extern const struct inode_operations proc_ns_dir_inode_operations;
222extern const struct file_operations proc_ns_dir_operations;
223
David Howells59d80532013-04-11 13:34:43 +0100224/*
225 * proc_net.c
226 */
227extern const struct file_operations proc_net_operations;
228extern const struct inode_operations proc_net_inode_operations;
229
230#ifdef CONFIG_NET
231extern int proc_net_init(void);
232#else
233static inline int proc_net_init(void) { return 0; }
234#endif
235
236/*
237 * proc_self.c
238 */
239extern int proc_setup_self(struct super_block *);
240
241/*
Eric W. Biederman00978752014-07-31 03:10:50 -0700242 * proc_thread_self.c
243 */
244extern int proc_setup_thread_self(struct super_block *);
245extern void proc_thread_self_init(void);
246
247/*
David Howells59d80532013-04-11 13:34:43 +0100248 * proc_sysctl.c
249 */
250#ifdef CONFIG_PROC_SYSCTL
251extern int proc_sys_init(void);
252extern void sysctl_head_put(struct ctl_table_header *);
253#else
254static inline void proc_sys_init(void) { }
255static inline void sysctl_head_put(struct ctl_table_header *head) { }
256#endif
David Howells34db8aa2013-04-12 02:29:19 +0100257
258/*
259 * proc_tty.c
260 */
261#ifdef CONFIG_TTY
262extern void proc_tty_init(void);
263#else
264static inline void proc_tty_init(void) {}
265#endif
David Howells59d80532013-04-11 13:34:43 +0100266
267/*
268 * root.c
269 */
270extern struct proc_dir_entry proc_root;
271
272extern void proc_self_init(void);
273extern int proc_remount(struct super_block *, int *, char *);
274
275/*
276 * task_[no]mmu.c
277 */
278struct proc_maps_private {
Oleg Nesterov2c033762014-10-09 15:25:51 -0700279 struct inode *inode;
David Howells59d80532013-04-11 13:34:43 +0100280 struct task_struct *task;
Oleg Nesterov29a40ac2014-10-09 15:25:26 -0700281 struct mm_struct *mm;
David Howells59d80532013-04-11 13:34:43 +0100282#ifdef CONFIG_MMU
283 struct vm_area_struct *tail_vma;
284#endif
285#ifdef CONFIG_NUMA
286 struct mempolicy *task_mempolicy;
287#endif
288};
289
Oleg Nesterov5381e162014-10-09 15:25:24 -0700290struct mm_struct *proc_mem_open(struct inode *inode, unsigned int mode);
291
David Howells59d80532013-04-11 13:34:43 +0100292extern const struct file_operations proc_pid_maps_operations;
293extern const struct file_operations proc_tid_maps_operations;
294extern const struct file_operations proc_pid_numa_maps_operations;
295extern const struct file_operations proc_tid_numa_maps_operations;
296extern const struct file_operations proc_pid_smaps_operations;
297extern const struct file_operations proc_tid_smaps_operations;
298extern const struct file_operations proc_clear_refs_operations;
299extern const struct file_operations proc_pagemap_operations;
300
301extern unsigned long task_vsize(struct mm_struct *);
302extern unsigned long task_statm(struct mm_struct *,
303 unsigned long *, unsigned long *,
304 unsigned long *, unsigned long *);
305extern void task_mem(struct seq_file *, struct mm_struct *);