Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Github Action <[email protected]>
  • Loading branch information
Github Action committed Apr 4, 2024
1 parent fe5b216 commit d45d814
Show file tree
Hide file tree
Showing 133 changed files with 2,203 additions and 2,010 deletions.
69 changes: 35 additions & 34 deletions annotated.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions bpf2c_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,8 @@
<div class="ttc" id="abpf2c_8h_html_ab89f9a3008e6862217c45fc719bc5869"><div class="ttname"><a href="bpf2c_8h.html#ab89f9a3008e6862217c45fc719bc5869">bpf2c_version_t</a></div><div class="ttdeci">struct _bpf2c_version bpf2c_version_t</div><div class="ttdoc">Version information for the bpf2c compiler. This structure contains the version information for the b...</div></div>
<div class="ttc" id="abpf2c_8h_html_ae777b2c463d86d373db6806421ee42ff"><div class="ttname"><a href="bpf2c_8h.html#ae777b2c463d86d373db6806421ee42ff">metadata_table_t</a></div><div class="ttdeci">struct _metadata_table metadata_table_t</div><div class="ttdoc">Metadata table for a module. This structure is returned by the module's metadata function,...</div></div>
<div class="ttc" id="aebpf__structs_8h_html"><div class="ttname"><a href="ebpf__structs_8h.html">ebpf_structs.h</a></div><div class="ttdoc">This file contains eBPF definitions common to eBPF programs, core execution engine as well as eBPF AP...</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a3f56868552f991b0f9eb6800d8f9a43c"><div class="ttname"><a href="ebpf__windows_8h.html#a3f56868552f991b0f9eb6800d8f9a43c">ebpf_attach_type_t</a></div><div class="ttdeci">GUID ebpf_attach_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:60</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a7392ed9f9037688cd94f7069c523c251"><div class="ttname"><a href="ebpf__windows_8h.html#a7392ed9f9037688cd94f7069c523c251">ebpf_program_type_t</a></div><div class="ttdeci">GUID ebpf_program_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:59</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a3f56868552f991b0f9eb6800d8f9a43c"><div class="ttname"><a href="ebpf__windows_8h.html#a3f56868552f991b0f9eb6800d8f9a43c">ebpf_attach_type_t</a></div><div class="ttdeci">GUID ebpf_attach_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:62</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a7392ed9f9037688cd94f7069c523c251"><div class="ttname"><a href="ebpf__windows_8h.html#a7392ed9f9037688cd94f7069c523c251">ebpf_program_type_t</a></div><div class="ttdeci">GUID ebpf_program_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:61</div></div>
<div class="ttc" id="astddef_8h_html"><div class="ttname"><a href="stddef_8h.html">stddef.h</a></div></div>
<div class="ttc" id="astruct__bpf2c__version_html"><div class="ttname"><a href="struct__bpf2c__version.html">_bpf2c_version</a></div><div class="ttdoc">Version information for the bpf2c compiler. This structure contains the version information for the b...</div><div class="ttdef"><b>Definition:</b> bpf2c.h:120</div></div>
<div class="ttc" id="astruct__bpf2c__version_html_a6679b94465a4de568d747d2ed0f646ed"><div class="ttname"><a href="struct__bpf2c__version.html#a6679b94465a4de568d747d2ed0f646ed">_bpf2c_version::major</a></div><div class="ttdeci">uint32_t major</div><div class="ttdef"><b>Definition:</b> bpf2c.h:121</div></div>
Expand Down
2 changes: 1 addition & 1 deletion classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<dd><a class="el" href="structxdp__md__.html">xdp_md_</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter__">_</a></dt>
<dd><a class="el" href="struct__bind__md.html">_bind_md</a></dd><dd><a class="el" href="struct__bpf2c__version.html">_bpf2c_version</a></dd><dd><a class="el" href="struct__bpf__sock__ops.html">_bpf_sock_ops</a></dd><dd><a class="el" href="struct__ebpf__attach__provider__data.html">_ebpf_attach_provider_data</a></dd><dd><a class="el" href="struct__ebpf__execution__context__state.html">_ebpf_execution_context_state</a></dd><dd><a class="el" href="struct__ebpf__extension__data.html">_ebpf_extension_data</a></dd><dd><a class="el" href="struct__ebpf__extension__dispatch__table.html">_ebpf_extension_dispatch_table</a></dd><dd><a class="el" href="struct__ebpf__extension__header.html">_ebpf_extension_header</a></dd><dd><a class="el" href="struct__ebpf__extension__program__dispatch__table.html">_ebpf_extension_program_dispatch_table</a></dd><dd><a class="el" href="struct__ebpf__helper__function__addresses.html">_ebpf_helper_function_addresses</a></dd><dd><a class="el" href="struct__ebpf__helper__function__prototype.html">_ebpf_helper_function_prototype</a></dd><dd><a class="el" href="struct__ebpf__map__definition__in__file.html">_ebpf_map_definition_in_file</a></dd><dd><a class="el" href="struct__ebpf__map__definition__in__memory.html">_ebpf_map_definition_in_memory</a></dd><dd><a class="el" href="struct__ebpf__map__info.html">_ebpf_map_info</a></dd><dd><a class="el" href="struct__ebpf__program__data.html">_ebpf_program_data</a></dd><dd><a class="el" href="struct__ebpf__program__info.html">_ebpf_program_info</a></dd><dd><a class="el" href="struct__ebpf__program__section__info.html">_ebpf_program_section_info</a></dd><dd><a class="el" href="struct__ebpf__program__type__descriptor.html">_ebpf_program_type_descriptor</a></dd><dd><a class="el" href="struct__ebpf__ring__buffer__map__async__query__result.html">_ebpf_ring_buffer_map_async_query_result</a></dd><dd><a class="el" href="struct__ebpf__section__info.html">_ebpf_section_info</a></dd><dd><a class="el" href="struct__ebpf__stat.html">_ebpf_stat</a></dd><dd><a class="el" href="struct__ebpf__test__run__options.html">_ebpf_test_run_options</a></dd><dd><a class="el" href="struct___e_t_h_e_r_n_e_t___h_e_a_d_e_r.html">_ETHERNET_HEADER</a></dd><dd><a class="el" href="struct__helper__function__entry.html">_helper_function_entry</a></dd><dd><a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html">_IPV4_HEADER</a></dd><dd><a class="el" href="struct___i_p_v6___h_e_a_d_e_r.html">_IPV6_HEADER</a></dd><dd><a class="el" href="struct__map__entry.html">_map_entry</a></dd><dd><a class="el" href="struct__map__initial__values.html">_map_initial_values</a></dd><dd><a class="el" href="struct__metadata__table.html">_metadata_table</a></dd><dd><a class="el" href="struct__program__entry.html">_program_entry</a></dd></dl>
<dd><a class="el" href="struct__bind__md.html">_bind_md</a></dd><dd><a class="el" href="struct__bpf2c__version.html">_bpf2c_version</a></dd><dd><a class="el" href="struct__bpf__sock__ops.html">_bpf_sock_ops</a></dd><dd><a class="el" href="struct__ebpf__attach__provider__data.html">_ebpf_attach_provider_data</a></dd><dd><a class="el" href="struct__ebpf__execution__context__state.html">_ebpf_execution_context_state</a></dd><dd><a class="el" href="struct__ebpf__extension__data.html">_ebpf_extension_data</a></dd><dd><a class="el" href="struct__ebpf__extension__dispatch__table.html">_ebpf_extension_dispatch_table</a></dd><dd><a class="el" href="struct__ebpf__extension__header.html">_ebpf_extension_header</a></dd><dd><a class="el" href="struct__ebpf__extension__program__dispatch__table.html">_ebpf_extension_program_dispatch_table</a></dd><dd><a class="el" href="struct__ebpf__helper__function__addresses.html">_ebpf_helper_function_addresses</a></dd><dd><a class="el" href="struct__ebpf__helper__function__prototype.html">_ebpf_helper_function_prototype</a></dd><dd><a class="el" href="struct__ebpf__helper__function__prototype__flags.html">_ebpf_helper_function_prototype_flags</a></dd><dd><a class="el" href="struct__ebpf__map__definition__in__file.html">_ebpf_map_definition_in_file</a></dd><dd><a class="el" href="struct__ebpf__map__definition__in__memory.html">_ebpf_map_definition_in_memory</a></dd><dd><a class="el" href="struct__ebpf__map__info.html">_ebpf_map_info</a></dd><dd><a class="el" href="struct__ebpf__program__data.html">_ebpf_program_data</a></dd><dd><a class="el" href="struct__ebpf__program__info.html">_ebpf_program_info</a></dd><dd><a class="el" href="struct__ebpf__program__section__info.html">_ebpf_program_section_info</a></dd><dd><a class="el" href="struct__ebpf__program__type__descriptor.html">_ebpf_program_type_descriptor</a></dd><dd><a class="el" href="struct__ebpf__ring__buffer__map__async__query__result.html">_ebpf_ring_buffer_map_async_query_result</a></dd><dd><a class="el" href="struct__ebpf__section__info.html">_ebpf_section_info</a></dd><dd><a class="el" href="struct__ebpf__stat.html">_ebpf_stat</a></dd><dd><a class="el" href="struct__ebpf__test__run__options.html">_ebpf_test_run_options</a></dd><dd><a class="el" href="struct___e_t_h_e_r_n_e_t___h_e_a_d_e_r.html">_ETHERNET_HEADER</a></dd><dd><a class="el" href="struct__helper__function__entry.html">_helper_function_entry</a></dd><dd><a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html">_IPV4_HEADER</a></dd><dd><a class="el" href="struct___i_p_v6___h_e_a_d_e_r.html">_IPV6_HEADER</a></dd><dd><a class="el" href="struct__map__entry.html">_map_entry</a></dd><dd><a class="el" href="struct__map__initial__values.html">_map_initial_values</a></dd><dd><a class="el" href="struct__metadata__table.html">_metadata_table</a></dd><dd><a class="el" href="struct__program__entry.html">_program_entry</a></dd></dl>
</div>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
6 changes: 3 additions & 3 deletions ebpf__api_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -321,10 +321,10 @@
<div class="ttc" id="aebpf__program__attach__type__guids_8h_html"><div class="ttname"><a href="ebpf__program__attach__type__guids_8h.html">ebpf_program_attach_type_guids.h</a></div></div>
<div class="ttc" id="aebpf__result_8h_html"><div class="ttname"><a href="ebpf__result_8h.html">ebpf_result.h</a></div></div>
<div class="ttc" id="aebpf__result_8h_html_ac40fcf7ca8c88cd1975ade33fda0b333"><div class="ttname"><a href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a></div><div class="ttdeci">enum ebpf_result ebpf_result_t</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a3f56868552f991b0f9eb6800d8f9a43c"><div class="ttname"><a href="ebpf__windows_8h.html#a3f56868552f991b0f9eb6800d8f9a43c">ebpf_attach_type_t</a></div><div class="ttdeci">GUID ebpf_attach_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:60</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a7392ed9f9037688cd94f7069c523c251"><div class="ttname"><a href="ebpf__windows_8h.html#a7392ed9f9037688cd94f7069c523c251">ebpf_program_type_t</a></div><div class="ttdeci">GUID ebpf_program_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:59</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a3f56868552f991b0f9eb6800d8f9a43c"><div class="ttname"><a href="ebpf__windows_8h.html#a3f56868552f991b0f9eb6800d8f9a43c">ebpf_attach_type_t</a></div><div class="ttdeci">GUID ebpf_attach_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:62</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a7392ed9f9037688cd94f7069c523c251"><div class="ttname"><a href="ebpf__windows_8h.html#a7392ed9f9037688cd94f7069c523c251">ebpf_program_type_t</a></div><div class="ttdeci">GUID ebpf_program_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:61</div></div>
<div class="ttc" id="astruct__ebpf__map__info_html"><div class="ttname"><a href="struct__ebpf__map__info.html">_ebpf_map_info</a></div><div class="ttdoc">eBPF Map Information</div><div class="ttdef"><b>Definition:</b> ebpf_core_structs.h:21</div></div>
<div class="ttc" id="astruct__ebpf__program__info_html"><div class="ttname"><a href="struct__ebpf__program__info.html">_ebpf_program_info</a></div><div class="ttdef"><b>Definition:</b> ebpf_program_types.h:38</div></div>
<div class="ttc" id="astruct__ebpf__program__info_html"><div class="ttname"><a href="struct__ebpf__program__info.html">_ebpf_program_info</a></div><div class="ttdef"><b>Definition:</b> ebpf_program_types.h:44</div></div>
<div class="ttc" id="astruct__ebpf__section__info_html"><div class="ttname"><a href="struct__ebpf__section__info.html">_ebpf_section_info</a></div><div class="ttdef"><b>Definition:</b> ebpf_api.h:56</div></div>
<div class="ttc" id="astruct__ebpf__section__info_html_a37825751b391d525a9337fb66026ee87"><div class="ttname"><a href="struct__ebpf__section__info.html#a37825751b391d525a9337fb66026ee87">_ebpf_section_info::next</a></div><div class="ttdeci">struct _ebpf_section_info * next</div><div class="ttdef"><b>Definition:</b> ebpf_api.h:57</div></div>
<div class="ttc" id="astruct__ebpf__section__info_html_a4499d796b8c43df1a71a286257e5a155"><div class="ttname"><a href="struct__ebpf__section__info.html#a4499d796b8c43df1a71a286257e5a155">_ebpf_section_info::section_name</a></div><div class="ttdeci">_Field_z_ const char * section_name</div><div class="ttdef"><b>Definition:</b> ebpf_api.h:58</div></div>
Expand Down
4 changes: 2 additions & 2 deletions ebpf__extension_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
<div class="ttc" id="aebpf__structs_8h_html_a354e84389719f1a5541fbca272618eaf"><div class="ttname"><a href="ebpf__structs_8h.html#a354e84389719f1a5541fbca272618eaf">bpf_link_type</a></div><div class="ttdeci">bpf_link_type</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:243</div></div>
<div class="ttc" id="aebpf__structs_8h_html_ac2f0847a6885cc3784a2e61d7ddf51b8"><div class="ttname"><a href="ebpf__structs_8h.html#ac2f0847a6885cc3784a2e61d7ddf51b8">bpf_attach_type_t</a></div><div class="ttdeci">enum bpf_attach_type bpf_attach_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:321</div></div>
<div class="ttc" id="aebpf__windows_8h_html"><div class="ttname"><a href="ebpf__windows_8h.html">ebpf_windows.h</a></div></div>
<div class="ttc" id="aebpf__windows_8h_html_a7392ed9f9037688cd94f7069c523c251"><div class="ttname"><a href="ebpf__windows_8h.html#a7392ed9f9037688cd94f7069c523c251">ebpf_program_type_t</a></div><div class="ttdeci">GUID ebpf_program_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:59</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a7392ed9f9037688cd94f7069c523c251"><div class="ttname"><a href="ebpf__windows_8h.html#a7392ed9f9037688cd94f7069c523c251">ebpf_program_type_t</a></div><div class="ttdeci">GUID ebpf_program_type_t</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:61</div></div>
<div class="ttc" id="astruct__ebpf__attach__provider__data_html"><div class="ttname"><a href="struct__ebpf__attach__provider__data.html">_ebpf_attach_provider_data</a></div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:95</div></div>
<div class="ttc" id="astruct__ebpf__attach__provider__data_html_a3518d0235ba1f89f9d1e84c05facd50a"><div class="ttname"><a href="struct__ebpf__attach__provider__data.html#a3518d0235ba1f89f9d1e84c05facd50a">_ebpf_attach_provider_data::header</a></div><div class="ttdeci">ebpf_extension_header_t header</div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:96</div></div>
<div class="ttc" id="astruct__ebpf__attach__provider__data_html_aa6d50545c0c6d3a69f9fe3cfd787dc3c"><div class="ttname"><a href="struct__ebpf__attach__provider__data.html#aa6d50545c0c6d3a69f9fe3cfd787dc3c">_ebpf_attach_provider_data::supported_program_type</a></div><div class="ttdeci">ebpf_program_type_t supported_program_type</div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:97</div></div>
Expand All @@ -183,7 +183,7 @@
<div class="ttc" id="astruct__ebpf__extension__dispatch__table_html_ab11b171193db782c4638f8dc8966c5ec"><div class="ttname"><a href="struct__ebpf__extension__dispatch__table.html#ab11b171193db782c4638f8dc8966c5ec">_ebpf_extension_dispatch_table::version</a></div><div class="ttdeci">uint16_t version</div><div class="ttdoc">Version of the dispatch table.</div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:13</div></div>
<div class="ttc" id="astruct__ebpf__extension__dispatch__table_html_aeb5455c4f909769f25087007161b2b89"><div class="ttname"><a href="struct__ebpf__extension__dispatch__table.html#aeb5455c4f909769f25087007161b2b89">_ebpf_extension_dispatch_table::count</a></div><div class="ttdeci">uint16_t count</div><div class="ttdoc">Number of entries in the dispatch table.</div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:14</div></div>
<div class="ttc" id="astruct__ebpf__extension__dispatch__table_html_af24df383f76c21bf80fa5facb4c626b1"><div class="ttname"><a href="struct__ebpf__extension__dispatch__table.html#af24df383f76c21bf80fa5facb4c626b1">_ebpf_extension_dispatch_table::_Field_size_</a></div><div class="ttdeci">_Field_size_(count) _ebpf_extension_dispatch_function function[1]</div></div>
<div class="ttc" id="astruct__ebpf__extension__header_html"><div class="ttname"><a href="struct__ebpf__extension__header.html">_ebpf_extension_header</a></div><div class="ttdoc">Header of an eBPF extension data structure. Every eBPF extension data structure must start with this ...</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:109</div></div>
<div class="ttc" id="astruct__ebpf__extension__header_html"><div class="ttname"><a href="struct__ebpf__extension__header.html">_ebpf_extension_header</a></div><div class="ttdoc">Header of an eBPF extension data structure. Every eBPF extension data structure must start with this ...</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:111</div></div>
<div class="ttc" id="astruct__ebpf__extension__program__dispatch__table_html"><div class="ttname"><a href="struct__ebpf__extension__program__dispatch__table.html">_ebpf_extension_program_dispatch_table</a></div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:79</div></div>
<div class="ttc" id="astruct__ebpf__extension__program__dispatch__table_html_a2c7f0bb85f83eb39048b806392c45036"><div class="ttname"><a href="struct__ebpf__extension__program__dispatch__table.html#a2c7f0bb85f83eb39048b806392c45036">_ebpf_extension_program_dispatch_table::ebpf_program_invoke_function</a></div><div class="ttdeci">ebpf_program_invoke_function_t ebpf_program_invoke_function</div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:82</div></div>
<div class="ttc" id="astruct__ebpf__extension__program__dispatch__table_html_a39c41ca9b569b1b5e8882594b9b25075"><div class="ttname"><a href="struct__ebpf__extension__program__dispatch__table.html#a39c41ca9b569b1b5e8882594b9b25075">_ebpf_extension_program_dispatch_table::ebpf_program_batch_begin_invoke_function</a></div><div class="ttdeci">ebpf_program_batch_begin_invoke_function_t ebpf_program_batch_begin_invoke_function</div><div class="ttdef"><b>Definition:</b> ebpf_extension.h:83</div></div>
Expand Down
Loading

0 comments on commit d45d814

Please sign in to comment.