FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
mheap.h
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 #ifndef included_mheap_h
39 #define included_mheap_h
40 
41 #include <vppinfra/vec.h>
42 #include <vppinfra/error.h> /* clib_error_t */
43 #include <vppinfra/mem.h> /* clib_mem_usage_t */
44 #include <vppinfra/format.h> /* for unformat_input_t */
45 
46 /* Allocate size bytes. New heap and offset are returned.
47  offset == ~0 means allocation failed. */
48 always_inline void *
49 mheap_get (void *v, uword size, uword * offset_return)
50 {
51  return mheap_get_aligned (v, size, 0, 0, offset_return);
52 }
53 
54 /* Create allocation heap of given size.
55  * The actual usable size is smaller than the requested size.
56  * memory_bytes must be greater than mheap_page_size + sizeof (mheap_t) + 16.
57  * Otherwise, allocation may fail and return 0.
58  */
59 void *mheap_alloc (void *memory, uword memory_bytes);
60 void *mheap_alloc_with_flags (void *memory, uword memory_bytes, uword flags);
61 
62 #define mheap_free(v) (v) = _mheap_free(v)
63 void *_mheap_free (void *v);
64 
65 void mheap_foreach (void *v,
66  uword (*func) (void *arg, void *v, void *elt_data,
67  uword elt_size), void *arg);
68 
69 /* Format mheap data structures as string. */
70 u8 *format_mheap (u8 * s, va_list * va);
71 
72 /* Validate internal consistency. */
73 void mheap_validate (void *h);
74 
75 /* Query bytes used. */
76 uword mheap_bytes (void *v);
77 
78 void mheap_usage (void *v, clib_mem_usage_t * usage);
79 
80 /* Enable disable traceing. */
81 void mheap_trace (void *v, int enable);
82 
83 /* Test routine. */
84 int test_mheap_main (unformat_input_t * input);
85 
86 #endif /* included_mheap_h */
87 
88 /*
89  * fd.io coding-style-patch-verification: ON
90  *
91  * Local Variables:
92  * eval: (c-set-style "gnu")
93  * End:
94  */
static void usage(void)
Definition: health_check.c:14
static void * mheap_get(void *v, uword size, uword *offset_return)
Definition: mheap.h:49
void * mheap_alloc(void *memory, uword memory_bytes)
Definition: mheap.c:947
vhost_user_memory_t memory
Definition: vhost-user.h:84
void mheap_validate(void *h)
Definition: mheap.c:1339
#define always_inline
Definition: clib.h:92
void * mheap_alloc_with_flags(void *memory, uword memory_bytes, uword flags)
Definition: mheap.c:869
struct _unformat_input_t unformat_input_t
void mheap_foreach(void *v, uword(*func)(void *arg, void *v, void *elt_data, uword elt_size), void *arg)
Definition: mheap.c:975
static u32 * elt_data(void *v, heap_elt_t *e)
Definition: heap.c:213
uword mheap_bytes(void *v)
Definition: mheap.c:1030
vec_header_t h
Definition: buffer.c:282
void * mheap_get_aligned(void *v, uword n_user_data_bytes, uword align, uword align_offset, uword *offset_return)
Definition: mheap.c:643
u8 * format_mheap(u8 *s, va_list *va)
Definition: mheap.c:1162
u64 size
Definition: vhost-user.h:76
int test_mheap_main(unformat_input_t *input)
void mheap_usage(void *v, clib_mem_usage_t *usage)
Definition: mheap.c:1072
u64 uword
Definition: types.h:112
unsigned char u8
Definition: types.h:56
void mheap_trace(void *v, int enable)
Definition: mheap.c:1621
u32 flags
Definition: vhost-user.h:77
CLIB vectors are ubiquitous dynamically resized arrays with by user defined "headers".