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 #ifdef CLIB_LINUX_KERNEL
  99 #include <asm/page.h>
 100
 101 uword
 102 clib_mem_get_page_size (void)
 103 {
 104   return PAGE_SIZE;
 105 }
 106 #endif
 107
 108 #ifdef CLIB_UNIX
 109 uword
 110 clib_mem_get_page_size (void)
 111 {
 112   return getpagesize ();
 113 }
 114 #endif
 115
 116 /* Make a guess for standalone. */
 117 #ifdef CLIB_STANDALONE
 118 uword
 119 clib_mem_get_page_size (void)
 120 {
 121   return 4096;
 122 }
 123 #endif
 124
 125 u8 *
 126 format_clib_mem_usage (u8 * s, va_list * va)
 127 {
 128   int verbose = va_arg (*va, int);
 129   return format (s, "%U", format_mheap, clib_mem_get_heap (), verbose);
 130 }
 131
 132 void
 133 clib_mem_usage (clib_mem_usage_t * u)
 134 {
 135   mheap_usage (clib_mem_get_heap (), u);
 136 }
 137
 138 /* Call serial number for debugger breakpoints. */
 139 uword clib_mem_validate_serial = 0;
 140
 141 void
 142 clib_mem_validate (void)
 143 {
 144   if (MHEAP_HAVE_SMALL_OBJECT_CACHE)
 145     clib_warning ("clib_mem_validate disabled (small object cache is ON)");
 146   else
 147     {
 148       mheap_validate (clib_mem_get_heap ());
 149       clib_mem_validate_serial++;
 150     }
 151 }
 152
 153 void
 154 clib_mem_trace (int enable)
 155 {
 156   mheap_trace (clib_mem_get_heap (), enable);
 157 }
 158
 159 /*
 160  * fd.io coding-style-patch-verification: ON
 161  *
 162  * Local Variables:
 163  * eval: (c-set-style "gnu")
 164  * End:
 165  */