123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312 |
- /****************************************************************************
- * binfmt/nxflat.c
- *
- * 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.
- *
- ****************************************************************************/
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <sys/types.h>
- #include <stdint.h>
- #include <string.h>
- #include <nxflat.h>
- #include <debug.h>
- #include <errno.h>
- #include <arpa/inet.h>
- #include <nuttx/kmalloc.h>
- #include <nuttx/binfmt/binfmt.h>
- #include <nuttx/binfmt/nxflat.h>
- #ifdef CONFIG_NXFLAT
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- /* CONFIG_DEBUG_FEATURES, CONFIG_DEBUG_INFO, and CONFIG_DEBUG_BINFMT
- * have to be defined or CONFIG_NXFLAT_DUMPBUFFER does nothing.
- */
- #if !defined(CONFIG_DEBUG_INFO) || !defined (CONFIG_DEBUG_BINFMT)
- # undef CONFIG_NXFLAT_DUMPBUFFER
- #endif
- #ifdef CONFIG_NXFLAT_DUMPBUFFER
- # define nxflat_dumpbuffer(m,b,n) binfodumpbuffer(m,b,n)
- #else
- # define nxflat_dumpbuffer(m,b,n)
- #endif
- #ifndef MIN
- # define MIN(a,b) (a < b ? a : b)
- #endif
- /****************************************************************************
- * Private Function Prototypes
- ****************************************************************************/
- static int nxflat_loadbinary(FAR struct binary_s *binp,
- FAR const char *filename,
- FAR const struct symtab_s *exports,
- int nexports);
- static int nxflat_unloadbinary(FAR struct binary_s *binp);
- #if defined(CONFIG_DEBUG_FEATURES) && defined(CONFIG_DEBUG_BINFMT)
- static void nxflat_dumploadinfo(FAR struct nxflat_loadinfo_s *loadinfo);
- #endif
- /****************************************************************************
- * Private Data
- ****************************************************************************/
- static struct binfmt_s g_nxflatbinfmt =
- {
- NULL, /* next */
- nxflat_loadbinary, /* load */
- nxflat_unloadbinary, /* unload */
- };
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: nxflat_dumploadinfo
- ****************************************************************************/
- #if defined(CONFIG_DEBUG_FEATURES) && defined(CONFIG_DEBUG_BINFMT)
- static void nxflat_dumploadinfo(FAR struct nxflat_loadinfo_s *loadinfo)
- {
- unsigned long dsize = loadinfo->datasize + loadinfo->bsssize;
- binfo("LOAD_INFO:\n");
- binfo(" ISPACE:\n");
- binfo(" ispace: %08lx\n", loadinfo->ispace);
- binfo(" entryoffs: %08lx\n", loadinfo->entryoffs);
- binfo(" isize: %08lx\n", loadinfo->isize);
- binfo(" DSPACE:\n");
- binfo(" dspace: %08lx\n", loadinfo->dspace);
- if (loadinfo->dspace != NULL)
- {
- binfo(" crefs: %d\n", loadinfo->dspace->crefs);
- binfo(" region: %08lx\n", loadinfo->dspace->region);
- }
- binfo(" datasize: %08lx\n", loadinfo->datasize);
- binfo(" bsssize: %08lx\n", loadinfo->bsssize);
- binfo(" (pad): %08lx\n", loadinfo->dsize - dsize);
- binfo(" stacksize: %08lx\n", loadinfo->stacksize);
- binfo(" dsize: %08lx\n", loadinfo->dsize);
- binfo(" RELOCS:\n");
- binfo(" relocstart: %08lx\n", loadinfo->relocstart);
- binfo(" reloccount: %d\n", loadinfo->reloccount);
- }
- #else
- # define nxflat_dumploadinfo(i)
- #endif
- /****************************************************************************
- * Name: nxflat_loadbinary
- *
- * Description:
- * Verify that the file is an NXFLAT binary and, if so, load the NXFLAT
- * binary into memory
- *
- ****************************************************************************/
- static int nxflat_loadbinary(FAR struct binary_s *binp,
- FAR const char *filename,
- FAR const struct symtab_s *exports,
- int nexports)
- {
- struct nxflat_loadinfo_s loadinfo; /* Contains globals for libnxflat */
- int ret;
- binfo("Loading file: %s\n", filename);
- /* Initialize the xflat library to load the program binary. */
- ret = nxflat_init(filename, &loadinfo);
- nxflat_dumploadinfo(&loadinfo);
- if (ret != 0)
- {
- berr("Failed to initialize for load of NXFLAT program: %d\n", ret);
- goto errout;
- }
- /* Load the program binary */
- ret = nxflat_load(&loadinfo);
- nxflat_dumploadinfo(&loadinfo);
- if (ret != 0)
- {
- berr("Failed to load NXFLAT program binary: %d\n", ret);
- goto errout_with_init;
- }
- /* Bind the program to the exported symbol table */
- ret = nxflat_bind(&loadinfo, exports, nexports);
- if (ret != 0)
- {
- berr("Failed to bind symbols program binary: %d\n", ret);
- goto errout_with_load;
- }
- /* Return the load information. By convention, D-space address
- * space is stored as the first allocated memory.
- */
- binp->entrypt = (main_t)(loadinfo.ispace + loadinfo.entryoffs);
- binp->mapped = (FAR void *)loadinfo.ispace;
- binp->mapsize = loadinfo.isize;
- binp->stacksize = loadinfo.stacksize;
- /* Add the ELF allocation to the alloc[] only if there is no address
- * environment. If there is an address environment, it will automatically
- * be freed when the function exits
- *
- * REVISIT: If the module is loaded then unloaded, wouldn't this cause
- * a memory leak?
- */
- #ifdef CONFIG_ARCH_ADDRENV
- # warning "REVISIT"
- #else
- binp->alloc[0] = (FAR void *)loadinfo.dspace;
- #endif
- #ifdef CONFIG_ARCH_ADDRENV
- /* Save the address environment in the binfmt structure. This will be
- * needed when the module is executed.
- */
- up_addrenv_clone(&loadinfo.addrenv, &binp->addrenv);
- #endif
- nxflat_dumpbuffer("Entry code", (FAR const uint8_t *)binp->entrypt,
- MIN(loadinfo.isize - loadinfo.entryoffs, 512));
- nxflat_uninit(&loadinfo);
- return OK;
- errout_with_load:
- nxflat_unload(&loadinfo);
- errout_with_init:
- nxflat_uninit(&loadinfo);
- errout:
- return ret;
- }
- /****************************************************************************
- * Name: nxflat_unloadbinary
- *
- * Description:
- * Verify that the file is an NXFLAT binary and, if so, load the NXFLAT
- * binary into memory
- *
- ****************************************************************************/
- static int nxflat_unloadbinary(FAR struct binary_s *binp)
- {
- FAR struct dspace_s *dspace = (FAR struct dspace_s *)binp->alloc[0];
- /* Check if this is the last reference to dspace. It may still be needed
- * by other threads. In that case, it must persist after this thread
- * terminates.
- */
- if (dspace != NULL && dspace->crefs == 1)
- {
- /* Free the dspace region */
- kumm_free(dspace->region);
- dspace->region = NULL;
- /* Mark alloc[0] (dspace) as freed */
- binp->alloc[0] = NULL;
- /* The reference count will be decremented to zero and the dspace
- * container will be freed in sched/nxsched_release_tcb.c
- */
- }
- return OK;
- }
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: nxflat_initialize
- *
- * Description:
- * In order to use the NxFLAT binary format, this function must be called
- * during system initialization to register the NXFLAT 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 nxflat_initialize(void)
- {
- int ret;
- /* Register ourselves as a binfmt loader */
- binfo("Registering NXFLAT\n");
- ret = register_binfmt(&g_nxflatbinfmt);
- if (ret != 0)
- {
- berr("Failed to register binfmt: %d\n", ret);
- }
- return ret;
- }
- /****************************************************************************
- * Name: nxflat_uninitialize
- *
- * Description:
- * Unregister the NXFLAT binary loader
- *
- * Returned Value:
- * None
- *
- ****************************************************************************/
- void nxflat_uninitialize(void)
- {
- unregister_binfmt(&g_nxflatbinfmt);
- }
- #endif /* CONFIG_NXFLAT */
|