2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __included_ssvm_h__
16 #define __included_ssvm_h__
20 #include <sys/types.h>
23 #include <netinet/in.h>
30 #include <vppinfra/clib.h>
31 #include <vppinfra/vec.h>
32 #include <vppinfra/hash.h>
33 #include <vppinfra/bitmap.h>
34 #include <vppinfra/fifo.h>
35 #include <vppinfra/time.h>
36 #include <vppinfra/mheap.h>
37 #include <vppinfra/heap.h>
38 #include <vppinfra/pool.h>
39 #include <vppinfra/format.h>
40 #include <vppinfra/linux/syscall.h>
43 #define MMAP_PAGESIZE (clib_mem_get_page_size())
46 #define SSVM_N_OPAQUE 7
52 volatile u32 owner_pid;
54 u32 tag; /* for debugging */
56 /* The allocation arena */
59 /* Segment must be mapped at this address, or no supper */
61 /* The actual mmap size */
66 void *opaque[SSVM_N_OPAQUE];
68 /* Set when the master application thinks it's time to make the donuts */
71 /* Needed to make unique MAC addresses, etc. */
73 } ssvm_shared_header_t;
77 ssvm_shared_header_t *sh;
84 /* Needed by memfd segments */
89 ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag)
91 if (h->owner_pid == my_pid)
97 while (__sync_lock_test_and_set (&h->lock, 1))
100 h->owner_pid = my_pid;
101 h->recursion_count = 1;
106 ssvm_lock_non_recursive (ssvm_shared_header_t * h, u32 tag)
108 while (__sync_lock_test_and_set (&h->lock, 1))
115 ssvm_unlock (ssvm_shared_header_t * h)
117 if (--h->recursion_count == 0)
121 CLIB_MEMORY_BARRIER ();
127 ssvm_unlock_non_recursive (ssvm_shared_header_t * h)
130 CLIB_MEMORY_BARRIER ();
135 ssvm_push_heap (ssvm_shared_header_t * sh)
138 oldheap = clib_mem_set_heap (sh->heap);
139 return ((void *) oldheap);
143 ssvm_pop_heap (void *oldheap)
145 clib_mem_set_heap (oldheap);
148 #define foreach_ssvm_api_error \
149 _(NO_NAME, "No shared segment name", -100) \
150 _(NO_SIZE, "Size not set (master)", -101) \
151 _(CREATE_FAILURE, "Create failed", -102) \
152 _(SET_SIZE, "Set size failed", -103) \
153 _(MMAP, "mmap failed", -104) \
154 _(SLAVE_TIMEOUT, "Slave map timeout", -105)
158 #define _(n,s,c) SSVM_API_ERROR_##n = c,
159 foreach_ssvm_api_error
161 } ssvm_api_error_enum_t;
163 #define SSVM_API_ERROR_NO_NAME (-10)
165 int ssvm_master_init (ssvm_private_t * ssvm, u32 master_index);
166 int ssvm_slave_init (ssvm_private_t * ssvm, int timeout_in_seconds);
167 void ssvm_delete (ssvm_private_t * ssvm);
169 int ssvm_master_init_memfd (ssvm_private_t * memfd, u32 master_index);
170 int ssvm_slave_init_memfd (ssvm_private_t * memfd);
171 void ssvm_delete_memfd (ssvm_private_t * memfd);
173 #endif /* __included_ssvm_h__ */
176 * fd.io coding-style-patch-verification: ON
179 * eval: (c-set-style "gnu")