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 25, 2024
1 parent d45d814 commit 94a789c
Show file tree
Hide file tree
Showing 120 changed files with 1,974 additions and 1,916 deletions.
2 changes: 1 addition & 1 deletion bpf_2bpf_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
<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:167</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:168</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>
Expand Down
30 changes: 30 additions & 0 deletions bpf__helper__defs_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@
<tr class="memitem:a761216d9ea8f44b31f064e238b3f2f75"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bpf__helper__defs_8h.html#a761216d9ea8f44b31f064e238b3f2f75">bpf_memmove</a> (void *destination, uint32_t destination_size, const void *source, uint32_t source_size)</td></tr>
<tr class="memdesc:a761216d9ea8f44b31f064e238b3f2f75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy memory from one location to another, handling overlapping regions. <a href="bpf__helper__defs_8h.html#a761216d9ea8f44b31f064e238b3f2f75">More...</a><br /></td></tr>
<tr class="separator:a761216d9ea8f44b31f064e238b3f2f75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91543269c3d993aa3b79fa250d4df943"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bpf__helper__defs_8h.html#a91543269c3d993aa3b79fa250d4df943">bpf_get_socket_cookie</a> (const void *ctx)</td></tr>
<tr class="memdesc:a91543269c3d993aa3b79fa250d4df943"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the socket cookie associated with the socket context. The context can be <em><a class="el" href="structbpf__sock__addr.html" title="Data structure used as context for BPF_PROG_TYPE_CGROUP_SOCK_ADDR program type.">bpf_sock_addr</a></em> struct, <em>bpf_sock_ops</em> struct, or <em>bpf_sock</em> struct. <a href="bpf__helper__defs_8h.html#a91543269c3d993aa3b79fa250d4df943">More...</a><br /></td></tr>
<tr class="separator:a91543269c3d993aa3b79fa250d4df943"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8925aebb6537b5d34b8cb28b04d34515"></a>
Expand Down Expand Up @@ -303,6 +306,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#aeac5e76520396d4436978a5c
<p>Return SMP id of the processor running the program. </p>
<dl class="section return"><dt>Returns</dt><dd>SMP id of the processor running the program. </dd></dl>

</div>
</div>
<a id="a91543269c3d993aa3b79fa250d4df943"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91543269c3d993aa3b79fa250d4df943">&#9670;&nbsp;</a></span>bpf_get_socket_cookie()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t bpf_get_socket_cookie </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Get the socket cookie associated with the socket context. The context can be <em><a class="el" href="structbpf__sock__addr.html" title="Data structure used as context for BPF_PROG_TYPE_CGROUP_SOCK_ADDR program type.">bpf_sock_addr</a></em> struct, <em>bpf_sock_ops</em> struct, or <em>bpf_sock</em> struct. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>Context passed to the eBPF program.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The socket cookie. </dd></dl>

