vppinfra/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 clib_mem_exit (void)
  49 {
  50   u8 * heap = clib_mem_get_per_cpu_heap ();
  51   if (heap)
  52     mheap_free (heap);
  53   clib_mem_set_per_cpu_heap (0);
  54 }
  55
  56 /* Initialize CLIB heap based on memory/size given by user.
  57    Set memory to 0 and CLIB will try to allocate its own heap. */
  58 void * clib_mem_init (void * memory, uword memory_size)
  59 {
  60   u8 * heap;
  61
  62   if (memory || memory_size)
  63     heap = mheap_alloc (memory, memory_size);
  64   else
  65     {
  66       /* Allocate lots of address space since this will limit
  67          the amount of memory the program can allocate.
  68          In the kernel we're more conservative since some architectures
  69          (e.g. mips) have pretty small kernel virtual address spaces. */
  70 #ifdef __KERNEL__
  71 #define MAX_VM_MEG 64
  72 #else
  73 #define MAX_VM_MEG 1024
  74 #endif
  75
  76       uword alloc_size = MAX_VM_MEG << 20;
  77       uword tries = 16;
  78
  79       while (1)
  80         {
  81           heap = mheap_alloc (0, alloc_size);
  82           if (heap)
  83             break;
  84           alloc_size = (alloc_size * 3) / 4;
  85           tries--;
  86           if (tries == 0)
  87             break;
  88         }
  89     }
  90
  91   clib_mem_set_heap (heap);
  92
  93   return heap;
  94 }
  95
  96 #ifdef CLIB_LINUX_KERNEL
  97 #include <asm/page.h>
  98
  99 uword clib_mem_get_page_size (void)
 100 { return PAGE_SIZE; }
 101 #endif
 102
 103 #ifdef CLIB_UNIX
 104 uword clib_mem_get_page_size (void)
 105 { return getpagesize (); }
 106 #endif
 107
 108 /* Make a guess for standalone. */
 109 #ifdef CLIB_STANDALONE
 110 uword clib_mem_get_page_size (void)
 111 { return 4096; }
 112 #endif
 113
 114 u8 * 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 clib_mem_usage (clib_mem_usage_t * u)
 121 { mheap_usage (clib_mem_get_heap (), u); }
 122
 123 /* Call serial number for debugger breakpoints. */
 124 uword clib_mem_validate_serial = 0;
 125
 126 void clib_mem_validate (void)
 127 {
 128   if (MHEAP_HAVE_SMALL_OBJECT_CACHE)
 129     clib_warning ("clib_mem_validate disabled (small object cache is ON)");
 130   else
 131     {
 132       mheap_validate (clib_mem_get_heap ());
 133       clib_mem_validate_serial++;
 134     }
 135 }
 136
 137 void clib_mem_trace (int enable)
 138 { mheap_trace (clib_mem_get_heap (), enable); }