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