Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Github Action <ubpf@users.noreply.github.com>
  • Loading branch information
Github Action committed May 17, 2024
1 parent 4e339f1 commit 51686af
Show file tree
Hide file tree
Showing 34 changed files with 1,113 additions and 208 deletions.
60 changes: 56 additions & 4 deletions globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,26 @@
</div>

<div class="contents">
<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div><ul>
<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div>

<h3><a id="index_a"></a>- a -</h3><ul>
<li>as_external_function_t()
: <a class="el" href="ubpf_8h.html#a53971fe3966198c6fec238d81d94bfe8">ubpf.h</a>
</li>
</ul>


<h3><a id="index_b"></a>- b -</h3><ul>
<li>BasicJitMode
: <a class="el" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8">ubpf.h</a>
</li>
</ul>


<h3><a id="index_e"></a>- e -</h3><ul>
<li>ExtendedJitMode
: <a class="el" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd">ubpf.h</a>
</li>
<li>external_function_dispatcher_t
: <a class="el" href="ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b">ubpf.h</a>
</li>
Expand All @@ -74,12 +90,33 @@
<li>external_function_validate_t
: <a class="el" href="ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c">ubpf.h</a>
</li>
</ul>


<h3><a id="index_j"></a>- j -</h3><ul>
<li>JitMode
: <a class="el" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd">ubpf.h</a>
</li>
</ul>


<h3><a id="index_s"></a>- s -</h3><ul>
<li>stack_usage_calculator_t
: <a class="el" href="ubpf_8h.html#a087420d1735791ffa6c5c436f52da00e">ubpf.h</a>
</li>
</ul>


<h3><a id="index_u"></a>- u -</h3><ul>
<li>ubpf_bounds_check
: <a class="el" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699">ubpf.h</a>
</li>
<li>ubpf_compile()
: <a class="el" href="ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba">ubpf.h</a>
</li>
<li>ubpf_compile_ex()
: <a class="el" href="ubpf_8h.html#a281772f3e99c3d8505751297c51aa22e">ubpf.h</a>
</li>
<li>ubpf_copy_jit()
: <a class="el" href="ubpf_8h.html#aa2604f93223a8f076b503ba144a6b1ce">ubpf.h</a>
</li>
Expand All @@ -92,12 +129,24 @@
<li>ubpf_destroy()
: <a class="el" href="ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f">ubpf.h</a>
</li>
<li>UBPF_EBPF_NONVOLATILE_SIZE
: <a class="el" href="ubpf_8h.html#ae89d6c1d7d2bda6006e9969e731826a3">ubpf.h</a>
</li>
<li>UBPF_EBPF_STACK_SIZE
: <a class="el" href="ubpf_8h.html#a91fdfd9d55e9ffcadcfe27a87340eace">ubpf.h</a>
</li>
<li>ubpf_exec()
: <a class="el" href="ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95">ubpf.h</a>
</li>
<li>ubpf_exec_ex()
: <a class="el" href="ubpf_8h.html#a6ded3ae17d5879d7c19f32fa52cbbe26">ubpf.h</a>
</li>
<li>ubpf_get_registers()
: <a class="el" href="ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4">ubpf.h</a>
</li>
<li>ubpf_jit_ex_fn
: <a class="el" href="ubpf_8h.html#a30c41270d593fc7ffc2161f03f8c0b5b">ubpf.h</a>
</li>
<li>ubpf_jit_fn
: <a class="el" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf.h</a>
</li>
Expand All @@ -122,6 +171,9 @@
<li>ubpf_register_external_dispatcher()
: <a class="el" href="ubpf_8h.html#a27fbf5d30614b9c4b618209d681c3653">ubpf.h</a>
</li>
<li>ubpf_register_stack_usage_calculator()
: <a class="el" href="ubpf_8h.html#aacb195bc0c95663214fe205613ff1c9a">ubpf.h</a>
</li>
<li>ubpf_set_error_print()
: <a class="el" href="ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c">ubpf.h</a>
</li>
Expand All @@ -140,15 +192,15 @@
<li>ubpf_set_unwind_function_index()
: <a class="el" href="ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3">ubpf.h</a>
</li>
<li>UBPF_STACK_SIZE
: <a class="el" href="ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12">ubpf.h</a>
</li>
<li>ubpf_toggle_bounds_check()
: <a class="el" href="ubpf_8h.html#a80938918080712ac0667359fd163f1a5">ubpf.h</a>
</li>
<li>ubpf_translate()
: <a class="el" href="ubpf_8h.html#ab34e26c0a46366345df354ce992448c4">ubpf.h</a>
</li>
<li>ubpf_translate_ex()
: <a class="el" href="ubpf_8h.html#afb2b46e62e54e7e8b81303def1014eb0">ubpf.h</a>
</li>
<li>ubpf_unload_code()
: <a class="el" href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25">ubpf.h</a>
</li>
Expand Down
9 changes: 6 additions & 3 deletions globals_defs.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,18 @@

