USB Gadget: documentation update
[linux-2.6] / include / linux / binfmts.h
1 #ifndef _LINUX_BINFMTS_H
2 #define _LINUX_BINFMTS_H
3
4 #include <linux/capability.h>
5
6 struct pt_regs;
7
8 /*
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.
13  */
14 #define MAX_ARG_STRLEN (PAGE_SIZE * 32)
15 #define MAX_ARG_STRINGS 0x7FFFFFFF
16
17 /* sizeof(linux_binprm->buf) */
18 #define BINPRM_BUF_SIZE 128
19
20 #ifdef __KERNEL__
21
22 #define CORENAME_MAX_SIZE 128
23
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];
29 #ifdef CONFIG_MMU
30         struct vm_area_struct *vma;
31 #else
32 # define MAX_ARG_PAGES  32
33         struct page *page[MAX_ARG_PAGES];
34 #endif
35         struct mm_struct *mm;
36         unsigned long p; /* current top of mem */
37         unsigned int sh_bang:1,
38                      misc_bang:1;
39         struct file * file;
40         int e_uid, e_gid;
41         kernel_cap_t cap_inheritable, cap_permitted;
42         bool cap_effective;
43         void *security;
44         int argc, envc;
45         char * filename;        /* Name of binary as seen by procps */
46         char * interp;          /* Name of the binary really executed. Most
47                                    of the time same as filename, but could be
48                                    different for binfmt_{misc,script} */
49         unsigned interp_flags;
50         unsigned interp_data;
51         unsigned long loader, exec;
52 };
53
54 #define BINPRM_FLAGS_ENFORCE_NONDUMP_BIT 0
55 #define BINPRM_FLAGS_ENFORCE_NONDUMP (1 << BINPRM_FLAGS_ENFORCE_NONDUMP_BIT)
56
57 /* fd of the binary should be passed to the interpreter */
58 #define BINPRM_FLAGS_EXECFD_BIT 1
59 #define BINPRM_FLAGS_EXECFD (1 << BINPRM_FLAGS_EXECFD_BIT)
60
61
62 /*
63  * This structure defines the functions that are used to load the binary formats that
64  * linux accepts.
65  */
66 struct linux_binfmt {
67         struct list_head lh;
68         struct module *module;
69         int (*load_binary)(struct linux_binprm *, struct  pt_regs * regs);
70         int (*load_shlib)(struct file *);
71         int (*core_dump)(long signr, struct pt_regs *regs, struct file *file, unsigned long limit);
72         unsigned long min_coredump;     /* minimal dump size */
73         int hasvdso;
74 };
75
76 extern int register_binfmt(struct linux_binfmt *);
77 extern void unregister_binfmt(struct linux_binfmt *);
78
79 extern int prepare_binprm(struct linux_binprm *);
80 extern int __must_check remove_arg_zero(struct linux_binprm *);
81 extern int search_binary_handler(struct linux_binprm *,struct pt_regs *);
82 extern int flush_old_exec(struct linux_binprm * bprm);
83
84 extern int suid_dumpable;
85 #define SUID_DUMP_DISABLE       0       /* No setuid dumping */
86 #define SUID_DUMP_USER          1       /* Dump as user of process */
87 #define SUID_DUMP_ROOT          2       /* Dump as root */
88
89 /* Stack area protections */
90 #define EXSTACK_DEFAULT   0     /* Whatever the arch defaults to */
91 #define EXSTACK_DISABLE_X 1     /* Disable executable stacks */
92 #define EXSTACK_ENABLE_X  2     /* Enable executable stacks */
93
94 extern int setup_arg_pages(struct linux_binprm * bprm,
95                            unsigned long stack_top,
96                            int executable_stack);
97 extern int bprm_mm_init(struct linux_binprm *bprm);
98 extern int copy_strings_kernel(int argc,char ** argv,struct linux_binprm *bprm);
99 extern void compute_creds(struct linux_binprm *binprm);
100 extern int do_coredump(long signr, int exit_code, struct pt_regs * regs);
101 extern int set_binfmt(struct linux_binfmt *new);
102 extern void free_bprm(struct linux_binprm *);
103
104 #endif /* __KERNEL__ */
105 #endif /* _LINUX_BINFMTS_H */