xref: /illumos-gate/usr/src/uts/common/sys/exec.h (revision a74f7440e9d4ba2cf59e6cbfc445479a28170f2a)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
27 /*	  All Rights Reserved  	*/
28 
29 
30 #ifndef _SYS_EXEC_H
31 #define	_SYS_EXEC_H
32 
33 #pragma ident	"%Z%%M%	%I%	%E% SMI"
34 
35 #include <sys/systm.h>
36 #include <vm/seg.h>
37 #include <vm/seg_vn.h>
38 #include <sys/model.h>
39 #include <sys/uio.h>
40 #include <sys/corectl.h>
41 #include <sys/machelf.h>
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 /*
48  * Number of bytes to read for magic string
49  */
50 #define	MAGIC_BYTES	8
51 
52 #define	getexmag(x)	(((x)[0] << 8) + (x)[1])
53 
54 typedef struct execa {
55 	const char *fname;
56 	const char **argp;
57 	const char **envp;
58 } execa_t;
59 
60 typedef struct execenv {
61 	caddr_t ex_bssbase;
62 	caddr_t ex_brkbase;
63 	size_t	ex_brksize;
64 	vnode_t *ex_vp;
65 	short   ex_magic;
66 } execenv_t;
67 
68 #ifdef _KERNEL
69 
70 #define	LOADABLE_EXEC(e)	((e)->exec_lock)
71 #define	LOADED_EXEC(e)		((e)->exec_func)
72 
73 extern int nexectype;		/* number of elements in execsw */
74 extern struct execsw execsw[];
75 extern kmutex_t execsw_lock;
76 
77 /*
78  * User argument structure for passing exec information around between the
79  * common and machine-dependent portions of exec and the exec modules.
80  */
81 typedef struct uarg {
82 	ssize_t	na;
83 	ssize_t	ne;
84 	ssize_t	nc;
85 	ssize_t arglen;
86 	char	*fname;
87 	char	*pathname;
88 	ssize_t	auxsize;
89 	caddr_t	stackend;
90 	size_t	stk_align;
91 	size_t	stk_size;
92 	char	*stk_base;
93 	char	*stk_strp;
94 	int	*stk_offp;
95 	size_t	usrstack_size;
96 	uint_t	stk_prot;
97 	uint_t	dat_prot;
98 	int	traceinval;
99 	model_t	to_model;
100 	model_t	from_model;
101 	size_t	to_ptrsize;
102 	size_t	from_ptrsize;
103 	size_t	ncargs;
104 	struct execsw *execswp;
105 	uintptr_t entry;
106 	uintptr_t thrptr;
107 	vnode_t	*ex_vp;
108 	char	*emulator;
109 	char	*brandname;
110 	char	*auxp_auxflags; /* addr of auxflags auxv on the user stack */
111 	char	*auxp_brand; /* address of first brand auxv on user stack */
112 } uarg_t;
113 
114 /*
115  * Possible brand actions for exec.
116  */
117 #define	EBA_NONE	0
118 #define	EBA_NATIVE	1
119 #define	EBA_BRAND	2
120 
121 /*
122  * The following macro is a machine dependent encapsulation of
123  * postfix processing to hide the stack direction from elf.c
124  * thereby making the elf.c code machine independent.
125  */
126 #define	execpoststack(ARGS, ARRAYADDR, BYTESIZE) \
127 	(copyout((caddr_t)(ARRAYADDR), (ARGS)->stackend, (BYTESIZE)) ? EFAULT \
128 		: (((ARGS)->stackend += (BYTESIZE)), 0))
129 
130 /*
131  * This provides the current user stack address for an object of size BYTESIZE.
132  * Used to determine the stack address just before applying execpoststack().
133  */
134 #define	stackaddress(ARGS, BYTESIZE)	((ARGS)->stackend)
135 
136 /*
137  * Macro to add attribute/values the aux vector under construction.
138  */
139 /* BEGIN CSTYLED */
140 #if ((_LONG_ALIGNMENT == (2 * _INT_ALIGNMENT)) || \
141      (_POINTER_ALIGNMENT == (2 * _INT_ALIGNMENT)))
142 /* END CSTYLED */
143 /*
144  * This convoluted stuff is necessitated by the fact that there is
145  * potential padding in the aux vector, but not necessarily and
146  * without clearing the padding there is a small, but potential
147  * security hole.
148  */
149 #define	ADDAUX(p, a, v)	{		\
150 		(&(p)->a_type)[1] = 0;	\
151 		(p)->a_type = (a);	\
152 		(p)->a_un.a_val = (v);	\
153 		++(p);			\
154 	}
155 #else
156 #define	ADDAUX(p, a, v)	{			\
157 		(p)->a_type = (a);		\
158 		((p)++)->a_un.a_val = (v);	\
159 	}
160 #endif
161 
162 #define	INTPSZ	MAXPATHLEN
163 typedef struct intpdata {
164 	char	*intp;
165 	char	*intp_name;
166 	char	*intp_arg;
167 } intpdata_t;
168 
169 #define	EXECSETID_SETID		0x1 /* setid exec */
170 #define	EXECSETID_UGIDS		0x2 /* [ug]ids mismatch */
171 #define	EXECSETID_PRIVS		0x4 /* more privs than before */
172 
173 struct execsw {
174 	char	*exec_magic;
175 	int	exec_magoff;
176 	int	exec_maglen;
177 	int	(*exec_func)(struct vnode *vp, struct execa *uap,
178 		    struct uarg *args, struct intpdata *idata, int level,
179 		    long *execsz, int setid, caddr_t exec_file,
180 		    struct cred *cred, int brand_action);
181 	int	(*exec_core)(struct vnode *vp, struct proc *p,
182 		    struct cred *cred, rlim64_t rlimit, int sig,
183 		    core_content_t content);
184 	krwlock_t	*exec_lock;
185 };
186 
187 extern short elfmagic;
188 extern short intpmagic;
189 extern short javamagic;
190 #if defined(__sparc)
191 extern short aout_zmagic;
192 extern short aout_nmagic;
193 extern short aout_omagic;
194 #endif
195 extern short nomagic;
196 
197 extern char elf32magicstr[];
198 extern char elf64magicstr[];
199 extern char intpmagicstr[];
200 extern char javamagicstr[];
201 #if defined(__sparc)
202 extern char aout_nmagicstr[];
203 extern char aout_zmagicstr[];
204 extern char aout_omagicstr[];
205 #endif
206 extern char nomagicstr[];
207 
208 extern int exec_args(execa_t *, uarg_t *, intpdata_t *, void **);
209 extern int exec(const char *fname, const char **argp);
210 extern int exece(const char *fname, const char **argp, const char **envp);
211 extern int exec_common(const char *fname, const char **argp,
212     const char **envp, int brand_action);
213 extern int gexec(vnode_t **vp, struct execa *uap, struct uarg *args,
214     struct intpdata *idata, int level, long *execsz, caddr_t exec_file,
215     struct cred *cred, int brand_action);
216 extern struct execsw *allocate_execsw(char *name, char *magic,
217     size_t magic_size);
218 extern struct execsw *findexecsw(char *magic);
219 extern struct execsw *findexec_by_hdr(char *header);
220 extern struct execsw *findexec_by_magic(char *magic);
221 extern int execpermissions(struct vnode *vp, struct vattr *vattrp,
222     struct uarg *args);
223 extern int execmap(vnode_t *vp, caddr_t addr, size_t len, size_t zfodlen,
224     off_t offset, int prot, int page, uint_t);
225 extern void setexecenv(struct execenv *ep);
226 extern int execopen(struct vnode **vpp, int *fdp);
227 extern int execclose(int fd);
228 extern void setregs(uarg_t *);
229 extern void exec_set_sp(size_t);
230 
231 /*
232  * Utility functions for branded process executing
233  */
234 #if !defined(_ELF32_COMPAT)
235 /*
236  * When compiling 64-bit kernels we don't want these definitions included
237  * when compiling the 32-bit compatability elf code in the elfexec module.
238  */
239 extern int elfexec(vnode_t *, execa_t *, uarg_t *, intpdata_t *, int,
240     long *, int, caddr_t, cred_t *, int);
241 extern int mapexec_brand(vnode_t *, uarg_t *, Ehdr *, Addr *,
242     intptr_t *, caddr_t, int *, caddr_t *, caddr_t *, size_t *, uintptr_t *);
243 #endif /* !_ELF32_COMPAT */
244 
245 #if defined(_LP64)
246 extern int elf32exec(vnode_t *, execa_t *, uarg_t *, intpdata_t *, int,
247     long *, int, caddr_t, cred_t *, int);
248 extern int mapexec32_brand(vnode_t *, uarg_t *, Elf32_Ehdr *, Elf32_Addr *,
249     intptr_t *, caddr_t, int *, caddr_t *, caddr_t *, size_t *, uintptr_t *);
250 #endif  /* _LP64 */
251 
252 /*
253  * Utility functions for exec module core routines:
254  */
255 extern int core_seg(proc_t *, vnode_t *, offset_t, caddr_t,
256     size_t, rlim64_t, cred_t *);
257 
258 extern int core_write(vnode_t *, enum uio_seg, offset_t,
259     const void *, size_t, rlim64_t, cred_t *);
260 
261 /* a.out stuff */
262 
263 struct exec;
264 
265 extern caddr_t gettmem(struct exec *exp);
266 extern caddr_t getdmem(struct exec *exp);
267 extern ulong_t getdfile(struct exec *exp);
268 extern uint_t gettfile(struct exec *exp);
269 extern int chkaout(struct exdata *exp);
270 extern void getexinfo(struct exdata *edp_in, struct exdata *edp_out,
271     int *pagetext, int *pagedata);
272 
273 #endif	/* _KERNEL */
274 
275 #ifdef	__cplusplus
276 }
277 #endif
278 
279 #endif /* _SYS_EXEC_H */
280