1 /* Postprocess pmd object files to export hw support
3 * Copyright 2016 Neil Horman <nhorman@tuxdriver.com>
4 * Based in part on modpost.c from the linux kernel
6 * This software may be used and distributed according to the terms
7 * of the GNU General Public License V2, incorporated herein by reference.
18 #include "pmdinfogen.h"
27 static const char *sym_name(struct elf_info *elf, Elf_Sym *sym)
30 return elf->strtab + sym->st_name;
35 void *grab_file(const char *filename, unsigned long *size)
38 void *map = MAP_FAILED;
41 fd = open(filename, O_RDONLY);
48 map = mmap(NULL, *size, PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
52 if (map == MAP_FAILED)
58 * Return a copy of the next line in a mmap'ed file.
59 * spaces in the beginning of the line is trimmed away.
60 * Return a pointer to a static buffer.
62 void release_file(void *file, unsigned long size)
68 static void *get_sym_value(struct elf_info *info, const Elf_Sym *sym)
70 void *ptr = (void *)info->hdr + info->sechdrs[sym->st_shndx].sh_offset;
72 return (void *)(ptr + sym->st_value);
75 static Elf_Sym *find_sym_in_symtab(struct elf_info *info,
76 const char *name, Elf_Sym *last)
82 idx = info->symtab_start;
84 for (; idx < info->symtab_stop; idx++) {
85 const char *n = sym_name(info, idx);
86 if (!strncmp(n, name, strlen(name)))
92 static int parse_elf(struct elf_info *info, const char *filename)
98 const char *secstrings;
100 unsigned int symtab_idx = ~0U, symtab_shndx_idx = ~0U;
102 hdr = grab_file(filename, &info->size);
108 if (info->size < sizeof(*hdr)) {
109 /* file too small, assume this is an empty .o file */
112 /* Is this a valid ELF file? */
113 if ((hdr->e_ident[EI_MAG0] != ELFMAG0) ||
114 (hdr->e_ident[EI_MAG1] != ELFMAG1) ||
115 (hdr->e_ident[EI_MAG2] != ELFMAG2) ||
116 (hdr->e_ident[EI_MAG3] != ELFMAG3)) {
117 /* Not an ELF file - silently ignore it */
121 if (!hdr->e_ident[EI_DATA]) {
126 endian = hdr->e_ident[EI_DATA];
128 /* Fix endianness in ELF header */
129 hdr->e_type = TO_NATIVE(endian, 16, hdr->e_type);
130 hdr->e_machine = TO_NATIVE(endian, 16, hdr->e_machine);
131 hdr->e_version = TO_NATIVE(endian, 32, hdr->e_version);
132 hdr->e_entry = TO_NATIVE(endian, ADDR_SIZE, hdr->e_entry);
133 hdr->e_phoff = TO_NATIVE(endian, ADDR_SIZE, hdr->e_phoff);
134 hdr->e_shoff = TO_NATIVE(endian, ADDR_SIZE, hdr->e_shoff);
135 hdr->e_flags = TO_NATIVE(endian, 32, hdr->e_flags);
136 hdr->e_ehsize = TO_NATIVE(endian, 16, hdr->e_ehsize);
137 hdr->e_phentsize = TO_NATIVE(endian, 16, hdr->e_phentsize);
138 hdr->e_phnum = TO_NATIVE(endian, 16, hdr->e_phnum);
139 hdr->e_shentsize = TO_NATIVE(endian, 16, hdr->e_shentsize);
140 hdr->e_shnum = TO_NATIVE(endian, 16, hdr->e_shnum);
141 hdr->e_shstrndx = TO_NATIVE(endian, 16, hdr->e_shstrndx);
143 sechdrs = (void *)hdr + hdr->e_shoff;
144 info->sechdrs = sechdrs;
146 /* Check if file offset is correct */
147 if (hdr->e_shoff > info->size) {
148 fprintf(stderr, "section header offset=%lu in file '%s' "
149 "is bigger than filesize=%lu\n",
150 (unsigned long)hdr->e_shoff,
151 filename, info->size);
155 if (hdr->e_shnum == SHN_UNDEF) {
157 * There are more than 64k sections,
158 * read count from .sh_size.
160 info->num_sections = TO_NATIVE(endian, 32, sechdrs[0].sh_size);
162 info->num_sections = hdr->e_shnum;
164 if (hdr->e_shstrndx == SHN_XINDEX)
165 info->secindex_strings =
166 TO_NATIVE(endian, 32, sechdrs[0].sh_link);
168 info->secindex_strings = hdr->e_shstrndx;
170 /* Fix endianness in section headers */
171 for (i = 0; i < info->num_sections; i++) {
173 TO_NATIVE(endian, 32, sechdrs[i].sh_name);
175 TO_NATIVE(endian, 32, sechdrs[i].sh_type);
176 sechdrs[i].sh_flags =
177 TO_NATIVE(endian, 32, sechdrs[i].sh_flags);
179 TO_NATIVE(endian, ADDR_SIZE, sechdrs[i].sh_addr);
180 sechdrs[i].sh_offset =
181 TO_NATIVE(endian, ADDR_SIZE, sechdrs[i].sh_offset);
183 TO_NATIVE(endian, 32, sechdrs[i].sh_size);
185 TO_NATIVE(endian, 32, sechdrs[i].sh_link);
187 TO_NATIVE(endian, 32, sechdrs[i].sh_info);
188 sechdrs[i].sh_addralign =
189 TO_NATIVE(endian, ADDR_SIZE, sechdrs[i].sh_addralign);
190 sechdrs[i].sh_entsize =
191 TO_NATIVE(endian, ADDR_SIZE, sechdrs[i].sh_entsize);
193 /* Find symbol table. */
194 secstrings = (void *)hdr + sechdrs[info->secindex_strings].sh_offset;
195 for (i = 1; i < info->num_sections; i++) {
196 int nobits = sechdrs[i].sh_type == SHT_NOBITS;
198 if (!nobits && sechdrs[i].sh_offset > info->size) {
199 fprintf(stderr, "%s is truncated. "
200 "sechdrs[i].sh_offset=%lu > sizeof(*hrd)=%zu\n",
201 filename, (unsigned long)sechdrs[i].sh_offset,
206 if (sechdrs[i].sh_type == SHT_SYMTAB) {
207 unsigned int sh_link_idx;
209 info->symtab_start = (void *)hdr +
210 sechdrs[i].sh_offset;
211 info->symtab_stop = (void *)hdr +
212 sechdrs[i].sh_offset + sechdrs[i].sh_size;
213 sh_link_idx = sechdrs[i].sh_link;
214 info->strtab = (void *)hdr +
215 sechdrs[sh_link_idx].sh_offset;
218 /* 32bit section no. table? ("more than 64k sections") */
219 if (sechdrs[i].sh_type == SHT_SYMTAB_SHNDX) {
220 symtab_shndx_idx = i;
221 info->symtab_shndx_start = (void *)hdr +
222 sechdrs[i].sh_offset;
223 info->symtab_shndx_stop = (void *)hdr +
224 sechdrs[i].sh_offset + sechdrs[i].sh_size;
227 if (!info->symtab_start)
228 fprintf(stderr, "%s has no symtab?\n", filename);
230 /* Fix endianness in symbols */
231 for (sym = info->symtab_start; sym < info->symtab_stop; sym++) {
232 sym->st_shndx = TO_NATIVE(endian, 16, sym->st_shndx);
233 sym->st_name = TO_NATIVE(endian, 32, sym->st_name);
234 sym->st_value = TO_NATIVE(endian, ADDR_SIZE, sym->st_value);
235 sym->st_size = TO_NATIVE(endian, ADDR_SIZE, sym->st_size);
238 if (symtab_shndx_idx != ~0U) {
240 if (symtab_idx != sechdrs[symtab_shndx_idx].sh_link)
242 "%s: SYMTAB_SHNDX has bad sh_link: %u!=%u\n",
243 filename, sechdrs[symtab_shndx_idx].sh_link,
246 for (p = info->symtab_shndx_start; p < info->symtab_shndx_stop;
248 *p = TO_NATIVE(endian, 32, *p);
254 static void parse_elf_finish(struct elf_info *info)
256 struct pmd_driver *tmp, *idx = info->drivers;
257 release_file(info->hdr, info->size);
265 static const char *sec_name(struct elf_info *elf, int secindex)
267 Elf_Shdr *sechdrs = elf->sechdrs;
268 return (void *)elf->hdr +
269 elf->sechdrs[elf->secindex_strings].sh_offset +
270 sechdrs[secindex].sh_name;
273 static int get_symbol_index(struct elf_info *info, Elf_Sym *sym)
275 const char *name = sym_name(info, sym);
292 static const struct opt_tag opt_tags[] = {
293 {"_param_string_export", "params"},
296 static int complete_pmd_entry(struct elf_info *info, struct pmd_driver *drv)
300 char tmpsymname[128];
303 drv->name = get_sym_value(info, drv->name_sym);
305 for (i = 0; i < PMD_OPT_MAX; i++) {
306 memset(tmpsymname, 0, 128);
307 sprintf(tmpsymname, "__%s%s", drv->name, opt_tags[i].suffix);
308 tmpsym = find_sym_in_symtab(info, tmpsymname, NULL);
311 drv->opt_vals[i] = get_sym_value(info, tmpsym);
314 memset(tmpsymname, 0, 128);
315 sprintf(tmpsymname, "__%s_pci_tbl_export", drv->name);
317 tmpsym = find_sym_in_symtab(info, tmpsymname, NULL);
321 * If this returns NULL, then this is a PMD_VDEV, because
322 * it has no pci table reference
329 tname = get_sym_value(info, tmpsym);
330 tmpsym = find_sym_in_symtab(info, tname, NULL);
334 drv->pci_tbl = (struct rte_pci_id *)get_sym_value(info, tmpsym);
341 static int locate_pmd_entries(struct elf_info *info)
343 Elf_Sym *last = NULL;
344 struct pmd_driver *new;
346 info->drivers = NULL;
349 new = calloc(sizeof(struct pmd_driver), 1);
350 new->name_sym = find_sym_in_symtab(info, "this_pmd_name", last);
351 last = new->name_sym;
355 if (complete_pmd_entry(info, new)) {
357 "Failed to complete pmd entry\n");
360 new->next = info->drivers;
367 static void output_pmd_info_string(struct elf_info *info, char *outfile)
370 struct pmd_driver *drv;
371 struct rte_pci_id *pci_ids;
374 ofd = fopen(outfile, "w+");
376 fprintf(stderr, "Unable to open output file\n");
383 fprintf(ofd, "const char %s_pmd_info[] __attribute__((used)) = "
384 "\"PMD_INFO_STRING= {",
386 fprintf(ofd, "\\\"name\\\" : \\\"%s\\\", ", drv->name);
388 for (idx = 0; idx < PMD_OPT_MAX; idx++) {
389 if (drv->opt_vals[idx])
390 fprintf(ofd, "\\\"%s\\\" : \\\"%s\\\", ",
391 opt_tags[idx].json_id,
395 pci_ids = drv->pci_tbl;
396 fprintf(ofd, "\\\"pci_ids\\\" : [");
398 while (pci_ids && pci_ids->device_id) {
399 fprintf(ofd, "[%d, %d, %d, %d]",
400 pci_ids->vendor_id, pci_ids->device_id,
401 pci_ids->subsystem_vendor_id,
402 pci_ids->subsystem_device_id);
404 if (pci_ids->device_id)
409 fprintf(ofd, "]}\";");
416 int main(int argc, char **argv)
418 struct elf_info info;
423 "usage: pmdinfo <object file> <c output file>\n");
426 parse_elf(&info, argv[1]);
428 locate_pmd_entries(&info);
431 output_pmd_info_string(&info, argv[2]);
434 fprintf(stderr, "No drivers registered\n");
437 parse_elf_finish(&info);