Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 1 | /* |
Peter Stuge | 45ae92ff | 2009-04-14 19:48:32 +0000 | [diff] [blame] | 2 | * cbfs-mkstage |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 3 | * |
| 4 | * Copyright (C) 2008 Jordan Crouse <jordan@cosmicpenguin.net> |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 5 | * 2009 coresystems GmbH |
| 6 | * written by Patrick Georgi <patrick.georgi@coresystems.de> |
David Hendricks | 90ca3b6 | 2012-11-16 14:48:22 -0800 | [diff] [blame] | 7 | * Copyright (C) 2012 Google, Inc. |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License as published by |
| 11 | * the Free Software Foundation; version 2 of the License. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License |
| 19 | * along with this program; if not, write to the Free Software |
Patrick Georgi | b890a12 | 2015-03-26 15:17:45 +0100 | [diff] [blame] | 20 | * Foundation, Inc. |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 21 | */ |
| 22 | |
Francis Rowe | 3fb8b0d | 2014-11-21 02:38:48 +0000 | [diff] [blame] | 23 | #include <inttypes.h> |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 24 | #include <stdio.h> |
| 25 | #include <stdlib.h> |
| 26 | #include <string.h> |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 27 | |
Aaron Durbin | 54ef306 | 2014-03-05 12:12:09 -0600 | [diff] [blame] | 28 | #include "elfparsing.h" |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 29 | #include "common.h" |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 30 | #include "cbfs.h" |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 31 | |
Furquan Shaikh | 405304a | 2014-10-30 11:44:20 -0700 | [diff] [blame] | 32 | /* Checks if program segment contains the ignored section */ |
| 33 | static int is_phdr_ignored(Elf64_Phdr *phdr, Elf64_Shdr *shdr) |
| 34 | { |
| 35 | /* If no ignored section, return false. */ |
| 36 | if (shdr == NULL) |
| 37 | return 0; |
| 38 | |
| 39 | Elf64_Addr sh_start = shdr->sh_addr; |
| 40 | Elf64_Addr sh_end = shdr->sh_addr + shdr->sh_size; |
| 41 | Elf64_Addr ph_start = phdr->p_vaddr; |
| 42 | Elf64_Addr ph_end = phdr->p_vaddr + phdr->p_memsz; |
| 43 | |
| 44 | /* Return true only if section occupies whole of segment. */ |
| 45 | if ((sh_start == ph_start) && (sh_end == ph_end)) { |
Francis Rowe | 3fb8b0d | 2014-11-21 02:38:48 +0000 | [diff] [blame] | 46 | DEBUG("Ignoring program segment at 0x%" PRIx64 "\n", ph_start); |
Furquan Shaikh | 405304a | 2014-10-30 11:44:20 -0700 | [diff] [blame] | 47 | return 1; |
| 48 | } |
| 49 | |
| 50 | /* If shdr intersects phdr at all, its a conflict */ |
| 51 | if (((sh_start >= ph_start) && (sh_start <= ph_end)) || |
| 52 | ((sh_end >= ph_start) && (sh_end <= ph_end))) { |
| 53 | ERROR("Conflicting sections in segment\n"); |
| 54 | exit(1); |
| 55 | } |
| 56 | |
| 57 | /* Program header doesn't need to be ignored. */ |
| 58 | return 0; |
| 59 | } |
| 60 | |
| 61 | /* Find section header based on ignored section name */ |
| 62 | static Elf64_Shdr *find_ignored_section_header(struct parsed_elf *pelf, |
| 63 | const char *ignore_section) |
| 64 | { |
| 65 | int i; |
| 66 | const char *shstrtab; |
| 67 | |
| 68 | /* No section needs to be ignored */ |
| 69 | if (ignore_section == NULL) |
| 70 | return NULL; |
| 71 | |
| 72 | DEBUG("Section to be ignored: %s\n", ignore_section); |
| 73 | |
| 74 | /* Get pointer to string table */ |
| 75 | shstrtab = buffer_get(pelf->strtabs[pelf->ehdr.e_shstrndx]); |
| 76 | |
| 77 | for (i = 0; i < pelf->ehdr.e_shnum; i++) { |
| 78 | Elf64_Shdr *shdr; |
| 79 | const char *section_name; |
| 80 | |
| 81 | shdr = &pelf->shdr[i]; |
| 82 | section_name = &shstrtab[shdr->sh_name]; |
| 83 | |
| 84 | /* If section name matches ignored string, return shdr */ |
| 85 | if (strcmp(section_name, ignore_section) == 0) |
| 86 | return shdr; |
| 87 | } |
| 88 | |
| 89 | /* No section matches ignore string */ |
| 90 | return NULL; |
| 91 | } |
| 92 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 93 | /* returns size of result, or -1 if error. |
| 94 | * Note that, with the new code, this function |
| 95 | * works for all elf files, not just the restricted set. |
| 96 | */ |
| 97 | int parse_elf_to_stage(const struct buffer *input, struct buffer *output, |
Sol Boucher | 6310ccc | 2015-05-07 21:12:28 -0700 | [diff] [blame] | 98 | enum comp_algo algo, uint32_t *location, |
Furquan Shaikh | 405304a | 2014-10-30 11:44:20 -0700 | [diff] [blame] | 99 | const char *ignore_section) |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 100 | { |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 101 | struct parsed_elf pelf; |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 102 | Elf64_Phdr *phdr; |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 103 | Elf64_Ehdr *ehdr; |
Furquan Shaikh | 405304a | 2014-10-30 11:44:20 -0700 | [diff] [blame] | 104 | Elf64_Shdr *shdr_ignored; |
Furquan Shaikh | f7a5b56 | 2015-05-29 12:46:18 -0700 | [diff] [blame] | 105 | Elf64_Addr virt_to_phys; |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 106 | char *buffer; |
| 107 | struct buffer outheader; |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 108 | int ret = -1; |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 109 | |
| 110 | int headers; |
| 111 | int i, outlen; |
| 112 | uint32_t data_start, data_end, mem_end; |
| 113 | |
| 114 | comp_func_ptr compress = compression_function(algo); |
| 115 | if (!compress) |
| 116 | return -1; |
| 117 | |
| 118 | DEBUG("start: parse_elf_to_stage(location=0x%x)\n", *location); |
| 119 | |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 120 | int flags = ELF_PARSE_PHDR | ELF_PARSE_SHDR | ELF_PARSE_STRTAB; |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 121 | |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 122 | if (parse_elf(input, &pelf, flags)) { |
| 123 | ERROR("Couldn't parse ELF\n"); |
| 124 | return -1; |
| 125 | } |
| 126 | |
| 127 | ehdr = &pelf.ehdr; |
| 128 | phdr = &pelf.phdr[0]; |
| 129 | |
Furquan Shaikh | 405304a | 2014-10-30 11:44:20 -0700 | [diff] [blame] | 130 | /* Find the section header corresponding to ignored-section */ |
| 131 | shdr_ignored = find_ignored_section_header(&pelf, ignore_section); |
| 132 | |
| 133 | if (ignore_section && (shdr_ignored == NULL)) |
| 134 | WARN("Ignore section not found\n"); |
| 135 | |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 136 | headers = ehdr->e_phnum; |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 137 | |
Furquan Shaikh | 405304a | 2014-10-30 11:44:20 -0700 | [diff] [blame] | 138 | /* Ignore the program header containing ignored section */ |
| 139 | for (i = 0; i < headers; i++) { |
| 140 | if (is_phdr_ignored(&phdr[i], shdr_ignored)) |
| 141 | phdr[i].p_type = PT_NULL; |
| 142 | } |
| 143 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 144 | data_start = ~0; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 145 | data_end = 0; |
| 146 | mem_end = 0; |
Furquan Shaikh | f7a5b56 | 2015-05-29 12:46:18 -0700 | [diff] [blame] | 147 | virt_to_phys = 0; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 148 | |
| 149 | for (i = 0; i < headers; i++) { |
| 150 | unsigned int start, mend, rend; |
| 151 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 152 | if (phdr[i].p_type != PT_LOAD) |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 153 | continue; |
| 154 | |
| 155 | /* Empty segments are never interesting */ |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 156 | if (phdr[i].p_memsz == 0) |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 157 | continue; |
| 158 | |
| 159 | /* BSS */ |
| 160 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 161 | start = phdr[i].p_paddr; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 162 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 163 | mend = start + phdr[i].p_memsz; |
| 164 | rend = start + phdr[i].p_filesz; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 165 | |
| 166 | if (start < data_start) |
| 167 | data_start = start; |
| 168 | |
| 169 | if (rend > data_end) |
| 170 | data_end = rend; |
| 171 | |
| 172 | if (mend > mem_end) |
| 173 | mem_end = mend; |
Furquan Shaikh | f7a5b56 | 2015-05-29 12:46:18 -0700 | [diff] [blame] | 174 | |
| 175 | if (virt_to_phys == 0) |
| 176 | virt_to_phys = phdr[i].p_paddr - phdr[i].p_vaddr; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 177 | } |
| 178 | |
Patrick Georgi | 9341acd | 2009-12-23 12:52:56 +0000 | [diff] [blame] | 179 | if (data_start < *location) { |
| 180 | data_start = *location; |
| 181 | } |
| 182 | |
Patrick Georgi | a6c337d | 2010-02-03 17:56:37 +0000 | [diff] [blame] | 183 | if (data_end <= data_start) { |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 184 | ERROR("data ends (%08lx) before it starts (%08lx). Make sure " |
| 185 | "the ELF file is correct and resides in ROM space.\n", |
| 186 | (unsigned long)data_end, (unsigned long)data_start); |
Patrick Georgi | a6c337d | 2010-02-03 17:56:37 +0000 | [diff] [blame] | 187 | exit(1); |
| 188 | } |
| 189 | |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 190 | /* allocate an intermediate buffer for the data */ |
| 191 | buffer = calloc(data_end - data_start, 1); |
| 192 | |
| 193 | if (buffer == NULL) { |
Hung-Te Lin | 4d87d4e | 2013-01-28 14:39:43 +0800 | [diff] [blame] | 194 | ERROR("Unable to allocate memory: %m\n"); |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 195 | goto err; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | /* Copy the file data into the buffer */ |
| 199 | |
| 200 | for (i = 0; i < headers; i++) { |
Patrick Georgi | 9341acd | 2009-12-23 12:52:56 +0000 | [diff] [blame] | 201 | unsigned int l_start, l_offset = 0; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 202 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 203 | if (phdr[i].p_type != PT_LOAD) |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 204 | continue; |
| 205 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 206 | if (phdr[i].p_memsz == 0) |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 207 | continue; |
| 208 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 209 | l_start = phdr[i].p_paddr; |
Patrick Georgi | 9341acd | 2009-12-23 12:52:56 +0000 | [diff] [blame] | 210 | if (l_start < *location) { |
| 211 | l_offset = *location - l_start; |
| 212 | l_start = *location; |
| 213 | } |
| 214 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 215 | /* A legal ELF file can have a program header with |
| 216 | * non-zero length but zero-length file size and a |
| 217 | * non-zero offset which, added together, are > than |
| 218 | * input->size (i.e. the total file size). So we need |
| 219 | * to not even test in the case that p_filesz is zero. |
| 220 | */ |
| 221 | if (! phdr[i].p_filesz) |
| 222 | continue; |
| 223 | if (input->size < (phdr[i].p_offset + phdr[i].p_filesz)){ |
| 224 | ERROR("Underflow copying out the segment." |
Paul Menzel | 470c37c | 2014-03-16 00:15:57 +0100 | [diff] [blame] | 225 | "File has %zu bytes left, segment end is %zu\n", |
| 226 | input->size, (size_t)(phdr[i].p_offset + phdr[i].p_filesz)); |
Daniele Forsi | 8e89847 | 2014-07-27 12:01:40 +0200 | [diff] [blame] | 227 | free(buffer); |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 228 | goto err; |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 229 | } |
Patrick Georgi | 9341acd | 2009-12-23 12:52:56 +0000 | [diff] [blame] | 230 | memcpy(buffer + (l_start - data_start), |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 231 | &input->data[phdr[i].p_offset + l_offset], |
| 232 | phdr[i].p_filesz - l_offset); |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 233 | } |
| 234 | |
| 235 | /* Now make the output buffer */ |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 236 | if (buffer_create(output, sizeof(struct cbfs_stage) + data_end - data_start, |
Hung-Te Lin | c13e4bf | 2013-01-29 15:22:11 +0800 | [diff] [blame] | 237 | input->name) != 0) { |
Hung-Te Lin | 4d87d4e | 2013-01-28 14:39:43 +0800 | [diff] [blame] | 238 | ERROR("Unable to allocate memory: %m\n"); |
Paul Menzel | 2c8f81b | 2013-04-11 10:45:11 +0200 | [diff] [blame] | 239 | free(buffer); |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 240 | goto err; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 241 | } |
Hung-Te Lin | c13e4bf | 2013-01-29 15:22:11 +0800 | [diff] [blame] | 242 | memset(output->data, 0, output->size); |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 243 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 244 | /* Compress the data, at which point we'll know information |
| 245 | * to fill out the header. This seems backward but it works because |
| 246 | * - the output header is a known size (not always true in many xdr's) |
| 247 | * - we do need to know the compressed output size first |
Gabe Black | 845aa14 | 2014-02-21 01:01:06 -0800 | [diff] [blame] | 248 | * If compression fails or makes the data bigger, we'll warn about it |
| 249 | * and use the original data. |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 250 | */ |
Gabe Black | dbd006b | 2014-02-20 23:38:49 -0800 | [diff] [blame] | 251 | if (compress(buffer, data_end - data_start, |
| 252 | (output->data + sizeof(struct cbfs_stage)), |
Sol Boucher | 0e53931 | 2015-03-05 15:38:03 -0800 | [diff] [blame] | 253 | &outlen) < 0 || (unsigned)outlen > data_end - data_start) { |
Gabe Black | 845aa14 | 2014-02-21 01:01:06 -0800 | [diff] [blame] | 254 | WARN("Compression failed or would make the data bigger " |
| 255 | "- disabled.\n"); |
| 256 | memcpy(output->data + sizeof(struct cbfs_stage), |
| 257 | buffer, data_end - data_start); |
| 258 | algo = CBFS_COMPRESS_NONE; |
Gabe Black | dbd006b | 2014-02-20 23:38:49 -0800 | [diff] [blame] | 259 | } |
Stefan Reinauer | 6321758 | 2012-10-29 16:52:36 -0700 | [diff] [blame] | 260 | free(buffer); |
| 261 | |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 262 | /* Set up for output marshaling. */ |
| 263 | outheader.data = output->data; |
| 264 | outheader.size = 0; |
| 265 | /* N.B. The original plan was that SELF data was B.E. |
| 266 | * but: this is all L.E. |
| 267 | * Maybe we should just change the spec. |
| 268 | */ |
| 269 | xdr_le.put32(&outheader, algo); |
Furquan Shaikh | f7a5b56 | 2015-05-29 12:46:18 -0700 | [diff] [blame] | 270 | /* Coreboot expects entry point to be physical address. Thus, adjust the |
| 271 | * entry point accordingly. |
| 272 | */ |
| 273 | xdr_le.put64(&outheader, ehdr->e_entry + virt_to_phys); |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 274 | xdr_le.put64(&outheader, data_start); |
| 275 | xdr_le.put32(&outheader, outlen); |
| 276 | xdr_le.put32(&outheader, mem_end - data_start); |
| 277 | |
Patrick Georgi | b7b56dd8 | 2009-09-14 13:29:27 +0000 | [diff] [blame] | 278 | if (*location) |
| 279 | *location -= sizeof(struct cbfs_stage); |
Ronald G. Minnich | aa2f739 | 2013-12-03 11:13:35 -0800 | [diff] [blame] | 280 | output->size = sizeof(struct cbfs_stage) + outlen; |
Furquan Shaikh | cc6f84c | 2014-10-30 11:28:27 -0700 | [diff] [blame] | 281 | ret = 0; |
| 282 | |
| 283 | err: |
| 284 | parsed_elf_destroy(&pelf); |
| 285 | return ret; |
Ronald G. Minnich | 5d01ec0 | 2009-03-31 11:57:36 +0000 | [diff] [blame] | 286 | } |