lib/librte_eal/common/include/rte_eal_memconfig.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_EAL_MEMCONFIG_H_
  35 #define _RTE_EAL_MEMCONFIG_H_
  36
  37 #include <rte_tailq.h>
  38 #include <rte_memory.h>
  39 #include <rte_memzone.h>
  40 #include <rte_malloc_heap.h>
  41 #include <rte_rwlock.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * the structure for the memory configuration for the RTE.
  49  * Used by the rte_config structure. It is separated out, as for multi-process
  50  * support, the memory details should be shared across instances
  51  */
  52 struct rte_mem_config {
  53         volatile uint32_t magic;   /**< Magic number - Sanity check. */
  54
  55         /* memory topology */
  56         uint32_t nchannel;    /**< Number of channels (0 if unknown). */
  57         uint32_t nrank;       /**< Number of ranks (0 if unknown). */
  58
  59         /**
  60          * current lock nest order
  61          *  - qlock->mlock (ring/hash/lpm)
  62          *  - mplock->qlock->mlock (mempool)
  63          * Notice:
  64          *  *ALWAYS* obtain qlock first if having to obtain both qlock and mlock
  65          */
  66         rte_rwlock_t mlock;   /**< only used by memzone LIB for thread-safe. */
  67         rte_rwlock_t qlock;   /**< used for tailq operation for thread safe. */
  68         rte_rwlock_t mplock;  /**< only used by mempool LIB for thread-safe. */
  69
  70         uint32_t memzone_cnt; /**< Number of allocated memzones */
  71
  72         /* memory segments and zones */
  73         struct rte_memseg memseg[RTE_MAX_MEMSEG];    /**< Physmem descriptors. */
  74         struct rte_memzone memzone[RTE_MAX_MEMZONE]; /**< Memzone descriptors. */
  75
  76         struct rte_tailq_head tailq_head[RTE_MAX_TAILQ]; /**< Tailqs for objects */
  77
  78         /* Heaps of Malloc per socket */
  79         struct malloc_heap malloc_heaps[RTE_MAX_NUMA_NODES];
  80
  81         /* address of mem_config in primary process. used to map shared config into
  82          * exact same address the primary process maps it.
  83          */
  84         uint64_t mem_cfg_addr;
  85 } __attribute__((__packed__));
  86
  87
  88 inline static void
  89 rte_eal_mcfg_wait_complete(struct rte_mem_config* mcfg)
  90 {
  91         /* wait until shared mem_config finish initialising */
  92         while(mcfg->magic != RTE_MAGIC)
  93                 rte_pause();
  94 }
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100 #endif /*__RTE_EAL_MEMCONFIG_H_*/