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 /* Initialize CLIB heap based on memory/size given by user.
198 Set memory to 0 and CLIB will try to allocate its own heap. */
200 clib_mem_init_internal (void *memory, uword memory_size, int set_heap)
206 heap = create_mspace_with_base (memory, memory_size, 1 /* locked */ );
207 mspace_disable_expand (heap);
210 heap = create_mspace (memory_size, 1 /* locked */ );
212 CLIB_MEM_POISON (mspace_least_addr (heap), mspace_footprint (heap));
215 clib_mem_set_heap (heap);
217 if (mheap_trace_main.lock == 0)
218 clib_spinlock_init (&mheap_trace_main.lock);
224 clib_mem_init (void *memory, uword memory_size)
226 return clib_mem_init_internal (memory, memory_size,
227 1 /* do clib_mem_set_heap */ );
231 clib_mem_init_thread_safe (void *memory, uword memory_size)
233 return clib_mem_init_internal (memory, memory_size,
234 1 /* do clib_mem_set_heap */ );
238 clib_mem_destroy_mspace (void *mspace)
240 mheap_trace_main_t *tm = &mheap_trace_main;
242 if (tm->enabled && mspace == tm->current_traced_mheap)
245 destroy_mspace (mspace);
249 clib_mem_destroy (void)
251 clib_mem_destroy_mspace (clib_mem_get_heap ());
255 clib_mem_init_thread_safe_numa (void *memory, uword memory_size, u8 numa)
257 clib_mem_vm_alloc_t alloc = { 0 };
261 alloc.size = memory_size;
262 alloc.flags = CLIB_MEM_VM_F_NUMA_FORCE;
263 alloc.numa_node = numa;
264 if ((err = clib_mem_vm_ext_alloc (&alloc)))
266 clib_error_report (err);
270 heap = clib_mem_init_internal (memory, memory_size,
271 0 /* do NOT clib_mem_set_heap */ );
279 format_clib_mem_usage (u8 * s, va_list * va)
281 int verbose = va_arg (*va, int);
282 return format (s, "$$$$ heap at %llx verbose %d", clib_mem_get_heap (),
287 * Magic decoder ring for mallinfo stats (ala dlmalloc):
289 * size_t arena; / * Non-mmapped space allocated (bytes) * /
290 * size_t ordblks; / * Number of free chunks * /
291 * size_t smblks; / * Number of free fastbin blocks * /
292 * size_t hblks; / * Number of mmapped regions * /
293 * size_t hblkhd; / * Space allocated in mmapped regions (bytes) * /
294 * size_t usmblks; / * Maximum total allocated space (bytes) * /
295 * size_t fsmblks; / * Space in freed fastbin blocks (bytes) * /
296 * size_t uordblks; / * Total allocated space (bytes) * /
297 * size_t fordblks; / * Total free space (bytes) * /
298 * size_t keepcost; / * Top-most, releasable space (bytes) * /
303 format_msize (u8 * s, va_list * va)
305 uword a = va_arg (*va, uword);
308 s = format (s, "%.2fG", (((f64) a) / ((f64) (1ULL << 30))));
309 else if (a >= 1ULL << 20)
310 s = format (s, "%.2fM", (((f64) a) / ((f64) (1ULL << 20))));
311 else if (a >= 1ULL << 10)
312 s = format (s, "%.2fK", (((f64) a) / ((f64) (1ULL << 10))));
314 s = format (s, "%lld", a);
319 mheap_trace_sort (const void *_t1, const void *_t2)
321 const mheap_trace_t *t1 = _t1;
322 const mheap_trace_t *t2 = _t2;
325 cmp = (word) t2->n_bytes - (word) t1->n_bytes;
327 cmp = (word) t2->n_allocations - (word) t1->n_allocations;
332 format_mheap_trace (u8 * s, va_list * va)
334 mheap_trace_main_t *tm = va_arg (*va, mheap_trace_main_t *);
335 int verbose = va_arg (*va, int);
339 clib_spinlock_lock (&tm->lock);
340 if (vec_len (tm->traces) > 0 &&
341 clib_mem_get_heap () == tm->current_traced_mheap)
345 /* Make a copy of traces since we'll be sorting them. */
346 mheap_trace_t *t, *traces_copy;
347 u32 indent, total_objects_traced;
349 traces_copy = vec_dup (tm->traces);
351 qsort (traces_copy, vec_len (traces_copy), sizeof (traces_copy[0]),
354 total_objects_traced = 0;
355 s = format (s, "\n");
356 vec_foreach (t, traces_copy)
358 /* Skip over free elements. */
359 if (t->n_allocations == 0)
362 total_objects_traced += t->n_allocations;
364 /* When not verbose only report allocations of more than 1k. */
365 if (!verbose && t->n_bytes < 1024)
368 if (t == traces_copy)
369 s = format (s, "%=9s%=9s %=10s Traceback\n", "Bytes", "Count",
371 s = format (s, "%9d%9d %p", t->n_bytes, t->n_allocations, t->offset);
372 indent = format_get_indent (s);
373 for (i = 0; i < ARRAY_LEN (t->callers) && t->callers[i]; i++)
376 s = format (s, "%U", format_white_space, indent);
377 #if defined(CLIB_UNIX) && !defined(__APPLE__)
378 /* $$$$ does this actually work? */
380 format (s, " %U\n", format_clib_elf_symbol_with_address,
383 s = format (s, " %p\n", t->callers[i]);
388 s = format (s, "%d total traced objects\n", total_objects_traced);
390 vec_free (traces_copy);
392 clib_spinlock_unlock (&tm->lock);
393 if (have_traces == 0)
394 s = format (s, "no traced allocations\n");
401 format_mheap (u8 * s, va_list * va)
403 void *heap = va_arg (*va, u8 *);
404 int verbose = va_arg (*va, int);
405 struct dlmallinfo mi;
406 mheap_trace_main_t *tm = &mheap_trace_main;
408 mi = mspace_mallinfo (heap);
410 s = format (s, "total: %U, used: %U, free: %U, trimmable: %U",
411 format_msize, mi.arena,
412 format_msize, mi.uordblks,
413 format_msize, mi.fordblks, format_msize, mi.keepcost);
416 s = format (s, "\n free chunks %llu free fastbin blks %llu",
417 mi.ordblks, mi.smblks);
419 format (s, "\n max total allocated %U", format_msize, mi.usmblks);
422 if (mspace_is_traced (heap))
423 s = format (s, "\n%U", format_mheap_trace, tm, verbose);
428 clib_mem_usage (clib_mem_usage_t * u)
430 clib_warning ("unimp");
434 mheap_usage (void *heap, clib_mem_usage_t * usage)
436 struct dlmallinfo mi = mspace_mallinfo (heap);
438 /* TODO: Fill in some more values */
439 usage->object_count = 0;
440 usage->bytes_total = mi.arena;
441 usage->bytes_overhead = 0;
442 usage->bytes_max = 0;
443 usage->bytes_used = mi.uordblks;
444 usage->bytes_free = mi.fordblks;
445 usage->bytes_free_reclaimed = 0;
448 /* Call serial number for debugger breakpoints. */
449 uword clib_mem_validate_serial = 0;
452 clib_mem_validate (void)
454 clib_warning ("unimp");
458 mheap_trace (void *v, int enable)
460 (void) mspace_enable_disable_trace (v, enable);
463 mheap_trace_main_free (&mheap_trace_main);
467 clib_mem_trace (int enable)
469 mheap_trace_main_t *tm = &mheap_trace_main;
470 void *current_heap = clib_mem_get_heap ();
472 tm->enabled = enable;
473 mheap_trace (current_heap, enable);
476 tm->current_traced_mheap = current_heap;
478 tm->current_traced_mheap = 0;
482 clib_mem_is_traced (void)
484 return mspace_is_traced (clib_mem_get_heap ());
488 clib_mem_trace_enable_disable (uword enable)
491 mheap_trace_main_t *tm = &mheap_trace_main;
494 tm->enabled = enable;
499 * These API functions seem like layering violations, but
500 * by introducing them we greatly reduce the number
501 * of code changes required to use dlmalloc spaces
504 mheap_alloc_with_lock (void *memory, uword size, int locked)
508 return create_mspace (size, locked);
511 rv = create_mspace_with_base (memory, size, locked);
513 mspace_disable_expand (rv);
519 * fd.io coding-style-patch-verification: ON
522 * eval: (c-set-style "gnu")