lib/librte_eal/common/include/rte_eal_memconfig.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_EAL_MEMCONFIG_H_
   6 #define _RTE_EAL_MEMCONFIG_H_
   7
   8 #include <rte_compat.h>
   9
  10 /**
  11  * @file
  12  *
  13  * This API allows access to EAL shared memory configuration through an API.
  14  */
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 /**
  21  * Lock the internal EAL shared memory configuration for shared access.
  22  */
  23 void
  24 rte_mcfg_mem_read_lock(void);
  25
  26 /**
  27  * Unlock the internal EAL shared memory configuration for shared access.
  28  */
  29 void
  30 rte_mcfg_mem_read_unlock(void);
  31
  32 /**
  33  * Lock the internal EAL shared memory configuration for exclusive access.
  34  */
  35 void
  36 rte_mcfg_mem_write_lock(void);
  37
  38 /**
  39  * Unlock the internal EAL shared memory configuration for exclusive access.
  40  */
  41 void
  42 rte_mcfg_mem_write_unlock(void);
  43
  44 /**
  45  * Lock the internal EAL TAILQ list for shared access.
  46  */
  47 void
  48 rte_mcfg_tailq_read_lock(void);
  49
  50 /**
  51  * Unlock the internal EAL TAILQ list for shared access.
  52  */
  53 void
  54 rte_mcfg_tailq_read_unlock(void);
  55
  56 /**
  57  * Lock the internal EAL TAILQ list for exclusive access.
  58  */
  59 void
  60 rte_mcfg_tailq_write_lock(void);
  61
  62 /**
  63  * Unlock the internal EAL TAILQ list for exclusive access.
  64  */
  65 void
  66 rte_mcfg_tailq_write_unlock(void);
  67
  68 /**
  69  * Lock the internal EAL Mempool list for shared access.
  70  */
  71 void
  72 rte_mcfg_mempool_read_lock(void);
  73
  74 /**
  75  * Unlock the internal EAL Mempool list for shared access.
  76  */
  77 void
  78 rte_mcfg_mempool_read_unlock(void);
  79
  80 /**
  81  * Lock the internal EAL Mempool list for exclusive access.
  82  */
  83 void
  84 rte_mcfg_mempool_write_lock(void);
  85
  86 /**
  87  * Unlock the internal EAL Mempool list for exclusive access.
  88  */
  89 void
  90 rte_mcfg_mempool_write_unlock(void);
  91
  92 /**
  93  * @warning
  94  * @b EXPERIMENTAL: this API may change without prior notice
  95  *
  96  * Lock the internal EAL Timer Library lock for exclusive access.
  97  */
  98 __rte_experimental
  99 void
 100 rte_mcfg_timer_lock(void);
 101
 102 /**
 103  * @warning
 104  * @b EXPERIMENTAL: this API may change without prior notice
 105  *
 106  * Unlock the internal EAL Timer Library lock for exclusive access.
 107  */
 108 __rte_experimental
 109 void
 110 rte_mcfg_timer_unlock(void);
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115
 116 #endif /*__RTE_EAL_MEMCONFIG_H_*/