X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_eal%2Fcommon%2Finclude%2Frte_eal.h;h=bf0c74e074d7a3864a98a9810ca9b96e5743a97c;hb=18218713bf4248c4c6b97a12231e7d59b8a86865;hp=d1cc89eda71eeb6715c2142d26bf32bd7bfe4879;hpb=ce3a7312357ba636dea4e326e5676615502805c5;p=dpdk.git diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h index d1cc89eda7..bf0c74e074 100644 --- a/lib/librte_eal/common/include/rte_eal.h +++ b/lib/librte_eal/common/include/rte_eal.h @@ -41,7 +41,7 @@ enum rte_lcore_role_t { }; /** - * The type of process in a linuxapp, multi-process setup + * The type of process in a linux, multi-process setup */ enum rte_proc_type_t { RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */ @@ -57,6 +57,8 @@ enum rte_proc_type_t { struct rte_config { uint32_t master_lcore; /**< Id of the master lcore */ uint32_t lcore_count; /**< Number of available logical cores. */ + uint32_t numa_node_count; /**< Number of detected NUMA nodes. */ + uint32_t numa_nodes[RTE_MAX_NUMA_NODES]; /**< List of detected NUMA nodes. */ uint32_t service_lcore_count;/**< Number of available service cores. */ enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */ @@ -172,9 +174,6 @@ int rte_eal_iopl_init(void); int rte_eal_init(int argc, char **argv); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Clean up the Environment Abstraction Layer (EAL) * * This function must be called to release any internal resources that EAL has @@ -185,7 +184,7 @@ int rte_eal_init(int argc, char **argv); * @return 0 Successfully released all internal EAL resources * @return -EFAULT There was an error in releasing all resources. */ -int __rte_experimental rte_eal_cleanup(void); +int rte_eal_cleanup(void); /** * Check if a primary process is currently alive @@ -226,9 +225,33 @@ struct rte_mp_reply { * * As we create socket channel for primary/secondary communication, use * this function typedef to register action for coming messages. + * + * @note When handling IPC request callbacks, the reply must be sent even in + * cases of error handling. Simply returning success or failure will *not* + * send a response to the requestor. + * Implementation of error signalling mechanism is up to the application. + * + * @note No memory allocations should take place inside the callback. */ typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer); +/** + * Asynchronous reply function typedef used by other components. + * + * As we create socket channel for primary/secondary communication, use + * this function typedef to register action for coming responses to asynchronous + * requests. + * + * @note When handling IPC request callbacks, the reply must be sent even in + * cases of error handling. Simply returning success or failure will *not* + * send a response to the requestor. + * Implementation of error signalling mechanism is up to the application. + * + * @note No memory allocations should take place inside the callback. + */ +typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request, + const struct rte_mp_reply *reply); + /** * @warning * @b EXPERIMENTAL: this API may change without prior notice @@ -239,6 +262,9 @@ typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer); * to response the messages from the corresponding component in its primary * process or secondary processes. * + * @note IPC may be unsupported in certain circumstances, so caller should check + * for ENOTSUP error. + * * @param name * The name argument plays as the nonredundant key to find the action. * @@ -249,7 +275,8 @@ typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer); * - 0 on success. * - (<0) on failure. */ -int __rte_experimental +__rte_experimental +int rte_mp_action_register(const char *name, rte_mp_t action); /** @@ -262,11 +289,15 @@ rte_mp_action_register(const char *name, rte_mp_t action); * not want to response the messages from the corresponding component in its * primary process or secondary processes. * + * @note IPC may be unsupported in certain circumstances, so caller should check + * for ENOTSUP error. + * * @param name * The name argument plays as the nonredundant key to find the action. * */ -void __rte_experimental +__rte_experimental +void rte_mp_action_unregister(const char *name); /** @@ -275,7 +306,7 @@ rte_mp_action_unregister(const char *name); * * Send a message to the peer process. * - * This function will send a message which will be responsed by the action + * This function will send a message which will be responded by the action * identified by name in the peer process. * * @param msg @@ -285,7 +316,8 @@ rte_mp_action_unregister(const char *name); * - On success, return 0. * - On failure, return -1, and the reason will be stored in rte_errno. */ -int __rte_experimental +__rte_experimental +int rte_mp_sendmsg(struct rte_mp_msg *msg); /** @@ -299,12 +331,18 @@ rte_mp_sendmsg(struct rte_mp_msg *msg); * * @note The caller is responsible to free reply->replies. * + * @note This API must not be used inside memory-related or IPC callbacks, and + * no memory allocations should take place inside such callback. + * + * @note IPC may be unsupported in certain circumstances, so caller should check + * for ENOTSUP error. + * * @param req * The req argument contains the customized request message. * * @param reply * The reply argument will be for storing all the replied messages; - * the caller is responsible for free reply->replies. + * the caller is responsible for free reply->msgs. * * @param ts * The ts argument specifies how long we can wait for the peer(s) to reply. @@ -313,10 +351,41 @@ rte_mp_sendmsg(struct rte_mp_msg *msg); * - On success, return 0. * - On failure, return -1, and the reason will be stored in rte_errno. */ -int __rte_experimental +__rte_experimental +int rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply, const struct timespec *ts); +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice + * + * Send a request to the peer process and expect a reply in a separate callback. + * + * This function sends a request message to the peer process, and will not + * block. Instead, reply will be received in a separate callback. + * + * @note IPC may be unsupported in certain circumstances, so caller should check + * for ENOTSUP error. + * + * @param req + * The req argument contains the customized request message. + * + * @param ts + * The ts argument specifies how long we can wait for the peer(s) to reply. + * + * @param clb + * The callback to trigger when all responses for this request have arrived. + * + * @return + * - On success, return 0. + * - On failure, return -1, and the reason will be stored in rte_errno. + */ +__rte_experimental +int +rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts, + rte_mp_async_reply_t clb); + /** * @warning * @b EXPERIMENTAL: this API may change without prior notice @@ -326,6 +395,11 @@ rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply, * This function will send a reply message in response to a request message * received previously. * + * @note When handling IPC request callbacks, the reply must be sent even in + * cases of error handling. Simply returning success or failure will *not* + * send a response to the requestor. + * Implementation of error signalling mechanism is up to the application. + * * @param msg * The msg argument contains the customized message. * @@ -336,7 +410,8 @@ rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply, * - On success, return 0. * - On failure, return -1, and the reason will be stored in rte_errno. */ -int __rte_experimental +__rte_experimental +int rte_mp_reply(struct rte_mp_msg *msg, const char *peer); /** @@ -377,7 +452,7 @@ rte_set_application_usage_hook(rte_usage_hook_t usage_func); #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock) /** - * macro to get the multiple lock of mempool shared by mutiple-instance + * macro to get the multiple lock of mempool shared by multiple-instance */ #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock) @@ -452,25 +527,22 @@ static inline int rte_gettid(void) enum rte_iova_mode rte_eal_iova_mode(void); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Get user provided pool ops name for mbuf * * @return * returns user provided pool ops name. */ -const char * __rte_experimental +const char * rte_eal_mbuf_user_pool_ops(void); /** - * Get default pool ops name for mbuf + * Get the runtime directory of DPDK * * @return - * returns default pool ops name. + * The runtime directory path of DPDK */ const char * -rte_eal_mbuf_default_mempool_ops(void); +rte_eal_get_runtime_dir(void); #ifdef __cplusplus }