[net-next-2.6.git] / include / linux / binfmts.h

#ifndef _LINUX_BINFMTS_H
#define _LINUX_BINFMTS_H

#include <linux/capability.h>

struct pt_regs;

/*
 * These are the maximum length and maximum number of strings passed to the
 * execve() system call.  MAX_ARG_STRLEN is essentially random but serves to
 * prevent the kernel from being unduly impacted by misaddressed pointers.
 * MAX_ARG_STRINGS is chosen to fit in a signed 32-bit integer.
 */
#define MAX_ARG_STRLEN (PAGE_SIZE * 32)
#define MAX_ARG_STRINGS 0x7FFFFFFF

/* sizeof(linux_binprm->buf) */
#define BINPRM_BUF_SIZE 128

#ifdef __KERNEL__
#include <linux/list.h>

#define CORENAME_MAX_SIZE 128

/*
 * This structure is used to hold the arguments that are used when loading binaries.
 */
struct linux_binprm{
	char buf[BINPRM_BUF_SIZE];
#ifdef CONFIG_MMU
	struct vm_area_struct *vma;
#else
# define MAX_ARG_PAGES	32
	struct page *page[MAX_ARG_PAGES];
#endif
	struct mm_struct *mm;
	unsigned long p; /* current top of mem */
	unsigned int
		cred_prepared:1,/* true if creds already prepared (multiple
				 * preps happen for interpreters) */
		cap_effective:1;/* true if has elevated effective capabilities,
				 * false if not; except for init which inherits
				 * its parent's caps anyway */
#ifdef __alpha__
	unsigned int taso:1;
#endif
	unsigned int recursion_depth;
	struct file * file;
	struct cred *cred;	/* new credentials */
	int unsafe;		/* how unsafe this exec is (mask of LSM_UNSAFE_*) */
	unsigned int per_clear;	/* bits to clear in current->personality */
	int argc, envc;
	const char * filename;	/* Name of binary as seen by procps */
	const char * interp;	/* Name of the binary really executed. Most
				   of the time same as filename, but could be
				   different for binfmt_{misc,script} */
	unsigned interp_flags;
	unsigned interp_data;
	unsigned long loader, exec;
};

#define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
#define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)

/* fd of the binary should be passed to the interpreter */
#define BINPRM_FLAGS_EXECFD_BIT 1
#define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)

#define BINPRM_MAX_RECURSION 4

/* Function parameter for binfmt->coredump */
struct coredump_params {
	long signr;
	struct pt_regs *regs;
	struct file *file;
	unsigned long limit;
	unsigned long mm_flags;
};

/*
 * This structure defines the functions that are used to load the binary formats that
 * linux accepts.
 */
struct linux_binfmt {
	struct list_head lh;
	struct module *module;
	int (*load_binary)(struct linux_binprm *, struct  pt_regs * regs);
	int (*load_shlib)(struct file *);
	int (*core_dump)(struct coredump_params *cprm);
	unsigned long min_coredump;	/* minimal dump size */
	int hasvdso;
};

extern int __register_binfmt(struct linux_binfmt *fmt, int insert);

/* Registration of default binfmt handlers */
static inline int register_binfmt(struct linux_binfmt *fmt)
{
	return __register_binfmt(fmt, 0);
}
/* Same as above, but adds a new binfmt at the top of the list */
static inline int insert_binfmt(struct linux_binfmt *fmt)
{
	return __register_binfmt(fmt, 1);
}

extern void unregister_binfmt(struct linux_binfmt *);

extern int prepare_binprm(struct linux_binprm *);
extern int __must_check remove_arg_zero(struct linux_binprm *);
extern int search_binary_handler(struct linux_binprm *,struct pt_regs *);
extern int flush_old_exec(struct linux_binprm * bprm);
extern void setup_new_exec(struct linux_binprm * bprm);

extern int suid_dumpable;
#define SUID_DUMP_DISABLE	0	/* No setuid dumping */
#define SUID_DUMP_USER		1	/* Dump as user of process */
#define SUID_DUMP_ROOT		2	/* Dump as root */

