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 ();
191 ssvm_delete_shm (ssvm_private_t * ssvm)
195 fn = format (0, "/dev/shm/%s%c", ssvm->name, 0);
198 clib_warning ("[%d] unlinking ssvm (%s) backing file '%s'", getpid (),
201 /* Throw away the backing file */
202 if (unlink ((char *) fn) < 0)
203 clib_unix_warning ("unlink segment '%s'", ssvm->name);
206 vec_free (ssvm->name);
209 clib_mem_vm_unmap (ssvm->sh);
211 munmap ((void *) ssvm->sh, ssvm->ssvm_size);
215 * Initialize memfd segment server
218 ssvm_server_init_memfd (ssvm_private_t * memfd)
220 uword page_size, n_pages;
221 ssvm_shared_header_t *sh;
225 if (memfd->ssvm_size == 0)
226 return SSVM_API_ERROR_NO_SIZE;
228 ASSERT (vec_c_string_is_terminated (memfd->name));
230 if (memfd->huge_page)
231 memfd->fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT_HUGE,
232 (char *) memfd->name);
235 clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, (char *) memfd->name);
237 if (memfd->fd == CLIB_MEM_ERROR)
239 clib_unix_warning ("failed to create memfd");
240 return SSVM_API_ERROR_CREATE_FAILURE;
243 log2_page_size = clib_mem_get_fd_log2_page_size (memfd->fd);
244 if (log2_page_size == 0)
246 clib_unix_warning ("cannot determine page size");
247 return SSVM_API_ERROR_CREATE_FAILURE;
250 n_pages = ((memfd->ssvm_size - 1) >> log2_page_size) + 1;
252 if ((ftruncate (memfd->fd, n_pages << log2_page_size)) == -1)
254 clib_unix_warning ("memfd ftruncate failure");
255 return SSVM_API_ERROR_CREATE_FAILURE;
258 sh = clib_mem_vm_map_shared (uword_to_pointer (memfd->requested_va, void *),
259 memfd->ssvm_size, memfd->fd, 0,
260 (char *) memfd->name);
261 if (sh == CLIB_MEM_VM_MAP_FAILED)
263 clib_unix_warning ("memfd map (fd %d)", memfd->fd);
265 return SSVM_API_ERROR_CREATE_FAILURE;
269 memfd->my_pid = getpid ();
270 memfd->is_server = 1;
272 sh->server_pid = memfd->my_pid;
273 sh->ssvm_size = memfd->ssvm_size;
274 sh->ssvm_va = pointer_to_uword (sh);
275 sh->type = SSVM_SEGMENT_MEMFD;
277 page_size = clib_mem_get_page_size ();
278 sh->heap = clib_mem_create_heap (((u8 *) sh) + page_size,
279 memfd->ssvm_size - page_size,
280 1 /* locked */ , "ssvm server memfd");
281 oldheap = ssvm_push_heap (sh);
282 sh->name = format (0, "%s", memfd->name, 0);
283 ssvm_pop_heap (oldheap);
285 /* The application has to set set sh->ready... */
290 * Initialize memfd segment client
292 * Subtly different than svm_client_init. The caller needs to acquire
293 * a usable file descriptor for the memfd segment e.g. via
294 * vppinfra/socket.c:default_socket_recvmsg
297 ssvm_client_init_memfd (ssvm_private_t * memfd)
299 int mmap_flags = MAP_SHARED;
300 ssvm_shared_header_t *sh;
303 memfd->is_server = 0;
305 page_size = clib_mem_get_fd_page_size (memfd->fd);
308 clib_unix_warning ("page size unknown");
309 return SSVM_API_ERROR_MMAP;
313 * Map the segment once, to look at the shared header
315 sh = (void *) mmap (0, page_size, PROT_READ | PROT_WRITE, MAP_SHARED,
318 if (sh == MAP_FAILED)
320 clib_unix_warning ("client research mmap (fd %d)", memfd->fd);
322 return SSVM_API_ERROR_MMAP;
325 memfd->requested_va = sh->ssvm_va;
326 memfd->ssvm_size = sh->ssvm_size;
327 munmap (sh, page_size);
329 if (memfd->requested_va)
330 mmap_flags |= MAP_FIXED;
333 * Remap the segment at the 'right' address
335 sh = (void *) mmap (uword_to_pointer (memfd->requested_va, void *),
337 PROT_READ | PROT_WRITE, mmap_flags, memfd->fd, 0);
339 if (sh == MAP_FAILED)
341 clib_unix_warning ("client final mmap");
343 return SSVM_API_ERROR_MMAP;
346 sh->client_pid = getpid ();
352 ssvm_delete_memfd (ssvm_private_t * memfd)
354 vec_free (memfd->name);
355 if (memfd->is_server)
356 clib_mem_vm_unmap (memfd->sh);
358 munmap (memfd->sh, memfd->ssvm_size);
363 * Initialize segment in a private heap
366 ssvm_server_init_private (ssvm_private_t * ssvm)
368 uword page_size, log2_page_size, rnd_size = 0;
369 ssvm_shared_header_t *sh;
370 clib_mem_heap_t *heap, *oldheap;
372 log2_page_size = clib_mem_get_log2_page_size ();
373 if (log2_page_size == 0)
375 clib_unix_warning ("cannot determine page size");
376 return SSVM_API_ERROR_CREATE_FAILURE;
379 page_size = 1ULL << log2_page_size;
380 rnd_size = clib_max (ssvm->ssvm_size + (page_size - 1), ssvm->ssvm_size);
381 rnd_size &= ~(page_size - 1);
383 sh = clib_mem_vm_map (0, rnd_size + page_size, log2_page_size,
384 (char *) ssvm->name);
385 if (sh == CLIB_MEM_VM_MAP_FAILED)
387 clib_unix_warning ("private map failed");
388 return SSVM_API_ERROR_CREATE_FAILURE;
391 heap = clib_mem_create_heap ((u8 *) sh + page_size, rnd_size,
392 1 /* locked */ , "ssvm server private");
395 clib_unix_warning ("heap alloc");
399 rnd_size = clib_mem_get_heap_free_space (heap);
401 ssvm->ssvm_size = rnd_size;
403 ssvm->my_pid = getpid ();
404 ssvm->requested_va = ~0;
406 /* First page in allocated memory is set aside for the shared header */
409 clib_memset (sh, 0, sizeof (*sh));
411 sh->ssvm_size = rnd_size;
412 sh->ssvm_va = pointer_to_uword (sh);
413 sh->type = SSVM_SEGMENT_PRIVATE;
415 oldheap = ssvm_push_heap (sh);
416 sh->name = format (0, "%s", ssvm->name, 0);
417 ssvm_pop_heap (oldheap);
423 ssvm_client_init_private (ssvm_private_t * ssvm)
425 clib_warning ("BUG: this should not be called!");
430 ssvm_delete_private (ssvm_private_t * ssvm)
432 vec_free (ssvm->name);
433 clib_mem_destroy_heap (ssvm->sh->heap);
434 clib_mem_vm_unmap (ssvm->sh);
438 ssvm_server_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
440 return (server_init_fns[type]) (ssvm);
444 ssvm_client_init (ssvm_private_t * ssvm, ssvm_segment_type_t type)
446 return (client_init_fns[type]) (ssvm);
450 ssvm_delete (ssvm_private_t * ssvm)
452 delete_fns[ssvm->sh->type] (ssvm);
456 ssvm_type (const ssvm_private_t * ssvm)
458 return ssvm->sh->type;
462 ssvm_name (const ssvm_private_t * ssvm)
464 return ssvm->sh->name;
468 * fd.io coding-style-patch-verification: ON
471 * eval: (c-set-style "gnu")