[mirror_ubuntu-bionic-kernel.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__

#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 sh_bang:1,
		     misc_bang:1;
#ifdef __alpha__
	unsigned int taso:1;
#endif
	unsigned int recursion_depth;
	struct file * file;
	int e_uid, e_gid;
	kernel_cap_t cap_post_exec_permitted;
	bool cap_effective;
	void *security;
	int argc, envc;
	char * filename;	/* Name of binary as seen by procps */
	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

/*
 * 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)(long signr, struct pt_regs *regs, struct file *file, unsigned long limit);
	unsigned long min_coredump;	/* minimal dump size */
	int hasvdso;
};

extern int register_binfmt(struct linux_binfmt *);
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 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,char ** argv,struct linux_binprm *bprm);
extern void compute_creds(struct linux_binprm *binprm);
extern int do_coredump(long signr, int exit_code, struct pt_regs * regs);
extern int 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__
	21
71ce92f3 DA	22	#define CORENAME_MAX_SIZE 128
71ce92f3 DA	23
1da177e4 LT	24	/*
	25	* This structure is used to hold the arguments that are used when loading binaries.
	26	*/
	27	struct linux_binprm{
	28	char buf[BINPRM_BUF_SIZE];
b6a2fea3 OW	29	#ifdef CONFIG_MMU
	30	struct vm_area_struct *vma;
	31	#else
	32	# define MAX_ARG_PAGES 32
1da177e4	33	struct page *page[MAX_ARG_PAGES];
b6a2fea3	34	#endif
1da177e4 LT	35	struct mm_struct *mm;
1da177e4 LT	36	unsigned long p; /* current top of mem */
3a2e7f47 PE	37	unsigned int sh_bang:1,
3a2e7f47 PE	38	misc_bang:1;
53112488 KS	39	#ifdef __alpha__
	40	unsigned int taso:1;
	41	#endif
bf2a9a39	42	unsigned int recursion_depth;
1da177e4 LT	43	struct file * file;
1da177e4 LT	44	int e_uid, e_gid;
5459c164	45	kernel_cap_t cap_post_exec_permitted;
b5376771	46	bool cap_effective;
1da177e4 LT	47	void *security;
	48	int argc, envc;
	49	char * filename; /* Name of binary as seen by procps */
	50	char * interp; /* Name of the binary really executed. Most
	51	of the time same as filename, but could be
	52	different for binfmt_{misc,script} */
	53	unsigned interp_flags;
	54	unsigned interp_data;
	55	unsigned long loader, exec;
	56	};
	57
	58	#define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
	59	#define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
	60
	61	/* fd of the binary should be passed to the interpreter */
	62	#define BINPRM_FLAGS_EXECFD_BIT 1
	63	#define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
	64
bf2a9a39	65	#define BINPRM_MAX_RECURSION 4
1da177e4 LT	66
	67	/*
	68	* This structure defines the functions that are used to load the binary formats that
	69	* linux accepts.
	70	*/
	71	struct linux_binfmt {
e4dc1b14	72	struct list_head lh;
1da177e4 LT	73	struct module *module;
	74	int (load_binary)(struct linux_binprm , struct pt_regs * regs);
	75	int (load_shlib)(struct file );
7dc0b22e	76	int (core_dump)(long signr, struct pt_regs regs, struct file *file, unsigned long limit);
1da177e4	77	unsigned long min_coredump; /* minimal dump size */
9fbbd4dd	78	int hasvdso;
1da177e4 LT	79	};
	80
	81	extern int register_binfmt(struct linux_binfmt *);
f6b450d4	82	extern void unregister_binfmt(struct linux_binfmt *);
1da177e4 LT	83
1da177e4 LT	84	extern int prepare_binprm(struct linux_binprm *);
b6a2fea3	85	extern int __must_check remove_arg_zero(struct linux_binprm *);
1da177e4 LT	86	extern int search_binary_handler(struct linux_binprm ,struct pt_regs );
	87	extern int flush_old_exec(struct linux_binprm * bprm);
	88
d6e71144 AC	89	extern int suid_dumpable;
	90	#define SUID_DUMP_DISABLE 0 /* No setuid dumping */
	91	#define SUID_DUMP_USER 1 /* Dump as user of process */
	92	#define SUID_DUMP_ROOT 2 /* Dump as root */
	93
1da177e4 LT	94	/* Stack area protections */
	95	#define EXSTACK_DEFAULT 0 /* Whatever the arch defaults to */
	96	#define EXSTACK_DISABLE_X 1 /* Disable executable stacks */
	97	#define EXSTACK_ENABLE_X 2 /* Enable executable stacks */
	98
	99	extern int setup_arg_pages(struct linux_binprm * bprm,
	100	unsigned long stack_top,
	101	int executable_stack);
b6a2fea3	102	extern int bprm_mm_init(struct linux_binprm *bprm);
1da177e4 LT	103	extern int copy_strings_kernel(int argc,char ** argv,struct linux_binprm *bprm);
	104	extern void compute_creds(struct linux_binprm *binprm);
	105	extern int do_coredump(long signr, int exit_code, struct pt_regs * regs);
	106	extern int set_binfmt(struct linux_binfmt *new);
08a6fac1	107	extern void free_bprm(struct linux_binprm *);
1da177e4 LT	108
	109	#endif /* __KERNEL__ */
	110	#endif /* _LINUX_BINFMTS_H */