lib/librte_eal/common/include/rte_eal_memconfig.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  35 #ifndef _RTE_EAL_MEMCONFIG_H_
  36 #define _RTE_EAL_MEMCONFIG_H_
  37
  38 #include <rte_tailq.h>
  39 #include <rte_memory.h>
  40 #include <rte_memzone.h>
  41 #include <rte_malloc_heap.h>
  42 #include <rte_rwlock.h>
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /**
  49  * Index type of tailq_head
  50  */
  51 enum rte_tailq_t {
  52 #define rte_tailq_elem(idx, name)     idx,
  53 #define rte_tailq_end(idx)            idx
  54 #include <rte_tailq_elem.h>
  55 };
  56
  57 /**
  58  * the structure for the memory configuration for the RTE.
  59  * Used by the rte_config structure. It is separated out, as for multi-process
  60  * support, the memory details should be shared across instances
  61  */
  62 struct rte_mem_config {
  63         volatile uint32_t magic;   /**< Magic number - Sanity check. */
  64
  65         /* memory topology */
  66         uint32_t nchannel;    /**< Number of channels (0 if unknown). */
  67         uint32_t nrank;       /**< Number of ranks (0 if unknown). */
  68
  69         /**
  70          * current lock nest order
  71          *  - qlock->mlock (ring/hash/lpm)
  72          *  - mplock->qlock->mlock (mempool)
  73          * Notice:
  74          *  *ALWAYS* obtain qlock first if having to obtain both qlock and mlock
  75          */
  76         rte_rwlock_t mlock;   /**< only used by memzone LIB for thread-safe. */
  77         rte_rwlock_t qlock;   /**< used for tailq operation for thread safe. */
  78         rte_rwlock_t mplock;  /**< only used by mempool LIB for thread-safe. */
  79
  80         uint32_t memzone_idx; /**< Index of memzone */
  81
  82         /* memory segments and zones */
  83         struct rte_memseg memseg[RTE_MAX_MEMSEG];    /**< Physmem descriptors. */
  84         struct rte_memzone memzone[RTE_MAX_MEMZONE]; /**< Memzone descriptors. */
  85
  86         /* Runtime Physmem descriptors. */
  87         struct rte_memseg free_memseg[RTE_MAX_MEMSEG];
  88
  89         struct rte_tailq_head tailq_head[RTE_MAX_TAILQ]; /**< Tailqs for objects */
  90
  91         /* Heaps of Malloc per socket */
  92         struct malloc_heap malloc_heaps[RTE_MAX_NUMA_NODES];
  93 } __attribute__((__packed__));
  94
  95
  96 inline static void
  97 rte_eal_mcfg_wait_complete(struct rte_mem_config* mcfg)
  98 {
  99         /* wait until shared mem_config finish initialising */
 100         while(mcfg->magic != RTE_MAGIC)
 101                 rte_pause();
 102 }
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /*__RTE_EAL_MEMCONFIG_H_*/