[iSCSI] Support Windows Server 2008 direct iSCSI installation
[people/mdeck/gpxe.git] / src / arch / i386 / image / bzimage.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
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  * Linux bzImage image format
23  *
24  */
25
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <assert.h>
31 #include <realmode.h>
32 #include <bzimage.h>
33 #include <gpxe/uaccess.h>
34 #include <gpxe/image.h>
35 #include <gpxe/segment.h>
36 #include <gpxe/init.h>
37 #include <gpxe/cpio.h>
38 #include <gpxe/features.h>
39
40 FEATURE ( FEATURE_IMAGE, "bzImage", DHCP_EB_FEATURE_BZIMAGE, 1 );
41
42 struct image_type bzimage_image_type __image_type ( PROBE_NORMAL );
43
44 /**
45  * bzImage load context
46  */
47 struct bzimage_load_context {
48         /** Real-mode kernel portion load segment address */
49         unsigned int rm_kernel_seg;
50         /** Real-mode kernel portion load address */
51         userptr_t rm_kernel;
52         /** Real-mode kernel portion file size */
53         size_t rm_filesz;
54         /** Real-mode heap top (offset from rm_kernel) */
55         size_t rm_heap;
56         /** Command line (offset from rm_kernel) */
57         size_t rm_cmdline;
58         /** Real-mode kernel portion total memory size */
59         size_t rm_memsz;
60         /** Non-real-mode kernel portion load address */
61         userptr_t pm_kernel;
62         /** Non-real-mode kernel portion file and memory size */
63         size_t pm_sz;
64 };
65
66 /**
67  * bzImage execution context
68  */
69 struct bzimage_exec_context {
70         /** Real-mode kernel portion load segment address */
71         unsigned int rm_kernel_seg;
72         /** Real-mode kernel portion load address */
73         userptr_t rm_kernel;
74         /** Real-mode heap top (offset from rm_kernel) */
75         size_t rm_heap;
76         /** Command line (offset from rm_kernel) */
77         size_t rm_cmdline;
78         /** Command line maximum length */
79         size_t cmdline_size;
80         /** Video mode */
81         unsigned int vid_mode;
82         /** Memory limit */
83         uint64_t mem_limit;
84         /** Initrd address */
85         physaddr_t ramdisk_image;
86         /** Initrd size */
87         physaddr_t ramdisk_size;
88 };
89
90 /**
91  * Parse kernel command line for bootloader parameters
92  *
93  * @v image             bzImage file
94  * @v exec_ctx          Execution context
95  * @v cmdline           Kernel command line
96  * @ret rc              Return status code
97  */
98 static int bzimage_parse_cmdline ( struct image *image,
99                                    struct bzimage_exec_context *exec_ctx,
100                                    const char *cmdline ) {
101         char *vga;
102         char *mem;
103
104         /* Look for "vga=" */
105         if ( ( vga = strstr ( cmdline, "vga=" ) ) ) {
106                 vga += 4;
107                 if ( strcmp ( vga, "normal" ) == 0 ) {
108                         exec_ctx->vid_mode = BZI_VID_MODE_NORMAL;
109                 } else if ( strcmp ( vga, "ext" ) == 0 ) {
110                         exec_ctx->vid_mode = BZI_VID_MODE_EXT;
111                 } else if ( strcmp ( vga, "ask" ) == 0 ) {
112                         exec_ctx->vid_mode = BZI_VID_MODE_ASK;
113                 } else {
114                         exec_ctx->vid_mode = strtoul ( vga, &vga, 0 );
115                         if ( *vga && ( *vga != ' ' ) ) {
116                                 DBGC ( image, "bzImage %p strange \"vga=\""
117                                        "terminator '%c'\n", image, *vga );
118                         }
119                 }
120         }
121
122         /* Look for "mem=" */
123         if ( ( mem = strstr ( cmdline, "mem=" ) ) ) {
124                 mem += 4;
125                 exec_ctx->mem_limit = strtoul ( mem, &mem, 0 );
126                 switch ( *mem ) {
127                 case 'G':
128                 case 'g':
129                         exec_ctx->mem_limit <<= 10;
130                 case 'M':
131                 case 'm':
132                         exec_ctx->mem_limit <<= 10;
133                 case 'K':
134                 case 'k':
135                         exec_ctx->mem_limit <<= 10;
136                         break;
137                 case '\0':
138                 case ' ':
139                         break;
140                 default:
141                         DBGC ( image, "bzImage %p strange \"mem=\" "
142                                "terminator '%c'\n", image, *mem );
143                         break;
144                 }
145                 exec_ctx->mem_limit -= 1;
146         }
147
148         return 0;
149 }
150
151 /**
152  * Set command line
153  *
154  * @v image             bzImage image
155  * @v exec_ctx          Execution context
156  * @v cmdline           Kernel command line
157  * @ret rc              Return status code
158  */
159 static int bzimage_set_cmdline ( struct image *image,
160                                  struct bzimage_exec_context *exec_ctx,
161                                  const char *cmdline ) {
162         size_t cmdline_len;
163
164         /* Copy command line down to real-mode portion */
165         cmdline_len = ( strlen ( cmdline ) + 1 );
166         if ( cmdline_len > exec_ctx->cmdline_size )
167                 cmdline_len = exec_ctx->cmdline_size;
168         copy_to_user ( exec_ctx->rm_kernel, exec_ctx->rm_cmdline,
169                        cmdline, cmdline_len );
170         DBGC ( image, "bzImage %p command line \"%s\"\n", image, cmdline );
171
172         return 0;
173 }
174
175 /**
176  * Load initrd
177  *
178  * @v image             bzImage image
179  * @v initrd            initrd image
180  * @v address           Address at which to load, or UNULL
181  * @ret len             Length of loaded image, rounded up to 4 bytes
182  */
183 static size_t bzimage_load_initrd ( struct image *image,
184                                     struct image *initrd,
185                                     userptr_t address ) {
186         char *filename = initrd->cmdline;
187         struct cpio_header cpio;
188         size_t offset = 0;
189
190         /* Do not include kernel image itself as an initrd */
191         if ( initrd == image )
192                 return 0;
193
194         /* Create cpio header before non-prebuilt images */
195         if ( filename && filename[0] ) {
196                 size_t name_len = ( strlen ( filename ) + 1 );
197
198                 DBGC ( image, "bzImage %p inserting initrd %p as %s\n",
199                        image, initrd, filename );
200                 memset ( &cpio, '0', sizeof ( cpio ) );
201                 memcpy ( cpio.c_magic, CPIO_MAGIC, sizeof ( cpio.c_magic ) );
202                 cpio_set_field ( cpio.c_mode, 0100644 );
203                 cpio_set_field ( cpio.c_nlink, 1 );
204                 cpio_set_field ( cpio.c_filesize, initrd->len );
205                 cpio_set_field ( cpio.c_namesize, name_len );
206                 if ( address ) {
207                         copy_to_user ( address, offset, &cpio,
208                                        sizeof ( cpio ) );
209                 }
210                 offset += sizeof ( cpio );
211                 if ( address ) {
212                         copy_to_user ( address, offset, filename,
213                                        name_len );
214                 }
215                 offset += name_len;
216                 offset = ( ( offset + 0x03 ) & ~0x03 );
217         }
218
219         /* Copy in initrd image body */
220         if ( address ) {
221                 DBGC ( image, "bzImage %p has initrd %p at [%lx,%lx)\n",
222                        image, initrd, address, ( address + offset ) );
223                 memcpy_user ( address, offset, initrd->data, 0,
224                               initrd->len );
225         }
226         offset += initrd->len;
227
228         offset = ( ( offset + 0x03 ) & ~0x03 );
229         return offset;
230 }
231
232 /**
233  * Load initrds, if any
234  *
235  * @v image             bzImage image
236  * @v exec_ctx          Execution context
237  * @ret rc              Return status code
238  */
239 static int bzimage_load_initrds ( struct image *image,
240                                   struct bzimage_exec_context *exec_ctx ) {
241         struct image *initrd;
242         size_t total_len = 0;
243         physaddr_t address;
244         int rc;
245
246         /* Add up length of all initrd images */
247         for_each_image ( initrd ) {
248                 total_len += bzimage_load_initrd ( image, initrd, UNULL );
249         }
250
251         /* Give up if no initrd images found */
252         if ( ! total_len )
253                 return 0;
254
255         /* Find a suitable start address.  Try 1MB boundaries,
256          * starting from the downloaded kernel image itself and
257          * working downwards until we hit an available region.
258          */
259         for ( address = ( user_to_phys ( image->data, 0 ) & ~0xfffff ) ; ;
260               address -= 0x100000 ) {
261                 /* Check that we're not going to overwrite the
262                  * kernel itself.  This check isn't totally
263                  * accurate, but errs on the side of caution.
264                  */
265                 if ( address <= ( BZI_LOAD_HIGH_ADDR + image->len ) ) {
266                         DBGC ( image, "bzImage %p could not find a location "
267                                "for initrd\n", image );
268                         return -ENOBUFS;
269                 }
270                 /* Check that we are within the kernel's range */
271                 if ( ( address + total_len - 1 ) > exec_ctx->mem_limit )
272                         continue;
273                 /* Prepare and verify segment */
274                 if ( ( rc = prep_segment ( phys_to_user ( address ), 0,
275                                            total_len ) ) != 0 )
276                         continue;
277                 /* Use this address */
278                 break;
279         }
280
281         /* Record initrd location */
282         exec_ctx->ramdisk_image = address;
283         exec_ctx->ramdisk_size = total_len;
284
285         /* Construct initrd */
286         DBGC ( image, "bzImage %p constructing initrd at [%lx,%lx)\n",
287                image, address, ( address + total_len ) );
288         for_each_image ( initrd ) {
289                 address += bzimage_load_initrd ( image, initrd,
290                                                  phys_to_user ( address ) );
291         }
292
293         return 0;
294 }
295
296 /**
297  * Execute bzImage image
298  *
299  * @v image             bzImage image
300  * @ret rc              Return status code
301  */
302 static int bzimage_exec ( struct image *image ) {
303         struct bzimage_exec_context exec_ctx;
304         struct bzimage_header bzhdr;
305         const char *cmdline = ( image->cmdline ? image->cmdline : "" );
306         int rc;
307
308         /* Initialise context */
309         memset ( &exec_ctx, 0, sizeof ( exec_ctx ) );
310
311         /* Retrieve kernel header */
312         exec_ctx.rm_kernel_seg = image->priv.ul;
313         exec_ctx.rm_kernel = real_to_user ( exec_ctx.rm_kernel_seg, 0 );
314         copy_from_user ( &bzhdr, exec_ctx.rm_kernel, BZI_HDR_OFFSET,
315                          sizeof ( bzhdr ) );
316         exec_ctx.rm_cmdline = exec_ctx.rm_heap = 
317                 ( bzhdr.heap_end_ptr + 0x200 );
318         exec_ctx.vid_mode = bzhdr.vid_mode;
319         if ( bzhdr.version >= 0x0203 ) {
320                 exec_ctx.mem_limit = bzhdr.initrd_addr_max;
321         } else {
322                 exec_ctx.mem_limit = BZI_INITRD_MAX;
323         }
324         if ( bzhdr.version >= 0x0206 ) {
325                 exec_ctx.cmdline_size = bzhdr.cmdline_size;
326         } else {
327                 exec_ctx.cmdline_size = BZI_CMDLINE_SIZE;
328         }
329         DBG ( "cmdline_size = %zd\n", exec_ctx.cmdline_size );
330
331         /* Parse command line for bootloader parameters */
332         if ( ( rc = bzimage_parse_cmdline ( image, &exec_ctx, cmdline ) ) != 0)
333                 return rc;
334
335         /* Store command line */
336         if ( ( rc = bzimage_set_cmdline ( image, &exec_ctx, cmdline ) ) != 0 )
337                 return rc;
338
339         /* Load any initrds */
340         if ( ( rc = bzimage_load_initrds ( image, &exec_ctx ) ) != 0 )
341                 return rc;
342
343         /* Update and store kernel header */
344         bzhdr.vid_mode = exec_ctx.vid_mode;
345         bzhdr.ramdisk_image = exec_ctx.ramdisk_image;
346         bzhdr.ramdisk_size = exec_ctx.ramdisk_size;
347         copy_to_user ( exec_ctx.rm_kernel, BZI_HDR_OFFSET, &bzhdr,
348                        sizeof ( bzhdr ) );
349
350         /* Prepare for exiting */
351         shutdown ( SHUTDOWN_BOOT );
352
353         DBGC ( image, "bzImage %p jumping to RM kernel at %04x:0000 "
354                "(stack %04x:%04zx)\n", image,
355                ( exec_ctx.rm_kernel_seg + 0x20 ),
356                exec_ctx.rm_kernel_seg, exec_ctx.rm_heap );
357
358         /* Jump to the kernel */
359         __asm__ __volatile__ ( REAL_CODE ( "movw %w0, %%ds\n\t"
360                                            "movw %w0, %%es\n\t"
361                                            "movw %w0, %%fs\n\t"
362                                            "movw %w0, %%gs\n\t"
363                                            "movw %w0, %%ss\n\t"
364                                            "movw %w1, %%sp\n\t"
365                                            "pushw %w2\n\t"
366                                            "pushw $0\n\t"
367                                            "lret\n\t" )
368                                : : "r" ( exec_ctx.rm_kernel_seg ),
369                                    "r" ( exec_ctx.rm_heap ),
370                                    "r" ( exec_ctx.rm_kernel_seg + 0x20 ) );
371
372         /* There is no way for the image to return, since we provide
373          * no return address.
374          */
375         assert ( 0 );
376
377         return -ECANCELED; /* -EIMPOSSIBLE */
378 }
379
380 /**
381  * Load and parse bzImage header
382  *
383  * @v image             bzImage file
384  * @v load_ctx          Load context
385  * @v bzhdr             Buffer for bzImage header
386  * @ret rc              Return status code
387  */
388 static int bzimage_load_header ( struct image *image,
389                                  struct bzimage_load_context *load_ctx,
390                                  struct bzimage_header *bzhdr ) {
391
392         /* Sanity check */
393         if ( image->len < ( BZI_HDR_OFFSET + sizeof ( *bzhdr ) ) ) {
394                 DBGC ( image, "bzImage %p too short for kernel header\n",
395                        image );
396                 return -ENOEXEC;
397         }
398
399         /* Read and verify header */
400         copy_from_user ( bzhdr, image->data, BZI_HDR_OFFSET,
401                          sizeof ( *bzhdr ) );
402         if ( bzhdr->header != BZI_SIGNATURE ) {
403                 DBGC ( image, "bzImage %p bad signature %08lx\n",
404                        image, bzhdr->header );
405                 return -ENOEXEC;
406         }
407
408         /* We don't support ancient kernels */
409         if ( bzhdr->version < 0x0200 ) {
410                 DBGC ( image, "bzImage %p version %04x not supported\n",
411                        image, bzhdr->version );
412                 return -ENOTSUP;
413         }
414
415         /* Calculate load address and size of real-mode portion */
416         load_ctx->rm_kernel_seg = ( ( bzhdr->loadflags & BZI_LOAD_HIGH ) ?
417                                     0x1000 :  /* 1000:0000 (bzImage) */
418                                     0x9000 ); /* 9000:0000 (zImage) */
419         load_ctx->rm_kernel = real_to_user ( load_ctx->rm_kernel_seg, 0 );
420         load_ctx->rm_filesz =
421                 ( ( bzhdr->setup_sects ? bzhdr->setup_sects : 4 ) + 1 ) << 9;
422         load_ctx->rm_memsz = BZI_ASSUMED_RM_SIZE;
423         if ( load_ctx->rm_filesz > image->len ) {
424                 DBGC ( image, "bzImage %p too short for %zd byte of setup\n",
425                        image, load_ctx->rm_filesz );
426                 return -ENOEXEC;
427         }
428
429         /* Calculate load address and size of non-real-mode portion */
430         load_ctx->pm_kernel = ( ( bzhdr->loadflags & BZI_LOAD_HIGH ) ?
431                                 phys_to_user ( BZI_LOAD_HIGH_ADDR ) :
432                                 phys_to_user ( BZI_LOAD_LOW_ADDR ) );
433         load_ctx->pm_sz = ( image->len - load_ctx->rm_filesz );
434
435         DBGC ( image, "bzImage %p version %04x RM %#zx bytes PM %#zx bytes\n",
436                image, bzhdr->version, load_ctx->rm_filesz, load_ctx->pm_sz );
437         return 0;
438 }
439
440 /**
441  * Load real-mode portion of bzImage
442  *
443  * @v image             bzImage file
444  * @v load_ctx          Load context
445  * @ret rc              Return status code
446  */
447 static int bzimage_load_real ( struct image *image,
448                                struct bzimage_load_context *load_ctx ) {
449         int rc;
450
451         /* Allow space for the stack and heap */
452         load_ctx->rm_memsz += BZI_STACK_SIZE;
453         load_ctx->rm_heap = load_ctx->rm_memsz;
454
455         /* Allow space for the command line */
456         load_ctx->rm_cmdline = load_ctx->rm_memsz;
457         load_ctx->rm_memsz += BZI_CMDLINE_SIZE;
458
459         /* Prepare, verify, and load the real-mode segment */
460         if ( ( rc = prep_segment ( load_ctx->rm_kernel, load_ctx->rm_filesz,
461                                    load_ctx->rm_memsz ) ) != 0 ) {
462                 DBGC ( image, "bzImage %p could not prepare RM segment: %s\n",
463                        image, strerror ( rc ) );
464                 return rc;
465         }
466         memcpy_user ( load_ctx->rm_kernel, 0, image->data, 0,
467                       load_ctx->rm_filesz );
468
469         return 0;
470 }
471
472 /**
473  * Load non-real-mode portion of bzImage
474  *
475  * @v image             bzImage file
476  * @v load_ctx          Load context
477  * @ret rc              Return status code
478  */
479 static int bzimage_load_non_real ( struct image *image,
480                                    struct bzimage_load_context *load_ctx ) {
481         int rc;
482
483         /* Prepare, verify and load the non-real-mode segment */
484         if ( ( rc = prep_segment ( load_ctx->pm_kernel, load_ctx->pm_sz,
485                                    load_ctx->pm_sz ) ) != 0 ) {
486                 DBGC ( image, "bzImage %p could not prepare PM segment: %s\n",
487                        image, strerror ( rc ) );
488                 return rc;
489         }
490         memcpy_user ( load_ctx->pm_kernel, 0, image->data, load_ctx->rm_filesz,
491                       load_ctx->pm_sz );
492
493         return 0;
494 }
495
496 /**
497  * Update and store bzImage header
498  *
499  * @v image             bzImage file
500  * @v load_ctx          Load context
501  * @v bzhdr             Original bzImage header
502  * @ret rc              Return status code
503  */
504 static int bzimage_write_header ( struct image *image __unused,
505                                   struct bzimage_load_context *load_ctx,
506                                   struct bzimage_header *bzhdr ) {
507         struct bzimage_cmdline cmdline;
508
509         /* Update the header and copy it into the loaded kernel */
510         bzhdr->type_of_loader = BZI_LOADER_TYPE_GPXE;
511         if ( bzhdr->version >= 0x0201 ) {
512                 bzhdr->heap_end_ptr = ( load_ctx->rm_heap - 0x200 );
513                 bzhdr->loadflags |= BZI_CAN_USE_HEAP;
514         }
515         if ( bzhdr->version >= 0x0202 ) {
516                 bzhdr->cmd_line_ptr = user_to_phys ( load_ctx->rm_kernel,
517                                                      load_ctx->rm_cmdline );
518         } else {
519                 cmdline.magic = BZI_CMDLINE_MAGIC;
520                 cmdline.offset = load_ctx->rm_cmdline;
521                 copy_to_user ( load_ctx->rm_kernel, BZI_CMDLINE_OFFSET,
522                                &cmdline, sizeof ( cmdline ) );
523                 bzhdr->setup_move_size = load_ctx->rm_memsz;
524         }
525         copy_to_user ( load_ctx->rm_kernel, BZI_HDR_OFFSET,
526                        bzhdr, sizeof ( *bzhdr ) );
527
528         return 0;
529 }
530
531 /**
532  * Load bzImage image into memory
533  *
534  * @v image             bzImage file
535  * @ret rc              Return status code
536  */
537 int bzimage_load ( struct image *image ) {
538         struct bzimage_load_context load_ctx;
539         struct bzimage_header bzhdr;
540         int rc;
541
542         /* Initialise context */
543         memset ( &load_ctx, 0, sizeof ( load_ctx ) );
544
545         /* Load and verify header */
546         if ( ( rc = bzimage_load_header ( image, &load_ctx, &bzhdr ) ) != 0 )
547                 return rc;
548
549         /* This is a bzImage image, valid or otherwise */
550         if ( ! image->type )
551                 image->type = &bzimage_image_type;
552
553         /* Load real-mode portion */
554         if ( ( rc = bzimage_load_real ( image, &load_ctx ) ) != 0 )
555                 return rc;
556
557         /* Load non-real-mode portion */
558         if ( ( rc = bzimage_load_non_real ( image, &load_ctx ) ) != 0 )
559                 return rc;
560
561         /* Update and write out header */
562         if ( ( rc = bzimage_write_header ( image, &load_ctx, &bzhdr ) ) != 0 )
563                 return rc;
564
565         /* Record real-mode segment in image private data field */
566         image->priv.ul = load_ctx.rm_kernel_seg;
567
568         return 0;
569 }
570
571 /** Linux bzImage image type */
572 struct image_type bzimage_image_type __image_type ( PROBE_NORMAL ) = {
573         .name = "bzImage",
574         .load = bzimage_load,
575         .exec = bzimage_exec,
576 };