Updated documentation

Signed-off-by: Github Action <[email protected]>
microsoft · Feb 15, 2024 · 137bc04 · 137bc04
1 parent 8e19131
commit 137bc04
Show file tree

Hide file tree

Showing 113 changed files with 1,505 additions and 1,559 deletions.
diff --git a/ebpf__api_8h_source.html b/ebpf__api_8h_source.html
@@ -324,7 +324,7 @@
 <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="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:44</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:39</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>

diff --git a/ebpf__program__types_8h.html b/ebpf__program__types_8h.html
@@ -76,7 +76,6 @@
 <div class="textblock"><code>#include &quot;ebpf_base.h&quot;</code><br />
 <code>#include &quot;<a class="el" href="ebpf__result_8h_source.html">ebpf_result.h</a>&quot;</code><br />
 <code>#include &lt;guiddef.h&gt;</code><br />
-<code>#include &lt;stdbool.h&gt;</code><br />
 <code>#include &lt;stdint.h&gt;</code><br />
 </div>
 <p><a href="ebpf__program__types_8h_source.html">Go to the source code of this file.</a></p>
@@ -102,8 +101,6 @@
 <tr class="separator:a9848135b2a7f061ddeb32204a2ec511f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:adfa6f94ddf162a37941cbdecd8111c67"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__program__types_8h.html#adfa6f94ddf162a37941cbdecd8111c67">EBPF_MAX_HELPER_FUNCTION_NAME_LENGTH</a>&#160;&#160;&#160;256</td></tr>
 <tr class="separator:adfa6f94ddf162a37941cbdecd8111c67"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aa2cbcf37721f82cc217e34b42c917689"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__program__types_8h.html#aa2cbcf37721f82cc217e34b42c917689">HELPER_FUNCTION_REALLOCATE_PACKET</a>&#160;&#160;&#160;0x1</td></tr>
-<tr class="separator:aa2cbcf37721f82cc217e34b42c917689"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 Typedefs</h2></td></tr>
@@ -151,20 +148,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9848135b2a7f061ddeb32204
       </table>
 </div><div class="memdoc">
 
-</div>
-</div>
-<a id="aa2cbcf37721f82cc217e34b42c917689"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#aa2cbcf37721f82cc217e34b42c917689">&#9670;&nbsp;</a></span>HELPER_FUNCTION_REALLOCATE_PACKET</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define HELPER_FUNCTION_REALLOCATE_PACKET&#160;&#160;&#160;0x1</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
 </div>
 </div>
 <h2 class="groupheader">Typedef Documentation</h2>

diff --git a/ebpf__program__types_8h_source.html b/ebpf__program__types_8h_source.html
diff --git a/ebpf__store__helper_8h_source.html b/ebpf__store__helper_8h_source.html
@@ -123,9 +123,9 @@
 <div class="ttc" id="aebpf__store__helper_8h_html_ad5f74d4ca63d4db326791eecb87424dd"><div class="ttname"><a href="ebpf__store__helper_8h.html#ad5f74d4ca63d4db326791eecb87424dd">ebpf_store_delete_section_information</a></div><div class="ttdeci">ebpf_result_t ebpf_store_delete_section_information(const ebpf_program_section_info_t *section_info)</div><div class="ttdoc">Delete section information from the eBPF store.</div></div>
 <div class="ttc" id="aebpf__utilities_8h_html"><div class="ttname"><a href="ebpf__utilities_8h.html">ebpf_utilities.h</a></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="astruct__ebpf__helper__function__prototype_html"><div class="ttname"><a href="struct__ebpf__helper__function__prototype.html">_ebpf_helper_function_prototype</a></div><div class="ttdef"><b>Definition:</b> ebpf_program_types.h:35</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__program__section__info_html"><div class="ttname"><a href="struct__ebpf__program__section__info.html">_ebpf_program_section_info</a></div><div class="ttdef"><b>Definition:</b> ebpf_program_types.h:86</div></div>
+<div class="ttc" id="astruct__ebpf__helper__function__prototype_html"><div class="ttname"><a href="struct__ebpf__helper__function__prototype.html">_ebpf_helper_function_prototype</a></div><div class="ttdef"><b>Definition:</b> ebpf_program_types.h:31</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:39</div></div>
+<div class="ttc" id="astruct__ebpf__program__section__info_html"><div class="ttname"><a href="struct__ebpf__program__section__info.html">_ebpf_program_section_info</a></div><div class="ttdef"><b>Definition:</b> ebpf_program_types.h:81</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

