nuttx/libs/libc/elf/elf.h
Marco Casaroli dcd93b0f67
Some checks are pending
Build Documentation / build-html (push) Waiting to run
MemBrowse Memory Report / changes-filter (push) Waiting to run
MemBrowse Memory Report / load-targets (push) Waiting to run
MemBrowse Memory Report / identical (push) Blocked by required conditions
MemBrowse Memory Report / analyze (push) Blocked by required conditions
libs/libc/elf: Load the libraries a module names in DT_NEEDED.
A module that names a shared library in DT_NEEDED now gets it loaded and
its imports bound against it, rather than being refused.

libelf_insert() does the loading, which is what dlopen() calls anyway: the
library lands in the module registry like anything else, its exports come
back through libelf_getsymbol() -- the same call dlsym() uses -- and a
library named by two modules is loaded once.  A bare name is looked for
along LD_LIBRARY_PATH, where dlopen() looks for it.  Undefined symbols
resolve against the globally registered symbols first, then the modules
this one depends on, then the table exec() supplied.  Nothing here calls
into dlfcn, because this loader is also the kernel's module loader, which
has none.

Each library becomes one of the module's dependencies[], and the dependency
holds it in place of the reference libelf_insert() took.  So a library
loaded only for DT_NEEDED is kept by the modules that depend on it, and
libelf_undepend() unloads it with the last of them; one that dlopen() or
insmod also opened stays until that reference goes too.
CONFIG_LIBC_ELF_MAXDEPEND bounds how many libraries a module may name,
which is what it already meant.

Six things had to be fixed to make it work, none of which a build shows.

reldata was a file-scope global.  Loading a library from inside
libelf_relocatedyn() makes that function reentrant, so the nested load
overwrote the outer one's relocation offsets and the module resumed binding
with the library's DT_REL.  It is now per call.

A cross-object call needs the callee's data base, not the caller's.  A
symbol resolved from an FDPIC library comes back as a descriptor, and
R_ARM_FUNCDESC_VALUE was treating it as a code address and pairing it with
the importing module's GOT.  It now copies both words, so the library runs
with its own.

An object with no imports has no PLT and so no DT_PLTGOT, but it still has
a GOT and still has to be entered with it.  Without the fallback its
descriptors carried a data base of zero and the library read its globals
through a null pointer.

R_ARM_FUNCDESC, a pointer to a descriptor, wrapped a library's descriptor
in a second one.  It now stores the library's descriptor as it is.

The flag that says a resolved value is a descriptor was set only for an
import and never cleared, so the next relocation against a symbol of the
module itself took that symbol for a descriptor too.  It is cleared there.

libelf_symname() was static, and reading a DT_NEEDED name needs it.

A module with DT_NEEDED is refused where CONFIG_LIBC_ELF_MAXDEPEND is zero,
since that is where the dependency logic is compiled out.

A DT_NEEDED library is one shared instance, its data included, because the
loader returns the object already in the registry.  A module started with
exec() is different: that path loads the module afresh each time, so two
running instances have separate data while sharing one copy of the text.

Built for mps3-an547:picostest with CONFIG_FDPIC both ways.  Run on
mps2-an500:xipfs under QEMU: fdpicxip solib loads libcounter.so by name out
of DT_NEEDED, two instances share one pinned copy of its text, and the
library is unloaded, and its pin given back, when the second one exits.  A
library also opened with dlopen() stays loaded after its DT_NEEDED user
exits, and dlclose() unloads it.

With CONFIG_ARCH_ADDRENV the program runs in its own address space, which
a library libelf_insert() loads cannot reach, so DT_NEEDED is refused
there as before.

Assisted-by: Claude Code:claude-opus-5-5
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
2026-10-06 17:48:49 -03:00

385 lines
13 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_symname
*
* Description:
* Read a name out of a string table into the I/O buffer.
*
****************************************************************************/
int libelf_symname(FAR struct mod_loadinfo_s *loadinfo,
FAR const Elf_Sym *sym, Elf_Off sh_offset);
/****************************************************************************
* 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 */
#ifdef HAVE_LIBC_ELF_PIN
/****************************************************************************
* Name: libelf_pinrelease
*
* Description:
* Give back an XIP pin that the loader took, and the file that holds it.
* Does nothing if the loader took no pin.
*
* Input Parameters:
* pinfile - The held file. Cleared on return.
*
* Returned Value:
* None.
*
****************************************************************************/
void libelf_pinrelease(FAR struct file **pinfile);
#endif
#endif /* __LIBS_LIBC_LIBC_ELF_LIBC_ELF_H */