<div class="contents">
&#160;<ul>
<li>UBPF_EBPF_NONVOLATILE_SIZE
: <a class="el" href="ubpf_8h.html#ae89d6c1d7d2bda6006e9969e731826a3">ubpf.h</a>
</li>
<li>UBPF_EBPF_STACK_SIZE
: <a class="el" href="ubpf_8h.html#a91fdfd9d55e9ffcadcfe27a87340eace">ubpf.h</a>
</li>
<li>UBPF_MAX_CALL_DEPTH
: <a class="el" href="ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8">ubpf.h</a>
</li>
<li>UBPF_MAX_INSTS
: <a class="el" href="ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f">ubpf.h</a>
</li>
<li>UBPF_STACK_SIZE
: <a class="el" href="ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12">ubpf.h</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
75 changes: 75 additions & 0 deletions globals_enum.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uBPF: Globals</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uBPF
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="contents">
&#160;<ul>
<li>JitMode
: <a class="el" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd">ubpf.h</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
78 changes: 78 additions & 0 deletions globals_eval.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uBPF: Globals</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uBPF
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="contents">
&#160;<ul>
<li>BasicJitMode
: <a class="el" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8">ubpf.h</a>
</li>
<li>ExtendedJitMode
: <a class="el" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd">ubpf.h</a>
</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
12 changes: 12 additions & 0 deletions globals_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@
<li>ubpf_compile()
: <a class="el" href="ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba">ubpf.h</a>
</li>
<li>ubpf_compile_ex()
: <a class="el" href="ubpf_8h.html#a281772f3e99c3d8505751297c51aa22e">ubpf.h</a>
</li>
<li>ubpf_copy_jit()
: <a class="el" href="ubpf_8h.html#aa2604f93223a8f076b503ba144a6b1ce">ubpf.h</a>
</li>
Expand All @@ -80,6 +83,9 @@
<li>ubpf_exec()
: <a class="el" href="ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95">ubpf.h</a>
</li>
<li>ubpf_exec_ex()
: <a class="el" href="ubpf_8h.html#a6ded3ae17d5879d7c19f32fa52cbbe26">ubpf.h</a>
</li>
<li>ubpf_get_registers()
: <a class="el" href="ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4">ubpf.h</a>
</li>
Expand All @@ -98,6 +104,9 @@
<li>ubpf_register_external_dispatcher()
: <a class="el" href="ubpf_8h.html#a27fbf5d30614b9c4b618209d681c3653">ubpf.h</a>
</li>
<li>ubpf_register_stack_usage_calculator()
: <a class="el" href="ubpf_8h.html#aacb195bc0c95663214fe205613ff1c9a">ubpf.h</a>
</li>
<li>ubpf_set_error_print()
: <a class="el" href="ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c">ubpf.h</a>
</li>
Expand All @@ -122,6 +131,9 @@
<li>ubpf_translate()
: <a class="el" href="ubpf_8h.html#ab34e26c0a46366345df354ce992448c4">ubpf.h</a>
</li>
<li>ubpf_translate_ex()
: <a class="el" href="ubpf_8h.html#afb2b46e62e54e7e8b81303def1014eb0">ubpf.h</a>
</li>
<li>ubpf_unload_code()
: <a class="el" href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25">ubpf.h</a>
</li>
Expand Down
6 changes: 6 additions & 0 deletions globals_type.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,18 @@
<li>external_function_validate_t
: <a class="el" href="ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c">ubpf.h</a>
</li>
<li>stack_usage_calculator_t
: <a class="el" href="ubpf_8h.html#a087420d1735791ffa6c5c436f52da00e">ubpf.h</a>
</li>
<li>ubpf_bounds_check
: <a class="el" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699">ubpf.h</a>
</li>
<li>ubpf_data_relocation
: <a class="el" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391">ubpf.h</a>
</li>
<li>ubpf_jit_ex_fn
: <a class="el" href="ubpf_8h.html#a30c41270d593fc7ffc2161f03f8c0b5b">ubpf.h</a>
</li>
<li>ubpf_jit_fn
: <a class="el" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf.h</a>
</li>
Expand Down
10 changes: 9 additions & 1 deletion menudata.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,15 @@ var menudata={children:[
{text:"Files",url:"files.html",children:[
{text:"File List",url:"files.html"},
{text:"Globals",url:"globals.html",children:[
{text:"All",url:"globals.html"},
{text:"All",url:"globals.html",children:[
{text:"a",url:"globals.html#index_a"},
{text:"b",url:"globals.html#index_b"},
{text:"e",url:"globals.html#index_e"},
{text:"j",url:"globals.html#index_j"},
{text:"s",url:"globals.html#index_s"},
{text:"u",url:"globals.html#index_u"}]},
{text:"Functions",url:"globals_func.html"},
{text:"Typedefs",url:"globals_type.html"},
{text:"Enumerations",url:"globals_enum.html"},
{text:"Enumerator",url:"globals_eval.html"},
{text:"Macros",url:"globals_defs.html"}]}]}]}
4 changes: 1 addition & 3 deletions search/all_1.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
var searchData=
[
['external_5ffunction_5fdispatcher_5ft_1',['external_function_dispatcher_t',['../ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b',1,'ubpf.h']]],
['external_5ffunction_5ft_2',['external_function_t',['../ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30',1,'ubpf.h']]],
['external_5ffunction_5fvalidate_5ft_3',['external_function_validate_t',['../ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c',1,'ubpf.h']]]
['basicjitmode_1',['BasicJitMode',['../ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8',1,'ubpf.h']]]
];
5 changes: 4 additions & 1 deletion search/all_2.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
var searchData=
[
['mainpage_2edox_4',['mainpage.dox',['../mainpage_8dox.html',1,'']]]
['extendedjitmode_2',['ExtendedJitMode',['../ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd',1,'ubpf.h']]],
['external_5ffunction_5fdispatcher_5ft_3',['external_function_dispatcher_t',['../ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b',1,'ubpf.h']]],
['external_5ffunction_5ft_4',['external_function_t',['../ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30',1,'ubpf.h']]],
['external_5ffunction_5fvalidate_5ft_5',['external_function_validate_t',['../ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c',1,'ubpf.h']]]
];
Loading

0 comments on commit 51686af

Please sign in to comment.