/**************************************************************************** * sched/module/mod_insmod.c * * Copyright (C) 2015, 2017 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. * ****************************************************************************/ /**************************************************************************** * Included Files ****************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include "module/module.h" #ifdef CONFIG_MODULE /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* CONFIG_DEBUG_INFO, and CONFIG_DEBUG_BINFMT have to be defined or * CONFIG_MODULE_DUMPBUFFER does nothing. */ #if !defined(CONFIG_DEBUG_INFO) || !defined (CONFIG_DEBUG_BINFMT) # undef CONFIG_MODULE_DUMPBUFFER #endif #ifdef CONFIG_MODULE_DUMPBUFFER # define mod_dumpbuffer(m,b,n) sinfodumpbuffer(m,b,n) #else # define mod_dumpbuffer(m,b,n) #endif #ifndef MIN # define MIN(a,b) (a < b ? a : b) #endif /**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: mod_dumploadinfo ****************************************************************************/ #if defined(CONFIG_DEBUG_INFO) && defined(CONFIG_DEBUG_BINFMT) static void mod_dumploadinfo(FAR struct mod_loadinfo_s *loadinfo) { int i; sinfo("LOAD_INFO:\n"); sinfo(" textalloc: %08lx\n", (long)loadinfo->textalloc); sinfo(" datastart: %08lx\n", (long)loadinfo->datastart); sinfo(" textsize: %ld\n", (long)loadinfo->textsize); sinfo(" datasize: %ld\n", (long)loadinfo->datasize); sinfo(" filelen: %ld\n", (long)loadinfo->filelen); sinfo(" filfd: %d\n", loadinfo->filfd); sinfo(" symtabidx: %d\n", loadinfo->symtabidx); sinfo(" strtabidx: %d\n", loadinfo->strtabidx); sinfo("ELF Header:\n"); sinfo(" e_ident: %02x %02x %02x %02x\n", loadinfo->ehdr.e_ident[0], loadinfo->ehdr.e_ident[1], loadinfo->ehdr.e_ident[2], loadinfo->ehdr.e_ident[3]); sinfo(" e_type: %04x\n", loadinfo->ehdr.e_type); sinfo(" e_machine: %04x\n", loadinfo->ehdr.e_machine); sinfo(" e_version: %08x\n", loadinfo->ehdr.e_version); sinfo(" e_entry: %08lx\n", (long)loadinfo->ehdr.e_entry); sinfo(" e_phoff: %d\n", loadinfo->ehdr.e_phoff); sinfo(" e_shoff: %d\n", loadinfo->ehdr.e_shoff); sinfo(" e_flags: %08x\n" , loadinfo->ehdr.e_flags); sinfo(" e_ehsize: %d\n", loadinfo->ehdr.e_ehsize); sinfo(" e_phentsize: %d\n", loadinfo->ehdr.e_phentsize); sinfo(" e_phnum: %d\n", loadinfo->ehdr.e_phnum); sinfo(" e_shentsize: %d\n", loadinfo->ehdr.e_shentsize); sinfo(" e_shnum: %d\n", loadinfo->ehdr.e_shnum); sinfo(" e_shstrndx: %d\n", loadinfo->ehdr.e_shstrndx); if (loadinfo->shdr && loadinfo->ehdr.e_shnum > 0) { for (i = 0; i < loadinfo->ehdr.e_shnum; i++) { FAR Elf32_Shdr *shdr = &loadinfo->shdr[i]; sinfo("Sections %d:\n", i); sinfo(" sh_name: %08x\n", shdr->sh_name); sinfo(" sh_type: %08x\n", shdr->sh_type); sinfo(" sh_flags: %08x\n", shdr->sh_flags); sinfo(" sh_addr: %08x\n", shdr->sh_addr); sinfo(" sh_offset: %d\n", shdr->sh_offset); sinfo(" sh_size: %d\n", shdr->sh_size); sinfo(" sh_link: %d\n", shdr->sh_link); sinfo(" sh_info: %d\n", shdr->sh_info); sinfo(" sh_addralign: %d\n", shdr->sh_addralign); sinfo(" sh_entsize: %d\n", shdr->sh_entsize); } } } #else # define mod_dumploadinfo(i) #endif /**************************************************************************** * Name: mod_dumpinitializer ****************************************************************************/ #ifdef CONFIG_MODULE_DUMPBUFFER static void mod_dumpinitializer(mod_initializer_t initializer, FAR struct mod_loadinfo_s *loadinfo) { mod_dumpbuffer("Initializer code", (FAR const uint8_t *)initializer, MIN(loadinfo->textsize - loadinfo->ehdr.e_entry, 512)); } #else # define mod_dumpinitializer(b,l) #endif /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: insmod * * Description: * Verify that the file is an ELF module binary and, if so, load the * module into kernel memory and initialize it for use. * * NOTE: mod_setsymtab had to have been called in board-specific OS logic * prior to calling this function from application logic (perhaps via * boardctl(BOARDIOC_OS_SYMTAB). Otherwise, insmod will be unable to * resolve symbols in the OS module. * * Input Parameters: * * filename - Full path to the module binary to be loaded * modulename - The name that can be used to refer to the module after * it has been loaded. * * Returned Value: * A non-NULL module handle that can be used on subsequent calls to other * module interfaces is returned on success. If insmod() was unable to * load the module insmod() will return a NULL handle and the errno * variable will be set appropriately. * ****************************************************************************/ FAR void *insmod(FAR const char *filename, FAR const char *modulename) { struct mod_loadinfo_s loadinfo; FAR struct module_s *modp; mod_initializer_t initializer; int ret; DEBUGASSERT(filename != NULL && modulename != NULL); sinfo("Loading file: %s\n", filename); /* Get exclusive access to the module registry */ mod_registry_lock(); /* Check if this module is already installed */ if (mod_registry_find(modulename) != NULL) { mod_registry_unlock(); ret = -EEXIST; goto errout_with_lock; } /* Initialize the ELF library to load the program binary. */ ret = mod_initialize(filename, &loadinfo); mod_dumploadinfo(&loadinfo); if (ret != 0) { serr("ERROR: Failed to initialize to load module: %d\n", ret); goto errout_with_lock; } /* Allocate a module registry entry to hold the module data */ modp = (FAR struct module_s *)kmm_zalloc(sizeof(struct module_s)); if (ret != 0) { sinfo("Failed to initialize for load of ELF program: %d\n", ret); goto errout_with_loadinfo; } /* Save the module name in the registry entry */ strncpy(modp->modulename, modulename, MODULENAME_MAX); /* Load the program binary */ ret = mod_load(&loadinfo); mod_dumploadinfo(&loadinfo); if (ret != 0) { sinfo("Failed to load ELF program binary: %d\n", ret); goto errout_with_registry_entry; } /* Bind the program to the kernel symbol table */ ret = mod_bind(&loadinfo); if (ret != 0) { sinfo("Failed to bind symbols program binary: %d\n", ret); goto errout_with_load; } /* Save the load information */ modp->alloc = (FAR void *)loadinfo.textalloc; #if defined(CONFIG_FS_PROCFS) && !defined(CONFIG_FS_PROCFS_EXCLUDE_MODULE) modp->textsize = loadinfo.textsize; modp->datasize = loadinfo.datasize; #endif /* Get the module initializer entry point */ initializer = (mod_initializer_t)(loadinfo.textalloc + loadinfo.ehdr.e_entry); #if defined(CONFIG_FS_PROCFS) && !defined(CONFIG_FS_PROCFS_EXCLUDE_MODULE) modp->initializer = initializer; #endif mod_dumpinitializer(initializer, &loadinfo); /* Call the module initializer */ ret = initializer(&modp->modinfo); if (ret < 0) { sinfo("Failed to initialize the module: %d\n", ret); goto errout_with_load; } /* Add the new module entry to the registry */ mod_registry_add(modp); mod_uninitialize(&loadinfo); mod_registry_unlock(); return (FAR void *)modp; errout_with_load: mod_unload(&loadinfo); errout_with_registry_entry: kmm_free(modp); errout_with_loadinfo: mod_uninitialize(&loadinfo); errout_with_lock: mod_registry_unlock(); set_errno(-ret); return NULL; } #endif /* CONFIG_MODULE */