nuttx/libs/libc/elf/elf.h
Marco Casaroli 014ea57042 libs/libc/elf: Translate link-time addresses through one place.
The ET_DYN path computes run-time addresses from link-time ones in five
places, each open-coding the arithmetic, and two of them disagree about
how: libelf_relocatedyn() adds textalloc to a relocation's r_offset in
one branch and subtracts datasec before adding datastart in the next,
while the value translation a few lines further down picks between those
two forms with an explicit test on datasec.

Collect that into libelf_addr(), which makes the test once: an address
below the data segment's link-time base belongs to text, anything at or
above it to data.

This changes nothing today.  libelf_elfsize() sets

  segpad   = datasec - (text_vaddr + textsize)

and libelf_load() then places

  datastart = textalloc + textsize + segpad

so datastart - datasec is textalloc, and the data branch reduces to
textalloc + vaddr -- exactly what the text branch returns, and exactly
what adding a single load bias did before.  The two forms are the same
arithmetic written twice.

They stop being the same once text and data are placed independently,
which is what an FDPIC object requires: its two PT_LOAD segments are
relocated separately so that the read-only one can be mapped in place on
the media while only the writable one is copied.  Having the translation
in one function is what makes that possible without auditing every
open-coded expression again.

Built for mps3-an547:picostest, which is CONFIG_ELF with CONFIG_PIC, and
boots identically to the same configuration without this change.

Assisted-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
2026-08-27 19:01:58 -03:00

352 lines
12 KiB
C

