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 /* Valgrind stuff. */
  43 #include <vppinfra/memcheck.h>
  44 #include <vppinfra/valgrind.h>
  45
  46 void *clib_per_cpu_mheaps[CLIB_MAX_MHEAPS];
  47
  48 void
  49 clib_mem_exit (void)
  50 {
  51   u8 *heap = clib_mem_get_per_cpu_heap ();
  52   if (heap)
  53     mheap_free (heap);
  54   clib_mem_set_per_cpu_heap (0);
  55 }
  56
  57 /* Initialize CLIB heap based on memory/size given by user.
  58    Set memory to 0 and CLIB will try to allocate its own heap. */
  59 void *
  60 clib_mem_init (void *memory, uword memory_size)
  61 {
  62   u8 *heap;
  63
  64   if (memory || memory_size)
  65     heap = mheap_alloc (memory, memory_size);
  66   else
  67     {
  68       /* Allocate lots of address space since this will limit
  69          the amount of memory the program can allocate.
  70          In the kernel we're more conservative since some architectures
  71          (e.g. mips) have pretty small kernel virtual address spaces. */
  72 #ifdef __KERNEL__
  73 #define MAX_VM_MEG 64
  74 #else
  75 #define MAX_VM_MEG 1024
  76 #endif
  77
  78       uword alloc_size = MAX_VM_MEG << 20;
  79       uword tries = 16;
  80
  81       while (1)
  82         {
  83           heap = mheap_alloc (0, alloc_size);
  84           if (heap)
  85             break;
  86           alloc_size = (alloc_size * 3) / 4;
  87           tries--;
  88           if (tries == 0)
  89             break;
  90         }
  91     }
  92
  93   clib_mem_set_heap (heap);
  94
  95   return heap;
  96 }
  97
  98 void *
  99 clib_mem_init_thread_safe (void *memory, uword memory_size)
 100 {
 101   mheap_t *h;
 102   u8 *heap;
 103
 104   clib_mem_init (memory, memory_size);
 105
 106   heap = clib_mem_get_per_cpu_heap ();
 107   ASSERT (heap);
 108
 109   h = mheap_header (heap);
 110
 111   /* make the main heap thread-safe */
 112   h->flags |= MHEAP_FLAG_THREAD_SAFE;
 113
 114   return heap;
 115 }
 116
 117 #ifdef CLIB_LINUX_KERNEL
 118 #include <asm/page.h>
 119
 120 uword
 121 clib_mem_get_page_size (void)
 122 {
 123   return PAGE_SIZE;
 124 }
 125 #endif
 126
 127 #ifdef CLIB_UNIX
 128 uword
 129 clib_mem_get_page_size (void)
 130 {
 131   return getpagesize ();
 132 }
 133 #endif
 134
 135 /* Make a guess for standalone. */
 136 #ifdef CLIB_STANDALONE
 137 uword
 138 clib_mem_get_page_size (void)
 139 {
 140   return 4096;
 141 }
 142 #endif
 143
 144 u8 *
 145 format_clib_mem_usage (u8 * s, va_list * va)
 146 {
 147   int verbose = va_arg (*va, int);
 148   return format (s, "%U", format_mheap, clib_mem_get_heap (), verbose);
 149 }
 150
 151 void
 152 clib_mem_usage (clib_mem_usage_t * u)
 153 {
 154   mheap_usage (clib_mem_get_heap (), u);
 155 }
 156
 157 /* Call serial number for debugger breakpoints. */
 158 uword clib_mem_validate_serial = 0;
 159
 160 void
 161 clib_mem_validate (void)
 162 {
 163   if (MHEAP_HAVE_SMALL_OBJECT_CACHE)
 164     clib_warning ("clib_mem_validate disabled (small object cache is ON)");
 165   else
 166     {
 167       mheap_validate (clib_mem_get_heap ());
 168       clib_mem_validate_serial++;
 169     }
 170 }
 171
 172 void
 173 clib_mem_trace (int enable)
 174 {
 175   mheap_trace (clib_mem_get_heap (), enable);
 176 }
 177
 178 /*
 179  * fd.io coding-style-patch-verification: ON
 180  *
 181  * Local Variables:
 182  * eval: (c-set-style "gnu")
 183  * End:
 184  */