FD.io VPP  v18.07-34-g55fbdb9
Vector Packet Processing
physmem_funcs.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  * physmem.h: virtual <-> physical memory mapping for VLIB buffers
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_vlib_physmem_funcs_h
41 #define included_vlib_physmem_funcs_h
42 
45 {
47  return pool_elt_at_index (vpm->regions, index);
48 }
49 
53 {
55  uword page_index = o >> pr->log2_page_size;
56  ASSERT (o < pr->size);
57  ASSERT (pr->page_table[page_index] != 0);
58  return (vec_elt (pr->page_table, page_index) + (o & pr->page_mask));
59 }
60 
61 always_inline int
63  uword p)
64 {
66  return p >= pointer_to_uword (pr->mem)
67  && p < (pointer_to_uword (pr->mem) + pr->size);
68 }
69 
72  void *p)
73 {
75  uword a = pointer_to_uword (p);
76  uword o;
77 
78  ASSERT (vlib_physmem_is_virtual (vm, idx, a));
79  o = a - pointer_to_uword (pr->mem);
80 
81  /* Offset must fit in 32 bits. */
82  ASSERT ((uword) o == a - pointer_to_uword (pr->mem));
83 
84  return o;
85 }
86 
87 always_inline void *
89  uword offset)
90 {
93  return uword_to_pointer (pointer_to_uword (pr->mem) + offset, void *);
94 }
95 
96 always_inline void *
98  clib_error_t ** error,
99  uword n_bytes, uword alignment)
100 {
101  void *r = vm->os_physmem_alloc_aligned (vm, idx, n_bytes, alignment);
102  if (!r)
103  *error =
104  clib_error_return (0, "failed to allocate %wd bytes of I/O memory",
105  n_bytes);
106  else
107  *error = 0;
108  return r;
109 }
110 
111 /* By default allocate I/O memory with cache line alignment. */
112 always_inline void *
114  clib_error_t ** error, uword n_bytes)
115 {
116  return vlib_physmem_alloc_aligned (vm, idx, error, n_bytes,
118 }
119 
120 always_inline void
122  void *mem)
123 {
124  if (mem)
125  vm->os_physmem_free (vm, idx, mem);
126 }
127 
130  vlib_physmem_region_index_t idx, void *mem)
131 {
134  uword o = mem - pr->mem;
135  return vlib_physmem_offset_to_physical (vm, idx, o);
136 }
137 
138 
141  u8 numa_node, u32 flags,
143 {
144  return vm->os_physmem_region_alloc (vm, name, size, numa_node, flags, idx);
145 }
146 
147 always_inline void
150 {
151  vm->os_physmem_region_free (vm, idx);
152 }
153 
154 #endif /* included_vlib_physmem_funcs_h */
155 
156 /*
157  * fd.io coding-style-patch-verification: ON
158  *
159  * Local Variables:
160  * eval: (c-set-style "gnu")
161  * End:
162  */
a
Definition: bitmap.h:538
void(* os_physmem_region_free)(struct vlib_main_t *vm, vlib_physmem_region_index_t idx)
Definition: main.h:122
static void * vlib_physmem_at_offset(vlib_main_t *vm, vlib_physmem_region_index_t idx, uword offset)
Definition: physmem_funcs.h:88
unsigned long u64
Definition: types.h:89
static int vlib_physmem_is_virtual(vlib_main_t *vm, vlib_physmem_region_index_t idx, uword p)
Definition: physmem_funcs.h:62
static clib_error_t * vlib_physmem_region_alloc(vlib_main_t *vm, char *name, u32 size, u8 numa_node, u32 flags, vlib_physmem_region_index_t *idx)
static void * vlib_physmem_alloc_aligned(vlib_main_t *vm, vlib_physmem_region_index_t idx, clib_error_t **error, uword n_bytes, uword alignment)
Definition: physmem_funcs.h:97
unsigned char u8
Definition: types.h:56
void(* os_physmem_free)(struct vlib_main_t *vm, vlib_physmem_region_index_t idx, void *x)
Definition: main.h:128
#define always_inline
Definition: clib.h:92
void *(* os_physmem_alloc_aligned)(struct vlib_main_t *vm, vlib_physmem_region_index_t idx, uword n_bytes, uword alignment)
Definition: main.h:125
#define clib_error_return(e, args...)
Definition: error.h:99
unsigned int u32
Definition: types.h:88
static uword vlib_physmem_offset_of(vlib_main_t *vm, vlib_physmem_region_index_t idx, void *p)
Definition: physmem_funcs.h:71
static vlib_physmem_region_t * vlib_physmem_get_region(vlib_main_t *vm, u8 index)
Definition: physmem_funcs.h:44
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:464
uword size
u32 flags
Definition: vhost_user.h:110
vlib_main_t * vm
Definition: buffer.c:294
#define uword_to_pointer(u, type)
Definition: types.h:136
#define ASSERT(truth)
static void vlib_physmem_free(vlib_main_t *vm, vlib_physmem_region_index_t idx, void *mem)
static u64 vlib_physmem_offset_to_physical(vlib_main_t *vm, vlib_physmem_region_index_t idx, uword o)
Definition: physmem_funcs.h:51
static uword pointer_to_uword(const void *p)
Definition: types.h:131
static void * vlib_physmem_alloc(vlib_main_t *vm, vlib_physmem_region_index_t idx, clib_error_t **error, uword n_bytes)
#define vec_elt(v, i)
Get vector value at index i.
template key/value backing page structure
Definition: bihash_doc.h:44
static u64 vlib_physmem_virtual_to_physical(vlib_main_t *vm, vlib_physmem_region_index_t idx, void *mem)
u64 uword
Definition: types.h:112
static void vlib_physmem_region_free(struct vlib_main_t *vm, vlib_physmem_region_index_t idx)
vlib_physmem_main_t physmem_main
Definition: main.c:64
void * mem
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:62
clib_error_t *(* os_physmem_region_alloc)(struct vlib_main_t *vm, char *name, u32 size, u8 numa_node, u32 flags, vlib_physmem_region_index_t *idx)
Definition: main.h:116
u8 vlib_physmem_region_index_t
Definition: physmem.h:43
vlib_physmem_region_t * regions
Definition: physmem.h:73