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