src/disk/bootblock_iso9660.c

/*
 *  Copyright (C) 2003-2007  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: bootblock_iso9660.c,v 1.3 2007/06/15 17:02:39 debug Exp $
 *
 *  ISO9660 CD-ROM "bootblock" handling.
 *
 *  There is really no bootblock; instead, the file which is to be booted
 *  is extracted into a temporary file, and started as if it was given
 *  as a normal file argument on the command line.
 *
 *  TODO: This is really ugly. It's a quick hack. All the magic constants
 *        need to be replaced with real code!
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <unistd.h>

#include "cpu.h"
#include "diskimage.h"
#include "machine.h"
#include "misc.h"

/*  #define ISO_DEBUG  */


static void debug_print_volume_id_and_filename(int iso_type,
        unsigned char *buf, char *filename)
{
        /*  Volume ID:  */
        char str[35];
        int i, ofs = iso_type == 3? 48 : 40;

        memcpy(str, buf + ofs, sizeof(str));
        str[32] = '\0';  i = 31;

        while (i >= 0 && str[i]==' ')
                str[i--] = '\0';
        if (str[0])
                debug("\"%s\"", str);
        else {
                /*  System ID:  */
                ofs = iso_type == 3? 16 : 8;
                memcpy(str, buf + ofs, sizeof(str));
                str[32] = '\0';  i = 31;
                while (i >= 0 && str[i]==' ')
                        str[i--] = '\0';
                if (str[0])
                        debug("\"%s\"", str);
                else
                        debug("(no ID)");
        }

        debug(":%s\n", filename);
}


/*
 *  iso_load_bootblock():
 *
 *  Try to load a kernel from an ISO 9660 disk image. iso_type is 1 for
 *  "CD001" (standard), 2 for "CDW01" (ECMA), and 3 for "CDROM" (Sierra).
 *
 *  TODO: This function uses too many magic offsets and so on; it should be
 *  cleaned up some day.
 *
 *  Returns 1 on success, 0 on failure.
 */
