xref: /freebsd/sys/sys/imgact.h (revision b0b1dbdd)
1 /*-
2  * Copyright (c) 1993, David Greenman
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _SYS_IMGACT_H_
33 #define	_SYS_IMGACT_H_
34 
35 #include <sys/uio.h>
36 
37 #include <vm/vm.h>
38 
39 #define MAXSHELLCMDLEN	PAGE_SIZE
40 
41 struct ucred;
42 
43 struct image_args {
44 	char *buf;		/* pointer to string buffer */
45 	void *bufkva;		/* cookie for string buffer KVA */
46 	char *begin_argv;	/* beginning of argv in buf */
47 	char *begin_envv;	/* beginning of envv in buf */
48 	char *endp;		/* current `end' pointer of arg & env strings */
49 	char *fname;            /* pointer to filename of executable (system space) */
50 	char *fname_buf;	/* pointer to optional malloc(M_TEMP) buffer */
51 	int stringspace;	/* space left in arg & env buffer */
52 	int argc;		/* count of argument strings */
53 	int envc;		/* count of environment strings */
54 	int fd;			/* file descriptor of the executable */
55 	struct filedesc *fdp;	/* new file descriptor table */
56 };
57 
58 struct image_params {
59 	struct proc *proc;	/* our process struct */
60 	struct label *execlabel;	/* optional exec label */
61 	struct vnode *vp;	/* pointer to vnode of file to exec */
62 	struct vm_object *object;	/* The vm object for this vp */
63 	struct vattr *attr;	/* attributes of file */
64 	const char *image_header; /* head of file to exec */
65 	unsigned long entry_addr; /* entry address of target executable */
66 	unsigned long reloc_base; /* load address of image */
67 	char vmspace_destroyed;	/* flag - we've blown away original vm space */
68 #define IMGACT_SHELL	0x1
69 #define IMGACT_BINMISC	0x2
70 	unsigned char interpreted;	/* mask of interpreters that have run */
71 	char opened;		/* flag - we have opened executable vnode */
72 	char *interpreter_name;	/* name of the interpreter */
73 	void *auxargs;		/* ELF Auxinfo structure pointer */
74 	struct sf_buf *firstpage;	/* first page that we mapped */
75 	unsigned long ps_strings; /* PS_STRINGS for BSD/OS binaries */
76 	size_t auxarg_size;
77 	struct image_args *args;	/* system call arguments */
78 	struct sysentvec *sysent;	/* system entry vector */
79 	char *execpath;
80 	unsigned long execpathp;
81 	char *freepath;
82 	unsigned long canary;
83 	int canarylen;
84 	unsigned long pagesizes;
85 	int pagesizeslen;
86 	vm_prot_t stack_prot;
87 	u_long stack_sz;
88 	struct ucred *newcred;		/* new credentials if changing */
89 	bool credential_setid;		/* true if becoming setid */
90 };
91 
92 #ifdef _KERNEL
93 struct sysentvec;
94 struct thread;
95 struct vmspace;
96 
97 #define IMGACT_CORE_COMPRESS	0x01
98 
99 int	exec_alloc_args(struct image_args *);
100 int	exec_check_permissions(struct image_params *);
101 register_t *exec_copyout_strings(struct image_params *);
102 void	exec_free_args(struct image_args *);
103 int	exec_new_vmspace(struct image_params *, struct sysentvec *);
104 void	exec_setregs(struct thread *, struct image_params *, u_long);
105 int	exec_shell_imgact(struct image_params *);
106 int	exec_copyin_args(struct image_args *, char *, enum uio_seg,
107 	char **, char **);
108 int	exec_copyin_data_fds(struct thread *, struct image_args *, const void *,
109 	size_t, const int *, size_t);
110 int	pre_execve(struct thread *td, struct vmspace **oldvmspace);
111 void	post_execve(struct thread *td, int error, struct vmspace *oldvmspace);
112 #endif
113 
114 #endif /* !_SYS_IMGACT_H_ */
115