ebpf-for-windows/include/ebpf_extension.h

129 строки
4.6 KiB
C

// Copyright (c) eBPF for Windows contributors
// SPDX-License-Identifier: MIT
#pragma once
#include "ebpf_result.h"
#include "ebpf_structs.h"
#include "ebpf_windows.h"
typedef ebpf_result_t (*_ebpf_extension_dispatch_function)();
typedef struct _ebpf_extension_dispatch_table
{
uint16_t version; ///< Version of the dispatch table.
uint16_t count; ///< Number of entries in the dispatch table.
_Field_size_(count) _ebpf_extension_dispatch_function function[1];
} ebpf_extension_dispatch_table_t;
/**
* @brief Invoke the eBPF program.
*
* @param[in] extension_client_binding_context The context provided by the extension client when the binding was
* created.
* @param[in,out] program_context The context for this invocation of the eBPF program.
* @param[out] result The result of the eBPF program.
*
* @retval EBPF_SUCCESS The operation was successful.
* @retval EBPF_NO_MEMORY The operation failed due to lack of memory.
* @retval EBPF_EXTENSION_FAILED_TO_LOAD The required extension is not loaded.
*/
typedef ebpf_result_t (*ebpf_program_invoke_function_t)(
_In_ const void* extension_client_binding_context, _Inout_ void* program_context, _Out_ uint32_t* result);
/**
* @brief Prepare the eBPF program for batch invocation.
*
* @param[in] state_size The size of the state to be allocated, which should be greater than or equal to
* sizeof(ebpf_execution_context_state_t).
* @param[out] state The state to be used for batch invocation.
*
* @retval EBPF_SUCCESS The operation was successful.
* @retval EBPF_NO_MEMORY The operation failed due to lack of memory.
* @retval EBPF_EXTENSION_FAILED_TO_LOAD The required extension is not loaded.
*/
typedef ebpf_result_t (*ebpf_program_batch_begin_invoke_function_t)(
size_t state_size, _Out_writes_(state_size) void* state);
/**
* @brief Invoke the eBPF program in batch mode.
*
* @param[in] extension_client_binding_context The context provided by the extension client when the binding was
* created.
* @param[in,out] program_context The context for this invocation of the eBPF program.
* @param[out] result The result of the eBPF program.
* @param[in] state The state to be used for batch invocation.
*
* @retval EBPF_SUCCESS The operation was successful.
*/
typedef ebpf_result_t (*ebpf_program_batch_invoke_function_t)(
_In_ const void* extension_client_binding_context,
_Inout_ void* program_context,
_Out_ uint32_t* result,
_In_ const void* state);
/**
* @brief Clean up the eBPF program after batch invocation.
*
* @param[in,out] state The state to be used for batch invocation.
*
* @retval EBPF_SUCCESS The operation was successful.
*/
typedef ebpf_result_t (*ebpf_program_batch_end_invoke_function_t)(_Inout_ void* state);
typedef enum _ebpf_link_dispatch_table_version
{
EBPF_LINK_DISPATCH_TABLE_VERSION_1 = 1, ///< Initial version of the dispatch table.
EBPF_LINK_DISPATCH_TABLE_VERSION_CURRENT =
EBPF_LINK_DISPATCH_TABLE_VERSION_1, ///< Current version of the dispatch table.
} ebpf_link_dispatch_table_version_t;
#define EBPF_LINK_DISPATCH_TABLE_FUNCTION_COUNT_1 4
#define EBPF_LINK_DISPATCH_TABLE_FUNCTION_COUNT_CURRENT \
EBPF_LINK_DISPATCH_TABLE_FUNCTION_COUNT_1 ///< Current number of functions in the dispatch table.
typedef struct _ebpf_extension_program_dispatch_table
{
uint16_t version; ///< Version of the dispatch table.
uint16_t count; ///< Number of entries in the dispatch table.
ebpf_program_invoke_function_t ebpf_program_invoke_function;
ebpf_program_batch_begin_invoke_function_t ebpf_program_batch_begin_invoke_function;
ebpf_program_batch_invoke_function_t ebpf_program_batch_invoke_function;
ebpf_program_batch_end_invoke_function_t ebpf_program_batch_end_invoke_function;
} ebpf_extension_program_dispatch_table_t;
typedef struct _ebpf_extension_data
{
ebpf_extension_header_t header;
const void* data;
} ebpf_extension_data_t;
typedef struct _ebpf_attach_provider_data
{
ebpf_extension_header_t header;
ebpf_program_type_t supported_program_type;
bpf_attach_type_t bpf_attach_type;
enum bpf_link_type link_type;
} ebpf_attach_provider_data_t;
/***
* The state of the execution context when the eBPF program was invoked.
* This is used to cache state that won't change during the execution of
* the eBPF program and is expensive to query.
*/
typedef struct _ebpf_execution_context_state
{
uint64_t epoch_state[4];
union
{
uint64_t thread;
uint32_t cpu;
} id;
uint8_t current_irql;
struct
{
const void* next_program;
uint32_t count;
} tail_call_state;
} ebpf_execution_context_state_t;
#define EBPF_CONTEXT_HEADER uint64_t context_header[8]