2012-12-19 18:54:26 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* binfmt/libelf/libelf_addrenv.c
|
|
|
|
*
|
2021-02-03 14:47:23 +01:00
|
|
|
* 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
|
2012-12-19 18:54:26 +01:00
|
|
|
*
|
2021-02-03 14:47:23 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2012-12-19 18:54:26 +01:00
|
|
|
*
|
2021-02-03 14:47:23 +01:00
|
|
|
* 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.
|
2012-12-19 18:54:26 +01:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
|
|
|
#include <errno.h>
|
|
|
|
#include <debug.h>
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
#include <nuttx/addrenv.h>
|
2012-12-19 18:54:26 +01:00
|
|
|
#include <nuttx/arch.h>
|
|
|
|
#include <nuttx/kmalloc.h>
|
|
|
|
|
2022-05-12 10:55:50 +02:00
|
|
|
#include <sys/mman.h>
|
|
|
|
|
2012-12-19 18:54:26 +01:00
|
|
|
#include "libelf.h"
|
|
|
|
|
|
|
|
/****************************************************************************
|
2015-04-08 16:29:03 +02:00
|
|
|
* Pre-processor Definitions
|
2012-12-19 18:54:26 +01:00
|
|
|
****************************************************************************/
|
|
|
|
|
2022-05-12 10:55:50 +02:00
|
|
|
#define ELF_TEXT_WRE (PROT_READ | PROT_WRITE | PROT_EXEC)
|
|
|
|
#define ELF_TEXT_WRD (PROT_READ | PROT_EXEC)
|
|
|
|
|
2012-12-19 18:54:26 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Private Constant Data
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
2012-12-19 23:18:30 +01:00
|
|
|
* Name: elf_addrenv_alloc
|
2012-12-19 18:54:26 +01:00
|
|
|
*
|
|
|
|
* Description:
|
2014-08-24 19:54:14 +02:00
|
|
|
* Allocate memory for the ELF image (textalloc and dataalloc). If
|
2020-03-26 07:54:27 +01:00
|
|
|
* CONFIG_ARCH_ADDRENV=n, textalloc will be allocated using kmm_zalloc()
|
|
|
|
* and dataalloc will be a offset from textalloc. If
|
|
|
|
* CONFIG_ARCH_ADDRENV=y, then textalloc and dataalloc will be allocated
|
|
|
|
* using up_addrenv_create(). In either case, there will be a unique
|
|
|
|
* instance of textalloc and dataalloc (and stack) for each instance of a
|
|
|
|
* process.
|
2012-12-19 18:54:26 +01:00
|
|
|
*
|
|
|
|
* Input Parameters:
|
|
|
|
* loadinfo - Load state information
|
2014-08-24 19:54:14 +02:00
|
|
|
* 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).
|
2014-09-10 23:55:36 +02:00
|
|
|
* heapsize - The initial size (in bytes) of the heap address environment
|
|
|
|
* needed by the task. This region may be read/write only.
|
2012-12-19 18:54:26 +01:00
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* Zero (OK) on success; a negated errno value on failure.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-08-24 19:54:14 +02:00
|
|
|
int elf_addrenv_alloc(FAR struct elf_loadinfo_s *loadinfo, size_t textsize,
|
2014-09-10 23:55:36 +02:00
|
|
|
size_t datasize, size_t heapsize)
|
2012-12-19 18:54:26 +01:00
|
|
|
{
|
2014-08-24 14:42:11 +02:00
|
|
|
#ifdef CONFIG_ARCH_ADDRENV
|
2023-01-27 12:45:03 +01:00
|
|
|
FAR struct arch_addrenv_s *addrenv = &loadinfo->addrenv.addrenv;
|
2014-08-24 19:54:14 +02:00
|
|
|
FAR void *vtext;
|
|
|
|
FAR void *vdata;
|
2012-12-19 18:54:26 +01:00
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Create an address environment for the new ELF task */
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = up_addrenv_create(textsize, datasize, heapsize, addrenv);
|
2012-12-19 18:54:26 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2016-06-11 23:50:49 +02:00
|
|
|
berr("ERROR: up_addrenv_create failed: %d\n", ret);
|
2012-12-19 18:54:26 +01:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
/* Take a reference to the address environment, so it won't get freed */
|
|
|
|
|
|
|
|
addrenv_take(&loadinfo->addrenv);
|
|
|
|
|
2012-12-19 18:54:26 +01:00
|
|
|
/* Get the virtual address associated with the start of the address
|
|
|
|
* environment. This is the base address that we will need to use to
|
|
|
|
* access the ELF image (but only if the address environment has been
|
|
|
|
* selected.
|
|
|
|
*/
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = up_addrenv_vtext(addrenv, &vtext);
|
2012-12-19 18:54:26 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2016-06-11 23:50:49 +02:00
|
|
|
berr("ERROR: up_addrenv_vtext failed: %d\n", ret);
|
2012-12-19 18:54:26 +01:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = up_addrenv_vdata(addrenv, textsize, &vdata);
|
2014-08-24 19:54:14 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2019-01-26 18:18:45 +01:00
|
|
|
berr("ERROR: up_addrenv_vdata failed: %d\n", ret);
|
2014-08-24 19:54:14 +02:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2014-08-25 21:28:13 +02:00
|
|
|
loadinfo->textalloc = (uintptr_t)vtext;
|
2014-08-24 19:54:14 +02:00
|
|
|
loadinfo->dataalloc = (uintptr_t)vdata;
|
2012-12-19 18:54:26 +01:00
|
|
|
return OK;
|
|
|
|
#else
|
|
|
|
/* Allocate memory to hold the ELF image */
|
|
|
|
|
2021-06-18 01:47:45 +02:00
|
|
|
#if defined(CONFIG_ARCH_USE_TEXT_HEAP)
|
2021-06-02 06:54:57 +02:00
|
|
|
loadinfo->textalloc = (uintptr_t)
|
2021-06-18 01:47:45 +02:00
|
|
|
up_textheap_memalign(loadinfo->textalign,
|
|
|
|
textsize);
|
2021-06-02 06:54:57 +02:00
|
|
|
#else
|
2022-01-28 07:13:41 +01:00
|
|
|
loadinfo->textalloc = (uintptr_t)kumm_memalign(loadinfo->textalign,
|
|
|
|
textsize);
|
2021-06-02 06:54:57 +02:00
|
|
|
#endif
|
|
|
|
|
2014-08-24 19:54:14 +02:00
|
|
|
if (!loadinfo->textalloc)
|
2012-12-19 18:54:26 +01:00
|
|
|
{
|
|
|
|
return -ENOMEM;
|
|
|
|
}
|
|
|
|
|
2022-01-28 07:13:41 +01:00
|
|
|
if (loadinfo->datasize > 0)
|
2021-06-02 06:54:57 +02:00
|
|
|
{
|
2022-01-28 07:13:41 +01:00
|
|
|
loadinfo->dataalloc = (uintptr_t)kumm_memalign(loadinfo->dataalign,
|
|
|
|
datasize);
|
|
|
|
if (!loadinfo->dataalloc)
|
|
|
|
{
|
|
|
|
return -ENOMEM;
|
|
|
|
}
|
2021-06-02 06:54:57 +02:00
|
|
|
}
|
|
|
|
|
2012-12-19 18:54:26 +01:00
|
|
|
return OK;
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2022-03-29 11:15:30 +02:00
|
|
|
/****************************************************************************
|
2022-05-04 08:08:33 +02:00
|
|
|
* Name: elf_addrenv_select
|
2022-03-29 11:15:30 +02:00
|
|
|
*
|
|
|
|
* Description:
|
2022-05-04 08:08:33 +02:00
|
|
|
* Temporarily select the task's address environment.
|
2022-03-29 11:15:30 +02:00
|
|
|
*
|
|
|
|
* Input Parameters:
|
|
|
|
* loadinfo - Load state information
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* Zero (OK) on success; a negated errno value on failure.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifdef CONFIG_ARCH_ADDRENV
|
|
|
|
int elf_addrenv_select(FAR struct elf_loadinfo_s *loadinfo)
|
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Instantiate the new address environment */
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = addrenv_select(&loadinfo->addrenv);
|
2022-03-29 11:15:30 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2023-01-27 12:45:03 +01:00
|
|
|
berr("ERROR: addrenv_select failed: %d\n", ret);
|
2022-03-29 11:15:30 +02:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Allow write access to .text */
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = up_addrenv_mprot(&loadinfo->addrenv.addrenv, loadinfo->textalloc,
|
2022-05-12 10:55:50 +02:00
|
|
|
loadinfo->textsize, ELF_TEXT_WRE);
|
2022-03-29 11:15:30 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
berr("ERROR: up_addrenv_text_enable_write failed: %d\n", ret);
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/****************************************************************************
|
2022-05-04 08:08:33 +02:00
|
|
|
* Name: elf_addrenv_restore
|
2022-03-29 11:15:30 +02:00
|
|
|
*
|
|
|
|
* Description:
|
2022-05-04 08:08:33 +02:00
|
|
|
* Restore the address environment before elf_addrenv_select() was called..
|
2022-03-29 11:15:30 +02:00
|
|
|
*
|
|
|
|
* Input Parameters:
|
|
|
|
* loadinfo - Load state information
|
|
|
|
*
|
|
|
|
* Returned Value:
|
2022-05-04 08:08:33 +02:00
|
|
|
* Zero (OK) on success; a negated errno value on failure.
|
2022-03-29 11:15:30 +02:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifdef CONFIG_ARCH_ADDRENV
|
|
|
|
int elf_addrenv_restore(FAR struct elf_loadinfo_s *loadinfo)
|
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Remove write access to .text */
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = up_addrenv_mprot(&loadinfo->addrenv.addrenv, loadinfo->textalloc,
|
2022-05-12 10:55:50 +02:00
|
|
|
loadinfo->textsize, ELF_TEXT_WRD);
|
2022-03-29 11:15:30 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
berr("ERROR: up_addrenv_text_disable_write failed: %d\n", ret);
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Restore the old address environment */
|
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = addrenv_restore();
|
2022-03-29 11:15:30 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2023-01-27 12:45:03 +01:00
|
|
|
berr("ERROR: addrenv_restore failed: %d\n", ret);
|
2022-03-29 11:15:30 +02:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2012-12-19 18:54:26 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: elf_addrenv_free
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Release the address environment previously created by
|
2014-09-10 23:55:36 +02:00
|
|
|
* elf_addrenv_alloc(). This function is called only under certain error
|
2013-08-27 17:40:19 +02:00
|
|
|
* conditions after the module has been loaded but not yet started.
|
2012-12-19 18:54:26 +01:00
|
|
|
* 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)
|
|
|
|
{
|
2014-08-24 14:42:11 +02:00
|
|
|
#ifdef CONFIG_ARCH_ADDRENV
|
2012-12-19 18:54:26 +01:00
|
|
|
int ret;
|
|
|
|
|
2014-08-25 21:28:13 +02:00
|
|
|
/* Free the address environment */
|
2012-12-19 18:54:26 +01:00
|
|
|
|
2023-01-27 12:45:03 +01:00
|
|
|
ret = up_addrenv_destroy(&loadinfo->addrenv.addrenv);
|
2012-12-19 18:54:26 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2016-06-11 23:50:49 +02:00
|
|
|
berr("ERROR: up_addrenv_destroy failed: %d\n", ret);
|
2012-12-19 18:54:26 +01:00
|
|
|
}
|
|
|
|
#else
|
2021-06-02 06:54:57 +02:00
|
|
|
|
|
|
|
if (loadinfo->textalloc != 0)
|
|
|
|
{
|
2022-01-28 07:13:41 +01:00
|
|
|
#if defined(CONFIG_ARCH_USE_TEXT_HEAP)
|
2021-06-18 01:47:45 +02:00
|
|
|
up_textheap_free((FAR void *)loadinfo->textalloc);
|
2022-01-28 07:13:41 +01:00
|
|
|
#else
|
|
|
|
kumm_free((FAR void *)loadinfo->textalloc);
|
|
|
|
#endif
|
2021-06-02 06:54:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (loadinfo->dataalloc != 0)
|
|
|
|
{
|
|
|
|
kumm_free((FAR void *)loadinfo->dataalloc);
|
|
|
|
}
|
|
|
|
|
2012-12-19 18:54:26 +01:00
|
|
|
#endif
|
2014-08-25 21:28:13 +02:00
|
|
|
|
|
|
|
/* Clear out all indications of the allocated address environment */
|
|
|
|
|
|
|
|
loadinfo->textalloc = 0;
|
|
|
|
loadinfo->dataalloc = 0;
|
|
|
|
loadinfo->textsize = 0;
|
|
|
|
loadinfo->datasize = 0;
|
2012-12-19 18:54:26 +01:00
|
|
|
}
|