xref: /titanic_50/usr/src/uts/common/sys/exec.h (revision dbed73cbda2229fd1aa6dc5743993cae7f0a7ee9)
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 2009 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 
72 /*
73  * User argument structure for passing exec information around between the
74  * common and machine-dependent portions of exec and the exec modules.
75  */
76 typedef struct uarg {
77 	ssize_t	na;
78 	ssize_t	ne;
79 	ssize_t	nc;
80 	ssize_t arglen;
81 	char	*fname;
82 	char	*pathname;
83 	ssize_t	auxsize;
84 	caddr_t	stackend;
85 	size_t	stk_align;
86 	size_t	stk_size;
87 	char	*stk_base;
88 	char	*stk_strp;
89 	int	*stk_offp;
90 	size_t	usrstack_size;
91 	uint_t	stk_prot;
92 	uint_t	dat_prot;
93 	int	traceinval;
94 	int	addr32;
95 	model_t	to_model;
96 	model_t	from_model;
97 	size_t	to_ptrsize;
98 	size_t	from_ptrsize;
99 	size_t	ncargs;
100 	struct execsw *execswp;
101 	uintptr_t entry;
102 	uintptr_t thrptr;
103 	vnode_t	*ex_vp;
104 	char	*emulator;
105 	char	*brandname;
106 	char	*auxp_auxflags; /* addr of auxflags auxv on the user stack */
107 	char	*auxp_brand; /* address of first brand auxv on user stack */
108 } uarg_t;
109 
110 /*
111  * Possible brand actions for exec.
112  */
113 #define	EBA_NONE	0
114 #define	EBA_NATIVE	1
115 #define	EBA_BRAND	2
116 
117 /*
118  * The following macro is a machine dependent encapsulation of
119  * postfix processing to hide the stack direction from elf.c
120  * thereby making the elf.c code machine independent.
121  */
122 #define	execpoststack(ARGS, ARRAYADDR, BYTESIZE) \
123 	(copyout((caddr_t)(ARRAYADDR), (ARGS)->stackend, (BYTESIZE)) ? EFAULT \
124 		: (((ARGS)->stackend += (BYTESIZE)), 0))
125 
126 /*
127  * This provides the current user stack address for an object of size BYTESIZE.
128  * Used to determine the stack address just before applying execpoststack().
129  */
130 #define	stackaddress(ARGS, BYTESIZE)	((ARGS)->stackend)
131 
132 /*
133  * Macro to add attribute/values the aux vector under construction.
134  */
135 /* BEGIN CSTYLED */
136 #if ((_LONG_ALIGNMENT == (2 * _INT_ALIGNMENT)) || \
137      (_POINTER_ALIGNMENT == (2 * _INT_ALIGNMENT)))
138 /* END CSTYLED */
139 /*
140  * This convoluted stuff is necessitated by the fact that there is
141  * potential padding in the aux vector, but not necessarily and
142  * without clearing the padding there is a small, but potential
143  * security hole.
144  */
145 #define	ADDAUX(p, a, v)	{		\
146 		(&(p)->a_type)[1] = 0;	\
147 		(p)->a_type = (a);	\
148 		(p)->a_un.a_val = (v);	\
149 		++(p);			\
150 	}
151 #else
152 #define	ADDAUX(p, a, v)	{			\
153 		(p)->a_type = (a);		\
154 		((p)++)->a_un.a_val = (v);	\
155 	}
156 #endif
157 
158 #define	INTPSZ	MAXPATHLEN
159 typedef struct intpdata {
160 	char	*intp;
161 	char	*intp_name;
162 	char	*intp_arg;
163 } intpdata_t;
164 
165 #define	EXECSETID_SETID		0x1 /* setid exec */
166 #define	EXECSETID_UGIDS		0x2 /* [ug]ids mismatch */
167 #define	EXECSETID_PRIVS		0x4 /* more privs than before */
168 
169 struct execsw {
170 	char	*exec_magic;
171 	int	exec_magoff;
172 	int	exec_maglen;
173 	int	(*exec_func)(struct vnode *vp, struct execa *uap,
174 		    struct uarg *args, struct intpdata *idata, int level,
175 		    long *execsz, int setid, caddr_t exec_file,
176 		    struct cred *cred, int brand_action);
177 	int	(*exec_core)(struct vnode *vp, struct proc *p,
178 		    struct cred *cred, rlim64_t rlimit, int sig,
179 		    core_content_t content);
180 	krwlock_t	*exec_lock;
181 };
182 
183 extern int nexectype;		/* number of elements in execsw */
184 extern struct execsw execsw[];
185 extern kmutex_t execsw_lock;
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