</div>
</div>
<a id="a1cf21c253fa4ea868ddeefba950b1469"></a>
Expand Down
22 changes: 14 additions & 8 deletions bpf__helper__defs_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -233,14 +233,19 @@
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160;<span class="preprocessor">#define bpf_memmove ((bpf_memmove_t)BPF_FUNC_memmove)</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; </div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="preprocessor">#if __clang__</span></div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<span class="preprocessor">#define memcpy(dest, src, dest_size) bpf_memcpy(dest, dest_size, src, dest_size)</span></div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160;<span class="preprocessor">#define memcmp(mem1, mem2, mem1_size) bpf_memcmp(mem1, mem1_size, mem2, mem1_size)</span></div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160;<span class="preprocessor">#define memset(mem, value, mem_size) bpf_memset(mem, mem_size, value)</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160;<span class="preprocessor">#define memmove(dest, src, dest_size) bpf_memmove(dest, dest_size, src, dest_size)</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;<span class="preprocessor">#define memcpy_s bpf_memcpy</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="preprocessor">#define memmove_s bpf_memmove</span></div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00417"></a><span class="lineno"><a class="line" href="bpf__helper__defs_8h.html#a91543269c3d993aa3b79fa250d4df943"> 417</a></span>&#160;EBPF_HELPER(int64_t, <a class="code" href="bpf__helper__defs_8h.html#a91543269c3d993aa3b79fa250d4df943">bpf_get_socket_cookie</a>, (<span class="keyword">const</span> <span class="keywordtype">void</span>* ctx));</div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160;<span class="preprocessor">#ifndef __doxygen</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;<span class="preprocessor">#define bpf_get_socket_cookie ((bpf_get_socket_cookie_t)BPF_FUNC_get_socket_cookie)</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; </div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160;<span class="preprocessor">#if __clang__</span></div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="preprocessor">#define memcpy(dest, src, dest_size) bpf_memcpy(dest, dest_size, src, dest_size)</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160;<span class="preprocessor">#define memcmp(mem1, mem2, mem1_size) bpf_memcmp(mem1, mem1_size, mem2, mem1_size)</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160;<span class="preprocessor">#define memset(mem, value, mem_size) bpf_memset(mem, mem_size, value)</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;<span class="preprocessor">#define memmove(dest, src, dest_size) bpf_memmove(dest, dest_size, src, dest_size)</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="preprocessor">#define memcpy_s bpf_memcpy</span></div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160;<span class="preprocessor">#define memmove_s bpf_memmove</span></div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a0002267858304987c29d1c614e3c1448"><div class="ttname"><a href="bpf__helper__defs_8h.html#a0002267858304987c29d1c614e3c1448">bpf_ringbuf_output</a></div><div class="ttdeci">int bpf_ringbuf_output(void *ring_buffer, void *data, uint64_t size, uint64_t flags)</div><div class="ttdoc">Copy data into the ring buffer map.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a0c684e5d92fd5f2125b5580a69261ba8"><div class="ttname"><a href="bpf__helper__defs_8h.html#a0c684e5d92fd5f2125b5580a69261ba8">bpf_map_delete_elem</a></div><div class="ttdeci">int64_t bpf_map_delete_elem(void *map, void *key)</div><div class="ttdoc">Remove an entry from the map.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a168a50d0b69124ccdd082e27ca3a0faa"><div class="ttname"><a href="bpf__helper__defs_8h.html#a168a50d0b69124ccdd082e27ca3a0faa">bpf_map_push_elem</a></div><div class="ttdeci">int64_t bpf_map_push_elem(void *map, void *value, uint64_t flags)</div><div class="ttdoc">Insert an element at the end of the map (only valid for stack and queue).</div></div>
Expand All @@ -258,6 +263,7 @@
<div class="ttc" id="abpf__helper__defs_8h_html_a7afba40def49ec09dc8f77e6ae40b172"><div class="ttname"><a href="bpf__helper__defs_8h.html#a7afba40def49ec09dc8f77e6ae40b172">bpf_map_pop_elem</a></div><div class="ttdeci">int64_t bpf_map_pop_elem(void *map, void *value)</div><div class="ttdoc">Copy an entry from the map and remove it from the map (only valid for stack and queue)....</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a7c9d78fb59b216295336750966998a08"><div class="ttname"><a href="bpf__helper__defs_8h.html#a7c9d78fb59b216295336750966998a08">bpf_trace_printk3</a></div><div class="ttdeci">long bpf_trace_printk3(const char *fmt, uint32_t fmt_size, uint64_t arg3)</div><div class="ttdoc">Print debug output.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a8925aebb6537b5d34b8cb28b04d34515"><div class="ttname"><a href="bpf__helper__defs_8h.html#a8925aebb6537b5d34b8cb28b04d34515">bpf_csum_diff</a></div><div class="ttdeci">int bpf_csum_diff(void *from, int from_size, void *to, int to_size, int seed)</div><div class="ttdoc">Computes difference of checksum values for two input raw buffers using 1's complement arithmetic.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a91543269c3d993aa3b79fa250d4df943"><div class="ttname"><a href="bpf__helper__defs_8h.html#a91543269c3d993aa3b79fa250d4df943">bpf_get_socket_cookie</a></div><div class="ttdeci">int64_t bpf_get_socket_cookie(const void *ctx)</div><div class="ttdoc">Get the socket cookie associated with the socket context. The context can be bpf_sock_addr struct,...</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a992316ef9a6e6bcf762ca033a4e01f1a"><div class="ttname"><a href="bpf__helper__defs_8h.html#a992316ef9a6e6bcf762ca033a4e01f1a">bpf_trace_printk</a></div><div class="ttdeci">long bpf_trace_printk(const char *fmt, uint32_t size,...)</div><div class="ttdoc">Print debug output. For instructions on viewing the output, see the Using tracing section of the Gett...</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_aa94070613a8c287facfae0b1e945259f"><div class="ttname"><a href="bpf__helper__defs_8h.html#aa94070613a8c287facfae0b1e945259f">bpf_memcmp</a></div><div class="ttdeci">int bpf_memcmp(const void *memory1, uint32_t memory1_size, const void *memory2, uint32_t memory2_size)</div><div class="ttdoc">Compare two memory regions.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_aae337e68db96b4b9470f8c519386cbec"><div class="ttname"><a href="bpf__helper__defs_8h.html#aae337e68db96b4b9470f8c519386cbec">bpf_printk</a></div><div class="ttdeci">long bpf_printk(const char *fmt,...)</div><div class="ttdoc">Print debug output. For instructions on viewing the output, see the Using tracing section of the Gett...</div></div>
Expand Down
4 changes: 2 additions & 2 deletions bpf__legacy_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@
<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: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:257</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:168</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:258</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__extension_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@
<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__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:321</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:244</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:322</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: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>
Expand Down
Loading

0 comments on commit 94a789c

Please sign in to comment.