12874c5fdSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
294b212c2SPaul Mackerras /*
394b212c2SPaul Mackerras * Program to hack in a PT_NOTE program header entry in an ELF file.
494b212c2SPaul Mackerras * This is needed for OF on RS/6000s to load an image correctly.
594b212c2SPaul Mackerras * Note that OF needs a program header entry for the note, not an
694b212c2SPaul Mackerras * ELF section.
794b212c2SPaul Mackerras *
894b212c2SPaul Mackerras * Copyright 2000 Paul Mackerras.
994b212c2SPaul Mackerras *
10284b52c4SCédric Le Goater * Adapted for 64 bit little endian images by Andrew Tauferner.
11284b52c4SCédric Le Goater *
125663a123SPaul Mackerras * Usage: addnote zImage
1394b212c2SPaul Mackerras */
1494b212c2SPaul Mackerras #include <stdio.h>
1594b212c2SPaul Mackerras #include <stdlib.h>
1694b212c2SPaul Mackerras #include <fcntl.h>
1794b212c2SPaul Mackerras #include <unistd.h>
1894b212c2SPaul Mackerras #include <string.h>
1994b212c2SPaul Mackerras
2094b212c2SPaul Mackerras /* CHRP note section */
214e74fd7dSJoe Perches static const char arch[] = "PowerPC";
2294b212c2SPaul Mackerras
2394b212c2SPaul Mackerras #define N_DESCR 6
2494b212c2SPaul Mackerras unsigned int descr[N_DESCR] = {
2594b212c2SPaul Mackerras 0xffffffff, /* real-mode = true */
269b09c6d9STony Breeds 0x02000000, /* real-base, i.e. where we expect OF to be */
2794b212c2SPaul Mackerras 0xffffffff, /* real-size */
2894b212c2SPaul Mackerras 0xffffffff, /* virt-base */
2994b212c2SPaul Mackerras 0xffffffff, /* virt-size */
3094b212c2SPaul Mackerras 0x4000, /* load-base */
3194b212c2SPaul Mackerras };
3294b212c2SPaul Mackerras
3394b212c2SPaul Mackerras /* RPA note section */
344e74fd7dSJoe Perches static const char rpaname[] = "IBM,RPA-Client-Config";
3594b212c2SPaul Mackerras
3694b212c2SPaul Mackerras /*
3794b212c2SPaul Mackerras * Note: setting ignore_my_client_config *should* mean that OF ignores
3894b212c2SPaul Mackerras * all the other fields, but there is a firmware bug which means that
3994b212c2SPaul Mackerras * it looks at the splpar field at least. So these values need to be
4094b212c2SPaul Mackerras * reasonable.
4194b212c2SPaul Mackerras */
4294b212c2SPaul Mackerras #define N_RPA_DESCR 8
4394b212c2SPaul Mackerras unsigned int rpanote[N_RPA_DESCR] = {
445663a123SPaul Mackerras 0, /* lparaffinity */
455663a123SPaul Mackerras 64, /* min_rmo_size */
4694b212c2SPaul Mackerras 0, /* min_rmo_percent */
475663a123SPaul Mackerras 40, /* max_pft_size */
4894b212c2SPaul Mackerras 1, /* splpar */
4994b212c2SPaul Mackerras -1, /* min_load */
505663a123SPaul Mackerras 0, /* new_mem_def */
515663a123SPaul Mackerras 1, /* ignore_my_client_config */
5294b212c2SPaul Mackerras };
5394b212c2SPaul Mackerras
5494b212c2SPaul Mackerras #define ROUNDUP(len) (((len) + 3) & ~3)
5594b212c2SPaul Mackerras
56284b52c4SCédric Le Goater unsigned char buf[1024];
57284b52c4SCédric Le Goater #define ELFDATA2LSB 1
58284b52c4SCédric Le Goater #define ELFDATA2MSB 2
59284b52c4SCédric Le Goater static int e_data = ELFDATA2MSB;
60284b52c4SCédric Le Goater #define ELFCLASS32 1
61284b52c4SCédric Le Goater #define ELFCLASS64 2
62284b52c4SCédric Le Goater static int e_class = ELFCLASS32;
6394b212c2SPaul Mackerras
645663a123SPaul Mackerras #define GET_16BE(off) ((buf[off] << 8) + (buf[(off)+1]))
65284b52c4SCédric Le Goater #define GET_32BE(off) ((GET_16BE(off) << 16U) + GET_16BE((off)+2U))
66284b52c4SCédric Le Goater #define GET_64BE(off) ((((unsigned long long)GET_32BE(off)) << 32ULL) + \
67284b52c4SCédric Le Goater ((unsigned long long)GET_32BE((off)+4ULL)))
685663a123SPaul Mackerras #define PUT_16BE(off, v)(buf[off] = ((v) >> 8) & 0xff, \
695663a123SPaul Mackerras buf[(off) + 1] = (v) & 0xff)
70284b52c4SCédric Le Goater #define PUT_32BE(off, v)(PUT_16BE((off), (v) >> 16L), PUT_16BE((off) + 2, (v)))
71284b52c4SCédric Le Goater #define PUT_64BE(off, v)((PUT_32BE((off), (v) >> 32L), \
72284b52c4SCédric Le Goater PUT_32BE((off) + 4, (v))))
73284b52c4SCédric Le Goater
74284b52c4SCédric Le Goater #define GET_16LE(off) ((buf[off]) + (buf[(off)+1] << 8))
75284b52c4SCédric Le Goater #define GET_32LE(off) (GET_16LE(off) + (GET_16LE((off)+2U) << 16U))
76284b52c4SCédric Le Goater #define GET_64LE(off) ((unsigned long long)GET_32LE(off) + \
77284b52c4SCédric Le Goater (((unsigned long long)GET_32LE((off)+4ULL)) << 32ULL))
78284b52c4SCédric Le Goater #define PUT_16LE(off, v) (buf[off] = (v) & 0xff, \
79284b52c4SCédric Le Goater buf[(off) + 1] = ((v) >> 8) & 0xff)
80284b52c4SCédric Le Goater #define PUT_32LE(off, v) (PUT_16LE((off), (v)), PUT_16LE((off) + 2, (v) >> 16L))
81284b52c4SCédric Le Goater #define PUT_64LE(off, v) (PUT_32LE((off), (v)), PUT_32LE((off) + 4, (v) >> 32L))
82284b52c4SCédric Le Goater
83284b52c4SCédric Le Goater #define GET_16(off) (e_data == ELFDATA2MSB ? GET_16BE(off) : GET_16LE(off))
84284b52c4SCédric Le Goater #define GET_32(off) (e_data == ELFDATA2MSB ? GET_32BE(off) : GET_32LE(off))
85284b52c4SCédric Le Goater #define GET_64(off) (e_data == ELFDATA2MSB ? GET_64BE(off) : GET_64LE(off))
86284b52c4SCédric Le Goater #define PUT_16(off, v) (e_data == ELFDATA2MSB ? PUT_16BE(off, v) : \
87284b52c4SCédric Le Goater PUT_16LE(off, v))
88284b52c4SCédric Le Goater #define PUT_32(off, v) (e_data == ELFDATA2MSB ? PUT_32BE(off, v) : \
89284b52c4SCédric Le Goater PUT_32LE(off, v))
90284b52c4SCédric Le Goater #define PUT_64(off, v) (e_data == ELFDATA2MSB ? PUT_64BE(off, v) : \
91284b52c4SCédric Le Goater PUT_64LE(off, v))
9294b212c2SPaul Mackerras
9394b212c2SPaul Mackerras /* Structure of an ELF file */
9494b212c2SPaul Mackerras #define E_IDENT 0 /* ELF header */
95284b52c4SCédric Le Goater #define E_PHOFF (e_class == ELFCLASS32 ? 28 : 32)
96284b52c4SCédric Le Goater #define E_PHENTSIZE (e_class == ELFCLASS32 ? 42 : 54)
97284b52c4SCédric Le Goater #define E_PHNUM (e_class == ELFCLASS32 ? 44 : 56)
98284b52c4SCédric Le Goater #define E_HSIZE (e_class == ELFCLASS32 ? 52 : 64)
9994b212c2SPaul Mackerras
10094b212c2SPaul Mackerras #define EI_MAGIC 0 /* offsets in E_IDENT area */
10194b212c2SPaul Mackerras #define EI_CLASS 4
10294b212c2SPaul Mackerras #define EI_DATA 5
10394b212c2SPaul Mackerras
10494b212c2SPaul Mackerras #define PH_TYPE 0 /* ELF program header */
105284b52c4SCédric Le Goater #define PH_OFFSET (e_class == ELFCLASS32 ? 4 : 8)
106284b52c4SCédric Le Goater #define PH_FILESZ (e_class == ELFCLASS32 ? 16 : 32)
107284b52c4SCédric Le Goater #define PH_HSIZE (e_class == ELFCLASS32 ? 32 : 56)
10894b212c2SPaul Mackerras
10994b212c2SPaul Mackerras #define PT_NOTE 4 /* Program header type = note */
11094b212c2SPaul Mackerras
11194b212c2SPaul Mackerras
11294b212c2SPaul Mackerras unsigned char elf_magic[4] = { 0x7f, 'E', 'L', 'F' };
11394b212c2SPaul Mackerras
11494b212c2SPaul Mackerras int
main(int ac,char ** av)11594b212c2SPaul Mackerras main(int ac, char **av)
11694b212c2SPaul Mackerras {
1175663a123SPaul Mackerras int fd, n, i;
118284b52c4SCédric Le Goater unsigned long ph, ps, np;
119284b52c4SCédric Le Goater long nnote, nnote2, ns;
12094b212c2SPaul Mackerras
1215663a123SPaul Mackerras if (ac != 2) {
1225663a123SPaul Mackerras fprintf(stderr, "Usage: %s elf-file\n", av[0]);
12394b212c2SPaul Mackerras exit(1);
12494b212c2SPaul Mackerras }
1255663a123SPaul Mackerras fd = open(av[1], O_RDWR);
12694b212c2SPaul Mackerras if (fd < 0) {
1275663a123SPaul Mackerras perror(av[1]);
12894b212c2SPaul Mackerras exit(1);
12994b212c2SPaul Mackerras }
13094b212c2SPaul Mackerras
13194b212c2SPaul Mackerras nnote = 12 + ROUNDUP(strlen(arch) + 1) + sizeof(descr);
13294b212c2SPaul Mackerras nnote2 = 12 + ROUNDUP(strlen(rpaname) + 1) + sizeof(rpanote);
13394b212c2SPaul Mackerras
13494b212c2SPaul Mackerras n = read(fd, buf, sizeof(buf));
13594b212c2SPaul Mackerras if (n < 0) {
13694b212c2SPaul Mackerras perror("read");
13794b212c2SPaul Mackerras exit(1);
13894b212c2SPaul Mackerras }
13994b212c2SPaul Mackerras
140284b52c4SCédric Le Goater if (memcmp(&buf[E_IDENT+EI_MAGIC], elf_magic, 4) != 0)
141284b52c4SCédric Le Goater goto notelf;
142284b52c4SCédric Le Goater e_class = buf[E_IDENT+EI_CLASS];
143284b52c4SCédric Le Goater if (e_class != ELFCLASS32 && e_class != ELFCLASS64)
144284b52c4SCédric Le Goater goto notelf;
145284b52c4SCédric Le Goater e_data = buf[E_IDENT+EI_DATA];
146284b52c4SCédric Le Goater if (e_data != ELFDATA2MSB && e_data != ELFDATA2LSB)
147284b52c4SCédric Le Goater goto notelf;
148284b52c4SCédric Le Goater if (n < E_HSIZE)
14994b212c2SPaul Mackerras goto notelf;
15094b212c2SPaul Mackerras
151284b52c4SCédric Le Goater ph = (e_class == ELFCLASS32 ? GET_32(E_PHOFF) : GET_64(E_PHOFF));
152284b52c4SCédric Le Goater ps = GET_16(E_PHENTSIZE);
153284b52c4SCédric Le Goater np = GET_16(E_PHNUM);
15494b212c2SPaul Mackerras if (ph < E_HSIZE || ps < PH_HSIZE || np < 1)
15594b212c2SPaul Mackerras goto notelf;
15694b212c2SPaul Mackerras if (ph + (np + 2) * ps + nnote + nnote2 > n)
15794b212c2SPaul Mackerras goto nospace;
15894b212c2SPaul Mackerras
15994b212c2SPaul Mackerras for (i = 0; i < np; ++i) {
160284b52c4SCédric Le Goater if (GET_32(ph + PH_TYPE) == PT_NOTE) {
16194b212c2SPaul Mackerras fprintf(stderr, "%s already has a note entry\n",
1625663a123SPaul Mackerras av[1]);
16394b212c2SPaul Mackerras exit(0);
16494b212c2SPaul Mackerras }
16594b212c2SPaul Mackerras ph += ps;
16694b212c2SPaul Mackerras }
16794b212c2SPaul Mackerras
16894b212c2SPaul Mackerras /* XXX check that the area we want to use is all zeroes */
16994b212c2SPaul Mackerras for (i = 0; i < 2 * ps + nnote + nnote2; ++i)
17094b212c2SPaul Mackerras if (buf[ph + i] != 0)
17194b212c2SPaul Mackerras goto nospace;
17294b212c2SPaul Mackerras
17394b212c2SPaul Mackerras /* fill in the program header entry */
17494b212c2SPaul Mackerras ns = ph + 2 * ps;
175284b52c4SCédric Le Goater PUT_32(ph + PH_TYPE, PT_NOTE);
176284b52c4SCédric Le Goater if (e_class == ELFCLASS32)
177284b52c4SCédric Le Goater PUT_32(ph + PH_OFFSET, ns);
178284b52c4SCédric Le Goater else
179284b52c4SCédric Le Goater PUT_64(ph + PH_OFFSET, ns);
180284b52c4SCédric Le Goater
181284b52c4SCédric Le Goater if (e_class == ELFCLASS32)
182284b52c4SCédric Le Goater PUT_32(ph + PH_FILESZ, nnote);
183284b52c4SCédric Le Goater else
184284b52c4SCédric Le Goater PUT_64(ph + PH_FILESZ, nnote);
18594b212c2SPaul Mackerras
18694b212c2SPaul Mackerras /* fill in the note area we point to */
18794b212c2SPaul Mackerras /* XXX we should probably make this a proper section */
188284b52c4SCédric Le Goater PUT_32(ns, strlen(arch) + 1);
189284b52c4SCédric Le Goater PUT_32(ns + 4, N_DESCR * 4);
190284b52c4SCédric Le Goater PUT_32(ns + 8, 0x1275);
19194b212c2SPaul Mackerras strcpy((char *) &buf[ns + 12], arch);
19294b212c2SPaul Mackerras ns += 12 + strlen(arch) + 1;
19394b212c2SPaul Mackerras for (i = 0; i < N_DESCR; ++i, ns += 4)
1945663a123SPaul Mackerras PUT_32BE(ns, descr[i]);
19594b212c2SPaul Mackerras
19694b212c2SPaul Mackerras /* fill in the second program header entry and the RPA note area */
19794b212c2SPaul Mackerras ph += ps;
198284b52c4SCédric Le Goater PUT_32(ph + PH_TYPE, PT_NOTE);
199284b52c4SCédric Le Goater if (e_class == ELFCLASS32)
200284b52c4SCédric Le Goater PUT_32(ph + PH_OFFSET, ns);
201284b52c4SCédric Le Goater else
202284b52c4SCédric Le Goater PUT_64(ph + PH_OFFSET, ns);
203284b52c4SCédric Le Goater
204284b52c4SCédric Le Goater if (e_class == ELFCLASS32)
205284b52c4SCédric Le Goater PUT_32(ph + PH_FILESZ, nnote);
206284b52c4SCédric Le Goater else
207284b52c4SCédric Le Goater PUT_64(ph + PH_FILESZ, nnote2);
20894b212c2SPaul Mackerras
20994b212c2SPaul Mackerras /* fill in the note area we point to */
210284b52c4SCédric Le Goater PUT_32(ns, strlen(rpaname) + 1);
211284b52c4SCédric Le Goater PUT_32(ns + 4, sizeof(rpanote));
212284b52c4SCédric Le Goater PUT_32(ns + 8, 0x12759999);
21394b212c2SPaul Mackerras strcpy((char *) &buf[ns + 12], rpaname);
21494b212c2SPaul Mackerras ns += 12 + ROUNDUP(strlen(rpaname) + 1);
21594b212c2SPaul Mackerras for (i = 0; i < N_RPA_DESCR; ++i, ns += 4)
2165663a123SPaul Mackerras PUT_32BE(ns, rpanote[i]);
21794b212c2SPaul Mackerras
21894b212c2SPaul Mackerras /* Update the number of program headers */
219284b52c4SCédric Le Goater PUT_16(E_PHNUM, np + 2);
22094b212c2SPaul Mackerras
22194b212c2SPaul Mackerras /* write back */
2225d085ec0SBo YU i = lseek(fd, (long) 0, SEEK_SET);
2235d085ec0SBo YU if (i < 0) {
2245d085ec0SBo YU perror("lseek");
2255d085ec0SBo YU exit(1);
2265d085ec0SBo YU }
22794b212c2SPaul Mackerras i = write(fd, buf, n);
22894b212c2SPaul Mackerras if (i < 0) {
22994b212c2SPaul Mackerras perror("write");
23094b212c2SPaul Mackerras exit(1);
23194b212c2SPaul Mackerras }
23294b212c2SPaul Mackerras if (i < n) {
2335663a123SPaul Mackerras fprintf(stderr, "%s: write truncated\n", av[1]);
23494b212c2SPaul Mackerras exit(1);
23594b212c2SPaul Mackerras }
23694b212c2SPaul Mackerras
23794b212c2SPaul Mackerras exit(0);
23894b212c2SPaul Mackerras
23994b212c2SPaul Mackerras notelf:
2405663a123SPaul Mackerras fprintf(stderr, "%s does not appear to be an ELF file\n", av[1]);
24194b212c2SPaul Mackerras exit(1);
24294b212c2SPaul Mackerras
24394b212c2SPaul Mackerras nospace:
24494b212c2SPaul Mackerras fprintf(stderr, "sorry, I can't find space in %s to put the note\n",
2455663a123SPaul Mackerras av[1]);
24694b212c2SPaul Mackerras exit(1);
24794b212c2SPaul Mackerras }
248