diff --git a/functions_p.html b/functions_p.html
@@ -154,13 +154,13 @@ <h3><a id="index_p"></a>- p -</h3><ul>
 <li>protocol
 : <a class="el" href="struct__bind__md.html#a357cadb124e6aa13adbdcfe5f9696847">_bind_md</a>
 , <a class="el" href="struct__bpf__sock__ops.html#aa0faa6133a9c642d2baf996be967b236">_bpf_sock_ops</a>
-, <a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html#a39ab3e1dc802ec5a3d97f3514216d096">_IPV4_HEADER</a>
 </li>
 <li>Protocol
 : <a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html#a036667d1925198e7eb24f0626935c5da">_IPV4_HEADER</a>
 </li>
 <li>protocol
-: <a class="el" href="structbpf__sock__addr.html#a12138e7cc791a56f46f191ce4d8fb2d3">bpf_sock_addr</a>
+: <a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html#a39ab3e1dc802ec5a3d97f3514216d096">_IPV4_HEADER</a>
+, <a class="el" href="structbpf__sock__addr.html#a12138e7cc791a56f46f191ce4d8fb2d3">bpf_sock_addr</a>
 </li>
 <li>psh
 : <a class="el" href="structtcphdr.html#a36bbcd14c9ef7a7f7375e8700361c07a">tcphdr</a>

diff --git a/functions_r.html b/functions_r.html
@@ -67,9 +67,6 @@ <h3><a id="index_r"></a>- r -</h3><ul>
 <li>raw_data_size
 : <a class="el" href="struct__ebpf__section__info.html#a9b292eb1277172551f5338286fb4b86c">_ebpf_section_info</a>
 </li>
-<li>reallocate_packet
-: <a class="el" href="struct__ebpf__helper__function__prototype.html#a0627b9b29485b12720c3e5f8069a7459">_ebpf_helper_function_prototype</a>
-</li>
 <li>referenced_map_count
 : <a class="el" href="struct__program__entry.html#a487de1acdc59c9b8a897f9ca2a685c8f">_program_entry</a>
 </li>

diff --git a/functions_vars_p.html b/functions_vars_p.html
@@ -154,13 +154,13 @@ <h3><a id="index_p"></a>- p -</h3><ul>
 <li>protocol
 : <a class="el" href="struct__bind__md.html#a357cadb124e6aa13adbdcfe5f9696847">_bind_md</a>
 , <a class="el" href="struct__bpf__sock__ops.html#aa0faa6133a9c642d2baf996be967b236">_bpf_sock_ops</a>
-, <a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html#a39ab3e1dc802ec5a3d97f3514216d096">_IPV4_HEADER</a>
 </li>
 <li>Protocol
 : <a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html#a036667d1925198e7eb24f0626935c5da">_IPV4_HEADER</a>
 </li>
 <li>protocol
-: <a class="el" href="structbpf__sock__addr.html#a12138e7cc791a56f46f191ce4d8fb2d3">bpf_sock_addr</a>
+: <a class="el" href="struct___i_p_v4___h_e_a_d_e_r.html#a39ab3e1dc802ec5a3d97f3514216d096">_IPV4_HEADER</a>
+, <a class="el" href="structbpf__sock__addr.html#a12138e7cc791a56f46f191ce4d8fb2d3">bpf_sock_addr</a>
 </li>
 <li>psh
 : <a class="el" href="structtcphdr.html#a36bbcd14c9ef7a7f7375e8700361c07a">tcphdr</a>

diff --git a/functions_vars_r.html b/functions_vars_r.html
@@ -67,9 +67,6 @@ <h3><a id="index_r"></a>- r -</h3><ul>
 <li>raw_data_size
 : <a class="el" href="struct__ebpf__section__info.html#a9b292eb1277172551f5338286fb4b86c">_ebpf_section_info</a>
 </li>
-<li>reallocate_packet
-: <a class="el" href="struct__ebpf__helper__function__prototype.html#a0627b9b29485b12720c3e5f8069a7459">_ebpf_helper_function_prototype</a>
-</li>
 <li>referenced_map_count
 : <a class="el" href="struct__program__entry.html#a487de1acdc59c9b8a897f9ca2a685c8f">_program_entry</a>
 </li>

diff --git a/globals_b.html b/globals_b.html
@@ -286,18 +286,18 @@ <h3><a id="index_b"></a>- b -</h3><ul>
 <li>BPF_LINK_DETACH
 : <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a89ad9c6e03007dd9310da8f5b49498dc">bpf.h</a>
 </li>
-<li>BPF_LINK_GET_FD_BY_ID
-: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09aba1b82aca4e658fdbabca289f5128eba">bpf.h</a>
-</li>
 <li>bpf_link_get_fd_by_id()
 : <a class="el" href="bpf_2bpf_8h.html#ab7b9a2be5b70b133483ac17b921c3dff">bpf.h</a>
 </li>
