Rename apps/include/apps.h to builtin.h. Move parts of apps/builtins/exec_builtin.c to binfmt/libbuiltin/libbuiltin_utils.c

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5524 42af7a65-404d-4744-a932-0658087f49c3

ChangeLog

@@ -3957,3 +3957,8 @@
 	* configs/ubw32/ostest: Enable the vfork() test.
 	* fs/binfs:  Move apps/builtin/binfs.c to fs/binfs/fs_binfs.c
 	  CONFIG_APPS_BINDIR rename CONFIG_FS_BINFS
+	* include/nuttx/binfmt/builtin.h:  Some of the content of
+	  apps/include/apps.h moved to include/nuttx/binfmt/builtin.h
+	* binfmt/libbuiltin/libbuiltin_utils.c:  Move utility builtin
+	  utility functions from apps/builtin/exec_builtins.c to
+	  binfmt/libbuiltin/libbuiltin_utils.c

Documentation/NuttShell.html

@@ -3261,7 +3261,7 @@ Builtin Apps:
 
 <p>
   <b>Built-In Application Utility Functions</b>.
-  The utility functions exported by the builtin application logic are prototyped in <code>apps/include/apps.h</code>.
+  The utility functions exported by the builtin application logic are prototyped in <code>nuttx/include/nuttx/binfmt/builtin.h</code> and <code>apps/include/builtin.h</code>.
   These utility functions include:
 </p>
 

binfmt/Kconfig

@@ -49,6 +49,20 @@ if ELF
 source binfmt/libelf/Kconfig
 endif
 
+config BUILTIN
+	bool "Support Builtin Applications"
+	default n
+	---help---
+		Enable support for builtin applications.  This features assigns a string
+		name to an application and in addition if FS_BINFS is defined, retaining
+		those names in a file system from which they can be executed.  This feature
+		is also the underlying requirement to support built-in applications in the
+		NuttShell (NSH).
+
+if BUILTIN
+source binfmt/libbuiltin/Kconfig
+endif
+
 endif
 
 config PIC

binfmt/Makefile

@@ -1,7 +1,7 @@
 ############################################################################
 # nxflat/Makefile
 #
-#   Copyright (C) 2007-2009, 2012 Gregory Nutt. All rights reserved.
+#   Copyright (C) 2007-2009, 2012-2013 Gregory Nutt. All rights reserved.
 #   Author: Gregory Nutt <gnutt@nuttx.org>
 #
 # Redistribution and use in source and binary forms, with or without
@@ -65,6 +65,7 @@ DEPPATH = --dep-path .
 
 include libnxflat$(DELIM)Make.defs
 include libelf$(DELIM)Make.defs
+include libbuiltin$(DELIM)Make.defs
 
 BINFMT_AOBJS = $(BINFMT_ASRCS:.S=$(OBJEXT))
 BINFMT_COBJS = $(BINFMT_CSRCS:.c=$(OBJEXT))

binfmt/libbuiltin/Kconfig

@@ -0,0 +1,4 @@
+#
+# For a description of the syntax of this configuration file,
+# see misc/tools/kconfig-language.txt.
+#

binfmt/libbuiltin/Make.defs

@@ -0,0 +1,49 @@
+############################################################################
+# binfmt/libbuiltin/Make.defs
+#
+#   Copyright (C) 2013 Gregory Nutt. All rights reserved.
+#   Author: Gregory Nutt <gnutt@nuttx.org>
+#
+# 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.
+#
+############################################################################
+
+# Legacy configurations don't set CONFIG_BUILTIN
+# ifeq ($(CONFIG_BUILTIN),y)
+
+# Builtin application interfaces
+
+BINFMT_CSRCS += libbuiltin_utils.c
+
+# Hook the libelf subdirectory into the build
+
+VPATH += libbuiltin
+SUBDIRS += libbuiltin
+DEPPATH += --dep-path libbuiltin
+
+# endif

binfmt/libbuiltin/libbuiltin_utils.c

@@ -0,0 +1,121 @@
+/****************************************************************************
+ * binfmt/libbuiltin/libbuiltin_utils.c
+ *
+ * Originally by:
+ *
+ *   Copyright (C) 2011 Uros Platise. All rights reserved.
+ *   Author: Uros Platise <uros.platise@isotel.eu>
+ *
+ * With subsequent updates, modifications, and general maintenance by:
+ *
+ *   Copyright (C) 2012-2013 Gregory Nutt.  All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * 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 <limits.h>
+#include <errno.h>
+
+#include <nuttx/binfmt/builtin.h>
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: builtin_getname
+ *
+ * Description:
+ *   Return the name of the application at index in the table of builtin
+ *   applications.
+ *
+ ****************************************************************************/
+
+FAR const char *builtin_getname(int index)
+{
+  if (index < 0 || index >= number_builtins())
+   {
+     return NULL;
+   }
+
+  return g_builtins[index].name;
+}
+
+/****************************************************************************
+ * Name: builtin_isavail
+ *
+ * Description:
+ *   Return the index into the table of applications for the applicaiton with
+ *   the name 'appname'.
+ *
+ ****************************************************************************/
+
+int builtin_isavail(FAR const char *appname)
+{
+  int i;
+
+  for (i = 0; g_builtins[i].name; i++)
+    {
+      if (!strncmp(g_builtins[i].name, appname, NAME_MAX))
+        {
+          return i;
+        }
+    }
+
+  set_errno(ENOENT);
+  return ERROR;
+}

