2 * Copyright (C) 2001-2002 Hewlett-Packard Co.
3 * Contributed by Stephane Eranian <eranian@hpl.hp.com>
5 * Copyright (C) 2001 Silicon Graphics, Inc.
6 * Contributed by Brent Casavant <bcasavan@sgi.com>
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>
13 * This file is part of the ELILO, the EFI Linux boot loader.
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)
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.
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
30 * Please check out the elilo.txt for complete documentation on how
31 * to use this program.
42 #define memzero(s, n) Memset((VOID *)(s), 0, (n))
43 #define memcpy(a,b,n) Memcpy((VOID *)(a),(b),(n))
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
56 #define FUNC_STATIC static
58 typedef unsigned char uch;
59 typedef unsigned short ush;
60 typedef unsigned long ulg;
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 */
71 #define CHUNK_FL_VALID 0x1
72 #define CHUNK_FL_LOAD 0x2
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)
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)
83 * static parameters to gzip helper functions
84 * we cannot use paramters because API was not
87 static segment_t *chunks; /* holds the list of segments */
88 static segment_t *cur_chunk;
90 static UINTN chunk; /* current segment */
91 static UINTN input_fd;
92 static VOID *kernel_entry, *kernel_base, *kernel_end;
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 */
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 */
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 */
111 #define get_byte() (inptr < insize ? inbuf[inptr++] : fill_inbuf())
113 /* Diagnostic functions */
115 # define Assert(cond,msg) {if(!(cond)) error(msg);}
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__) ;}
123 # define Assert(cond,msg)
128 # define Tracecv(c,x)
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;
139 gzip_malloc(int size)
141 return (void *)alloc(size, 0);
145 gzip_free(void *where)
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.
159 UINTN expected, nread;
162 expected = nread = INBUFSIZE;
164 status = fops_read(input_fd, inbuf, &nread);
165 if (EFI_ERROR(status)) {
166 error("elilo: Read failed");
168 DBG_PRT((L"%s : read %d bytes of %d bytes\n", LD_NAME, nread, expected));
176 /* ===========================================================================
177 * Write the output window window[0..outcnt-1] and update crc and bytes_out.
178 * (Used for the decompressed data only.)
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.
187 * S pointer to bytes to pump through.
188 * N number of bytes in S[].
191 updcrc(unsigned char *s, unsigned n)
193 register unsigned long c;
194 /* crc is defined in inflate.c */
201 c = crc_32_tab[((int)c ^ (*s++)) & 0xff] ^ (c >> 8);
205 return c ^ 0xffffffffUL; /* (instead of ~c for 64-bit machines) */
210 * Clear input and output buffers
224 is_valid_header(Elf64_Ehdr *ehdr)
226 UINT16 type, machine;
229 machine = ehdr->e_machine;
231 VERB_PRT(3, Print(L"class=%d type=%d data=%d machine=%d\n",
232 ehdr->e_ident[EI_CLASS],
234 ehdr->e_ident[EI_DATA],
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;
247 * will invalidate loadble segments which overlap with others
253 unsigned long iend = chunks[i].addr + chunks[i].size;
255 for(j=0; j < nchunks; j++) {
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 */
270 for (i=0; i < nchunks; i++) {
271 if (CHUNK_IS_VALID(i) && !CHUNK_IS_LOAD(i))
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.
283 first_block (const unsigned char *buf, long blocksize)
287 UINTN total_size, pages;
288 UINTN low_addr, max_addr;
294 elf = (Elf64_Ehdr *)buf;
296 if (is_valid_header(elf) == -1)
300 phnum = elf->e_phnum;
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);
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));
313 kernel_entry = (VOID *)(elf->e_entry & PADDR_MASK);
315 phdrs = (Elf64_Phdr *) (buf + offs);
320 * allocate chunk table
321 * Convention: a segment that does not need loading will
322 * have chunk[].addr = 0.
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));
331 * find lowest and higest virtual addresses
332 * don't assume FULLY sorted !
334 for (i = 0; i < phnum; ++i) {
336 * record chunk no matter what because no load may happen
337 * anywhere in archive, not just as the last segment
339 paddr = (phdrs[i].p_paddr & PADDR_MASK);
340 memsz = phdrs[i].p_memsz,
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;
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));
355 CHUNK_CAN_LOAD(i); /* mark no load chunk */
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));
363 if (paddr < low_addr)
365 if (paddr + memsz > max_addr)
366 max_addr = paddr + memsz;
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));
375 DBG_PRT((L"%s : %d program headers entry=0x%lx\nlowest_addr=0x%lx highest_addr=0x%lx\n",
377 phnum, kernel_entry, low_addr, max_addr));
379 total_size = (UINTN)max_addr - (UINTN)low_addr;
380 pages = EFI_SIZE_TO_PAGES(total_size);
383 * Record end of kernel for initrd
385 kernel_base = (void *)low_addr;
386 kernel_end = (void *)(low_addr + (pages << EFI_PAGE_SHIFT));
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));
404 * Determine which chunk in the Elf file will be coming out of the expand
414 for(i=0; i < nchunks; i++) {
416 if (!CHUNK_IS_VALID(i) || !CHUNK_IS_LOAD(i)) continue;
418 if (file_offset > chunks[i].offset) continue;
420 if (cp == NULL || chunks[i].offset < cp->offset) cp = &chunks[i];
427 * Write the output window window[0..outcnt-1] holding uncompressed
428 * data and update crc.
433 static const CHAR8 helicopter[4] = { '|' , '/' , '-' , '\\' };
434 static UINTN heli_count;
436 unsigned char *src, *dst;
441 DBG_PRT((L"%s : flush_window outnct=%d file_offset=%ld\n", LD_NAME, outcnt, file_offset));
443 Print(L"%c\b",helicopter[heli_count++%4]);
445 updcrc(window, outcnt);
447 /* first time, we extract the headers */
449 if (first_block(window, outcnt) < 0)
450 error("invalid exec header");
457 /* check if user wants to abort */
458 if (check_abort() == EFI_SUCCESS) goto load_abort;
461 if (cp == NULL || file_offset + outcnt <= cp->offset) {
462 file_offset += outcnt;
466 /* Does this window begin before the current chunk? */
467 if (file_offset < cp->offset) {
468 unsigned long skip = cp->offset - file_offset;
474 dst = (unsigned char *)cp->addr + (file_offset - cp->offset);
475 cnt = cp->offset + cp->size - file_offset;
479 Memcpy(dst, src, cnt);
485 /* See if we are at the end of this chunk */
486 if (file_offset == cp->offset + cp->size) {
488 dst = (unsigned char *)cp->addr + cp->size;
489 Memset(dst, 0, cp->bss_sz);
492 /* handle remaining bytes */
499 error_return = ELILO_LOAD_ABORTED;
505 ERR_PRT((L"%s : %a", LD_NAME, x));
506 /* will eventually exit with error from gunzip() */
510 decompress_kernel(VOID)
516 Print(L"Uncompressing Linux... ");
520 return ret == 0 ? 0 : -1;
524 gunzip_kernel(fops_fd_t fd, kdesc_t *kd)
528 error_return = ELILO_LOAD_ERROR;
530 window = (void *)alloc(WSIZE, 0);
531 if (window == NULL) {
532 ERR_PRT((L"%s : allocate output window failed\n", LD_NAME));
536 inbuf = (void *)alloc(INBUFSIZE, 0);
538 ERR_PRT((L"%s : allocate input window failedr\n", LD_NAME));
545 ret = decompress_kernel();
547 if (window) free(window);
548 if (inbuf) free(inbuf);
551 kd->kentry = kernel_entry;
552 kd->kend = kernel_end;
553 kd->kstart = kernel_base;
554 error_return = ELILO_LOAD_SUCCESS;