-<li>bpf_link_get_next_id()
-: <a class="el" href="bpf_2bpf_8h.html#a22b6c612a8c54fff0dd93f163bfadf22">bpf.h</a>
+<li>BPF_LINK_GET_FD_BY_ID
+: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09aba1b82aca4e658fdbabca289f5128eba">bpf.h</a>
 </li>
 <li>BPF_LINK_GET_NEXT_ID
 : <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a83a22d9bd7cab247e1ced4d5811ab978">bpf.h</a>
 </li>
+<li>bpf_link_get_next_id()
+: <a class="el" href="bpf_2bpf_8h.html#a22b6c612a8c54fff0dd93f163bfadf22">bpf.h</a>
+</li>
 <li>bpf_link_type
 : <a class="el" href="ebpf__structs_8h.html#a354e84389719f1a5541fbca272618eaf">ebpf_structs.h</a>
 </li>
@@ -389,19 +389,19 @@ <h3><a id="index_b"></a>- b -</h3><ul>
 <li>BPF_MAP_GET_NEXT_KEY
 : <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09aa64737ec5dbeaebadbe10c55cb3dbadb">bpf.h</a>
 </li>
-<li>BPF_MAP_LOOKUP_AND_DELETE_ELEM
-: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a03bb881134718e15ecd9d01c13f43e12">bpf.h</a>
-</li>
 <li>bpf_map_lookup_and_delete_elem()
 : <a class="el" href="bpf__helper__defs_8h.html#a1dbd2b00c309af872d20e6c335fa979a">bpf_helper_defs.h</a>
 </li>
-<li>BPF_MAP_LOOKUP_ELEM
-: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09aeda0d0507e3a0f6cedc59bb34dd8eef8">bpf.h</a>
+<li>BPF_MAP_LOOKUP_AND_DELETE_ELEM
+: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a03bb881134718e15ecd9d01c13f43e12">bpf.h</a>
 </li>
 <li>bpf_map_lookup_elem()
 : <a class="el" href="bpf_2bpf_8h.html#a95579ca07cccfd0f756a361c2da12ad5">bpf.h</a>
 , <a class="el" href="bpf__helper__defs_8h.html#ab1c6c619dd3307a80909036de1264874">bpf_helper_defs.h</a>
 </li>
+<li>BPF_MAP_LOOKUP_ELEM
+: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09aeda0d0507e3a0f6cedc59bb34dd8eef8">bpf.h</a>
+</li>
 <li>bpf_map_peek_elem()
 : <a class="el" href="bpf__helper__defs_8h.html#af19660acfb8574c59f214621ee3dddaa">bpf_helper_defs.h</a>
 </li>
@@ -475,27 +475,27 @@ <h3><a id="index_b"></a>- b -</h3><ul>
 <li>bpf_ntohs
 : <a class="el" href="bpf__endian_8h.html#a809ca78691cdb5e0fd36b7b313f98cda">bpf_endian.h</a>
 </li>
-<li>BPF_OBJ_GET
-: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a1c4511c9d4655065ab745612a7d5916a">bpf.h</a>
-</li>
 <li>bpf_obj_get()
 : <a class="el" href="bpf_2bpf_8h.html#a2fd48f3d62ed0b56a9d01675bcd68c7a">bpf.h</a>
 </li>
-<li>BPF_OBJ_GET_INFO_BY_FD
-: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09ac91812af05cb4bd71159c8d2659b8784">bpf.h</a>
+<li>BPF_OBJ_GET
+: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a1c4511c9d4655065ab745612a7d5916a">bpf.h</a>
 </li>
 <li>bpf_obj_get_info_by_fd()
 : <a class="el" href="bpf_2bpf_8h.html#a23ca7dd3889db2e7fc97e063c727c17f">bpf.h</a>
 </li>
+<li>BPF_OBJ_GET_INFO_BY_FD
+: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09ac91812af05cb4bd71159c8d2659b8784">bpf.h</a>
+</li>
 <li>BPF_OBJ_NAME_LEN
 : <a class="el" href="ebpf__structs_8h.html#abc5e07d826c22d4c2b46fd1fb5a2e93e">ebpf_structs.h</a>
 </li>
-<li>bpf_obj_pin()
-: <a class="el" href="bpf_2bpf_8h.html#a9f5eaf959fde6143ec1d94617362f5f1">bpf.h</a>
-</li>
 <li>BPF_OBJ_PIN
 : <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a6abdc7140f3c0faf9adde20d6f01ac2d">bpf.h</a>
 </li>
