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