X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_eal%2Fcommon%2Finclude%2Frte_eal.h;h=2f9ed298de63eea593b5712e5462d36d752910cf;hb=df3ff6be2b33faea3edf3c112b9bdc5b74d6f684;hp=c698b3155c7a125577bf414fced6f9a70ac7ee49;hpb=952b20777255d203dafd813b1adfb4b9d6b449d1;p=dpdk.git diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h index c698b3155c..2f9ed298de 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 */ @@ -51,49 +51,6 @@ enum rte_proc_type_t { RTE_PROC_INVALID }; -/** - * The global RTE configuration structure. - */ -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. */ - - /** Primary or secondary configuration */ - enum rte_proc_type_t process_type; - - /** PA or VA mapping mode */ - enum rte_iova_mode iova_mode; - - /** - * Pointer to memory configuration, which may be shared across multiple - * DPDK instances - */ - struct rte_mem_config *mem_config; -} __attribute__((__packed__)); - -/** - * Get the global configuration structure. - * - * @return - * A pointer to the global configuration structure. - */ -struct rte_config *rte_eal_get_configuration(void); - -/** - * Get a lcore's role. - * - * @param lcore_id - * The identifier of the lcore. - * @return - * The role of the lcore. - */ -enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id); - - /** * Get the process type in a multi-process setup * @@ -174,9 +131,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 @@ -187,7 +141,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 @@ -228,6 +182,13 @@ 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); @@ -237,6 +198,13 @@ typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer); * 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); @@ -251,6 +219,9 @@ typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request, * 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. * @@ -261,7 +232,8 @@ typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request, * - 0 on success. * - (<0) on failure. */ -int __rte_experimental +__rte_experimental +int rte_mp_action_register(const char *name, rte_mp_t action); /** @@ -274,11 +246,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); /** @@ -287,7 +263,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 @@ -297,7 +273,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); /** @@ -311,12 +288,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. @@ -325,7 +308,8 @@ 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); @@ -338,6 +322,9 @@ rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply, * 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. * @@ -351,7 +338,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_request_async(struct rte_mp_msg *req, const struct timespec *ts, rte_mp_async_reply_t clb); @@ -364,6 +352,11 @@ rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts, * 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. * @@ -374,7 +367,8 @@ rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts, * - 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); /** @@ -409,22 +403,9 @@ typedef void (*rte_usage_hook_t)(const char * prgname); 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) - /** * 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. + * The no-huge mode is not compatible with all drivers or features. * * @return * Nonzero if hugepages are enabled. @@ -490,25 +471,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 }