imfs: Add IMFS_add_node()

Update #3894.

5 files changed, 312 insertions, 16 deletions

diff --git a/cpukit/Makefile.am b/cpukit/Makefile.am
index 783a9bbf42..9b0b821deb 100644
--- a/cpukit/Makefile.am
+++ b/cpukit/Makefile.am
@@ -413,6 +413,7 @@ librtemscpu_a_SOURCES += libfs/src/dosfs/msdos_rename.c
 librtemscpu_a_SOURCES += libfs/src/dosfs/msdos_rmnod.c
 librtemscpu_a_SOURCES += libfs/src/dosfs/msdos_statvfs.c
 librtemscpu_a_SOURCES += libfs/src/imfs/deviceio.c
+librtemscpu_a_SOURCES += libfs/src/imfs/imfs_add_node.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_chown.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_config.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_creat.c
@@ -435,6 +436,7 @@ librtemscpu_a_SOURCES += libfs/src/imfs/imfs_memfile.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_mknod.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_mount.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_node.c
+librtemscpu_a_SOURCES += libfs/src/imfs/imfs_node_destroy_default.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_rename.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_rmnod.c
 librtemscpu_a_SOURCES += libfs/src/imfs/imfs_stat.c
diff --git a/cpukit/include/rtems/imfs.h b/cpukit/include/rtems/imfs.h
index 1490186287..565d103226 100644
--- a/cpukit/include/rtems/imfs.h
+++ b/cpukit/include/rtems/imfs.h
@@ -207,6 +207,15 @@ typedef void (*IMFS_node_control_destroy)( IMFS_jnode_t *node );
 void IMFS_node_destroy_default( IMFS_jnode_t *node );
 
 /**
+ * @brief Does nothing.
+ *
+ * @param node The IMFS node.
+ *
+ * @see IMFS_node_control.
+ */
+void IMFS_do_nothing_destroy( IMFS_jnode_t *node );
+
+/**
  * @brief IMFS node control.
  */
 typedef struct {
@@ -319,6 +328,11 @@ typedef struct {
   size_t      size;
 } IMFS_linearfile_context;
 
+static inline IMFS_jnode_t *IMFS_iop_to_node( const rtems_libio_t *iop )
+{
+  return (IMFS_jnode_t *) iop->pathinfo.node_access;
+}
+
 static inline IMFS_directory_t *IMFS_iop_to_directory(
   const rtems_libio_t *iop
 )
@@ -594,6 +608,92 @@ static inline bool IMFS_is_imfs_instance(
   return loc->mt_entry->ops->clonenod_h == IMFS_node_clone;
 }
 
+/**
+ * @brief Initializer for an IMFS node control.
+ *
+ * @param handlers The file system node handlers.
+ * @param init The node initialization method.
+ * @param destroy The node destruction method.
+ */
+#define IMFS_NODE_CONTROL_INITIALIZER( handlers, init, destroy ) \
+  { \
+    ( handlers ), \
+    ( init ), \
+    IMFS_node_remove_default, \
+    ( destroy ) \
+  }
+
+/**
+ * @brief Initializer for an IMFS node.
+ *
+ * Initialize the node control with IMFS_NODE_CONTROL_INITIALIZER().
+ *
+ * @param node_control The node control of the IMFS node.
+ * @param name The name of the IMFS node.
+ * @param namelen The length of the name of the IMFS node.
+ * @param mode The mode of the IMFS node.
+ *
+ * @see IMFS_node_preinitialize().
+ */
+#define IMFS_NODE_INITIALIZER( node_control, name, namelen, mode ) \
+  { \
+    { NULL, NULL }, \
+    NULL, \
+    ( name ), \
+    ( namelen ), \
+    ( mode ), \
+    0, \
+    0, \
+    0, \
+    0, \
+    0, \
+    0, \
+    0, \
+    ( node_control ) \
+  }
+
+/**
+ * @brief Preinitializes an IMFS node.
+ *
+ * Initialize the node control with IMFS_NODE_CONTROL_INITIALIZER().
+ *
+ * @param node The IMFS node to preinitialize.
+ * @param node_control The node control of the IMFS node.
+ * @param name The name of the IMFS node.
+ * @param namelen The length of the name of the IMFS node.
+ * @param mode The mode of the IMFS node.
+ *
+ * @see IMFS_NODE_INITIALIZER().
+ */
+static inline void IMFS_node_preinitialize(
+  IMFS_jnode_t            *node,
+  const IMFS_node_control *node_control,
+  const char              *name,
+  size_t                   namelen,
+  mode_t                   mode
+)
+{
+  node->control = node_control;
+  node->name = name;
+  node->namelen = namelen;
+  node->st_mode = mode;
+}
+
+/**
+ * @brief Adds an IMFS node.
+ *
+ * Initialize the node with IMFS_NODE_INITIALIZER(), IMFS_node_preinitialize(),
+ * IMFS_GENERIC_NODE_INITIALIZER(), or IMFS_generic_node_preinitialize().
+ *
+ * @param path The path of parent directories for the IMFS node to add.
+ * @param node The IMFS node to add.
+ * @param arg The argument passed to the node initialization method.
+ *
+ * @retval 0 Successful operation.
+ * @retval -1 An error occurred.  The @c errno indicates the error.
+ */
+int IMFS_add_node( const char *path, IMFS_jnode_t *node, void *arg );
+
 extern int IMFS_make_node(
   const char              *path,
   mode_t                   mode,
@@ -638,20 +738,56 @@ extern int IMFS_make_linearfile(
  * @{
  */
 
+/* Provided for backward compatibility */
+#define IMFS_GENERIC_INITIALIZER( handlers, init, destroy ) \
+  IMFS_NODE_CONTROL_INITIALIZER( handlers, init, destroy )
+
 /**
  * @brief Initializer for a generic node control.
  *
- * @param[in] handlers The file system node handlers.
- * @param[in] init The node initialization method.
- * @param[in] destroy The node destruction method.
+ * @param handlers The file system node handlers.
+ * @param init The node initialization method.
+ * @param destroy The node destruction method.
  */
-#define IMFS_GENERIC_INITIALIZER( handlers, init, destroy ) \
-  { \
-    ( handlers ), \
-    ( init ), \
-    IMFS_node_remove_default, \
-    ( destroy ) \
-  }
+#define IMFS_GENERIC_CONTROL_INITIALIZER( handlers, init, destroy ) \
+  IMFS_NODE_CONTROL_INITIALIZER( handlers, init, destroy )
+
+/**
+ * @brief Initializer for a generic node.
+ *
+ * Initialize the node control with IMFS_GENERIC_CONTROL_INITIALIZER().
+ *
+ * @param node_control The node control of the IMFS generic node.
+ * @param name The name of the IMFS generic node.
+ * @param namelen The length of the name of the IMFS generic node.
+ * @param mode The mode of the IMFS generic node.
+ */
+#define IMFS_GENERIC_NODE_INITIALIZER( node_control, name, namelen, mode ) \
+  { IMFS_NODE_INITIALIZER( node_control, name, namelen, mode ), NULL }
+
+/**
+ * @brief Preinitializes a generic IMFS node.
+ *
+ * Initialize the node control with IMFS_GENERIC_CONTROL_INITIALIZER().
+ *
+ * @param node The generic IMFS node to preinitialize.
+ * @param node_control The node control of the generic IMFS node.
+ * @param name The name of the generic IMFS node.
+ * @param namelen The length of the name of the generic IMFS node.
+ * @param mode The mode of the generic IMFS node.
+ *
+ * @see IMFS_GENERIC_NODE_INITIALIZER().
+ */
+static inline void IMFS_generic_node_preinitialize(
+  IMFS_generic_t          *node,
+  const IMFS_node_control *node_control,
+  const char              *name,
+  size_t                   namelen,
+  mode_t                   mode
+)
+{
+  IMFS_node_preinitialize( &node->Node, node_control, name, namelen, mode );
+}
 
 /**
  * @brief Makes a generic IMFS node.
@@ -692,7 +828,8 @@ extern int IMFS_make_linearfile(
  *   IMFS_node_destroy_default(node);
  * }
  *
- * static const IMFS_node_control some_node_control = IMFS_GENERIC_INITIALIZER(
+ * static const IMFS_node_control
+ * some_node_control = IMFS_GENERIC_CONTROL_INITIALIZER(
  *   &some_node_handlers,
  *   some_node_init,
  *   some_node_destroy
diff --git a/cpukit/libfs/src/imfs/imfs_add_node.c b/cpukit/libfs/src/imfs/imfs_add_node.c
new file mode 100644
index 0000000000..ad26c5b26c
--- /dev/null
+++ b/cpukit/libfs/src/imfs/imfs_add_node.c
@@ -0,0 +1,112 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup IMFS
+ *
+ * @brief IMFS Add a Node
+ */
+
+/*
+ * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ *
+ * 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.
+ *
+ * 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.
+ */
+
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <rtems/imfs.h>
+
+int IMFS_add_node( const char *path, IMFS_jnode_t *node, void *arg )
+{
+  mode_t                                  mode;
+  rtems_filesystem_eval_path_context_t    ctx;
+  const rtems_filesystem_location_info_t *currentloc;
+  int                                     eval_flags;
+  int                                     rv;
+
+  mode = node->st_mode;
+  mode &= ~rtems_filesystem_umask;
+
+  switch (mode & S_IFMT) {
+    case S_IFBLK:
+    case S_IFCHR:
+    case S_IFIFO:
+    case S_IFREG:
+    case S_IFSOCK:
+      break;
+    default:
+      errno = EINVAL;
+      return -1;
+  }
+
+  eval_flags = RTEMS_FS_FOLLOW_LINK;
+  currentloc = rtems_filesystem_eval_path_start( &ctx, path, eval_flags );
+
+  if ( IMFS_is_imfs_instance( currentloc ) ) {
+    eval_flags = RTEMS_FS_MAKE | RTEMS_FS_EXCLUSIVE;
+    rtems_filesystem_eval_path_set_flags( &ctx, eval_flags );
+    rtems_filesystem_eval_path_set_path( &ctx, node->name, node->namelen );
+    rtems_filesystem_eval_path_continue( &ctx );
+
+    if ( rtems_filesystem_eval_path_get_token( &ctx ) == node->name ) {
+      IMFS_assert(
+        rtems_filesystem_eval_path_get_tokenlen( &ctx ) == node->namelen
+      );
+      node = IMFS_initialize_node(
+        node,
+        node->control,
+        node->name,
+        node->namelen,
+        mode,
+        arg
+      );
+      if ( node != NULL ) {
+        IMFS_jnode_t *parent;
+
+        currentloc = rtems_filesystem_eval_path_get_currentloc( &ctx );
+        parent = currentloc->node_access;
+        IMFS_assert( parent != NULL );
+        IMFS_add_to_directory( parent, node );
+        IMFS_mtime_ctime_update( parent );
+        rv = 0;
+      } else {
+        rv = -1;
+      }
+    } else {
+      if ( rtems_filesystem_eval_path_get_token( &ctx ) != NULL ) {
+        rtems_filesystem_eval_path_error( &ctx, EINVAL );
+      }
+
+      rv = -1;
+    }
+  } else {
+    rtems_filesystem_eval_path_error( &ctx, ENOTSUP );
+    rv = -1;
+  }
+
+  rtems_filesystem_eval_path_cleanup( &ctx );
+  return rv;
+}
diff --git a/cpukit/libfs/src/imfs/imfs_node.c b/cpukit/libfs/src/imfs/imfs_node.c
index ae087bd58f..c6a4b4bd4e 100644
--- a/cpukit/libfs/src/imfs/imfs_node.c
+++ b/cpukit/libfs/src/imfs/imfs_node.c
@@ -18,13 +18,11 @@
  */
 
 #if HAVE_CONFIG_H
-  #include "config.h"
+#include "config.h"
 #endif
 
 #include <rtems/imfs.h>
 
-#include <stdlib.h>
-
 IMFS_jnode_t *IMFS_initialize_node(
   IMFS_jnode_t *node,
   const IMFS_node_control *node_control,
@@ -105,7 +103,7 @@ IMFS_jnode_t *IMFS_node_remove_default(
   return node;
 }
 
-void IMFS_node_destroy_default( IMFS_jnode_t *node )
+void IMFS_do_nothing_destroy( IMFS_jnode_t *node )
 {
-  free( node );
+  (void) node;
 }
diff --git a/cpukit/libfs/src/imfs/imfs_node_destroy_default.c b/cpukit/libfs/src/imfs/imfs_node_destroy_default.c
new file mode 100644
index 0000000000..2340baa8d1
--- /dev/null
+++ b/cpukit/libfs/src/imfs/imfs_node_destroy_default.c
@@ -0,0 +1,47 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup IMFS
+ *
+ * @brief IMFS Default Node Destruction
+ */
+
+/*
+ * Copyright (C) 2014 embedded brains GmbH (http://www.embedded-brains.de)
+ *
+ * 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.
+ *
+ * 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.
+ */
+
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <rtems/imfs.h>
+
+#include <stdlib.h>
+
+void IMFS_node_destroy_default( IMFS_jnode_t *node )
+{
+  free( node );
+}