From d45d81453e1f4618676ee723c48614a360dc33e2 Mon Sep 17 00:00:00 2001 From: Github Action Date: Thu, 4 Apr 2024 01:35:26 +0000 Subject: [PATCH] Updated documentation Signed-off-by: Github Action --- annotated.html | 69 +-- bpf2c_8h_source.html | 4 +- classes.html | 2 +- ebpf__api_8h_source.html | 6 +- ebpf__extension_8h_source.html | 4 +- ...rogram__attach__type__guids_8h_source.html | 4 +- ebpf__program__types_8h.html | 18 + ebpf__program__types_8h_source.html | 224 ++++---- ebpf__store__helper_8h_source.html | 6 +- ebpf__structs_8h_source.html | 4 +- ebpf__windows_8h.html | 20 +- ebpf__windows_8h_source.html | 178 +++--- functions_f.html | 3 +- functions_p.html | 4 +- functions_r.html | 3 + functions_vars_f.html | 3 +- functions_vars_p.html | 4 +- functions_vars_r.html | 3 + globals_b.html | 22 +- globals_defs.html | 3 + globals_e.html | 10 +- globals_type.html | 3 + search/all_0.js | 51 +- search/all_1.js | 30 +- search/all_10.js | 37 +- search/all_11.js | 46 +- search/all_12.js | 42 +- search/all_13.js | 24 +- search/all_14.js | 16 +- search/all_15.js | 4 +- search/all_16.js | 20 +- search/all_17.js | 2 +- search/all_2.js | 528 +++++++++--------- search/all_3.js | 44 +- search/all_4.js | 40 +- search/all_5.js | 466 ++++++++-------- search/all_6.js | 20 +- search/all_7.js | 8 +- search/all_8.js | 42 +- search/all_9.js | 56 +- search/all_a.js | 6 +- search/all_b.js | 60 +- search/all_c.js | 44 +- search/all_d.js | 24 +- search/all_e.js | 8 +- search/all_f.js | 72 +-- search/classes_0.js | 61 +- search/classes_1.js | 22 +- search/classes_2.js | 2 +- search/classes_3.js | 2 +- search/classes_4.js | 2 +- search/classes_5.js | 2 +- search/defines_0.js | 46 +- search/defines_1.js | 4 +- search/defines_10.js | 4 +- search/defines_2.js | 34 +- search/defines_3.js | 2 +- search/defines_4.js | 2 +- search/defines_5.js | 131 ++--- search/defines_6.js | 2 +- search/defines_7.js | 18 +- search/defines_8.js | 12 +- search/defines_9.js | 2 +- search/defines_a.js | 6 +- search/defines_b.js | 2 +- search/defines_c.js | 2 +- search/defines_d.js | 4 +- search/defines_e.js | 2 +- search/defines_f.js | 2 +- search/enums_0.js | 12 +- search/enums_1.js | 14 +- search/enums_2.js | 12 +- search/enumvalues_0.js | 2 +- search/enumvalues_1.js | 194 +++---- search/enumvalues_2.js | 90 +-- search/enumvalues_3.js | 4 +- search/enumvalues_4.js | 6 +- search/files_0.js | 14 +- search/files_1.js | 30 +- search/files_2.js | 2 +- search/files_3.js | 6 +- search/files_4.js | 4 +- search/files_5.js | 2 +- search/files_6.js | 2 +- search/files_7.js | 2 +- search/files_8.js | 4 +- search/files_9.js | 2 +- search/functions_0.js | 8 +- search/functions_1.js | 222 ++++---- search/functions_2.js | 2 +- search/functions_3.js | 64 +-- search/functions_4.js | 18 +- search/functions_5.js | 4 +- search/functions_6.js | 6 +- search/pages_0.js | 2 +- search/typedefs_0.js | 22 +- search/typedefs_1.js | 20 +- search/typedefs_2.js | 75 +-- search/typedefs_3.js | 2 +- search/typedefs_4.js | 2 +- search/typedefs_5.js | 2 +- search/typedefs_6.js | 6 +- search/typedefs_7.js | 8 +- search/typedefs_8.js | 10 +- search/typedefs_9.js | 6 +- search/typedefs_a.js | 8 +- search/typedefs_b.js | 6 +- search/variables_0.js | 4 +- search/variables_1.js | 26 +- search/variables_10.js | 33 +- search/variables_11.js | 28 +- search/variables_12.js | 36 +- search/variables_13.js | 10 +- search/variables_14.js | 16 +- search/variables_15.js | 2 +- search/variables_16.js | 2 +- search/variables_17.js | 2 +- search/variables_2.js | 20 +- search/variables_3.js | 42 +- search/variables_4.js | 36 +- search/variables_5.js | 62 +- search/variables_6.js | 18 +- search/variables_7.js | 4 +- search/variables_8.js | 20 +- search/variables_9.js | 32 +- search/variables_a.js | 6 +- search/variables_b.js | 34 +- search/variables_c.js | 32 +- search/variables_d.js | 18 +- search/variables_e.js | 6 +- search/variables_f.js | 58 +- ...ct__ebpf__helper__function__prototype.html | 16 + ...f__helper__function__prototype__flags.html | 102 ++++ 133 files changed, 2203 insertions(+), 2010 deletions(-) create mode 100644 struct__ebpf__helper__function__prototype__flags.html diff --git a/annotated.html b/annotated.html index 1961b4d751..68126164e7 100644 --- a/annotated.html +++ b/annotated.html @@ -78,40 +78,41 @@  C_ebpf_extension_program_dispatch_table  C_ebpf_helper_function_addresses  C_ebpf_helper_function_prototype - C_ebpf_map_definition_in_fileEBPF Map Definition as it appears in the maps section of an ELF file - C_ebpf_map_definition_in_memoryEBPF Map Definition as it is stored in memory - C_ebpf_map_infoEBPF Map Information - C_ebpf_program_data - C_ebpf_program_info - C_ebpf_program_section_info - C_ebpf_program_type_descriptor - C_ebpf_ring_buffer_map_async_query_result - C_ebpf_section_info - C_ebpf_stat - C_ebpf_test_run_options - C_ETHERNET_HEADER - C_helper_function_entryHelper function entry. This structure defines a helper function entry in the metadata table. The address of the helper function is written into the entry during load time. The helper_id and name are used to identify the helper function to bind to when the program is loaded - C_IPV4_HEADER - C_IPV6_HEADER - C_map_entryMap entry. This structure contains the address of the map and the map definition. The address is written into the entry during load time. The map definition is used to initialize the map when the program is loaded - C_map_initial_valuesMap initial values. This structure contains the initial values for a map. The values are used to initialize the map when the program is loaded. Values are specified as strings and are converted to the appropriate type based on the map definition. Only BPF_MAP_TYPE_ARRAY_OF_MAPS and BPF_MAP_TYPE_PROG_ARRAY map types are supported - C_metadata_tableMetadata table for a module. This structure is returned by the module's metadata function, get_metadata_table and contains information about the module including the list of programs and maps - C_program_entryProgram entry. This structure contains the address of the program and additional information about the program - Cbpf_attrParameters used by the bpf() API - Cbpf_create_map_attr - Cbpf_link_detach_attr_tAttributes used by BPF_LINK_DETACH - Cbpf_link_infoEBPF link information. This structure can be retrieved by calling bpf_obj_get_info_by_fd on a link fd - Cbpf_load_program_attr - Cbpf_map_infoEBPF map information. This structure can be retrieved by calling bpf_obj_get_info_by_fd on a map fd - Cbpf_obj_info_attr_tAttributes used by BPF_OBJ_GET_INFO_BY_FD - Cbpf_object_load_attr - Cbpf_prog_bind_map_attr_tAttributes used by BPF_PROG_BIND_MAP - Cbpf_prog_infoEBPF program information. This structure can be retrieved by calling bpf_obj_get_info_by_fd on a program fd - Cbpf_sock_addrData structure used as context for BPF_PROG_TYPE_CGROUP_SOCK_ADDR program type - Cebpf_api_verifier_stats_t - Ctcphdr - CUDP_HEADER_ - Cxdp_md_ + C_ebpf_helper_function_prototype_flags + C_ebpf_map_definition_in_fileEBPF Map Definition as it appears in the maps section of an ELF file + C_ebpf_map_definition_in_memoryEBPF Map Definition as it is stored in memory + C_ebpf_map_infoEBPF Map Information + C_ebpf_program_data + C_ebpf_program_info + C_ebpf_program_section_info + C_ebpf_program_type_descriptor + C_ebpf_ring_buffer_map_async_query_result + C_ebpf_section_info + C_ebpf_stat + C_ebpf_test_run_options + C_ETHERNET_HEADER + C_helper_function_entryHelper function entry. This structure defines a helper function entry in the metadata table. The address of the helper function is written into the entry during load time. The helper_id and name are used to identify the helper function to bind to when the program is loaded + C_IPV4_HEADER + C_IPV6_HEADER + C_map_entryMap entry. This structure contains the address of the map and the map definition. The address is written into the entry during load time. The map definition is used to initialize the map when the program is loaded + C_map_initial_valuesMap initial values. This structure contains the initial values for a map. The values are used to initialize the map when the program is loaded. Values are specified as strings and are converted to the appropriate type based on the map definition. Only BPF_MAP_TYPE_ARRAY_OF_MAPS and BPF_MAP_TYPE_PROG_ARRAY map types are supported + C_metadata_tableMetadata table for a module. This structure is returned by the module's metadata function, get_metadata_table and contains information about the module including the list of programs and maps + C_program_entryProgram entry. This structure contains the address of the program and additional information about the program + Cbpf_attrParameters used by the bpf() API + Cbpf_create_map_attr + Cbpf_link_detach_attr_tAttributes used by BPF_LINK_DETACH + Cbpf_link_infoEBPF link information. This structure can be retrieved by calling bpf_obj_get_info_by_fd on a link fd + Cbpf_load_program_attr + Cbpf_map_infoEBPF map information. This structure can be retrieved by calling bpf_obj_get_info_by_fd on a map fd + Cbpf_obj_info_attr_tAttributes used by BPF_OBJ_GET_INFO_BY_FD + Cbpf_object_load_attr + Cbpf_prog_bind_map_attr_tAttributes used by BPF_PROG_BIND_MAP + Cbpf_prog_infoEBPF program information. This structure can be retrieved by calling bpf_obj_get_info_by_fd on a program fd + Cbpf_sock_addrData structure used as context for BPF_PROG_TYPE_CGROUP_SOCK_ADDR program type + Cebpf_api_verifier_stats_t + Ctcphdr + CUDP_HEADER_ + Cxdp_md_ diff --git a/bpf2c_8h_source.html b/bpf2c_8h_source.html index a50bf52ae8..e93a42841c 100644 --- a/bpf2c_8h_source.html +++ b/bpf2c_8h_source.html @@ -217,8 +217,8 @@
struct _bpf2c_version bpf2c_version_t
Version information for the bpf2c compiler. This structure contains the version information for the b...
struct _metadata_table metadata_table_t
Metadata table for a module. This structure is returned by the module's metadata function,...
This file contains eBPF definitions common to eBPF programs, core execution engine as well as eBPF AP...
-
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:60
-
GUID ebpf_program_type_t
Definition: ebpf_windows.h:59
+
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:62
+
GUID ebpf_program_type_t
Definition: ebpf_windows.h:61
Version information for the bpf2c compiler. This structure contains the version information for the b...
Definition: bpf2c.h:120
uint32_t major
Definition: bpf2c.h:121
diff --git a/classes.html b/classes.html index 660ed28270..4cc27d9f66 100644 --- a/classes.html +++ b/classes.html @@ -84,7 +84,7 @@
xdp_md_
_
-
_bind_md
_bpf2c_version
_bpf_sock_ops
_ebpf_attach_provider_data
_ebpf_execution_context_state
_ebpf_extension_data
_ebpf_extension_dispatch_table
_ebpf_extension_header
_ebpf_extension_program_dispatch_table
_ebpf_helper_function_addresses
_ebpf_helper_function_prototype
_ebpf_map_definition_in_file
_ebpf_map_definition_in_memory
_ebpf_map_info
_ebpf_program_data
_ebpf_program_info
_ebpf_program_section_info
_ebpf_program_type_descriptor
_ebpf_ring_buffer_map_async_query_result
_ebpf_section_info
_ebpf_stat
_ebpf_test_run_options
_ETHERNET_HEADER
_helper_function_entry
_IPV4_HEADER
_IPV6_HEADER
_map_entry
_map_initial_values
_metadata_table
_program_entry
+
_bind_md
_bpf2c_version
_bpf_sock_ops
_ebpf_attach_provider_data
_ebpf_execution_context_state
_ebpf_extension_data
_ebpf_extension_dispatch_table
_ebpf_extension_header
_ebpf_extension_program_dispatch_table
_ebpf_helper_function_addresses
_ebpf_helper_function_prototype
_ebpf_helper_function_prototype_flags
_ebpf_map_definition_in_file
_ebpf_map_definition_in_memory
_ebpf_map_info
_ebpf_program_data
_ebpf_program_info
_ebpf_program_section_info
_ebpf_program_type_descriptor
_ebpf_ring_buffer_map_async_query_result
_ebpf_section_info
_ebpf_stat
_ebpf_test_run_options
_ETHERNET_HEADER
_helper_function_entry
_IPV4_HEADER
_IPV6_HEADER
_map_entry
_map_initial_values
_metadata_table
_program_entry
diff --git a/ebpf__api_8h_source.html b/ebpf__api_8h_source.html index 18e53f213b..0b26cb906a 100644 --- a/ebpf__api_8h_source.html +++ b/ebpf__api_8h_source.html @@ -321,10 +321,10 @@
enum ebpf_result ebpf_result_t
-
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:60
-
GUID ebpf_program_type_t
Definition: ebpf_windows.h:59
+
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:62
+
GUID ebpf_program_type_t
Definition: ebpf_windows.h:61
eBPF Map Information
Definition: ebpf_core_structs.h:21
-
Definition: ebpf_program_types.h:38
+
Definition: ebpf_program_types.h:44
Definition: ebpf_api.h:56
struct _ebpf_section_info * next
Definition: ebpf_api.h:57
_Field_z_ const char * section_name
Definition: ebpf_api.h:58
diff --git a/ebpf__extension_8h_source.html b/ebpf__extension_8h_source.html index b1724e1e22..095ef43767 100644 --- a/ebpf__extension_8h_source.html +++ b/ebpf__extension_8h_source.html @@ -161,7 +161,7 @@
bpf_link_type
Definition: ebpf_structs.h:243
enum bpf_attach_type bpf_attach_type_t
Definition: ebpf_structs.h:321
-
GUID ebpf_program_type_t
Definition: ebpf_windows.h:59
+
GUID ebpf_program_type_t
Definition: ebpf_windows.h:61
Definition: ebpf_extension.h:95
ebpf_extension_header_t header
Definition: ebpf_extension.h:96
ebpf_program_type_t supported_program_type
Definition: ebpf_extension.h:97
@@ -183,7 +183,7 @@
uint16_t version
Version of the dispatch table.
Definition: ebpf_extension.h:13
uint16_t count
Number of entries in the dispatch table.
Definition: ebpf_extension.h:14
_Field_size_(count) _ebpf_extension_dispatch_function function[1]
-
Header of an eBPF extension data structure. Every eBPF extension data structure must start with this ...
Definition: ebpf_windows.h:109
+
Header of an eBPF extension data structure. Every eBPF extension data structure must start with this ...
Definition: ebpf_windows.h:111
Definition: ebpf_extension.h:79
ebpf_program_invoke_function_t ebpf_program_invoke_function
Definition: ebpf_extension.h:82
ebpf_program_batch_begin_invoke_function_t ebpf_program_batch_begin_invoke_function
Definition: ebpf_extension.h:83
diff --git a/ebpf__program__attach__type__guids_8h_source.html b/ebpf__program__attach__type__guids_8h_source.html index be0fb76d37..3fe146adf7 100644 --- a/ebpf__program__attach__type__guids_8h_source.html +++ b/ebpf__program__attach__type__guids_8h_source.html @@ -225,8 +225,8 @@
ebpf_program_type_t EBPF_PROGRAM_TYPE_CGROUP_SOCK_ADDR
Program type for handling various socket operations such as connect(), accept() etc.
Definition: ebpf_program_attach_type_guids.h:169
ebpf_program_type_t EBPF_PROGRAM_TYPE_UNSPECIFIED
Definition: ebpf_program_attach_type_guids.h:121
-
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:60
-
GUID ebpf_program_type_t
Definition: ebpf_windows.h:59
+
GUID ebpf_attach_type_t
Definition: ebpf_windows.h:62
+
GUID ebpf_program_type_t
Definition: ebpf_windows.h:61