[5.5/10] arch/arm, cmake: Build FDPIC modules in the normal ELF build.

arch/Kconfig

@@ -725,6 +725,13 @@ config ARCH_HAVE_ELF_EXECUTABLE
 	bool
 	default n
 
+config ARCH_HAVE_ELF_FDPIC
+	bool
+	default n
+	---help---
+		The architecture has a PIC base register and the ELF relocations
+		that an FDPIC object uses.
+
 config ARCH_HAVE_TRUSTZONE
 	bool
 	default n

arch/arm/Kconfig

@@ -1096,6 +1096,7 @@ config ARCH_ARMV7M
 	default n
 	select ARCH_HAVE_CPUINFO
 	select ARCH_HAVE_DEBUG
+	select ARCH_HAVE_ELF_FDPIC
 	select ARCH_HAVE_PERF_EVENTS
 
 config ARCH_CORTEXM3
@@ -1245,6 +1246,7 @@ config ARCH_ARMV8M
 	default n
 	select ARCH_HAVE_CPUINFO
 	select ARCH_HAVE_DEBUG
+	select ARCH_HAVE_ELF_FDPIC
 	select ARCH_HAVE_PERF_EVENTS
 
 config ARCH_CORTEXM23

arch/arm/include/arch.h

@@ -79,6 +79,45 @@ do { \
   ); \
 } while (0)
 
+#ifdef CONFIG_FDPIC
+
+/****************************************************************************
+ * Name: up_fdpic_invoke
+ *
+ * Description:
+ *   Call a module entry point with the module data base in the PIC base
+ *   register.  Put the caller data base back after the call.
+ *
+ * Input Parameters:
+ *   arg   - The one word argument, passed in r0.
+ *   entry - The code address to enter.
+ *   got   - The module data base to install.
+ *
+ ****************************************************************************/
+
+static inline void up_fdpic_invoke(uintptr_t arg, uintptr_t entry,
+                                   uintptr_t got)
+{
+  register uintptr_t r0v __asm__ ("r0") = arg;
+
+  /* arg is already in r0.  r4 goes on the stack with the PIC register to
+   * keep the push aligned to 8 bytes.
+   */
+
+  __asm__ __volatile__
+  (
+    "push {r4, " PIC_REG_STRING "}\n"   /* Save the caller's base       */
+    "mov " PIC_REG_STRING ", %[got]\n"  /* Install the module's base    */
+    "blx %[entry]\n"                    /* Enter the module             */
+    "pop {r4, " PIC_REG_STRING "}\n"    /* Restore the caller's base    */
+    : "+r" (r0v)
+    : [entry] "r" (entry), [got] "r" (got)
+    : "r1", "r2", "r3", "r12", "lr", "cc", "memory"
+  );
+}
+
+#endif /* CONFIG_FDPIC */
+
 #endif /* CONFIG_PIC */
 
 #ifdef CONFIG_ARCH_ADDRENV

arch/arm/include/elf.h

@@ -41,6 +41,11 @@
 
 #define EM_ARCH                  EM_ARM
 
+/* An object built for the FDPIC ABI says so in the OS/ABI byte. */
+
+#define ELF_IS_FDPIC(ehdr) \
+  ((ehdr)->e_ident[EI_OSABI] == ELFOSABI_ARM_FDPIC)
+
 /* Table 4-2, ARM-specific e_flags */
 
 #define EF_ARM_EABI_MASK         0xff000000
@@ -206,6 +211,18 @@
 #define R_ARM_THM_TLS_DESCSEQ16  129           /* Thumb16 */
 #define R_ARM_THM_TLS_DESCSEQ32  130           /* Thumb32 */
 
+/* FDPIC relocations.  Values from the ARM FDPIC ABI as implemented by
+ * binutils (include/elf/arm.h).
+ */
+
+#define R_ARM_GOTFUNCDESC        161           /* Data      GOT entry holding a descriptor */
+#define R_ARM_GOTOFFFUNCDESC     162           /* Data      GOT-relative descriptor */
+#define R_ARM_FUNCDESC           163           /* Data      Address of a descriptor */
+#define R_ARM_FUNCDESC_VALUE     164           /* Data      The descriptor itself: {code, GOT} */
+#define R_ARM_TLS_GD32_FDPIC     165           /* Data */
+#define R_ARM_TLS_LDM32_FDPIC    166           /* Data */
+#define R_ARM_TLS_IE32_FDPIC     167           /* Data */
+
 /* Processor specific values for the Phdr p_type field.  */
 
 #define PT_ARM_EXIDX             (PT_LOPROC + 1) /* ARM unwind segment.  */

