host stack: update stale copyright
[vpp.git] / src / svm / ssvm.h
index 0295e30..1c0373f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Cisco and/or its affiliates.
+ * Copyright (c) 2015-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
@@ -37,7 +37,6 @@
 #include <vppinfra/heap.h>
 #include <vppinfra/pool.h>
 #include <vppinfra/format.h>
-#include <vppinfra/linux/syscall.h>
 
 #ifndef MMAP_PAGESIZE
 #define MMAP_PAGESIZE (clib_mem_get_page_size())
 
 #define SSVM_N_OPAQUE 7
 
+typedef enum ssvm_segment_type_
+{
+  SSVM_SEGMENT_SHM = 0,
+  SSVM_SEGMENT_MEMFD,
+  SSVM_SEGMENT_PRIVATE,
+  SSVM_N_SEGMENT_TYPES         /**< Private segments */
+} ssvm_segment_type_t;
+
 typedef struct
 {
   /* Spin-lock */
@@ -57,9 +64,9 @@ typedef struct
   void *heap;
 
   /* Segment must be mapped at this address, or no supper */
-  u64 ssvm_va;
+  uword ssvm_va;
   /* The actual mmap size */
-  u64 ssvm_size;
+  uword ssvm_size;
   u32 master_pid;
   u32 slave_pid;
   u8 *name;
@@ -68,8 +75,7 @@ typedef struct
   /* Set when the master application thinks it's time to make the donuts */
   volatile u32 ready;
 
-  /* Needed to make unique MAC addresses, etc. */
-  u32 master_index;
+  ssvm_segment_type_t type;
 } ssvm_shared_header_t;
 
 typedef struct
@@ -81,8 +87,11 @@ typedef struct
   uword requested_va;
   int i_am_master;
 
-  /* Needed by memfd segments */
-  int fd;
+  union
+  {
+    int fd;                    /**< memfd segments */
+    int attach_timeout;                /**< shm segments attach timeout (sec) */
+  };
 } ssvm_private_t;
 
 always_inline void
@@ -94,7 +103,7 @@ ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag)
       return;
     }
 
-  while (__sync_lock_test_and_set (&h->lock, 1))
+  while (clib_atomic_test_and_set (&h->lock))
     ;
 
   h->owner_pid = my_pid;
@@ -105,7 +114,7 @@ ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag)
 always_inline void
 ssvm_lock_non_recursive (ssvm_shared_header_t * h, u32 tag)
 {
-  while (__sync_lock_test_and_set (&h->lock, 1))
+  while (clib_atomic_test_and_set (&h->lock))
     ;
 
   h->tag = tag;
@@ -145,6 +154,18 @@ ssvm_pop_heap (void *oldheap)
   clib_mem_set_heap (oldheap);
 }
 
+static inline void *
+ssvm_mem_alloc (ssvm_private_t * ssvm, uword size)
+{
+  u8 *oldheap;
+  void *rv;
+
+  oldheap = clib_mem_set_heap (ssvm->sh->heap);
+  rv = clib_mem_alloc (size);
+  clib_mem_set_heap (oldheap);
+  return (rv);
+}
+
 #define foreach_ssvm_api_error                  \
 _(NO_NAME, "No shared segment name", -100)      \
 _(NO_SIZE, "Size not set (master)", -101)       \
@@ -162,27 +183,24 @@ typedef enum
 
 #define SSVM_API_ERROR_NO_NAME (-10)
 
-int ssvm_master_init (ssvm_private_t * ssvm, u32 master_index);
-int ssvm_slave_init (ssvm_private_t * ssvm, int timeout_in_seconds);
+int ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type);
+int ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type);
 void ssvm_delete (ssvm_private_t * ssvm);
 
-int ssvm_master_init_memfd (ssvm_private_t * memfd, u32 master_index);
+int ssvm_master_init_shm (ssvm_private_t * ssvm);
+int ssvm_slave_init_shm (ssvm_private_t * ssvm);
+void ssvm_delete_shm (ssvm_private_t * ssvm);
+
+int ssvm_master_init_memfd (ssvm_private_t * memfd);
 int ssvm_slave_init_memfd (ssvm_private_t * memfd);
-void memfd_delete (ssvm_private_t * memfd);
+void ssvm_delete_memfd (ssvm_private_t * memfd);
 
-/* These do not belong here, but the original keeps running around... */
-/* $$$$ work w/ Damjan to fix properly */
-#ifndef F_LINUX_SPECIFIC_BASE
-#define F_LINUX_SPECIFIC_BASE 1024
-#endif
-#define MFD_ALLOW_SEALING       0x0002U
-#define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
-#define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
-
-#define F_SEAL_SEAL     0x0001 /* prevent further seals from being set */
-#define F_SEAL_SHRINK   0x0002 /* prevent file from shrinking */
-#define F_SEAL_GROW     0x0004 /* prevent file from growing */
-#define F_SEAL_WRITE    0x0008 /* prevent writes */
+int ssvm_master_init_private (ssvm_private_t * ssvm);
+int ssvm_slave_init_private (ssvm_private_t * ssvm);
+void ssvm_delete_private (ssvm_private_t * ssvm);
+
+ssvm_segment_type_t ssvm_type (const ssvm_private_t * ssvm);
+u8 *ssvm_name (const ssvm_private_t * ssvm);
 
 #endif /* __included_ssvm_h__ */