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