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 Nov 27, 2023
1 parent 5f63327 commit a6aa144
Show file tree
Hide file tree
Showing 2 changed files with 160 additions and 88 deletions.
72 changes: 72 additions & 0 deletions ebpf__extension_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,16 @@
<tr class="memitem:a3e9a56b076375a0ff39336ffde056377"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ebpf__extension__dispatch__table.html">_ebpf_extension_dispatch_table</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__extension_8h.html#a3e9a56b076375a0ff39336ffde056377">ebpf_extension_dispatch_table_t</a></td></tr>
<tr class="separator:a3e9a56b076375a0ff39336ffde056377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae80fa727147e54667fe9876c9caa45ef"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__extension_8h.html#ae80fa727147e54667fe9876c9caa45ef">ebpf_program_invoke_function_t</a>) (const void *extension_client_binding_context, _Inout_ void *program_context, uint32_t *result)</td></tr>
<tr class="memdesc:ae80fa727147e54667fe9876c9caa45ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invoke the eBPF program. <a href="ebpf__extension_8h.html#ae80fa727147e54667fe9876c9caa45ef">More...</a><br /></td></tr>
<tr class="separator:ae80fa727147e54667fe9876c9caa45ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90a1e53ea499494503dbb9a957bc3232"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__extension_8h.html#a90a1e53ea499494503dbb9a957bc3232">ebpf_program_batch_begin_invoke_function_t</a>) (const void *extension_client_binding_context, size_t state_size, _Out_writes_(state_size) void *state)</td></tr>
<tr class="memdesc:a90a1e53ea499494503dbb9a957bc3232"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare the eBPF program for batch invocation. <a href="ebpf__extension_8h.html#a90a1e53ea499494503dbb9a957bc3232">More...</a><br /></td></tr>
<tr class="separator:a90a1e53ea499494503dbb9a957bc3232"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ec831c09562821de93907fe639a3647"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__extension_8h.html#a9ec831c09562821de93907fe639a3647">ebpf_program_batch_invoke_function_t</a>) (const void *extension_client_binding_context, _Inout_ void *program_context, uint32_t *result, const void *state)</td></tr>
<tr class="memdesc:a9ec831c09562821de93907fe639a3647"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invoke the eBPF program in batch mode. <a href="ebpf__extension_8h.html#a9ec831c09562821de93907fe639a3647">More...</a><br /></td></tr>
<tr class="separator:a9ec831c09562821de93907fe639a3647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7db1d33fbe10c5a5f038513232aa0f5"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="ebpf__result_8h.html#ac40fcf7ca8c88cd1975ade33fda0b333">ebpf_result_t</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__extension_8h.html#ad7db1d33fbe10c5a5f038513232aa0f5">ebpf_program_batch_end_invoke_function_t</a>) (const void *extension_client_binding_context, _Inout_ void *state)</td></tr>
<tr class="memdesc:ad7db1d33fbe10c5a5f038513232aa0f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clean up the eBPF program after batch invocation. <a href="ebpf__extension_8h.html#ad7db1d33fbe10c5a5f038513232aa0f5">More...</a><br /></td></tr>
<tr class="separator:ad7db1d33fbe10c5a5f038513232aa0f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7de51587fef3981f43338faa5cef5023"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__ebpf__extension__program__dispatch__table.html">_ebpf_extension_program_dispatch_table</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ebpf__extension_8h.html#a7de51587fef3981f43338faa5cef5023">ebpf_extension_program_dispatch_table_t</a></td></tr>
<tr class="separator:a7de51587fef3981f43338faa5cef5023"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -280,6 +284,24 @@ <h2 class="memtitle"><span class="permalink"><a href="#a90a1e53ea499494503dbb9a9
</table>
</div><div class="memdoc">

<p>Prepare the eBPF program for batch invocation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">extension_client_binding_context</td><td>The context provided by the extension client when the binding was created. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state_size</td><td>The size of the state to be allocated, which should be greater than or equal to sizeof(ebpf_execution_context_state_t). </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">state</td><td>The state to be used for batch invocation.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">EBPF_SUCCESS</td><td>The operation was successful. </td></tr>
<tr><td class="paramname">EBPF_NO_MEMORY</td><td>The operation failed due to lack of memory. </td></tr>
<tr><td class="paramname">EBPF_EXTENSION_FAILED_TO_LOAD</td><td>The required extension is not loaded. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ad7db1d33fbe10c5a5f038513232aa0f5"></a>
Expand All @@ -294,6 +316,21 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad7db1d33fbe10c5a5f038513
</table>
</div><div class="memdoc">

<p>Clean up the eBPF program after batch invocation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">extension_client_binding_context</td><td>The context provided by the extension client when the binding was created. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">state</td><td>The state to be used for batch invocation.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">EBPF_SUCCESS</td><td>The operation was successful. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a9ec831c09562821de93907fe639a3647"></a>
Expand All @@ -308,6 +345,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9ec831c09562821de93907fe
</table>
</div><div class="memdoc">

<p>Invoke the eBPF program in batch mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">extension_client_binding_context</td><td>The context provided by the extension client when the binding was created. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">program_context</td><td>The context for this invocation of the eBPF program. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>The result of the eBPF program. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>The state to be used for batch invocation.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">EBPF_SUCCESS</td><td>The operation was successful. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ae80fa727147e54667fe9876c9caa45ef"></a>
Expand All @@ -322,6 +376,24 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae80fa727147e54667fe9876c
</table>
</div><div class="memdoc">

<p>Invoke the eBPF program. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">extension_client_binding_context</td><td>The context provided by the extension client when the binding was created. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">program_context</td><td>The context for this invocation of the eBPF program. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>The result of the eBPF program.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">EBPF_SUCCESS</td><td>The operation was successful. </td></tr>
<tr><td class="paramname">EBPF_NO_MEMORY</td><td>The operation failed due to lack of memory. </td></tr>
<tr><td class="paramname">EBPF_EXTENSION_FAILED_TO_LOAD</td><td>The required extension is not loaded. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div><!-- contents -->
Expand Down
Loading

0 comments on commit a6aa144

Please sign in to comment.