eal: set iopl only when needed
[dpdk.git] / lib / librte_eal / common / include / rte_eal.h
index 421a91b..8d39cba 100644 (file)
@@ -1,13 +1,13 @@
 /*-
  *   BSD LICENSE
- * 
- *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
+ *
+ *   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
@@ -46,7 +46,6 @@
 extern "C" {
 #endif
 
-#define RTE_VERSION 1 /**< The version of the RTE configuration structure. */
 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
 
 /**
@@ -72,10 +71,6 @@ enum rte_proc_type_t {
  * The global RTE configuration structure.
  */
 struct rte_config {
-       uint32_t version; /**< Configuration [structure] version. */
-       uint32_t magic;   /**< Magic number - Sanity check. */
-
-
        uint32_t master_lcore;       /**< Id of the master lcore */
        uint32_t lcore_count;        /**< Number of available logical cores. */
        enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
@@ -83,6 +78,9 @@ struct rte_config {
        /** Primary or secondary configuration */
        enum rte_proc_type_t process_type;
 
+       /** A set of general status flags */
+       unsigned flags;
+
        /**
         * Pointer to memory configuration, which may be shared across multiple
         * Intel DPDK instances
@@ -117,6 +115,17 @@ enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
  */
 enum rte_proc_type_t rte_eal_process_type(void);
 
+/**
+ * Request iopl privilege for all RPL.
+ *
+ * This function should be called by pmds which need access to ioports.
+
+ * @return
+ *   - On success, returns 0.
+ *   - On failure, returns -1.
+ */
+int rte_eal_iopl_init(void);
+
 /**
  * Initialize the Environment Abstraction Layer (EAL).
  *
@@ -178,7 +187,7 @@ rte_usage_hook_t
 rte_set_application_usage_hook( rte_usage_hook_t usage_func );
 
 /**
- * macro to get the lock of tailq in mem_config 
+ * macro to get the lock of tailq in mem_config
  */
 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 
@@ -207,7 +216,7 @@ rte_set_application_usage_hook( rte_usage_hook_t usage_func );
        rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
        TAILQ_INSERT_TAIL(list, elm, next);                     \
        rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
-} while (0)  
+} while (0)
 
 /**
  * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config
@@ -245,7 +254,18 @@ rte_set_application_usage_hook( rte_usage_hook_t usage_func );
        }                                                               \
 } while(0)
 
+/**
+ * Whether EAL is using huge pages (disabled by --no-huge option).
+ * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
+ * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
+ * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
+ * as 6WIND.
+ *
+ * @return
+ *   Nonzero if hugepages are enabled.
+ */
+int rte_eal_has_hugepages(void);
+
 #ifdef __cplusplus
 }
 #endif