/**************************************************************************** * binfmt/libelf/libelf.h * * Copyright (C) 2012 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ #ifndef __BINFMT_LIBELF_LIBELF_H #define __BINFMT_LIBELF_LIBELF_H /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include #include #include /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /**************************************************************************** * Public Types ****************************************************************************/ /**************************************************************************** * Name: elf_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 elf_verifyheader(FAR const Elf32_Ehdr *header); /**************************************************************************** * Name: elf_read * * Description: * Read 'readsize' bytes from the object file at 'offset'. The data is * read into 'buffer.' If 'buffer' is part of the ELF address environment, * then the caller is responsibile for assuring that that address * environment is in place before calling this function (i.e., that * elf_addrenv_select() has been called if CONFIG_ARCH_ADDRENV=y). * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ int elf_read(FAR struct elf_loadinfo_s *loadinfo, FAR uint8_t *buffer, size_t readsize, off_t offset); /**************************************************************************** * Name: elf_loadshdrs * * Description: * Loads section headers into memory. * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ int elf_loadshdrs(FAR struct elf_loadinfo_s *loadinfo); /**************************************************************************** * Name: elf_findsection * * Description: * A section by its name. * * Input Parameters: * loadinfo - Load state information * sectname - Name of the section to find * * Returned Value: * On success, the index to the section is returned; A negated errno value * is returned on failure. * ****************************************************************************/ int elf_findsection(FAR struct elf_loadinfo_s *loadinfo, FAR const char *sectname); /**************************************************************************** * Name: elf_findsymtab * * Description: * Find the symbol table section. * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ int elf_findsymtab(FAR struct elf_loadinfo_s *loadinfo); /**************************************************************************** * Name: elf_readsym * * Description: * Read the ELFT symbol structure at the specfied 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 elf_readsym(FAR struct elf_loadinfo_s *loadinfo, int index, FAR Elf32_Sym *sym); /**************************************************************************** * Name: elf_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: * loadinfo - Load state information * sym - Symbol table entry (value might be undefined) * exports - The symbol table to use for resolving undefined symbols. * nexports - Number of symbols in the symbol table. * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ int elf_symvalue(FAR struct elf_loadinfo_s *loadinfo, FAR Elf32_Sym *sym, FAR const struct symtab_s *exports, int nexports); /**************************************************************************** * Name: elf_freebuffers * * Description: * Release all working buffers. * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ int elf_freebuffers(FAR struct elf_loadinfo_s *loadinfo); /**************************************************************************** * Name: elf_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 elf_allocbuffer(FAR struct elf_loadinfo_s *loadinfo); /**************************************************************************** * Name: elf_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 elf_reallocbuffer(FAR struct elf_loadinfo_s *loadinfo, size_t increment); /**************************************************************************** * Name: elf_findctors * * Description: * Find C++ static constructors. * * Input Parameters: * loadinfo - Load state information * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ #ifdef CONFIG_BINFMT_CONSTRUCTORS int elf_loadctors(FAR struct elf_loadinfo_s *loadinfo); #endif /**************************************************************************** * Name: elf_loaddtors * * Description: * Load pointers to static destructors into an in-memory array. * * Input Parameters: * loadinfo - Load state information * * Returned Value: * 0 (OK) is returned on success and a negated errno is returned on * failure. * ****************************************************************************/ #ifdef CONFIG_BINFMT_CONSTRUCTORS int elf_loaddtors(FAR struct elf_loadinfo_s *loadinfo); #endif /**************************************************************************** * Name: elf_addrenv_alloc * * Description: * Allocate memory for the ELF image (elfalloc). If CONFIG_ARCH_ADDRENV=n, * elfalloc will be allocated using kzalloc(). If CONFIG_ARCH_ADDRENV-y, then * elfalloc will be allocated using up_addrenv_create(). In either case, * there will be a unique instance of elfalloc (and stack) for each * instance of a process. * * Input Parameters: * loadinfo - Load state information * envsize - The size (in bytes) of the address environment needed for the * ELF image. * * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ int elf_addrenv_alloc(FAR struct elf_loadinfo_s *loadinfo, size_t envsize); /**************************************************************************** * Name: elf_addrenv_select * * Description: * Temporarity select the task's address environemnt. * * Input Parameters: * loadinfo - Load state information * * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ #ifdef CONFIG_ARCH_ADDRENV # define elf_addrenv_select(l) up_addrenv_select((l)->addrenv, &(l)->oldenv) #endif /**************************************************************************** * Name: elf_addrenv_restore * * Description: * Restore the address environment before elf_addrenv_select() was called.. * * Input Parameters: * loadinfo - Load state information * * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ #ifdef CONFIG_ARCH_ADDRENV # define elf_addrenv_restore(l) up_addrenv_restore((l)->oldenv) #endif /**************************************************************************** * Name: elf_addrenv_free * * Description: * Release the address environment previously created by * elf_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 elf_addrenv_free(FAR struct elf_loadinfo_s *loadinfo); #endif /* __BINFMT_LIBELF_LIBELF_H */