2009-07-12 20:43:59 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* binfmt/binfmt_exec.c
|
|
|
|
*
|
2014-07-11 19:58:46 +02:00
|
|
|
* Copyright (C) 2009, 2013-2014 Gregory Nutt. All rights reserved.
|
2012-09-13 20:32:24 +02:00
|
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
2009-07-12 20:43:59 +02:00
|
|
|
*
|
|
|
|
* 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 <string.h>
|
|
|
|
#include <debug.h>
|
|
|
|
#include <errno.h>
|
|
|
|
|
2013-01-17 19:32:13 +01:00
|
|
|
#include <nuttx/kmalloc.h>
|
2012-10-24 22:19:44 +02:00
|
|
|
#include <nuttx/binfmt/binfmt.h>
|
2009-07-12 20:43:59 +02:00
|
|
|
|
|
|
|
#include "binfmt_internal.h"
|
|
|
|
|
|
|
|
#ifndef CONFIG_BINFMT_DISABLE
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Pre-processor Definitions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Function Prototypes
|
|
|
|
****************************************************************************/
|
|
|
|
|
2014-09-14 22:10:23 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Name: binfmt_copyargv
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* In the kernel build, the argv list will likely lie in the caller's
|
|
|
|
* address environment and, hence, by inaccessible when we swith to the
|
|
|
|
* address environment of the new process address environment. So we
|
|
|
|
* do not have any real option other than to copy the callers argv[] list.
|
|
|
|
*
|
|
|
|
* Input Parameter:
|
|
|
|
* bin - Load structure
|
|
|
|
* argv - Argument list
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* Zero (OK) on sucess; a negater erro value on failure.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
static inline int binfmt_copyargv(FAR struct binary_s *bin, FAR char * const *argv)
|
|
|
|
{
|
|
|
|
#if defined(CONFIG_ARCH_ADDRENV) && defined(CONFIG_BUILD_KERNEL)
|
|
|
|
FAR char *ptr;
|
|
|
|
size_t argsize;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
/* Get the size of the argument list */
|
|
|
|
|
|
|
|
bin->argbuffer = (FAR char *)NULL;
|
|
|
|
i = 0;
|
|
|
|
|
|
|
|
if (argv)
|
|
|
|
{
|
|
|
|
argsize = 0;
|
|
|
|
for (i = 0; i < CONFIG_MAX_TASK_ARGS && argv[i]; i++)
|
|
|
|
{
|
|
|
|
argsize += (strlen(argv[i]) + 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
bvdbg("args=%d argsize=%lu\n", i, (unsigned long)argsize);
|
|
|
|
|
|
|
|
/* Allocate a temporary argument buffer */
|
|
|
|
|
|
|
|
i = 0;
|
|
|
|
|
|
|
|
if (argsize > 0)
|
|
|
|
{
|
|
|
|
bin->argbuffer = (FAR char *)kmm_malloc(argsize);
|
|
|
|
if (!bin->argbuffer)
|
|
|
|
{
|
|
|
|
bdbg("ERROR: Failed to allocate the argument buffer\n");
|
|
|
|
return -ENOMEM;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Copy the argv list */
|
|
|
|
|
|
|
|
ptr = bin->argbuffer;
|
|
|
|
for (; i < CONFIG_MAX_TASK_ARGS && argv[i]; i++)
|
|
|
|
{
|
|
|
|
bin->argv[i] = ptr;
|
|
|
|
argsize = strlen(argv[i]) + 1;
|
|
|
|
memcpy(ptr, argv[i], argsize);
|
|
|
|
ptr += argsize;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Nullify the remainder of the list */
|
|
|
|
|
|
|
|
for (; i <= CONFIG_MAX_TASK_ARGS; i++)
|
|
|
|
{
|
|
|
|
bin->argv[i] = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
return OK;
|
|
|
|
|
|
|
|
#else
|
|
|
|
/* Just save the caller's argv pointer */
|
|
|
|
|
|
|
|
bin->argv = argv;
|
|
|
|
return OK;
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2009-07-12 20:43:59 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Private Data
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Private Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Functions
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Name: exec
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* This is a convenience function that wraps load_ and exec_module into
|
2014-07-11 19:58:46 +02:00
|
|
|
* one call. If CONFIG_SCHED_ONEXIT and CONFIG_SCHED_HAVE_PARENT are
|
|
|
|
* also defined, this function will automatically call schedule_unload()
|
|
|
|
* to unload the module when task exits.
|
|
|
|
*
|
|
|
|
* NOTE: This function is flawed and useless without CONFIG_SCHED_ONEXIT
|
|
|
|
* and CONFIG_SCHED_HAVE_PARENT because there is then no mechanism to
|
|
|
|
* unload the module once it exits.
|
2009-07-12 20:43:59 +02:00
|
|
|
*
|
|
|
|
* Input Parameter:
|
2014-06-15 21:22:44 +02:00
|
|
|
* filename - Full path to the binary to be loaded
|
2009-07-12 20:43:59 +02:00
|
|
|
* argv - Argument list
|
|
|
|
* exports - Table of exported symbols
|
|
|
|
* nexports - The number of symbols in exports
|
|
|
|
*
|
|
|
|
* Returned Value:
|
|
|
|
* This is an end-user function, so it follows the normal convention:
|
2013-01-17 15:43:55 +01:00
|
|
|
* It returns the PID of the exec'ed module. On failure, it returns
|
2009-07-12 20:43:59 +02:00
|
|
|
* -1 (ERROR) and sets errno appropriately.
|
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
2013-02-02 20:31:30 +01:00
|
|
|
int exec(FAR const char *filename, FAR char * const *argv,
|
2009-07-12 20:43:59 +02:00
|
|
|
FAR const struct symtab_s *exports, int nexports)
|
|
|
|
{
|
2014-07-11 19:58:46 +02:00
|
|
|
#if defined(CONFIG_SCHED_ONEXIT) && defined(CONFIG_SCHED_HAVE_PARENT)
|
2013-01-17 15:43:55 +01:00
|
|
|
FAR struct binary_s *bin;
|
2013-01-17 19:32:13 +01:00
|
|
|
int pid;
|
2014-09-07 20:09:30 +02:00
|
|
|
int err;
|
2013-01-17 15:43:55 +01:00
|
|
|
int ret;
|
|
|
|
|
|
|
|
/* Allocate the load information */
|
|
|
|
|
2014-09-01 01:34:44 +02:00
|
|
|
bin = (FAR struct binary_s *)kmm_zalloc(sizeof(struct binary_s));
|
2013-01-17 15:43:55 +01:00
|
|
|
if (!bin)
|
|
|
|
{
|
2014-09-07 20:09:30 +02:00
|
|
|
bdbg("ERROR: Failed to allocate binary_s\n");
|
|
|
|
err = ENOMEM;
|
|
|
|
goto errout;
|
2013-01-17 15:43:55 +01:00
|
|
|
}
|
|
|
|
|
2014-09-14 22:10:23 +02:00
|
|
|
/* Initialize the binary structure */
|
2013-01-17 15:43:55 +01:00
|
|
|
|
|
|
|
bin->filename = filename;
|
|
|
|
bin->exports = exports;
|
|
|
|
bin->nexports = nexports;
|
|
|
|
|
2014-09-14 22:10:23 +02:00
|
|
|
/* Copy the argv[] list */
|
|
|
|
|
|
|
|
ret = binfmt_copyargv(bin, argv);
|
|
|
|
if (ret < 0)
|
|
|
|
{
|
|
|
|
err = -ret;
|
|
|
|
bdbg("ERROR: Failed to copy argv[]: %d\n", err);
|
|
|
|
goto errout_with_bin;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Load the module into memory */
|
|
|
|
|
2013-01-17 15:43:55 +01:00
|
|
|
ret = load_module(bin);
|
|
|
|
if (ret < 0)
|
|
|
|
{
|
2014-09-07 20:09:30 +02:00
|
|
|
err = get_errno();
|
|
|
|
bdbg("ERROR: Failed to load program '%s': %d\n", filename, err);
|
2014-09-14 22:10:23 +02:00
|
|
|
goto errout_with_argv;
|
2013-01-17 15:43:55 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Disable pre-emption so that the executed module does
|
|
|
|
* not return until we get a chance to connect the on_exit
|
|
|
|
* handler.
|
|
|
|
*/
|
|
|
|
|
|
|
|
sched_lock();
|
|
|
|
|
|
|
|
/* Then start the module */
|
|
|
|
|
2013-01-17 19:32:13 +01:00
|
|
|
pid = exec_module(bin);
|
|
|
|
if (pid < 0)
|
2013-01-17 15:43:55 +01:00
|
|
|
{
|
2014-09-07 20:09:30 +02:00
|
|
|
err = get_errno();
|
|
|
|
bdbg("ERROR: Failed to execute program '%s': %d\n", filename, err);
|
|
|
|
goto errout_with_lock;
|
2013-01-17 15:43:55 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Set up to unload the module (and free the binary_s structure)
|
|
|
|
* when the task exists.
|
|
|
|
*/
|
|
|
|
|
2013-01-17 19:32:13 +01:00
|
|
|
ret = schedule_unload(pid, bin);
|
2013-01-17 15:43:55 +01:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2014-09-07 20:09:30 +02:00
|
|
|
err = get_errno();
|
|
|
|
bdbg("ERROR: Failed to schedule unload '%s': %d\n", filename, err);
|
2013-01-17 15:43:55 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
sched_unlock();
|
2013-01-17 19:32:13 +01:00
|
|
|
return pid;
|
2014-09-07 20:09:30 +02:00
|
|
|
|
|
|
|
errout_with_lock:
|
|
|
|
sched_unlock();
|
|
|
|
unload_module(bin);
|
2014-09-14 22:10:23 +02:00
|
|
|
errout_with_argv:
|
|
|
|
binfmt_freeargv(bin);
|
2014-09-07 20:09:30 +02:00
|
|
|
errout_with_bin:
|
|
|
|
kmm_free(bin);
|
|
|
|
errout:
|
|
|
|
set_errno(err);
|
|
|
|
return ERROR;
|
|
|
|
|
2013-01-17 15:43:55 +01:00
|
|
|
#else
|
2009-07-12 20:43:59 +02:00
|
|
|
struct binary_s bin;
|
2014-09-07 20:09:30 +02:00
|
|
|
int err;
|
2009-07-12 20:43:59 +02:00
|
|
|
int ret;
|
|
|
|
|
2013-01-08 17:25:30 +01:00
|
|
|
/* Load the module into memory */
|
|
|
|
|
2009-07-12 20:43:59 +02:00
|
|
|
memset(&bin, 0, sizeof(struct binary_s));
|
|
|
|
bin.filename = filename;
|
|
|
|
bin.exports = exports;
|
2009-07-13 03:35:15 +02:00
|
|
|
bin.nexports = nexports;
|
2009-07-12 20:43:59 +02:00
|
|
|
|
|
|
|
ret = load_module(&bin);
|
|
|
|
if (ret < 0)
|
|
|
|
{
|
2014-09-07 20:09:30 +02:00
|
|
|
err = get_errno();
|
|
|
|
bdbg("ERROR: Failed to load program '%s': %d\n", filename, err);
|
|
|
|
goto errout;
|
2009-07-12 20:43:59 +02:00
|
|
|
}
|
|
|
|
|
2013-01-17 01:30:12 +01:00
|
|
|
/* Then start the module */
|
2013-01-08 17:25:30 +01:00
|
|
|
|
2013-01-17 01:30:12 +01:00
|
|
|
ret = exec_module(&bin);
|
2009-07-12 20:43:59 +02:00
|
|
|
if (ret < 0)
|
|
|
|
{
|
2014-09-07 20:09:30 +02:00
|
|
|
err = get_errno();
|
|
|
|
bdbg("ERROR: Failed to execute program '%s': %d\n", filename, err);
|
|
|
|
goto errout_with_module;
|
2009-07-12 20:43:59 +02:00
|
|
|
}
|
|
|
|
|
2013-01-17 15:43:55 +01:00
|
|
|
/* TODO: How does the module get unloaded in this case? */
|
|
|
|
|
2009-07-12 20:43:59 +02:00
|
|
|
return ret;
|
2014-09-07 20:09:30 +02:00
|
|
|
|
|
|
|
errout_with_module:
|
|
|
|
unload_module(&bin);
|
|
|
|
errout:
|
|
|
|
set_errno(err);
|
|
|
|
return ERROR;
|
2013-01-17 15:43:55 +01:00
|
|
|
#endif
|
2009-07-12 20:43:59 +02:00
|
|
|
}
|
|
|
|
|
2014-07-11 19:58:46 +02:00
|
|
|
#endif /* !CONFIG_BINFMT_DISABLE */
|
|
|
|
|