/****************************************************************************
* libs/libc/elf/elf.h
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __LIBS_LIBC_LIBC_ELF_LIBC_ELF_H
#define __LIBS_LIBC_LIBC_ELF_LIBC_ELF_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/addrenv.h>
#include <nuttx/lib/elf.h>
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: libelf_verifyheader
*
* Description:
* Given the header from a possible ELF executable, verify that it is
* an ELF executable.
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_verifyheader(FAR const Elf_Ehdr *header);
/****************************************************************************
* Name: libelf_findsymtab
*
* Description:
* Find the symbol table section.
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_findsymtab(FAR struct mod_loadinfo_s *loadinfo);
/****************************************************************************
* Name: libelf_readsym
*
* Description:
* Read the ELF symbol structure at the specified index into memory.
*
* Input Parameters:
* loadinfo - Load state information
* index - Symbol table index
* sym - Location to return the table entry
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_readsym(FAR struct mod_loadinfo_s *loadinfo, int index,
FAR Elf_Sym *sym, FAR Elf_Shdr *shdr);
/****************************************************************************
* Name: libelf_symvalue
*
* Description:
* Get the value of a symbol. The updated value of the symbol is returned
* in the st_value field of the symbol table entry.
*
* Input Parameters:
* modp - Module state information
* loadinfo - Load state information
* sym - Symbol table entry (value might be undefined)
* sh_offset - Offset of strtab
* exports - Pointer to the symbol table
* nexports - Number of symbols in the symbol table*
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
* EINVAL - There is something inconsistent in the symbol table (should
* only happen if the file is corrupted)
* ENOSYS - Symbol lies in common
* ESRCH - Symbol has no name
* ENOENT - Symbol undefined and not provided via a symbol table
*
****************************************************************************/
int libelf_symvalue(FAR struct module_s *modp,
FAR struct mod_loadinfo_s *loadinfo, FAR Elf_Sym *sym,
Elf_Off sh_offset,
FAR const struct symtab_s *exports, int nexports);
/****************************************************************************
* Name: libelf_insertsymtab
*
* Description:
* Insert a symbol table for the current module.
*
* Input Parameters:
* modp - Module state information
* loadinfo - Module load information
* shdr - Symbol table section header
* sym - Symbol table entry
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
* ENOMEM - Symbol undefined and not provided via a symbol table
*
****************************************************************************/
int libelf_insertsymtab(FAR struct module_s *modp,
FAR struct mod_loadinfo_s *loadinfo,
FAR Elf_Shdr *shdr,
FAR Elf_Sym *sym);
/****************************************************************************
* Name: libelf_findglobal
*
* Description:
* Find a symbol in the global symbol table
*
* Input Parameters:
* modp - Module state information
* loadinfo - Module load information
* shdr - Symbol table section header
* sym - Symbol table entry
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
* ENOMEM - Symbol undefined and not provided via a symbol table
*
****************************************************************************/
void *libelf_findglobal(FAR struct module_s *modp,
FAR struct mod_loadinfo_s *loadinfo,
FAR Elf_Shdr *shdr,
FAR Elf_Sym *sym);
/****************************************************************************
* Name: libelf_loadhdrs
*
* Description:
* Loads program and section headers into memory.
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_loadhdrs(FAR struct mod_loadinfo_s *loadinfo);
/****************************************************************************
* Name: libelf_sectname
*
* Description:
* Get the symbol name in loadinfo->iobuffer[].
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_sectname(FAR struct mod_loadinfo_s *loadinfo,
FAR const Elf_Shdr *shdr);
/****************************************************************************
* Name: libelf_allocbuffer
*
* Description:
* Perform the initial allocation of the I/O buffer, if it has not already
* been allocated.
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_allocbuffer(FAR struct mod_loadinfo_s *loadinfo);
/****************************************************************************
* Name: libelf_reallocbuffer
*
* Description:
* Increase the size of I/O buffer by the specified buffer increment.
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_reallocbuffer(FAR struct mod_loadinfo_s *loadinfo,
size_t increment);
/****************************************************************************
* Name: libelf_freebuffers
*
* Description:
* Release all working buffers.
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on
* failure.
*
****************************************************************************/
int libelf_freebuffers(FAR struct mod_loadinfo_s *loadinfo);
/****************************************************************************
* Name: libelf_addr
*
* Description:
* Translate a link-time address in a loaded object to the address it
* occupies now. An address below the data segment's link-time base
* belongs to text, anything at or above it to data.
*
* Input Parameters:
* loadinfo - Load state information
* vaddr - The link-time address to translate
*
* Returned Value:
* The run-time address.
*
****************************************************************************/
static inline uintptr_t libelf_addr(FAR struct mod_loadinfo_s *loadinfo,
uintptr_t vaddr)
{
if (loadinfo->datasec != 0 && vaddr >= loadinfo->datasec)
{
return loadinfo->datastart + (vaddr - loadinfo->datasec);
}
return loadinfo->textalloc + vaddr;
}
#ifdef CONFIG_ARCH_ADDRENV
/****************************************************************************
* Name: libelf_addrenv_alloc
*
* Description:
* Allocate memory for the ELF image (textalloc and datastart). If
* CONFIG_ARCH_ADDRENV=n, textalloc will be allocated using kmm_zalloc()
* and datastart will be a offset from textalloc. If
* CONFIG_ARCH_ADDRENV=y, then textalloc and datastart will be allocated
* using up_addrenv_create(). In either case, there will be a unique
* instance of textalloc and datastart (and stack) for each instance of a
* process.
*
* Input Parameters:
* loadinfo - Load state information
* textsize - The size (in bytes) of the .text address environment needed
* for the ELF image (read/execute).
* datasize - The size (in bytes) of the .bss/.data address environment
* needed for the ELF image (read/write).
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int libelf_addrenv_alloc(FAR struct mod_loadinfo_s *loadinfo,
size_t textsize, size_t datasize);
/****************************************************************************
* Name: libelf_addrenv_select
*
* Description:
* Temporarily select the task's address environment.
*
* Input Parameters:
* loadinfo - Load state information
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int libelf_addrenv_select(FAR struct mod_loadinfo_s *loadinfo);
/****************************************************************************
* Name: libelf_addrenv_restore
*
* Description:
* Restore the address environment before libelf_addrenv_select() was
* called.
*
* Input Parameters:
* loadinfo - Load state information
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
int libelf_addrenv_restore(FAR struct mod_loadinfo_s *loadinfo);
/****************************************************************************
* Name: libelf_addrenv_free
*
* Description:
* Release the address environment previously created by
* libelf_addrenv_alloc(). This function is called only under certain
* error conditions after the module has been loaded but not yet started.
* After the module has been started, the address environment will
* automatically be freed when the module exits.
*
* Input Parameters:
* loadinfo - Load state information
*
* Returned Value:
* None.
*
****************************************************************************/
void libelf_addrenv_free(FAR struct mod_loadinfo_s *loadinfo);
#endif /* CONFIG_ARCH_ADDRENV */
#endif /* __LIBS_LIBC_LIBC_ELF_LIBC_ELF_H */