arch/arm/src/cmake/elf.cmake

@@ -27,17 +27,59 @@ nuttx_mod_compile_options(-fvisibility=hidden -mlong-calls)
 nuttx_elf_compile_options_ifdef(CONFIG_UNWINDER_ARM -fno-unwind-tables
                                 -fno-asynchronous-unwind-tables)
 
-# An ELF module needs r9 as its PIC base, so it must not also have the register
-# fixed: GCC rejects that pair with "unable to use 'r9' for PIC register".  This
-# mirrors CELFFLAGS in common/Toolchain.defs, which filters --fixed-r9 back out
-# of the inherited CFLAGS for the same reason.
+if(CONFIG_FDPIC)
 
-nuttx_elf_compile_options_ifdef(CONFIG_PIC -mpic-register=r9)
+  # An FDPIC module is a shared object whose two segments the loader places
+  # independently.  The stock compiler emits correct FDPIC objects for both C
+  # and C++, so only the link needs the arm-uclinuxfdpiceabi linker: the stock
+  # one carries the armelf emulation alone and would turn every import into a
+  # jump slot where the ABI wants a function descriptor.
 
-nuttx_elf_link_options_ifdef(
-  CONFIG_PIC --unresolved-symbols=ignore-in-object-files --emit-relocs)
+  if(NOT FDPIC_CROSSDEV)
+    set(FDPIC_CROSSDEV arm-uclinuxfdpiceabi-)
+  endif()
+
+  # Say which linker is missing rather than failing later with a command that
+  # cannot be run.
+
+  find_program(FDPIC_LD "${FDPIC_CROSSDEV}ld")
+
+  if(NOT FDPIC_LD)
+    message(
+      FATAL_ERROR
+        "CONFIG_FDPIC needs ${FDPIC_CROSSDEV}ld, which is not on PATH. "
+        "It is in the NuttX CI image, and tools/ci/docker/linux/Dockerfile "
+        "shows how it is built.  Set FDPIC_CROSSDEV to use a different prefix")
+  endif()
+
+  set(CMAKE_ELF_LD
+      "${FDPIC_LD}"
+      CACHE INTERNAL "Linker for FDPIC modules")
+
+  nuttx_elf_compile_options(-mfdpic -fPIC -Wa,--noexecstack)
+
+  nuttx_elf_link_options(-m armelf_linux_fdpiceabi -shared -z now)
 
-nuttx_elf_link_options_ifdef(CONFIG_BINFMT_ELF_RELOCATABLE -r)
+elseif(CONFIG_PIC)
+
+  # An ELF module needs r9 as its PIC base, so it must not also have the
+  # register fixed: GCC rejects that pair with "unable to use 'r9' for PIC
+  # register".  This mirrors CELFFLAGS in common/Toolchain.defs, which filters
+  # --fixed-r9 back out of the inherited CFLAGS for the same reason.
+
+  nuttx_elf_compile_options(-mpic-register=r9)
+
+  nuttx_elf_link_options(--unresolved-symbols=ignore-in-object-files
+                         --emit-relocs)
+
+endif()
+
+# Not with CONFIG_PIC: there the module is linked as an executable, which is
+# what common/Toolchain.defs does too.
+
+if(CONFIG_BINFMT_ELF_RELOCATABLE AND NOT CONFIG_PIC)
+  nuttx_elf_link_options(-r)
+endif()
 
 nuttx_mod_link_options(-r)
 

arch/arm/src/common/Toolchain.defs

@@ -638,11 +638,45 @@ ifeq ($(CONFIG_PIC),y)
   # after including this file, which would discard the flag.
 
   ARCHCFLAGS += --fixed-r9
