Implement redirection of output from NSH builtin commands to a file in a mounted volume

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

apps/builtin/Kconfig

@@ -27,4 +27,13 @@ if BUILTIN
 		however, to support execution of the builtin applications from BINFS as
 		well (via a binfmt/ loader).  However, that is down the road.
 
+config BUILTIN_PROXY_STACKSIZE
+	int "Builtin Proxy Stack Size"
+	default 1024
+	---help---
+		If exec_builting uses I/O redirection options, then it will require
+		an intermediary/proxy task to muck with the file descriptors.  This
+		configuration item specifies the stack size used for the proxy. Default:
+		1024 bytes.
+
 endif

apps/builtin/binfs.c

@@ -399,7 +399,7 @@ static int binfs_readdir(struct inode *mountpt, struct fs_dirent_s *dir)
   /* Have we reached the end of the directory */
 
   index = dir->u.binfs.fb_index;
-  if (builtins[index].name == NULL)
+  if (g_builtins[index].name == NULL)
     {
       /* We signal the end of the directory by returning the
        * special error -ENOENT
@@ -412,9 +412,9 @@ static int binfs_readdir(struct inode *mountpt, struct fs_dirent_s *dir)
     {
       /* Save the filename and file type */
 
-      fvdbg("Entry %d: \"%s\"\n", index, builtins[index].name);
+      fvdbg("Entry %d: \"%s\"\n", index, g_builtins[index].name);
       dir->fd_dir.d_type = DTYPE_FILE;
-      strncpy(dir->fd_dir.d_name, builtins[index].name, NAME_MAX+1);
+      strncpy(dir->fd_dir.d_name, g_builtins[index].name, NAME_MAX+1);
 
       /* The application list is terminated by an entry with a NULL name.
        * Therefore, there is at least one more entry in the list.

apps/builtin/builtin.c

@@ -64,7 +64,7 @@ extern "C" {
 
 #include "builtin_proto.h"
 
-const struct builtin_s builtins[] =
+const struct builtin_s g_builtins[] =
 {
 # include "builtin_list.h"
   { NULL, 0, 0, 0 }
@@ -90,7 +90,7 @@ const struct builtin_s builtins[] =
 
 int number_builtins(void)
 {
-  return sizeof(builtins)/sizeof(struct builtin_s) - 1;
+  return sizeof(g_builtins)/sizeof(struct builtin_s) - 1;
 }
 
 

apps/builtin/builtin.h

@@ -60,7 +60,7 @@ extern "C" {
 #define EXTERN extern
 #endif
 
-EXTERN const struct builtin_s builtins[];
+EXTERN const struct builtin_s g_builtins[];
 
 /****************************************************************************
  * Public Functions

apps/builtin/exec_builtin.c

@@ -1,13 +1,15 @@
 /****************************************************************************
  * apps/builtin/exec_builtin.c
  *
+ * Originally by:
+ *
  *   Copyright (C) 2011 Uros Platise. All rights reserved.
  *   Author: Uros Platise <uros.platise@isotel.eu>
  *
- * With updates, modifications, and general maintenance by:
+ * With subsequent updates, modifications, and general maintenance by:
  *
- *   Copyright (C) 2012 Gregory Nutt.  All rights reserved.
- *   Auther: Gregory Nutt <gnutt@nuttx.org>
+ *   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,18 +45,45 @@
  ****************************************************************************/
 
 #include <nuttx/config.h>
-#include <apps/apps.h>
-#include <sched.h>
 
+#include <sched.h>
 #include <string.h>
+#include <fcntl.h>
+#include <semaphore.h>
 #include <errno.h>
+#include <debug.h>
+
+#include <apps/apps.h>
 
 #include "builtin.h"
 
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+#ifndef CONFIG_BUILTIN_PROXY_STACKSIZE
+#  define CONFIG_BUILTIN_PROXY_STACKSIZE 1024
+#endif
+
 /****************************************************************************
  * Private Types
  ****************************************************************************/
 
+struct builtin_parms_s
+{
+  /* Input values */
+
+  FAR const char *redirfile;
+  FAR const char **argv;
+  int oflags;
+  int index;
+
+  /* Returned values */
+
+  pid_t result;
+  int errcode;
+};
+
 /****************************************************************************
  * Private Function Prototypes
  ****************************************************************************/
@@ -63,10 +92,276 @@
  * Private Data
  ****************************************************************************/
 
+static sem_t g_builtin_parmsem = SEM_INITIALIZER(1);
+static sem_t g_builtin_execsem = SEM_INITIALIZER(0);
+static struct builtin_parms_s g_builtin_parms;
+
 /****************************************************************************
  * Private Functions
  ****************************************************************************/
 
+/****************************************************************************
+ * Name: bultin_semtake and builtin_semgive
+ *
+ * Description:
+ *   Give and take semaphores
+ *
+ * Input Parameters:
+ *
+ *   sem - The semaphore to act on.
+ *
+ * Returned Value:
+ *   None
+ *
+ ****************************************************************************/
+
+static void bultin_semtake(FAR sem_t *sem)
+{
+  int ret;
+
+  do
+    {
+      ret = sem_wait(sem);
+      ASSERT(ret == 0 || errno == EINTR);
+    }
+  while (ret != 0);
+}
+
+#define builtin_semgive(sem) sem_post(sem)
+
+/****************************************************************************
+ * Name: builtin_taskcreate
+ *
+ * Description:
+ *   Execute the builtin task
+ *
+ * Returned Value:
+ *   On success, the task ID of the builtin task is returned; On failure, -1
+ *  (ERROR) is returned and the errno is set appropriately.
+ *
+ ****************************************************************************/
+
+static int builtin_taskcreate(int index, FAR const char **argv)
+{
+  int ret;
+
+  /* Disable pre-emption.  This means that although we start the builtin
+   * application here, it will not actually run until pre-emption is
+   * re-enabled below.
+   */
+
+  sched_lock();
+
+  /* Start the builtin application task */
+
+  ret = TASK_CREATE(g_builtins[index].name, g_builtins[index].priority,
+                    g_builtins[index].stacksize, g_builtins[index].main,
+                    (argv) ? &argv[1] : (FAR const char **)NULL);
+
+  /* If robin robin scheduling is enabled, then set the scheduling policy
+   * of the new task to SCHED_RR before it has a chance to run.
+   */
+
+#if CONFIG_RR_INTERVAL > 0
+  if (ret > 0)
+    {
+      struct sched_param param;
+
+      /* Pre-emption is disabled so the task creation and the
+       * following operation will be atomic.  The priority of the
+       * new task cannot yet have changed from its initial value.
+       */
+
+      param.sched_priority = g_builtins[index].priority;
+      (void)sched_setscheduler(ret, SCHED_RR, &param);
+    }
+#endif
+
+  /* Now let the builtin application run */
+
+  sched_unlock();
+
+  /* Return the task ID of the new task if the task was sucessfully
+   * started.  Otherwise, ret will be ERROR (and the errno value will
+   * be set appropriately).
+   */
+
+  return ret;
+}
+
+/****************************************************************************
+ * Name: builtin_proxy
+ *
+ * Description:
+ *   Perform output redirection, then execute the builtin task.
+ *
+ * Input Parameters:
+ *   Standard task start-up parameters
+ *
+ * Returned Value:
+ *   Standard task return value.
+ *
+ ****************************************************************************/
+
+static int builtin_proxy(int argc, char *argv[])
+{
+  int fd;
+  int ret = ERROR;
+
+  /* Open the output file for redirection */
+
+  svdbg("Open'ing redirfile=%s oflags=%04x mode=0644\n",
+        g_builtin_parms.redirfile, g_builtin_parms.oflags);
+
+  fd = open(g_builtin_parms.redirfile, g_builtin_parms.oflags, 0644);
+  if (fd < 0)
+    {
+      /* Remember the errno value.  ret is already set to ERROR */
+
+      g_builtin_parms.errcode = errno;
+      sdbg("ERROR: open of %s failed: %d\n",
+           g_builtin_parms.redirfile, g_builtin_parms.errcode);
+    }
+
+  /* Does the return file descriptor happen to match the required file
+   * desciptor number?
+   */
+
+  else if (fd != 1)
+    {
+      /* No.. dup2 to get the correct file number */
+
+      svdbg("Dup'ing %d->1\n", fd);
+
+      ret = dup2(fd, 1);
+      if (ret < 0)
+        {
+          g_builtin_parms.errcode = errno;
+          sdbg("ERROR: dup2 failed: %d\n", g_builtin_parms.errcode);
+        }
+
+      svdbg("Closing fd=%d\n", fd);
+      close(fd);
+    }
+
+  /* Was the setup successful? */
+
+  if (ret == OK)
+    {
+      /* Yes.. Start the task.  On success, the task ID of the builtin task
+       * is returned; On failure, -1 (ERROR) is returned and the errno
+       * is set appropriately.
+       */
+
+      ret = builtin_taskcreate(g_builtin_parms.index, g_builtin_parms.argv);
+      if (ret < 0)
+        {
+          g_builtin_parms.errcode = errno;
+          sdbg("ERROR: builtin_taskcreate failed: %d\n",
+               g_builtin_parms.errcode);
+        }
+    }
+
+  /* Post the semaphore to inform the parent task that we have completed
+   * what we need to do.
+   */
+
+  g_builtin_parms.result = ret;
+  builtin_semgive(&g_builtin_execsem);
+  return 0;
+}
+
+/****************************************************************************
+ * Name: builtin_startproxy
+ *
+ * Description:
+ *   Perform output redirection, then execute the builtin task.
+ *
+ * Input Parameters:
+ *   Standard task start-up parameters
+ *
+ * Returned Value:
+ *   On success, the task ID of the builtin task is returned; On failure, -1
+ *  (ERROR) is returned and the errno is set appropriately.
+ *
+ ****************************************************************************/
+
+static inline int builtin_startproxy(int index, FAR const char **argv,
+                                     FAR const char *redirfile, int oflags)
+{
+  struct sched_param param;
+  pid_t proxy;
+  int errcode;
+  int ret;
+
+  DEBUGASSERT(path);
+
+  svdbg("index=%d argv=%p redirfile=%s oflags=%04x\n",
+        index, argv, redirfile, oflags);
+
+  /* We will have to go through an intermediary/proxy task in order to
+   * perform the I/O redirection.  This would be a natural place to fork().
+   * However, true fork() behavior requires an MMU and most implementations
+   * of vfork() are not capable of these operations.
+   *
+   * Even without fork(), we can still do the job, but parameter passing is
+   * messier.  Unfortunately, there is no (clean) way to pass binary values
+   * as a task parameter, so we will use a semaphore-protected global
+   * structure.
+   */
+
+  /* Get exclusive access to the global parameter structure */
+
+  bultin_semtake(&g_builtin_parmsem);
+
+  /* Populate the parameter structure */
+
+  g_builtin_parms.redirfile = redirfile;
+  g_builtin_parms.argv      = argv;
+  g_builtin_parms.result    = ERROR;
+  g_builtin_parms.oflags    = oflags;
+  g_builtin_parms.index     = index;
+
+  /* Get the priority of this (parent) task */
+
+  ret = sched_getparam(0, &param);
+  if (ret < 0)
+    {
+      errcode = errno;
+      sdbg("ERROR: sched_getparam failed: %d\n", errcode);
+      goto errout;
+    }
+
+  /* Start the intermediary/proxy task at the same priority as the parent task. */
+
+  proxy = TASK_CREATE("builtin_proxy", param.sched_priority,
+                      CONFIG_BUILTIN_PROXY_STACKSIZE, (main_t)builtin_proxy,
+                      (FAR const char **)NULL);
+  if (proxy < 0)
+    {
+      errcode = errno;
+      sdbg("ERROR: Failed to start builtin_proxy: %d\n", errcode);
+      goto errout;
+    }
+
+   /* Wait for the proxy to complete its job.  We could use waitpid()
+    * for this.
+    */
+
+   bultin_semtake(&g_builtin_execsem);
+
+   /* Get the result and relinquish our access to the parameter structure */
+
+   set_errno(g_builtin_parms.errcode);
+   builtin_semgive(&g_builtin_parmsem);
+   return g_builtin_parms.result;
+
+errout:
+  set_errno(errcode);
+  builtin_semgive(&g_builtin_parmsem);
+  return ERROR;
+}
+
 /****************************************************************************
  * Public Functions
  ****************************************************************************/
@@ -86,10 +381,10 @@ const char *builtin_getname(int index)
    {
      return NULL;
    }
-    
-  return builtins[index].name;
+
+  return g_builtins[index].name;
 }
