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)
32 clib_mem_vm_map_t mapa = { 0 };
33 u8 junk = 0, *ssvm_filename;
34 ssvm_shared_header_t *sh;
35 uword page_size, requested_va = 0;
38 if (ssvm->ssvm_size == 0)
39 return SSVM_API_ERROR_NO_SIZE;
42 clib_warning ("[%d] creating segment '%s'", getpid (), ssvm->name);
44 ASSERT (vec_c_string_is_terminated (ssvm->name));
45 ssvm_filename = format (0, "/dev/shm/%s%c", ssvm->name, 0);
46 unlink ((char *) ssvm_filename);
47 vec_free (ssvm_filename);
49 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR | O_CREAT | O_EXCL, 0777);
52 clib_unix_warning ("create segment '%s'", ssvm->name);
53 return SSVM_API_ERROR_CREATE_FAILURE;
56 if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
57 clib_unix_warning ("ssvm segment chmod");
58 if (svm_get_root_rp ())
60 /* TODO: is this really needed? */
61 svm_main_region_t *smr = svm_get_root_rp ()->data_base;
62 if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
63 clib_unix_warning ("ssvm segment chown");
66 if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
68 clib_unix_warning ("lseek");
70 return SSVM_API_ERROR_SET_SIZE;
73 if (write (ssvm_fd, &junk, 1) != 1)
75 clib_unix_warning ("set ssvm size");
77 return SSVM_API_ERROR_SET_SIZE;
80 page_size = clib_mem_get_fd_page_size (ssvm_fd);
81 if (ssvm->requested_va)
83 requested_va = ssvm->requested_va;
84 clib_mem_vm_randomize_va (&requested_va, min_log2 (page_size));
87 mapa.requested_va = requested_va;
88 mapa.size = ssvm->ssvm_size;
90 mapa.numa_node = ssvm->numa;
91 if (clib_mem_vm_ext_map (&mapa))
93 clib_unix_warning ("mmap");
95 return SSVM_API_ERROR_MMAP;
100 CLIB_MEM_UNPOISON (sh, sizeof (*sh));
101 sh->master_pid = ssvm->my_pid;
102 sh->ssvm_size = ssvm->ssvm_size;
103 sh->ssvm_va = pointer_to_uword (sh);
104 sh->type = SSVM_SEGMENT_SHM;
105 sh->heap = create_mspace_with_base (((u8 *) sh) + page_size,
106 ssvm->ssvm_size - page_size,
108 mspace_disable_expand (sh->heap);
110 oldheap = ssvm_push_heap (sh);
111 sh->name = format (0, "%s", ssvm->name, 0);
112 ssvm_pop_heap (oldheap);
115 ssvm->my_pid = getpid ();
116 ssvm->i_am_master = 1;
118 /* The application has to set set sh->ready... */
123 ssvm_slave_init_shm (ssvm_private_t * ssvm)
127 ssvm_shared_header_t *sh;
129 ASSERT (vec_c_string_is_terminated (ssvm->name));
130 ssvm->i_am_master = 0;
132 while (ssvm->attach_timeout-- > 0)
135 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
141 if (fstat (ssvm_fd, &stat) < 0)
147 if (stat.st_size > 0)
150 clib_warning ("slave timeout");
151 return SSVM_API_ERROR_SLAVE_TIMEOUT;
154 sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
156 if (sh == MAP_FAILED)
158 clib_unix_warning ("slave research mmap");
160 return SSVM_API_ERROR_MMAP;
163 while (ssvm->attach_timeout-- > 0)
169 munmap (sh, MMAP_PAGESIZE);
170 clib_warning ("slave timeout 2");
171 return SSVM_API_ERROR_SLAVE_TIMEOUT;
174 ssvm->requested_va = sh->ssvm_va;
175 ssvm->ssvm_size = sh->ssvm_size;
176 munmap (sh, MMAP_PAGESIZE);
178 sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
179 PROT_READ | PROT_WRITE,
180 MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
182 if (sh == MAP_FAILED)
184 clib_unix_warning ("slave final mmap");
186 return SSVM_API_ERROR_MMAP;
188 sh->slave_pid = getpid ();
193 ssvm_delete_shm (ssvm_private_t * ssvm)
197 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
200 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
203 /* Throw away the backing file */
204 if (unlink ((char *) fn) < 0)
205 clib_unix_warning ("unlink segment '%s'", ssvm->name);
208 vec_free (ssvm->name);
210 munmap ((void *) ssvm->sh, ssvm->ssvm_size);
214 * Initialize memfd segment master
217 ssvm_master_init_memfd (ssvm_private_t * memfd)
220 ssvm_shared_header_t *sh;
222 clib_mem_vm_alloc_t alloc = { 0 };
225 if (memfd->ssvm_size == 0)
226 return SSVM_API_ERROR_NO_SIZE;
228 ASSERT (vec_c_string_is_terminated (memfd->name));
230 alloc.name = (char *) memfd->name;
231 alloc.size = memfd->ssvm_size;
232 alloc.flags = CLIB_MEM_VM_F_SHARED;
233 alloc.requested_va = memfd->requested_va;
236 alloc.numa_node = memfd->numa;
237 alloc.flags |= CLIB_MEM_VM_F_NUMA_PREFER;
239 if ((err = clib_mem_vm_ext_alloc (&alloc)))
241 clib_error_report (err);
242 return SSVM_API_ERROR_CREATE_FAILURE;
245 memfd->fd = alloc.fd;
246 memfd->sh = (ssvm_shared_header_t *) alloc.addr;
247 memfd->my_pid = getpid ();
248 memfd->i_am_master = 1;
250 page_size = 1ull << alloc.log2_page_size;
252 sh->master_pid = memfd->my_pid;
253 sh->ssvm_size = memfd->ssvm_size;
254 sh->ssvm_va = pointer_to_uword (sh);
255 sh->type = SSVM_SEGMENT_MEMFD;
257 sh->heap = create_mspace_with_base (((u8 *) sh) + page_size,
258 memfd->ssvm_size - page_size,
260 mspace_disable_expand (sh->heap);
261 oldheap = ssvm_push_heap (sh);
262 sh->name = format (0, "%s", memfd->name, 0);
263 ssvm_pop_heap (oldheap);
265 /* The application has to set set sh->ready... */
270 * Initialize memfd segment slave
272 * Subtly different than svm_slave_init. The caller needs to acquire
273 * a usable file descriptor for the memfd segment e.g. via
274 * vppinfra/socket.c:default_socket_recvmsg
277 ssvm_slave_init_memfd (ssvm_private_t * memfd)
279 clib_mem_vm_map_t mapa = { 0 };
280 ssvm_shared_header_t *sh;
283 memfd->i_am_master = 0;
285 page_size = clib_mem_get_fd_page_size (memfd->fd);
288 clib_unix_warning ("page size unknown");
289 return SSVM_API_ERROR_MMAP;
293 * Map the segment once, to look at the shared header
296 mapa.size = page_size;
298 if (clib_mem_vm_ext_map (&mapa))
300 clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
302 return SSVM_API_ERROR_MMAP;
306 memfd->requested_va = sh->ssvm_va;
307 memfd->ssvm_size = sh->ssvm_size;
308 clib_mem_vm_free (sh, page_size);
311 * Remap the segment at the 'right' address
313 mapa.requested_va = memfd->requested_va;
314 mapa.size = memfd->ssvm_size;
315 if (clib_mem_vm_ext_map (&mapa))
317 clib_unix_warning ("slave final mmap");
319 return SSVM_API_ERROR_MMAP;
323 sh->slave_pid = getpid ();
329 ssvm_delete_memfd (ssvm_private_t * memfd)
331 vec_free (memfd->name);
332 clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
337 * Initialize segment in a private heap
340 ssvm_master_init_private (ssvm_private_t * ssvm)
342 uword pagesize = clib_mem_get_page_size (), rnd_size = 0;
343 clib_mem_vm_alloc_t alloc = { 0 };
344 struct dlmallinfo dlminfo;
345 ssvm_shared_header_t *sh;
349 rnd_size = clib_max (ssvm->ssvm_size + (pagesize - 1), ssvm->ssvm_size);
350 rnd_size &= ~(pagesize - 1);
352 alloc.name = (char *) ssvm->name;
353 alloc.size = rnd_size + pagesize;
356 alloc.numa_node = ssvm->numa;
357 alloc.flags |= CLIB_MEM_VM_F_NUMA_PREFER;
360 if ((err = clib_mem_vm_ext_alloc (&alloc)))
362 clib_error_report (err);
363 return SSVM_API_ERROR_CREATE_FAILURE;
366 heap = create_mspace_with_base ((u8 *) alloc.addr + pagesize, rnd_size,
370 clib_unix_warning ("mheap alloc");
374 mspace_disable_expand (heap);
376 /* Find actual size because mspace size is rounded up by dlmalloc */
377 dlminfo = mspace_mallinfo (heap);
378 rnd_size = dlminfo.fordblks;
380 ssvm->ssvm_size = rnd_size;
381 ssvm->i_am_master = 1;
382 ssvm->my_pid = getpid ();
383 ssvm->requested_va = ~0;
385 /* First page in allocated memory is set aside for the shared header */
389 clib_memset (sh, 0, sizeof (*sh));
391 sh->ssvm_size = rnd_size;
392 sh->ssvm_va = pointer_to_uword (heap);
393 sh->type = SSVM_SEGMENT_PRIVATE;
394 sh->name = ssvm->name;
400 ssvm_slave_init_private (ssvm_private_t * ssvm)
402 clib_warning ("BUG: this should not be called!");
407 ssvm_delete_private (ssvm_private_t * ssvm)
409 vec_free (ssvm->name);
410 destroy_mspace (ssvm->sh->heap);
411 clib_mem_vm_free (ssvm->sh, ssvm->ssvm_size + clib_mem_get_page_size ());
415 ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
417 return (master_init_fns[type]) (ssvm);
421 ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
423 return (slave_init_fns[type]) (ssvm);
427 ssvm_delete (ssvm_private_t * ssvm)
429 delete_fns[ssvm->sh->type] (ssvm);
433 ssvm_type (const ssvm_private_t * ssvm)
435 return ssvm->sh->type;
439 ssvm_name (const ssvm_private_t * ssvm)
441 return ssvm->sh->name;
445 * fd.io coding-style-patch-verification: ON
448 * eval: (c-set-style "gnu")