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