+<li>bpf_obj_pin()
+: <a class="el" href="bpf_2bpf_8h.html#a9f5eaf959fde6143ec1d94617362f5f1">bpf.h</a>
+</li>
 <li>bpf_object__close()
 : <a class="el" href="libbpf_8h.html#a473872ff7ab53d1ed593e7abd206f31a">libbpf.h</a>
 </li>
@@ -568,18 +568,18 @@ <h3><a id="index_b"></a>- b -</h3><ul>
 <li>bpf_prog_attach()
 : <a class="el" href="libbpf_8h.html#a537fad2441f3f63e2cda6f88bc12ce80">libbpf.h</a>
 </li>
-<li>bpf_prog_bind_map()
-: <a class="el" href="bpf_2bpf_8h.html#aa0444bc5793f94ba959aaada46342240">bpf.h</a>
-</li>
 <li>BPF_PROG_BIND_MAP
 : <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a9e6f8dd9c9ddd605713477765ee28bca">bpf.h</a>
 </li>
-<li>BPF_PROG_DETACH
-: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a39368e1308fd10a8e95810d4a82a8b6b">bpf.h</a>
+<li>bpf_prog_bind_map()
+: <a class="el" href="bpf_2bpf_8h.html#aa0444bc5793f94ba959aaada46342240">bpf.h</a>
 </li>
 <li>bpf_prog_detach()
 : <a class="el" href="libbpf_8h.html#a05c653e93f2a6e2e421bbecfaeb624db">libbpf.h</a>
 </li>
+<li>BPF_PROG_DETACH
+: <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a39368e1308fd10a8e95810d4a82a8b6b">bpf.h</a>
+</li>
 <li>bpf_prog_detach2()
 : <a class="el" href="libbpf_8h.html#a8e167aa907a4d732b42b8a3bb889cd41">libbpf.h</a>
 </li>
@@ -589,12 +589,12 @@ <h3><a id="index_b"></a>- b -</h3><ul>
 <li>bpf_prog_get_fd_by_id()
 : <a class="el" href="bpf_2bpf_8h.html#af4a69e7174078629e3f20dade5e6743d">bpf.h</a>
 </li>
-<li>bpf_prog_get_next_id()
-: <a class="el" href="bpf_2bpf_8h.html#a08fd6fe439bbd700f63a5cf95324be90">bpf.h</a>
-</li>
 <li>BPF_PROG_GET_NEXT_ID
 : <a class="el" href="linux_2bpf_8h.html#a9cd4b69e2bbb3202f71b8b2b0eeede09a5e5d7957df15c05673e76c3b3302ac09">bpf.h</a>
 </li>
+<li>bpf_prog_get_next_id()
+: <a class="el" href="bpf_2bpf_8h.html#a08fd6fe439bbd700f63a5cf95324be90">bpf.h</a>
+</li>
 <li>bpf_prog_load()
 : <a class="el" href="bpf_2bpf_8h.html#ac3c199aafea072c96c7d8c79dcc70ffa">bpf.h</a>
 </li>

diff --git a/globals_defs.html b/globals_defs.html
@@ -345,9 +345,6 @@ <h3><a id="index_h"></a>- h -</h3><ul>
 <li>h_proto
 : <a class="el" href="net_2if__ether_8h.html#a3fc023e67be859031668e4bc0449c363">if_ether.h</a>
 </li>
-<li>HELPER_FUNCTION_REALLOCATE_PACKET
-: <a class="el" href="ebpf__program__types_8h.html#aa2cbcf37721f82cc217e34b42c917689">ebpf_program_types.h</a>
-</li>
 <li>htobe16
 : <a class="el" href="bpf2c_8h.html#a02ba1fc05a319ff6fb0cd94006bb6717">bpf2c.h</a>
 </li>

diff --git a/globals_h.html b/globals_h.html
@@ -70,9 +70,6 @@ <h3><a id="index_h"></a>- h -</h3><ul>
 <li>helper_function_entry_t
 : <a class="el" href="bpf2c_8h.html#a5a615dcc4f1c8b536fd125680aa93b72">bpf2c.h</a>
 </li>
-<li>HELPER_FUNCTION_REALLOCATE_PACKET
-: <a class="el" href="ebpf__program__types_8h.html#aa2cbcf37721f82cc217e34b42c917689">ebpf_program_types.h</a>
-</li>
 <li>htobe16
 : <a class="el" href="bpf2c_8h.html#a02ba1fc05a319ff6fb0cd94006bb6717">bpf2c.h</a>
 </li>