- 
+
 /****************************************************************************
  * Name: builtin_isavail
  *
@@ -102,10 +397,10 @@ const char *builtin_getname(int index)
 int builtin_isavail(FAR const char *appname)
 {
   int i;
-    
-  for (i = 0; builtins[i].name; i++) 
+
+  for (i = 0; g_builtins[i].name; i++)
     {
-      if (!strcmp(builtins[i].name, appname))
+      if (!strcmp(g_builtins[i].name, appname))
         {
           return i;
         }
@@ -114,74 +409,60 @@ int builtin_isavail(FAR const char *appname)
   set_errno(ENOENT);
   return ERROR;
 }
- 
+
 /****************************************************************************
- * Name: builtin_isavail
+ * Name: exec_builtin
  *
  * Description:
- *   Execute the application with name 'appname', providing the arguments
- *   in the argv[] array.
+ *   Executes builtin applications registered during 'make context' time.
+ *   New application is run in a separate task context (and thread).
+ *
+ * Input Parameter:
+ *   filename  - Name of the linked-in binary to be started.
+ *   argv      - Argument list
+ *   redirfile - If output if redirected, this parameter will be non-NULL
+ *               and will provide the full path to the file.
+ *   oflags    - If output is redirected, this parameter will provide the
+ *               open flags to use.  This will support file replacement
+ *               of appending to an existing file.
  *
  * Returned Value:
- *   On success, the task ID of the builtin application is returned.  On
- *   failure, -1 (ERROR) is returned an the errno value is set appropriately.
+ *   This is an end-user function, so it follows the normal convention:
+ *   Returns the PID of the exec'ed module.  On failure, it.returns
+ *   -1 (ERROR) and sets errno appropriately.
  *
  ****************************************************************************/
 
