git.gag.com Git - debian/elilo/blob - x86_64/gzip.c

   1 /*
   2  *  Copyright (C) 2001-2002 Hewlett-Packard Co.
   3  *      Contributed by Stephane Eranian <eranian@hpl.hp.com>
   4  *
   5  *  Copyright (C) 2001 Silicon Graphics, Inc.
   6  *      Contributed by Brent Casavant <bcasavan@sgi.com>
   7  *
   8  *  Copyright (C) 2006-2009 Intel Corporation
   9  *      Contributed by Fenghua Yu <fenghua.yu@intel.com>
  10  *      Contributed by Bibo Mao <bibo.mao@intel.com>
  11  *      Contributed by Chandramouli Narayanan <mouli@linux.intel.com>
  12  *
  13  * This file is part of the ELILO, the EFI Linux boot loader.
  14  *
  15  *  ELILO is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2, or (at your option)
  18  *  any later version.
  19  *
  20  *  ELILO is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with ELILO; see the file COPYING.  If not, write to the Free
  27  *  Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  28  *  02111-1307, USA.
  29  *
  30  * Please check out the elilo.txt for complete documentation on how
  31  * to use this program.
  32  */
  33
  34 #include <efi.h>
  35 #include <efilib.h>
  36
  37 #include "elf.h"
  38 #include "elilo.h"
  39 #include "gzip.h"
  40 #include "private.h"
  41
  42 #define memzero(s, n)   Memset((VOID *)(s), 0, (n))
  43 #define memcpy(a,b,n)   Memcpy((VOID *)(a),(b),(n))
  44
  45 /* size of output buffer */
  46 #define WSIZE 0x8000            /* Window size must be at least 32k, */
  47                                 /* and a power of two */
  48 /* size of input buffer */
  49 #define INBUFSIZE 0x8000
  50
  51 /*
  52  * gzip declarations
  53  */
  54
  55 #define OF(args)  args
  56 #define FUNC_STATIC static
  57
  58 typedef unsigned char  uch;
  59 typedef unsigned short ush;
  60 typedef unsigned long  ulg;
  61
  62
  63 typedef struct segment {
  64         unsigned long addr;     /* start address */
  65         unsigned long offset;   /* file offset   */
  66         unsigned long size;     /* file size     */
  67         unsigned long bss_sz;   /* BSS size      */
  68         UINT8   flags;  /* indicates whether to load or not */
  69 } segment_t;
  70
  71 #define CHUNK_FL_VALID          0x1
  72 #define CHUNK_FL_LOAD           0x2
  73
  74 #define CHUNK_CAN_LOAD(n)       chunks[(n)].flags |= CHUNK_FL_LOAD
  75 #define CHUNK_NO_LOAD(n)        chunks[(n)].flags &= ~CHUNK_FL_LOAD
  76 #define CHUNK_IS_LOAD(n)        (chunks[(n)].flags & CHUNK_FL_LOAD)
  77
  78 #define CHUNK_VALIDATE(n)       chunks[(n)].flags |= CHUNK_FL_VALID
  79 #define CHUNK_INVALIDATE(n)     chunks[(n)].flags = 0
  80 #define CHUNK_IS_VALID(n)       (chunks[(n)].flags & CHUNK_FL_VALID)
  81
  82 /*
  83  * static parameters to gzip helper functions
  84  * we cannot use paramters because API was not
  85  * designed that way
  86  */
  87 static segment_t *chunks;       /* holds the list of segments */
  88 static segment_t *cur_chunk;
  89 static UINTN nchunks;
  90 static UINTN chunk;                 /* current segment */
  91 static UINTN input_fd;
  92 static VOID *kernel_entry, *kernel_base, *kernel_end;
  93
  94 static uch *inbuf;              /* input buffer (compressed data) */
  95 static uch *window;             /* output buffer (uncompressed data) */
  96 static unsigned long file_offset;       /* position in the file */
  97
  98 static unsigned insize = 0;  /* valid bytes in inbuf */
  99 static unsigned inptr  = 0;   /* index of next byte to be processed in inbuf */
 100 static unsigned outcnt = 0;  /* bytes in output buffer */
 101
 102 /* gzip flag byte */
 103 #define ASCII_FLAG   0x01 /* bit 0 set: file probably ASCII text */
 104 #define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
 105 #define EXTRA_FIELD  0x04 /* bit 2 set: extra field present */
 106 #define ORIG_NAME    0x08 /* bit 3 set: original file name present */
 107 #define COMMENT      0x10 /* bit 4 set: file comment present */
 108 #define ENCRYPTED    0x20 /* bit 5 set: file is encrypted */
 109 #define RESERVED     0xC0 /* bit 6,7:   reserved */
 110
 111 #define get_byte()  (inptr < insize ? inbuf[inptr++] : fill_inbuf())
 112
 113 /* Diagnostic functions */
 114 #ifdef INFLATE_DEBUG
 115 #  define Assert(cond,msg) {if(!(cond)) error(msg);}
 116 int stderr;
 117 #  define Trace(x) Print(L"line %d:\n", __LINE__);
 118 #  define Tracev(x) {if (verbose) Print(L"line %d:\n", __LINE__) ;}
 119 #  define Tracevv(x) {if (verbose>1) Print(L"line %d:\n", __LINE__)  ;}
 120 #  define Tracec(c,x) {if (verbose && (c))  Print(L"line %d:\n", __LINE__) ;}
 121 #  define Tracecv(c,x) {if (verbose>1 && (c))  Print(L"line %d:\n", __LINE__) ;}
 122 #else
 123 #  define Assert(cond,msg)
 124 #  define Trace(x)
 125 #  define Tracev(x)
 126 #  define Tracevv(x)
 127 #  define Tracec(c,x)
 128 #  define Tracecv(c,x)
 129 #endif
 130
 131 static int  fill_inbuf(void);
 132 static void flush_window(void);
 133 static void error(char *m);
 134 static long bytes_out;
 135 static void error(char *m);
 136 static int error_return;
 137
 138 static void *
 139 gzip_malloc(int size)
 140 {
 141         return (void *)alloc(size, 0);
 142 }
 143
 144 static void
 145 gzip_free(void *where)
 146 {
 147         return free(where);
 148 }
 149
 150 #include "inflate.c"
 151
 152 /*
 153  * Fill the input buffer and return the first byte in it. This is called
 154  * only when the buffer is empty and at least one byte is really needed.
 155  */
 156 int
 157 fill_inbuf(void)
 158 {
 159         UINTN expected, nread;
 160         EFI_STATUS status;
 161
 162         expected = nread = INBUFSIZE;
 163
 164         status = fops_read(input_fd, inbuf, &nread);
 165         if (EFI_ERROR(status)) {
 166                 error("elilo: Read failed");
 167         }
 168         DBG_PRT((L"%s : read %d bytes of %d bytes\n", LD_NAME, nread, expected));
 169
 170         insize = nread;
 171         inptr = 1;
 172
 173         return inbuf[0];
 174 }
 175
 176 /* ===========================================================================
 177  * Write the output window window[0..outcnt-1] and update crc and bytes_out.
 178  * (Used for the decompressed data only.)
 179  */
 180
 181 /*
 182  * Run a set of bytes through the crc shift register.  If s is a NULL
 183  * pointer, then initialize the crc shift register contents instead.
 184  * Return the current crc in either case.
 185  *
 186  * Input:
 187  *      S       pointer to bytes to pump through.
 188  *      N       number of bytes in S[].
 189  */
 190 unsigned long
 191 updcrc(unsigned char *s, unsigned n)
 192 {
 193         register unsigned long c;
 194         /* crc is defined in inflate.c */
 195
 196         if (!s) {
 197                 c = 0xffffffffL;
 198         } else {
 199                 c = crc;
 200                 while (n--) {
 201                         c = crc_32_tab[((int)c ^ (*s++)) & 0xff] ^ (c >> 8);
 202                 }
 203         }
 204         crc = c;
 205         return c ^ 0xffffffffUL;       /* (instead of ~c for 64-bit machines) */
 206 }
 207
 208
 209 /*
 210  * Clear input and output buffers
 211  */
 212 void
 213 clear_bufs(void)
 214 {
 215         outcnt = 0;
 216         inptr = 0;
 217         chunk = 0;
 218         cur_chunk = NULL;
 219         file_offset = 0;
 220 }
 221
 222
 223 static INTN
 224 is_valid_header(Elf64_Ehdr *ehdr)
 225 {
 226         UINT16 type, machine;
 227
 228         type    = ehdr->e_type;
 229         machine = ehdr->e_machine;
 230
 231         VERB_PRT(3, Print(L"class=%d type=%d data=%d machine=%d\n",
 232                 ehdr->e_ident[EI_CLASS],
 233                 type,
 234                 ehdr->e_ident[EI_DATA],
 235                 machine));
 236
 237         return    ehdr->e_ident[EI_MAG0]  == 0x7f
 238                && ehdr->e_ident[EI_MAG1]  == 'E'
 239                && ehdr->e_ident[EI_MAG2]  == 'L'
 240                && ehdr->e_ident[EI_MAG3]  == 'F'
 241                && ehdr->e_ident[EI_CLASS] == ELFCLASS64
 242                && type                    == ET_EXEC    /* must be executable */
 243                && machine                 == EM_X86_64 ? 0 : -1;
 244 }
 245
 246 /*
 247  * will invalidate loadble segments which overlap with others
 248  */
 249 void
 250 check_overlap(int i)
 251 {
 252         int j;
 253         unsigned long iend = chunks[i].addr + chunks[i].size;
 254
 255         for(j=0; j < nchunks; j++) {
 256                 if (j ==i) continue;
 257                 if (chunks[i].addr >= chunks[j].addr && iend < (chunks[j].addr + chunks[j].size)) {
 258                         DBG_PRT((L"%s : segment %d fully included in segment %d\n", LD_NAME, i, j));
 259                         CHUNK_INVALIDATE(i); /* nullyify segment */
 260                         break;
 261                 }
 262         }
 263 }
 264
 265 void
 266 analyze_chunks(void)
 267 {
 268         INTN i;
 269
 270         for (i=0; i < nchunks; i++) {
 271                 if (CHUNK_IS_VALID(i) && !CHUNK_IS_LOAD(i))
 272                         check_overlap(i);
 273         }
 274 }
 275
 276
 277 /*
 278  * The decompression code calls this function after decompressing the
 279  * first block of the object file.  The first block must contain all
 280  * the relevant header information.
 281  */
 282 int
 283 first_block (const unsigned char *buf, long blocksize)
 284 {
 285         Elf64_Ehdr *elf;
 286         Elf64_Phdr *phdrs;
 287         UINTN total_size, pages;
 288         UINTN low_addr, max_addr;
 289         UINTN offs = 0;
 290         UINT16 phnum;
 291         UINTN paddr, memsz;
 292         INTN i;
 293
 294         elf  = (Elf64_Ehdr *)buf;
 295
 296         if (is_valid_header(elf) == -1)
 297                 return -1;
 298
 299         offs  = elf->e_phoff;
 300         phnum = elf->e_phnum;
 301
 302         VERB_PRT(3, {
 303                 Print(L"Entry point 0x%lx\n", elf->e_entry);
 304                 Print(L"%d program headers\n", phnum);
 305                 Print(L"%d segment headers\n", elf->e_shnum);
 306         });
 307
 308         if (offs + phnum * sizeof(*phdrs) > (unsigned) blocksize) {
 309                 ERR_PRT((L"%s : ELF program headers not in first block (%ld)\n", LD_NAME, offs));
 310                 return -1;
 311         }
 312
 313         kernel_entry = (VOID *)(elf->e_entry & PADDR_MASK);
 314
 315         phdrs = (Elf64_Phdr *) (buf + offs);
 316         low_addr = ~0;
 317         max_addr = 0;
 318
 319         /*
 320          * allocate chunk table
 321          * Convention: a segment that does not need loading will
 322          * have chunk[].addr = 0.
 323          */
 324         chunks = (void *)alloc(sizeof(struct segment)*phnum, 0);
 325         if (chunks == NULL) {
 326                 ERR_PRT((L"%s : failed alloc chunks %r\n", LD_NAME));
 327                 return -1;
 328         }
 329         nchunks = phnum;
 330         /*
 331          * find lowest and higest virtual addresses
 332          * don't assume FULLY sorted !
 333          */
 334         for (i = 0; i < phnum; ++i) {
 335                 /*
 336                  * record chunk no matter what because no load may happen
 337                  * anywhere in archive, not just as the last segment
 338                  */
 339                 paddr = (phdrs[i].p_paddr & PADDR_MASK);
 340                 memsz = phdrs[i].p_memsz,
 341
 342                 chunks[i].addr   = paddr;
 343                 chunks[i].offset = phdrs[i].p_offset;
 344                 chunks[i].size   = phdrs[i].p_filesz;
 345                 chunks[i].bss_sz = phdrs[i].p_memsz - phdrs[i].p_filesz;
 346
 347                 CHUNK_VALIDATE(i);
 348
 349                 if (phdrs[i].p_type != PT_LOAD) {
 350                         CHUNK_NO_LOAD(i); /* mark no load chunk */
 351                         DBG_PRT((L"%s : skipping segment %ld\n", LD_NAME, i));
 352                         continue;
 353                 }
 354
 355                 CHUNK_CAN_LOAD(i); /* mark no load chunk */
 356
 357                 VERB_PRT(3,
 358                 Print(L"\n%s : segment %ld vaddr [0x%lx-0x%lx] offset %ld filesz %ld "
 359                         "memsz=%ld bss_sz=%ld\n",
 360                         LD_NAME, 1+i, chunks[i].addr, chunks[i].addr+phdrs[i].p_filesz,
 361                         chunks[i].offset, chunks[i].size, memsz, chunks[i].bss_sz));
 362
 363                 if (paddr < low_addr)
 364                         low_addr = paddr;
 365                 if (paddr + memsz > max_addr)
 366                         max_addr = paddr + memsz;
 367         }
 368
 369         if (low_addr & (EFI_PAGE_SIZE - 1)) {
 370                 ERR_PRT((L"%s : low_addr not page aligned 0x%lx\n", LD_NAME, low_addr));
 371                 goto error;
 372         }
 373         analyze_chunks();
 374
 375         DBG_PRT((L"%s : %d program headers entry=0x%lx\nlowest_addr=0x%lx highest_addr=0x%lx\n",
 376                         LD_NAME,
 377                         phnum, kernel_entry, low_addr, max_addr));
 378
 379         total_size = (UINTN)max_addr - (UINTN)low_addr;
 380         pages = EFI_SIZE_TO_PAGES(total_size);
 381
 382         /*
 383          * Record end of kernel for initrd
 384          */
 385         kernel_base = (void *)low_addr;
 386         kernel_end  = (void *)(low_addr + (pages << EFI_PAGE_SHIFT));
 387
 388         /* allocate memory for the kernel */
 389         if (alloc_kmem((void *)low_addr, pages) == -1) {
 390                 ERR_PRT((L"%s : AllocatePages(%d, 0x%lx) for kernel failed\n",
 391                         LD_NAME, pages, low_addr));
 392                 ERR_PRT((L"%s : Could not load kernel at 0x%lx\n", LD_NAME, low_addr));
 393                 ERR_PRT((L"%s : Bailing\n", LD_NAME));
 394                 goto error;
 395         }
 396         return 0;
 397 error:
 398         if (chunks)
 399                 free(chunks);
 400         return -1;
 401 }
 402
 403 /*
 404  * Determine which chunk in the Elf file will be coming out of the expand
 405  * code next.
 406  */
 407 static void
 408 nextchunk(void)
 409 {
 410         int i;
 411         segment_t *cp;
 412
 413         cp = NULL;
 414         for(i=0; i < nchunks; i++) {
 415
 416                 if (!CHUNK_IS_VALID(i) || !CHUNK_IS_LOAD(i)) continue;
 417
 418                 if (file_offset > chunks[i].offset) continue;
 419
 420                 if (cp == NULL || chunks[i].offset < cp->offset) cp = &chunks[i];
 421         }
 422         cur_chunk = cp;
 423 }
 424
 425
 426 /*
 427  * Write the output window window[0..outcnt-1] holding uncompressed
 428  * data and update crc.
 429  */
 430 void
 431 flush_window(void)
 432 {
 433         static const CHAR8 helicopter[4] = { '|' , '/' , '-' , '\\' };
 434         static UINTN heli_count;
 435         struct segment *cp;
 436         unsigned char   *src, *dst;
 437         long    cnt;
 438
 439         if (!outcnt) return;
 440
 441         DBG_PRT((L"%s : flush_window outnct=%d file_offset=%ld\n", LD_NAME, outcnt, file_offset));
 442
 443         Print(L"%c\b",helicopter[heli_count++%4]);
 444
 445         updcrc(window, outcnt);
 446
 447         /* first time, we extract the headers */
 448         if (!bytes_out) {
 449                 if (first_block(window, outcnt) < 0)
 450                         error("invalid exec header");
 451                 nextchunk();
 452         }
 453
 454         bytes_out += outcnt;
 455         src = window;
 456 tail:
 457         /* check if user wants to abort */
 458         if (check_abort() == EFI_SUCCESS) goto load_abort;
 459
 460         cp = cur_chunk;
 461         if (cp == NULL || file_offset + outcnt <= cp->offset) {
 462                 file_offset += outcnt;
 463                 return;
 464         }
 465
 466         /* Does this window begin before the current chunk? */
 467         if (file_offset < cp->offset) {
 468                 unsigned long skip = cp->offset - file_offset;
 469
 470                 src         += skip;
 471                 file_offset += skip;
 472                 outcnt      -= skip;
 473         }
 474         dst = (unsigned char *)cp->addr + (file_offset - cp->offset);
 475         cnt = cp->offset + cp->size - file_offset;
 476         if (cnt > outcnt)
 477                 cnt = outcnt;
 478
 479         Memcpy(dst, src, cnt);
 480
 481         file_offset += cnt;
 482         outcnt      -= cnt;
 483         src         += cnt;
 484
 485         /* See if we are at the end of this chunk */
 486         if (file_offset == cp->offset + cp->size) {
 487                 if (cp->bss_sz) {
 488                         dst = (unsigned char *)cp->addr + cp->size;
 489                         Memset(dst, 0, cp->bss_sz);
 490                 }
 491                 nextchunk();
 492                 /* handle remaining bytes */
 493                 if (outcnt)
 494                         goto tail;
 495         }
 496         return;
 497 load_abort:
 498         free_kmem();
 499         error_return = ELILO_LOAD_ABORTED;
 500 }
 501
 502 static void
 503 error(char *x)
 504 {
 505         ERR_PRT((L"%s : %a", LD_NAME, x));
 506         /* will eventually exit with error from gunzip() */
 507 }
 508
 509 INT32
 510 decompress_kernel(VOID)
 511 {
 512         INT32 ret;
 513
 514         clear_bufs();
 515         makecrc();
 516         Print(L"Uncompressing Linux... ");
 517         ret = gunzip();
 518         if (ret == 0)
 519                 Print(L"done\n");
 520         return ret == 0 ? 0 : -1;
 521 }
 522
 523 int
 524 gunzip_kernel(fops_fd_t fd, kdesc_t *kd)
 525 {
 526         int ret = -1;
 527
 528         error_return = ELILO_LOAD_ERROR;
 529
 530         window = (void *)alloc(WSIZE, 0);
 531         if (window == NULL) {
 532                 ERR_PRT((L"%s : allocate output window failed\n", LD_NAME));
 533                 return -1;
 534         }
 535
 536         inbuf = (void *)alloc(INBUFSIZE, 0);
 537         if (inbuf == NULL) {
 538                 ERR_PRT((L"%s : allocate input window failedr\n", LD_NAME));
 539                 goto error;
 540         }
 541         input_fd   = fd;
 542         insize     = 0;
 543         bytes_out  = 0;
 544
 545         ret = decompress_kernel();
 546 error:
 547         if (window) free(window);
 548         if (inbuf) free(inbuf);
 549
 550         if (ret == 0) {
 551                 kd->kentry = kernel_entry;
 552                 kd->kend   = kernel_end;
 553                 kd->kstart = kernel_base;
 554                 error_return = ELILO_LOAD_SUCCESS;
 555         }
 556         return error_return;
 557 }