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 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_vm_get_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 if (clib_mem_vm_ext_map (&mapa))
92 clib_unix_warning ("mmap");
94 return SSVM_API_ERROR_MMAP;
99 sh->master_pid = ssvm->my_pid;
100 sh->ssvm_size = ssvm->ssvm_size;
101 sh->ssvm_va = pointer_to_uword (sh);
102 sh->type = SSVM_SEGMENT_SHM;
103 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
104 ssvm->ssvm_size - page_size, mh_flags);
106 oldheap = ssvm_push_heap (sh);
107 sh->name = format (0, "%s", ssvm->name, 0);
108 ssvm_pop_heap (oldheap);
111 ssvm->my_pid = getpid ();
112 ssvm->i_am_master = 1;
114 /* The application has to set set sh->ready... */
119 ssvm_slave_init_shm (ssvm_private_t * ssvm)
123 ssvm_shared_header_t *sh;
125 ASSERT (vec_c_string_is_terminated (ssvm->name));
126 ssvm->i_am_master = 0;
128 while (ssvm->attach_timeout-- > 0)
131 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
137 if (fstat (ssvm_fd, &stat) < 0)
143 if (stat.st_size > 0)
146 clib_warning ("slave timeout");
147 return SSVM_API_ERROR_SLAVE_TIMEOUT;
150 sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
152 if (sh == MAP_FAILED)
154 clib_unix_warning ("slave research mmap");
156 return SSVM_API_ERROR_MMAP;
159 while (ssvm->attach_timeout-- > 0)
165 munmap (sh, MMAP_PAGESIZE);
166 clib_warning ("slave timeout 2");
167 return SSVM_API_ERROR_SLAVE_TIMEOUT;
170 ssvm->requested_va = (u64) sh->ssvm_va;
171 ssvm->ssvm_size = sh->ssvm_size;
172 munmap (sh, MMAP_PAGESIZE);
174 sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
175 PROT_READ | PROT_WRITE,
176 MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
178 if (sh == MAP_FAILED)
180 clib_unix_warning ("slave final mmap");
182 return SSVM_API_ERROR_MMAP;
184 sh->slave_pid = getpid ();
189 ssvm_delete_shm (ssvm_private_t * ssvm)
193 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
196 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
199 /* Throw away the backing file */
200 if (unlink ((char *) fn) < 0)
201 clib_unix_warning ("unlink segment '%s'", ssvm->name);
204 vec_free (ssvm->name);
206 munmap ((void *) ssvm->requested_va, ssvm->ssvm_size);
210 * Initialize memfd segment master
213 ssvm_master_init_memfd (ssvm_private_t * memfd)
215 uword page_size, flags = MHEAP_FLAG_DISABLE_VM | MHEAP_FLAG_THREAD_SAFE;
216 ssvm_shared_header_t *sh;
218 clib_mem_vm_alloc_t alloc = { 0 };
221 if (memfd->ssvm_size == 0)
222 return SSVM_API_ERROR_NO_SIZE;
224 ASSERT (vec_c_string_is_terminated (memfd->name));
226 alloc.name = (char *) memfd->name;
227 alloc.size = memfd->ssvm_size;
228 alloc.flags = CLIB_MEM_VM_F_SHARED;
229 alloc.requested_va = memfd->requested_va;
230 if ((err = clib_mem_vm_ext_alloc (&alloc)))
232 clib_error_report (err);
233 return SSVM_API_ERROR_CREATE_FAILURE;
236 memfd->fd = alloc.fd;
237 memfd->sh = (ssvm_shared_header_t *) alloc.addr;
238 memfd->my_pid = getpid ();
239 memfd->i_am_master = 1;
241 page_size = 1 << alloc.log2_page_size;
243 sh->master_pid = memfd->my_pid;
244 sh->ssvm_size = memfd->ssvm_size;
245 sh->ssvm_va = pointer_to_uword (sh);
246 sh->type = SSVM_SEGMENT_MEMFD;
247 sh->heap = mheap_alloc_with_flags (((u8 *) sh) + page_size,
248 memfd->ssvm_size - page_size, flags);
250 oldheap = ssvm_push_heap (sh);
251 sh->name = format (0, "%s", memfd->name, 0);
252 ssvm_pop_heap (oldheap);
254 /* The application has to set set sh->ready... */
259 * Initialize memfd segment slave
261 * Subtly different than svm_slave_init. The caller needs to acquire
262 * a usable file descriptor for the memfd segment e.g. via
263 * vppinfra/socket.c:default_socket_recvmsg
266 ssvm_slave_init_memfd (ssvm_private_t * memfd)
268 clib_mem_vm_map_t mapa = { 0 };
269 ssvm_shared_header_t *sh;
272 memfd->i_am_master = 0;
274 page_size = clib_mem_vm_get_page_size (memfd->fd);
277 clib_unix_warning ("page size unknown");
278 return SSVM_API_ERROR_MMAP;
282 * Map the segment once, to look at the shared header
285 mapa.size = page_size;
287 if (clib_mem_vm_ext_map (&mapa))
289 clib_unix_warning ("slave research mmap (fd %d)", mapa.fd);
291 return SSVM_API_ERROR_MMAP;
295 memfd->requested_va = sh->ssvm_va;
296 memfd->ssvm_size = sh->ssvm_size;
297 clib_mem_vm_free (sh, page_size);
300 * Remap the segment at the 'right' address
302 mapa.requested_va = memfd->requested_va;
303 mapa.size = memfd->ssvm_size;
304 if (clib_mem_vm_ext_map (&mapa))
306 clib_unix_warning ("slave final mmap");
308 return SSVM_API_ERROR_MMAP;
312 sh->slave_pid = getpid ();
318 ssvm_delete_memfd (ssvm_private_t * memfd)
320 vec_free (memfd->name);
321 clib_mem_vm_free (memfd->sh, memfd->ssvm_size);
326 * Initialize segment in a private heap
329 ssvm_master_init_private (ssvm_private_t * ssvm)
331 u32 pagesize = clib_mem_get_page_size ();
332 ssvm_shared_header_t *sh;
333 mheap_t *heap_header;
337 rnd_size = (ssvm->ssvm_size + (pagesize - 1)) & ~(pagesize - 1);
338 rnd_size = clib_min (rnd_size, ((u64) 1 << 32) - pagesize);
339 heap = mheap_alloc (0, rnd_size);
342 clib_unix_warning ("mheap alloc");
345 heap_header = mheap_header (heap);
346 heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
348 ssvm->ssvm_size = rnd_size;
349 ssvm->i_am_master = 1;
350 ssvm->my_pid = getpid ();
351 ssvm->requested_va = ~0;
353 /* Allocate a [sic] shared memory header, in process memory... */
354 sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
357 memset (sh, 0, sizeof (*sh));
359 sh->type = SSVM_SEGMENT_PRIVATE;
365 ssvm_slave_init_private (ssvm_private_t * ssvm)
367 clib_warning ("BUG: this should not be called!");
372 ssvm_delete_private (ssvm_private_t * ssvm)
374 vec_free (ssvm->name);
375 mheap_free (ssvm->sh->heap);
376 clib_mem_free (ssvm->sh);
380 ssvm_master_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
382 return (master_init_fns[type]) (ssvm);
386 ssvm_slave_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
388 return (slave_init_fns[type]) (ssvm);
392 ssvm_delete (ssvm_private_t * ssvm)
394 delete_fns[ssvm->sh->type] (ssvm);
398 ssvm_type (const ssvm_private_t * ssvm)
400 return ssvm->sh->type;
404 ssvm_name (const ssvm_private_t * ssvm)
406 return ssvm->sh->name;
410 * fd.io coding-style-patch-verification: ON
413 * eval: (c-set-style "gnu")