src/vppinfra/mem_mheap.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   Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
  17
  18   Permission is hereby granted, free of charge, to any person obtaining
  19   a copy of this software and associated documentation files (the
  20   "Software"), to deal in the Software without restriction, including
  21   without limitation the rights to use, copy, modify, merge, publish,
  22   distribute, sublicense, and/or sell copies of the Software, and to
  23   permit persons to whom the Software is furnished to do so, subject to
  24   the following conditions:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  29   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  33   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  34   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  35   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36 */
  37
  38 #include <vppinfra/format.h>
  39 #include <vppinfra/mheap.h>
  40 #include <vppinfra/os.h>
  41
  42 void *clib_per_cpu_mheaps[CLIB_MAX_MHEAPS];
  43
  44 void
  45 clib_mem_exit (void)
  46 {
  47   u8 *heap = clib_mem_get_per_cpu_heap ();
  48   if (heap)
  49     mheap_free (heap);
  50   clib_mem_set_per_cpu_heap (0);
  51 }
  52
  53 /* Initialize CLIB heap based on memory/size given by user.
  54    Set memory to 0 and CLIB will try to allocate its own heap. */
  55 void *
  56 clib_mem_init (void *memory, uword memory_size)
  57 {
  58   u8 *heap;
  59
  60   if (memory || memory_size)
  61     heap = mheap_alloc (memory, memory_size);
  62   else
  63     {
  64       /* Allocate lots of address space since this will limit
  65          the amount of memory the program can allocate.
  66          In the kernel we're more conservative since some architectures
  67          (e.g. mips) have pretty small kernel virtual address spaces. */
  68 #ifdef __KERNEL__
  69 #define MAX_VM_MEG 64
  70 #else
  71 #define MAX_VM_MEG 1024
  72 #endif
  73
  74       uword alloc_size = MAX_VM_MEG << 20;
  75       uword tries = 16;
  76
  77       while (1)
  78         {
  79           heap = mheap_alloc (0, alloc_size);
  80           if (heap)
  81             break;
  82           alloc_size = (alloc_size * 3) / 4;
  83           tries--;
  84           if (tries == 0)
  85             break;
  86         }
  87     }
  88
  89   clib_mem_set_heap (heap);
  90
  91   return heap;
  92 }
  93
  94 void *
  95 clib_mem_init_thread_safe (void *memory, uword memory_size)
  96 {
  97   mheap_t *h;
  98   u8 *heap;
  99
 100   clib_mem_init (memory, memory_size);
 101
 102   heap = clib_mem_get_per_cpu_heap ();
 103   ASSERT (heap);
 104
 105   h = mheap_header (heap);
 106
 107   /* make the main heap thread-safe */
 108   h->flags |= MHEAP_FLAG_THREAD_SAFE;
 109
 110   return heap;
 111 }
 112
 113 u8 *
 114 format_clib_mem_usage (u8 * s, va_list * va)
 115 {
 116   int verbose = va_arg (*va, int);
 117   return format (s, "%U", format_mheap, clib_mem_get_heap (), verbose);
 118 }
 119
 120 void
 121 clib_mem_usage (clib_mem_usage_t * u)
 122 {
 123   mheap_usage (clib_mem_get_heap (), u);
 124 }
 125
 126 /* Call serial number for debugger breakpoints. */
 127 uword clib_mem_validate_serial = 0;
 128
 129 void
 130 clib_mem_validate (void)
 131 {
 132   if (MHEAP_HAVE_SMALL_OBJECT_CACHE)
 133     clib_warning ("clib_mem_validate disabled (small object cache is ON)");
 134   else
 135     {
 136       mheap_validate (clib_mem_get_heap ());
 137       clib_mem_validate_serial++;
 138     }
 139 }
 140
 141 void
 142 clib_mem_trace (int enable)
 143 {
 144   mheap_trace (clib_mem_get_heap (), enable);
 145 }
 146
 147 int
 148 clib_mem_is_traced (void)
 149 {
 150   return mheap_is_traced (clib_mem_get_heap ());
 151 }
 152
 153 /*
 154  * fd.io coding-style-patch-verification: ON
 155  *
 156  * Local Variables:
 157  * eval: (c-set-style "gnu")
 158  * End:
 159  */