src/vppinfra/mem_dlmalloc.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  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>
  23
  24 void *clib_per_cpu_mheaps[CLIB_MAX_MHEAPS];
  25
  26 typedef struct
  27 {
  28   /* Address of callers: outer first, inner last. */
  29   uword callers[12];
  30
  31   /* Count of allocations with this traceback. */
  32 #if CLIB_VEC64 > 0
  33   u64 n_allocations;
  34 #else
  35   u32 n_allocations;
  36 #endif
  37
  38   /* Count of bytes allocated with this traceback. */
  39   u32 n_bytes;
  40
  41   /* Offset of this item */
  42   uword offset;
  43 } mheap_trace_t;
  44
  45 typedef struct
  46 {
  47   clib_spinlock_t lock;
  48   uword enabled;
  49
  50   mheap_trace_t *traces;
  51
  52   /* Indices of free traces. */
  53   u32 *trace_free_list;
  54
  55   /* Hash table mapping callers to trace index. */
  56   uword *trace_by_callers;
  57
  58   /* Hash table mapping mheap offset to trace index. */
  59   uword *trace_index_by_offset;
  60
  61   /* So we can easily shut off current segment trace, if any */
  62   void *current_traced_mheap;
  63
  64 } mheap_trace_main_t;
  65
  66 mheap_trace_main_t mheap_trace_main;
  67
  68 void
  69 mheap_get_trace (uword offset, uword size)
  70 {
  71   mheap_trace_main_t *tm = &mheap_trace_main;
  72   mheap_trace_t *t;
  73   uword i, n_callers, trace_index, *p;
  74   mheap_trace_t trace;
  75   uword save_enabled;
  76
  77   if (tm->enabled == 0 || (clib_mem_get_heap () != tm->current_traced_mheap))
  78     return;
  79
  80   /* Spurious Coverity warnings be gone. */
  81   clib_memset (&trace, 0, sizeof (trace));
  82
  83   /* Skip our frame and mspace_get_aligned's frame */
  84   n_callers = clib_backtrace (trace.callers, ARRAY_LEN (trace.callers), 2);
  85   if (n_callers == 0)
  86     return;
  87
  88   clib_spinlock_lock (&tm->lock);
  89
  90   /* Turn off tracing to avoid embarrassment... */
  91   save_enabled = tm->enabled;
  92   tm->enabled = 0;
  93
  94   if (!tm->trace_by_callers)
  95     tm->trace_by_callers =
  96       hash_create_shmem (0, sizeof (trace.callers), sizeof (uword));
  97
  98   p = hash_get_mem (tm->trace_by_callers, &trace.callers);
  99   if (p)
 100     {
 101       trace_index = p[0];
 102       t = tm->traces + trace_index;
 103     }
 104   else
 105     {
 106       i = vec_len (tm->trace_free_list);
 107       if (i > 0)
 108         {
 109           trace_index = tm->trace_free_list[i - 1];
 110           _vec_len (tm->trace_free_list) = i - 1;
 111         }
 112       else
 113         {
 114           mheap_trace_t *old_start = tm->traces;
 115           mheap_trace_t *old_end = vec_end (tm->traces);
 116
 117           vec_add2 (tm->traces, t, 1);
 118
 119           if (tm->traces != old_start)
 120             {
 121               hash_pair_t *p;
 122               mheap_trace_t *q;
 123             /* *INDENT-OFF* */
 124             hash_foreach_pair (p, tm->trace_by_callers,
 125             ({
 126               q = uword_to_pointer (p->key, mheap_trace_t *);
 127               ASSERT (q >= old_start && q < old_end);
 128               p->key = pointer_to_uword (tm->traces + (q - old_start));
 129             }));
 130             /* *INDENT-ON* */
 131             }
 132           trace_index = t - tm->traces;
 133         }
 134
 135       t = tm->traces + trace_index;
 136       t[0] = trace;
 137       t->n_allocations = 0;
 138       t->n_bytes = 0;
 139       hash_set_mem (tm->trace_by_callers, t->callers, trace_index);
 140     }
 141
 142   t->n_allocations += 1;
 143   t->n_bytes += size;
 144   t->offset = offset;           /* keep a sample to autopsy */
 145   hash_set (tm->trace_index_by_offset, offset, t - tm->traces);
 146   tm->enabled = save_enabled;
 147   clib_spinlock_unlock (&tm->lock);
 148 }
 149
 150 void
 151 mheap_put_trace (uword offset, uword size)
 152 {
 153   mheap_trace_t *t;
 154   uword trace_index, *p;
 155   mheap_trace_main_t *tm = &mheap_trace_main;
 156   uword save_enabled;
 157
 158   if (tm->enabled == 0)
 159     return;
 160
 161   clib_spinlock_lock (&tm->lock);
 162
 163   /* Turn off tracing for a moment */
 164   save_enabled = tm->enabled;
 165   tm->enabled = 0;
 166
 167   p = hash_get (tm->trace_index_by_offset, offset);
 168   if (!p)
 169     {
 170       tm->enabled = save_enabled;
 171       clib_spinlock_unlock (&tm->lock);
 172       return;
 173     }
 174
 175   trace_index = p[0];
 176   hash_unset (tm->trace_index_by_offset, offset);
 177   ASSERT (trace_index < vec_len (tm->traces));
 178
 179   t = tm->traces + trace_index;
 180   ASSERT (t->n_allocations > 0);
 181   ASSERT (t->n_bytes >= size);
 182   t->n_allocations -= 1;
 183   t->n_bytes -= size;
 184   if (t->n_allocations == 0)
 185     {
 186       hash_unset_mem (tm->trace_by_callers, t->callers);
 187       vec_add1 (tm->trace_free_list, trace_index);
 188       clib_memset (t, 0, sizeof (t[0]));
 189     }
 190   tm->enabled = save_enabled;
 191   clib_spinlock_unlock (&tm->lock);
 192 }
 193
 194 always_inline void
 195 mheap_trace_main_free (mheap_trace_main_t * tm)
 196 {
 197   vec_free (tm->traces);
 198   vec_free (tm->trace_free_list);
 199   hash_free (tm->trace_by_callers);
 200   hash_free (tm->trace_index_by_offset);
 201 }
 202
 203 /* Initialize CLIB heap based on memory/size given by user.
 204    Set memory to 0 and CLIB will try to allocate its own heap. */
 205 void *
 206 clib_mem_init (void *memory, uword memory_size)
 207 {
 208   u8 *heap;
 209
 210   if (memory)
 211     {
 212       heap = create_mspace_with_base (memory, memory_size, 1 /* locked */ );
 213       mspace_disable_expand (heap);
 214     }
 215   else
 216     heap = create_mspace (memory_size, 1 /* locked */ );
 217
 218   clib_mem_set_heap (heap);
 219
 220   if (mheap_trace_main.lock == 0)
 221     clib_spinlock_init (&mheap_trace_main.lock);
 222
 223   CLIB_MEM_POISON (mspace_least_addr (heap), mspace_footprint (heap));
 224   return heap;
 225 }
 226
 227 void *
 228 clib_mem_init_thread_safe (void *memory, uword memory_size)
 229 {
 230   return clib_mem_init (memory, memory_size);
 231 }
 232
 233 u8 *
 234 format_clib_mem_usage (u8 * s, va_list * va)
 235 {
 236   int verbose = va_arg (*va, int);
 237   return format (s, "$$$$ heap at %llx verbose %d", clib_mem_get_heap (),
 238                  verbose);
 239 }
 240
 241 /*
 242  * Magic decoder ring for mallinfo stats (ala dlmalloc):
 243  *
 244  * size_t arena;     / * Non-mmapped space allocated (bytes) * /
 245  * size_t ordblks;   / * Number of free chunks * /
 246  * size_t smblks;    / * Number of free fastbin blocks * /
 247  * size_t hblks;     / * Number of mmapped regions * /
 248  * size_t hblkhd;    / * Space allocated in mmapped regions (bytes) * /
 249  * size_t usmblks;   / * Maximum total allocated space (bytes) * /
 250  * size_t fsmblks;   / * Space in freed fastbin blocks (bytes) * /
 251  * size_t uordblks;  / * Total allocated space (bytes) * /
 252  * size_t fordblks;  / * Total free space (bytes) * /
 253  * size_t keepcost;  / * Top-most, releasable space (bytes) * /
 254  *
 255  */
 256
 257 u8 *
 258 format_msize (u8 * s, va_list * va)
 259 {
 260   uword a = va_arg (*va, uword);
 261
 262   if (a >= 1ULL << 30)
 263     s = format (s, "%.2fG", (((f64) a) / ((f64) (1ULL << 30))));
 264   else if (a >= 1ULL << 20)
 265     s = format (s, "%.2fM", (((f64) a) / ((f64) (1ULL << 20))));
 266   else if (a >= 1ULL << 10)
 267     s = format (s, "%.2fK", (((f64) a) / ((f64) (1ULL << 10))));
 268   else
 269     s = format (s, "%lld", a);
 270   return s;
 271 }
 272
 273 static int
 274 mheap_trace_sort (const void *_t1, const void *_t2)
 275 {
 276   const mheap_trace_t *t1 = _t1;
 277   const mheap_trace_t *t2 = _t2;
 278   word cmp;
 279
 280   cmp = (word) t2->n_bytes - (word) t1->n_bytes;
 281   if (!cmp)
 282     cmp = (word) t2->n_allocations - (word) t1->n_allocations;
 283   return cmp;
 284 }
 285
 286 u8 *
 287 format_mheap_trace (u8 * s, va_list * va)
 288 {
 289   mheap_trace_main_t *tm = va_arg (*va, mheap_trace_main_t *);
 290   int verbose = va_arg (*va, int);
 291   int have_traces = 0;
 292   int i;
 293
 294   clib_spinlock_lock (&tm->lock);
 295   if (vec_len (tm->traces) > 0 &&
 296       clib_mem_get_heap () == tm->current_traced_mheap)
 297     {
 298       have_traces = 1;
 299
 300       /* Make a copy of traces since we'll be sorting them. */
 301       mheap_trace_t *t, *traces_copy;
 302       u32 indent, total_objects_traced;
 303
 304       traces_copy = vec_dup (tm->traces);
 305
 306       qsort (traces_copy, vec_len (traces_copy), sizeof (traces_copy[0]),
 307              mheap_trace_sort);
 308
 309       total_objects_traced = 0;
 310       s = format (s, "\n");
 311       vec_foreach (t, traces_copy)
 312       {
 313         /* Skip over free elements. */
 314         if (t->n_allocations == 0)
 315           continue;
 316
 317         total_objects_traced += t->n_allocations;
 318
 319         /* When not verbose only report allocations of more than 1k. */
 320         if (!verbose && t->n_bytes < 1024)
 321           continue;
 322
 323         if (t == traces_copy)
 324           s = format (s, "%=9s%=9s %=10s Traceback\n", "Bytes", "Count",
 325                       "Sample");
 326         s = format (s, "%9d%9d %p", t->n_bytes, t->n_allocations, t->offset);
 327         indent = format_get_indent (s);
 328         for (i = 0; i < ARRAY_LEN (t->callers) && t->callers[i]; i++)
 329           {
 330             if (i > 0)
 331               s = format (s, "%U", format_white_space, indent);
 332 #if defined(CLIB_UNIX) && !defined(__APPLE__)
 333             /* $$$$ does this actually work? */
 334             s =
 335               format (s, " %U\n", format_clib_elf_symbol_with_address,
 336                       t->callers[i]);
 337 #else
 338             s = format (s, " %p\n", t->callers[i]);
 339 #endif
 340           }
 341       }
 342
 343       s = format (s, "%d total traced objects\n", total_objects_traced);
 344
 345       vec_free (traces_copy);
 346     }
 347   clib_spinlock_unlock (&tm->lock);
 348   if (have_traces == 0)
 349     s = format (s, "no traced allocations\n");
 350
 351   return s;
 352 }
 353
 354
 355 u8 *
 356 format_mheap (u8 * s, va_list * va)
 357 {
 358   void *heap = va_arg (*va, u8 *);
 359   int verbose = va_arg (*va, int);
 360   struct dlmallinfo mi;
 361   mheap_trace_main_t *tm = &mheap_trace_main;
 362
 363   mi = mspace_mallinfo (heap);
 364
 365   s = format (s, "total: %U, used: %U, free: %U, trimmable: %U",
 366               format_msize, mi.arena,
 367               format_msize, mi.uordblks,
 368               format_msize, mi.fordblks, format_msize, mi.keepcost);
 369   if (verbose > 0)
 370     {
 371       s = format (s, "\n    free chunks %llu free fastbin blks %llu",
 372                   mi.ordblks, mi.smblks);
 373       s =
 374         format (s, "\n    max total allocated %U", format_msize, mi.usmblks);
 375     }
 376
 377   if (mspace_is_traced (heap))
 378     s = format (s, "\n%U", format_mheap_trace, tm, verbose);
 379   return s;
 380 }
 381
 382 void
 383 clib_mem_usage (clib_mem_usage_t * u)
 384 {
 385   clib_warning ("unimp");
 386 }
 387
 388 void
 389 mheap_usage (void *heap, clib_mem_usage_t * usage)
 390 {
 391   struct dlmallinfo mi = mspace_mallinfo (heap);
 392
 393   /* TODO: Fill in some more values */
 394   usage->object_count = 0;
 395   usage->bytes_total = mi.arena;
 396   usage->bytes_overhead = 0;
 397   usage->bytes_max = 0;
 398   usage->bytes_used = mi.uordblks;
 399   usage->bytes_free = mi.fordblks;
 400   usage->bytes_free_reclaimed = 0;
 401 }
 402
 403 /* Call serial number for debugger breakpoints. */
 404 uword clib_mem_validate_serial = 0;
 405
 406 void
 407 clib_mem_validate (void)
 408 {
 409   clib_warning ("unimp");
 410 }
 411
 412 void
 413 mheap_trace (void *v, int enable)
 414 {
 415   (void) mspace_enable_disable_trace (v, enable);
 416
 417   if (enable == 0)
 418     mheap_trace_main_free (&mheap_trace_main);
 419 }
 420
 421 void
 422 clib_mem_trace (int enable)
 423 {
 424   mheap_trace_main_t *tm = &mheap_trace_main;
 425   void *current_heap = clib_mem_get_heap ();
 426
 427   tm->enabled = enable;
 428   mheap_trace (current_heap, enable);
 429
 430   if (enable)
 431     tm->current_traced_mheap = current_heap;
 432   else
 433     tm->current_traced_mheap = 0;
 434 }
 435
 436 int
 437 clib_mem_is_traced (void)
 438 {
 439   return mspace_is_traced (clib_mem_get_heap ());
 440 }
 441
 442 uword
 443 clib_mem_trace_enable_disable (uword enable)
 444 {
 445   uword rv;
 446   mheap_trace_main_t *tm = &mheap_trace_main;
 447
 448   rv = tm->enabled;
 449   tm->enabled = enable;
 450   return rv;
 451 }
 452
 453 /*
 454  * These API functions seem like layering violations, but
 455  * by introducing them we greatly reduce the number
 456  * of code changes required to use dlmalloc spaces
 457  */
 458 void *
 459 mheap_alloc_with_lock (void *memory, uword size, int locked)
 460 {
 461   void *rv;
 462   if (memory == 0)
 463     return create_mspace (size, locked);
 464   else
 465     {
 466       rv = create_mspace_with_base (memory, size, locked);
 467       if (rv)
 468         mspace_disable_expand (rv);
 469       return rv;
 470     }
 471 }
 472
 473 /*
 474  * fd.io coding-style-patch-verification: ON
 475  *
 476  * Local Variables:
 477  * eval: (c-set-style "gnu")
 478  * End:
 479  */