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 <vppinfra/format.h>
17 #include <vppinfra/dlmalloc.h>
18 #include <vppinfra/os.h>
19 #include <vppinfra/lock.h>
20 #include <vppinfra/hash.h>
21 #include <vppinfra/elf_clib.h>
22 #include <vppinfra/sanitizer.h>
26 /* Address of callers: outer first, inner last. */
29 /* Count of allocations with this traceback. */
32 /* Count of bytes allocated with this traceback. */
35 /* Offset of this item */
44 mheap_trace_t *traces;
46 /* Indices of free traces. */
49 /* Hash table mapping callers to trace index. */
50 uword *trace_by_callers;
52 /* Hash table mapping mheap offset to trace index. */
53 uword *trace_index_by_offset;
55 /* So we can easily shut off current segment trace, if any */
56 void *current_traced_mheap;
60 mheap_trace_main_t mheap_trace_main;
63 mheap_get_trace (uword offset, uword size)
65 mheap_trace_main_t *tm = &mheap_trace_main;
67 uword i, n_callers, trace_index, *p;
71 if (tm->enabled == 0 || (clib_mem_get_heap () != tm->current_traced_mheap))
74 /* Spurious Coverity warnings be gone. */
75 clib_memset (&trace, 0, sizeof (trace));
77 /* Skip our frame and mspace_get_aligned's frame */
78 n_callers = clib_backtrace (trace.callers, ARRAY_LEN (trace.callers), 2);
82 clib_spinlock_lock (&tm->lock);
84 /* Turn off tracing to avoid embarrassment... */
85 save_enabled = tm->enabled;
88 if (!tm->trace_by_callers)
89 tm->trace_by_callers =
90 hash_create_shmem (0, sizeof (trace.callers), sizeof (uword));
92 p = hash_get_mem (tm->trace_by_callers, &trace.callers);
96 t = tm->traces + trace_index;
100 i = vec_len (tm->trace_free_list);
103 trace_index = tm->trace_free_list[i - 1];
104 _vec_len (tm->trace_free_list) = i - 1;
108 mheap_trace_t *old_start = tm->traces;
109 mheap_trace_t *old_end = vec_end (tm->traces);
111 vec_add2 (tm->traces, t, 1);
113 if (tm->traces != old_start)
118 hash_foreach_pair (p, tm->trace_by_callers,
120 q = uword_to_pointer (p->key, mheap_trace_t *);
121 ASSERT (q >= old_start && q < old_end);
122 p->key = pointer_to_uword (tm->traces + (q - old_start));
126 trace_index = t - tm->traces;
129 t = tm->traces + trace_index;
131 t->n_allocations = 0;
133 hash_set_mem (tm->trace_by_callers, t->callers, trace_index);
136 t->n_allocations += 1;
138 t->offset = offset; /* keep a sample to autopsy */
139 hash_set (tm->trace_index_by_offset, offset, t - tm->traces);
140 tm->enabled = save_enabled;
141 clib_spinlock_unlock (&tm->lock);
145 mheap_put_trace (uword offset, uword size)
148 uword trace_index, *p;
149 mheap_trace_main_t *tm = &mheap_trace_main;
152 if (tm->enabled == 0)
155 clib_spinlock_lock (&tm->lock);
157 /* Turn off tracing for a moment */
158 save_enabled = tm->enabled;
161 p = hash_get (tm->trace_index_by_offset, offset);
164 tm->enabled = save_enabled;
165 clib_spinlock_unlock (&tm->lock);
170 hash_unset (tm->trace_index_by_offset, offset);
171 ASSERT (trace_index < vec_len (tm->traces));
173 t = tm->traces + trace_index;
174 ASSERT (t->n_allocations > 0);
175 ASSERT (t->n_bytes >= size);
176 t->n_allocations -= 1;
178 if (t->n_allocations == 0)
180 hash_unset_mem (tm->trace_by_callers, t->callers);
181 vec_add1 (tm->trace_free_list, trace_index);
182 clib_memset (t, 0, sizeof (t[0]));
184 tm->enabled = save_enabled;
185 clib_spinlock_unlock (&tm->lock);
189 mheap_trace_main_free (mheap_trace_main_t * tm)
191 vec_free (tm->traces);
192 vec_free (tm->trace_free_list);
193 hash_free (tm->trace_by_callers);
194 hash_free (tm->trace_index_by_offset);
197 static clib_mem_heap_t *
198 clib_mem_create_heap_internal (void *base, uword size,
199 clib_mem_page_sz_t log2_page_sz, int is_locked,
204 int sz = sizeof (clib_mem_heap_t);
208 log2_page_sz = clib_mem_log2_page_size_validate (log2_page_sz);
209 size = round_pow2 (size, clib_mem_page_bytes (log2_page_sz));
210 base = clib_mem_vm_map_internal (0, log2_page_sz, size, -1, 0,
213 if (base == CLIB_MEM_VM_MAP_FAILED)
216 flags = CLIB_MEM_HEAP_F_UNMAP_ON_DESTROY;
219 log2_page_sz = CLIB_MEM_PAGE_SZ_UNKNOWN;
222 flags |= CLIB_MEM_HEAP_F_LOCKED;
227 h->log2_page_sz = log2_page_sz;
230 strcpy (h->name, name);
231 sz = round_pow2 (sz + sizeof (clib_mem_heap_t), 16);
232 h->mspace = create_mspace_with_base (base + sz, size - sz, is_locked);
234 mspace_disable_expand (h->mspace);
236 CLIB_MEM_POISON (mspace_least_addr (h->mspace),
237 mspace_footprint (h->mspace));
242 /* Initialize CLIB heap based on memory/size given by user.
243 Set memory to 0 and CLIB will try to allocate its own heap. */
245 clib_mem_init_internal (void *base, uword size,
246 clib_mem_page_sz_t log2_page_sz)
250 clib_mem_main_init ();
252 h = clib_mem_create_heap_internal (base, size, log2_page_sz,
253 1 /*is_locked */ , "main heap");
255 clib_mem_set_heap (h);
257 if (mheap_trace_main.lock == 0)
258 clib_spinlock_init (&mheap_trace_main.lock);
264 clib_mem_init (void *memory, uword memory_size)
266 return clib_mem_init_internal (memory, memory_size,
267 CLIB_MEM_PAGE_SZ_DEFAULT);
271 clib_mem_init_with_page_size (uword memory_size,
272 clib_mem_page_sz_t log2_page_sz)
274 return clib_mem_init_internal (0, memory_size, log2_page_sz);
278 clib_mem_init_thread_safe (void *memory, uword memory_size)
280 return clib_mem_init_internal (memory, memory_size,
281 CLIB_MEM_PAGE_SZ_DEFAULT);
285 clib_mem_destroy (void)
287 mheap_trace_main_t *tm = &mheap_trace_main;
288 clib_mem_heap_t *heap = clib_mem_get_heap ();
289 void *base = mspace_least_addr (heap->mspace);
291 if (tm->enabled && heap->mspace == tm->current_traced_mheap)
294 destroy_mspace (heap->mspace);
295 clib_mem_vm_unmap (base);
299 format_clib_mem_usage (u8 * s, va_list * va)
301 int verbose = va_arg (*va, int);
302 return format (s, "$$$$ heap at %llx verbose %d", clib_mem_get_heap (),
307 * Magic decoder ring for mallinfo stats (ala dlmalloc):
309 * size_t arena; / * Non-mmapped space allocated (bytes) * /
310 * size_t ordblks; / * Number of free chunks * /
311 * size_t smblks; / * Number of free fastbin blocks * /
312 * size_t hblks; / * Number of mmapped regions * /
313 * size_t hblkhd; / * Space allocated in mmapped regions (bytes) * /
314 * size_t usmblks; / * Maximum total allocated space (bytes) * /
315 * size_t fsmblks; / * Space in freed fastbin blocks (bytes) * /
316 * size_t uordblks; / * Total allocated space (bytes) * /
317 * size_t fordblks; / * Total free space (bytes) * /
318 * size_t keepcost; / * Top-most, releasable space (bytes) * /
323 format_msize (u8 * s, va_list * va)
325 uword a = va_arg (*va, uword);
328 s = format (s, "%.2fG", (((f64) a) / ((f64) (1ULL << 30))));
329 else if (a >= 1ULL << 20)
330 s = format (s, "%.2fM", (((f64) a) / ((f64) (1ULL << 20))));
331 else if (a >= 1ULL << 10)
332 s = format (s, "%.2fK", (((f64) a) / ((f64) (1ULL << 10))));
334 s = format (s, "%lld", a);
339 mheap_trace_sort (const void *_t1, const void *_t2)
341 const mheap_trace_t *t1 = _t1;
342 const mheap_trace_t *t2 = _t2;
345 cmp = (word) t2->n_bytes - (word) t1->n_bytes;
347 cmp = (word) t2->n_allocations - (word) t1->n_allocations;
352 format_mheap_trace (u8 * s, va_list * va)
354 mheap_trace_main_t *tm = va_arg (*va, mheap_trace_main_t *);
355 int verbose = va_arg (*va, int);
359 clib_spinlock_lock (&tm->lock);
360 if (vec_len (tm->traces) > 0 &&
361 clib_mem_get_heap () == tm->current_traced_mheap)
365 /* Make a copy of traces since we'll be sorting them. */
366 mheap_trace_t *t, *traces_copy;
367 u32 indent, total_objects_traced;
369 traces_copy = vec_dup (tm->traces);
371 qsort (traces_copy, vec_len (traces_copy), sizeof (traces_copy[0]),
374 total_objects_traced = 0;
375 s = format (s, "\n");
376 vec_foreach (t, traces_copy)
378 /* Skip over free elements. */
379 if (t->n_allocations == 0)
382 total_objects_traced += t->n_allocations;
384 /* When not verbose only report allocations of more than 1k. */
385 if (!verbose && t->n_bytes < 1024)
388 if (t == traces_copy)
389 s = format (s, "%=9s%=9s %=10s Traceback\n", "Bytes", "Count",
391 s = format (s, "%9d%9d %p", t->n_bytes, t->n_allocations, t->offset);
392 indent = format_get_indent (s);
393 for (i = 0; i < ARRAY_LEN (t->callers) && t->callers[i]; i++)
396 s = format (s, "%U", format_white_space, indent);
397 #if defined(CLIB_UNIX) && !defined(__APPLE__)
398 /* $$$$ does this actually work? */
400 format (s, " %U\n", format_clib_elf_symbol_with_address,
403 s = format (s, " %p\n", t->callers[i]);
408 s = format (s, "%d total traced objects\n", total_objects_traced);
410 vec_free (traces_copy);
412 clib_spinlock_unlock (&tm->lock);
413 if (have_traces == 0)
414 s = format (s, "no traced allocations\n");
420 format_clib_mem_heap (u8 * s, va_list * va)
422 clib_mem_heap_t *heap = va_arg (*va, clib_mem_heap_t *);
423 int verbose = va_arg (*va, int);
424 struct dlmallinfo mi;
425 mheap_trace_main_t *tm = &mheap_trace_main;
426 u32 indent = format_get_indent (s) + 2;
429 heap = clib_mem_get_heap ();
431 mi = mspace_mallinfo (heap->mspace);
433 s = format (s, "base %p, size %U",
434 heap->base, format_memory_size, heap->size);
437 if (heap->flags & CLIB_MEM_HEAP_F_##v) s = format (s, ", %s", str);
438 foreach_clib_mem_heap_flag;
441 s = format (s, ", name '%s'", heap->name);
443 if (heap->log2_page_sz != CLIB_MEM_PAGE_SZ_UNKNOWN)
445 clib_mem_page_stats_t stats;
446 clib_mem_get_page_stats (heap->base, heap->log2_page_sz,
447 heap->size >> heap->log2_page_sz, &stats);
448 s = format (s, "\n%U%U", format_white_space, indent,
449 format_clib_mem_page_stats, &stats);
452 s = format (s, "\n%Utotal: %U, used: %U, free: %U, trimmable: %U",
453 format_white_space, indent,
454 format_msize, mi.arena,
455 format_msize, mi.uordblks,
456 format_msize, mi.fordblks, format_msize, mi.keepcost);
459 s = format (s, "\n%Ufree chunks %llu free fastbin blks %llu",
460 format_white_space, indent + 2, mi.ordblks, mi.smblks);
461 s = format (s, "\n%Umax total allocated %U",
462 format_white_space, indent + 2, format_msize, mi.usmblks);
465 if (mspace_is_traced (heap->mspace))
466 s = format (s, "\n%U", format_mheap_trace, tm, verbose);
471 clib_mem_get_heap_usage (clib_mem_heap_t * heap, clib_mem_usage_t * usage)
473 struct dlmallinfo mi = mspace_mallinfo (heap->mspace);
475 /* TODO: Fill in some more values */
476 usage->object_count = 0;
477 usage->bytes_total = mi.arena;
478 usage->bytes_overhead = 0;
479 usage->bytes_max = 0;
480 usage->bytes_used = mi.uordblks;
481 usage->bytes_free = mi.fordblks;
482 usage->bytes_free_reclaimed = 0;
485 /* Call serial number for debugger breakpoints. */
486 uword clib_mem_validate_serial = 0;
489 mheap_trace (clib_mem_heap_t * h, int enable)
491 (void) mspace_enable_disable_trace (h->mspace, enable);
494 mheap_trace_main_free (&mheap_trace_main);
498 clib_mem_trace (int enable)
500 mheap_trace_main_t *tm = &mheap_trace_main;
501 void *current_heap = clib_mem_get_heap ();
503 tm->enabled = enable;
504 mheap_trace (current_heap, enable);
507 tm->current_traced_mheap = current_heap;
509 tm->current_traced_mheap = 0;
513 clib_mem_is_traced (void)
515 clib_mem_heap_t *h = clib_mem_get_heap ();
516 return mspace_is_traced (h->mspace);
520 clib_mem_trace_enable_disable (uword enable)
523 mheap_trace_main_t *tm = &mheap_trace_main;
526 tm->enabled = enable;
530 __clib_export clib_mem_heap_t *
531 clib_mem_create_heap (void *base, uword size, int is_locked, char *fmt, ...)
533 clib_mem_page_sz_t log2_page_sz = clib_mem_get_log2_page_size ();
542 else if (strchr (fmt, '%'))
546 s = va_format (0, fmt, &va);
554 h = clib_mem_create_heap_internal (base, size, log2_page_sz, is_locked,
561 clib_mem_destroy_heap (clib_mem_heap_t * h)
563 mheap_trace_main_t *tm = &mheap_trace_main;
565 if (tm->enabled && h->mspace == tm->current_traced_mheap)
568 destroy_mspace (h->mspace);
569 if (h->flags & CLIB_MEM_HEAP_F_UNMAP_ON_DESTROY)
570 clib_mem_vm_unmap (h->base);
574 clib_mem_get_heap_free_space (clib_mem_heap_t * h)
576 struct dlmallinfo dlminfo = mspace_mallinfo (h->mspace);
577 return dlminfo.fordblks;
581 clib_mem_get_heap_base (clib_mem_heap_t * h)
587 clib_mem_get_heap_size (clib_mem_heap_t * heap)
593 * fd.io coding-style-patch-verification: ON
596 * eval: (c-set-style "gnu")