fs/binfs/fs_binfs.c

@@ -54,10 +54,9 @@
 #include <nuttx/fs/fs.h>
 #include <nuttx/fs/binfs.h>
 #include <nuttx/fs/dirent.h>
+#include <nuttx/fs/ioctl.h>
 #include <nuttx/binfmt/builtin.h>
 
-#include <apps/apps.h>
-
 #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_BINFS)
 
 /****************************************************************************

include/nuttx/binfmt/builtin.h

@@ -1,10 +1,15 @@
 /****************************************************************************
  * include/nuttx/binfmt/builtin.h
  *
+ * Originally by:
+ *
  *   Copyright (C) 2011 Uros Platise. All rights reserved.
- *   Copyright (C) 2011-2012 Gregory Nutt. All rights reserved.
+ *   Author: Uros Platise <uros.platise@isotel.eu>
- *   Authors: Uros Platise <uros.platise@isotel.eu>
+ *
- *            Gregory Nutt <gnutt@nuttx.org>
+ * With subsequent updates, modifications, and general maintenance by:
+ *
+ *   Copyright (C) 2012-2013 Gregory Nutt.  All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -43,7 +48,7 @@
  ****************************************************************************/
 
 #include <nuttx/config.h>
-#include <apps/apps.h>
+#include <sys/types.h>
 
 /****************************************************************************
  * Public Types
@@ -68,13 +73,79 @@ extern "C" {
 #define EXTERN extern
 #endif
 
+/* The g_builtins[] array holds information about each builtin function. If
+ * support for builtin functions is enabled in the NuttX configuration, then
+ * this arrary (along with the number_builtins() function) must be provided
+ * by the application code.
+ */
+
 EXTERN const struct builtin_s g_builtins[];
 
 /****************************************************************************
  * Public Functions
  ****************************************************************************/
 
-EXTERN int number_builtins(void);
+/****************************************************************************
+ * Utility Functions Provided to Applications by binfmt/libbuiltin
+ ****************************************************************************/
+/****************************************************************************
+ * Name: builtin_isavail
+ *
+ * Description:
+ *   Checks for availabiliy of application registerred during compile time.
+ *
+ * Input Parameter:
+ *   filename - Name of the linked-in binary to be started.
+ *
+ * Returned Value:
+ *   This is an end-user function, so it follows the normal convention:
+ *   Returns index of builtin application. If it is not found then it
+ *   returns -1 (ERROR) and sets errno appropriately.
+ *
+ ****************************************************************************/
+
+int builtin_isavail(FAR const char *appname);
+
+/****************************************************************************
+ * Name: builtin_getname
+ *
+ * Description:
+ *   Returns pointer to a name of built-in application pointed by the
+ *   index.
+ *
+ * Input Parameter:
+ *   index, from 0 and on ...
+ *
+ * Returned Value:
+ *   Returns valid pointer pointing to the app name if index is valid.
+ *   Otherwise NULL is returned.
+ *
+ ****************************************************************************/
+
+FAR const char *builtin_getname(int index);
+
+/****************************************************************************
+ * Data Set Access Functions Provided to Applications by binfmt/libbuiltin
+ ****************************************************************************/
+/****************************************************************************
+ * Name: number_builtins
+ *
+ * Description:
+ *   Returns the number of builtin functions in the g_builtins[] array.  If
+ *   support for builtin functions is enabled in the NuttX configuration,
+ *   then this function (along with g_builtins[]) must be provided by the
+ *   application code.
+ *
+ * Input Parameter:
+ *   None
+ *
+ * Returned Value:
+ *   The number of entries in the g_builtins[] array.  This function does
+ *   not return failures.
+ *
+ ****************************************************************************/
+
+int number_builtins(void);
 
 #undef EXTERN
 #if defined(__cplusplus)

include/nuttx/fs/binfs.h

@@ -42,22 +42,11 @@
 
 #include <nuttx/config.h>
 
-#include <nuttx/fs/ioctl.h>
-
 #ifdef CONFIG_FS_BINFS
 
 /****************************************************************************
  * Pre-processor Definitions
  ****************************************************************************/
-/* This is the BINFS ioctl that can be used to recover the filename
- * associated with the builtin task.
- */
-
-#define FIOC_FILENAME FIOC_USER /* IN:  FAR const char ** pointer 
-                                 * OUT: Pointer to a persistent file name
-                                 *      (Guaranteed to persist while the file
-                                 *      is open).
-                                 */
 
 /****************************************************************************
  * Type Definitions

include/nuttx/fs/ioctl.h

@@ -105,7 +105,11 @@
 #define FIOC_OPTIMIZE   _FIOC(0x0003)     /* IN:  None
                                            * OUT: None
                                            */
-#define FIOC_USER       _FIOC(0x0004)     /* File system-specific */
+#define FIOC_FILENAME   _FIOC(0x0004)     /* IN:  FAR const char ** pointer 
+                                           * OUT: Pointer to a persistent file name
+                                           *      (Guaranteed to persist while the file
+                                           *      is open).
+                                           */
 
 /* NuttX file system ioctl definitions **************************************/