+
+ifeq ($(CONFIG_FDPIC),y)
+  # An FDPIC module is a shared object whose two segments the loader places
+  # independently.  The stock compiler emits correct FDPIC objects for both C
+  # and C++, so only the link needs the arm-uclinuxfdpiceabi linker: the
+  # stock one carries the armelf emulation alone and would turn every import
+  # into a jump slot where the ABI wants a function descriptor.
+
+  FDPIC_CROSSDEV ?= arm-uclinuxfdpiceabi-
+  MODULELD = $(FDPIC_CROSSDEV)ld
+
+  # Say which linker is missing rather than letting make report a command it
+  # cannot run.  The report is deferred to the link itself rather than made
+  # here, so that a tree configured for FDPIC on a host without the linker can
+  # still be cleaned and reconfigured.
+
+  FDPIC_LD_FOUND := $(shell command -v $(MODULELD) 2> /dev/null)
+
+  ifeq ($(FDPIC_LD_FOUND),)
+    FDPIC_NO_LD_MSG = CONFIG_FDPIC needs $(FDPIC_CROSSDEV)ld, which is not \
+      on PATH.  It is in the NuttX CI image, and \
+      tools/ci/docker/linux/Dockerfile shows how it is built.  Set \
+      FDPIC_CROSSDEV to use a different prefix.
+
+    MODULELD = $(SHELL) -c 'echo "ERROR: $(FDPIC_NO_LD_MSG)" 1>&2; exit 1' --
+  endif
+
+  CELFFLAGS += -mfdpic -fPIC -Wa,--noexecstack
+  CXXELFFLAGS += -mfdpic -fPIC -Wa,--noexecstack
+
+  LDELFFLAGS += -m armelf_linux_fdpiceabi -shared -z now
+else
   CELFFLAGS += $(PICFLAGS) -mpic-register=r9
   CXXELFFLAGS += $(PICFLAGS) -mpic-register=r9
 
   # Generate an executable elf, need to ignore undefined symbols
   LDELFFLAGS += --unresolved-symbols=ignore-in-object-files --emit-relocs
+endif
+
 else
   ifneq ($(CONFIG_BINFMT_ELF_EXECUTABLE),y)
     LDELFFLAGS += -r

binfmt/Kconfig

@@ -60,6 +60,38 @@ config ELF_STACKSIZE
 	default DEFAULT_TASK_STACKSIZE
 	---help---
 		This is the default stack size that will be used when starting ELF binaries.
+
+config FDPIC
+	bool "FDPIC modules"
+	default n
+	select PIC
+	depends on ARCH_HAVE_ELF_FDPIC
+	---help---
+		Load ELF modules built for the FDPIC ABI.
+
+		An FDPIC module places its read-only and writable segments
+		independently, so its text can be executed directly out of flash
+		while only the writable segment is copied to RAM, once per running
+		instance.  A filesystem that can show its media, such as XIPFS or
+		ROMFS, gives that result.  On any other filesystem the loader copies
+		the text to RAM, and the module runs but shares nothing.
+
+		Building a module needs an arm-uclinuxfdpiceabi linker.  The stock
+		arm-none-eabi compiler emits correct FDPIC objects for both C and
+		C++, so only the link needs it.
+
+		What this adds over the position independent ELF support already
+		present is a function pointer that carries its own data base, as a
+		two word descriptor rather than a bare code address.  That is what
+		lets a module be called back on a thread it did not create, such as
+		the work queue worker that runs a SIGEV_THREAD notification.
+
+		Selecting this makes ten libc and sched entry points that can
+		accept a callback from a module resolve such a descriptor before
+		storing or branching to it.  Each costs a register read and a
+		branch on a path that is not hot.
+
+		This implementation covers ARM Thumb-2.
 endif
 endif
 

binfmt/elf.c

