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)
33 int mh_flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
35 clib_mem_vm_map_t mapa = { 0 };
36 u8 junk = 0, *ssvm_filename;
37 ssvm_shared_header_t *sh;
38 uword page_size, requested_va = 0;
41 if (ssvm->ssvm_size == 0)
42 return SSVM_API_ERROR_NO_SIZE;
45 clib_warning ("[%d] creating segment '%s'", getpid (), ssvm->name);
47 ASSERT (vec_c_string_is_terminated (ssvm->name));
48 ssvm_filename = format (0, "/dev/shm/%s%c", ssvm->name, 0);
49 unlink ((char *) ssvm_filename);
50 vec_free (ssvm_filename);
52 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR | O_CREAT | O_EXCL, 0777);
55 clib_unix_warning ("create segment '%s'", ssvm->name);
56 return SSVM_API_ERROR_CREATE_FAILURE;
59 if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
60 clib_unix_warning ("ssvm segment chmod");
61 if (svm_get_root_rp ())
63 /* TODO: is this really needed? */
64 svm_main_region_t *smr = svm_get_root_rp ()->data_base;
65 if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
66 clib_unix_warning ("ssvm segment chown");
69 if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
71 clib_unix_warning ("lseek");
73 return SSVM_API_ERROR_SET_SIZE;
76 if (write (ssvm_fd, &junk, 1) != 1)
78 clib_unix_warning ("set ssvm size");
80 return SSVM_API_ERROR_SET_SIZE;
83 page_size = clib_mem_get_fd_page_size (ssvm_fd);
84 if (ssvm->requested_va)
86 requested_va = ssvm->requested_va;
87 clib_mem_vm_randomize_va (&requested_va, min_log2 (page_size));
90 mapa.requested_va = requested_va;
91 mapa.size = ssvm->ssvm_size;
93 if (clib_mem_vm_ext_map (&mapa))
95 clib_unix_warning ("mmap");
97 return SSVM_API_ERROR_MMAP;
102 sh->master_pid = ssvm->my_pid;
103 sh->ssvm_size = ssvm->ssvm_size;
104 sh->ssvm_va = pointer_to_uword (sh);
105 sh->type = SSVM_SEGMENT_SHM;
106 #if USE_DLMALLOC == 0
107 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
108 ssvm->ssvm_size - page_size, mh_flags);
110 sh->heap = create_mspace_with_base (((u8 *) sh) + page_size,
111 ssvm->ssvm_size - page_size,
113 mspace_disable_expand (sh->heap);
116 oldheap = ssvm_push_heap (sh);
117 sh->name = format (0, "%s", ssvm->name, 0);
118 ssvm_pop_heap (oldheap);
121 ssvm->my_pid = getpid ();
122 ssvm->i_am_master = 1;
124 /* The application has to set set sh->ready... */
129 ssvm_slave_init_shm (ssvm_private_t * ssvm)
133 ssvm_shared_header_t *sh;
135 ASSERT (vec_c_string_is_terminated (ssvm->name));
136 ssvm->i_am_master = 0;
138 while (ssvm->attach_timeout-- > 0)
141 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
147 if (fstat (ssvm_fd, &stat) < 0)
153 if (stat.st_size > 0)
156 clib_warning ("slave timeout");
157 return SSVM_API_ERROR_SLAVE_TIMEOUT;
160 sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
162 if (sh == MAP_FAILED)
164 clib_unix_warning ("slave research mmap");
166 return SSVM_API_ERROR_MMAP;
169 while (ssvm->attach_timeout-- > 0)
175 munmap (sh, MMAP_PAGESIZE);
176 clib_warning ("slave timeout 2");
177 return SSVM_API_ERROR_SLAVE_TIMEOUT;
180 ssvm->requested_va = (u64) sh->ssvm_va;
181 ssvm->ssvm_size = sh->ssvm_size;
182 munmap (sh, MMAP_PAGESIZE);
184 sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
185 PROT_READ | PROT_WRITE,
186 MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
188 if (sh == MAP_FAILED)
190 clib_unix_warning ("slave final mmap");
192 return SSVM_API_ERROR_MMAP;
194 sh->slave_pid = getpid ();
199 ssvm_delete_shm (ssvm_private_t * ssvm)
203 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
206 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
209 /* Throw away the backing file */
210 if (unlink ((char *) fn) < 0)
211 clib_unix_warning ("unlink segment '%s'", ssvm->name);
214 vec_free (ssvm->name);
216 munmap ((void *) ssvm->requested_va, ssvm->ssvm_size);
220 * Initialize memfd segment master
223 ssvm_master_init_memfd (ssvm_private_t * memfd)
226 ssvm_shared_header_t *sh;
228 clib_mem_vm_alloc_t alloc = { 0 };
231 if (memfd->ssvm_size == 0)
232 return SSVM_API_ERROR_NO_SIZE;
234 ASSERT (vec_c_string_is_terminated (memfd->name));
236 alloc.name = (char *) memfd->name;
237 alloc.size = memfd->ssvm_size;
238 alloc.flags = CLIB_MEM_VM_F_SHARED;
239 alloc.requested_va = memfd->requested_va;
240 if ((err = clib_mem_vm_ext_alloc (&alloc)))
242 clib_error_report (err);
243 return SSVM_API_ERROR_CREATE_FAILURE;
246 memfd->fd = alloc.fd;
247 memfd->sh = (ssvm_shared_header_t *) alloc.addr;
248 memfd->my_pid = getpid ();
249 memfd->i_am_master = 1;
251 page_size = 1ull << alloc.log2_page_size;
253 sh->master_pid = memfd->my_pid;
254 sh->ssvm_size = memfd->ssvm_size;
255 sh->ssvm_va = pointer_to_uword (sh);
256 sh->type = SSVM_SEGMENT_MEMFD;
258 #if USE_DLMALLOC == 0
259 uword flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
261 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
262 memfd->ssvm_size - page_size, flags);
264 sh->heap = create_mspace_with_base (((u8 *) sh) + page_size,
265 memfd->ssvm_size - page_size,
267 mspace_disable_expand (sh->heap);
269 oldheap = ssvm_push_heap (sh);
270 sh->name = format (0, "%s", memfd->name, 0);
271 ssvm_pop_heap (oldheap);
273 /* The application has to set set sh->ready... */
278 * Initialize memfd segment slave
280 * Subtly different than svm_slave_init. The caller needs to acquire
281 * a usable file descriptor for the memfd segment e.g. via
282 * vppinfra/socket.c:default_socket_recvmsg
285 ssvm_slave_init_memfd (ssvm_private_t * memfd)
287 clib_mem_vm_map_t mapa = { 0 };
288 ssvm_shared_header_t *sh;
291 memfd->i_am_master = 0;
293 page_size = clib_mem_get_fd_page_size (memfd->fd);
296 clib_unix_warning ("page size unknown");
297 return SSVM_API_ERROR_MMAP;
301 * Map the segment once, to look at the shared header
304 mapa.size = page_size;
306 if (clib_mem_vm_ext_map (&mapa))
308 clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
310 return SSVM_API_ERROR_MMAP;
314 memfd->requested_va = sh->ssvm_va;
315 memfd->ssvm_size = sh->ssvm_size;
316 clib_mem_vm_free (sh, page_size);
319 * Remap the segment at the 'right' address
321 mapa.requested_va = memfd->requested_va;
322 mapa.size = memfd->ssvm_size;
323 if (clib_mem_vm_ext_map (&mapa))
325 clib_unix_warning ("slave final mmap");
327 return SSVM_API_ERROR_MMAP;
331 sh->slave_pid = getpid ();
337 ssvm_delete_memfd (ssvm_private_t * memfd)
339 vec_free (memfd->name);
340 clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
345 * Initialize segment in a private heap
348 ssvm_master_init_private (ssvm_private_t * ssvm)
350 ssvm_shared_header_t *sh;
351 u32 pagesize = clib_mem_get_page_size ();
355 rnd_size = (ssvm->ssvm_size + (pagesize - 1)) & ~(pagesize - 1);
356 rnd_size = clib_min (rnd_size, ((u64) 1 << 32) - pagesize);
358 #if USE_DLMALLOC == 0
360 mheap_t *heap_header;
362 heap = mheap_alloc (0, rnd_size);
365 clib_unix_warning ("mheap alloc");
368 heap_header = mheap_header (heap);
369 heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
372 heap = create_mspace (rnd_size, 1 /* locked */ );
375 ssvm->ssvm_size = rnd_size;
376 ssvm->i_am_master = 1;
377 ssvm->my_pid = getpid ();
378 ssvm->requested_va = ~0;
380 /* Allocate a [sic] shared memory header, in process memory... */
381 sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
384 clib_memset (sh, 0, sizeof (*sh));
386 sh->type = SSVM_SEGMENT_PRIVATE;
392 ssvm_slave_init_private (ssvm_private_t * ssvm)
394 clib_warning ("BUG: this should not be called!");
399 ssvm_delete_private (ssvm_private_t * ssvm)
401 vec_free (ssvm->name);
402 #if USE_DLMALLOC == 0
403 mheap_free (ssvm->sh->heap);
405 destroy_mspace (ssvm->sh->heap);
407 clib_mem_free (ssvm->sh);
411 ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
413 return (master_init_fns[type]) (ssvm);
417 ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
419 return (slave_init_fns[type]) (ssvm);
423 ssvm_delete (ssvm_private_t * ssvm)
425 delete_fns[ssvm->sh->type] (ssvm);
429 ssvm_type (const ssvm_private_t * ssvm)
431 return ssvm->sh->type;
435 ssvm_name (const ssvm_private_t * ssvm)
437 return ssvm->sh->name;
441 * fd.io coding-style-patch-verification: ON
444 * eval: (c-set-style "gnu")