arch/x86/boot/compressed/misc.c

   1 /*
   2  * misc.c
   3  *
   4  * This is a collection of several routines from gzip-1.0.3
   5  * adapted for Linux.
   6  *
   7  * malloc by Hannu Savolainen 1993 and Matthias Urlichs 1994
   8  * puts by Nick Holloway 1993, better puts by Martin Mares 1995
   9  * High loaded stuff by Hans Lermen & Werner Almesberger, Feb. 1996
  10  */
  11
  12 /*
  13  * we have to be careful, because no indirections are allowed here, and
  14  * paravirt_ops is a kind of one. As it will only run in baremetal anyway,
  15  * we just keep it from happening
  16  */
  17 #undef CONFIG_PARAVIRT
  18 #ifdef CONFIG_X86_32
  19 #define _ASM_DESC_H_ 1
  20 #endif
  21
  22 #ifdef CONFIG_X86_64
  23 #define _LINUX_STRING_H_ 1
  24 #define __LINUX_BITMAP_H 1
  25 #endif
  26
  27 #include <linux/linkage.h>
  28 #include <linux/screen_info.h>
  29 #include <linux/elf.h>
  30 #include <asm/io.h>
  31 #include <asm/page.h>
  32 #include <asm/boot.h>
  33 #include <asm/bootparam.h>
  34
  35 /* WARNING!!
  36  * This code is compiled with -fPIC and it is relocated dynamically
  37  * at run time, but no relocation processing is performed.
  38  * This means that it is not safe to place pointers in static structures.
  39  */
  40
  41 /*
  42  * Getting to provable safe in place decompression is hard.
  43  * Worst case behaviours need to be analyzed.
  44  * Background information:
  45  *
  46  * The file layout is:
  47  *    magic[2]
  48  *    method[1]
  49  *    flags[1]
  50  *    timestamp[4]
  51  *    extraflags[1]
  52  *    os[1]
  53  *    compressed data blocks[N]
  54  *    crc[4] orig_len[4]
  55  *
  56  * resulting in 18 bytes of non compressed data overhead.
  57  *
  58  * Files divided into blocks
  59  * 1 bit (last block flag)
  60  * 2 bits (block type)
  61  *
  62  * 1 block occurs every 32K -1 bytes or when there 50% compression
  63  * has been achieved. The smallest block type encoding is always used.
  64  *
  65  * stored:
  66  *    32 bits length in bytes.
  67  *
  68  * fixed:
  69  *    magic fixed tree.
  70  *    symbols.
  71  *
  72  * dynamic:
  73  *    dynamic tree encoding.
  74  *    symbols.
  75  *
  76  *
  77  * The buffer for decompression in place is the length of the
  78  * uncompressed data, plus a small amount extra to keep the algorithm safe.
  79  * The compressed data is placed at the end of the buffer.  The output
  80  * pointer is placed at the start of the buffer and the input pointer
  81  * is placed where the compressed data starts.  Problems will occur
  82  * when the output pointer overruns the input pointer.
  83  *
  84  * The output pointer can only overrun the input pointer if the input
  85  * pointer is moving faster than the output pointer.  A condition only
  86  * triggered by data whose compressed form is larger than the uncompressed
  87  * form.
  88  *
  89  * The worst case at the block level is a growth of the compressed data
  90  * of 5 bytes per 32767 bytes.
  91  *
  92  * The worst case internal to a compressed block is very hard to figure.
  93  * The worst case can at least be boundined by having one bit that represents
  94  * 32764 bytes and then all of the rest of the bytes representing the very
  95  * very last byte.
  96  *
  97  * All of which is enough to compute an amount of extra data that is required
  98  * to be safe.  To avoid problems at the block level allocating 5 extra bytes
  99  * per 32767 bytes of data is sufficient.  To avoind problems internal to a
 100  * block adding an extra 32767 bytes (the worst case uncompressed block size)
 101  * is sufficient, to ensure that in the worst case the decompressed data for
 102  * block will stop the byte before the compressed data for a block begins.
 103  * To avoid problems with the compressed data's meta information an extra 18
 104  * bytes are needed.  Leading to the formula:
 105  *
 106  * extra_bytes = (uncompressed_size >> 12) + 32768 + 18 + decompressor_size.
 107  *
 108  * Adding 8 bytes per 32K is a bit excessive but much easier to calculate.
 109  * Adding 32768 instead of 32767 just makes for round numbers.
 110  * Adding the decompressor_size is necessary as it musht live after all
 111  * of the data as well.  Last I measured the decompressor is about 14K.
 112  * 10K of actual data and 4K of bss.
 113  *
 114  */
 115
 116 /*
 117  * gzip declarations
 118  */
 119
 120 #define OF(args)        args
 121 #define STATIC          static
 122
 123 #undef memset
 124 #undef memcpy
 125 #define memzero(s, n)   memset((s), 0, (n))
 126
 127 typedef unsigned char   uch;
 128 typedef unsigned short  ush;
 129 typedef unsigned long   ulg;
 130
 131 /*
 132  * Window size must be at least 32k, and a power of two.
 133  * We don't actually have a window just a huge output buffer,
 134  * so we report a 2G window size, as that should always be
 135  * larger than our output buffer:
 136  */
 137 #define WSIZE           0x80000000
 138
 139 /* Input buffer: */
 140 static unsigned char    *inbuf;
 141
 142 /* Sliding window buffer (and final output buffer): */
 143 static unsigned char    *window;
 144
 145 /* Valid bytes in inbuf: */
 146 static unsigned         insize;
 147
 148 /* Index of next byte to be processed in inbuf: */
 149 static unsigned         inptr;
 150
 151 /* Bytes in output buffer: */
 152 static unsigned         outcnt;
 153
 154 /* gzip flag byte */
 155 #define ASCII_FLAG      0x01 /* bit 0 set: file probably ASCII text */
 156 #define CONTINUATION    0x02 /* bit 1 set: continuation of multi-part gz file */
 157 #define EXTRA_FIELD     0x04 /* bit 2 set: extra field present */
 158 #define ORIG_NAM        0x08 /* bit 3 set: original file name present */
 159 #define COMMENT         0x10 /* bit 4 set: file comment present */
 160 #define ENCRYPTED       0x20 /* bit 5 set: file is encrypted */
 161 #define RESERVED        0xC0 /* bit 6, 7:  reserved */
 162
 163 #define get_byte()      (inptr < insize ? inbuf[inptr++] : fill_inbuf())
 164
 165 /* Diagnostic functions */
 166 #ifdef DEBUG
 167 #  define Assert(cond, msg) do { if (!(cond)) error(msg); } while (0)
 168 #  define Trace(x)      do { fprintf x; } while (0)
 169 #  define Tracev(x)     do { if (verbose) fprintf x ; } while (0)
 170 #  define Tracevv(x)    do { if (verbose > 1) fprintf x ; } while (0)
 171 #  define Tracec(c, x)  do { if (verbose && (c)) fprintf x ; } while (0)
 172 #  define Tracecv(c, x) do { if (verbose > 1 && (c)) fprintf x ; } while (0)
 173 #else
 174 #  define Assert(cond, msg)
 175 #  define Trace(x)
 176 #  define Tracev(x)
 177 #  define Tracevv(x)
 178 #  define Tracec(c, x)
 179 #  define Tracecv(c, x)
 180 #endif
 181
 182 static int  fill_inbuf(void);
 183 static void flush_window(void);
 184 static void error(char *m);
 185 static void gzip_mark(void **);
 186 static void gzip_release(void **);
 187
 188 /*
 189  * This is set up by the setup-routine at boot-time
 190  */
 191 static struct boot_params *real_mode;           /* Pointer to real-mode data */
 192 static int quiet;
 193
 194 extern unsigned char input_data[];
 195 extern int input_len;
 196
 197 static long bytes_out;
 198
 199 static void *malloc(int size);
 200 static void free(void *where);
 201
 202 static void *memset(void *s, int c, unsigned n);
 203 static void *memcpy(void *dest, const void *src, unsigned n);
 204
 205 static void __putstr(int, const char *);
 206 #define putstr(__x)  __putstr(0, __x)
 207
 208 #ifdef CONFIG_X86_64
 209 #define memptr long
 210 #else
 211 #define memptr unsigned
 212 #endif
 213
 214 static memptr free_mem_ptr;
 215 static memptr free_mem_end_ptr;
 216
 217 static char *vidmem;
 218 static int vidport;
 219 static int lines, cols;
 220
 221 #ifdef CONFIG_X86_NUMAQ
 222 void *xquad_portio;
 223 #endif
 224
 225 #include "../../../../lib/inflate.c"
 226
 227 static void *malloc(int size)
 228 {
 229         void *p;
 230
 231         if (size < 0)
 232                 error("Malloc error");
 233         if (free_mem_ptr <= 0)
 234                 error("Memory error");
 235
 236         free_mem_ptr = (free_mem_ptr + 3) & ~3; /* Align */
 237
 238         p = (void *)free_mem_ptr;
 239         free_mem_ptr += size;
 240
 241         if (free_mem_ptr >= free_mem_end_ptr)
 242                 error("Out of memory");
 243
 244         return p;
 245 }
 246
 247 static void free(void *where)
 248 {       /* Don't care */
 249 }
 250
 251 static void gzip_mark(void **ptr)
 252 {
 253         *ptr = (void *) free_mem_ptr;
 254 }
 255
 256 static void gzip_release(void **ptr)
 257 {
 258         free_mem_ptr = (memptr) *ptr;
 259 }
 260
 261 static void scroll(void)
 262 {
 263         int i;
 264
 265         memcpy(vidmem, vidmem + cols * 2, (lines - 1) * cols * 2);
 266         for (i = (lines - 1) * cols * 2; i < lines * cols * 2; i += 2)
 267                 vidmem[i] = ' ';
 268 }
 269
 270 static void __putstr(int error, const char *s)
 271 {
 272         int x, y, pos;
 273         char c;
 274
 275 #ifndef CONFIG_X86_VERBOSE_BOOTUP
 276         if (!error)
 277                 return;
 278 #endif
 279
 280 #ifdef CONFIG_X86_32
 281         if (real_mode->screen_info.orig_video_mode == 0 &&
 282             lines == 0 && cols == 0)
 283                 return;
 284 #endif
 285
 286         x = real_mode->screen_info.orig_x;
 287         y = real_mode->screen_info.orig_y;
 288
 289         while ((c = *s++) != '\0') {
 290                 if (c == '\n') {
 291                         x = 0;
 292                         if (++y >= lines) {
 293                                 scroll();
 294                                 y--;
 295                         }
 296                 } else {
 297                         vidmem [(x + cols * y) * 2] = c;
 298                         if (++x >= cols) {
 299                                 x = 0;
 300                                 if (++y >= lines) {
 301                                         scroll();
 302                                         y--;
 303                                 }
 304                         }
 305                 }
 306         }
 307
 308         real_mode->screen_info.orig_x = x;
 309         real_mode->screen_info.orig_y = y;
 310
 311         pos = (x + cols * y) * 2;       /* Update cursor position */
 312         outb(14, vidport);
 313         outb(0xff & (pos >> 9), vidport+1);
 314         outb(15, vidport);
 315         outb(0xff & (pos >> 1), vidport+1);
 316 }
 317
 318 static void *memset(void *s, int c, unsigned n)
 319 {
 320         int i;
 321         char *ss = s;
 322
 323         for (i = 0; i < n; i++) ss[i] = c;
 324         return s;
 325 }
 326
 327 static void *memcpy(void *dest, const void *src, unsigned n)
 328 {
 329         int i;
 330         const char *s = src;
 331         char *d = dest;
 332
 333         for (i = 0; i < n; i++) d[i] = s[i];
 334         return dest;
 335 }
 336
 337 /* ===========================================================================
 338  * Fill the input buffer. This is called only when the buffer is empty
 339  * and at least one byte is really needed.
 340  */
 341 static int fill_inbuf(void)
 342 {
 343         error("ran out of input data");
 344         return 0;
 345 }
 346
 347 /* ===========================================================================
 348  * Write the output window window[0..outcnt-1] and update crc and bytes_out.
 349  * (Used for the decompressed data only.)
 350  */
 351 static void flush_window(void)
 352 {
 353         /* With my window equal to my output buffer
 354          * I only need to compute the crc here.
 355          */
 356         unsigned long c = crc;         /* temporary variable */
 357         unsigned n;
 358         unsigned char *in, ch;
 359
 360         in = window;
 361         for (n = 0; n < outcnt; n++) {
 362                 ch = *in++;
 363                 c = crc_32_tab[((int)c ^ ch) & 0xff] ^ (c >> 8);
 364         }
 365         crc = c;
 366         bytes_out += (unsigned long)outcnt;
 367         outcnt = 0;
 368 }
 369
 370 static void error(char *x)
 371 {
 372         __putstr(1, "\n\n");
 373         __putstr(1, x);
 374         __putstr(1, "\n\n -- System halted");
 375
 376         while (1)
 377                 asm("hlt");
 378 }
 379
 380 static void parse_elf(void *output)
 381 {
 382 #ifdef CONFIG_X86_64
 383         Elf64_Ehdr ehdr;
 384         Elf64_Phdr *phdrs, *phdr;
 385 #else
 386         Elf32_Ehdr ehdr;
 387         Elf32_Phdr *phdrs, *phdr;
 388 #endif
 389         void *dest;
 390         int i;
 391
 392         memcpy(&ehdr, output, sizeof(ehdr));
 393         if (ehdr.e_ident[EI_MAG0] != ELFMAG0 ||
 394            ehdr.e_ident[EI_MAG1] != ELFMAG1 ||
 395            ehdr.e_ident[EI_MAG2] != ELFMAG2 ||
 396            ehdr.e_ident[EI_MAG3] != ELFMAG3) {
 397                 error("Kernel is not a valid ELF file");
 398                 return;
 399         }
 400
 401         if (!quiet)
 402                 putstr("Parsing ELF... ");
 403
 404         phdrs = malloc(sizeof(*phdrs) * ehdr.e_phnum);
 405         if (!phdrs)
 406                 error("Failed to allocate space for phdrs");
 407
 408         memcpy(phdrs, output + ehdr.e_phoff, sizeof(*phdrs) * ehdr.e_phnum);
 409
 410         for (i = 0; i < ehdr.e_phnum; i++) {
 411                 phdr = &phdrs[i];
 412
 413                 switch (phdr->p_type) {
 414                 case PT_LOAD:
 415 #ifdef CONFIG_RELOCATABLE
 416                         dest = output;
 417                         dest += (phdr->p_paddr - LOAD_PHYSICAL_ADDR);
 418 #else
 419                         dest = (void *)(phdr->p_paddr);
 420 #endif
 421                         memcpy(dest,
 422                                output + phdr->p_offset,
 423                                phdr->p_filesz);
 424                         break;
 425                 default: /* Ignore other PT_* */ break;
 426                 }
 427         }
 428 }
 429
 430 asmlinkage void decompress_kernel(void *rmode, memptr heap,
 431                                   unsigned char *input_data,
 432                                   unsigned long input_len,
 433                                   unsigned char *output)
 434 {
 435         real_mode = rmode;
 436
 437         if (real_mode->hdr.loadflags & QUIET_FLAG)
 438                 quiet = 1;
 439
 440         if (real_mode->screen_info.orig_video_mode == 7) {
 441                 vidmem = (char *) 0xb0000;
 442                 vidport = 0x3b4;
 443         } else {
 444                 vidmem = (char *) 0xb8000;
 445                 vidport = 0x3d4;
 446         }
 447
 448         lines = real_mode->screen_info.orig_video_lines;
 449         cols = real_mode->screen_info.orig_video_cols;
 450
 451         window = output;                /* Output buffer (Normally at 1M) */
 452         free_mem_ptr     = heap;        /* Heap */
 453         free_mem_end_ptr = heap + BOOT_HEAP_SIZE;
 454         inbuf  = input_data;            /* Input buffer */
 455         insize = input_len;
 456         inptr  = 0;
 457
 458 #ifdef CONFIG_X86_64
 459         if ((unsigned long)output & (__KERNEL_ALIGN - 1))
 460                 error("Destination address not 2M aligned");
 461         if ((unsigned long)output >= 0xffffffffffUL)
 462                 error("Destination address too large");
 463 #else
 464         if ((u32)output & (CONFIG_PHYSICAL_ALIGN - 1))
 465                 error("Destination address not CONFIG_PHYSICAL_ALIGN aligned");
 466         if (heap > ((-__PAGE_OFFSET-(512<<20)-1) & 0x7fffffff))
 467                 error("Destination address too large");
 468 #ifndef CONFIG_RELOCATABLE
 469         if ((u32)output != LOAD_PHYSICAL_ADDR)
 470                 error("Wrong destination address");
 471 #endif
 472 #endif
 473
 474         makecrc();
 475         if (!quiet)
 476                 putstr("\nDecompressing Linux... ");
 477         gunzip();
 478         parse_elf(output);
 479         if (!quiet)
 480                 putstr("done.\nBooting the kernel.\n");
 481         return;
 482 }