eal: add application usage hook

[dpdk.git] / lib / librte_eal / common / include / rte_eal.h

diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h
index 61ed408..1df8d10 100644 (file)
--- a/lib/librte_eal/common/include/rte_eal.h
+++ b/lib/librte_eal/common/include/rte_eal.h
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
  *   All rights reserved.
  * 
  *   Redistribution and use in source and binary forms, with or without 
@@ -146,7 +146,107 @@ enum rte_proc_type_t rte_eal_process_type(void);
  *   - On failure, a negative error value.
  */
 int rte_eal_init(int argc, char **argv);
+/**
+ * Usage function typedef used by the application usage function.
+ *
+ * Use this function typedef to define and call rte_set_applcation_usage_hook()
+ * routine.
+ */
+typedef void   (*rte_usage_hook_t)(const char * prgname);
 
+/**
+ * Add application usage routine callout from the eal_usage() routine.
+ *
+ * This function allows the application to include its usage message
+ * in the EAL system usage message. The routine rte_set_application_usage_hook()
+ * needs to be called before the rte_eal_init() routine in the application.
+ *
+ * This routine is optional for the application and will behave as if the set
+ * routine was never called as the default behavior.
+ *
+ * @param 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).
+ *
+ *   Calling this routine with a NULL value will reset the usage hook routine and
+ *   return the current value, which could be NULL.
+ * @return
+ *   - Returns the current value of the rte_application_usage pointer to allow
+ *     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 );
+
+/**
+ * macro to get the lock of tailq in mem_config 
+ */
+#define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
+
+/**
+ * macro to get the multiple lock of mempool shared by mutiple-instance
+ */
+#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
+ *
+ */
+#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)                                                     \
+
+
+/**
+ *  macro to check TAILQ exist
+ *
+ *  @param idx
+ *    a kind of tailq define in enum rte_tailq_t
+ *
+ */
+#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)
+
+ 
 #ifdef __cplusplus
 }
 #endif