};
/**
- * 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 */
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
* @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
*
* 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);
* 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);
* 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.
*
* - 0 on success.
* - (<0) on failure.
*/
-int __rte_experimental
+__rte_experimental
+int
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);
/**
*
* 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
* - 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);
/**
*
* @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.
* - 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);
* 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.
*
* - 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);
* 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.
*
* - 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);
/**
#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)
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
}
git.droids-corp.org / dpdk.git / blobdiff