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 Dec 3, 2024
1 parent 8d54bbb commit 0f1c676
Show file tree
Hide file tree
Showing 117 changed files with 2,124 additions and 2,024 deletions.
2 changes: 1 addition & 1 deletion bpf_2bpf_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@
<div class="ttc" id="abpf_2bpf_8h_html_ae1224b7fa4a07d45a39cf76842dbe726"><div class="ttname"><a href="bpf_2bpf_8h.html#ae1224b7fa4a07d45a39cf76842dbe726">bpf_map_lookup_batch</a></div><div class="ttdeci">int bpf_map_lookup_batch(int fd, void *in_batch, void *out_batch, void *keys, void *values, __u32 *count, const struct bpf_map_batch_opts *opts)</div><div class="ttdoc">bpf_map_lookup_batch() allows for batch lookup of BPF map elements.</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:171</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:173</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
46 changes: 46 additions & 0 deletions bpf__helper__defs_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,12 @@
<tr class="memitem:a38bf8179fba161626e0eff58e222d88a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bpf__helper__defs_8h.html#a38bf8179fba161626e0eff58e222d88a">bpf_strnlen_s</a> (const char *str, size_t str_size)</td></tr>
<tr class="memdesc:a38bf8179fba161626e0eff58e222d88a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the length of a string, up to a certain number of characters. <a href="bpf__helper__defs_8h.html#a38bf8179fba161626e0eff58e222d88a">More...</a><br /></td></tr>
<tr class="separator:a38bf8179fba161626e0eff58e222d88a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73478db76c69875bbf408500fe2ea3fc"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bpf__helper__defs_8h.html#a73478db76c69875bbf408500fe2ea3fc">bpf_ktime_get_boot_ms</a> ()</td></tr>
<tr class="memdesc:a73478db76c69875bbf408500fe2ea3fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return time elapsed since boot in milliseconds including time while suspended. This function uses a lower resolution clock source than bpf_ktime_get_boot_ns, but is faster. <a href="bpf__helper__defs_8h.html#a73478db76c69875bbf408500fe2ea3fc">More...</a><br /></td></tr>
<tr class="separator:a73478db76c69875bbf408500fe2ea3fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6d332de3410614287e7145989a4a042"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bpf__helper__defs_8h.html#ac6d332de3410614287e7145989a4a042">bpf_ktime_get_ms</a> ()</td></tr>
<tr class="memdesc:ac6d332de3410614287e7145989a4a042"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return time elapsed since boot in milliseconds excluding time while suspended. This function uses a lower resolution clock source than bpf_ktime_get_ns, but is faster. <a href="bpf__helper__defs_8h.html#ac6d332de3410614287e7145989a4a042">More...</a><br /></td></tr>
<tr class="separator:ac6d332de3410614287e7145989a4a042"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8925aebb6537b5d34b8cb28b04d34515"></a>
Expand Down Expand Up @@ -376,6 +382,26 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1cf21c253fa4ea868ddeefba
</dd>
</dl>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bpf_ktime_get_boot_ms </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Return time elapsed since boot in milliseconds including time while suspended. This function uses a lower resolution clock source than bpf_ktime_get_boot_ns, but is faster. </p>
<dl class="section return"><dt>Returns</dt><dd>Time elapsed since boot in milliseconds. </dd></dl>

</div>
</div>
<a id="afcd5d11ba0f150bb73ac41eaf8f847e5"></a>
Expand All @@ -396,6 +422,26 @@ <h2 class="memtitle"><span class="permalink"><a href="#afcd5d11ba0f150bb73ac41ea
<p>Return time elapsed since boot in nanoseconds including time while suspended. </p>
<dl class="section return"><dt>Returns</dt><dd>Time elapsed since boot in nanosecond units. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bpf_ktime_get_ms </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Return time elapsed since boot in milliseconds excluding time while suspended. This function uses a lower resolution clock source than bpf_ktime_get_ns, but is faster. </p>
<dl class="section return"><dt>Returns</dt><dd>Time elapsed since boot in milliseconds. </dd></dl>

