blob: fd88a3945aa149af16b2671d656fede2e46fafe2 [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 */
Mikael Petterssonf670d0e2011-01-12 17:00:02 -080028struct linux_binprm {
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 char buf[BINPRM_BUF_SIZE];
Ollie Wildb6a2fea2007-07-19 01:48:16 -070030#ifdef CONFIG_MMU
31 struct vm_area_struct *vma;
Oleg Nesterov3c77f842010-11-30 20:55:34 +010032 unsigned long vma_pages;
Ollie Wildb6a2fea2007-07-19 01:48:16 -070033#else
34# define MAX_ARG_PAGES 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 struct page *page[MAX_ARG_PAGES];
Ollie Wildb6a2fea2007-07-19 01:48:16 -070036#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 struct mm_struct *mm;
38 unsigned long p; /* current top of mem */
Kirill A. Shutemova50b0aa2009-04-02 16:58:29 -070039 unsigned int
David Howellsa6f76f22008-11-14 10:39:24 +110040 cred_prepared:1,/* true if creds already prepared (multiple
41 * preps happen for interpreters) */
42 cap_effective:1;/* true if has elevated effective capabilities,
43 * false if not; except for init which inherits
44 * its parent's caps anyway */
Kirill A. Shutemov53112482008-10-15 22:02:37 -070045#ifdef __alpha__
46 unsigned int taso:1;
47#endif
Kirill A. Shutemovbf2a9a32008-10-15 22:02:39 -070048 unsigned int recursion_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 struct file * file;
David Howellsa6f76f22008-11-14 10:39:24 +110050 struct cred *cred; /* new credentials */
51 int unsafe; /* how unsafe this exec is (mask of LSM_UNSAFE_*) */
52 unsigned int per_clear; /* bits to clear in current->personality */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 int argc, envc;
David Howellsd7627462010-08-17 23:52:56 +010054 const char * filename; /* Name of binary as seen by procps */
55 const char * interp; /* Name of the binary really executed. Most
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 of the time same as filename, but could be
57 different for binfmt_{misc,script} */
58 unsigned interp_flags;
59 unsigned interp_data;
60 unsigned long loader, exec;
61};
62
63#define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
64#define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
65
66/* fd of the binary should be passed to the interpreter */
67#define BINPRM_FLAGS_EXECFD_BIT 1
68#define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
69
Kirill A. Shutemovbf2a9a32008-10-15 22:02:39 -070070#define BINPRM_MAX_RECURSION 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080072/* Function parameter for binfmt->coredump */
73struct coredump_params {
74 long signr;
75 struct pt_regs *regs;
76 struct file *file;
77 unsigned long limit;
Masami Hiramatsu30736a42010-03-05 13:44:12 -080078 unsigned long mm_flags;
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080079};
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081/*
82 * This structure defines the functions that are used to load the binary formats that
83 * linux accepts.
84 */
85struct linux_binfmt {
Alexey Dobriyane4dc1b12007-10-16 23:26:03 -070086 struct list_head lh;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 struct module *module;
88 int (*load_binary)(struct linux_binprm *, struct pt_regs * regs);
89 int (*load_shlib)(struct file *);
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080090 int (*core_dump)(struct coredump_params *cprm);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 unsigned long min_coredump; /* minimal dump size */
92};
93
Ivan Kokshaysky74641f52009-04-30 15:08:49 -070094extern int __register_binfmt(struct linux_binfmt *fmt, int insert);
95
96/* Registration of default binfmt handlers */
97static 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 */
102static inline int insert_binfmt(struct linux_binfmt *fmt)
103{
104 return __register_binfmt(fmt, 1);
105}
106
Alexey Dobriyanf6b450d2007-10-16 23:26:04 -0700107extern void unregister_binfmt(struct linux_binfmt *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109extern int prepare_binprm(struct linux_binprm *);
Ollie Wildb6a2fea2007-07-19 01:48:16 -0700110extern int __must_check remove_arg_zero(struct linux_binprm *);
Mikael Petterssonf670d0e2011-01-12 17:00:02 -0800111extern int search_binary_handler(struct linux_binprm *, struct pt_regs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112extern int flush_old_exec(struct linux_binprm * bprm);
Linus Torvalds221af7f2010-01-28 22:14:42 -0800113extern void setup_new_exec(struct linux_binprm * bprm);
Al Viro1b5d7832011-06-19 12:49:47 -0400114extern void would_dump(struct linux_binprm *, struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Alan Coxd6e71142005-06-23 00:09:43 -0700116extern int suid_dumpable;
117#define SUID_DUMP_DISABLE 0 /* No setuid dumping */
118#define SUID_DUMP_USER 1 /* Dump as user of process */
119#define SUID_DUMP_ROOT 2 /* Dump as root */
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/* Stack area protections */
122#define EXSTACK_DEFAULT 0 /* Whatever the arch defaults to */
123#define EXSTACK_DISABLE_X 1 /* Disable executable stacks */
124#define EXSTACK_ENABLE_X 2 /* Enable executable stacks */
125
126extern int setup_arg_pages(struct linux_binprm * bprm,
127 unsigned long stack_top,
128 int executable_stack);
Ollie Wildb6a2fea2007-07-19 01:48:16 -0700129extern int bprm_mm_init(struct linux_binprm *bprm);
David Howellsd7627462010-08-17 23:52:56 +0100130extern int copy_strings_kernel(int argc, const char *const *argv,
131 struct linux_binprm *bprm);
Oleg Nesterova2a84742009-09-05 11:17:13 -0700132extern int prepare_bprm_creds(struct linux_binprm *bprm);
David Howellsa6f76f22008-11-14 10:39:24 +1100133extern void install_exec_creds(struct linux_binprm *bprm);
WANG Cong8cd3ac32009-01-06 14:42:48 -0800134extern void do_coredump(long signr, int exit_code, struct pt_regs *regs);
Oleg Nesterov964ee7d2009-09-23 15:56:59 -0700135extern void set_binfmt(struct linux_binfmt *new);
Al Viro08a6fac2008-05-10 16:38:25 -0400136extern void free_bprm(struct linux_binprm *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138#endif /* __KERNEL__ */
139#endif /* _LINUX_BINFMTS_H */