build.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Copyright (C) 1991, 1992 Linus Torvalds
  4. * Copyright (C) 1997 Martin Mares
  5. * Copyright (C) 2007 H. Peter Anvin
  6. */
  7. /*
  8. * This file builds a disk-image from three different files:
  9. *
  10. * - setup: 8086 machine code, sets up system parm
  11. * - system: 80386 code for actual system
  12. * - zoffset.h: header with ZO_* defines
  13. *
  14. * It does some checking that all files are of the correct type, and writes
  15. * the result to the specified destination, removing headers and padding to
  16. * the right amount. It also writes some system data to stdout.
  17. */
  18. /*
  19. * Changes by tytso to allow root device specification
  20. * High loaded stuff by Hans Lermen & Werner Almesberger, Feb. 1996
  21. * Cross compiling fixes by Gertjan van Wingerde, July 1996
  22. * Rewritten by Martin Mares, April 1997
  23. * Substantially overhauled by H. Peter Anvin, April 2007
  24. */
  25. #include <stdio.h>
  26. #include <string.h>
  27. #include <stdlib.h>
  28. #include <stdarg.h>
  29. #include <sys/types.h>
  30. #include <sys/stat.h>
  31. #include <unistd.h>
  32. #include <fcntl.h>
  33. #include <sys/mman.h>
  34. #include <tools/le_byteshift.h>
  35. typedef unsigned char u8;
  36. typedef unsigned short u16;
  37. typedef unsigned int u32;
  38. #define DEFAULT_MAJOR_ROOT 0
  39. #define DEFAULT_MINOR_ROOT 0
  40. #define DEFAULT_ROOT_DEV (DEFAULT_MAJOR_ROOT << 8 | DEFAULT_MINOR_ROOT)
  41. /* Minimal number of setup sectors */
  42. #define SETUP_SECT_MIN 5
  43. #define SETUP_SECT_MAX 64
  44. /* This must be large enough to hold the entire setup */
  45. u8 buf[SETUP_SECT_MAX*512];
  46. #define PECOFF_RELOC_RESERVE 0x20
  47. #ifdef CONFIG_EFI_MIXED
  48. #define PECOFF_COMPAT_RESERVE 0x20
  49. #else
  50. #define PECOFF_COMPAT_RESERVE 0x0
  51. #endif
  52. static unsigned long efi32_stub_entry;
  53. static unsigned long efi64_stub_entry;
  54. static unsigned long efi_pe_entry;
  55. static unsigned long efi32_pe_entry;
  56. static unsigned long kernel_info;
  57. static unsigned long startup_64;
  58. static unsigned long _ehead;
  59. static unsigned long _end;
  60. /*----------------------------------------------------------------------*/
  61. static const u32 crctab32[] = {
  62. 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
  63. 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
  64. 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
  65. 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
  66. 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
  67. 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
  68. 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
  69. 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
  70. 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
  71. 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
  72. 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
  73. 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
  74. 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
  75. 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
  76. 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
  77. 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
  78. 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
  79. 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
  80. 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
  81. 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
  82. 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
  83. 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
  84. 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
  85. 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
  86. 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
  87. 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
  88. 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
  89. 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
  90. 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
  91. 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
  92. 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
  93. 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
  94. 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
  95. 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
  96. 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
  97. 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
  98. 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
  99. 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
  100. 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
  101. 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
  102. 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
  103. 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
  104. 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
  105. 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
  106. 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
  107. 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
  108. 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
  109. 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
  110. 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
  111. 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
  112. 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
  113. 0x2d02ef8d
  114. };
  115. static u32 partial_crc32_one(u8 c, u32 crc)
  116. {
  117. return crctab32[(crc ^ c) & 0xff] ^ (crc >> 8);
  118. }
  119. static u32 partial_crc32(const u8 *s, int len, u32 crc)
  120. {
  121. while (len--)
  122. crc = partial_crc32_one(*s++, crc);
  123. return crc;
  124. }
  125. static void die(const char * str, ...)
  126. {
  127. va_list args;
  128. va_start(args, str);
  129. vfprintf(stderr, str, args);
  130. va_end(args);
  131. fputc('\n', stderr);
  132. exit(1);
  133. }
  134. static void usage(void)
  135. {
  136. die("Usage: build setup system zoffset.h image");
  137. }
  138. #ifdef CONFIG_EFI_STUB
  139. static void update_pecoff_section_header_fields(char *section_name, u32 vma, u32 size, u32 datasz, u32 offset)
  140. {
  141. unsigned int pe_header;
  142. unsigned short num_sections;
  143. u8 *section;
  144. pe_header = get_unaligned_le32(&buf[0x3c]);
  145. num_sections = get_unaligned_le16(&buf[pe_header + 6]);
  146. #ifdef CONFIG_X86_32
  147. section = &buf[pe_header + 0xa8];
  148. #else
  149. section = &buf[pe_header + 0xb8];
  150. #endif
  151. while (num_sections > 0) {
  152. if (strncmp((char*)section, section_name, 8) == 0) {
  153. /* section header size field */
  154. put_unaligned_le32(size, section + 0x8);
  155. /* section header vma field */
  156. put_unaligned_le32(vma, section + 0xc);
  157. /* section header 'size of initialised data' field */
  158. put_unaligned_le32(datasz, section + 0x10);
  159. /* section header 'file offset' field */
  160. put_unaligned_le32(offset, section + 0x14);
  161. break;
  162. }
  163. section += 0x28;
  164. num_sections--;
  165. }
  166. }
  167. static void update_pecoff_section_header(char *section_name, u32 offset, u32 size)
  168. {
  169. update_pecoff_section_header_fields(section_name, offset, size, size, offset);
  170. }
  171. static void update_pecoff_setup_and_reloc(unsigned int size)
  172. {
  173. u32 setup_offset = 0x200;
  174. u32 reloc_offset = size - PECOFF_RELOC_RESERVE - PECOFF_COMPAT_RESERVE;
  175. #ifdef CONFIG_EFI_MIXED
  176. u32 compat_offset = reloc_offset + PECOFF_RELOC_RESERVE;
  177. #endif
  178. u32 setup_size = reloc_offset - setup_offset;
  179. update_pecoff_section_header(".setup", setup_offset, setup_size);
  180. update_pecoff_section_header(".reloc", reloc_offset, PECOFF_RELOC_RESERVE);
  181. /*
  182. * Modify .reloc section contents with a single entry. The
  183. * relocation is applied to offset 10 of the relocation section.
  184. */
  185. put_unaligned_le32(reloc_offset + 10, &buf[reloc_offset]);
  186. put_unaligned_le32(10, &buf[reloc_offset + 4]);
  187. #ifdef CONFIG_EFI_MIXED
  188. update_pecoff_section_header(".compat", compat_offset, PECOFF_COMPAT_RESERVE);
  189. /*
  190. * Put the IA-32 machine type (0x14c) and the associated entry point
  191. * address in the .compat section, so loaders can figure out which other
  192. * execution modes this image supports.
  193. */
  194. buf[compat_offset] = 0x1;
  195. buf[compat_offset + 1] = 0x8;
  196. put_unaligned_le16(0x14c, &buf[compat_offset + 2]);
  197. put_unaligned_le32(efi32_pe_entry + size, &buf[compat_offset + 4]);
  198. #endif
  199. }
  200. static void update_pecoff_text(unsigned int text_start, unsigned int file_sz,
  201. unsigned int init_sz)
  202. {
  203. unsigned int pe_header;
  204. unsigned int text_sz = file_sz - text_start;
  205. unsigned int bss_sz = init_sz - file_sz;
  206. pe_header = get_unaligned_le32(&buf[0x3c]);
  207. /*
  208. * The PE/COFF loader may load the image at an address which is
  209. * misaligned with respect to the kernel_alignment field in the setup
  210. * header.
  211. *
  212. * In order to avoid relocating the kernel to correct the misalignment,
  213. * add slack to allow the buffer to be aligned within the declared size
  214. * of the image.
  215. */
  216. bss_sz += CONFIG_PHYSICAL_ALIGN;
  217. init_sz += CONFIG_PHYSICAL_ALIGN;
  218. /*
  219. * Size of code: Subtract the size of the first sector (512 bytes)
  220. * which includes the header.
  221. */
  222. put_unaligned_le32(file_sz - 512 + bss_sz, &buf[pe_header + 0x1c]);
  223. /* Size of image */
  224. put_unaligned_le32(init_sz, &buf[pe_header + 0x50]);
  225. /*
  226. * Address of entry point for PE/COFF executable
  227. */
  228. put_unaligned_le32(text_start + efi_pe_entry, &buf[pe_header + 0x28]);
  229. update_pecoff_section_header_fields(".text", text_start, text_sz + bss_sz,
  230. text_sz, text_start);
  231. }
  232. static int reserve_pecoff_reloc_section(int c)
  233. {
  234. /* Reserve 0x20 bytes for .reloc section */
  235. memset(buf+c, 0, PECOFF_RELOC_RESERVE);
  236. return PECOFF_RELOC_RESERVE;
  237. }
  238. static void efi_stub_defaults(void)
  239. {
  240. /* Defaults for old kernel */
  241. #ifdef CONFIG_X86_32
  242. efi_pe_entry = 0x10;
  243. #else
  244. efi_pe_entry = 0x210;
  245. startup_64 = 0x200;
  246. #endif
  247. }
  248. static void efi_stub_entry_update(void)
  249. {
  250. unsigned long addr = efi32_stub_entry;
  251. #ifdef CONFIG_X86_64
  252. /* Yes, this is really how we defined it :( */
  253. addr = efi64_stub_entry - 0x200;
  254. #endif
  255. #ifdef CONFIG_EFI_MIXED
  256. if (efi32_stub_entry != addr)
  257. die("32-bit and 64-bit EFI entry points do not match\n");
  258. #endif
  259. put_unaligned_le32(addr, &buf[0x264]);
  260. }
  261. #else
  262. static inline void update_pecoff_setup_and_reloc(unsigned int size) {}
  263. static inline void update_pecoff_text(unsigned int text_start,
  264. unsigned int file_sz,
  265. unsigned int init_sz) {}
  266. static inline void efi_stub_defaults(void) {}
  267. static inline void efi_stub_entry_update(void) {}
  268. static inline int reserve_pecoff_reloc_section(int c)
  269. {
  270. return 0;
  271. }
  272. #endif /* CONFIG_EFI_STUB */
  273. static int reserve_pecoff_compat_section(int c)
  274. {
  275. /* Reserve 0x20 bytes for .compat section */
  276. memset(buf+c, 0, PECOFF_COMPAT_RESERVE);
  277. return PECOFF_COMPAT_RESERVE;
  278. }
  279. /*
  280. * Parse zoffset.h and find the entry points. We could just #include zoffset.h
  281. * but that would mean tools/build would have to be rebuilt every time. It's
  282. * not as if parsing it is hard...
  283. */
  284. #define PARSE_ZOFS(p, sym) do { \
  285. if (!strncmp(p, "#define ZO_" #sym " ", 11+sizeof(#sym))) \
  286. sym = strtoul(p + 11 + sizeof(#sym), NULL, 16); \
  287. } while (0)
  288. static void parse_zoffset(char *fname)
  289. {
  290. FILE *file;
  291. char *p;
  292. int c;
  293. file = fopen(fname, "r");
  294. if (!file)
  295. die("Unable to open `%s': %m", fname);
  296. c = fread(buf, 1, sizeof(buf) - 1, file);
  297. if (ferror(file))
  298. die("read-error on `zoffset.h'");
  299. fclose(file);
  300. buf[c] = 0;
  301. p = (char *)buf;
  302. while (p && *p) {
  303. PARSE_ZOFS(p, efi32_stub_entry);
  304. PARSE_ZOFS(p, efi64_stub_entry);
  305. PARSE_ZOFS(p, efi_pe_entry);
  306. PARSE_ZOFS(p, efi32_pe_entry);
  307. PARSE_ZOFS(p, kernel_info);
  308. PARSE_ZOFS(p, startup_64);
  309. PARSE_ZOFS(p, _ehead);
  310. PARSE_ZOFS(p, _end);
  311. p = strchr(p, '\n');
  312. while (p && (*p == '\r' || *p == '\n'))
  313. p++;
  314. }
  315. }
  316. int main(int argc, char ** argv)
  317. {
  318. unsigned int i, sz, setup_sectors, init_sz;
  319. int c;
  320. u32 sys_size;
  321. struct stat sb;
  322. FILE *file, *dest;
  323. int fd;
  324. void *kernel;
  325. u32 crc = 0xffffffffUL;
  326. efi_stub_defaults();
  327. if (argc != 5)
  328. usage();
  329. parse_zoffset(argv[3]);
  330. dest = fopen(argv[4], "w");
  331. if (!dest)
  332. die("Unable to write `%s': %m", argv[4]);
  333. /* Copy the setup code */
  334. file = fopen(argv[1], "r");
  335. if (!file)
  336. die("Unable to open `%s': %m", argv[1]);
  337. c = fread(buf, 1, sizeof(buf), file);
  338. if (ferror(file))
  339. die("read-error on `setup'");
  340. if (c < 1024)
  341. die("The setup must be at least 1024 bytes");
  342. if (get_unaligned_le16(&buf[510]) != 0xAA55)
  343. die("Boot block hasn't got boot flag (0xAA55)");
  344. fclose(file);
  345. c += reserve_pecoff_compat_section(c);
  346. c += reserve_pecoff_reloc_section(c);
  347. /* Pad unused space with zeros */
  348. setup_sectors = (c + 511) / 512;
  349. if (setup_sectors < SETUP_SECT_MIN)
  350. setup_sectors = SETUP_SECT_MIN;
  351. i = setup_sectors*512;
  352. memset(buf+c, 0, i-c);
  353. update_pecoff_setup_and_reloc(i);
  354. /* Set the default root device */
  355. put_unaligned_le16(DEFAULT_ROOT_DEV, &buf[508]);
  356. /* Open and stat the kernel file */
  357. fd = open(argv[2], O_RDONLY);
  358. if (fd < 0)
  359. die("Unable to open `%s': %m", argv[2]);
  360. if (fstat(fd, &sb))
  361. die("Unable to stat `%s': %m", argv[2]);
  362. sz = sb.st_size;
  363. kernel = mmap(NULL, sz, PROT_READ, MAP_SHARED, fd, 0);
  364. if (kernel == MAP_FAILED)
  365. die("Unable to mmap '%s': %m", argv[2]);
  366. /* Number of 16-byte paragraphs, including space for a 4-byte CRC */
  367. sys_size = (sz + 15 + 4) / 16;
  368. #ifdef CONFIG_EFI_STUB
  369. /*
  370. * COFF requires minimum 32-byte alignment of sections, and
  371. * adding a signature is problematic without that alignment.
  372. */
  373. sys_size = (sys_size + 1) & ~1;
  374. #endif
  375. /* Patch the setup code with the appropriate size parameters */
  376. buf[0x1f1] = setup_sectors-1;
  377. put_unaligned_le32(sys_size, &buf[0x1f4]);
  378. init_sz = get_unaligned_le32(&buf[0x260]);
  379. #ifdef CONFIG_EFI_STUB
  380. /*
  381. * The decompression buffer will start at ImageBase. When relocating
  382. * the compressed kernel to its end, we must ensure that the head
  383. * section does not get overwritten. The head section occupies
  384. * [i, i + _ehead), and the destination is [init_sz - _end, init_sz).
  385. *
  386. * At present these should never overlap, because 'i' is at most 32k
  387. * because of SETUP_SECT_MAX, '_ehead' is less than 1k, and the
  388. * calculation of INIT_SIZE in boot/header.S ensures that
  389. * 'init_sz - _end' is at least 64k.
  390. *
  391. * For future-proofing, increase init_sz if necessary.
  392. */
  393. if (init_sz - _end < i + _ehead) {
  394. init_sz = (i + _ehead + _end + 4095) & ~4095;
  395. put_unaligned_le32(init_sz, &buf[0x260]);
  396. }
  397. #endif
  398. update_pecoff_text(setup_sectors * 512, i + (sys_size * 16), init_sz);
  399. efi_stub_entry_update();
  400. /* Update kernel_info offset. */
  401. put_unaligned_le32(kernel_info, &buf[0x268]);
  402. crc = partial_crc32(buf, i, crc);
  403. if (fwrite(buf, 1, i, dest) != i)
  404. die("Writing setup failed");
  405. /* Copy the kernel code */
  406. crc = partial_crc32(kernel, sz, crc);
  407. if (fwrite(kernel, 1, sz, dest) != sz)
  408. die("Writing kernel failed");
  409. /* Add padding leaving 4 bytes for the checksum */
  410. while (sz++ < (sys_size*16) - 4) {
  411. crc = partial_crc32_one('\0', crc);
  412. if (fwrite("\0", 1, 1, dest) != 1)
  413. die("Writing padding failed");
  414. }
  415. /* Write the CRC */
  416. put_unaligned_le32(crc, buf);
  417. if (fwrite(buf, 1, 4, dest) != 4)
  418. die("Writing CRC failed");
  419. /* Catch any delayed write failures */
  420. if (fclose(dest))
  421. die("Writing image failed");
  422. close(fd);
  423. /* Everything is OK */
  424. return 0;
  425. }