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