</div>
</div>
<a id="a25b647b1c513ab7afec473ee3043e0dd"></a>
Expand Down
12 changes: 12 additions & 0 deletions bpf__helper__defs_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,16 @@
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160;<span class="preprocessor">#define memcpy_s bpf_memcpy</span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160;<span class="preprocessor">#define memmove_s bpf_memmove</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>&#160; </div>
<div class="line"><a name="l00483"></a><span class="lineno"><a class="line" href="bpf__helper__defs_8h.html#a73478db76c69875bbf408500fe2ea3fc"> 483</a></span>&#160;EBPF_HELPER(uint64_t, <a class="code" href="bpf__helper__defs_8h.html#a73478db76c69875bbf408500fe2ea3fc">bpf_ktime_get_boot_ms</a>, ());</div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>&#160;<span class="preprocessor">#ifndef __doxygen</span></div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160;<span class="preprocessor">#define bpf_ktime_get_boot_ms ((bpf_ktime_get_boot_ms_t)BPF_FUNC_ktime_get_boot_ms)</span></div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160; </div>
<div class="line"><a name="l00494"></a><span class="lineno"><a class="line" href="bpf__helper__defs_8h.html#ac6d332de3410614287e7145989a4a042"> 494</a></span>&#160;EBPF_HELPER(uint64_t, <a class="code" href="bpf__helper__defs_8h.html#ac6d332de3410614287e7145989a4a042">bpf_ktime_get_ms</a>, ());</div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>&#160;<span class="preprocessor">#ifndef __doxygen</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160;<span class="preprocessor">#define bpf_ktime_get_ms ((bpf_ktime_get_ms_t)BPF_FUNC_ktime_get_ms)</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</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_a0f748dcfe88e5f21b763292bb2b1b167"><div class="ttname"><a href="bpf__helper__defs_8h.html#a0f748dcfe88e5f21b763292bb2b1b167">bpf_strncpy_s</a></div><div class="ttdeci">int bpf_strncpy_s(char *dest, size_t dest_size, const char *src, size_t count)</div><div class="ttdoc">Copy a string into a buffer, of a fixed size.</div></div>
Expand All @@ -277,6 +287,7 @@
<div class="ttc" id="abpf__helper__defs_8h_html_a51ab6797f98ab75efd0a315e5ad185be"><div class="ttname"><a href="bpf__helper__defs_8h.html#a51ab6797f98ab75efd0a315e5ad185be">bpf_get_current_logon_id</a></div><div class="ttdeci">uint64_t bpf_get_current_logon_id(const void *ctx)</div><div class="ttdoc">Get the 64-bit logon ID of the current thread. In case of sock_addr attach types, get the logon ID of...</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a561a73b93143e70a7af27f6aa6aa48f3"><div class="ttname"><a href="bpf__helper__defs_8h.html#a561a73b93143e70a7af27f6aa6aa48f3">bpf_tail_call</a></div><div class="ttdeci">int64_t bpf_tail_call(void *ctx, void *prog_array_map, uint32_t index)</div><div class="ttdoc">Perform a tail call into another eBPF program.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a56a3b1bec62a48a1aa23726efa29aafa"><div class="ttname"><a href="bpf__helper__defs_8h.html#a56a3b1bec62a48a1aa23726efa29aafa">bpf_trace_printk4</a></div><div class="ttdeci">long bpf_trace_printk4(const char *fmt, uint32_t fmt_size, uint64_t arg3, uint64_t arg4)</div><div class="ttdoc">Print debug output.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a73478db76c69875bbf408500fe2ea3fc"><div class="ttname"><a href="bpf__helper__defs_8h.html#a73478db76c69875bbf408500fe2ea3fc">bpf_ktime_get_boot_ms</a></div><div class="ttdeci">uint64_t bpf_ktime_get_boot_ms()</div><div class="ttdoc">Return time elapsed since boot in milliseconds including time while suspended. This function uses a l...</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_a761216d9ea8f44b31f064e238b3f2f75"><div class="ttname"><a href="bpf__helper__defs_8h.html#a761216d9ea8f44b31f064e238b3f2f75">bpf_memmove</a></div><div class="ttdeci">long bpf_memmove(void *destination, uint32_t destination_size, const void *source, uint32_t source_size)</div><div class="ttdoc">Copy memory from one location to another, handling overlapping regions.</div></div>
<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>
Expand All @@ -286,6 +297,7 @@
<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>
<div class="ttc" id="abpf__helper__defs_8h_html_ab1c6c619dd3307a80909036de1264874"><div class="ttname"><a href="bpf__helper__defs_8h.html#ab1c6c619dd3307a80909036de1264874">bpf_map_lookup_elem</a></div><div class="ttdeci">void * bpf_map_lookup_elem(void *map, void *key)</div><div class="ttdoc">Get a pointer to an entry in the map.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_ac6d332de3410614287e7145989a4a042"><div class="ttname"><a href="bpf__helper__defs_8h.html#ac6d332de3410614287e7145989a4a042">bpf_ktime_get_ms</a></div><div class="ttdeci">uint64_t bpf_ktime_get_ms()</div><div class="ttdoc">Return time elapsed since boot in milliseconds excluding time while suspended. This function uses a l...</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_adad4a120de1d0f6c2a380e8d7b56570b"><div class="ttname"><a href="bpf__helper__defs_8h.html#adad4a120de1d0f6c2a380e8d7b56570b">bpf_get_prandom_u32</a></div><div class="ttdeci">uint32_t bpf_get_prandom_u32()</div><div class="ttdoc">Get a pseudo-random number.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_aeac5e76520396d4436978a5c53cdd94d"><div class="ttname"><a href="bpf__helper__defs_8h.html#aeac5e76520396d4436978a5c53cdd94d">bpf_get_smp_processor_id</a></div><div class="ttdeci">uint64_t bpf_get_smp_processor_id()</div><div class="ttdoc">Return SMP id of the processor running the program.</div></div>
<div class="ttc" id="abpf__helper__defs_8h_html_af19660acfb8574c59f214621ee3dddaa"><div class="ttname"><a href="bpf__helper__defs_8h.html#af19660acfb8574c59f214621ee3dddaa">bpf_map_peek_elem</a></div><div class="ttdeci">int64_t bpf_map_peek_elem(void *map, void *value)</div><div class="ttdoc">Copy an entry from the map (only valid for stack and queue). Queue peeks at the beginning of the map....</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:171</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:261</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:173</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:263</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
Loading

0 comments on commit 0f1c676

Please sign in to comment.