261 lines
8.5 KiB
C
261 lines
8.5 KiB
C
/****************************************************************************
|
|
* include/nuttx/binfmt/elf.h
|
|
*
|
|
* 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 __INCLUDE_NUTTX_BINFMT_ELF_H
|
|
#define __INCLUDE_NUTTX_BINFMT_ELF_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <elf.h>
|
|
|
|
#include <nuttx/arch.h>
|
|
#include <nuttx/binfmt/binfmt.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Configuration ************************************************************/
|
|
|
|
#ifndef CONFIG_ELF_ALIGN_LOG2
|
|
# define CONFIG_ELF_ALIGN_LOG2 2
|
|
#endif
|
|
|
|
#ifndef CONFIG_ELF_STACKSIZE
|
|
# define CONFIG_ELF_STACKSIZE 2048
|
|
#endif
|
|
|
|
#ifndef CONFIG_ELF_BUFFERSIZE
|
|
# define CONFIG_ELF_BUFFERSIZE 32
|
|
#endif
|
|
|
|
#ifndef CONFIG_ELF_BUFFERINCR
|
|
# define CONFIG_ELF_BUFFERINCR 32
|
|
#endif
|
|
|
|
/* Allocation array size and indices */
|
|
|
|
#define LIBELF_ELF_ALLOC 0
|
|
#ifdef CONFIG_BINFMT_CONSTRUCTORS
|
|
# define LIBELF_CTORS_ALLOC 1
|
|
# define LIBELF_CTPRS_ALLOC 2
|
|
# define LIBELF_NALLOC 3
|
|
#else
|
|
# define LIBELF_NALLOC 1
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* This struct provides a description of the currently loaded instantiation
|
|
* of an ELF binary.
|
|
*/
|
|
|
|
struct elf_loadinfo_s
|
|
{
|
|
/* elfalloc is the base address of the memory that is allocated to hold the
|
|
* ELF program image.
|
|
*
|
|
* If CONFIG_ARCH_ADDRENV=n, elfalloc will be allocated using kmm_malloc()
|
|
* (or kmm_zalloc()).
|
|
* 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.
|
|
*
|
|
* The alloc[] array in struct binary_s will hold memory that persists
|
|
* after the ELF module has been loaded.
|
|
*/
|
|
|
|
uintptr_t textalloc; /* .text memory allocated when ELF file was loaded */
|
|
uintptr_t dataalloc; /* .bss/.data memory allocated when ELF file was loaded */
|
|
size_t textsize; /* Size of the ELF .text memory allocation */
|
|
size_t datasize; /* Size of the ELF .bss/.data memory allocation */
|
|
off_t filelen; /* Length of the entire ELF file */
|
|
|
|
Elf_Ehdr ehdr; /* Buffered ELF file header */
|
|
FAR Elf_Shdr *shdr; /* Buffered ELF section headers */
|
|
uint8_t *iobuffer; /* File I/O buffer */
|
|
|
|
/* Constructors and destructors */
|
|
|
|
#ifdef CONFIG_BINFMT_CONSTRUCTORS
|
|
FAR void *ctoralloc; /* Memory allocated for ctors */
|
|
FAR void *dtoralloc; /* Memory allocated dtors */
|
|
FAR binfmt_ctor_t *ctors; /* Pointer to a list of constructors */
|
|
FAR binfmt_dtor_t *dtors; /* Pointer to a list of destructors */
|
|
uint16_t nctors; /* Number of constructors */
|
|
uint16_t ndtors; /* Number of destructors */
|
|
#endif
|
|
|
|
/* Address environment.
|
|
*
|
|
* addrenv - This is the handle created by up_addrenv_create() that can be
|
|
* used to manage the tasks address space.
|
|
* oldenv - This is a value returned by up_addrenv_select() that must be
|
|
* used to restore the current address environment.
|
|
*/
|
|
|
|
#ifdef CONFIG_ARCH_ADDRENV
|
|
group_addrenv_t addrenv; /* Task group address environment */
|
|
save_addrenv_t oldenv; /* Saved address environment */
|
|
#endif
|
|
|
|
uint16_t symtabidx; /* Symbol table section index */
|
|
uint16_t strtabidx; /* String table section index */
|
|
uint16_t buflen; /* size of iobuffer[] */
|
|
int filfd; /* Descriptor for the file being loaded */
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: elf_initialize
|
|
*
|
|
* Description:
|
|
* In order to use the ELF binary format, this function must be called
|
|
* during system initialization to register the ELF binary format.
|
|
*
|
|
* Returned Value:
|
|
* This is a NuttX internal function so it follows the convention that
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
* failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int elf_initialize(void);
|
|
|
|
/****************************************************************************
|
|
* Name: elf_uninitialize
|
|
*
|
|
* Description:
|
|
* Unregister the ELF binary loader
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
void elf_uninitialize(void);
|
|
|
|
/****************************************************************************
|
|
* Name: elf_init
|
|
*
|
|
* Description:
|
|
* This function is called to configure the library to process an ELF
|
|
* program binary.
|
|
*
|
|
* Returned Value:
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
* failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int elf_init(FAR const char *filename, FAR struct elf_loadinfo_s *loadinfo);
|
|
|
|
/****************************************************************************
|
|
* Name: elf_uninit
|
|
*
|
|
* Description:
|
|
* Releases any resources committed by elf_init(). This essentially
|
|
* undoes the actions of elf_init.
|
|
*
|
|
* Returned Value:
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
* failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int elf_uninit(FAR struct elf_loadinfo_s *loadinfo);
|
|
|
|
/****************************************************************************
|
|
* Name: elf_load
|
|
*
|
|
* Description:
|
|
* Loads the binary into memory, allocating memory, performing relocations
|
|
* and initializing the data and bss segments.
|
|
*
|
|
* Returned Value:
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
* failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int elf_load(FAR struct elf_loadinfo_s *loadinfo);
|
|
|
|
/****************************************************************************
|
|
* Name: elf_bind
|
|
*
|
|
* Description:
|
|
* Bind the imported symbol names in the loaded module described by
|
|
* 'loadinfo' using the exported symbol values provided by 'symtab'.
|
|
*
|
|
* Returned Value:
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
* failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
struct symtab_s;
|
|
int elf_bind(FAR struct elf_loadinfo_s *loadinfo,
|
|
FAR const struct symtab_s *exports, int nexports);
|
|
|
|
/****************************************************************************
|
|
* Name: elf_unload
|
|
*
|
|
* Description:
|
|
* This function unloads the object from memory. This essentially undoes
|
|
* the actions of elf_load. It is called only under certain error
|
|
* conditions after the module has been loaded but not yet started.
|
|
*
|
|
* Returned Value:
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
* failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int elf_unload(struct elf_loadinfo_s *loadinfo);
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_NUTTX_BINFMT_ELF_H */
|