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.
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 mapa.numa_node = ssvm->numa;
94 if (clib_mem_vm_ext_map (&mapa))
96 clib_unix_warning ("mmap");
98 return SSVM_API_ERROR_MMAP;
103 sh->master_pid = ssvm->my_pid;
104 sh->ssvm_size = ssvm->ssvm_size;
105 sh->ssvm_va = pointer_to_uword (sh);
106 sh->type = SSVM_SEGMENT_SHM;
107 #if USE_DLMALLOC == 0
108 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
109 ssvm->ssvm_size - page_size, mh_flags);
111 sh->heap = create_mspace_with_base (((u8 *) sh) + page_size,
112 ssvm->ssvm_size - page_size,
114 mspace_disable_expand (sh->heap);
117 oldheap = ssvm_push_heap (sh);
118 sh->name = format (0, "%s", ssvm->name, 0);
119 ssvm_pop_heap (oldheap);
122 ssvm->my_pid = getpid ();
123 ssvm->i_am_master = 1;
125 /* The application has to set set sh->ready... */
130 ssvm_slave_init_shm (ssvm_private_t * ssvm)
134 ssvm_shared_header_t *sh;
136 ASSERT (vec_c_string_is_terminated (ssvm->name));
137 ssvm->i_am_master = 0;
139 while (ssvm->attach_timeout-- > 0)
142 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
148 if (fstat (ssvm_fd, &stat) < 0)
154 if (stat.st_size > 0)
157 clib_warning ("slave timeout");
158 return SSVM_API_ERROR_SLAVE_TIMEOUT;
161 sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
163 if (sh == MAP_FAILED)
165 clib_unix_warning ("slave research mmap");
167 return SSVM_API_ERROR_MMAP;
170 while (ssvm->attach_timeout-- > 0)
176 munmap (sh, MMAP_PAGESIZE);
177 clib_warning ("slave timeout 2");
178 return SSVM_API_ERROR_SLAVE_TIMEOUT;
181 ssvm->requested_va = sh->ssvm_va;
182 ssvm->ssvm_size = sh->ssvm_size;
183 munmap (sh, MMAP_PAGESIZE);
185 sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
186 PROT_READ | PROT_WRITE,
187 MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
189 if (sh == MAP_FAILED)
191 clib_unix_warning ("slave final mmap");
193 return SSVM_API_ERROR_MMAP;
195 sh->slave_pid = getpid ();
200 ssvm_delete_shm (ssvm_private_t * ssvm)
204 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
207 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
210 /* Throw away the backing file */
211 if (unlink ((char *) fn) < 0)
212 clib_unix_warning ("unlink segment '%s'", ssvm->name);
215 vec_free (ssvm->name);
217 munmap ((void *) ssvm->sh, ssvm->ssvm_size);
221 * Initialize memfd segment master
224 ssvm_master_init_memfd (ssvm_private_t * memfd)
227 ssvm_shared_header_t *sh;
229 clib_mem_vm_alloc_t alloc = { 0 };
232 if (memfd->ssvm_size == 0)
233 return SSVM_API_ERROR_NO_SIZE;
235 ASSERT (vec_c_string_is_terminated (memfd->name));
237 alloc.name = (char *) memfd->name;
238 alloc.size = memfd->ssvm_size;
239 alloc.flags = CLIB_MEM_VM_F_SHARED;
240 alloc.requested_va = memfd->requested_va;
243 alloc.numa_node = memfd->numa;
244 alloc.flags |= CLIB_MEM_VM_F_NUMA_PREFER;
246 if ((err = clib_mem_vm_ext_alloc (&alloc)))
248 clib_error_report (err);
249 return SSVM_API_ERROR_CREATE_FAILURE;
252 memfd->fd = alloc.fd;
253 memfd->sh = (ssvm_shared_header_t *) alloc.addr;
254 memfd->my_pid = getpid ();
255 memfd->i_am_master = 1;
257 page_size = 1ull << alloc.log2_page_size;
259 sh->master_pid = memfd->my_pid;
260 sh->ssvm_size = memfd->ssvm_size;
261 sh->ssvm_va = pointer_to_uword (sh);
262 sh->type = SSVM_SEGMENT_MEMFD;
264 #if USE_DLMALLOC == 0
265 uword flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
267 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
268 memfd->ssvm_size - page_size, flags);
270 sh->heap = create_mspace_with_base (((u8 *) sh) + page_size,
271 memfd->ssvm_size - page_size,
273 mspace_disable_expand (sh->heap);
275 oldheap = ssvm_push_heap (sh);
276 sh->name = format (0, "%s", memfd->name, 0);
277 ssvm_pop_heap (oldheap);
279 /* The application has to set set sh->ready... */
284 * Initialize memfd segment slave
286 * Subtly different than svm_slave_init. The caller needs to acquire
287 * a usable file descriptor for the memfd segment e.g. via
288 * vppinfra/socket.c:default_socket_recvmsg
291 ssvm_slave_init_memfd (ssvm_private_t * memfd)
293 clib_mem_vm_map_t mapa = { 0 };
294 ssvm_shared_header_t *sh;
297 memfd->i_am_master = 0;
299 page_size = clib_mem_get_fd_page_size (memfd->fd);
302 clib_unix_warning ("page size unknown");
303 return SSVM_API_ERROR_MMAP;
307 * Map the segment once, to look at the shared header
310 mapa.size = page_size;
312 if (clib_mem_vm_ext_map (&mapa))
314 clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
316 return SSVM_API_ERROR_MMAP;
320 memfd->requested_va = sh->ssvm_va;
321 memfd->ssvm_size = sh->ssvm_size;
322 clib_mem_vm_free (sh, page_size);
325 * Remap the segment at the 'right' address
327 mapa.requested_va = memfd->requested_va;
328 mapa.size = memfd->ssvm_size;
329 if (clib_mem_vm_ext_map (&mapa))
331 clib_unix_warning ("slave final mmap");
333 return SSVM_API_ERROR_MMAP;
337 sh->slave_pid = getpid ();
343 ssvm_delete_memfd (ssvm_private_t * memfd)
345 vec_free (memfd->name);
346 clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
351 * Initialize segment in a private heap
354 ssvm_master_init_private (ssvm_private_t * ssvm)
356 uword pagesize = clib_mem_get_page_size (), rnd_size = 0;
357 clib_mem_vm_alloc_t alloc = { 0 };
358 struct dlmallinfo dlminfo;
359 ssvm_shared_header_t *sh;
363 rnd_size = clib_max (ssvm->ssvm_size + (pagesize - 1), ssvm->ssvm_size);
364 rnd_size &= ~(pagesize - 1);
366 alloc.name = (char *) ssvm->name;
367 alloc.size = rnd_size + pagesize;
370 alloc.numa_node = ssvm->numa;
371 alloc.flags |= CLIB_MEM_VM_F_NUMA_PREFER;
374 if ((err = clib_mem_vm_ext_alloc (&alloc)))
376 clib_error_report (err);
377 return SSVM_API_ERROR_CREATE_FAILURE;
380 heap = create_mspace_with_base ((u8 *) alloc.addr + pagesize, rnd_size,
384 clib_unix_warning ("mheap alloc");
388 mspace_disable_expand (heap);
390 /* Find actual size because mspace size is rounded up by dlmalloc */
391 dlminfo = mspace_mallinfo (heap);
392 rnd_size = dlminfo.fordblks;
394 ssvm->ssvm_size = rnd_size;
395 ssvm->i_am_master = 1;
396 ssvm->my_pid = getpid ();
397 ssvm->requested_va = ~0;
399 /* First page in allocated memory is set aside for the shared header */
403 clib_memset (sh, 0, sizeof (*sh));
405 sh->ssvm_size = rnd_size;
406 sh->ssvm_va = pointer_to_uword (heap);
407 sh->type = SSVM_SEGMENT_PRIVATE;
408 sh->name = ssvm->name;
414 ssvm_slave_init_private (ssvm_private_t * ssvm)
416 clib_warning ("BUG: this should not be called!");
421 ssvm_delete_private (ssvm_private_t * ssvm)
423 vec_free (ssvm->name);
424 destroy_mspace (ssvm->sh->heap);
425 clib_mem_vm_free (ssvm->sh, ssvm->ssvm_size + clib_mem_get_page_size ());
429 ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
431 return (master_init_fns[type]) (ssvm);
435 ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
437 return (slave_init_fns[type]) (ssvm);
441 ssvm_delete (ssvm_private_t * ssvm)
443 delete_fns[ssvm->sh->type] (ssvm);
447 ssvm_type (const ssvm_private_t * ssvm)
449 return ssvm->sh->type;
453 ssvm_name (const ssvm_private_t * ssvm)
455 return ssvm->sh->name;
459 * fd.io coding-style-patch-verification: ON
462 * eval: (c-set-style "gnu")