OSDN Git Service

remoteproc: Add elf64 support in elf loader
authorClement Leger <cleger@kalray.eu>
Mon, 2 Mar 2020 09:39:00 +0000 (10:39 +0100)
committerBjorn Andersson <bjorn.andersson@linaro.org>
Thu, 26 Mar 2020 05:29:40 +0000 (22:29 -0700)
In order to support elf64, use macros from remoteproc_elf_helpers.h
to access elf headers depending on elf class.
To allow new drivers to support elf64, add rproc_elf_sanity_check
function which make more sense than adding a elf64 named one since
it will support both elf versions.
Driver which need to support both elf32/elf64 should use this new
function for elf sanity check instead of the elf32 one.

Signed-off-by: Clement Leger <cleger@kalray.eu>
Tested-by: Arnaud POULIQUEN <arnaud.pouliquen@st.com>
Link: https://lore.kernel.org/r/20200302093902.27849-7-cleger@kalray.eu
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Documentation/remoteproc.txt
drivers/remoteproc/remoteproc_elf_loader.c
drivers/remoteproc/remoteproc_internal.h

index 03c3d2e..2be1147 100644 (file)
@@ -230,7 +230,7 @@ in the used rings.
 Binary Firmware Structure
 =========================
 
-At this point remoteproc only supports ELF32 firmware binaries. However,
+At this point remoteproc supports ELF32 and ELF64 firmware binaries. However,
 it is quite expected that other platforms/devices which we'd want to
 support with this framework will be based on different binary formats.
 
index 5a67745..4869fb7 100644 (file)
 #include <linux/elf.h>
 
 #include "remoteproc_internal.h"
+#include "remoteproc_elf_helpers.h"
 
 /**
- * rproc_elf_sanity_check() - Sanity Check ELF32 firmware image
+ * rproc_elf_sanity_check() - Sanity Check for ELF32/ELF64 firmware image
  * @rproc: the remote processor handle
  * @fw: the ELF firmware image
  *
- * Make sure this fw image is sane.
+ * Make sure this fw image is sane (ie a correct ELF32/ELF64 file).
  */
