2 *------------------------------------------------------------------
5 * Copyright (c) 2009 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
22 #include <sys/types.h>
25 #include <netinet/in.h>
32 #include <vppinfra/clib.h>
33 #include <vppinfra/vec.h>
34 #include <vppinfra/hash.h>
35 #include <vppinfra/bitmap.h>
36 #include <vppinfra/fifo.h>
37 #include <vppinfra/time.h>
38 #include <vppinfra/heap.h>
39 #include <vppinfra/pool.h>
40 #include <vppinfra/format.h>
47 * format_all_svm_regions
48 * Maps / unmaps regions. Do NOT call from client code!
51 format_all_svm_regions (u8 * s, va_list * args)
53 int verbose = va_arg (*args, int);
54 svm_region_t *root_rp = svm_get_root_rp ();
55 svm_main_region_t *mp;
56 svm_subregion_t *subp;
58 svm_map_region_args_t *a = 0;
65 pthread_mutex_lock (&root_rp->mutex);
67 s = format (s, "%U", format_svm_region, root_rp, verbose);
69 mp = root_rp->data_base;
72 * Snapshoot names, can't hold root rp mutex across
75 pool_foreach (subp, mp->subregions) {
76 name = vec_dup (subp->subregion_name);
77 vec_add1(svm_names, name);
80 pthread_mutex_unlock (&root_rp->mutex);
82 for (i = 0; i < vec_len (svm_names); i++)
85 a->name = (char *) svm_names[i];
86 rp = svm_region_find_or_create (a);
89 pthread_mutex_lock (&rp->mutex);
90 s = format (s, "%U", format_svm_region, rp, verbose);
91 pthread_mutex_unlock (&rp->mutex);
92 svm_region_unmap (rp);
93 vec_free (svm_names[i]);
102 show (char *chroot_path, int verbose)
104 svm_map_region_args_t *a = 0;
108 svm_region_init_chroot (chroot_path);
110 fformat (stdout, "My pid is %d\n", getpid ());
112 fformat (stdout, "%U", format_all_svm_regions, verbose);
121 svm_map_region_nolock (svm_map_region_args_t * a)
128 ASSERT ((a->size & ~(MMAP_PAGESIZE - 1)) == a->size);
130 shm_name = shm_name_from_svm_map_region_args (a);
132 svm_fd = shm_open ((char *) shm_name, O_RDWR, 0777);
136 perror ("svm_region_map(mmap open)");
141 rp = mmap (0, MMAP_PAGESIZE, PROT_READ | PROT_WRITE, MAP_SHARED, svm_fd, 0);
143 if (rp == (svm_region_t *) MAP_FAILED)
146 clib_warning ("mmap");
150 * We lost the footrace to create this region; make sure
151 * the winner has crossed the finish line.
153 while (rp->version == 0 && deadman++ < 5)
161 if (rp->version == 0)
163 clib_warning ("rp->version %d not %d", rp->version, SVM_VERSION);
164 munmap (rp, MMAP_PAGESIZE);
167 /* Remap now that the region has been placed */
168 a->baseva = rp->virtual_base;
169 a->size = rp->virtual_size;
170 munmap (rp, MMAP_PAGESIZE);
172 rp = (void *) mmap (uword_to_pointer (a->baseva, void *), a->size,
173 PROT_READ | PROT_WRITE,
174 MAP_SHARED | MAP_FIXED, svm_fd, 0);
175 if ((uword) rp == (uword) MAP_FAILED)
177 clib_unix_warning ("mmap");
181 if ((uword) rp != rp->virtual_base)
183 clib_warning ("mmap botch");
186 if (pthread_mutex_trylock (&rp->mutex))
188 clib_warning ("rp->mutex LOCKED by pid %d, tag %d, cleared...",
189 rp->mutex_owner_pid, rp->mutex_owner_tag);
190 clib_memset (&rp->mutex, 0, sizeof (rp->mutex));
195 clib_warning ("mutex OK...\n");
196 pthread_mutex_unlock (&rp->mutex);
199 return ((void *) rp);
204 * Round to a pagesize multiple, presumably 4k works
207 rnd_pagesize (u64 size)
211 rv = (size + (MMAP_PAGESIZE - 1)) & ~(MMAP_PAGESIZE - 1);
218 region_lock (svm_region_t * rp, int tag)
220 pthread_mutex_lock (&rp->mutex);
222 rp->mutex_owner_pid = getpid ();
223 rp->mutex_owner_tag = tag;
228 region_unlock (svm_region_t * rp)
231 rp->mutex_owner_pid = 0;
232 rp->mutex_owner_tag = 0;
234 pthread_mutex_unlock (&rp->mutex);
239 svm_existing_region_map_nolock (void *root_arg, svm_map_region_args_t * a)
241 svm_region_t *root_rp = root_arg;
242 svm_main_region_t *mp;
247 a->size += MMAP_PAGESIZE +
248 (a->pvt_heap_size ? a->pvt_heap_size : SVM_PVT_MHEAP_SIZE);
249 a->size = rnd_pagesize (a->size);
251 region_lock (root_rp, 4);
252 oldheap = svm_push_pvt_heap (root_rp);
253 mp = root_rp->data_base;
257 p = hash_get_mem (mp->name_hash, a->name);
261 rp = svm_map_region_nolock (a);
262 region_unlock (root_rp);
263 svm_pop_heap (oldheap);
266 region_unlock (root_rp);
272 trace (char *chroot_path, char *name, int enable_disable)
274 svm_map_region_args_t *a = 0;
280 svm_region_init_chroot (chroot_path);
284 a->flags = SVM_FLAGS_MHEAP;
286 db_rp = svm_region_find_or_create (a);
290 region_lock (db_rp, 20);
292 oldheap = svm_push_data_heap (db_rp);
294 mheap_trace (db_rp->data_heap, enable_disable);
296 svm_pop_heap (oldheap);
297 region_unlock (db_rp);
299 svm_region_unmap ((void *) db_rp);
307 subregion_repair (char *chroot_path)
310 svm_main_region_t *mp;
311 svm_map_region_args_t a;
312 svm_region_t *root_rp;
314 svm_subregion_t *subp;
318 svm_region_init_chroot (chroot_path);
319 root_rp = svm_get_root_rp ();
321 pthread_mutex_lock (&root_rp->mutex);
323 mp = root_rp->data_base;
326 * Snapshoot names, can't hold root rp mutex across
329 pool_foreach (subp, mp->subregions) {
330 name = vec_dup (subp->subregion_name);
331 vec_add1(svm_names, name);
334 pthread_mutex_unlock (&root_rp->mutex);
336 for (i = 0; i < vec_len (svm_names); i++)
338 clib_memset (&a, 0, sizeof (a));
339 a.root_path = chroot_path;
340 a.name = (char *) svm_names[i];
341 fformat (stdout, "Checking %s region...\n", a.name);
342 rp = svm_existing_region_map_nolock (root_rp, &a);
345 svm_region_unmap (rp);
346 vec_free (svm_names[i]);
349 vec_free (svm_names);
353 repair (char *chroot_path, int crash_root_region)
355 svm_region_t *root_rp = 0;
356 svm_map_region_args_t *a = 0;
357 void *svm_map_region (svm_map_region_args_t * a);
361 fformat (stdout, "our pid: %d\n", getpid ());
365 a->root_path = chroot_path;
366 a->name = SVM_GLOBAL_REGION_NAME;
367 a->baseva = svm_get_global_region_base_va ();
368 a->size = SVM_GLOBAL_REGION_SIZE;
369 a->flags = SVM_FLAGS_NODATA;
371 shm_name = shm_name_from_svm_map_region_args (a);
373 svm_fd = shm_open ((char *) shm_name, O_RDWR, 0777);
377 perror ("svm_region_map(mmap open)");
383 root_rp = mmap (0, MMAP_PAGESIZE,
384 PROT_READ | PROT_WRITE, MAP_SHARED, svm_fd, 0);
386 if (root_rp == (svm_region_t *) MAP_FAILED)
389 clib_warning ("mmap");
393 /* Remap now that the region has been placed */
394 clib_warning ("remap to 0x%x", root_rp->virtual_base);
396 a->baseva = root_rp->virtual_base;
397 a->size = root_rp->virtual_size;
398 munmap (root_rp, MMAP_PAGESIZE);
400 root_rp = (void *) mmap (uword_to_pointer (a->baseva, void *), a->size,
401 PROT_READ | PROT_WRITE,
402 MAP_SHARED | MAP_FIXED, svm_fd, 0);
403 if ((uword) root_rp == (uword) MAP_FAILED)
405 clib_unix_warning ("mmap");
411 if ((uword) root_rp != root_rp->virtual_base)
413 clib_warning ("mmap botch");
417 if (pthread_mutex_trylock (&root_rp->mutex))
419 clib_warning ("root_rp->mutex LOCKED by pid %d, tag %d, cleared...",
420 root_rp->mutex_owner_pid, root_rp->mutex_owner_tag);
421 clib_memset (&root_rp->mutex, 0, sizeof (root_rp->mutex));
426 clib_warning ("root_rp->mutex OK...\n");
427 pthread_mutex_unlock (&root_rp->mutex);
433 * Now that the root region is known to be OK,
434 * fix broken subregions
436 subregion_repair (chroot_path);
438 if (crash_root_region)
440 clib_warning ("Leaving root region locked on purpose...");
441 pthread_mutex_lock (&root_rp->mutex);
442 root_rp->mutex_owner_pid = getpid ();
443 root_rp->mutex_owner_tag = 99;
449 main (int argc, char **argv)
451 unformat_input_t input;
454 char *chroot_path = 0;
457 clib_mem_init_thread_safe (0, 128 << 20);
459 unformat_init_command_line (&input, argv);
461 while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
463 if (unformat (&input, "show-verbose"))
465 show (chroot_path, 1);
468 else if (unformat (&input, "show"))
470 show (chroot_path, 0);
473 else if (unformat (&input, "client-scan"))
475 svm_client_scan (chroot_path);
478 else if (unformat (&input, "repair"))
480 repair (chroot_path, 0 /* fix it */ );
483 else if (unformat (&input, "crash"))
485 repair (chroot_path, 1 /* crash it */ );
488 else if (unformat (&input, "trace-on %s", &name))
490 trace (chroot_path, name, 1);
493 else if (unformat (&input, "trace-off %s", &name))
495 trace (chroot_path, name, 0);
498 else if (unformat (&input, "chroot %s", &chroot_u8))
500 chroot_path = (char *) chroot_u8;
508 unformat_free (&input);
513 "%s: show | show-verbose | client-scan | trace-on <region-name>\n",
515 fformat (stdout, " trace-off <region-name>\n");
521 * fd.io coding-style-patch-verification: ON
524 * eval: (c-set-style "gnu")