int iso_load_bootblock(struct machine *m, struct cpu *cpu,
        int disk_id, int disk_type, int iso_type, unsigned char *buf,
        int *n_loadp, char ***load_namesp)
{
        int filenr, dirlen, res = 0, res2, iadd = DEBUG_INDENTATION, found_dir;
        uint64_t dirofs, fileofs, filelen;
        unsigned char *dirbuf = NULL, *dp, *match_entry = NULL, *filebuf = NULL;
        char *p, *filename_orig, *filename, *tmpfname = NULL;
        char **new_array;
        int tmpfile_handle;

        CHECK_ALLOCATION(filename = strdup(cpu->machine->boot_kernel_filename));
        filename_orig = filename;

        debug("ISO9660 boot:\n");
        debug_indentation(iadd);

        debug_print_volume_id_and_filename(iso_type, buf, filename);


        /*
         *  Traverse the directory structure to find the kernel.
         */

        dirlen = buf[0x84] + 256*buf[0x85] + 65536*buf[0x86];
        if (dirlen != buf[0x8b] + 256*buf[0x8a] + 65536*buf[0x89])
                fatal("WARNING: Root directory length mismatch?\n");

        dirofs = (int64_t)(buf[0x8c] + (buf[0x8d] << 8) + (buf[0x8e] << 16) +
            ((uint64_t)buf[0x8f] << 24)) * 2048;

#ifdef ISO_DEBUG
        debug("root = %i bytes at 0x%llx\n", dirlen, (long long)dirofs);
#endif

        CHECK_ALLOCATION(dirbuf = malloc(dirlen));
        res2 = diskimage_access(m, disk_id, disk_type, 0, dirofs, dirbuf,
            dirlen);
        if (!res2) {
                fatal("Couldn't read the disk image. Aborting.\n");
                goto ret;
        }

        found_dir = 1;  /*  Assume root dir  */
        dp = dirbuf; filenr = 1;
        p = NULL;
        while (dp < dirbuf + dirlen) {
                size_t i, nlen = dp[0];
                int x = dp[2] + (dp[3] << 8) + (dp[4] << 16) +
                    ((uint64_t)dp[5] << 24);
                int y = dp[6] + (dp[7] << 8);
                char direntry[65];

                dp += 8;

                /*
                 *  As long as there is an \ or / in the filename, then we
                 *  have not yet found the directory.
                 */
                p = strchr(filename, '/');
                if (p == NULL)
                        p = strchr(filename, '\\');

#ifdef ISO_DEBUG
                debug("%i%s: %i, %i, \"", filenr, filenr == found_dir?
                    " [CURRENT]" : "", x, y);
#endif
                for (i=0; i<nlen && i<sizeof(direntry)-1; i++)
                        if (dp[i]) {
                                direntry[i] = dp[i];
#ifdef ISO_DEBUG
                                debug("%c", dp[i]);
#endif
                        } else
                                break;
#ifdef ISO_DEBUG
                debug("\"\n");
#endif
                direntry[i] = '\0';

                /*  A directory name match?  */
                if ((p != NULL && strncasecmp(filename, direntry, nlen) == 0
                    && nlen == (size_t)p - (size_t)filename && found_dir == y)
                    || (p == NULL && direntry[0] == '\0') ) {
                        found_dir = filenr;
                        if (p != NULL)
                                filename = p+1;
                        dirofs = 2048 * (int64_t)x;
                }

                dp += nlen;

                /*  16-bit aligned lenght:  */
                if (nlen & 1)
                        dp ++;

                filenr ++;
        }

        p = strchr(filename, '/');
        if (p == NULL)
                p = strchr(filename, '\\');

        if (p != NULL) {
                char *blah = filename_orig;

                fatal("could not find '%s' in /", filename);

                /*  Print the first part of the filename:  */
                while (blah != filename)
                        fatal("%c", *blah++);
                
                fatal("\n");
                goto ret;
        }

        /*  debug("dirofs = 0x%llx\n", (long long)dirofs);  */

        /*  Free the old dirbuf, and allocate a new one:  */
        free(dirbuf);
        CHECK_ALLOCATION(dirbuf = malloc(512));

        for (;;) {
                size_t len, i;

                /*  Too close to another sector? Then realign.  */
                if ((dirofs & 2047) + 70 > 2047) {
                        dirofs = (dirofs | 2047) + 1;
                        /*  debug("realign dirofs = 0x%llx\n", dirofs);  */
                }

                res2 = diskimage_access(m, disk_id, disk_type, 0, dirofs,
                    dirbuf, 256);
                if (!res2) {
                        fatal("Couldn't read the disk image. Aborting.\n");
                        goto ret;
                }

                dp = dirbuf;
                len = dp[0];
                if (len < 2)
                        break;

                /*
                 *  TODO: Actually parse the directory entry!
                 *
                 *  Haha, this must be rewritten.
                 */

#if 0
/*  hahahaha  */
printf("filename = '%s'\n", filename);
{
int j;
for (j=32; j<len; j++)
        printf("%c", dp[j] >= ' ' && dp[j] < 128? dp[j] : '.');
printf("\n");
}
#endif

                for (i=32; i<len; i++) {
                        if (i < len - strlen(filename))
                                if (strncmp(filename, (char *)dp + i,
                                    strlen(filename)) == 0) {
                                        /*  The filename was found somewhere
                                            in the directory entry.  */
                                        if (match_entry != NULL) {
                                                fatal("TODO: I'm too lazy to"
                                                    " implement a correct "
                                                    "directory parser right "
                                                    "now... (BUG)\n");
                                                exit(1);
                                        }
                                        CHECK_ALLOCATION(match_entry =
                                            malloc(512));
                                        memcpy(match_entry, dp, 512);
                                        break;
                                }
                }

                if (match_entry != NULL)
                        break;

                dirofs += len;
        }

        if (match_entry == NULL) {
                char *blah = filename_orig;

                fatal("could not find '%s' in /", filename);

                /*  Print the first part of the filename:  */
                while (blah != filename)
                        fatal("%c", *blah++);
                
                fatal("\n");
                goto ret;
        }

        fileofs = match_entry[2] + (match_entry[3] << 8) +
            (match_entry[4] << 16) + ((uint64_t)match_entry[5] << 24);
        filelen = match_entry[10] + (match_entry[11] << 8) +
            (match_entry[12] << 16) + ((uint64_t)match_entry[13] << 24);
        fileofs *= 2048;

        /*  debug("filelen=%llx fileofs=%llx\n", (long long)filelen,
            (long long)fileofs);  */

        CHECK_ALLOCATION(filebuf = malloc(filelen));
        tmpfname = strdup("/tmp/gxemul.XXXXXXXXXXXX");

        res2 = diskimage_access(m, disk_id, disk_type, 0, fileofs, filebuf,
            filelen);
        if (!res2) {
                fatal("could not read the file from the disk image!\n");
                goto ret;
        }

        tmpfile_handle = mkstemp(tmpfname);
        if (tmpfile_handle < 0) {
                fatal("could not create %s\n", tmpfname);
                exit(1);
        }
        write(tmpfile_handle, filebuf, filelen);
        close(tmpfile_handle);

        debug("extracted %lli bytes into %s\n", (long long)filelen, tmpfname);

        /*  Add the temporary filename to the load_namesp array:  */
        (*n_loadp)++;
        CHECK_ALLOCATION(new_array = malloc(sizeof(char *) * (*n_loadp)));
        memcpy(new_array, *load_namesp, sizeof(char *) * (*n_loadp));
        *load_namesp = new_array;

        /*  This adds a Backspace char in front of the filename; this
            is a special hack which causes the file to be removed once
            it has been loaded.  */
        CHECK_ALLOCATION(tmpfname = realloc(tmpfname, strlen(tmpfname) + 2));
        memmove(tmpfname + 1, tmpfname, strlen(tmpfname) + 1);
        tmpfname[0] = 8;

        (*load_namesp)[*n_loadp - 1] = tmpfname;

        res = 1;

ret:
        if (dirbuf != NULL)
                free(dirbuf);

        if (filebuf != NULL)
                free(filebuf);

        if (match_entry != NULL)
                free(match_entry);

        free(filename_orig);

        debug_indentation(-iadd);
        return res;
}