-int exec_builtin(FAR const char *appname, FAR const char **argv)
+int exec_builtin(FAR const char *appname, FAR const char **argv,
+                 FAR const char *redirfile, int oflags)
 {
-  pid_t pid;
   int index;
+  int ret = ERROR;
 
   /* Verify that an application with this name exists */
 
   index = builtin_isavail(appname);
   if (index >= 0)
     {
-      /* Disable pre-emption.  This means that although we start the builtin
-       * application here, it will not actually run until pre-emption is
-       * re-enabled below.
-       */
+      /* Is output being redirected? */
 
-      sched_lock();
-
-      /* Start the builtin application task */
-
-      pid = TASK_CREATE(builtins[index].name, builtins[index].priority, 
-                        builtins[index].stacksize, builtins[index].main, 
-                        (argv) ? &argv[1] : (const char **)NULL);
-
-      /* If robin robin scheduling is enabled, then set the scheduling policy
-       * of the new task to SCHED_RR before it has a chance to run.
-       */
-
-#if CONFIG_RR_INTERVAL > 0
-      if (pid > 0)
+      if (redirfile)
         {
-          struct sched_param param;
-
-          /* Pre-emption is disabled so the task creation and the
-           * following operation will be atomic.  The priority of the
-           * new task cannot yet have changed from its initial value.
-           */
-
-          param.sched_priority = builtins[index].priority;
-          sched_setscheduler(pid, SCHED_RR, &param);
+          ret = builtin_startproxy(index, argv, redirfile, oflags);
         }
-#endif
-      /* Now let the builtin application run */
+      else
+        {
+          /* Start the builtin application task */
 
-      sched_unlock();
-
-      /* Return the task ID of the new task if the task was sucessfully
-       * started.  Otherwise, pid will be ERROR (and the errno value will
-       * be set appropriately).
-       */
-
-      return pid;
+          ret = builtin_taskcreate(index, argv);
+        }
     }
 
-  /* Return ERROR with errno set appropriately */
 
-  return ERROR;
+  /* Return the task ID of the new task if the task was sucessfully
+   * started.  Otherwise, ret will be ERROR (and the errno value will
+   * be set appropriately).
+   */
+
+  return ret;
 }