src/vlib/physmem_funcs.h

   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
  43 clib_error_t *vlib_physmem_init (vlib_main_t * vm);
  44 clib_error_t *vlib_physmem_shared_map_create (vlib_main_t * vm, char *name,
  45                                               uword size, u32 log2_page_sz,
  46                                               u32 numa_node, u32 * map_index);
  47
  48 vlib_physmem_map_t *vlib_physmem_get_map (vlib_main_t * vm, u32 index);
  49
  50 always_inline void *
  51 vlib_physmem_alloc_aligned (vlib_main_t * vm, uword n_bytes, uword alignment)
  52 {
  53   clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
  54   return clib_pmalloc_alloc_aligned (pm, n_bytes, alignment);
  55 }
  56
  57 always_inline void *
  58 vlib_physmem_alloc_aligned_on_numa (vlib_main_t * vm, uword n_bytes,
  59                                     uword alignment, u32 numa_node)
  60 {
  61   clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
  62   return clib_pmalloc_alloc_aligned_on_numa (pm, n_bytes, alignment,
  63                                              numa_node);
  64 }
  65
  66 /* By default allocate I/O memory with cache line alignment. */
  67 always_inline void *
  68 vlib_physmem_alloc (vlib_main_t * vm, uword n_bytes)
  69 {
  70   return vlib_physmem_alloc_aligned (vm, n_bytes, CLIB_CACHE_LINE_BYTES);
  71 }
  72
  73 always_inline void *
  74 vlib_physmem_alloc_from_map (vlib_main_t * vm, u32 physmem_map_index,
  75                              uword n_bytes, uword alignment)
  76 {
  77   clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
  78   vlib_physmem_map_t *map = vlib_physmem_get_map (vm, physmem_map_index);
  79   return clib_pmalloc_alloc_from_arena (pm, map->base, n_bytes,
  80                                         CLIB_CACHE_LINE_BYTES);
  81 }
  82
  83 always_inline void
  84 vlib_physmem_free (vlib_main_t * vm, void *p)
  85 {
  86   if (p)
  87     clib_pmalloc_free (vm->physmem_main.pmalloc_main, p);
  88 }
  89
  90 always_inline u64
  91 vlib_physmem_get_page_index (vlib_main_t * vm, void *mem)
  92 {
  93   clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
  94   return clib_pmalloc_get_page_index (pm, mem);
  95 }
  96
  97 always_inline u64
  98 vlib_physmem_get_pa (vlib_main_t * vm, void *mem)
  99 {
 100   clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
 101   return clib_pmalloc_get_pa (pm, mem);
 102 }
 103
 104 always_inline clib_error_t *
 105 vlib_physmem_last_error (struct vlib_main_t * vm)
 106 {
 107   return clib_error_return (0, "unknown error");
 108 }
 109
 110 #endif /* included_vlib_physmem_funcs_h */
 111
 112 /*
 113  * fd.io coding-style-patch-verification: ON
 114  *
 115  * Local Variables:
 116  * eval: (c-set-style "gnu")
 117  * End:
 118  */