2005-04-16 16:20:36 -06:00
|
|
|
#ifndef _LINUX_PROC_FS_H
|
|
|
|
#define _LINUX_PROC_FS_H
|
|
|
|
|
|
|
|
#include <linux/slab.h>
|
|
|
|
#include <linux/fs.h>
|
2006-03-26 02:36:55 -07:00
|
|
|
#include <linux/spinlock.h>
|
2006-09-24 09:13:19 -06:00
|
|
|
#include <linux/magic.h>
|
2005-04-16 16:20:36 -06:00
|
|
|
#include <asm/atomic.h>
|
|
|
|
|
2007-09-12 04:01:34 -06:00
|
|
|
struct net;
|
Fix rmmod/read/write races in /proc entries
Fix following races:
===========================================
1. Write via ->write_proc sleeps in copy_from_user(). Module disappears
meanwhile. Or, more generically, system call done on /proc file, method
supplied by module is called, module dissapeares meanwhile.
pde = create_proc_entry()
if (!pde)
return -ENOMEM;
pde->write_proc = ...
open
write
copy_from_user
pde = create_proc_entry();
if (!pde) {
remove_proc_entry();
return -ENOMEM;
/* module unloaded */
}
*boom*
==========================================
2. bogo-revoke aka proc_kill_inodes()
remove_proc_entry vfs_read
proc_kill_inodes [check ->f_op validness]
[check ->f_op->read validness]
[verify_area, security permissions checks]
->f_op = NULL;
if (file->f_op->read)
/* ->f_op dereference, boom */
NOTE, NOTE, NOTE: file_operations are proxied for regular files only. Let's
see how this scheme behaves, then extend if needed for directories.
Directories creators in /proc only set ->owner for them, so proxying for
directories may be unneeded.
NOTE, NOTE, NOTE: methods being proxied are ->llseek, ->read, ->write,
->poll, ->unlocked_ioctl, ->ioctl, ->compat_ioctl, ->open, ->release.
If your in-tree module uses something else, yell on me. Full audit pending.
[akpm@linux-foundation.org: build fix]
Signed-off-by: Alexey Dobriyan <adobriyan@sw.ru>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-07-16 00:39:00 -06:00
|
|
|
struct completion;
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/*
|
|
|
|
* The proc filesystem constants/structures
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Offset of the first process in the /proc root directory..
|
|
|
|
*/
|
|
|
|
#define FIRST_PROCESS_ENTRY 256
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* We always define these enumerators
|
|
|
|
*/
|
|
|
|
|
|
|
|
enum {
|
|
|
|
PROC_ROOT_INO = 1,
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This is not completely implemented yet. The idea is to
|
|
|
|
* create an in-memory tree (like the actual /proc filesystem
|
|
|
|
* tree) of these proc_dir_entries, so that we can dynamically
|
|
|
|
* add new files to /proc.
|
|
|
|
*
|
|
|
|
* The "next" pointer creates a linked list of one /proc directory,
|
|
|
|
* while parent/subdir create the directory structure (every
|
|
|
|
* /proc file has a parent, but "subdir" is NULL for all
|
|
|
|
* non-directory entries).
|
|
|
|
*
|
|
|
|
* "get_info" is called at "read", while "owner" is used to protect module
|
|
|
|
* from unloading while proc_dir_entry is in use
|
|
|
|
*/
|
|
|
|
|
|
|
|
typedef int (read_proc_t)(char *page, char **start, off_t off,
|
|
|
|
int count, int *eof, void *data);
|
|
|
|
typedef int (write_proc_t)(struct file *file, const char __user *buffer,
|
|
|
|
unsigned long count, void *data);
|
|
|
|
typedef int (get_info_t)(char *, char **, off_t, int);
|
2007-12-01 06:33:17 -07:00
|
|
|
typedef struct proc_dir_entry *(shadow_proc_t)(struct task_struct *task,
|
|
|
|
struct proc_dir_entry *pde);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
struct proc_dir_entry {
|
|
|
|
unsigned int low_ino;
|
|
|
|
unsigned short namelen;
|
|
|
|
const char *name;
|
|
|
|
mode_t mode;
|
|
|
|
nlink_t nlink;
|
|
|
|
uid_t uid;
|
|
|
|
gid_t gid;
|
2006-03-26 02:37:29 -07:00
|
|
|
loff_t size;
|
2007-02-12 01:55:40 -07:00
|
|
|
const struct inode_operations *proc_iops;
|
Fix rmmod/read/write races in /proc entries
Fix following races:
===========================================
1. Write via ->write_proc sleeps in copy_from_user(). Module disappears
meanwhile. Or, more generically, system call done on /proc file, method
supplied by module is called, module dissapeares meanwhile.
pde = create_proc_entry()
if (!pde)
return -ENOMEM;
pde->write_proc = ...
open
write
copy_from_user
pde = create_proc_entry();
if (!pde) {
remove_proc_entry();
return -ENOMEM;
/* module unloaded */
}
*boom*
==========================================
2. bogo-revoke aka proc_kill_inodes()
remove_proc_entry vfs_read
proc_kill_inodes [check ->f_op validness]
[check ->f_op->read validness]
[verify_area, security permissions checks]
->f_op = NULL;
if (file->f_op->read)
/* ->f_op dereference, boom */
NOTE, NOTE, NOTE: file_operations are proxied for regular files only. Let's
see how this scheme behaves, then extend if needed for directories.
Directories creators in /proc only set ->owner for them, so proxying for
directories may be unneeded.
NOTE, NOTE, NOTE: methods being proxied are ->llseek, ->read, ->write,
->poll, ->unlocked_ioctl, ->ioctl, ->compat_ioctl, ->open, ->release.
If your in-tree module uses something else, yell on me. Full audit pending.
[akpm@linux-foundation.org: build fix]
Signed-off-by: Alexey Dobriyan <adobriyan@sw.ru>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-07-16 00:39:00 -06:00
|
|
|
/*
|
|
|
|
* NULL ->proc_fops means "PDE is going away RSN" or
|
|
|
|
* "PDE is just created". In either case, e.g. ->read_proc won't be
|
|
|
|
* called because it's too late or too early, respectively.
|
|
|
|
*
|
|
|
|
* If you're allocating ->proc_fops dynamically, save a pointer
|
|
|
|
* somewhere.
|
|
|
|
*/
|
2007-02-12 01:55:40 -07:00
|
|
|
const struct file_operations *proc_fops;
|
2005-04-16 16:20:36 -06:00
|
|
|
get_info_t *get_info;
|
|
|
|
struct module *owner;
|
|
|
|
struct proc_dir_entry *next, *parent, *subdir;
|
|
|
|
void *data;
|
|
|
|
read_proc_t *read_proc;
|
|
|
|
write_proc_t *write_proc;
|
|
|
|
atomic_t count; /* use count */
|
Fix rmmod/read/write races in /proc entries
Fix following races:
===========================================
1. Write via ->write_proc sleeps in copy_from_user(). Module disappears
meanwhile. Or, more generically, system call done on /proc file, method
supplied by module is called, module dissapeares meanwhile.
pde = create_proc_entry()
if (!pde)
return -ENOMEM;
pde->write_proc = ...
open
write
copy_from_user
pde = create_proc_entry();
if (!pde) {
remove_proc_entry();
return -ENOMEM;
/* module unloaded */
}
*boom*
==========================================
2. bogo-revoke aka proc_kill_inodes()
remove_proc_entry vfs_read
proc_kill_inodes [check ->f_op validness]
[check ->f_op->read validness]
[verify_area, security permissions checks]
->f_op = NULL;
if (file->f_op->read)
/* ->f_op dereference, boom */
NOTE, NOTE, NOTE: file_operations are proxied for regular files only. Let's
see how this scheme behaves, then extend if needed for directories.
Directories creators in /proc only set ->owner for them, so proxying for
directories may be unneeded.
NOTE, NOTE, NOTE: methods being proxied are ->llseek, ->read, ->write,
->poll, ->unlocked_ioctl, ->ioctl, ->compat_ioctl, ->open, ->release.
If your in-tree module uses something else, yell on me. Full audit pending.
[akpm@linux-foundation.org: build fix]
Signed-off-by: Alexey Dobriyan <adobriyan@sw.ru>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-07-16 00:39:00 -06:00
|
|
|
int pde_users; /* number of callers into module in progress */
|
|
|
|
spinlock_t pde_unload_lock; /* proc_fops checks and pde_users bumps */
|
|
|
|
struct completion *pde_unload_completion;
|
2007-12-01 06:33:17 -07:00
|
|
|
shadow_proc_t *shadow_proc;
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
struct kcore_list {
|
|
|
|
struct kcore_list *next;
|
|
|
|
unsigned long addr;
|
|
|
|
size_t size;
|
|
|
|
};
|
|
|
|
|
2005-06-25 15:58:21 -06:00
|
|
|
struct vmcore {
|
|
|
|
struct list_head list;
|
|
|
|
unsigned long long paddr;
|
2006-04-10 23:54:10 -06:00
|
|
|
unsigned long long size;
|
2005-06-25 15:58:21 -06:00
|
|
|
loff_t offset;
|
|
|
|
};
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
#ifdef CONFIG_PROC_FS
|
|
|
|
|
|
|
|
extern struct proc_dir_entry proc_root;
|
|
|
|
extern struct proc_dir_entry *proc_root_fs;
|
|
|
|
extern struct proc_dir_entry *proc_bus;
|
|
|
|
extern struct proc_dir_entry *proc_root_driver;
|
|
|
|
extern struct proc_dir_entry *proc_root_kcore;
|
|
|
|
|
2006-03-26 02:36:55 -07:00
|
|
|
extern spinlock_t proc_subdir_lock;
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
extern void proc_root_init(void);
|
|
|
|
extern void proc_misc_init(void);
|
|
|
|
|
|
|
|
struct mm_struct;
|
|
|
|
|
2006-06-26 01:25:48 -06:00
|
|
|
void proc_flush_task(struct task_struct *task);
|
2005-04-16 16:20:36 -06:00
|
|
|
struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry, struct nameidata *);
|
|
|
|
int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
|
|
|
|
unsigned long task_vsize(struct mm_struct *);
|
|
|
|
int task_statm(struct mm_struct *, int *, int *, int *, int *);
|
|
|
|
char *task_mem(struct mm_struct *, char *);
|
2007-05-06 15:49:24 -06:00
|
|
|
void clear_refs_smap(struct mm_struct *mm);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-05-08 01:25:45 -06:00
|
|
|
struct proc_dir_entry *de_get(struct proc_dir_entry *de);
|
|
|
|
void de_put(struct proc_dir_entry *de);
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
|
|
|
|
struct proc_dir_entry *parent);
|
|
|
|
extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
|
|
|
|
|
|
|
|
extern struct vfsmount *proc_mnt;
|
2007-10-19 00:40:08 -06:00
|
|
|
struct pid_namespace;
|
|
|
|
extern int proc_fill_super(struct super_block *);
|
2005-04-16 16:20:36 -06:00
|
|
|
extern struct inode *proc_get_inode(struct super_block *, unsigned int, struct proc_dir_entry *);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* These are generic /proc routines that use the internal
|
|
|
|
* "struct proc_dir_entry" tree to traverse the filesystem.
|
|
|
|
*
|
|
|
|
* The /proc root directory has extended versions to take care
|
|
|
|
* of the /proc/<pid> subdirectories.
|
|
|
|
*/
|
|
|
|
extern int proc_readdir(struct file *, void *, filldir_t);
|
|
|
|
extern struct dentry *proc_lookup(struct inode *, struct dentry *, struct nameidata *);
|
|
|
|
|
2006-03-28 02:56:42 -07:00
|
|
|
extern const struct file_operations proc_kcore_operations;
|
|
|
|
extern const struct file_operations proc_kmsg_operations;
|
|
|
|
extern const struct file_operations ppc_htab_operations;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-10-19 00:40:11 -06:00
|
|
|
extern int pid_ns_prepare_proc(struct pid_namespace *ns);
|
|
|
|
extern void pid_ns_release_proc(struct pid_namespace *ns);
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/*
|
|
|
|
* proc_tty.c
|
|
|
|
*/
|
|
|
|
struct tty_driver;
|
|
|
|
extern void proc_tty_init(void);
|
|
|
|
extern void proc_tty_register_driver(struct tty_driver *driver);
|
|
|
|
extern void proc_tty_unregister_driver(struct tty_driver *driver);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* proc_devtree.c
|
|
|
|
*/
|
2005-11-06 20:29:02 -07:00
|
|
|
#ifdef CONFIG_PROC_DEVICETREE
|
2005-04-16 16:20:36 -06:00
|
|
|
struct device_node;
|
2005-11-06 20:29:02 -07:00
|
|
|
struct property;
|
2005-04-16 16:20:36 -06:00
|
|
|
extern void proc_device_tree_init(void);
|
|
|
|
extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
|
2005-11-06 20:29:02 -07:00
|
|
|
extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
|
2006-01-12 15:07:17 -07:00
|
|
|
extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
|
|
|
|
struct property *prop);
|
|
|
|
extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
|
|
|
|
struct property *newprop,
|
|
|
|
struct property *oldprop);
|
2005-04-16 16:20:36 -06:00
|
|
|
#endif /* CONFIG_PROC_DEVICETREE */
|
|
|
|
|
|
|
|
extern struct proc_dir_entry *proc_symlink(const char *,
|
|
|
|
struct proc_dir_entry *, const char *);
|
|
|
|
extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
|
|
|
|
extern struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
|
|
|
|
struct proc_dir_entry *parent);
|
|
|
|
|
|
|
|
static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
|
|
|
|
mode_t mode, struct proc_dir_entry *base,
|
|
|
|
read_proc_t *read_proc, void * data)
|
|
|
|
{
|
|
|
|
struct proc_dir_entry *res=create_proc_entry(name,mode,base);
|
|
|
|
if (res) {
|
|
|
|
res->read_proc=read_proc;
|
|
|
|
res->data=data;
|
|
|
|
}
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
|
|
|
|
mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
|
|
|
|
{
|
|
|
|
struct proc_dir_entry *res=create_proc_entry(name,mode,base);
|
|
|
|
if (res) res->get_info=get_info;
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2007-09-12 04:01:34 -06:00
|
|
|
extern struct proc_dir_entry *proc_net_fops_create(struct net *net,
|
|
|
|
const char *name, mode_t mode, const struct file_operations *fops);
|
|
|
|
extern void proc_net_remove(struct net *net, const char *name);
|
2008-01-10 04:51:41 -07:00
|
|
|
extern struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
|
|
|
|
struct proc_dir_entry *parent);
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
#else
|
|
|
|
|
|
|
|
#define proc_root_driver NULL
|
|
|
|
#define proc_bus NULL
|
|
|
|
|
2007-09-12 04:01:34 -06:00
|
|
|
#define proc_net_fops_create(net, name, mode, fops) ({ (void)(mode), NULL; })
|
|
|
|
static inline void proc_net_remove(struct net *net, const char *name) {}
|
2005-04-16 16:20:36 -06:00
|
|
|
|
2007-10-19 00:40:03 -06:00
|
|
|
static inline void proc_flush_task(struct task_struct *task)
|
|
|
|
{
|
|
|
|
}
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
static inline struct proc_dir_entry *create_proc_entry(const char *name,
|
|
|
|
mode_t mode, struct proc_dir_entry *parent) { return NULL; }
|
|
|
|
|
|
|
|
#define remove_proc_entry(name, parent) do {} while (0)
|
|
|
|
|
|
|
|
static inline struct proc_dir_entry *proc_symlink(const char *name,
|
|
|
|
struct proc_dir_entry *parent,const char *dest) {return NULL;}
|
|
|
|
static inline struct proc_dir_entry *proc_mkdir(const char *name,
|
|
|
|
struct proc_dir_entry *parent) {return NULL;}
|
|
|
|
|
|
|
|
static inline struct proc_dir_entry *create_proc_read_entry(const char *name,
|
|
|
|
mode_t mode, struct proc_dir_entry *base,
|
|
|
|
read_proc_t *read_proc, void * data) { return NULL; }
|
|
|
|
static inline struct proc_dir_entry *create_proc_info_entry(const char *name,
|
|
|
|
mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
|
|
|
|
{ return NULL; }
|
|
|
|
|
|
|
|
struct tty_driver;
|
|
|
|
static inline void proc_tty_register_driver(struct tty_driver *driver) {};
|
|
|
|
static inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
|
|
|
|
|
|
|
|
extern struct proc_dir_entry proc_root;
|
|
|
|
|
2007-10-19 00:40:11 -06:00
|
|
|
static inline int pid_ns_prepare_proc(struct pid_namespace *ns)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void pid_ns_release_proc(struct pid_namespace *ns)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
#endif /* CONFIG_PROC_FS */
|
|
|
|
|
|
|
|
#if !defined(CONFIG_PROC_KCORE)
|
|
|
|
static inline void kclist_add(struct kcore_list *new, void *addr, size_t size)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
extern void kclist_add(struct kcore_list *, void *, size_t);
|
|
|
|
#endif
|
|
|
|
|
2006-10-02 03:17:07 -06:00
|
|
|
union proc_op {
|
|
|
|
int (*proc_get_link)(struct inode *, struct dentry **, struct vfsmount **);
|
|
|
|
int (*proc_read)(struct task_struct *task, char *page);
|
|
|
|
};
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
struct proc_inode {
|
2006-06-26 01:25:56 -06:00
|
|
|
struct pid *pid;
|
2006-06-26 01:25:44 -06:00
|
|
|
int fd;
|
2006-10-02 03:17:07 -06:00
|
|
|
union proc_op op;
|
2005-04-16 16:20:36 -06:00
|
|
|
struct proc_dir_entry *pde;
|
|
|
|
struct inode vfs_inode;
|
|
|
|
};
|
|
|
|
|
|
|
|
static inline struct proc_inode *PROC_I(const struct inode *inode)
|
|
|
|
{
|
|
|
|
return container_of(inode, struct proc_inode, vfs_inode);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct proc_dir_entry *PDE(const struct inode *inode)
|
|
|
|
{
|
|
|
|
return PROC_I(inode)->pde;
|
|
|
|
}
|
|
|
|
|
2007-09-12 04:01:34 -06:00
|
|
|
static inline struct net *PDE_NET(struct proc_dir_entry *pde)
|
|
|
|
{
|
|
|
|
return pde->parent->data;
|
|
|
|
}
|
|
|
|
|
2007-09-13 01:18:57 -06:00
|
|
|
struct net *get_proc_net(const struct inode *inode);
|
2007-09-12 04:01:34 -06:00
|
|
|
|
2006-06-26 01:25:55 -06:00
|
|
|
struct proc_maps_private {
|
2006-06-26 01:25:56 -06:00
|
|
|
struct pid *pid;
|
2006-06-26 01:25:55 -06:00
|
|
|
struct task_struct *task;
|
2006-09-27 02:50:19 -06:00
|
|
|
#ifdef CONFIG_MMU
|
2006-06-26 01:25:55 -06:00
|
|
|
struct vm_area_struct *tail_vma;
|
2006-09-27 02:50:19 -06:00
|
|
|
#endif
|
2006-06-26 01:25:55 -06:00
|
|
|
};
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
#endif /* _LINUX_PROC_FS_H */
|