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 Mar 30, 2024
1 parent eec6a81 commit 8f3bd06
Show file tree
Hide file tree
Showing 152 changed files with 3,388 additions and 2,492 deletions.
75 changes: 38 additions & 37 deletions annotated.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions bpf2c_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -217,14 +217,14 @@
<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:44</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:43</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="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>
<div class="ttc" id="astruct__bpf2c__version_html_a8ae84369bccb3346eb2aa3ce84e60758"><div class="ttname"><a href="struct__bpf2c__version.html#a8ae84369bccb3346eb2aa3ce84e60758">_bpf2c_version::revision</a></div><div class="ttdeci">uint32_t revision</div><div class="ttdef"><b>Definition:</b> bpf2c.h:123</div></div>
<div class="ttc" id="astruct__bpf2c__version_html_abc026a444dc06c7c49fccb74d2ca90e2"><div class="ttname"><a href="struct__bpf2c__version.html#abc026a444dc06c7c49fccb74d2ca90e2">_bpf2c_version::minor</a></div><div class="ttdeci">uint32_t minor</div><div class="ttdef"><b>Definition:</b> bpf2c.h:122</div></div>
<div class="ttc" id="astruct__ebpf__map__definition__in__file_html"><div class="ttname"><a href="struct__ebpf__map__definition__in__file.html">_ebpf_map_definition_in_file</a></div><div class="ttdoc">eBPF Map Definition as it appears in the maps section of an ELF file.</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:125</div></div>
<div class="ttc" id="astruct__ebpf__map__definition__in__file_html"><div class="ttname"><a href="struct__ebpf__map__definition__in__file.html">_ebpf_map_definition_in_file</a></div><div class="ttdoc">eBPF Map Definition as it appears in the maps section of an ELF file.</div><div class="ttdef"><b>Definition:</b> ebpf_structs.h:115</div></div>
<div class="ttc" id="astruct__helper__function__entry_html"><div class="ttname"><a href="struct__helper__function__entry.html">_helper_function_entry</a></div><div class="ttdoc">Helper function entry. This structure defines a helper function entry in the metadata table....</div><div class="ttdef"><b>Definition:</b> bpf2c.h:55</div></div>
<div class="ttc" id="astruct__helper__function__entry_html_a0c402220e2c9d0a84a60ce091c7f361d"><div class="ttname"><a href="struct__helper__function__entry.html#a0c402220e2c9d0a84a60ce091c7f361d">_helper_function_entry::tail_call</a></div><div class="ttdeci">bool tail_call</div><div class="ttdef"><b>Definition:</b> bpf2c.h:59</div></div>
<div class="ttc" id="astruct__helper__function__entry_html_a42474f72009d53976dd8fcd8809a8bd4"><div class="ttname"><a href="struct__helper__function__entry.html#a42474f72009d53976dd8fcd8809a8bd4">_helper_function_entry::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition:</b> bpf2c.h:58</div></div>
Expand Down
4 changes: 2 additions & 2 deletions bpf_2bpf_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@
<div class="ttc" id="abpf_2bpf_8h_html_ad0ed6a975a6d623155c61de44e55e484"><div class="ttname"><a href="bpf_2bpf_8h.html#ad0ed6a975a6d623155c61de44e55e484">bpf_map_delete_elem</a></div><div class="ttdeci">int bpf_map_delete_elem(int fd, const void *key)</div><div class="ttdoc">Look up and delete an element by key in a specified map.</div></div>
<div class="ttc" id="abpf_2bpf_8h_html_af4a69e7174078629e3f20dade5e6743d"><div class="ttname"><a href="bpf_2bpf_8h.html#af4a69e7174078629e3f20dade5e6743d">bpf_prog_get_fd_by_id</a></div><div class="ttdeci">int bpf_prog_get_fd_by_id(__u32 id)</div><div class="ttdoc">Get a file descriptor referring to a program with a given ID.</div></div>
<div class="ttc" id="abpf__legacy_8h_html"><div class="ttname"><a href="bpf__legacy_8h.html">bpf_legacy.h</a></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:177</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:28</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_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="atypes_8h_html_a3acae9310e2c2e411e800a8a369171c6"><div class="ttname"><a href="types_8h.html#a3acae9310e2c2e411e800a8a369171c6">__u32</a></div><div class="ttdeci">uint32_t __u32</div><div class="ttdef"><b>Definition:</b> types.h:6</div></div>
<div class="ttc" id="atypes_8h_html_ac2a2bfb32105ffe8e74b67670b7ec440"><div class="ttname"><a href="types_8h.html#ac2a2bfb32105ffe8e74b67670b7ec440">__u64</a></div><div class="ttdeci">uint64_t __u64</div><div class="ttdef"><b>Definition:</b> types.h:7</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
6 changes: 3 additions & 3 deletions bpf__legacy_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,9 @@
<div class="ttc" id="abpf__legacy_8h_html_aa568c1b6f3dddfb439311bd952824f1b"><div class="ttname"><a href="bpf__legacy_8h.html#aa568c1b6f3dddfb439311bd952824f1b">bpf_create_map_in_map</a></div><div class="ttdeci">int bpf_create_map_in_map(enum bpf_map_type map_type, const char *name, int key_size, int inner_map_fd, int max_entries, __u32 map_flags)</div><div class="ttdoc">Create a new map-in-map.</div></div>
<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:177</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:266</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:28</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_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>
<div class="ttc" id="astructbpf__create__map__attr_html_a1dd086f9bf6e270211fbdf8fb1708e1f"><div class="ttname"><a href="structbpf__create__map__attr.html#a1dd086f9bf6e270211fbdf8fb1708e1f">bpf_create_map_attr::inner_map_fd</a></div><div class="ttdeci">__u32 inner_map_fd</div><div class="ttdef"><b>Definition:</b> bpf_legacy.h:30</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__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__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
Loading

0 comments on commit 8f3bd06

Please sign in to comment.