blob: 8938beabad7abbdfc9e914cb8e26797d89ebff3c [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__
Heiko Carstens96e02d12012-02-04 10:47:10 +010021#include <linux/sched.h>
Al Viro826eba42012-08-03 12:14:44 +040022#include <asm/exec.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Dan Aloni71ce92f2007-05-16 22:11:16 -070024#define CORENAME_MAX_SIZE 128
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/*
27 * This structure is used to hold the arguments that are used when loading binaries.
28 */
Mikael Petterssonf670d0e2011-01-12 17:00:02 -080029struct linux_binprm {
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 char buf[BINPRM_BUF_SIZE];
Ollie Wildb6a2fea2007-07-19 01:48:16 -070031#ifdef CONFIG_MMU
32 struct vm_area_struct *vma;
Oleg Nesterov3c77f842010-11-30 20:55:34 +010033 unsigned long vma_pages;
Ollie Wildb6a2fea2007-07-19 01:48:16 -070034#else
35# define MAX_ARG_PAGES 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 struct page *page[MAX_ARG_PAGES];
Ollie Wildb6a2fea2007-07-19 01:48:16 -070037#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 struct mm_struct *mm;
39 unsigned long p; /* current top of mem */
Kirill A. Shutemova50b0aa2009-04-02 16:58:29 -070040 unsigned int
David Howellsa6f76f22008-11-14 10:39:24 +110041 cred_prepared:1,/* true if creds already prepared (multiple
42 * preps happen for interpreters) */
43 cap_effective:1;/* true if has elevated effective capabilities,
44 * false if not; except for init which inherits
45 * its parent's caps anyway */
Kirill A. Shutemov53112482008-10-15 22:02:37 -070046#ifdef __alpha__
47 unsigned int taso:1;
48#endif
Kirill A. Shutemovbf2a9a32008-10-15 22:02:39 -070049 unsigned int recursion_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 struct file * file;
David Howellsa6f76f22008-11-14 10:39:24 +110051 struct cred *cred; /* new credentials */
52 int unsafe; /* how unsafe this exec is (mask of LSM_UNSAFE_*) */
53 unsigned int per_clear; /* bits to clear in current->personality */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 int argc, envc;
David Howellsd7627462010-08-17 23:52:56 +010055 const char * filename; /* Name of binary as seen by procps */
56 const char * interp; /* Name of the binary really executed. Most
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 of the time same as filename, but could be
58 different for binfmt_{misc,script} */
59 unsigned interp_flags;
60 unsigned interp_data;
61 unsigned long loader, exec;
Heiko Carstens96e02d12012-02-04 10:47:10 +010062 char tcomm[TASK_COMM_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -070063};
64
65#define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
66#define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
67
68/* fd of the binary should be passed to the interpreter */
69#define BINPRM_FLAGS_EXECFD_BIT 1
70#define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
71
Kirill A. Shutemovbf2a9a32008-10-15 22:02:39 -070072#define BINPRM_MAX_RECURSION 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080074/* Function parameter for binfmt->coredump */
75struct coredump_params {
76 long signr;
77 struct pt_regs *regs;
78 struct file *file;
79 unsigned long limit;
Masami Hiramatsu30736a42010-03-05 13:44:12 -080080 unsigned long mm_flags;
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080081};
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083/*
84 * This structure defines the functions that are used to load the binary formats that
85 * linux accepts.
86 */
87struct linux_binfmt {
Alexey Dobriyane4dc1b12007-10-16 23:26:03 -070088 struct list_head lh;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 struct module *module;
90 int (*load_binary)(struct linux_binprm *, struct pt_regs * regs);
91 int (*load_shlib)(struct file *);
Masami Hiramatsuf6151df2009-12-17 15:27:16 -080092 int (*core_dump)(struct coredump_params *cprm);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 unsigned long min_coredump; /* minimal dump size */
94};
95
Al Viro8fc3dc52012-03-17 03:05:16 -040096extern void __register_binfmt(struct linux_binfmt *fmt, int insert);
Ivan Kokshaysky74641f52009-04-30 15:08:49 -070097
98/* Registration of default binfmt handlers */
Al Viro8fc3dc52012-03-17 03:05:16 -040099static inline void register_binfmt(struct linux_binfmt *fmt)
Ivan Kokshaysky74641f52009-04-30 15:08:49 -0700100{
Al Viro8fc3dc52012-03-17 03:05:16 -0400101 __register_binfmt(fmt, 0);
Ivan Kokshaysky74641f52009-04-30 15:08:49 -0700102}
103/* Same as above, but adds a new binfmt at the top of the list */
Al Viro8fc3dc52012-03-17 03:05:16 -0400104static inline void insert_binfmt(struct linux_binfmt *fmt)
Ivan Kokshaysky74641f52009-04-30 15:08:49 -0700105{
Al Viro8fc3dc52012-03-17 03:05:16 -0400106 __register_binfmt(fmt, 1);
Ivan Kokshaysky74641f52009-04-30 15:08:49 -0700107}
108
Alexey Dobriyanf6b450d2007-10-16 23:26:04 -0700109extern void unregister_binfmt(struct linux_binfmt *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111extern int prepare_binprm(struct linux_binprm *);
Ollie Wildb6a2fea2007-07-19 01:48:16 -0700112extern int __must_check remove_arg_zero(struct linux_binprm *);
Mikael Petterssonf670d0e2011-01-12 17:00:02 -0800113extern int search_binary_handler(struct linux_binprm *, struct pt_regs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114extern int flush_old_exec(struct linux_binprm * bprm);
Linus Torvalds221af7f2010-01-28 22:14:42 -0800115extern void setup_new_exec(struct linux_binprm * bprm);
Al Viro1b5d7832011-06-19 12:49:47 -0400116extern void would_dump(struct linux_binprm *, struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Alan Coxd6e71142005-06-23 00:09:43 -0700118extern int suid_dumpable;
119#define SUID_DUMP_DISABLE 0 /* No setuid dumping */
120#define SUID_DUMP_USER 1 /* Dump as user of process */
121#define SUID_DUMP_ROOT 2 /* Dump as root */
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Stack area protections */
124#define EXSTACK_DEFAULT 0 /* Whatever the arch defaults to */
125#define EXSTACK_DISABLE_X 1 /* Disable executable stacks */
126#define EXSTACK_ENABLE_X 2 /* Enable executable stacks */
127
128extern int setup_arg_pages(struct linux_binprm * bprm,
129 unsigned long stack_top,
130 int executable_stack);
Ollie Wildb6a2fea2007-07-19 01:48:16 -0700131extern int bprm_mm_init(struct linux_binprm *bprm);
David Howellsd7627462010-08-17 23:52:56 +0100132extern int copy_strings_kernel(int argc, const char *const *argv,
133 struct linux_binprm *bprm);
Oleg Nesterova2a84742009-09-05 11:17:13 -0700134extern int prepare_bprm_creds(struct linux_binprm *bprm);
David Howellsa6f76f22008-11-14 10:39:24 +1100135extern void install_exec_creds(struct linux_binprm *bprm);
WANG Cong8cd3ac32009-01-06 14:42:48 -0800136extern void do_coredump(long signr, int exit_code, struct pt_regs *regs);
Oleg Nesterov964ee7d2009-09-23 15:56:59 -0700137extern void set_binfmt(struct linux_binfmt *new);
Al Viro08a6fac2008-05-10 16:38:25 -0400138extern void free_bprm(struct linux_binprm *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140#endif /* __KERNEL__ */
141#endif /* _LINUX_BINFMTS_H */