~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/proc_fs.h

Version: ~ [ linux-5.9.1 ] ~ [ linux-5.8.16 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.72 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.152 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.202 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.240 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.240 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /* SPDX-License-Identifier: GPL-2.0 */
  2 /*
  3  * The proc filesystem constants/structures
  4  */
  5 #ifndef _LINUX_PROC_FS_H
  6 #define _LINUX_PROC_FS_H
  7 
  8 #include <linux/compiler.h>
  9 #include <linux/types.h>
 10 #include <linux/fs.h>
 11 
 12 struct proc_dir_entry;
 13 struct seq_file;
 14 struct seq_operations;
 15 
 16 enum {
 17         /*
 18          * All /proc entries using this ->proc_ops instance are never removed.
 19          *
 20          * If in doubt, ignore this flag.
 21          */
 22 #ifdef MODULE
 23         PROC_ENTRY_PERMANENT = 0U,
 24 #else
 25         PROC_ENTRY_PERMANENT = 1U << 0,
 26 #endif
 27 };
 28 
 29 struct proc_ops {
 30         unsigned int proc_flags;
 31         int     (*proc_open)(struct inode *, struct file *);
 32         ssize_t (*proc_read)(struct file *, char __user *, size_t, loff_t *);
 33         ssize_t (*proc_write)(struct file *, const char __user *, size_t, loff_t *);
 34         loff_t  (*proc_lseek)(struct file *, loff_t, int);
 35         int     (*proc_release)(struct inode *, struct file *);
 36         __poll_t (*proc_poll)(struct file *, struct poll_table_struct *);
 37         long    (*proc_ioctl)(struct file *, unsigned int, unsigned long);
 38 #ifdef CONFIG_COMPAT
 39         long    (*proc_compat_ioctl)(struct file *, unsigned int, unsigned long);
 40 #endif
 41         int     (*proc_mmap)(struct file *, struct vm_area_struct *);
 42         unsigned long (*proc_get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
 43 } __randomize_layout;
 44 
 45 /* definitions for hide_pid field */
 46 enum proc_hidepid {
 47         HIDEPID_OFF       = 0,
 48         HIDEPID_NO_ACCESS = 1,
 49         HIDEPID_INVISIBLE = 2,
 50         HIDEPID_NOT_PTRACEABLE = 4, /* Limit pids to only ptraceable pids */
 51 };
 52 
 53 /* definitions for proc mount option pidonly */
 54 enum proc_pidonly {
 55         PROC_PIDONLY_OFF = 0,
 56         PROC_PIDONLY_ON  = 1,
 57 };
 58 
 59 struct proc_fs_info {
 60         struct pid_namespace *pid_ns;
 61         struct dentry *proc_self;        /* For /proc/self */
 62         struct dentry *proc_thread_self; /* For /proc/thread-self */
 63         kgid_t pid_gid;
 64         enum proc_hidepid hide_pid;
 65         enum proc_pidonly pidonly;
 66 };
 67 
 68 static inline struct proc_fs_info *proc_sb_info(struct super_block *sb)
 69 {
 70         return sb->s_fs_info;
 71 }
 72 
 73 #ifdef CONFIG_PROC_FS
 74 
 75 typedef int (*proc_write_t)(struct file *, char *, size_t);
 76 
 77 extern void proc_root_init(void);
 78 extern void proc_flush_pid(struct pid *);
 79 
 80 extern struct proc_dir_entry *proc_symlink(const char *,
 81                 struct proc_dir_entry *, const char *);
 82 extern struct proc_dir_entry *proc_mkdir(const char *, struct proc_dir_entry *);
 83 extern struct proc_dir_entry *proc_mkdir_data(const char *, umode_t,
 84                                               struct proc_dir_entry *, void *);
 85 extern struct proc_dir_entry *proc_mkdir_mode(const char *, umode_t,
 86                                               struct proc_dir_entry *);
 87 struct proc_dir_entry *proc_create_mount_point(const char *name);
 88 
 89 struct proc_dir_entry *proc_create_seq_private(const char *name, umode_t mode,
 90                 struct proc_dir_entry *parent, const struct seq_operations *ops,
 91                 unsigned int state_size, void *data);
 92 #define proc_create_seq_data(name, mode, parent, ops, data) \
 93         proc_create_seq_private(name, mode, parent, ops, 0, data)
 94 #define proc_create_seq(name, mode, parent, ops) \
 95         proc_create_seq_private(name, mode, parent, ops, 0, NULL)
 96 struct proc_dir_entry *proc_create_single_data(const char *name, umode_t mode,
 97                 struct proc_dir_entry *parent,
 98                 int (*show)(struct seq_file *, void *), void *data);
 99 #define proc_create_single(name, mode, parent, show) \
100         proc_create_single_data(name, mode, parent, show, NULL)
101  
102 extern struct proc_dir_entry *proc_create_data(const char *, umode_t,
103                                                struct proc_dir_entry *,
104                                                const struct proc_ops *,
105                                                void *);
106 
107 struct proc_dir_entry *proc_create(const char *name, umode_t mode, struct proc_dir_entry *parent, const struct proc_ops *proc_ops);
108 extern void proc_set_size(struct proc_dir_entry *, loff_t);
109 extern void proc_set_user(struct proc_dir_entry *, kuid_t, kgid_t);
110 extern void *PDE_DATA(const struct inode *);
111 extern void *proc_get_parent_data(const struct inode *);
112 extern void proc_remove(struct proc_dir_entry *);
113 extern void remove_proc_entry(const char *, struct proc_dir_entry *);
114 extern int remove_proc_subtree(const char *, struct proc_dir_entry *);
115 
116 struct proc_dir_entry *proc_create_net_data(const char *name, umode_t mode,
117                 struct proc_dir_entry *parent, const struct seq_operations *ops,
118                 unsigned int state_size, void *data);
119 #define proc_create_net(name, mode, parent, ops, state_size) \
120         proc_create_net_data(name, mode, parent, ops, state_size, NULL)
121 struct proc_dir_entry *proc_create_net_single(const char *name, umode_t mode,
122                 struct proc_dir_entry *parent,
123                 int (*show)(struct seq_file *, void *), void *data);
124 struct proc_dir_entry *proc_create_net_data_write(const char *name, umode_t mode,
125                                                   struct proc_dir_entry *parent,
126                                                   const struct seq_operations *ops,
127                                                   proc_write_t write,
128                                                   unsigned int state_size, void *data);
129 struct proc_dir_entry *proc_create_net_single_write(const char *name, umode_t mode,
130                                                     struct proc_dir_entry *parent,
131                                                     int (*show)(struct seq_file *, void *),
132                                                     proc_write_t write,
133                                                     void *data);
134 extern struct pid *tgid_pidfd_to_pid(const struct file *file);
135 
136 struct bpf_iter_aux_info;
137 extern int bpf_iter_init_seq_net(void *priv_data, struct bpf_iter_aux_info *aux);
138 extern void bpf_iter_fini_seq_net(void *priv_data);
139 
140 #ifdef CONFIG_PROC_PID_ARCH_STATUS
141 /*
142  * The architecture which selects CONFIG_PROC_PID_ARCH_STATUS must
143  * provide proc_pid_arch_status() definition.
144  */
145 int proc_pid_arch_status(struct seq_file *m, struct pid_namespace *ns,
146                         struct pid *pid, struct task_struct *task);
147 #endif /* CONFIG_PROC_PID_ARCH_STATUS */
148 
149 #else /* CONFIG_PROC_FS */
150 
151 static inline void proc_root_init(void)
152 {
153 }
154 
155 static inline void proc_flush_pid(struct pid *pid)
156 {
157 }
158 
159 static inline struct proc_dir_entry *proc_symlink(const char *name,
160                 struct proc_dir_entry *parent,const char *dest) { return NULL;}
161 static inline struct proc_dir_entry *proc_mkdir(const char *name,
162         struct proc_dir_entry *parent) {return NULL;}
163 static inline struct proc_dir_entry *proc_create_mount_point(const char *name) { return NULL; }
164 static inline struct proc_dir_entry *proc_mkdir_data(const char *name,
165         umode_t mode, struct proc_dir_entry *parent, void *data) { return NULL; }
166 static inline struct proc_dir_entry *proc_mkdir_mode(const char *name,
167         umode_t mode, struct proc_dir_entry *parent) { return NULL; }
168 #define proc_create_seq_private(name, mode, parent, ops, size, data) ({NULL;})
169 #define proc_create_seq_data(name, mode, parent, ops, data) ({NULL;})
170 #define proc_create_seq(name, mode, parent, ops) ({NULL;})
171 #define proc_create_single(name, mode, parent, show) ({NULL;})
172 #define proc_create_single_data(name, mode, parent, show, data) ({NULL;})
173 #define proc_create(name, mode, parent, proc_ops) ({NULL;})
174 #define proc_create_data(name, mode, parent, proc_ops, data) ({NULL;})
175 
176 static inline void proc_set_size(struct proc_dir_entry *de, loff_t size) {}
177 static inline void proc_set_user(struct proc_dir_entry *de, kuid_t uid, kgid_t gid) {}
178 static inline void *PDE_DATA(const struct inode *inode) {BUG(); return NULL;}
179 static inline void *proc_get_parent_data(const struct inode *inode) { BUG(); return NULL; }
180 
181 static inline void proc_remove(struct proc_dir_entry *de) {}
182 #define remove_proc_entry(name, parent) do {} while (0)
183 static inline int remove_proc_subtree(const char *name, struct proc_dir_entry *parent) { return 0; }
184 
185 #define proc_create_net_data(name, mode, parent, ops, state_size, data) ({NULL;})
186 #define proc_create_net(name, mode, parent, state_size, ops) ({NULL;})
187 #define proc_create_net_single(name, mode, parent, show, data) ({NULL;})
188 
189 static inline struct pid *tgid_pidfd_to_pid(const struct file *file)
190 {
191         return ERR_PTR(-EBADF);
192 }
193 
194 #endif /* CONFIG_PROC_FS */
195 
196 struct net;
197 
198 static inline struct proc_dir_entry *proc_net_mkdir(
199         struct net *net, const char *name, struct proc_dir_entry *parent)
200 {
201         return proc_mkdir_data(name, 0, parent, net);
202 }
203 
204 struct ns_common;
205 int open_related_ns(struct ns_common *ns,
206                    struct ns_common *(*get_ns)(struct ns_common *ns));
207 
208 /* get the associated pid namespace for a file in procfs */
209 static inline struct pid_namespace *proc_pid_ns(struct super_block *sb)
210 {
211         return proc_sb_info(sb)->pid_ns;
212 }
213 
214 bool proc_ns_file(const struct file *file);
215 
216 #endif /* _LINUX_PROC_FS_H */
217 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp