2 * Copyright (c) 2015-2019 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>
42 #define MMAP_PAGESIZE (clib_mem_get_page_size())
45 #define SSVM_N_OPAQUE 7
47 typedef enum ssvm_segment_type_
52 SSVM_N_SEGMENT_TYPES /**< Private segments */
53 } ssvm_segment_type_t;
59 volatile u32 owner_pid;
61 u32 tag; /* for debugging */
63 /* The allocation arena */
66 /* Segment must be mapped at this address, or no supper */
68 /* The actual mmap size */
73 void *opaque[SSVM_N_OPAQUE];
75 /* Set when the master application thinks it's time to make the donuts */
78 ssvm_segment_type_t type;
79 } ssvm_shared_header_t;
83 ssvm_shared_header_t *sh;
92 int fd; /**< memfd segments */
93 int attach_timeout; /**< shm segments attach timeout (sec) */
98 ssvm_lock (ssvm_shared_header_t * h, u32 my_pid, u32 tag)
100 if (h->owner_pid == my_pid)
102 h->recursion_count++;
106 while (clib_atomic_test_and_set (&h->lock))
109 h->owner_pid = my_pid;
110 h->recursion_count = 1;
115 ssvm_lock_non_recursive (ssvm_shared_header_t * h, u32 tag)
117 while (clib_atomic_test_and_set (&h->lock))
124 ssvm_unlock (ssvm_shared_header_t * h)
126 if (--h->recursion_count == 0)
130 CLIB_MEMORY_BARRIER ();
136 ssvm_unlock_non_recursive (ssvm_shared_header_t * h)
139 CLIB_MEMORY_BARRIER ();
144 ssvm_push_heap (ssvm_shared_header_t * sh)
147 oldheap = clib_mem_set_heap (sh->heap);
148 return ((void *) oldheap);
152 ssvm_pop_heap (void *oldheap)
154 clib_mem_set_heap (oldheap);
158 ssvm_mem_alloc (ssvm_private_t * ssvm, uword size)
163 oldheap = clib_mem_set_heap (ssvm->sh->heap);
164 rv = clib_mem_alloc (size);
165 clib_mem_set_heap (oldheap);
169 #define foreach_ssvm_api_error \
170 _(NO_NAME, "No shared segment name", -100) \
171 _(NO_SIZE, "Size not set (master)", -101) \
172 _(CREATE_FAILURE, "Create failed", -102) \
173 _(SET_SIZE, "Set size failed", -103) \
174 _(MMAP, "mmap failed", -104) \
175 _(SLAVE_TIMEOUT, "Slave map timeout", -105)
179 #define _(n,s,c) SSVM_API_ERROR_##n = c,
180 foreach_ssvm_api_error
182 } ssvm_api_error_enum_t;
184 #define SSVM_API_ERROR_NO_NAME (-10)
186 int ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type);
187 int ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type);
188 void ssvm_delete (ssvm_private_t * ssvm);
190 int ssvm_master_init_shm (ssvm_private_t * ssvm);
191 int ssvm_slave_init_shm (ssvm_private_t * ssvm);
192 void ssvm_delete_shm (ssvm_private_t * ssvm);
194 int ssvm_master_init_memfd (ssvm_private_t * memfd);
195 int ssvm_slave_init_memfd (ssvm_private_t * memfd);
196 void ssvm_delete_memfd (ssvm_private_t * memfd);
198 int ssvm_master_init_private (ssvm_private_t * ssvm);
199 int ssvm_slave_init_private (ssvm_private_t * ssvm);
200 void ssvm_delete_private (ssvm_private_t * ssvm);
202 ssvm_segment_type_t ssvm_type (const ssvm_private_t * ssvm);
203 u8 *ssvm_name (const ssvm_private_t * ssvm);
205 #endif /* __included_ssvm_h__ */
208 * fd.io coding-style-patch-verification: ON
211 * eval: (c-set-style "gnu")