blob: 89c6249fc561a0eaf38f5d01e850f70d52726dd5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_BINFMTS_H
2#define _LINUX_BINFMTS_H
3
4#include <linux/capability.h>
5
6struct pt_regs;
7
8/*
Ollie Wildb6a2fea2007-07-19 01:48:16 -07009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
Ollie Wildb6a2fea2007-07-19 01:48:16 -070014#define MAX_ARG_STRLEN (PAGE_SIZE * 32)
15#define MAX_ARG_STRINGS 0x7FFFFFFF
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17/* sizeof(linux_binprm->buf) */
18#define BINPRM_BUF_SIZE 128
19
20#ifdef __KERNEL__
Hiroshi Shimamoto5cf0cc42009-01-06 14:41:38 -080021#include <linux/list.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Dan Aloni71ce92f2007-05-16 22:11:16 -070023#define CORENAME_MAX_SIZE 128
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/*
26 * This structure is used to hold the arguments that are used when loading binaries.
27 */
28struct linux_binprm{
29 char buf[BINPRM_BUF_SIZE];
Ollie Wildb6a2fea2007-07-19 01:48:16 -070030#ifdef CONFIG_MMU
31 struct vm_area_struct *vma;
32#else
33# define MAX_ARG_PAGES 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 struct page *page[MAX_ARG_PAGES];
Ollie Wildb6a2fea2007-07-19 01:48:16 -070035#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 struct mm_struct *mm;
37 unsigned long p; /* current top of mem */
Kirill A. Shutemova50b0aa2009-04-02 16:58:29 -070038 unsigned int
David Howellsa6f76f22008-11-14 10:39:24 +110039 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 */
Kirill A. Shutemov53112482008-10-15 22:02:37 -070044#ifdef __alpha__
45 unsigned int taso:1;
46#endif
Kirill A. Shutemovbf2a9a32008-10-15 22:02:39 -070047 unsigned int recursion_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 struct file * file;
David Howellsa6f76f22008-11-14 10:39:24 +110049 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 int argc, envc;
53 char * filename; /* Name of binary as seen by procps */
54 char * interp; /* Name of the binary really executed. Most
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
Kirill A. Shutemovbf2a9a32008-10-15 22:02:39 -070069#define BINPRM_MAX_RECURSION 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080071/* Function parameter for binfmt->coredump */
72struct coredump_params {
73 long signr;
74 struct pt_regs *regs;
75 struct file *file;
76 unsigned long limit;
77};
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079/*
80 * This structure defines the functions that are used to load the binary formats that
81 * linux accepts.
82 */
83struct linux_binfmt {
Alexey Dobriyane4dc1b12007-10-16 23:26:03 -070084 struct list_head lh;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 struct module *module;
86 int (*load_binary)(struct linux_binprm *, struct pt_regs * regs);
87 int (*load_shlib)(struct file *);
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080088 int (*core_dump)(struct coredump_params *cprm);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 unsigned long min_coredump; /* minimal dump size */
Andi Kleen9fbbd4d2007-02-13 13:26:26 +010090 int hasvdso;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091};
92
Ivan Kokshaysky74641f52009-04-30 15:08:49 -070093extern int __register_binfmt(struct linux_binfmt *fmt, int insert);
94
95/* Registration of default binfmt handlers */
96static inline int register_binfmt(struct linux_binfmt *fmt)
97{
98 return __register_binfmt(fmt, 0);
99}
100/* Same as above, but adds a new binfmt at the top of the list */
101static inline int insert_binfmt(struct linux_binfmt *fmt)
102{
103 return __register_binfmt(fmt, 1);
104}
105
Alexey Dobriyanf6b450d2007-10-16 23:26:04 -0700106extern void unregister_binfmt(struct linux_binfmt *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108extern int prepare_binprm(struct linux_binprm *);
Ollie Wildb6a2fea2007-07-19 01:48:16 -0700109extern int __must_check remove_arg_zero(struct linux_binprm *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110extern int search_binary_handler(struct linux_binprm *,struct pt_regs *);
111extern int flush_old_exec(struct linux_binprm * bprm);
Linus Torvalds221af7f2010-01-28 22:14:42 -0800112extern void setup_new_exec(struct linux_binprm * bprm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Alan Coxd6e71142005-06-23 00:09:43 -0700114extern int suid_dumpable;
115#define SUID_DUMP_DISABLE 0 /* No setuid dumping */
116#define SUID_DUMP_USER 1 /* Dump as user of process */
117#define SUID_DUMP_ROOT 2 /* Dump as root */
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119/* Stack area protections */
120#define EXSTACK_DEFAULT 0 /* Whatever the arch defaults to */
121#define EXSTACK_DISABLE_X 1 /* Disable executable stacks */
122#define EXSTACK_ENABLE_X 2 /* Enable executable stacks */
123
124extern int setup_arg_pages(struct linux_binprm * bprm,
125 unsigned long stack_top,
126 int executable_stack);
Ollie Wildb6a2fea2007-07-19 01:48:16 -0700127extern int bprm_mm_init(struct linux_binprm *bprm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128extern int copy_strings_kernel(int argc,char ** argv,struct linux_binprm *bprm);
Oleg Nesterova2a84742009-09-05 11:17:13 -0700129extern int prepare_bprm_creds(struct linux_binprm *bprm);
David Howellsa6f76f22008-11-14 10:39:24 +1100130extern void install_exec_creds(struct linux_binprm *bprm);
WANG Cong8cd3ac32009-01-06 14:42:48 -0800131extern void do_coredump(long signr, int exit_code, struct pt_regs *regs);
Oleg Nesterov964ee7d2009-09-23 15:56:59 -0700132extern void set_binfmt(struct linux_binfmt *new);
Al Viro08a6fac2008-05-10 16:38:25 -0400133extern void free_bprm(struct linux_binprm *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135#endif /* __KERNEL__ */
136#endif /* _LINUX_BINFMTS_H */