/**************************************************************************** * binfmt/binfmt.h * * Copyright (C) 2009 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_BINFMT_H #define __BINFMT_BINFMT_H /**************************************************************************** * Included Files ****************************************************************************/ #include #include /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /**************************************************************************** * Public Data ****************************************************************************/ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /* This is a list of registered handlers for different binary formats. This * list should only be accessed by normal user programs. It should be sufficient * protection to simply disable pre-emption when accessing this list. */ EXTERN FAR struct binfmt_s *g_binfmts; /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /**************************************************************************** * Name: dump_module * * Description: * Dump the contents of struct binary_s. * * Input Parameters: * bin - Load structure * * Returned Value: * Zero (OK) on success; a negated errno value on failure * ****************************************************************************/ #if defined(CONFIG_DEBUG_FEATURES) && defined(CONFIG_DEBUG_BINFMT) int dump_module(FAR const struct binary_s *bin); #else # define dump_module(bin) #endif /**************************************************************************** * 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 switch 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 Parameters: * bin - Load structure * argv - Argument list * * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ int binfmt_copyargv(FAR struct binary_s *bin, FAR char * const *argv); /**************************************************************************** * Name: binfmt_freeargv * * Description: * Release the copied argv[] list. * * Input Parameters: * bin - Load structure * * Returned Value: * None * ****************************************************************************/ #if defined(CONFIG_ARCH_ADDRENV) && defined(CONFIG_BUILD_KERNEL) void binfmt_freeargv(FAR struct binary_s *bin); #else # define binfmt_freeargv(bin) #endif /**************************************************************************** * Name: builtin_initialize * * Description: * In order to use the builtin binary format, this function must be called * during system initialize to register the builtin 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. * ****************************************************************************/ #if defined(CONFIG_FS_BINFS) && defined(HAVE_BUILTIN_CONTEXT) int builtin_initialize(void); #endif /**************************************************************************** * Name: builtin_uninitialize * * Description: * Unregister the builtin binary loader * * Returned Value: * None * ****************************************************************************/ #if defined(CONFIG_FS_BINFS) && defined(HAVE_BUILTIN_CONTEXT) void builtin_uninitialize(void); #endif #undef EXTERN #if defined(__cplusplus) } #endif #endif /* __BINFMT_BINFMT_H */