2 * ----------------------------------------------------------------------------
3 * "THE BEER-WARE LICENSE" (Revision 42):
4 * <phk@FreeBSD.org> wrote this file. As long as you retain this notice you
5 * can do whatever you want with this stuff. If we meet some day, and you think
6 * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
7 * ----------------------------------------------------------------------------
11 * This module handles execution of a.out files which have been run through
12 * "gzip". This saves diskspace, but wastes cpu-cycles and VM.
15 * text-segments should be made R/O after being filled
16 * is the vm-stuff safe ?
17 * should handle the entire header of gzip'ed stuff.
18 * inflate isn't quite reentrant yet...
19 * error-handling is a mess...
21 * tidy up unnecessary includes
24 #include <sys/cdefs.h>
25 __FBSDID("$FreeBSD$");
27 #include <sys/param.h>
29 #include <sys/imgact.h>
30 #include <sys/imgact_aout.h>
31 #include <sys/kernel.h>
34 #include <sys/mutex.h>
36 #include <sys/racct.h>
37 #include <sys/resourcevar.h>
38 #include <sys/sysent.h>
39 #include <sys/systm.h>
40 #include <sys/vnode.h>
41 #include <sys/inflate.h>
44 #include <vm/vm_param.h>
46 #include <vm/vm_map.h>
47 #include <vm/vm_kern.h>
48 #include <vm/vm_extern.h>
51 struct image_params *ip;
61 u_long virtual_offset, file_offset, file_end, bss_size;
64 static int exec_gzip_imgact(struct image_params *imgp);
65 static int NextByte(void *vp);
66 static int do_aout_hdr(struct imgact_gzip *);
67 static int Flush(void *vp, u_char *, u_long siz);
70 exec_gzip_imgact(imgp)
71 struct image_params *imgp;
74 const u_char *p = (const u_char *) imgp->image_header;
75 struct imgact_gzip igz;
77 struct vmspace *vmspace;
79 /* If these four are not OK, it isn't a gzip file */
81 return -1; /* 0 Simply magic */
83 return -1; /* 1 Simply magic */
85 return -1; /* 2 Compression method */
87 return -1; /* 9 OS compressed on */
90 * If this one contains anything but a comment or a filename marker,
91 * we don't want to chew on it
94 return ENOEXEC; /* 3 Flags */
96 /* These are of no use to us */
100 bzero(&igz, sizeof igz);
101 bzero(&infl, sizeof infl);
102 infl.gz_private = (void *) &igz;
103 infl.gz_input = NextByte;
104 infl.gz_output = Flush;
109 if (p[3] & 0x08) { /* skip a filename */
111 if (igz.idx >= PAGE_SIZE)
114 if (p[3] & 0x10) { /* skip a comment */
116 if (igz.idx >= PAGE_SIZE)
119 igz.len = imgp->attr->va_size;
121 error = inflate(&infl);
124 * The unzipped file may not even have been long enough to contain
125 * a header giving Flush() a chance to return error. Check for this.
127 if ( !igz.gotheader )
131 vmspace = imgp->proc->p_vmspace;
132 error = vm_map_protect(&vmspace->vm_map,
133 (vm_offset_t) vmspace->vm_taddr,
134 (vm_offset_t) (vmspace->vm_taddr +
135 (vmspace->vm_tsize << PAGE_SHIFT)) ,
136 VM_PROT_READ|VM_PROT_EXECUTE,0);
140 kmap_free_wakeup(exec_map, (vm_offset_t)igz.inbuf, PAGE_SIZE);
141 if (igz.error || error) {
142 printf("Output=%lu ", igz.output);
143 printf("Inflate_error=%d igz.error=%d where=%d\n",
144 error, igz.error, igz.where);
154 do_aout_hdr(struct imgact_gzip * gz)
157 struct vmspace *vmspace;
161 * Set file/virtual offset based on a.out variant. We do two cases:
162 * host byte order and network byte order (for NetBSD compatibility)
164 switch ((int) (gz->a_out.a_midmag & 0xffff)) {
166 gz->virtual_offset = 0;
167 if (gz->a_out.a_text) {
168 gz->file_offset = PAGE_SIZE;
170 /* Bill's "screwball mode" */
175 gz->virtual_offset = PAGE_SIZE;
179 /* NetBSD compatibility */
180 switch ((int) (ntohl(gz->a_out.a_midmag) & 0xffff)) {
183 gz->virtual_offset = PAGE_SIZE;
187 gz->where = __LINE__;
192 gz->bss_size = roundup(gz->a_out.a_bss, PAGE_SIZE);
195 * Check various fields in header for validity/bounds.
197 if ( /* entry point must lay with text region */
198 gz->a_out.a_entry < gz->virtual_offset ||
199 gz->a_out.a_entry >= gz->virtual_offset + gz->a_out.a_text ||
201 /* text and data size must each be page rounded */
202 gz->a_out.a_text & PAGE_MASK || gz->a_out.a_data & PAGE_MASK) {
203 gz->where = __LINE__;
207 * text/data/bss must not exceed limits
209 PROC_LOCK(gz->ip->proc);
210 if ( /* text can't exceed maximum text size */
211 gz->a_out.a_text > maxtsiz ||
213 /* data + bss can't exceed rlimit */
214 gz->a_out.a_data + gz->bss_size >
215 lim_cur_proc(gz->ip->proc, RLIMIT_DATA) ||
216 racct_set(gz->ip->proc, RACCT_DATA,
217 gz->a_out.a_data + gz->bss_size) != 0) {
218 PROC_UNLOCK(gz->ip->proc);
219 gz->where = __LINE__;
222 PROC_UNLOCK(gz->ip->proc);
223 /* Find out how far we should go */
224 gz->file_end = gz->file_offset + gz->a_out.a_text + gz->a_out.a_data;
227 * Avoid a possible deadlock if the current address space is destroyed
228 * and that address space maps the locked vnode. In the common case,
229 * the locked vnode's v_usecount is decremented but remains greater
230 * than zero. Consequently, the vnode lock is not needed by vrele().
231 * However, in cases where the vnode lock is external, such as nullfs,
232 * v_usecount may become zero.
234 VOP_UNLOCK(gz->ip->vp, 0);
237 * Destroy old process VM and create a new one (with a new stack)
239 error = exec_new_vmspace(gz->ip, &aout_sysvec);
241 vn_lock(gz->ip->vp, LK_EXCLUSIVE | LK_RETRY);
243 gz->where = __LINE__;
247 vmspace = gz->ip->proc->p_vmspace;
249 vmaddr = gz->virtual_offset;
251 error = vm_mmap(&vmspace->vm_map,
253 gz->a_out.a_text + gz->a_out.a_data,
254 VM_PROT_ALL, VM_PROT_ALL, MAP_ANON | MAP_FIXED,
260 gz->where = __LINE__;
264 if (gz->bss_size != 0) {
266 * Allocate demand-zeroed area for uninitialized data.
267 * "bss" = 'block started by symbol' - named after the
268 * IBM 7090 instruction of the same name.
270 vmaddr = gz->virtual_offset + gz->a_out.a_text +
272 error = vm_map_find(&vmspace->vm_map, NULL, 0, &vmaddr,
273 gz->bss_size, 0, VMFS_NO_SPACE, VM_PROT_ALL, VM_PROT_ALL,
276 gz->where = __LINE__;
280 /* Fill in process VM information */
281 vmspace->vm_tsize = gz->a_out.a_text >> PAGE_SHIFT;
282 vmspace->vm_dsize = (gz->a_out.a_data + gz->bss_size) >> PAGE_SHIFT;
283 vmspace->vm_taddr = (caddr_t) (uintptr_t) gz->virtual_offset;
284 vmspace->vm_daddr = (caddr_t) (uintptr_t)
285 (gz->virtual_offset + gz->a_out.a_text);
287 /* Fill in image_params */
288 gz->ip->interpreted = 0;
289 gz->ip->entry_addr = gz->a_out.a_entry;
291 gz->ip->proc->p_sysent = &aout_sysvec;
300 struct imgact_gzip *igz = (struct imgact_gzip *) vp;
302 if (igz->idx >= igz->len) {
303 igz->where = __LINE__;
306 if (igz->inbuf && igz->idx < (igz->offset + PAGE_SIZE)) {
307 return igz->inbuf[(igz->idx++) - igz->offset];
310 kmap_free_wakeup(exec_map, (vm_offset_t)igz->inbuf, PAGE_SIZE);
311 igz->offset = igz->idx & ~PAGE_MASK;
313 error = vm_mmap(exec_map, /* map */
314 (vm_offset_t *) & igz->inbuf, /* address */
315 PAGE_SIZE, /* size */
316 VM_PROT_READ, /* protection */
317 VM_PROT_READ, /* max protection */
319 OBJT_VNODE, /* handle type */
320 igz->ip->vp, /* vnode */
321 igz->offset); /* offset */
323 igz->where = __LINE__;
327 return igz->inbuf[(igz->idx++) - igz->offset];
331 Flush(void *vp, u_char * ptr, u_long siz)
333 struct imgact_gzip *gz = (struct imgact_gzip *) vp;
337 /* First, find an a.out-header. */
338 if (gz->output < sizeof gz->a_out) {
339 q = (u_char *) & gz->a_out;
340 i = min(siz, sizeof gz->a_out - gz->output);
341 bcopy(p, q + gz->output, i);
345 if (gz->output == sizeof gz->a_out) {
350 gz->where = __LINE__;
354 gz->where = __LINE__;
358 if (gz->file_offset == 0) {
359 q = (u_char *) (uintptr_t) gz->virtual_offset;
360 copyout(&gz->a_out, q, sizeof gz->a_out);
364 /* Skip over zero-padded first PAGE if needed */
365 if (gz->output < gz->file_offset &&
366 gz->output + siz > gz->file_offset) {
367 i = min(siz, gz->file_offset - gz->output);
372 if (gz->output >= gz->file_offset && gz->output < gz->file_end) {
373 i = min(siz, gz->file_end - gz->output);
374 q = (u_char *) (uintptr_t)
375 (gz->virtual_offset + gz->output - gz->file_offset);
387 * Tell kern_execve.c about it, with a little help from the linker.
389 static struct execsw gzip_execsw = {exec_gzip_imgact, "gzip"};
390 EXEC_SET(execgzip, gzip_execsw);