/* Stack area protections */
#define EXSTACK_DEFAULT   0	/* Whatever the arch defaults to */
#define EXSTACK_DISABLE_X 1	/* Disable executable stacks */
#define EXSTACK_ENABLE_X  2	/* Enable executable stacks */

extern int setup_arg_pages(struct linux_binprm * bprm,
			   unsigned long stack_top,
			   int executable_stack);
extern int bprm_mm_init(struct linux_binprm *bprm);
extern int copy_strings_kernel(int argc, const char *const *argv,
			       struct linux_binprm *bprm);
extern int prepare_bprm_creds(struct linux_binprm *bprm);
extern void install_exec_creds(struct linux_binprm *bprm);
extern void do_coredump(long signr, int exit_code, struct pt_regs *regs);
extern void set_binfmt(struct linux_binfmt *new);
extern void free_bprm(struct linux_binprm *);

#endif /* __KERNEL__ */
#endif /* _LINUX_BINFMTS_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_BINFMTS_H
	2	#define _LINUX_BINFMTS_H
	3
	4	#include <linux/capability.h>
	5
	6	struct pt_regs;
	7
	8	/*
b6a2fea3 OW	9	* These are the maximum length and maximum number of strings passed to the
	10	* execve() system call. MAX_ARG_STRLEN is essentially random but serves to
	11	* prevent the kernel from being unduly impacted by misaddressed pointers.
	12	* MAX_ARG_STRINGS is chosen to fit in a signed 32-bit integer.
1da177e4	13	*/
b6a2fea3 OW	14	#define MAX_ARG_STRLEN (PAGE_SIZE * 32)
b6a2fea3 OW	15	#define MAX_ARG_STRINGS 0x7FFFFFFF
1da177e4 LT	16
	17	/* sizeof(linux_binprm->buf) */
	18	#define BINPRM_BUF_SIZE 128
	19
	20	#ifdef __KERNEL__
5cf0cc4e	21	#include <linux/list.h>
1da177e4	22
71ce92f3 DA	23	#define CORENAME_MAX_SIZE 128
71ce92f3 DA	24
1da177e4 LT	25	/*
	26	* This structure is used to hold the arguments that are used when loading binaries.
	27	*/
	28	struct linux_binprm{
	29	char buf[BINPRM_BUF_SIZE];
b6a2fea3 OW	30	#ifdef CONFIG_MMU
	31	struct vm_area_struct *vma;
	32	#else
	33	# define MAX_ARG_PAGES 32
1da177e4	34	struct page *page[MAX_ARG_PAGES];
b6a2fea3	35	#endif
1da177e4 LT	36	struct mm_struct *mm;
1da177e4 LT	37	unsigned long p; /* current top of mem */
a50b0aa4	38	unsigned int
a6f76f23 DH	39	cred_prepared:1,/* true if creds already prepared (multiple
	40	* preps happen for interpreters) */
	41	cap_effective:1;/* true if has elevated effective capabilities,
	42	* false if not; except for init which inherits
	43	* its parent's caps anyway */
53112488 KS	44	#ifdef __alpha__
	45	unsigned int taso:1;
	46	#endif
bf2a9a39	47	unsigned int recursion_depth;
1da177e4	48	struct file * file;
a6f76f23 DH	49	struct cred cred; / new credentials */
	50	int unsafe; /* how unsafe this exec is (mask of LSM_UNSAFE_) /
	51	unsigned int per_clear; /* bits to clear in current->personality */
1da177e4	52	int argc, envc;
d7627467 DH	53	const char * filename; /* Name of binary as seen by procps */
d7627467 DH	54	const char * interp; /* Name of the binary really executed. Most
1da177e4 LT	55	of the time same as filename, but could be
	56	different for binfmt_{misc,script} */
	57	unsigned interp_flags;
	58	unsigned interp_data;
	59	unsigned long loader, exec;
	60	};
	61
	62	#define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
	63	#define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
	64
	65	/* fd of the binary should be passed to the interpreter */
	66	#define BINPRM_FLAGS_EXECFD_BIT 1
	67	#define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
	68
