posix: shared memory support

Add POSIX shared memory manager (Shm). Includes a hook-based
approach for the backing memory storage that defaults to the
Workspace, and a test is provided using the heap. A test is
also provided for the basic use of mmap'ing a shared memory
object. This test currently fails at the mmap stage due to
no support for mmap.

3 files changed, 302 insertions, 0 deletions

diff --git a/cpukit/posix/include/rtems/posix/config.h b/cpukit/posix/include/rtems/posix/config.h
index 11c73c2b2f..6c74216dc2 100644
--- a/cpukit/posix/include/rtems/posix/config.h
+++ b/cpukit/posix/include/rtems/posix/config.h
@@ -111,6 +111,11 @@ typedef struct {
   uint32_t                            maximum_rwlocks;
 
   /**
+   * Maximum configured number of POSIX Shared memory objects.
+   */
+  uint32_t                            maximum_shms;
+
+  /**
    * This field contains the number of POSIX API Initialization
    * threads listed in @a User_initialization_thread_table.
    */
diff --git a/cpukit/posix/include/rtems/posix/shm.h b/cpukit/posix/include/rtems/posix/shm.h
new file mode 100644
index 0000000000..dfdd58ed2a
--- /dev/null
+++ b/cpukit/posix/include/rtems/posix/shm.h
@@ -0,0 +1,182 @@
+/**
+ * @file
+ *
+ * @brief Internal Support for POSIX Shared Memory
+ */
+
+/*
+ * Copyright (c) 2016 Gedare Bloom.
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifndef _RTEMS_POSIX_SHM_H
+#define _RTEMS_POSIX_SHM_H
+
+#include <rtems/score/object.h>
+#include <rtems/score/threadq.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @defgroup POSIXShmPrivate POSIX Shared Memory Private Support
+ *
+ * @ingroup POSIXAPI
+ *
+ * Internal implementation support for POSIX shared memory.
+ * @{
+ */
+typedef struct POSIX_Shm_Object_operations POSIX_Shm_Object_operations;
+extern const POSIX_Shm_Object_operations _POSIX_Shm_Object_operations;
+
+/**
+ * @brief Encapsulation for the storage and manipulation of shm objects.
+ */
+typedef struct {
+  /**
+   * @brief The handle is private for finding object storage.
+   */
+  void                               *handle;
+
+  /**
+   * @brief The number of bytes allocated to the object. A size of 0 with
+   * a handle of NULL means no object is allocated.
+   */
+  size_t                              size;
+
+  /**
+   * @brief Implementation-specific operations on shm objects.
+   */
+  const POSIX_Shm_Object_operations  *ops;
+} POSIX_Shm_Object;
+
+/**
+ * @brief Operations on POSIX Shared Memory Objects.
+ */
+struct POSIX_Shm_Object_operations {
+  /**
+   * @brief Allocates a new @a shm_obj with initial @a size.
+   *
+   * New shared memory is initialized to zeroes.
+   *
+   * Returns 0 for success.
+   */
+  int ( *object_create ) ( POSIX_Shm_Object *shm_obj, size_t size );
+
+  /**
+   * @brief Changes the @a shm_obj size to @a size.
+   *
+   * Zeroes out the portion of the shared memory object that shrinks or grows.
+   *
+   * Returns 0 for success.
+   */
+  int ( *object_resize ) ( POSIX_Shm_Object *shm_obj, size_t size );
+
+  /**
+   * @brief Deletes the @a shm_obj.
+   *
+   * Zeroes out the memory.
+   *
+   * Returns 0 for success.
+   */
+  int ( *object_delete ) ( POSIX_Shm_Object *shm_obj );
+
+  /**
+   * @brief Copies up to @count bytes of the @a shm_obj data into @a buf.
+   *
+   * Returns the number of bytes read (copied) into @a buf.
+   */
+  int ( *object_read ) ( POSIX_Shm_Object *shm_obj, void *buf, size_t count );
+};
+
+/**
+ * @brief Control for a POSIX Shared Memory Object
+ */
+typedef struct {
+   Objects_Control      Object;
+   Thread_queue_Control Wait_queue;
+
+   int                  reference_count;
+
+   POSIX_Shm_Object     shm_object;
+
+   uid_t                uid;
+   gid_t                gid;
+   mode_t               mode;
+
+   time_t               atime;
+   time_t               mtime;
+   time_t               ctime;
+} POSIX_Shm_Control;
+
+/**
+ * @brief object_create operation for shm objects stored in RTEMS Workspace.
+ */
+extern int _POSIX_Shm_Object_create_from_workspace(
+  POSIX_Shm_Object *shm_obj,
+  size_t size
+);
+
+/**
+ * @brief object_delete operation for shm objects stored in RTEMS Workspace.
+ */
+extern int _POSIX_Shm_Object_delete_from_workspace( POSIX_Shm_Object *shm_obj );
+
+/**
+ * @brief object_resize operation for shm objects stored in RTEMS Workspace.
+ */
+extern int _POSIX_Shm_Object_resize_from_workspace(
+  POSIX_Shm_Object *shm_obj,
+  size_t size
+);
+
+/**
+ * @brief object_read operation for shm objects stored in RTEMS Workspace.
+ */
+extern int _POSIX_Shm_Object_read_from_workspace(
+  POSIX_Shm_Object *shm_obj,
+  void *buf,
+  size_t count
+);
+
+/**
+ * @brief object_create operation for shm objects stored in C program heap.
+ */
+extern int _POSIX_Shm_Object_create_from_heap(
+  POSIX_Shm_Object *shm_obj,
+  size_t size
+);
+
+/**
+ * @brief object_delete operation for shm objects stored in C program heap.
+ */
+extern int _POSIX_Shm_Object_delete_from_heap( POSIX_Shm_Object *shm_obj );
+
+/**
+ * @brief object_resize operation for shm objects stored in C program heap.
+ */
+extern int _POSIX_Shm_Object_resize_from_heap(
+  POSIX_Shm_Object *shm_obj,
+  size_t size
+);
+
+/**
+ * @brief object_read operation for shm objects stored in C program heap.
+ */
+extern int _POSIX_Shm_Object_read_from_heap(
+  POSIX_Shm_Object *shm_obj,
+  void *buf,
+  size_t count
+);
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/cpukit/posix/include/rtems/posix/shmimpl.h b/cpukit/posix/include/rtems/posix/shmimpl.h
new file mode 100644
index 0000000000..207f50fc95
--- /dev/null
+++ b/cpukit/posix/include/rtems/posix/shmimpl.h
@@ -0,0 +1,115 @@
+/**
+ * @file
+ *
+ * @brief Private Support Information for POSIX Shared Memory
+ *
+ */
+
+/*
+ * Copyright (c) 2016 Gedare Bloom.
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.org/license/LICENSE.
+ */
+
+#ifndef _RTEMS_POSIX_SHMIMPL_H
+#define _RTEMS_POSIX_SHMIMPL_H
+
+#include <rtems/fs.h>
+#include <rtems/libio.h>
+#include <rtems/posix/posixapi.h>
+#include <rtems/posix/shm.h>
+#include <rtems/score/objectimpl.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @ingroup POSIXShmPrivate
+ * @{
+ */
+
+extern Objects_Information _POSIX_Shm_Information;
+
+RTEMS_INLINE_ROUTINE void _POSIX_Shm_Acquire(
+  POSIX_Shm_Control                 *the_shm,
+  Thread_queue_Context              *queue_context
+)
+{
+  _Thread_queue_Acquire(
+    &the_shm->Wait_queue,
+    queue_context
+  );
+}
+
+RTEMS_INLINE_ROUTINE void _POSIX_Shm_Release(
+  POSIX_Shm_Control                 *the_shm,
+  Thread_queue_Context              *queue_context
+)
+{
+  _Thread_queue_Release( &the_shm->Wait_queue, queue_context );
+}
+
+RTEMS_INLINE_ROUTINE POSIX_Shm_Control *_POSIX_Shm_Allocate_unprotected( void )
+{
+  return (POSIX_Shm_Control *)
+    _Objects_Allocate_unprotected( &_POSIX_Shm_Information );
+}
+
+/**
+ * @brief POSIX Shared Memory Free
+ *
+ * This routine frees a shm control block.
+ */
+RTEMS_INLINE_ROUTINE void _POSIX_Shm_Free (
+  POSIX_Shm_Control *the_shm
+)
+{
+  _Objects_Free( &_POSIX_Shm_Information, &the_shm->Object );
+}
+
+RTEMS_INLINE_ROUTINE POSIX_Shm_Control *_POSIX_Shm_Get_by_name(
+  const char                *name,
+  size_t                    *name_length_p,
+  Objects_Get_by_name_error *error
+)
+{
+  return (POSIX_Shm_Control *) _Objects_Get_by_name(
+    &_POSIX_Shm_Information,
+    name,
+    name_length_p,
+    error
+  );
+}
+
+RTEMS_INLINE_ROUTINE void _POSIX_Shm_Update_mtime_ctime(
+  POSIX_Shm_Control *shm
+)
+{
+  struct timeval now;
+  gettimeofday( &now, 0 );
+  shm->mtime = now.tv_sec;
+  shm->ctime = now.tv_sec;
+}
+
+static inline POSIX_Shm_Control* iop_to_shm( rtems_libio_t *iop )
+{
+  return (POSIX_Shm_Control*) iop->data1;
+}
+
+static inline POSIX_Shm_Control* loc_to_shm(
+    const rtems_filesystem_location_info_t *loc
+)
+{
+  return (POSIX_Shm_Control*) loc->node_access;
+}
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif