add prefix to cache line macros
[dpdk.git] / lib / librte_eal / common / include / rte_memory.h
index 4f04f4a..1990833 100644 (file)
@@ -1,13 +1,13 @@
 /*-
  *   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
@@ -17,7 +17,7 @@
  *     * 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
@@ -42,6 +42,7 @@
 
 #include <stdint.h>
 #include <stddef.h>
+#include <stdio.h>
 
 #ifdef RTE_EXEC_ENV_LINUXAPP
 #include <exec-env/rte_dom0_common.h>
@@ -52,25 +53,28 @@ extern "C" {
 #endif
 
 enum rte_page_sizes {
-       RTE_PGSIZE_4K = 1 << 12,
-       RTE_PGSIZE_2M = RTE_PGSIZE_4K << 9,
-       RTE_PGSIZE_1G = RTE_PGSIZE_2M <<9
+       RTE_PGSIZE_4K = 1ULL << 12,
+       RTE_PGSIZE_2M = 1ULL << 21,
+       RTE_PGSIZE_1G = 1ULL << 30,
+       RTE_PGSIZE_64K = 1ULL << 16,
+       RTE_PGSIZE_16M = 1ULL << 24,
+       RTE_PGSIZE_16G = 1ULL << 34
 };
 
 #define SOCKET_ID_ANY -1                    /**< Any NUMA socket. */
-#ifndef CACHE_LINE_SIZE
-#define CACHE_LINE_SIZE 64                  /**< Cache line size. */
+#ifndef RTE_CACHE_LINE_SIZE
+#define RTE_CACHE_LINE_SIZE 64                  /**< Cache line size. */
 #endif
-#define CACHE_LINE_MASK (CACHE_LINE_SIZE-1) /**< Cache line mask. */
+#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */
 
-#define CACHE_LINE_ROUNDUP(size) \
-       (CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
+#define RTE_CACHE_LINE_ROUNDUP(size) \
+       (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
 /**< Return the first cache-aligned value greater or equal to size. */
 
 /**
  * Force alignment to cache line.
  */
-#define __rte_cache_aligned __attribute__((__aligned__(CACHE_LINE_SIZE)))
+#define __rte_cache_aligned __attribute__((__aligned__(RTE_CACHE_LINE_SIZE)))
 
 typedef uint64_t phys_addr_t; /**< Physical address definition. */
 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
@@ -94,7 +98,7 @@ struct rte_memseg {
        uint32_t nrank;             /**< Number of ranks. */
 #ifdef RTE_LIBRTE_XEN_DOM0
         /**< store segment MFNs */
-       uint64_t mfn[DOM0_NUM_MEMBLOCK]; 
+       uint64_t mfn[DOM0_NUM_MEMBLOCK];
 #endif
 } __attribute__((__packed__));
 
@@ -139,8 +143,11 @@ const struct rte_memseg *rte_eal_get_physmem_layout(void);
 
 /**
  * Dump the physical memory layout to the console.
+ *
+ * @param f
+ *   A pointer to a file for output
  */
-void rte_dump_physmem_layout(void);
+void rte_dump_physmem_layout(FILE *f);
 
 /**
  * Get the total amount of available physical memory.
@@ -172,7 +179,7 @@ unsigned rte_memory_get_nrank(void);
 /**
  * Return the physical address of elt, which is an element of the pool mp.
  *
- * @param memseg_id 
+ * @param memseg_id
  *   The mempool is from which memory segment.
  * @param phy_addr
  *   physical address of elt.
@@ -183,22 +190,22 @@ unsigned rte_memory_get_nrank(void);
 phys_addr_t rte_mem_phy2mch(uint32_t memseg_id, const phys_addr_t phy_addr);
 
 /**
- * Memory init for supporting application running on Xen domain0. 
- * 
- * @param void 
- * 
- * @return 
+ * Memory init for supporting application running on Xen domain0.
+ *
+ * @param void
+ *
+ * @return
  *       0: successfully
  *      negative: error
- */ 
+ */
 int rte_xen_dom0_memory_init(void);
 
 /**
- * Attach to memory setments of primary process on Xen domain0. 
- * 
- * @param void 
- * 
- * @return 
+ * Attach to memory setments of primary process on Xen domain0.
+ *
+ * @param void
+ *
+ * @return
  *       0: successfully
  *       negative: error
  */