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.
16 #include <svm/svm_common.h>
18 typedef int (*init_fn) (ssvm_private_t *);
19 typedef void (*delete_fn) (ssvm_private_t *);
21 static init_fn master_init_fns[SSVM_N_SEGMENT_TYPES] =
22 { ssvm_master_init_shm, ssvm_master_init_memfd, ssvm_master_init_private };
23 static init_fn slave_init_fns[SSVM_N_SEGMENT_TYPES] =
24 { ssvm_slave_init_shm, ssvm_slave_init_memfd, ssvm_slave_init_private };
25 static delete_fn delete_fns[SSVM_N_SEGMENT_TYPES] =
26 { ssvm_delete_shm, ssvm_delete_memfd, ssvm_delete_private };
29 ssvm_master_init_shm (ssvm_private_t * ssvm)
31 int ssvm_fd, mh_flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
32 svm_main_region_t *smr = svm_get_root_rp ()->data_base;
33 clib_mem_vm_map_t mapa = { 0 };
34 u8 junk = 0, *ssvm_filename;
35 ssvm_shared_header_t *sh;
39 if (ssvm->ssvm_size == 0)
40 return SSVM_API_ERROR_NO_SIZE;
43 clib_warning ("[%d] creating segment '%s'", getpid (), ssvm->name);
45 ASSERT (vec_c_string_is_terminated (ssvm->name));
46 ssvm_filename = format (0, "/dev/shm/%s%c", ssvm->name, 0);
47 unlink ((char *) ssvm_filename);
48 vec_free (ssvm_filename);
50 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR | O_CREAT | O_EXCL, 0777);
53 clib_unix_warning ("create segment '%s'", ssvm->name);
54 return SSVM_API_ERROR_CREATE_FAILURE;
57 if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
58 clib_unix_warning ("ssvm segment chmod");
59 if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
60 clib_unix_warning ("ssvm segment chown");
62 if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
64 clib_unix_warning ("lseek");
66 return SSVM_API_ERROR_SET_SIZE;
69 if (write (ssvm_fd, &junk, 1) != 1)
71 clib_unix_warning ("set ssvm size");
73 return SSVM_API_ERROR_SET_SIZE;
76 page_size = clib_mem_vm_get_page_size (ssvm_fd);
77 if (ssvm->requested_va)
78 clib_mem_vm_randomize_va (&ssvm->requested_va, min_log2 (page_size));
80 mapa.requested_va = ssvm->requested_va;
81 mapa.size = ssvm->ssvm_size;
83 if (clib_mem_vm_ext_map (&mapa))
85 clib_unix_warning ("mmap");
87 return SSVM_API_ERROR_MMAP;
92 sh->master_pid = ssvm->my_pid;
93 sh->ssvm_size = ssvm->ssvm_size;
94 sh->ssvm_va = pointer_to_uword (sh);
95 sh->type = SSVM_SEGMENT_SHM;
96 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
97 ssvm->ssvm_size - page_size, mh_flags);
99 oldheap = ssvm_push_heap (sh);
100 sh->name = format (0, "%s", ssvm->name, 0);
101 ssvm_pop_heap (oldheap);
104 ssvm->my_pid = getpid ();
105 ssvm->i_am_master = 1;
107 /* The application has to set set sh->ready... */
112 ssvm_slave_init_shm (ssvm_private_t * ssvm)
116 ssvm_shared_header_t *sh;
118 ASSERT (vec_c_string_is_terminated (ssvm->name));
119 ssvm->i_am_master = 0;
121 while (ssvm->attach_timeout-- > 0)
124 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
130 if (fstat (ssvm_fd, &stat) < 0)
136 if (stat.st_size > 0)
139 clib_warning ("slave timeout");
140 return SSVM_API_ERROR_SLAVE_TIMEOUT;
143 sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
145 if (sh == MAP_FAILED)
147 clib_unix_warning ("slave research mmap");
149 return SSVM_API_ERROR_MMAP;
152 while (ssvm->attach_timeout-- > 0)
158 munmap (sh, MMAP_PAGESIZE);
159 clib_warning ("slave timeout 2");
160 return SSVM_API_ERROR_SLAVE_TIMEOUT;
163 ssvm->requested_va = (u64) sh->ssvm_va;
164 ssvm->ssvm_size = sh->ssvm_size;
165 munmap (sh, MMAP_PAGESIZE);
167 sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
168 PROT_READ | PROT_WRITE,
169 MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
171 if (sh == MAP_FAILED)
173 clib_unix_warning ("slave final mmap");
175 return SSVM_API_ERROR_MMAP;
177 sh->slave_pid = getpid ();
182 ssvm_delete_shm (ssvm_private_t * ssvm)
186 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
189 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
192 /* Throw away the backing file */
193 if (unlink ((char *) fn) < 0)
194 clib_unix_warning ("unlink segment '%s'", ssvm->name);
197 vec_free (ssvm->name);
199 munmap ((void *) ssvm->requested_va, ssvm->ssvm_size);
203 * Initialize memfd segment master
206 ssvm_master_init_memfd (ssvm_private_t * memfd)
208 uword page_size, flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
209 ssvm_shared_header_t *sh;
211 clib_mem_vm_alloc_t alloc = { 0 };
214 if (memfd->ssvm_size == 0)
215 return SSVM_API_ERROR_NO_SIZE;
217 ASSERT (vec_c_string_is_terminated (memfd->name));
219 alloc.name = (char *) memfd->name;
220 alloc.size = memfd->ssvm_size;
221 alloc.flags = CLIB_MEM_VM_F_SHARED;
222 alloc.requested_va = memfd->requested_va;
223 if ((err = clib_mem_vm_ext_alloc (&alloc)))
225 clib_error_report (err);
226 return SSVM_API_ERROR_CREATE_FAILURE;
229 memfd->fd = alloc.fd;
230 memfd->sh = (ssvm_shared_header_t *) alloc.addr;
231 memfd->my_pid = getpid ();
232 memfd->i_am_master = 1;
234 page_size = 1 << alloc.log2_page_size;
236 sh->master_pid = memfd->my_pid;
237 sh->ssvm_size = memfd->ssvm_size;
238 sh->ssvm_va = pointer_to_uword (sh);
239 sh->type = SSVM_SEGMENT_MEMFD;
240 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
241 memfd->ssvm_size - page_size, flags);
243 oldheap = ssvm_push_heap (sh);
244 sh->name = format (0, "%s", memfd->name, 0);
245 ssvm_pop_heap (oldheap);
247 /* The application has to set set sh->ready... */
252 * Initialize memfd segment slave
254 * Subtly different than svm_slave_init. The caller needs to acquire
255 * a usable file descriptor for the memfd segment e.g. via
256 * vppinfra/socket.c:default_socket_recvmsg
259 ssvm_slave_init_memfd (ssvm_private_t * memfd)
261 clib_mem_vm_map_t mapa = { 0 };
262 ssvm_shared_header_t *sh;
265 memfd->i_am_master = 0;
267 page_size = clib_mem_vm_get_page_size (memfd->fd);
270 clib_unix_warning ("page size unknown");
271 return SSVM_API_ERROR_MMAP;
275 * Map the segment once, to look at the shared header
278 mapa.size = page_size;
280 if (clib_mem_vm_ext_map (&mapa))
282 clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
284 return SSVM_API_ERROR_MMAP;
288 memfd->requested_va = sh->ssvm_va;
289 memfd->ssvm_size = sh->ssvm_size;
290 clib_mem_vm_free (sh, page_size);
293 * Remap the segment at the 'right' address
295 mapa.requested_va = memfd->requested_va;
296 mapa.size = memfd->ssvm_size;
297 if (clib_mem_vm_ext_map (&mapa))
299 clib_unix_warning ("slave final mmap");
301 return SSVM_API_ERROR_MMAP;
305 sh->slave_pid = getpid ();
311 ssvm_delete_memfd (ssvm_private_t * memfd)
313 vec_free (memfd->name);
314 clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
319 * Initialize segment in a private heap
322 ssvm_master_init_private (ssvm_private_t * ssvm)
324 u32 pagesize = clib_mem_get_page_size ();
325 ssvm_shared_header_t *sh;
326 mheap_t *heap_header;
330 rnd_size = (ssvm->ssvm_size + (pagesize - 1)) & ~pagesize;
331 heap = mheap_alloc (0, rnd_size);
334 clib_unix_warning ("mheap alloc");
337 heap_header = mheap_header (heap);
338 heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
340 ssvm->ssvm_size = rnd_size;
341 ssvm->i_am_master = 1;
342 ssvm->my_pid = getpid ();
343 ssvm->requested_va = ~0;
345 /* Allocate a [sic] shared memory header, in process memory... */
346 sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
349 memset (sh, 0, sizeof (*sh));
351 sh->type = SSVM_SEGMENT_PRIVATE;
357 ssvm_slave_init_private (ssvm_private_t * ssvm)
359 clib_warning ("BUG: this should not be called!");
364 ssvm_delete_private (ssvm_private_t * ssvm)
366 vec_free (ssvm->name);
367 mheap_free (ssvm->sh->heap);
368 clib_mem_free (ssvm->sh);
372 ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
374 return (master_init_fns[type]) (ssvm);
378 ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
380 return (slave_init_fns[type]) (ssvm);
384 ssvm_delete (ssvm_private_t * ssvm)
386 delete_fns[ssvm->sh->type] (ssvm);
390 ssvm_type (const ssvm_private_t * ssvm)
392 return ssvm->sh->type;
396 ssvm_name (const ssvm_private_t * ssvm)
398 return ssvm->sh->name;
402 * fd.io coding-style-patch-verification: ON
405 * eval: (c-set-style "gnu")