[comboot] Allow for tail recursion of COMBOOT images
[people/lynusvaz/gpxe.git] / src / arch / i386 / interface / syslinux / comboot_call.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 SYSLINUX COMBOOT API
21  *
22  */
23
24 #include <errno.h>
25 #include <realmode.h>
26 #include <biosint.h>
27 #include <console.h>
28 #include <stdlib.h>
29 #include <comboot.h>
30 #include <bzimage.h>
31 #include <pxe_call.h>
32 #include <setjmp.h>
33 #include <string.h>
34 #include <gpxe/posix_io.h>
35 #include <gpxe/process.h>
36 #include <gpxe/serial.h>
37 #include <gpxe/init.h>
38 #include <gpxe/image.h>
39 #include <usr/imgmgmt.h>
40
41 /** The "SYSLINUX" version string */
42 static char __data16_array ( syslinux_version, [] ) = "gPXE " VERSION;
43 #define syslinux_version __use_data16 ( syslinux_version )
44
45 /** The "SYSLINUX" copyright string */
46 static char __data16_array ( syslinux_copyright, [] ) = "http://etherboot.org";
47 #define syslinux_copyright __use_data16 ( syslinux_copyright )
48
49 static char __data16_array ( syslinux_configuration_file, [] ) = "";
50 #define syslinux_configuration_file __use_data16 ( syslinux_configuration_file )
51
52 /** Feature flags */
53 static uint8_t __data16 ( comboot_feature_flags ) = COMBOOT_FEATURE_IDLE_LOOP;
54 #define comboot_feature_flags __use_data16 ( comboot_feature_flags )
55
56 static struct segoff __text16 ( int20_vector );
57 #define int20_vector __use_text16 ( int20_vector )
58
59 static struct segoff __text16 ( int21_vector );
60 #define int21_vector __use_text16 ( int21_vector )
61
62 static struct segoff __text16 ( int22_vector );
63 #define int22_vector __use_text16 ( int22_vector )
64
65 extern void int20_wrapper ( void );
66 extern void int21_wrapper ( void );
67 extern void int22_wrapper ( void );
68
69 /* setjmp/longjmp context buffer used to return after loading an image */
70 jmp_buf comboot_return;
71
72 /* Replacement image when exiting with COMBOOT_EXIT_RUN_KERNEL */
73 struct image *comboot_replacement_image;
74
75 /* Mode flags set by INT 22h AX=0017h */
76 static uint16_t comboot_graphics_mode = 0;
77
78
79 /**
80  * Print a string with a particular terminator
81  */
82 static void print_user_string ( unsigned int segment, unsigned int offset, char terminator ) {
83         int i = 0;
84         char c;
85         userptr_t str = real_to_user ( segment, offset );
86         for ( ; ; ) {
87                 copy_from_user ( &c, str, i, 1 );
88                 if ( c == terminator ) break;
89                 putchar ( c );
90                 i++;
91         }
92 }
93
94
95 /**
96  * Perform a series of memory copies from a list in low memory
97  */
98 static void shuffle ( unsigned int list_segment, unsigned int list_offset, unsigned int count )
99 {
100         comboot_shuffle_descriptor shuf[COMBOOT_MAX_SHUFFLE_DESCRIPTORS];
101         unsigned int i;
102
103         /* Copy shuffle descriptor list so it doesn't get overwritten */
104         copy_from_user ( shuf, real_to_user ( list_segment, list_offset ), 0,
105                          count * sizeof( comboot_shuffle_descriptor ) );
106
107         /* Do the copies */
108         for ( i = 0; i < count; i++ ) {
109                 userptr_t src_u = phys_to_user ( shuf[ i ].src );
110                 userptr_t dest_u = phys_to_user ( shuf[ i ].dest );
111
112                 if ( shuf[ i ].src == 0xFFFFFFFF ) {
113                         /* Fill with 0 instead of copying */
114                         memset_user ( dest_u, 0, 0, shuf[ i ].len );
115                 } else if ( shuf[ i ].dest == 0xFFFFFFFF ) {
116                         /* Copy new list of descriptors */
117                         count = shuf[ i ].len / sizeof( comboot_shuffle_descriptor );
118                         assert ( count <= COMBOOT_MAX_SHUFFLE_DESCRIPTORS );
119                         copy_from_user ( shuf, src_u, 0, shuf[ i ].len );
120                         i = -1;
121                 } else {
122                         /* Regular copy */
123                         memmove_user ( dest_u, 0, src_u, 0, shuf[ i ].len );
124                 }
125         }
126 }
127
128
129 /**
130  * Set default text mode
131  */
132 void comboot_force_text_mode ( void ) {
133         if ( comboot_graphics_mode & COMBOOT_VIDEO_VESA ) {
134                 /* Set VGA mode 3 via VESA VBE mode set */
135                 __asm__ __volatile__ (
136                         REAL_CODE (
137                                 "mov $0x4F02, %%ax\n\t"
138                                 "mov $0x03, %%bx\n\t"
139                                 "int $0x10\n\t"
140                         )
141                 : : );
142         } else if ( comboot_graphics_mode & COMBOOT_VIDEO_GRAPHICS ) {
143                 /* Set VGA mode 3 via standard VGA mode set */
144                 __asm__ __volatile__ (
145                         REAL_CODE (
146                                 "mov $0x03, %%ax\n\t"
147                                 "int $0x10\n\t"
148                         )
149                 : : );
150         }
151
152         comboot_graphics_mode = 0;
153 }
154
155
156 /**
157  * Fetch kernel and optional initrd
158  */
159 static int comboot_fetch_kernel ( char *kernel_file, char *cmdline ) {
160         struct image *kernel;
161         struct image *initrd = NULL;
162         char *initrd_file;
163         int rc;
164
165         /* Find initrd= parameter, if any */
166         if ( ( initrd_file = strstr ( cmdline, "initrd=" ) ) != NULL ) {
167                 char *initrd_end;
168
169                 /* skip "initrd=" */
170                 initrd_file += 7;
171
172                 /* Find terminating space, if any, and replace with NUL */
173                 initrd_end = strchr ( initrd_file, ' ' );
174                 if ( initrd_end )
175                         *initrd_end = '\0';
176
177                 DBG ( "COMBOOT: fetching initrd '%s'\n", initrd_file );
178
179                 /* Allocate and fetch initrd */
180                 initrd = alloc_image();
181                 if ( ! initrd ) {
182                         DBG ( "COMBOOT: could not allocate initrd\n" );
183                         rc = -ENOMEM;
184                         goto err_alloc_initrd;
185                 }
186                 if ( ( rc = imgfetch ( initrd, initrd_file,
187                                        register_image ) ) != 0 ) {
188                         DBG ( "COMBOOT: could not fetch initrd: %s\n",
189                               strerror ( rc ) );
190                         goto err_fetch_initrd;
191                 }
192
193                 /* Restore space after initrd name, if applicable */
194                 if ( initrd_end )
195                         *initrd_end = ' ';
196         }
197
198         DBG ( "COMBOOT: fetching kernel '%s'\n", kernel_file );
199
200         /* Allocate and fetch kernel */
201         kernel = alloc_image();
202         if ( ! kernel ) {
203                 DBG ( "COMBOOT: could not allocate kernel\n" );
204                 rc = -ENOMEM;
205                 goto err_alloc_kernel;
206         }
207         if ( ( rc = imgfetch ( kernel, kernel_file,
208                                register_image ) ) != 0 ) {
209                 DBG ( "COMBOOT: could not fetch kernel: %s\n",
210                       strerror ( rc ) );
211                 goto err_fetch_kernel;
212         }
213         if ( ( rc = image_set_cmdline ( kernel, cmdline ) ) != 0 ) {
214                 DBG ( "COMBOOT: could not set kernel command line: %s\n",
215                       strerror ( rc ) );
216                 goto err_set_cmdline;
217         }
218
219         /* Store kernel as replacement image */
220         comboot_replacement_image = kernel;
221
222         return 0;
223
224  err_set_cmdline:
225  err_fetch_kernel:
226         image_put ( kernel );
227  err_alloc_kernel:
228  err_fetch_initrd:
229         image_put ( initrd );
230  err_alloc_initrd:
231         return rc;
232 }
233
234
235 /**
236  * Terminate program interrupt handler
237  */
238 static __asmcall void int20 ( struct i386_all_regs *ix86 __unused ) {
239         longjmp ( comboot_return, COMBOOT_EXIT );
240 }
241
242
243 /**
244  * DOS-compatible API
245  */
246 static __asmcall void int21 ( struct i386_all_regs *ix86 ) {
247         ix86->flags |= CF;
248
249         switch ( ix86->regs.ah ) {
250         case 0x00:
251         case 0x4C: /* Terminate program */
252                 longjmp ( comboot_return, COMBOOT_EXIT );
253                 break;
254
255         case 0x01: /* Get Key with Echo */
256         case 0x08: /* Get Key without Echo */
257                 /* TODO: handle extended characters? */
258                 ix86->regs.al = getchar( );
259
260                 /* Enter */
261                 if ( ix86->regs.al == 0x0A )
262                         ix86->regs.al = 0x0D;
263
264                 if ( ix86->regs.ah == 0x01 )
265                         putchar ( ix86->regs.al );
266
267                 ix86->flags &= ~CF;
268                 break;
269
270         case 0x02: /* Write Character */
271                 putchar ( ix86->regs.dl );
272                 ix86->flags &= ~CF;
273                 break;
274
275         case 0x04: /* Write Character to Serial Port */
276                 serial_putc ( ix86->regs.dl );
277                 ix86->flags &= ~CF;
278                 break;
279
280         case 0x09: /* Write DOS String to Console */
281                 print_user_string ( ix86->segs.ds, ix86->regs.dx, '$' );
282                 ix86->flags &= ~CF;
283                 break;
284
285         case 0x0B: /* Check Keyboard */
286                 if ( iskey() )
287                         ix86->regs.al = 0xFF;
288                 else
289                         ix86->regs.al = 0x00;
290
291                 ix86->flags &= ~CF;
292                 break;
293
294         case 0x30: /* Check DOS Version */
295                 /* Bottom halves all 0; top halves spell "SYSLINUX" */
296                 ix86->regs.eax = 0x59530000;
297                 ix86->regs.ebx = 0x4C530000;
298                 ix86->regs.ecx = 0x4E490000;
299                 ix86->regs.edx = 0x58550000;
300                 ix86->flags &= ~CF;
301                 break;
302
303         default:
304                 DBG ( "COMBOOT unknown int21 function %02x\n", ix86->regs.ah );
305                 break;
306         }
307 }
308
309
310 /**
311  * SYSLINUX API
312  */
313 static __asmcall void int22 ( struct i386_all_regs *ix86 ) {
314         ix86->flags |= CF;
315
316         switch ( ix86->regs.ax ) {
317         case 0x0001: /* Get Version */
318
319                 /* Number of INT 22h API functions available */
320                 ix86->regs.ax = 0x0018;
321
322                 /* SYSLINUX version number */
323                 ix86->regs.ch = 0; /* major */
324                 ix86->regs.cl = 0; /* minor */
325
326                 /* SYSLINUX derivative ID */
327                 ix86->regs.dl = BZI_LOADER_TYPE_GPXE;
328
329                 /* SYSLINUX version and copyright strings */
330                 ix86->segs.es = rm_ds;
331                 ix86->regs.si = ( ( unsigned ) __from_data16 ( syslinux_version ) );
332                 ix86->regs.di = ( ( unsigned ) __from_data16 ( syslinux_copyright ) );
333
334                 ix86->flags &= ~CF;
335                 break;
336
337         case 0x0002: /* Write String */
338                 print_user_string ( ix86->segs.es, ix86->regs.bx, '\0' );
339                 ix86->flags &= ~CF;
340                 break;
341
342         case 0x0003: /* Run command */
343                 {
344                         userptr_t cmd_u = real_to_user ( ix86->segs.es, ix86->regs.bx );
345                         int len = strlen_user ( cmd_u, 0 );
346                         char cmd[len + 1];
347                         copy_from_user ( cmd, cmd_u, 0, len + 1 );
348                         DBG ( "COMBOOT: executing command '%s'\n", cmd );
349                         system ( cmd );
350                         DBG ( "COMBOOT: exiting after executing command...\n" );
351                         longjmp ( comboot_return, COMBOOT_EXIT_COMMAND );
352                 }
353                 break;
354
355         case 0x0004: /* Run default command */
356                 /* FIXME: just exit for now */
357                 longjmp ( comboot_return, COMBOOT_EXIT_COMMAND );
358                 break;
359
360         case 0x0005: /* Force text mode */
361                 comboot_force_text_mode ( );
362                 ix86->flags &= ~CF;
363                 break;
364
365         case 0x0006: /* Open file */
366                 {
367                         int fd;
368                         userptr_t file_u = real_to_user ( ix86->segs.es, ix86->regs.si );
369                         int len = strlen_user ( file_u, 0 );
370                         char file[len + 1];
371
372                         copy_from_user ( file, file_u, 0, len + 1 );
373
374                         if ( file[0] == '\0' ) {
375                                 DBG ( "COMBOOT: attempted open with empty file name\n" );
376                                 break;
377                         }
378
379                         DBG ( "COMBOOT: opening file '%s'\n", file );
380
381                         fd = open ( file );
382
383                         if ( fd < 0 ) {
384                                 DBG ( "COMBOOT: error opening file %s\n", file );
385                                 break;
386                         }
387
388                         /* This relies on the fact that a gPXE POSIX fd will
389                          * always fit in 16 bits.
390                          */
391 #if (POSIX_FD_MAX > 65535)
392 #error POSIX_FD_MAX too large
393 #endif
394                         ix86->regs.si = (uint16_t) fd;
395
396                         ix86->regs.cx = COMBOOT_FILE_BLOCKSZ;
397                         ix86->regs.eax = fsize ( fd );
398                         ix86->flags &= ~CF;
399                 }
400                 break;
401
402         case 0x0007: /* Read file */
403                 {
404                         int fd = ix86->regs.si;
405                         int len = ix86->regs.cx * COMBOOT_FILE_BLOCKSZ;
406                         int rc;
407                         fd_set fds;
408                         userptr_t buf = real_to_user ( ix86->segs.es, ix86->regs.bx );
409
410                         /* Wait for data ready to read */
411                         FD_ZERO ( &fds );
412                         FD_SET ( fd, &fds );
413
414                         select ( &fds, 1 );
415
416                         rc = read_user ( fd, buf, 0, len );
417                         if ( rc < 0 ) {
418                                 DBG ( "COMBOOT: read failed\n" );
419                                 ix86->regs.si = 0;
420                                 break;
421                         }
422
423                         ix86->regs.ecx = rc;
424                         ix86->flags &= ~CF;
425                 }
426                 break;
427
428         case 0x0008: /* Close file */
429                 {
430                         int fd = ix86->regs.si;
431                         close ( fd );
432                         ix86->flags &= ~CF;
433                 }
434                 break;
435
436         case 0x0009: /* Call PXE Stack */
437                 pxe_api_call ( ix86 );
438                 ix86->flags &= ~CF;
439                 break;
440
441         case 0x000A: /* Get Derivative-Specific Information */
442
443                 /* gPXE has its own derivative ID, so there is no defined
444                  * output here; just return AL for now */
445                 ix86->regs.al = BZI_LOADER_TYPE_GPXE;
446                 ix86->flags &= ~CF;
447                 break;
448
449         case 0x000B: /* Get Serial Console Configuration */
450                 /* FIXME: stub */
451                 ix86->regs.dx = 0;
452                 ix86->flags &= ~CF;
453                 break;
454
455         case 0x000E: /* Get configuration file name */
456                 /* FIXME: stub */
457                 ix86->segs.es = rm_ds;
458                 ix86->regs.bx = ( ( unsigned ) __from_data16 ( syslinux_configuration_file ) );
459                 ix86->flags &= ~CF;
460                 break;
461
462         case 0x000F: /* Get IPAPPEND strings */
463                 /* FIXME: stub */
464                 ix86->regs.cx = 0;
465                 ix86->segs.es = 0;
466                 ix86->regs.bx = 0;
467                 ix86->flags &= ~CF;
468                 break;
469
470         case 0x0010: /* Resolve hostname */
471                 {
472                         userptr_t hostname_u = real_to_user ( ix86->segs.es, ix86->regs.bx );
473                         int len = strlen_user ( hostname_u, 0 );
474                         char hostname[len];
475                         struct in_addr addr;
476
477                         copy_from_user ( hostname, hostname_u, 0, len + 1 );
478                         
479                         /* TODO:
480                          * "If the hostname does not contain a dot (.), the
481                          * local domain name is automatically appended."
482                          */
483
484                         comboot_resolv ( hostname, &addr );
485
486                         ix86->regs.eax = addr.s_addr;
487                         ix86->flags &= ~CF;
488                 }
489                 break;
490
491         case 0x0011: /* Maximum number of shuffle descriptors */
492                 ix86->regs.cx = COMBOOT_MAX_SHUFFLE_DESCRIPTORS;
493                 ix86->flags &= ~CF;
494                 break;
495
496         case 0x0012: /* Cleanup, shuffle and boot */
497                 if ( ix86->regs.cx > COMBOOT_MAX_SHUFFLE_DESCRIPTORS )
498                         break;
499
500                 /* Perform final cleanup */
501                 shutdown ( SHUTDOWN_BOOT );
502
503                 /* Perform sequence of copies */
504                 shuffle ( ix86->segs.es, ix86->regs.di, ix86->regs.cx );
505
506                 /* Jump to real-mode entry point */
507                 __asm__ __volatile__ (
508                         REAL_CODE ( 
509                                 "pushw %0\n\t"
510                                 "popw %%ds\n\t"
511                                 "pushl %1\n\t"
512                                 "lret\n\t"
513                         )
514                         :
515                         : "r" ( ix86->segs.ds ),
516                           "r" ( ix86->regs.ebp ),
517                           "d" ( ix86->regs.ebx ),
518                           "S" ( ix86->regs.esi ) );
519
520                 assert ( 0 ); /* Execution should never reach this point */
521
522                 break;
523
524         case 0x0013: /* Idle loop call */
525                 step ( );
526                 ix86->flags &= ~CF;
527                 break;
528
529         case 0x0015: /* Get feature flags */
530                 ix86->segs.es = rm_ds;
531                 ix86->regs.bx = ( ( unsigned ) __from_data16 ( &comboot_feature_flags ) );
532                 ix86->regs.cx = 1; /* Number of feature flag bytes */
533                 ix86->flags &= ~CF;
534                 break;
535
536         case 0x0016: /* Run kernel image */
537                 {
538                         userptr_t file_u = real_to_user ( ix86->segs.ds, ix86->regs.si );
539                         userptr_t cmd_u = real_to_user ( ix86->segs.es, ix86->regs.bx );
540                         int file_len = strlen_user ( file_u, 0 );
541                         int cmd_len = strlen_user ( cmd_u, 0 );
542                         char file[file_len + 1];
543                         char cmd[cmd_len + 1];
544
545                         copy_from_user ( file, file_u, 0, file_len + 1 );
546                         copy_from_user ( cmd, cmd_u, 0, cmd_len + 1 );
547
548                         DBG ( "COMBOOT: run kernel %s %s\n", file, cmd );
549                         comboot_fetch_kernel ( file, cmd );
550                         /* Technically, we should return if we
551                          * couldn't load the kernel, but it's not safe
552                          * to do that since we have just overwritten
553                          * part of the COMBOOT program's memory space.
554                          */
555                         DBG ( "COMBOOT: exiting to run kernel...\n" );
556                         longjmp ( comboot_return, COMBOOT_EXIT_RUN_KERNEL );
557                 }
558                 break;
559
560         case 0x0017: /* Report video mode change */
561                 comboot_graphics_mode = ix86->regs.bx;
562                 ix86->flags &= ~CF;
563                 break;
564
565         case 0x0018: /* Query custom font */
566                 /* FIXME: stub */
567                 ix86->regs.al = 0;
568                 ix86->segs.es = 0;
569                 ix86->regs.bx = 0;
570                 ix86->flags &= ~CF;
571                 break;
572
573         default:
574                 DBG ( "COMBOOT unknown int22 function %04x\n", ix86->regs.ax );
575                 break;
576         }
577 }
578
579 /**
580  * Hook BIOS interrupts related to COMBOOT API (INT 20h, 21h, 22h)
581  */
582 void hook_comboot_interrupts ( ) {
583
584         __asm__ __volatile__ (
585                 TEXT16_CODE ( "\nint20_wrapper:\n\t"
586                               "pushl %0\n\t"
587                               "pushw %%cs\n\t"
588                               "call prot_call\n\t"
589                               "addw $4, %%sp\n\t"
590                               "iret\n\t" )
591                           : : "i" ( int20 ) );
592
593         hook_bios_interrupt ( 0x20, ( unsigned int ) int20_wrapper,
594                                       &int20_vector );
595
596         __asm__ __volatile__ (
597                 TEXT16_CODE ( "\nint21_wrapper:\n\t"
598                               "pushl %0\n\t"
599                               "pushw %%cs\n\t"
600                               "call prot_call\n\t"
601                               "addw $4, %%sp\n\t"
602                               "iret\n\t" )
603                           : : "i" ( int21 ) );
604
605         hook_bios_interrupt ( 0x21, ( unsigned int ) int21_wrapper,
606                               &int21_vector );
607
608         __asm__  __volatile__ (
609                 TEXT16_CODE ( "\nint22_wrapper:\n\t"
610                               "pushl %0\n\t"
611                               "pushw %%cs\n\t"
612                               "call prot_call\n\t"
613                               "addw $4, %%sp\n\t"
614                               "iret\n\t" )
615                           : : "i" ( int22) );
616
617         hook_bios_interrupt ( 0x22, ( unsigned int ) int22_wrapper,
618                               &int22_vector );
619 }