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 server_init_fns[SSVM_N_SEGMENT_TYPES] =
22 { ssvm_server_init_shm, ssvm_server_init_memfd, ssvm_server_init_private };
23 static init_fn client_init_fns[SSVM_N_SEGMENT_TYPES] =
24 { ssvm_client_init_shm, ssvm_client_init_memfd, ssvm_client_init_private };
25 static delete_fn delete_fns[SSVM_N_SEGMENT_TYPES] =
26 { ssvm_delete_shm, ssvm_delete_memfd, ssvm_delete_private };
29 ssvm_server_init_shm (ssvm_private_t * ssvm)
32 u8 junk = 0, *ssvm_filename;
33 ssvm_shared_header_t *sh;
34 uword page_size, requested_va = 0;
37 if (ssvm->ssvm_size == 0)
38 return SSVM_API_ERROR_NO_SIZE;
41 clib_warning ("[%d] creating segment '%s'", getpid (), ssvm->name);
43 ASSERT (vec_c_string_is_terminated (ssvm->name));
44 ssvm_filename = format (0, "/dev/shm/%s%c", ssvm->name, 0);
45 unlink ((char *) ssvm_filename);
46 vec_free (ssvm_filename);
48 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR | O_CREAT | O_EXCL, 0777);
51 clib_unix_warning ("create segment '%s'", ssvm->name);
52 return SSVM_API_ERROR_CREATE_FAILURE;
55 if (fchmod (ssvm_fd, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP) < 0)
56 clib_unix_warning ("ssvm segment chmod");
57 if (svm_get_root_rp ())
59 /* TODO: is this really needed? */
60 svm_main_region_t *smr = svm_get_root_rp ()->data_base;
61 if (fchown (ssvm_fd, smr->uid, smr->gid) < 0)
62 clib_unix_warning ("ssvm segment chown");
65 if (lseek (ssvm_fd, ssvm->ssvm_size, SEEK_SET) < 0)
67 clib_unix_warning ("lseek");
69 return SSVM_API_ERROR_SET_SIZE;
72 if (write (ssvm_fd, &junk, 1) != 1)
74 clib_unix_warning ("set ssvm size");
76 return SSVM_API_ERROR_SET_SIZE;
79 page_size = clib_mem_get_fd_page_size (ssvm_fd);
80 if (ssvm->requested_va)
82 requested_va = ssvm->requested_va;
83 clib_mem_vm_randomize_va (&requested_va, min_log2 (page_size));
86 sh = clib_mem_vm_map_shared (uword_to_pointer (requested_va, void *),
87 ssvm->ssvm_size, ssvm_fd, 0,
89 if (sh == CLIB_MEM_VM_MAP_FAILED)
91 clib_unix_warning ("mmap");
93 return SSVM_API_ERROR_MMAP;
98 CLIB_MEM_UNPOISON (sh, sizeof (*sh));
99 sh->server_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 = clib_mem_create_heap (((u8 *) sh) + page_size,
104 ssvm->ssvm_size - page_size,
105 1 /* locked */ , "ssvm server shm");
107 oldheap = ssvm_push_heap (sh);
108 sh->name = format (0, "%s", ssvm->name, 0);
109 ssvm_pop_heap (oldheap);
112 ssvm->my_pid = getpid ();
115 /* The application has to set set sh->ready... */
120 ssvm_client_init_shm (ssvm_private_t * ssvm)
124 ssvm_shared_header_t *sh;
126 ASSERT (vec_c_string_is_terminated (ssvm->name));
129 while (ssvm->attach_timeout-- > 0)
132 ssvm_fd = shm_open ((char *) ssvm->name, O_RDWR, 0777);
138 if (fstat (ssvm_fd, &stat) < 0)
144 if (stat.st_size > 0)
147 clib_warning ("client timeout");
148 return SSVM_API_ERROR_CLIENT_TIMEOUT;
151 sh = (void *) mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
153 if (sh == MAP_FAILED)
155 clib_unix_warning ("client research mmap");
157 return SSVM_API_ERROR_MMAP;
160 while (ssvm->attach_timeout-- > 0)
166 munmap (sh, MMAP_PAGESIZE);
167 clib_warning ("client timeout 2");
168 return SSVM_API_ERROR_CLIENT_TIMEOUT;
171 ssvm->requested_va = sh->ssvm_va;
172 ssvm->ssvm_size = sh->ssvm_size;
173 munmap (sh, MMAP_PAGESIZE);
175 sh = ssvm->sh = (void *) mmap ((void *) ssvm->requested_va, ssvm->ssvm_size,
176 PROT_READ | PROT_WRITE,
177 MAP_SHARED | MAP_FIXED, ssvm_fd, 0);
179 if (sh == MAP_FAILED)
181 clib_unix_warning ("client final mmap");
183 return SSVM_API_ERROR_MMAP;
185 sh->client_pid = getpid ();
190 ssvm_delete_shm (ssvm_private_t * ssvm)
194 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
197 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
200 /* Throw away the backing file */
201 if (unlink ((char *) fn) < 0)
202 clib_unix_warning ("unlink segment '%s'", ssvm->name);
205 vec_free (ssvm->name);
208 clib_mem_vm_unmap (ssvm->sh);
210 munmap ((void *) ssvm->sh, ssvm->ssvm_size);
214 * Initialize memfd segment server
217 ssvm_server_init_memfd (ssvm_private_t * memfd)
219 uword page_size, n_pages;
220 ssvm_shared_header_t *sh;
224 if (memfd->ssvm_size == 0)
225 return SSVM_API_ERROR_NO_SIZE;
227 ASSERT (vec_c_string_is_terminated (memfd->name));
229 memfd->fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT,
230 (char *) memfd->name);
232 if (memfd->fd == CLIB_MEM_ERROR)
234 clib_unix_warning ("failed to create memfd");
235 return SSVM_API_ERROR_CREATE_FAILURE;
238 log2_page_size = clib_mem_get_fd_log2_page_size (memfd->fd);
239 if (log2_page_size == 0)
241 clib_unix_warning ("cannot determine page size");
242 return SSVM_API_ERROR_CREATE_FAILURE;
245 n_pages = ((memfd->ssvm_size - 1) >> log2_page_size) + 1;
247 if ((ftruncate (memfd->fd, n_pages << log2_page_size)) == -1)
249 clib_unix_warning ("memfd ftruncate failure");
250 return SSVM_API_ERROR_CREATE_FAILURE;
253 sh = clib_mem_vm_map_shared (uword_to_pointer (memfd->requested_va, void *),
254 memfd->ssvm_size, memfd->fd, 0,
255 (char *) memfd->name);
256 if (sh == CLIB_MEM_VM_MAP_FAILED)
258 clib_unix_warning ("memfd map (fd %d)", memfd->fd);
260 return SSVM_API_ERROR_CREATE_FAILURE;
264 memfd->my_pid = getpid ();
265 memfd->is_server = 1;
267 sh->server_pid = memfd->my_pid;
268 sh->ssvm_size = memfd->ssvm_size;
269 sh->ssvm_va = pointer_to_uword (sh);
270 sh->type = SSVM_SEGMENT_MEMFD;
272 page_size = 1ULL << log2_page_size;
273 sh->heap = clib_mem_create_heap (((u8 *) sh) + page_size,
274 memfd->ssvm_size - page_size,
275 1 /* locked */ , "ssvm server memfd");
276 oldheap = ssvm_push_heap (sh);
277 sh->name = format (0, "%s", memfd->name, 0);
278 ssvm_pop_heap (oldheap);
280 /* The application has to set set sh->ready... */
285 * Initialize memfd segment client
287 * Subtly different than svm_client_init. The caller needs to acquire
288 * a usable file descriptor for the memfd segment e.g. via
289 * vppinfra/socket.c:default_socket_recvmsg
292 ssvm_client_init_memfd (ssvm_private_t * memfd)
294 int mmap_flags = MAP_SHARED;
295 ssvm_shared_header_t *sh;
298 memfd->is_server = 0;
300 page_size = clib_mem_get_fd_page_size (memfd->fd);
303 clib_unix_warning ("page size unknown");
304 return SSVM_API_ERROR_MMAP;
308 * Map the segment once, to look at the shared header
310 sh = (void *) mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_SHARED,
313 if (sh == MAP_FAILED)
315 clib_unix_warning ("client research mmap (fd %d)", memfd->fd);
317 return SSVM_API_ERROR_MMAP;
320 memfd->requested_va = sh->ssvm_va;
321 memfd->ssvm_size = sh->ssvm_size;
322 munmap (sh, page_size);
324 if (memfd->requested_va)
325 mmap_flags |= MAP_FIXED;
328 * Remap the segment at the 'right' address
330 sh = (void *) mmap (uword_to_pointer (memfd->requested_va, void *),
332 PROT_READ | PROT_WRITE, mmap_flags, memfd->fd, 0);
334 if (sh == MAP_FAILED)
336 clib_unix_warning ("client final mmap");
338 return SSVM_API_ERROR_MMAP;
341 sh->client_pid = getpid ();
347 ssvm_delete_memfd (ssvm_private_t * memfd)
349 vec_free (memfd->name);
350 if (memfd->is_server)
351 clib_mem_vm_unmap (memfd->sh);
353 munmap (memfd->sh, memfd->ssvm_size);
358 * Initialize segment in a private heap
361 ssvm_server_init_private (ssvm_private_t * ssvm)
363 uword page_size, log2_page_size, rnd_size = 0;
364 ssvm_shared_header_t *sh;
365 clib_mem_heap_t *heap, *oldheap;
367 log2_page_size = clib_mem_get_log2_page_size ();
368 if (log2_page_size == 0)
370 clib_unix_warning ("cannot determine page size");
371 return SSVM_API_ERROR_CREATE_FAILURE;
374 page_size = 1ULL << log2_page_size;
375 rnd_size = clib_max (ssvm->ssvm_size + (page_size - 1), ssvm->ssvm_size);
376 rnd_size &= ~(page_size - 1);
378 sh = clib_mem_vm_map (0, rnd_size + page_size, log2_page_size,
379 (char *) ssvm->name);
380 if (sh == CLIB_MEM_VM_MAP_FAILED)
382 clib_unix_warning ("private map failed");
383 return SSVM_API_ERROR_CREATE_FAILURE;
386 heap = clib_mem_create_heap ((u8 *) sh + page_size, rnd_size,
387 1 /* locked */ , "ssvm server private");
390 clib_unix_warning ("heap alloc");
394 rnd_size = clib_mem_get_heap_free_space (heap);
396 ssvm->ssvm_size = rnd_size;
398 ssvm->my_pid = getpid ();
399 ssvm->requested_va = ~0;
401 /* First page in allocated memory is set aside for the shared header */
404 clib_memset (sh, 0, sizeof (*sh));
406 sh->ssvm_size = rnd_size;
407 sh->ssvm_va = pointer_to_uword (sh);
408 sh->type = SSVM_SEGMENT_PRIVATE;
410 oldheap = ssvm_push_heap (sh);
411 sh->name = format (0, "%s", ssvm->name, 0);
412 ssvm_pop_heap (oldheap);
418 ssvm_client_init_private (ssvm_private_t * ssvm)
420 clib_warning ("BUG: this should not be called!");
425 ssvm_delete_private (ssvm_private_t * ssvm)
427 vec_free (ssvm->name);
428 clib_mem_destroy_heap (ssvm->sh->heap);
429 clib_mem_vm_unmap (ssvm->sh);
433 ssvm_server_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
435 return (server_init_fns[type]) (ssvm);
439 ssvm_client_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
441 return (client_init_fns[type]) (ssvm);
445 ssvm_delete (ssvm_private_t * ssvm)
447 delete_fns[ssvm->sh->type] (ssvm);
451 ssvm_type (const ssvm_private_t * ssvm)
453 return ssvm->sh->type;
457 ssvm_name (const ssvm_private_t * ssvm)
459 return ssvm->sh->name;
463 * fd.io coding-style-patch-verification: ON
466 * eval: (c-set-style "gnu")