lib: add missing include dependencies
[dpdk.git] / lib / librte_eal / common / include / rte_eal.h
index 273da9a..98d20db 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
  *   All rights reserved.
  *
  *   Redistribution and use in source and binary forms, with or without
  */
 
 #include <stdint.h>
+#include <sched.h>
+
+#include <rte_per_lcore.h>
+#include <rte_config.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -48,6 +52,9 @@ extern "C" {
 
 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
 
+/* Maximum thread_name length. */
+#define RTE_MAX_THREAD_NAME_LEN 16
+
 /**
  * The lcore role (used in RTE or not).
  */
@@ -78,19 +85,13 @@ 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
+        * DPDK instances
         */
        struct rte_mem_config *mem_config;
 } __attribute__((__packed__));
 
-/* Flag definitions for rte_config flags */
-#define EAL_FLG_HIGH_IOPL 1 /**< indicates high IO privilege in a linux env */
-
 /**
  * Get the global configuration structure.
  *
@@ -118,15 +119,25 @@ 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).
  *
  * This function is to be executed on the MASTER lcore only, as soon
  * as possible in the application's main() function.
  *
- * The function finishes the initialization process that was started
- * during boot (in case of baremetal) or before main() is called (in
- * case of linuxapp). It puts the SLAVE lcores in the WAIT state.
+ * The function finishes the initialization process before main() is called.
+ * It puts the SLAVE lcores in the WAIT state.
  *
  * When the multi-partition feature is supported, depending on the
  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
@@ -146,6 +157,24 @@ enum rte_proc_type_t rte_eal_process_type(void);
  *   - On failure, a negative error value.
  */
 int rte_eal_init(int argc, char **argv);
+
+/**
+ * Check if a primary process is currently alive
+ *
+ * This function returns true when a primary process is currently
+ * active.
+ *
+ * @param config_file_path
+ *   The config_file_path argument provided should point at the location
+ *   that the primary process will create its config file. If NULL, the default
+ *   config file path is used.
+ *
+ * @return
+ *  - If alive, returns 1.
+ *  - If dead, returns 0.
+ */
+int rte_eal_primary_proc_alive(const char *config_file_path);
+
 /**
  * Usage function typedef used by the application usage function.
  *
@@ -164,7 +193,7 @@ typedef void        (*rte_usage_hook_t)(const char * prgname);
  * This routine is optional for the application and will behave as if the set
  * routine was never called as the default behavior.
  *
- * @param func
+ * @param usage_func
  *   The func argument is a function pointer to the application usage routine.
  *   Called function is defined using rte_usage_hook_t typedef, which is of
  *   the form void rte_usage_func(const char * prgname).
@@ -176,7 +205,7 @@ typedef void        (*rte_usage_hook_t)(const char * prgname);
  *     the caller to daisy chain the usage routines if needing more then one.
  */
 rte_usage_hook_t
-rte_set_application_usage_hook( rte_usage_hook_t usage_func );
+rte_set_application_usage_hook(rte_usage_hook_t usage_func);
 
 /**
  * macro to get the lock of tailq in mem_config
@@ -188,75 +217,41 @@ rte_set_application_usage_hook( rte_usage_hook_t usage_func );
  */
 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 
-
-/**
- * Utility macro to do a thread-safe tailq 'INSERT' of rte_mem_config
- *
- * @param idx
- *   a kind of tailq define in enum rte_tailq_t
- *
- * @param type
- *   type of list(tailq head)
- *
- * @param elm
- *   The element will be added into the list
- *
- */
-#define RTE_EAL_TAILQ_INSERT_TAIL(idx, type, elm) do { \
-       struct type *list;                                      \
-       list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
-       rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
-       TAILQ_INSERT_TAIL(list, elm, next);                     \
-       rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
-} while (0)
-
 /**
- * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config
- *
- * @param idx
- *   a kind of tailq define in enum rte_tailq_t
- *
- * @param type
- *   type of list(tailq head)
- *
- * @param elm
- *   The element will be remove from the list
+ * 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.
  */
-#define RTE_EAL_TAILQ_REMOVE(idx, type, elm) do {      \
-       struct type *list;                                      \
-       list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
-       rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
-       TAILQ_REMOVE(list, elm, next);                          \
-       rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
-} while (0)                                                     \
-
+int rte_eal_has_hugepages(void);
 
 /**
- *  macro to check TAILQ exist
- *
- *  @param idx
- *    a kind of tailq define in enum rte_tailq_t
+ * A wrap API for syscall gettid.
  *
+ * @return
+ *   On success, returns the thread ID of calling process.
+ *   It is always successful.
  */
-#define RTE_EAL_TAILQ_EXIST_CHECK(idx) do {   \
-       if (RTE_TAILQ_LOOKUP_BY_IDX(idx, rte_tailq_head) == NULL){      \
-               rte_errno = E_RTE_NO_TAILQ;                             \
-               return NULL;                                            \
-       }                                                               \
-} while(0)
+int rte_sys_gettid(void);
 
 /**
- * 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.
+ * Get system unique thread id.
  *
  * @return
- *   Nonzero if hugepages are enabled.
+ *   On success, returns the thread ID of calling process.
+ *   It is always successful.
  */
-int rte_eal_has_hugepages(void);
+static inline int rte_gettid(void)
+{
+       static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
+       if (RTE_PER_LCORE(_thread_id) == -1)
+               RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
+       return RTE_PER_LCORE(_thread_id);
+}
 
 #ifdef __cplusplus
 }