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 3, 2024
1 parent 8f3bd06 commit fe5b216
Show file tree
Hide file tree
Showing 122 changed files with 1,909 additions and 1,725 deletions.
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:56</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:55</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="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 bpf__legacy_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
<div class="ttc" id="abpf__legacy_8h_html_ab69956e1b5ddb90e685db241857230e3"><div class="ttname"><a href="bpf__legacy_8h.html#ab69956e1b5ddb90e685db241857230e3">bpf_load_program</a></div><div class="ttdeci">int bpf_load_program(enum bpf_prog_type type, const struct bpf_insn *insns, size_t insns_cnt, const char *license, __u32 kern_version, char *log_buf, size_t log_buf_sz)</div><div class="ttdoc">Load (but do not attach) an eBPF program from eBPF instructions supplied by the caller.</div></div>
<div class="ttc" id="abpf__legacy_8h_html_af49249eba2a0e62fddb2a09f3a0c7833"><div class="ttname"><a href="bpf__legacy_8h.html#af49249eba2a0e62fddb2a09f3a0c7833">bpf_load_program_xattr</a></div><div class="ttdeci">int bpf_load_program_xattr(const struct bpf_load_program_attr *load_attr, char *log_buf, size_t log_buf_sz)</div><div class="ttdoc">Load (but do not attach) an eBPF program from eBPF instructions supplied by the caller.</div></div>
<div class="ttc" id="aebpf__structs_8h_html_a0f8242763b15ec665eaa47c6add861a0"><div class="ttname"><a href="ebpf__structs_8h.html#a0f8242763b15ec665eaa47c6add861a0">bpf_prog_type</a></div><div class="ttdeci">bpf_prog_type</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:167</div></div>
<div class="ttc" id="aebpf__structs_8h_html_aac6b4c09fa267f53c1d213551e0ccd5a"><div class="ttname"><a href="ebpf__structs_8h.html#aac6b4c09fa267f53c1d213551e0ccd5a">bpf_attach_type</a></div><div class="ttdeci">bpf_attach_type</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:256</div></div>
<div class="ttc" id="aebpf__structs_8h_html_aac6b4c09fa267f53c1d213551e0ccd5a"><div class="ttname"><a href="ebpf__structs_8h.html#aac6b4c09fa267f53c1d213551e0ccd5a">bpf_attach_type</a></div><div class="ttdeci">bpf_attach_type</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:257</div></div>
<div class="ttc" id="aebpf__structs_8h_html_afd97ad5450067d01ec6b6cd3c30761a1"><div class="ttname"><a href="ebpf__structs_8h.html#afd97ad5450067d01ec6b6cd3c30761a1">bpf_map_type</a></div><div class="ttdeci">bpf_map_type</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:18</div></div>
<div class="ttc" id="alibbpf_8h_html"><div class="ttname"><a href="libbpf_8h.html">libbpf.h</a></div></div>
<div class="ttc" id="astructbpf__create__map__attr_html"><div class="ttname"><a href="structbpf__create__map__attr.html">bpf_create_map_attr</a></div><div class="ttdef"><b>Definition:</b> bpf_legacy.h:16</div></div>
Expand Down
4 changes: 2 additions & 2 deletions ebpf__api_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,8 @@
<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:56</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:55</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="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__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>
Expand Down
6 changes: 3 additions & 3 deletions ebpf__extension_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,9 @@
<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__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__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:320</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:55</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="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:101</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__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
2 changes: 1 addition & 1 deletion ebpf__extension__uuids_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
<div class="ttc" id="aebpf__extension__uuids_8h_html_a4b09ac234ca80342c753e12a897d296b"><div class="ttname"><a href="ebpf__extension__uuids_8h.html#a4b09ac234ca80342c753e12a897d296b">EBPF_HOOK_EXTENSION_IID</a></div><div class="ttdeci">GUID EBPF_HOOK_EXTENSION_IID</div><div class="ttdoc">NPI ID for eBPF hook extension.</div><div class="ttdef"><b>Definition:</b> ebpf_extension_uuids.h:20</div></div>
<div class="ttc" id="aebpf__extension__uuids_8h_html_ac98f7be2f127a3e32795d2921616d931"><div class="ttname"><a href="ebpf__extension__uuids_8h.html#ac98f7be2f127a3e32795d2921616d931">EBPF_PROGRAM_INFO_EXTENSION_IID</a></div><div class="ttdeci">GUID EBPF_PROGRAM_INFO_EXTENSION_IID</div><div class="ttdoc">NPI ID for eBPF program information extension.</div><div class="ttdef"><b>Definition:</b> ebpf_extension_uuids.h:14</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_a774aa72faaf900258d045f091c6ebb3f"><div class="ttname"><a href="ebpf__windows_8h.html#a774aa72faaf900258d045f091c6ebb3f">GUID</a></div><div class="ttdeci">uint8_t GUID[16]</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:8</div></div>
<div class="ttc" id="aebpf__windows_8h_html_a774aa72faaf900258d045f091c6ebb3f"><div class="ttname"><a href="ebpf__windows_8h.html#a774aa72faaf900258d045f091c6ebb3f">GUID</a></div><div class="ttdeci">uint8_t GUID[16]</div><div class="ttdef"><b>Definition:</b> ebpf_windows.h:12</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
4 changes: 2 additions & 2 deletions ebpf__program__attach__type__guids_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,8 @@
<div class="ttc" id="aebpf__program__attach__type__guids_8h_html_afc537e477316cb69c5b989f0d944fb8b"><div class="ttname"><a href="ebpf__program__attach__type__guids_8h.html#afc537e477316cb69c5b989f0d944fb8b">EBPF_PROGRAM_TYPE_CGROUP_SOCK_ADDR</a></div><div class="ttdeci">ebpf_program_type_t EBPF_PROGRAM_TYPE_CGROUP_SOCK_ADDR</div><div class="ttdoc">Program type for handling various socket operations such as connect(), accept() etc.</div><div class="ttdef"><b>Definition:</b> ebpf_program_attach_type_guids.h:169</div></div>
<div class="ttc" id="aebpf__program__attach__type__guids_8h_html_aff7e133ecb6c918377e2648790de5f6f"><div class="ttname"><a href="ebpf__program__attach__type__guids_8h.html#aff7e133ecb6c918377e2648790de5f6f">EBPF_PROGRAM_TYPE_UNSPECIFIED</a></div><div class="ttdeci">ebpf_program_type_t EBPF_PROGRAM_TYPE_UNSPECIFIED</div><div class="ttdef"><b>Definition:</b> ebpf_program_attach_type_guids.h:121</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_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:56</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:55</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><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit fe5b216

Please sign in to comment.