[comboot] Allow for tail recursion of COMBOOT images
[people/lynusvaz/gpxe.git] / src / arch / i386 / image / com32.c
1 /*
2  * Copyright (C) 2008 Daniel Verkamp <daniel@drv.nu>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 /**
20  * @file
21  *
22  * SYSLINUX COM32 image format
23  *
24  */
25
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <strings.h>
30 #include <errno.h>
31 #include <assert.h>
32 #include <realmode.h>
33 #include <basemem.h>
34 #include <comboot.h>
35 #include <gpxe/uaccess.h>
36 #include <gpxe/image.h>
37 #include <gpxe/segment.h>
38 #include <gpxe/init.h>
39 #include <gpxe/memmap.h>
40
41 struct image_type com32_image_type __image_type ( PROBE_NORMAL );
42
43 /**
44  * Execute COMBOOT image
45  *
46  * @v image             COM32 image
47  * @ret rc              Return status code
48  */
49 static int com32_exec ( struct image *image ) {
50         struct memory_map memmap;
51         unsigned int i;
52         int state;
53         uint32_t avail_mem_top;
54
55         state = setjmp ( comboot_return );
56
57         switch ( state ) {
58         case 0: /* First time through; invoke COM32 program */
59
60                 /* Get memory map */
61                 get_memmap ( &memmap );
62
63                 /* Find end of block covering COM32 image loading area */
64                 for ( i = 0, avail_mem_top = 0 ; i < memmap.count ; i++ ) {
65                         if ( (memmap.regions[i].start <= COM32_START_PHYS) &&
66                              (memmap.regions[i].end > COM32_START_PHYS + image->len) ) {
67                                 avail_mem_top = memmap.regions[i].end;
68                                 break;
69                         }
70                 }
71
72                 DBGC ( image, "COM32 %p: available memory top = 0x%x\n",
73                        image, avail_mem_top );
74
75                 assert ( avail_mem_top != 0 );
76
77                 com32_external_esp = phys_to_virt ( avail_mem_top );
78
79                 /* Hook COMBOOT API interrupts */
80                 hook_comboot_interrupts();
81
82                 /* Unregister image, so that a "boot" command doesn't
83                  * throw us into an execution loop.  We never
84                  * reregister ourselves; COMBOOT images expect to be
85                  * removed on exit.
86                  */
87                 unregister_image ( image );
88
89                 __asm__ __volatile__ (
90                         "movl %%esp, (com32_internal_esp)\n\t" /* Save internal virtual address space ESP */
91                         "movl (com32_external_esp), %%esp\n\t" /* Switch to COM32 ESP (top of available memory) */
92                         "call _virt_to_phys\n\t"               /* Switch to flat physical address space */
93                         "pushl %0\n\t"                         /* Pointer to CDECL helper function */
94                         "pushl %1\n\t"                         /* Pointer to FAR call helper function */
95                         "pushl %2\n\t"                         /* Size of low memory bounce buffer */
96                         "pushl %3\n\t"                         /* Pointer to low memory bounce buffer */
97                         "pushl %4\n\t"                         /* Pointer to INT call helper function */
98                         "pushl %5\n\t"                         /* Pointer to the command line arguments */
99                         "pushl $6\n\t"                         /* Number of additional arguments */
100                         "call *%6\n\t"                         /* Execute image */
101                         "call _phys_to_virt\n\t"               /* Switch back to internal virtual address space */
102                         "movl (com32_internal_esp), %%esp\n\t" /* Switch back to internal stack */
103                 :
104                 :
105                         /* %0 */ "r" ( virt_to_phys ( com32_cfarcall_wrapper ) ),
106                         /* %1 */ "r" ( virt_to_phys ( com32_farcall_wrapper ) ),
107                         /* %2 */ "r" ( get_fbms() * 1024 - (COM32_BOUNCE_SEG << 4) ),
108                         /* %3 */ "i" ( COM32_BOUNCE_SEG << 4 ),
109                         /* %4 */ "r" ( virt_to_phys ( com32_intcall_wrapper ) ),
110                         /* %5 */ "r" ( virt_to_phys ( image->cmdline ) ),
111                         /* %6 */ "r" ( COM32_START_PHYS )
112                 :
113                         "memory" );
114                 DBGC ( image, "COM32 %p: returned\n", image );
115                 break;
116
117         case COMBOOT_EXIT:
118                 DBGC ( image, "COM32 %p: exited\n", image );
119                 break;
120
121         case COMBOOT_EXIT_RUN_KERNEL:
122                 DBGC ( image, "COM32 %p: exited to run kernel %p\n",
123                        image, comboot_replacement_image );
124                 image->replacement = comboot_replacement_image;
125                 image_autoload ( image->replacement );
126                 break;
127
128         case COMBOOT_EXIT_COMMAND:
129                 DBGC ( image, "COM32 %p: exited after executing command\n",
130                        image );
131                 break;
132
133         default:
134                 assert ( 0 );
135                 break;
136         }
137
138         comboot_force_text_mode();
139
140         return 0;
141 }
142
143 /**
144  * Check image name extension
145  * 
146  * @v image             COM32 image
147  * @ret rc              Return status code
148  */
149 static int com32_identify ( struct image *image ) {
150         const char *ext;
151         static const uint8_t magic[] = { 0xB8, 0xFF, 0x4C, 0xCD, 0x21 };
152         uint8_t buf[5];
153         
154         if ( image->len >= 5 ) {
155                 /* Check for magic number
156                  * mov eax,21cd4cffh
157                  * B8 FF 4C CD 21
158                  */
159                 copy_from_user ( buf, image->data, 0, sizeof(buf) );
160                 if ( ! memcmp ( buf, magic, sizeof(buf) ) ) {
161                         DBGC ( image, "COM32 %p: found magic number\n",
162                                image );
163                         return 0;
164                 }
165         }
166
167         /* Magic number not found; check filename extension */
168
169         ext = strrchr( image->name, '.' );
170
171         if ( ! ext ) {
172                 DBGC ( image, "COM32 %p: no extension\n",
173                        image );
174                 return -ENOEXEC;
175         }
176
177         ++ext;
178
179         if ( strcasecmp( ext, "c32" ) ) {
180                 DBGC ( image, "COM32 %p: unrecognized extension %s\n",
181                        image, ext );
182                 return -ENOEXEC;
183         }
184
185         return 0;
186 }
187
188
189 /**
190  * Load COM32 image into memory
191  * @v image             COM32 image
192  * @ret rc              Return status code
193  */
194 static int comboot_load_image ( struct image *image ) {
195         size_t filesz, memsz;
196         userptr_t buffer;
197         int rc;
198
199         filesz = image->len;
200         memsz = filesz;
201         buffer = phys_to_user ( COM32_START_PHYS );
202         if ( ( rc = prep_segment ( buffer, filesz, memsz ) ) != 0 ) {
203                 DBGC ( image, "COM32 %p: could not prepare segment: %s\n",
204                        image, strerror ( rc ) );
205                 return rc;
206         }
207
208         /* Copy image to segment */
209         memcpy_user ( buffer, 0, image->data, 0, filesz );
210
211         return 0;
212 }
213
214 /**
215  * Prepare COM32 low memory bounce buffer
216  * @v image             COM32 image
217  * @ret rc              Return status code
218  */
219 static int comboot_prepare_bounce_buffer ( struct image * image ) {
220         unsigned int seg;
221         userptr_t seg_userptr;
222         size_t filesz, memsz;
223         int rc;
224
225         seg = COM32_BOUNCE_SEG;
226         seg_userptr = real_to_user ( seg, 0 );
227
228         /* Ensure the entire 64k segment is free */
229         memsz = 0xFFFF;
230         filesz = 0;
231
232         /* Prepare, verify, and load the real-mode segment */
233         if ( ( rc = prep_segment ( seg_userptr, filesz, memsz ) ) != 0 ) {
234                 DBGC ( image, "COM32 %p: could not prepare bounce buffer segment: %s\n",
235                        image, strerror ( rc ) );
236                 return rc;
237         }
238
239         return 0;
240 }
241
242 /**
243  * Load COM32 image into memory
244  *
245  * @v image             COM32 image
246  * @ret rc              Return status code
247  */
248 static int com32_load ( struct image *image ) {
249         int rc;
250
251         DBGC ( image, "COM32 %p: name '%s', cmdline '%s'\n",
252                image, image->name, image->cmdline );
253
254         /* Check if this is a COMBOOT image */
255         if ( ( rc = com32_identify ( image ) ) != 0 ) {
256                 return rc;
257         }
258
259         /* This is a COM32 image, valid or otherwise */
260         if ( ! image->type )
261                 image->type = &com32_image_type;
262
263         /* Load image */
264         if ( ( rc = comboot_load_image ( image ) ) != 0 ) {
265                 return rc;
266         }
267
268         /* Prepare bounce buffer segment */
269         if ( ( rc = comboot_prepare_bounce_buffer ( image ) ) != 0 ) {
270                 return rc;
271         }
272
273         return 0;
274 }
275
276 /** SYSLINUX COM32 image type */
277 struct image_type com32_image_type __image_type ( PROBE_NORMAL ) = {
278         .name = "COM32",
279         .load = com32_load,
280         .exec = com32_exec,
281 };