FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
mem_mheap.c
Go to the documentation of this file.
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 
47 
48 void
50 {
51  u8 *heap = clib_mem_get_per_cpu_heap ();
52  if (heap)
53  mheap_free (heap);
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 *
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 *
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 */
113 
114  return heap;
115 }
116 
117 u8 *
118 format_clib_mem_usage (u8 * s, va_list * va)
119 {
120  int verbose = va_arg (*va, int);
121  return format (s, "%U", format_mheap, clib_mem_get_heap (), verbose);
122 }
123 
124 void
126 {
128 }
129 
130 /* Call serial number for debugger breakpoints. */
132 
133 void
135 {
137  clib_warning ("clib_mem_validate disabled (small object cache is ON)");
138  else
139  {
142  }
143 }
144 
145 void
146 clib_mem_trace (int enable)
147 {
148  mheap_trace (clib_mem_get_heap (), enable);
149 }
150 
151 int
153 {
154  return mheap_is_traced (clib_mem_get_heap ());
155 }
156 
157 /*
158  * fd.io coding-style-patch-verification: ON
159  *
160  * Local Variables:
161  * eval: (c-set-style "gnu")
162  * End:
163  */
int clib_mem_is_traced(void)
Definition: mem_mheap.c:152
void clib_mem_usage(clib_mem_usage_t *u)
Definition: mem_mheap.c:125
vhost_user_memory_t memory
Definition: vhost_user.h:122
u8 * format_clib_mem_usage(u8 *s, va_list *va)
Definition: mem_mheap.c:118
void * mheap_alloc(void *memory, uword size)
Definition: mheap.c:963
static mheap_t * mheap_header(u8 *v)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
#define MHEAP_FLAG_THREAD_SAFE
#define CLIB_MAX_MHEAPS
Definition: mem.h:58
unsigned char u8
Definition: types.h:56
void * clib_mem_init(void *memory, uword memory_size)
Definition: mem_mheap.c:60
void * clib_per_cpu_mheaps[CLIB_MAX_MHEAPS]
Definition: mem_mheap.c:46
void mheap_usage(void *v, clib_mem_usage_t *usage)
Definition: mheap.c:1111
void mheap_trace(void *v, int enable)
Definition: mem_dlmalloc.c:396
#define mheap_free(v)
Definition: mheap.h:65
void * clib_mem_init_thread_safe(void *memory, uword memory_size)
Definition: mem_mheap.c:99
u8 * format_mheap(u8 *s, va_list *va)
Definition: mem_dlmalloc.c:354
#define MAX_VM_MEG
u64 memory_size
Definition: vhost_user.h:115
static void * clib_mem_get_per_cpu_heap(void)
Definition: mem.h:64
uword clib_mem_validate_serial
Definition: mem_mheap.c:131
static void * clib_mem_set_heap(void *heap)
Definition: mem.h:261
#define clib_warning(format, args...)
Definition: error.h:59
void clib_mem_exit(void)
Definition: mem_mheap.c:49
static void * clib_mem_get_heap(void)
Definition: mem.h:255
#define ASSERT(truth)
void clib_mem_trace(int enable)
Definition: mem_mheap.c:146
static void * clib_mem_set_per_cpu_heap(u8 *new_heap)
Definition: mem.h:71
#define MHEAP_HAVE_SMALL_OBJECT_CACHE
u64 uword
Definition: types.h:112
void clib_mem_validate(void)
Definition: mem_mheap.c:134
void mheap_validate(void *v)
Definition: mheap.c:1378