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>
25 /* Address of callers: outer first, inner last. */
28 /* Count of allocations with this traceback. */
31 /* Count of bytes allocated with this traceback. */
34 /* Offset of this item */
43 mheap_trace_t *traces;
45 /* Indices of free traces. */
48 /* Hash table mapping callers to trace index. */
49 uword *trace_by_callers;
51 /* Hash table mapping mheap offset to trace index. */
52 uword *trace_index_by_offset;
54 /* So we can easily shut off current segment trace, if any */
55 void *current_traced_mheap;
59 mheap_trace_main_t mheap_trace_main;
62 mheap_get_trace (uword offset, uword size)
64 mheap_trace_main_t *tm = &mheap_trace_main;
66 uword i, n_callers, trace_index, *p;
70 if (tm->enabled == 0 || (clib_mem_get_heap () != tm->current_traced_mheap))
73 /* Spurious Coverity warnings be gone. */
74 clib_memset (&trace, 0, sizeof (trace));
76 clib_spinlock_lock (&tm->lock);
78 /* Turn off tracing to avoid embarrassment... */
79 save_enabled = tm->enabled;
82 /* Skip our frame and mspace_get_aligned's frame */
83 n_callers = clib_backtrace (trace.callers, ARRAY_LEN (trace.callers), 2);
87 if (!tm->trace_by_callers)
88 tm->trace_by_callers =
89 hash_create_shmem (0, sizeof (trace.callers), sizeof (uword));
91 p = hash_get_mem (tm->trace_by_callers, &trace.callers);
95 t = tm->traces + trace_index;
99 i = vec_len (tm->trace_free_list);
102 trace_index = tm->trace_free_list[i - 1];
103 vec_set_len (tm->trace_free_list, i - 1);
107 mheap_trace_t *old_start = tm->traces;
108 mheap_trace_t *old_end = vec_end (tm->traces);
110 vec_add2 (tm->traces, t, 1);
112 if (tm->traces != old_start)
117 hash_foreach_pair (p, tm->trace_by_callers,
119 q = uword_to_pointer (p->key, mheap_trace_t *);
120 ASSERT (q >= old_start && q < old_end);
121 p->key = pointer_to_uword (tm->traces + (q - old_start));
125 trace_index = t - tm->traces;
128 t = tm->traces + trace_index;
130 t->n_allocations = 0;
132 hash_set_mem (tm->trace_by_callers, t->callers, trace_index);
135 t->n_allocations += 1;
137 t->offset = offset; /* keep a sample to autopsy */
138 hash_set (tm->trace_index_by_offset, offset, t - tm->traces);
141 tm->enabled = save_enabled;
142 clib_spinlock_unlock (&tm->lock);
146 mheap_put_trace (uword offset, uword size)
149 uword trace_index, *p;
150 mheap_trace_main_t *tm = &mheap_trace_main;
153 if (tm->enabled == 0)
156 clib_spinlock_lock (&tm->lock);
158 /* Turn off tracing for a moment */
159 save_enabled = tm->enabled;
162 p = hash_get (tm->trace_index_by_offset, offset);
165 tm->enabled = save_enabled;
166 clib_spinlock_unlock (&tm->lock);
171 hash_unset (tm->trace_index_by_offset, offset);
172 ASSERT (trace_index < vec_len (tm->traces));
174 t = tm->traces + trace_index;
175 ASSERT (t->n_allocations > 0);
176 ASSERT (t->n_bytes >= size);
177 t->n_allocations -= 1;
179 if (t->n_allocations == 0)
181 hash_unset_mem (tm->trace_by_callers, t->callers);
182 vec_add1 (tm->trace_free_list, trace_index);
183 clib_memset (t, 0, sizeof (t[0]));
185 tm->enabled = save_enabled;
186 clib_spinlock_unlock (&tm->lock);
190 mheap_trace_main_free (mheap_trace_main_t * tm)
192 vec_free (tm->traces);
193 vec_free (tm->trace_free_list);
194 hash_free (tm->trace_by_callers);
195 hash_free (tm->trace_index_by_offset);
198 static clib_mem_heap_t *
199 clib_mem_create_heap_internal (void *base, uword size,
200 clib_mem_page_sz_t log2_page_sz, int is_locked,
205 int sz = sizeof (clib_mem_heap_t);
209 log2_page_sz = clib_mem_log2_page_size_validate (log2_page_sz);
210 size = round_pow2 (size, clib_mem_page_bytes (log2_page_sz));
211 base = clib_mem_vm_map_internal (0, log2_page_sz, size, -1, 0,
214 if (base == CLIB_MEM_VM_MAP_FAILED)
217 flags = CLIB_MEM_HEAP_F_UNMAP_ON_DESTROY;
220 log2_page_sz = CLIB_MEM_PAGE_SZ_UNKNOWN;
223 flags |= CLIB_MEM_HEAP_F_LOCKED;
228 h->log2_page_sz = log2_page_sz;
231 strcpy (h->name, name);
232 sz = round_pow2 (sz + sizeof (clib_mem_heap_t), 16);
233 h->mspace = create_mspace_with_base (base + sz, size - sz, is_locked);
235 mspace_disable_expand (h->mspace);
237 clib_mem_poison (mspace_least_addr (h->mspace),
238 mspace_footprint (h->mspace));
243 /* Initialize CLIB heap based on memory/size given by user.
244 Set memory to 0 and CLIB will try to allocate its own heap. */
246 clib_mem_init_internal (void *base, uword size,
247 clib_mem_page_sz_t log2_page_sz)
251 clib_mem_main_init ();
253 h = clib_mem_create_heap_internal (base, size, log2_page_sz,
254 1 /*is_locked */ , "main heap");
256 clib_mem_set_heap (h);
258 if (mheap_trace_main.lock == 0)
259 clib_spinlock_init (&mheap_trace_main.lock);
265 clib_mem_init (void *memory, uword memory_size)
267 return clib_mem_init_internal (memory, memory_size,
268 CLIB_MEM_PAGE_SZ_DEFAULT);
272 clib_mem_init_with_page_size (uword memory_size,
273 clib_mem_page_sz_t log2_page_sz)
275 return clib_mem_init_internal (0, memory_size, log2_page_sz);
279 clib_mem_init_thread_safe (void *memory, uword memory_size)
281 return clib_mem_init_internal (memory, memory_size,
282 CLIB_MEM_PAGE_SZ_DEFAULT);
286 clib_mem_destroy (void)
288 mheap_trace_main_t *tm = &mheap_trace_main;
289 clib_mem_heap_t *heap = clib_mem_get_heap ();
291 if (tm->enabled && heap->mspace == tm->current_traced_mheap)
294 destroy_mspace (heap->mspace);
295 clib_mem_vm_unmap (heap);
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 (heap->flags & CLIB_MEM_HEAP_F_TRACED)
466 s = format (s, "\n%U", format_mheap_trace, tm, verbose);
470 __clib_export __clib_flatten void
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 usage->bytes_total = mi.arena; /* non-mmapped space allocated from system */
476 usage->bytes_used = mi.uordblks; /* total allocated space */
477 usage->bytes_free = mi.fordblks; /* total free space */
478 usage->bytes_used_mmap = mi.hblkhd; /* space in mmapped regions */
479 usage->bytes_max = mi.usmblks; /* maximum total allocated space */
480 usage->bytes_free_reclaimed = mi.ordblks; /* number of free chunks */
481 usage->bytes_overhead = mi.keepcost; /* releasable (via malloc_trim) space */
484 usage->bytes_used_sbrk = 0;
485 usage->object_count = 0;
488 /* Call serial number for debugger breakpoints. */
489 uword clib_mem_validate_serial = 0;
492 mheap_trace (clib_mem_heap_t * h, int enable)
495 h->flags |= CLIB_MEM_HEAP_F_TRACED;
497 h->flags &= ~CLIB_MEM_HEAP_F_TRACED;
500 mheap_trace_main_free (&mheap_trace_main);
504 clib_mem_trace (int enable)
506 mheap_trace_main_t *tm = &mheap_trace_main;
507 void *current_heap = clib_mem_get_heap ();
509 tm->enabled = enable;
510 mheap_trace (current_heap, enable);
513 tm->current_traced_mheap = current_heap;
515 tm->current_traced_mheap = 0;
519 clib_mem_is_traced (void)
521 clib_mem_heap_t *h = clib_mem_get_heap ();
522 return (h->flags &= CLIB_MEM_HEAP_F_TRACED) != 0;
526 clib_mem_trace_enable_disable (uword enable)
529 mheap_trace_main_t *tm = &mheap_trace_main;
532 tm->enabled = enable;
536 __clib_export clib_mem_heap_t *
537 clib_mem_create_heap (void *base, uword size, int is_locked, char *fmt, ...)
539 clib_mem_page_sz_t log2_page_sz = clib_mem_get_log2_page_size ();
548 else if (strchr (fmt, '%'))
552 s = va_format (0, fmt, &va);
560 h = clib_mem_create_heap_internal (base, size, log2_page_sz, is_locked,
567 clib_mem_destroy_heap (clib_mem_heap_t * h)
569 mheap_trace_main_t *tm = &mheap_trace_main;
571 if (tm->enabled && h->mspace == tm->current_traced_mheap)
574 destroy_mspace (h->mspace);
575 if (h->flags & CLIB_MEM_HEAP_F_UNMAP_ON_DESTROY)
576 clib_mem_vm_unmap (h->base);
579 __clib_export __clib_flatten uword
580 clib_mem_get_heap_free_space (clib_mem_heap_t *h)
582 struct dlmallinfo dlminfo = mspace_mallinfo (h->mspace);
583 return dlminfo.fordblks;
586 __clib_export __clib_flatten void *
587 clib_mem_get_heap_base (clib_mem_heap_t *h)
592 __clib_export __clib_flatten uword
593 clib_mem_get_heap_size (clib_mem_heap_t *heap)
598 /* Memory allocator which may call os_out_of_memory() if it fails */
600 clib_mem_heap_alloc_inline (void *heap, uword size, uword align,
601 int os_out_of_memory_on_failure)
603 clib_mem_heap_t *h = heap ? heap : clib_mem_get_per_cpu_heap ();
606 align = clib_max (CLIB_MEM_MIN_ALIGN, align);
608 p = mspace_memalign (h->mspace, align, size);
610 if (PREDICT_FALSE (0 == p))
612 if (os_out_of_memory_on_failure)
617 if (PREDICT_FALSE (h->flags & CLIB_MEM_HEAP_F_TRACED))
618 mheap_get_trace (pointer_to_uword (p), clib_mem_size (p));
620 clib_mem_unpoison (p, size);
624 /* Memory allocator which calls os_out_of_memory() when it fails */
625 __clib_export __clib_flatten void *
626 clib_mem_alloc (uword size)
628 return clib_mem_heap_alloc_inline (0, size, CLIB_MEM_MIN_ALIGN,
629 /* os_out_of_memory */ 1);
632 __clib_export __clib_flatten void *
633 clib_mem_alloc_aligned (uword size, uword align)
635 return clib_mem_heap_alloc_inline (0, size, align,
636 /* os_out_of_memory */ 1);
639 /* Memory allocator which calls os_out_of_memory() when it fails */
640 __clib_export __clib_flatten void *
641 clib_mem_alloc_or_null (uword size)
643 return clib_mem_heap_alloc_inline (0, size, CLIB_MEM_MIN_ALIGN,
644 /* os_out_of_memory */ 0);
647 __clib_export __clib_flatten void *
648 clib_mem_alloc_aligned_or_null (uword size, uword align)
650 return clib_mem_heap_alloc_inline (0, size, align,
651 /* os_out_of_memory */ 0);
654 __clib_export __clib_flatten void *
655 clib_mem_heap_alloc (void *heap, uword size)
657 return clib_mem_heap_alloc_inline (heap, size, CLIB_MEM_MIN_ALIGN,
658 /* os_out_of_memory */ 1);
661 __clib_export __clib_flatten void *
662 clib_mem_heap_alloc_aligned (void *heap, uword size, uword align)
664 return clib_mem_heap_alloc_inline (heap, size, align,
665 /* os_out_of_memory */ 1);
668 __clib_export __clib_flatten void *
669 clib_mem_heap_alloc_or_null (void *heap, uword size)
671 return clib_mem_heap_alloc_inline (heap, size, CLIB_MEM_MIN_ALIGN,
672 /* os_out_of_memory */ 0);
675 __clib_export __clib_flatten void *
676 clib_mem_heap_alloc_aligned_or_null (void *heap, uword size, uword align)
678 return clib_mem_heap_alloc_inline (heap, size, align,
679 /* os_out_of_memory */ 0);
682 __clib_export __clib_flatten void *
683 clib_mem_heap_realloc_aligned (void *heap, void *p, uword new_size,
686 uword old_alloc_size;
687 clib_mem_heap_t *h = heap ? heap : clib_mem_get_per_cpu_heap ();
690 ASSERT (count_set_bits (align) == 1);
692 old_alloc_size = p ? mspace_usable_size (p) : 0;
694 if (new_size == old_alloc_size)
697 if (p && pointer_is_aligned (p, align) &&
698 mspace_realloc_in_place (h->mspace, p, new_size))
700 clib_mem_unpoison (p, new_size);
701 if (PREDICT_FALSE (h->flags & CLIB_MEM_HEAP_F_TRACED))
703 mheap_put_trace (pointer_to_uword (p), old_alloc_size);
704 mheap_get_trace (pointer_to_uword (p), clib_mem_size (p));
709 new = clib_mem_heap_alloc_inline (h, new_size, align, 1);
711 clib_mem_unpoison (new, new_size);
714 clib_mem_unpoison (p, old_alloc_size);
715 clib_memcpy_fast (new, p, clib_min (new_size, old_alloc_size));
716 clib_mem_heap_free (h, p);
724 __clib_export __clib_flatten void *
725 clib_mem_heap_realloc (void *heap, void *p, uword new_size)
727 return clib_mem_heap_realloc_aligned (heap, p, new_size, CLIB_MEM_MIN_ALIGN);
730 __clib_export __clib_flatten void *
731 clib_mem_realloc_aligned (void *p, uword new_size, uword align)
733 return clib_mem_heap_realloc_aligned (0, p, new_size, align);
736 __clib_export __clib_flatten void *
737 clib_mem_realloc (void *p, uword new_size)
739 return clib_mem_heap_realloc_aligned (0, p, new_size, CLIB_MEM_MIN_ALIGN);
742 __clib_export __clib_flatten uword
743 clib_mem_heap_is_heap_object (void *heap, void *p)
745 clib_mem_heap_t *h = heap ? heap : clib_mem_get_per_cpu_heap ();
746 return mspace_is_heap_object (h->mspace, p);
749 __clib_export __clib_flatten uword
750 clib_mem_is_heap_object (void *p)
752 return clib_mem_heap_is_heap_object (0, p);
755 __clib_export __clib_flatten void
756 clib_mem_heap_free (void *heap, void *p)
758 clib_mem_heap_t *h = heap ? heap : clib_mem_get_per_cpu_heap ();
759 uword size = clib_mem_size (p);
761 /* Make sure object is in the correct heap. */
762 ASSERT (clib_mem_heap_is_heap_object (h, p));
764 if (PREDICT_FALSE (h->flags & CLIB_MEM_HEAP_F_TRACED))
765 mheap_put_trace (pointer_to_uword (p), size);
766 clib_mem_poison (p, clib_mem_size (p));
768 mspace_free (h->mspace, p);
771 __clib_export __clib_flatten void
772 clib_mem_free (void *p)
774 clib_mem_heap_free (0, p);
777 __clib_export __clib_flatten uword
778 clib_mem_size (void *p)
780 return mspace_usable_size (p);
784 clib_mem_free_s (void *p)
786 uword size = clib_mem_size (p);
787 clib_mem_unpoison (p, size);
788 memset_s_inline (p, size, 0, size);