Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doxygen style comments to all common ebpf headers #58

Merged
merged 12 commits into from
Apr 23, 2021
Prev Previous commit
Next Next commit
PR feedback
Signed-off-by: Alan Jowett <alanjo@microsoft.com>
  • Loading branch information
Alan-Jowett committed Apr 23, 2021
commit aebd6af724ae263f6a0df7c88feca9bb90a4869d
24 changes: 24 additions & 0 deletions src/ebpf/include/ebpf_platform.h
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,25 @@ extern "C"
int32_t
ebpf_interlocked_compare_exchange_int32(volatile int32_t* destination, int32_t exchange, int32_t comperand);

/**
* @brief Load an extension and get it's dispatch table.
*
* @param[out] client_context Context used to unload the extension.
* @param[in] client_id GUID representing the identity of the client.
* @param[in] client_data Opaque client data passed to the extension.
* @param[in] client_data_length Length of the client data.
* @param[in] client_dispatch_table Table of function pointers the client
* exposes.
* @param[in] provider_id GUID representing the extension to load.
* @param[out] provider_data Opaque provider data.
* @param[out] provider_data_length Length of the provider data.
* @param[out] provider_dispatch_table Table of function pointer the
* provider exposes.
* @retval EBPF_ERROR_SUCCESS The operation was successful.
* @retval EBPF_ERROR_NOT_FOUND The provider was not found.
* @retval EBPF_ERROR_OUT_OF_RESOURCES Unable to allocate resources for this
* operation.
*/
ebpf_error_code_t
ebpf_extension_load(
ebpf_extension_client_t** client_context,
Expand All @@ -411,6 +430,11 @@ extern "C"
size_t* provider_data_length,
ebpf_extension_dispatch_table_t** provider_dispatch_table);

/**
* @brief Unload an extension.
*
* @param client_context Context of the extension to unload.
*/
void
ebpf_extension_unload(ebpf_extension_client_t* client_context);

Expand Down