2015-12-10 16:53:31 +01:00
|
|
|
/****************************************************************************
|
2018-05-29 21:21:26 +02:00
|
|
|
* libs/libc/modlib/modlib_init.c
|
2015-12-10 16:53:31 +01:00
|
|
|
*
|
2018-09-15 18:49:41 +02:00
|
|
|
* Copyright (C) 2015, 2017-2018 Gregory Nutt. All rights reserved.
|
2015-12-10 16:53:31 +01:00
|
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
|
|
|
#include <sys/stat.h>
|
|
|
|
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <fcntl.h>
|
|
|
|
#include <debug.h>
|
|
|
|
#include <errno.h>
|
|
|
|
|
2018-09-15 18:49:41 +02:00
|
|
|
#include <nuttx/fs/fs.h>
|
2017-01-29 15:24:42 +01:00
|
|
|
#include <nuttx/lib/modlib.h>
|
2015-12-10 16:53:31 +01:00
|
|
|
|
2017-01-29 18:54:54 +01:00
|
|
|
#include "modlib/modlib.h"
|
|
|
|
|
2015-12-10 16:53:31 +01:00
|
|
|
/****************************************************************************
|
|
|
|
* Pre-processor Definitions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2017-01-29 17:05:15 +01:00
|
|
|
/* CONFIG_DEBUG_FEATURES, CONFIG_DEBUG_INFO, and CONFIG_MODLIB_DUMPBUFFER
|
|
|
|
* have to be defined or CONFIG_MODLIB_DUMPBUFFER does nothing.
|
2015-12-10 16:53:31 +01:00
|
|
|
*/
|
|
|
|
|
2017-01-29 17:05:15 +01:00
|
|
|
#if !defined(CONFIG_DEBUG_INFO) || !defined (CONFIG_MODLIB_DUMPBUFFER)
|
|
|
|
# undef CONFIG_MODLIB_DUMPBUFFER
|
2015-12-10 16:53:31 +01:00
|
|
|
#endif
|
|
|
|
|
2017-01-29 17:05:15 +01:00
|
|
|
#ifdef CONFIG_MODLIB_DUMPBUFFER
|
2018-06-01 18:10:17 +02:00
|
|
|
# define modlib_dumpbuffer(m,b,n) binfodumpbuffer(m,b,n)
|
2015-12-10 16:53:31 +01:00
|
|
|
#else
|
2017-01-29 20:03:53 +01:00
|
|
|
# define modlib_dumpbuffer(m,b,n)
|
2015-12-10 16:53:31 +01:00
|
|
|
#endif
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
2017-01-29 20:03:53 +01:00
|
|
|
* Name: modlib_filelen
|
2015-12-10 16:53:31 +01:00
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* Get the size of the ELF file
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* 0 (OK) is returned on success and a negated errno is returned on
|
|
|
|
* failure.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2017-01-29 20:03:53 +01:00
|
|
|
static inline int modlib_filelen(FAR struct mod_loadinfo_s *loadinfo,
|
|
|
|
FAR const char *filename)
|
2015-12-10 16:53:31 +01:00
|
|
|
{
|
|
|
|
struct stat buf;
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Get the file stats */
|
|
|
|
|
|
|
|
ret = stat(filename, &buf);
|
|
|
|
if (ret < 0)
|
|
|
|
{
|
2018-01-31 00:57:36 +01:00
|
|
|
int errval = get_errno();
|
2018-06-01 18:10:17 +02:00
|
|
|
berr("ERROR: Failed to stat file: %d\n", errval);
|
2015-12-10 16:53:31 +01:00
|
|
|
return -errval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Verify that it is a regular file */
|
|
|
|
|
|
|
|
if (!S_ISREG(buf.st_mode))
|
|
|
|
{
|
2018-06-01 18:10:17 +02:00
|
|
|
berr("ERROR: Not a regular file. mode: %d\n", buf.st_mode);
|
2015-12-10 16:53:31 +01:00
|
|
|
return -ENOENT;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* TODO: Verify that the file is readable. Not really important because
|
|
|
|
* we will detect this when we try to open the file read-only.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Return the size of the file in the loadinfo structure */
|
|
|
|
|
|
|
|
loadinfo->filelen = buf.st_size;
|
|
|
|
return OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
2017-01-29 17:05:15 +01:00
|
|
|
* Name: modlib_initialize
|
2015-12-10 16:53:31 +01:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2017-01-29 17:05:15 +01:00
|
|
|
int modlib_initialize(FAR const char *filename,
|
|
|
|
FAR struct mod_loadinfo_s *loadinfo)
|
2015-12-10 16:53:31 +01:00
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
2018-06-01 18:10:17 +02:00
|
|
|
binfo("filename: %s loadinfo: %p\n", filename, loadinfo);
|
2015-12-10 16:53:31 +01:00
|
|
|
|
|
|
|
/* Clear the load info structure */
|
|
|
|
|
2015-12-12 14:09:17 +01:00
|
|
|
memset(loadinfo, 0, sizeof(struct mod_loadinfo_s));
|
2015-12-10 16:53:31 +01:00
|
|
|
|
|
|
|
/* Get the length of the file. */
|
|
|
|
|
2017-01-29 20:03:53 +01:00
|
|
|
ret = modlib_filelen(loadinfo, filename);
|
2015-12-10 16:53:31 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2018-06-01 18:10:17 +02:00
|
|
|
berr("ERROR: modlib_filelen failed: %d\n", ret);
|
2015-12-10 16:53:31 +01:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Open the binary file for reading (only) */
|
|
|
|
|
2018-09-15 18:49:41 +02:00
|
|
|
loadinfo->filfd = _NX_OPEN(filename, O_RDONLY);
|
2015-12-10 16:53:31 +01:00
|
|
|
if (loadinfo->filfd < 0)
|
|
|
|
{
|
2018-09-15 18:49:41 +02:00
|
|
|
int errval = _NX_GETERRNO(loadinfo->filfd);
|
2018-06-01 18:10:17 +02:00
|
|
|
berr("ERROR: Failed to open ELF binary %s: %d\n", filename, errval);
|
2015-12-10 16:53:31 +01:00
|
|
|
return -errval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Read the ELF ehdr from offset 0 */
|
|
|
|
|
2017-01-29 18:17:29 +01:00
|
|
|
ret = modlib_read(loadinfo, (FAR uint8_t *)&loadinfo->ehdr,
|
2015-12-10 23:56:10 +01:00
|
|
|
sizeof(Elf32_Ehdr), 0);
|
2015-12-10 16:53:31 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2018-06-01 18:10:17 +02:00
|
|
|
berr("ERROR: Failed to read ELF header: %d\n", ret);
|
2015-12-10 16:53:31 +01:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2017-01-29 20:03:53 +01:00
|
|
|
modlib_dumpbuffer("ELF header", (FAR const uint8_t *)&loadinfo->ehdr,
|
2015-12-10 23:56:10 +01:00
|
|
|
sizeof(Elf32_Ehdr));
|
2015-12-10 16:53:31 +01:00
|
|
|
|
|
|
|
/* Verify the ELF header */
|
|
|
|
|
2017-01-29 18:54:54 +01:00
|
|
|
ret = modlib_verifyheader(&loadinfo->ehdr);
|
2015-12-10 16:53:31 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
/* This may not be an error because we will be called to attempt loading
|
2017-01-29 18:54:54 +01:00
|
|
|
* EVERY binary. If modlib_verifyheader() does not recognize the ELF header,
|
2015-12-10 16:53:31 +01:00
|
|
|
* it will -ENOEXEC whcih simply informs the system that the file is not an
|
2017-01-29 18:54:54 +01:00
|
|
|
* ELF file. modlib_verifyheader() will return other errors if the ELF header
|
2015-12-10 16:53:31 +01:00
|
|
|
* is not correctly formed.
|
|
|
|
*/
|
|
|
|
|
2018-06-01 18:10:17 +02:00
|
|
|
berr("ERROR: Bad ELF header: %d\n", ret);
|
2015-12-10 16:53:31 +01:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
}
|