Imported Upstream version 16.04
[deb_dpdk.git] / lib / librte_eal / common / include / rte_eal_memconfig.h
diff --git a/lib/librte_eal/common/include/rte_eal_memconfig.h b/lib/librte_eal/common/include/rte_eal_memconfig.h
new file mode 100644 (file)
index 0000000..2b5e0b1
--- /dev/null
@@ -0,0 +1,100 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _RTE_EAL_MEMCONFIG_H_
+#define _RTE_EAL_MEMCONFIG_H_
+
+#include <rte_tailq.h>
+#include <rte_memory.h>
+#include <rte_memzone.h>
+#include <rte_malloc_heap.h>
+#include <rte_rwlock.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * the structure for the memory configuration for the RTE.
+ * Used by the rte_config structure. It is separated out, as for multi-process
+ * support, the memory details should be shared across instances
+ */
+struct rte_mem_config {
+       volatile uint32_t magic;   /**< Magic number - Sanity check. */
+
+       /* memory topology */
+       uint32_t nchannel;    /**< Number of channels (0 if unknown). */
+       uint32_t nrank;       /**< Number of ranks (0 if unknown). */
+
+       /**
+        * current lock nest order
+        *  - qlock->mlock (ring/hash/lpm)
+        *  - mplock->qlock->mlock (mempool)
+        * Notice:
+        *  *ALWAYS* obtain qlock first if having to obtain both qlock and mlock
+        */
+       rte_rwlock_t mlock;   /**< only used by memzone LIB for thread-safe. */
+       rte_rwlock_t qlock;   /**< used for tailq operation for thread safe. */
+       rte_rwlock_t mplock;  /**< only used by mempool LIB for thread-safe. */
+
+       uint32_t memzone_cnt; /**< Number of allocated memzones */
+
+       /* memory segments and zones */
+       struct rte_memseg memseg[RTE_MAX_MEMSEG];    /**< Physmem descriptors. */
+       struct rte_memzone memzone[RTE_MAX_MEMZONE]; /**< Memzone descriptors. */
+
+       struct rte_tailq_head tailq_head[RTE_MAX_TAILQ]; /**< Tailqs for objects */
+
+       /* Heaps of Malloc per socket */
+       struct malloc_heap malloc_heaps[RTE_MAX_NUMA_NODES];
+
+       /* address of mem_config in primary process. used to map shared config into
+        * exact same address the primary process maps it.
+        */
+       uint64_t mem_cfg_addr;
+} __attribute__((__packed__));
+
+
+inline static void
+rte_eal_mcfg_wait_complete(struct rte_mem_config* mcfg)
+{
+       /* wait until shared mem_config finish initialising */
+       while(mcfg->magic != RTE_MAGIC)
+               rte_pause();
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /*__RTE_EAL_MEMCONFIG_H_*/