-int rproc_elf32_sanity_check(struct rproc *rproc, const struct firmware *fw)
+int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw)
 {
        const char *name = rproc->firmware;
        struct device *dev = &rproc->dev;
+       /*
+        * Elf files are beginning with the same structure. Thus, to simplify
+        * header parsing, we can use the elf32_hdr one for both elf64 and
+        * elf32.
+        */
        struct elf32_hdr *ehdr;
+       u32 elf_shdr_get_size;
+       u64 phoff, shoff;
        char class;
+       u16 phnum;
 
        if (!fw) {
                dev_err(dev, "failed to load %s\n", name);
@@ -50,13 +59,22 @@ int rproc_elf32_sanity_check(struct rproc *rproc, const struct firmware *fw)
 
        ehdr = (struct elf32_hdr *)fw->data;
 
-       /* We only support ELF32 at this point */
+       if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
+               dev_err(dev, "Image is corrupted (bad magic)\n");
+               return -EINVAL;
+       }
+
        class = ehdr->e_ident[EI_CLASS];
-       if (class != ELFCLASS32) {
+       if (class != ELFCLASS32 && class != ELFCLASS64) {
                dev_err(dev, "Unsupported class: %d\n", class);
                return -EINVAL;
        }
 
+       if (class == ELFCLASS64 && fw->size < sizeof(struct elf64_hdr)) {
+               dev_err(dev, "elf64 header is too small\n");
+               return -EINVAL;
+       }
+
        /* We assume the firmware has the same endianness as the host */
 # ifdef __LITTLE_ENDIAN
        if (ehdr->e_ident[EI_DATA] != ELFDATA2LSB) {
@@ -67,28 +85,52 @@ int rproc_elf32_sanity_check(struct rproc *rproc, const struct firmware *fw)
                return -EINVAL;
        }
 
-       if (fw->size < ehdr->e_shoff + sizeof(struct elf32_shdr)) {
-               dev_err(dev, "Image is too small\n");
-               return -EINVAL;
-       }
+       phoff = elf_hdr_get_e_phoff(class, fw->data);
+       shoff = elf_hdr_get_e_shoff(class, fw->data);
+       phnum =  elf_hdr_get_e_phnum(class, fw->data);
+       elf_shdr_get_size = elf_size_of_shdr(class);
 
-       if (memcmp(ehdr->e_ident, ELFMAG, SELFMAG)) {
-               dev_err(dev, "Image is corrupted (bad magic)\n");
+       if (fw->size < shoff + elf_shdr_get_size) {
+               dev_err(dev, "Image is too small\n");
                return -EINVAL;
        }
 
-       if (ehdr->e_phnum == 0) {
+       if (phnum == 0) {
                dev_err(dev, "No loadable segments\n");
                return -EINVAL;
        }
 
-       if (ehdr->e_phoff > fw->size) {
+       if (phoff > fw->size) {
                dev_err(dev, "Firmware size is too small\n");
                return -EINVAL;
        }
 
+       dev_dbg(dev, "Firmware is an elf%d file\n",
+               class == ELFCLASS32 ? 32 : 64);
+
        return 0;
 }
+EXPORT_SYMBOL(rproc_elf_sanity_check);
+
+/**
+ * rproc_elf_sanity_check() - Sanity Check ELF32 firmware image
+ * @rproc: the remote processor handle
+ * @fw: the ELF32 firmware image
+ *
+ * Make sure this fw image is sane.
+ */
+int rproc_elf32_sanity_check(struct rproc *rproc, const struct firmware *fw)
+{
+       int ret = rproc_elf_sanity_check(rproc, fw);
+
+       if (ret)
+               return ret;
+
+       if (fw_elf_get_class(fw) == ELFCLASS32)
+               return 0;
+
+       return -EINVAL;
+}
 EXPORT_SYMBOL(rproc_elf32_sanity_check);
 
 /**
@@ -104,9 +146,7 @@ EXPORT_SYMBOL(rproc_elf32_sanity_check);
  */
 u64 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw)
 {
-       struct elf32_hdr *ehdr  = (struct elf32_hdr *)fw->data;
-
-       return ehdr->e_entry;
+       return elf_hdr_get_e_entry(fw_elf_get_class(fw), fw->data);
 }
 EXPORT_SYMBOL(rproc_elf_get_boot_addr);
 
@@ -137,53 +177,65 @@ EXPORT_SYMBOL(rproc_elf_get_boot_addr);
 int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw)
 {
        struct device *dev = &rproc->dev;
-       struct elf32_hdr *ehdr;
-       struct elf32_phdr *phdr;
+       const void *ehdr, *phdr;
        int i, ret = 0;
+       u16 phnum;
        const u8 *elf_data = fw->data;
+       u8 class = fw_elf_get_class(fw);
+       u32 elf_phdr_get_size = elf_size_of_phdr(class);
 
-       ehdr = (struct elf32_hdr *)elf_data;
-       phdr = (struct elf32_phdr *)(elf_data + ehdr->e_phoff);
+       ehdr = elf_data;
+       phnum = elf_hdr_get_e_phnum(class, ehdr);
+       phdr = elf_data + elf_hdr_get_e_phoff(class, ehdr);
 
        /* go through the available ELF segments */
-       for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
-               u32 da = phdr->p_paddr;
-               u32 memsz = phdr->p_memsz;
-               u32 filesz = phdr->p_filesz;
-               u32 offset = phdr->p_offset;
+       for (i = 0; i < phnum; i++, phdr += elf_phdr_get_size) {
+               u64 da = elf_phdr_get_p_paddr(class, phdr);
+               u64 memsz = elf_phdr_get_p_memsz(class, phdr);
+               u64 filesz = elf_phdr_get_p_filesz(class, phdr);
+               u64 offset = elf_phdr_get_p_offset(class, phdr);
+               u32 type = elf_phdr_get_p_type(class, phdr);
                void *ptr;
 
-               if (phdr->p_type != PT_LOAD)
+               if (type != PT_LOAD)
                        continue;
 
-               dev_dbg(dev, "phdr: type %d da 0x%x memsz 0x%x filesz 0x%x\n",
-                       phdr->p_type, da, memsz, filesz);
+               dev_dbg(dev, "phdr: type %d da 0x%llx memsz 0x%llx filesz 0x%llx\n",
+                       type, da, memsz, filesz);
 
                if (filesz > memsz) {
-                       dev_err(dev, "bad phdr filesz 0x%x memsz 0x%x\n",
+                       dev_err(dev, "bad phdr filesz 0x%llx memsz 0x%llx\n",
                                filesz, memsz);
                        ret = -EINVAL;
                        break;
                }
 
                if (offset + filesz > fw->size) {
-                       dev_err(dev, "truncated fw: need 0x%x avail 0x%zx\n",
+                       dev_err(dev, "truncated fw: need 0x%llx avail 0x%zx\n",
                                offset + filesz, fw->size);
                        ret = -EINVAL;
                        break;
                }
 
+               if (!rproc_u64_fit_in_size_t(memsz)) {
+                       dev_err(dev, "size (%llx) does not fit in size_t type\n",
+                               memsz);
+                       ret = -EOVERFLOW;
+                       break;
+               }
+
                /* grab the kernel address for this device address */
                ptr = rproc_da_to_va(rproc, da, memsz);
                if (!ptr) {
-                       dev_err(dev, "bad phdr da 0x%x mem 0x%x\n", da, memsz);
+                       dev_err(dev, "bad phdr da 0x%llx mem 0x%llx\n", da,
+                               memsz);
                        ret = -EINVAL;
                        break;
                }
 
                /* put the segment where the remote processor expects it */
-               if (phdr->p_filesz)
-                       memcpy(ptr, elf_data + phdr->p_offset, filesz);
+               if (filesz)
+                       memcpy(ptr, elf_data + offset, filesz);
 
                /*
                 * Zero out remaining memory for this segment.
@@ -200,24 +252,35 @@ int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw)
 }
 EXPORT_SYMBOL(rproc_elf_load_segments);
 
-static struct elf32_shdr *
-find_table(struct device *dev, struct elf32_hdr *ehdr, size_t fw_size)
+static const void *
+find_table(struct device *dev, const struct firmware *fw)
 {
-       struct elf32_shdr *shdr;
+       const void *shdr, *name_table_shdr;
        int i;
        const char *name_table;
        struct resource_table *table = NULL;
-       const u8 *elf_data = (void *)ehdr;
+       const u8 *elf_data = (void *)fw->data;
+       u8 class = fw_elf_get_class(fw);
+       size_t fw_size = fw->size;
+       const void *ehdr = elf_data;
+       u16 shnum = elf_hdr_get_e_shnum(class, ehdr);
+       u32 elf_shdr_get_size = elf_size_of_shdr(class);
+       u16 shstrndx = elf_hdr_get_e_shstrndx(class, ehdr);
 
        /* look for the resource table and handle it */
-       shdr = (struct elf32_shdr *)(elf_data + ehdr->e_shoff);
-       name_table = elf_data + shdr[ehdr->e_shstrndx].sh_offset;
-
-       for (i = 0; i < ehdr->e_shnum; i++, shdr++) {
-               u32 size = shdr->sh_size;
-               u32 offset = shdr->sh_offset;
-
-               if (strcmp(name_table + shdr->sh_name, ".resource_table"))
+       /* First, get the section header according to the elf class */
+       shdr = elf_data + elf_hdr_get_e_shoff(class, ehdr);
+       /* Compute name table section header entry in shdr array */
+       name_table_shdr = shdr + (shstrndx * elf_shdr_get_size);
+       /* Finally, compute the name table section address in elf */
+       name_table = elf_data + elf_shdr_get_sh_offset(class, name_table_shdr);
+
+       for (i = 0; i < shnum; i++, shdr += elf_shdr_get_size) {
+               u64 size = elf_shdr_get_sh_size(class, shdr);
+               u64 offset = elf_shdr_get_sh_offset(class, shdr);
+               u32 name = elf_shdr_get_sh_name(class, shdr);
+
+               if (strcmp(name_table + name, ".resource_table"))
                        continue;
 
                table = (struct resource_table *)(elf_data + offset);
@@ -270,21 +333,21 @@ find_table(struct device *dev, struct elf32_hdr *ehdr, size_t fw_size)
  */
 int rproc_elf_load_rsc_table(struct rproc *rproc, const struct firmware *fw)
 {
-       struct elf32_hdr *ehdr;
-       struct elf32_shdr *shdr;
+       const void *shdr;
        struct device *dev = &rproc->dev;
        struct resource_table *table = NULL;
        const u8 *elf_data = fw->data;
        size_t tablesz;
+       u8 class = fw_elf_get_class(fw);
+       u64 sh_offset;
 
-       ehdr = (struct elf32_hdr *)elf_data;
-
-       shdr = find_table(dev, ehdr, fw->size);
+       shdr = find_table(dev, fw);
        if (!shdr)
                return -EINVAL;
 
-       table = (struct resource_table *)(elf_data + shdr->sh_offset);
-       tablesz = shdr->sh_size;
+       sh_offset = elf_shdr_get_sh_offset(class, shdr);
+       table = (struct resource_table *)(elf_data + sh_offset);
+       tablesz = elf_shdr_get_sh_size(class, shdr);
 
        /*
         * Create a copy of the resource table. When a virtio device starts
@@ -317,13 +380,24 @@ EXPORT_SYMBOL(rproc_elf_load_rsc_table);
 struct resource_table *rproc_elf_find_loaded_rsc_table(struct rproc *rproc,
                                                       const struct firmware *fw)
 {
-       struct elf32_hdr *ehdr = (struct elf32_hdr *)fw->data;
-       struct elf32_shdr *shdr;
+       const void *shdr;
+       u64 sh_addr, sh_size;
+       u8 class = fw_elf_get_class(fw);
+       struct device *dev = &rproc->dev;
 
-       shdr = find_table(&rproc->dev, ehdr, fw->size);
+       shdr = find_table(&rproc->dev, fw);
        if (!shdr)
                return NULL;
 
-       return rproc_da_to_va(rproc, shdr->sh_addr, shdr->sh_size);
+       sh_addr = elf_shdr_get_sh_addr(class, shdr);
+       sh_size = elf_shdr_get_sh_size(class, shdr);
+
+       if (!rproc_u64_fit_in_size_t(sh_size)) {
+               dev_err(dev, "size (%llx) does not fit in size_t type\n",
+                       sh_size);
+               return NULL;
+       }
+
+       return rproc_da_to_va(rproc, sh_addr, sh_size);
 }
 EXPORT_SYMBOL(rproc_elf_find_loaded_rsc_table);
index 85903f5..b389dc7 100644 (file)
@@ -55,6 +55,7 @@ phys_addr_t rproc_va_to_pa(void *cpu_addr);
 int rproc_trigger_recovery(struct rproc *rproc);
 
 int rproc_elf32_sanity_check(struct rproc *rproc, const struct firmware *fw);
+int rproc_elf_sanity_check(struct rproc *rproc, const struct firmware *fw);
 u64 rproc_elf_get_boot_addr(struct rproc *rproc, const struct firmware *fw);
 int rproc_elf_load_segments(struct rproc *rproc, const struct firmware *fw);
 int rproc_elf_load_rsc_table(struct rproc *rproc, const struct firmware *fw);
@@ -119,4 +120,13 @@ struct resource_table *rproc_find_loaded_rsc_table(struct rproc *rproc,
        return NULL;
 }
 
+static inline
+bool rproc_u64_fit_in_size_t(u64 val)
+{
+       if (sizeof(size_t) == sizeof(u64))
+               return true;
+
+       return (val <= (size_t) -1);
+}
+
 #endif /* REMOTEPROC_INTERNAL_H */