bf2a9a39	69	#define BINPRM_MAX_RECURSION 4
1da177e4	70
f6151dfe MH	71	/* Function parameter for binfmt->coredump */
	72	struct coredump_params {
	73	long signr;
	74	struct pt_regs *regs;
	75	struct file *file;
	76	unsigned long limit;
30736a4d	77	unsigned long mm_flags;
f6151dfe MH	78	};
f6151dfe MH	79
1da177e4 LT	80	/*
	81	* This structure defines the functions that are used to load the binary formats that
	82	* linux accepts.
	83	*/
	84	struct linux_binfmt {
e4dc1b14	85	struct list_head lh;
1da177e4 LT	86	struct module *module;
	87	int (load_binary)(struct linux_binprm , struct pt_regs * regs);
	88	int (load_shlib)(struct file );
f6151dfe	89	int (core_dump)(struct coredump_params cprm);
1da177e4	90	unsigned long min_coredump; /* minimal dump size */
9fbbd4dd	91	int hasvdso;
1da177e4 LT	92	};
1da177e4 LT	93
74641f58 IK	94	extern int __register_binfmt(struct linux_binfmt *fmt, int insert);
	95
	96	/* Registration of default binfmt handlers */
	97	static inline int register_binfmt(struct linux_binfmt *fmt)
	98	{
	99	return __register_binfmt(fmt, 0);
	100	}
	101	/* Same as above, but adds a new binfmt at the top of the list */
	102	static inline int insert_binfmt(struct linux_binfmt *fmt)
	103	{
	104	return __register_binfmt(fmt, 1);
	105	}
	106
f6b450d4	107	extern void unregister_binfmt(struct linux_binfmt *);
1da177e4 LT	108
1da177e4 LT	109	extern int prepare_binprm(struct linux_binprm *);
b6a2fea3	110	extern int __must_check remove_arg_zero(struct linux_binprm *);
1da177e4 LT	111	extern int search_binary_handler(struct linux_binprm ,struct pt_regs );
1da177e4 LT	112	extern int flush_old_exec(struct linux_binprm * bprm);
221af7f8	113	extern void setup_new_exec(struct linux_binprm * bprm);
1da177e4	114
d6e71144 AC	115	extern int suid_dumpable;
	116	#define SUID_DUMP_DISABLE 0 /* No setuid dumping */
	117	#define SUID_DUMP_USER 1 /* Dump as user of process */
	118	#define SUID_DUMP_ROOT 2 /* Dump as root */
	119
1da177e4 LT	120	/* Stack area protections */
	121	#define EXSTACK_DEFAULT 0 /* Whatever the arch defaults to */
	122	#define EXSTACK_DISABLE_X 1 /* Disable executable stacks */
	123	#define EXSTACK_ENABLE_X 2 /* Enable executable stacks */
	124
	125	extern int setup_arg_pages(struct linux_binprm * bprm,
	126	unsigned long stack_top,
	127	int executable_stack);
b6a2fea3	128	extern int bprm_mm_init(struct linux_binprm *bprm);
d7627467 DH	129	extern int copy_strings_kernel(int argc, const char const argv,
d7627467 DH	130	struct linux_binprm *bprm);
a2a8474c	131	extern int prepare_bprm_creds(struct linux_binprm *bprm);
a6f76f23	132	extern void install_exec_creds(struct linux_binprm *bprm);
8cd3ac3a	133	extern void do_coredump(long signr, int exit_code, struct pt_regs *regs);
964ee7df	134	extern void set_binfmt(struct linux_binfmt *new);
08a6fac1	135	extern void free_bprm(struct linux_binprm *);
1da177e4 LT	136
	137	#endif /* __KERNEL__ */
	138	#endif /* _LINUX_BINFMTS_H */