1	/*
2	* Copyright (C) 2003-2007 Anders Gavare. All rights reserved.
3	*
4	* Redistribution and use in source and binary forms, with or without
5	* modification, are permitted provided that the following conditions are met:
6	*
7	* 1. Redistributions of source code must retain the above copyright
8	* notice, this list of conditions and the following disclaimer.
9	* 2. Redistributions in binary form must reproduce the above copyright
10	* notice, this list of conditions and the following disclaimer in the
11	* documentation and/or other materials provided with the distribution.
12	* 3. The name of the author may not be used to endorse or promote products
13	* derived from this software without specific prior written permission.
14	*
15	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25	* SUCH DAMAGE.
26	*
27	*
28	* $Id: bootblock_iso9660.c,v 1.3 2007/06/15 17:02:39 debug Exp $
29	*
30	* ISO9660 CD-ROM "bootblock" handling.
31	*
32	* There is really no bootblock; instead, the file which is to be booted
33	* is extracted into a temporary file, and started as if it was given
34	* as a normal file argument on the command line.
35	*
36	* TODO: This is really ugly. It's a quick hack. All the magic constants
37	* need to be replaced with real code!
38	*/
39
40	#include <stdio.h>
41	#include <stdlib.h>
42	#include <string.h>
43	#include <sys/types.h>
44	#include <unistd.h>
45
46	#include "cpu.h"
47	#include "diskimage.h"
48	#include "machine.h"
49	#include "misc.h"
50
51	/* #define ISO_DEBUG */
52
53
54	static void debug_print_volume_id_and_filename(int iso_type,
55	unsigned char buf, char filename)
56	{
57	/* Volume ID: */
58	char str[35];
59	int i, ofs = iso_type == 3? 48 : 40;
60
61	memcpy(str, buf + ofs, sizeof(str));
62	str[32] = '\0'; i = 31;
63
64	while (i >= 0 && str[i]==' ')
65	str[i--] = '\0';
66	if (str[0])
67	debug("\"%s\"", str);
68	else {
69	/* System ID: */
70	ofs = iso_type == 3? 16 : 8;
71	memcpy(str, buf + ofs, sizeof(str));
72	str[32] = '\0'; i = 31;
73	while (i >= 0 && str[i]==' ')
74	str[i--] = '\0';
75	if (str[0])
76	debug("\"%s\"", str);
77	else
78	debug("(no ID)");
79	}
80
81	debug(":%s\n", filename);
82	}
83
84
85	/*
86	* iso_load_bootblock():
87	*
88	* Try to load a kernel from an ISO 9660 disk image. iso_type is 1 for
89	* "CD001" (standard), 2 for "CDW01" (ECMA), and 3 for "CDROM" (Sierra).
90	*
91	* TODO: This function uses too many magic offsets and so on; it should be
92	* cleaned up some day.
93	*
94	* Returns 1 on success, 0 on failure.
95	*/
96	int iso_load_bootblock(struct machine m, struct cpu cpu,
97	int disk_id, int disk_type, int iso_type, unsigned char *buf,
98	int n_loadp, char **load_namesp)
99	{
100	int filenr, dirlen, res = 0, res2, iadd = DEBUG_INDENTATION, found_dir;
101	uint64_t dirofs, fileofs, filelen;
102	unsigned char dirbuf = NULL, dp, match_entry = NULL, filebuf = NULL;
103	char p, filename_orig, filename, tmpfname = NULL;
104	char **new_array;
105	int tmpfile_handle;
106
107	CHECK_ALLOCATION(filename = strdup(cpu->machine->boot_kernel_filename));
108	filename_orig = filename;
109
110	debug("ISO9660 boot:\n");
111	debug_indentation(iadd);
112
113	debug_print_volume_id_and_filename(iso_type, buf, filename);
114
115
116	/*
117	* Traverse the directory structure to find the kernel.
118	*/
119
120	dirlen = buf[0x84] + 256buf[0x85] + 65536buf[0x86];
121	if (dirlen != buf[0x8b] + 256buf[0x8a] + 65536buf[0x89])
122	fatal("WARNING: Root directory length mismatch?\n");
123
124	dirofs = (int64_t)(buf[0x8c] + (buf[0x8d] << 8) + (buf[0x8e] << 16) +
125	((uint64_t)buf[0x8f] << 24)) * 2048;
126
127	#ifdef ISO_DEBUG
128	debug("root = %i bytes at 0x%llx\n", dirlen, (long long)dirofs);
129	#endif
130
131	CHECK_ALLOCATION(dirbuf = malloc(dirlen));
132	res2 = diskimage_access(m, disk_id, disk_type, 0, dirofs, dirbuf,
133	dirlen);
134	if (!res2) {
135	fatal("Couldn't read the disk image. Aborting.\n");
136	goto ret;
137	}
138
139	found_dir = 1; /* Assume root dir */
140	dp = dirbuf; filenr = 1;
141	p = NULL;
142	while (dp < dirbuf + dirlen) {
143	size_t i, nlen = dp[0];
144	int x = dp[2] + (dp[3] << 8) + (dp[4] << 16) +
145	((uint64_t)dp[5] << 24);
146	int y = dp[6] + (dp[7] << 8);
147	char direntry[65];
148
149	dp += 8;
150
151	/*
152	* As long as there is an \ or / in the filename, then we
153	* have not yet found the directory.
154	*/
155	p = strchr(filename, '/');
156	if (p == NULL)
157	p = strchr(filename, '\\');
158
159	#ifdef ISO_DEBUG
160	debug("%i%s: %i, %i, \"", filenr, filenr == found_dir?
161	" [CURRENT]" : "", x, y);
162	#endif
163	for (i=0; i<nlen && i<sizeof(direntry)-1; i++)
164	if (dp[i]) {
165	direntry[i] = dp[i];
166	#ifdef ISO_DEBUG
167	debug("%c", dp[i]);
168	#endif
169	} else
170	break;
171	#ifdef ISO_DEBUG
172	debug("\"\n");
173	#endif
174	direntry[i] = '\0';
175
176	/* A directory name match? */
177	if ((p != NULL && strncasecmp(filename, direntry, nlen) == 0
178	&& nlen == (size_t)p - (size_t)filename && found_dir == y)
179	\|\| (p == NULL && direntry[0] == '\0') ) {
180	found_dir = filenr;
181	if (p != NULL)
182	filename = p+1;
183	dirofs = 2048 * (int64_t)x;
184	}
185
186	dp += nlen;
187
188	/* 16-bit aligned lenght: */
189	if (nlen & 1)
190	dp ++;
191
192	filenr ++;
193	}
194
195	p = strchr(filename, '/');
196	if (p == NULL)
197	p = strchr(filename, '\\');
198
199	if (p != NULL) {
200	char *blah = filename_orig;
201
202	fatal("could not find '%s' in /", filename);
203
204	/* Print the first part of the filename: */
205	while (blah != filename)
206	fatal("%c", *blah++);
207
208	fatal("\n");
209	goto ret;
210	}
211
212	/* debug("dirofs = 0x%llx\n", (long long)dirofs); */
213
214	/* Free the old dirbuf, and allocate a new one: */
215	free(dirbuf);
216	CHECK_ALLOCATION(dirbuf = malloc(512));
217
218	for (;;) {
219	size_t len, i;
220
221	/* Too close to another sector? Then realign. */
222	if ((dirofs & 2047) + 70 > 2047) {
223	dirofs = (dirofs \| 2047) + 1;
224	/* debug("realign dirofs = 0x%llx\n", dirofs); */
225	}
226
227	res2 = diskimage_access(m, disk_id, disk_type, 0, dirofs,
228	dirbuf, 256);
229	if (!res2) {
230	fatal("Couldn't read the disk image. Aborting.\n");
231	goto ret;
232	}
233
234	dp = dirbuf;
235	len = dp[0];
236	if (len < 2)
237	break;
238
239	/*
240	* TODO: Actually parse the directory entry!
241	*
242	* Haha, this must be rewritten.
243	*/
244
245	#if 0
246	/* hahahaha */
247	printf("filename = '%s'\n", filename);
248	{
249	int j;
250	for (j=32; j<len; j++)
251	printf("%c", dp[j] >= ' ' && dp[j] < 128? dp[j] : '.');
252	printf("\n");
253	}
254	#endif
255
256	for (i=32; i<len; i++) {
257	if (i < len - strlen(filename))
258	if (strncmp(filename, (char *)dp + i,
259	strlen(filename)) == 0) {
260	/* The filename was found somewhere
261	in the directory entry. */
262	if (match_entry != NULL) {
263	fatal("TODO: I'm too lazy to"
264	" implement a correct "
265	"directory parser right "
266	"now... (BUG)\n");
267	exit(1);
268	}
269	CHECK_ALLOCATION(match_entry =
270	malloc(512));
271	memcpy(match_entry, dp, 512);
272	break;
273	}
274	}
275
276	if (match_entry != NULL)
277	break;
278
279	dirofs += len;
280	}
281
282	if (match_entry == NULL) {
283	char *blah = filename_orig;
284
285	fatal("could not find '%s' in /", filename);
286
287	/* Print the first part of the filename: */
288	while (blah != filename)
289	fatal("%c", *blah++);
290
291	fatal("\n");
292	goto ret;
293	}
294
295	fileofs = match_entry[2] + (match_entry[3] << 8) +
296	(match_entry[4] << 16) + ((uint64_t)match_entry[5] << 24);
297	filelen = match_entry[10] + (match_entry[11] << 8) +
298	(match_entry[12] << 16) + ((uint64_t)match_entry[13] << 24);
299	fileofs *= 2048;
300
301	/* debug("filelen=%llx fileofs=%llx\n", (long long)filelen,
302	(long long)fileofs); */
303
304	CHECK_ALLOCATION(filebuf = malloc(filelen));
305	tmpfname = strdup("/tmp/gxemul.XXXXXXXXXXXX");
306
307	res2 = diskimage_access(m, disk_id, disk_type, 0, fileofs, filebuf,
308	filelen);
309	if (!res2) {
310	fatal("could not read the file from the disk image!\n");
311	goto ret;
312	}
313
314	tmpfile_handle = mkstemp(tmpfname);
315	if (tmpfile_handle < 0) {
316	fatal("could not create %s\n", tmpfname);
317	exit(1);
318	}
319	write(tmpfile_handle, filebuf, filelen);
320	close(tmpfile_handle);
321
322	debug("extracted %lli bytes into %s\n", (long long)filelen, tmpfname);
323
324	/* Add the temporary filename to the load_namesp array: */
325	(*n_loadp)++;
326	CHECK_ALLOCATION(new_array = malloc(sizeof(char ) (*n_loadp)));
327	memcpy(new_array, load_namesp, sizeof(char ) * (*n_loadp));
328	*load_namesp = new_array;
329
330	/* This adds a Backspace char in front of the filename; this
331	is a special hack which causes the file to be removed once
332	it has been loaded. */
333	CHECK_ALLOCATION(tmpfname = realloc(tmpfname, strlen(tmpfname) + 2));
334	memmove(tmpfname + 1, tmpfname, strlen(tmpfname) + 1);
335	tmpfname[0] = 8;
336
337	(load_namesp)[n_loadp - 1] = tmpfname;
338
339	res = 1;
340
341	ret:
342	if (dirbuf != NULL)
343	free(dirbuf);
344
345	if (filebuf != NULL)
346	free(filebuf);
347
348	if (match_entry != NULL)
349	free(match_entry);
350
351	free(filename_orig);
352
353	debug_indentation(-iadd);
354	return res;
355	}
356