@@ -139,7 +139,7 @@ static int elf_loadbinary(FAR struct binary_s *binp,
 
   /* Bind the program to the exported symbol table */
 
-  if (loadinfo.ehdr.e_type == ET_REL || loadinfo.gotindex >= 0)
+  if (loadinfo.ehdr.e_type == ET_REL || loadinfo.gotsize != 0)
     {
       ret = libelf_bind(&binp->mod, &loadinfo, exports, nexports);
       if (ret != 0)
@@ -270,7 +270,7 @@ static int elf_loadbinary(FAR struct binary_s *binp,
 
   libelf_dumpentrypt(&loadinfo);
 #ifdef CONFIG_PIC
-  if (loadinfo.gotindex >= 0)
+  if (loadinfo.gotsize != 0)
     {
       FAR struct dspace_s *dspaces = kmm_zalloc(sizeof(struct dspace_s));
 
@@ -280,7 +280,7 @@ static int elf_loadbinary(FAR struct binary_s *binp,
           goto errout_with_load;
         }
 
-      dspaces->region = (FAR void *)loadinfo.shdr[loadinfo.gotindex].sh_addr;
+      dspaces->region = (FAR void *)loadinfo.gotbase;
       dspaces->crefs = 1;
       binp->picbase = (FAR void *)dspaces;
     }

boards/arm/mps/mps3-an547/src/mps3_bringup.c

@@ -147,7 +147,7 @@ int board_boot_image(const char *path, uint32_t hdr_size)
     }
 
   bss = libelf_findsection(&loadinfo, ".bss");
-  got = loadinfo.shdr[loadinfo.gotindex].sh_addr;
+  got = loadinfo.gotbase;
   msp = loadinfo.shdr[bss].sh_addr + loadinfo.shdr[bss].sh_size +
         CONFIG_IDLETHREAD_STACKSIZE;
 

cmake/nuttx_add_application.cmake

@@ -149,7 +149,15 @@ function(nuttx_add_application)
         if(TARGET STARTUP_OBJS)
           add_dependencies(${TARGET} STARTUP_OBJS)
         endif()
-        if(NOT "${CMAKE_LD}" MATCHES "gcc$")
+        # A module may need a different linker from the one that links the
+        # firmware: an FDPIC module does, because the stock linker cannot
+        # produce one.  CMAKE_ELF_LD is that linker, and it is the ordinary one
+        # unless the architecture says otherwise.
+
+        if(NOT CMAKE_ELF_LD)
+          set(CMAKE_ELF_LD ${CMAKE_LD})
+        endif()
+        if(NOT "${CMAKE_ELF_LD}" MATCHES "gcc$")
           set(USE_LINKER True)
         endif()
         if(STACKSIZE)
@@ -179,7 +187,7 @@ function(nuttx_add_application)
           POST_BUILD
           COMMAND
             # add default link option
-            ${CMAKE_LD} -T ${NUTTX_BINARY_DIR}/gnu-elf.ld
+            ${CMAKE_ELF_LD} -T ${NUTTX_BINARY_DIR}/gnu-elf.ld
             # add global MOD link option if dynlib link
             $<$<BOOL:${DYNLIB_ELF_MODE}>:$<TARGET_PROPERTY:nuttx_global,NUTTX_MOD_APP_LINK_OPTIONS>>
             # add global ELF link option if m&kernel link

fs/Kconfig

@@ -94,6 +94,17 @@ config PSEUDOFS_ATTRIBUTES
 		Enable support for attributes(e.g. mode, uid, gid and time)
 		in the pseudo file system.
 
+config FS_PIN
+	bool
+	default n
+	---help---
+		Selected by a file system that can pin a file's blocks in place and
+		hand out their media address, so that a module's read-only segment
+		can be executed where it already lies instead of being copied.
+
+		The pin is held for as long as the module is loaded and given back
+		when it is unloaded.
+
 config FS_PERMISSION
 	bool "Enable UNIX Filesystem Permission Support"
 	default n

fs/xipfs/Kconfig

@@ -7,6 +7,7 @@ config FS_XIPFS
 	bool "XIPFS contiguous execute-in-place file system"
 	default n
 	depends on !DISABLE_MOUNTPOINT && MTD
+	select FS_PIN
 	---help---
 		Enable support for XIPFS, a file system that stores each file as a
 		single physically contiguous, erase-block aligned extent on memory

include/elf.h

@@ -149,6 +149,7 @@
 #define ELFOSABI_MODESTO   11    /* Novell Modesto.  */
 #define ELFOSABI_OPENBSD   12    /* OpenBSD.  */
 #define ELFOSABI_ARM_AEABI 64    /* ARM EABI */
+#define ELFOSABI_ARM_FDPIC 65    /* ARM FDPIC */
 #define ELFOSABI_ARM       97    /* ARM */
 #define ELFOSABI_STANDALONE 255  /* Standalone (embedded) application */
 
@@ -278,6 +279,12 @@
 #define DT_TEXTREL         22         /* d_un=ignored */
 #define DT_JMPREL          23         /* d_un=d_ptr */
 #define DT_BINDNOW         24         /* d_un=ignored */
+#define DT_INIT_ARRAY      25         /* d_un=d_ptr */
+#define DT_FINI_ARRAY      26         /* d_un=d_ptr */
+#define DT_INIT_ARRAYSZ    27         /* d_un=d_val */
+#define DT_FINI_ARRAYSZ    28         /* d_un=d_val */
+#define DT_PREINIT_ARRAY   32         /* d_un=d_ptr */
+#define DT_PREINIT_ARRAYSZ 33         /* d_un=d_val */
 #define DT_LOPROC          0x70000000 /* d_un=unspecified */
 #define DT_HIPROC          0x7fffffff /* d_un= unspecified */
 

include/nuttx/elf.h

@@ -37,6 +37,12 @@
 
 #define ELF_PRARGSZ    (80)  /* Number of chars for args */
 
+/* An architecture that has no FDPIC ABI recognises no FDPIC object. */
+
+#ifndef ELF_IS_FDPIC
+#  define ELF_IS_FDPIC(ehdr) false
+#endif
+
 /****************************************************************************
  * Public Types
  ****************************************************************************/