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