| <!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" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>uBPF: vm/inc/ubpf.h Source File</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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">uBPF |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_93effe02d2e8dd09437fb49d0adaddf7.html">vm</a></li><li class="navelem"><a class="el" href="dir_cf6c78462b393272f91793a3a49557d3.html">inc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">ubpf.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="ubpf_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright (c) 2015 Big Switch Networks, Inc</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-License-Identifier: Apache-2.0</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Copyright 2015 Big Switch Networks, Inc</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef UBPF_H</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define UBPF_H</span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>{</div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <ubpf_config.h></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include <stdio.h></span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include <stdint.h></span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include <stddef.h></span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include <stdbool.h></span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#if !defined(UBPF_MAX_INSTS)</span></div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f"> 39</a></span><span class="preprocessor">#define UBPF_MAX_INSTS 65536</span></div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#if !defined(UBPF_MAX_CALL_DEPTH)</span></div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8"> 46</a></span><span class="preprocessor">#define UBPF_MAX_CALL_DEPTH 8</span></div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#if !defined(UBPF_EBPF_STACK_SIZE)</span></div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a91fdfd9d55e9ffcadcfe27a87340eace"> 53</a></span><span class="preprocessor">#define UBPF_EBPF_STACK_SIZE (UBPF_MAX_CALL_DEPTH * 512)</span></div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#if !defined(UBPF_EBPF_LOCAL_FUNCTION_STACK_SIZE)</span></div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a62c7fa1f07bf5c6d3734a1fcd4e6d6cf"> 65</a></span><span class="preprocessor">#define UBPF_EBPF_LOCAL_FUNCTION_STACK_SIZE 256</span></div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae89d6c1d7d2bda6006e9969e731826a3"> 68</a></span><span class="preprocessor">#define UBPF_EBPF_NONVOLATILE_SIZE (sizeof(uint64_t) * 5)</span></div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">struct </span>ubpf_vm;</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0"> 79</a></span> <span class="keyword">typedef</span> uint64_t (*<a class="code hl_typedef" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf_jit_fn</a>)(<span class="keywordtype">void</span>* mem, <span class="keywordtype">size_t</span> mem_len);</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a30c41270d593fc7ffc2161f03f8c0b5b"> 85</a></span> <span class="keyword">typedef</span> uint64_t (*<a class="code hl_typedef" href="ubpf_8h.html#a30c41270d593fc7ffc2161f03f8c0b5b">ubpf_jit_ex_fn</a>)(<span class="keywordtype">void</span>* mem, <span class="keywordtype">size_t</span> mem_len, uint8_t* stack, <span class="keywordtype">size_t</span> stack_len);</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="foldopen" id="foldopen00104" data-start="{" data-end="};"> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd"> 104</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd">JitMode</a></div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> {</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd"> 106</a></span> <a class="code hl_enumvalue" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd">ExtendedJitMode</a>,</div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_enumvalue" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8">BasicJitMode</a></div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8"> 108</a></span> };</div> |
| </div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">struct </span>ubpf_vm*</div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a626fc733422de6db211fa33fe1f19727"> 116</a></span> <a class="code hl_function" href="ubpf_8h.html#a626fc733422de6db211fa33fe1f19727">ubpf_create</a>(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">void</span></div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f"> 124</a></span> <a class="code hl_function" href="ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f">ubpf_destroy</a>(<span class="keyword">struct</span> ubpf_vm* vm);</div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">bool</span></div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a80938918080712ac0667359fd163f1a5"> 134</a></span> <a class="code hl_function" href="ubpf_8h.html#a80938918080712ac0667359fd163f1a5">ubpf_toggle_bounds_check</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">bool</span> enable);</div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div> |
| <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">void</span></div> |
| <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c"> 143</a></span> <a class="code hl_function" href="ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c">ubpf_set_error_print</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">int</span> (*error_printf)(FILE* stream, <span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...));</div> |
| <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div> |
| <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30"> 152</a></span> <span class="keyword">typedef</span> uint64_t (*<a class="code hl_typedef" href="ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30">external_function_t</a>)(uint64_t p0, uint64_t p1, uint64_t p2, uint64_t p3, uint64_t p4);</div> |
| <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div> |
| <div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <a class="code hl_typedef" href="ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30">external_function_t</a></div> |
| <div class="line"><a id="l00166" name="l00166"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a53971fe3966198c6fec238d81d94bfe8"> 166</a></span> <a class="code hl_function" href="ubpf_8h.html#a53971fe3966198c6fec238d81d94bfe8">as_external_function_t</a>(<span class="keywordtype">void</span>* f);</div> |
| <div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> </div> |
| <div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00182" name="l00182"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a398c1c9b6d59876005eb64bbfab7b2b4"> 182</a></span> <a class="code hl_function" href="ubpf_8h.html#a398c1c9b6d59876005eb64bbfab7b2b4">ubpf_register</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code hl_typedef" href="ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30">external_function_t</a> fn);</div> |
| <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> </div> |
| <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b"> 187</a></span> <span class="keyword">typedef</span> uint64_t (*<a class="code hl_typedef" href="ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b">external_function_dispatcher_t</a>)(</div> |
| <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keywordtype">void</span>* cookie);</div> |
| <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div> |
| <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c"> 193</a></span> <span class="keyword">typedef</span> bool (*<a class="code hl_typedef" href="ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c">external_function_validate_t</a>)(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keyword">const</span> <span class="keyword">struct </span>ubpf_vm* vm);</div> |
| <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div> |
| <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a27fbf5d30614b9c4b618209d681c3653"> 212</a></span> <a class="code hl_function" href="ubpf_8h.html#a27fbf5d30614b9c4b618209d681c3653">ubpf_register_external_dispatcher</a>(</div> |
| <div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> <span class="keyword">struct</span> ubpf_vm* vm, <a class="code hl_typedef" href="ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b">external_function_dispatcher_t</a> dispatcher, <a class="code hl_typedef" href="ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c">external_function_validate_t</a> validater);</div> |
| <div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> </div> |
| <div class="line"><a id="l00220" name="l00220"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a087420d1735791ffa6c5c436f52da00e"> 220</a></span> <span class="keyword">typedef</span> int (*<a class="code hl_typedef" href="ubpf_8h.html#a087420d1735791ffa6c5c436f52da00e">stack_usage_calculator_t</a>)(<span class="keyword">const</span> <span class="keyword">struct </span>ubpf_vm* vm, uint16_t pc, <span class="keywordtype">void</span>* cookie);</div> |
| <div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> </div> |
| <div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00246" name="l00246"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aacb195bc0c95663214fe205613ff1c9a"> 246</a></span> <a class="code hl_function" href="ubpf_8h.html#aacb195bc0c95663214fe205613ff1c9a">ubpf_register_stack_usage_calculator</a>(<span class="keyword">struct</span> ubpf_vm* vm, <a class="code hl_typedef" href="ubpf_8h.html#a087420d1735791ffa6c5c436f52da00e">stack_usage_calculator_t</a> calculator, <span class="keywordtype">void</span>* cookie);</div> |
| <div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> </div> |
| <div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00264" name="l00264"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d"> 264</a></span> <a class="code hl_function" href="ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d">ubpf_load</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keyword">const</span> <span class="keywordtype">void</span>* code, uint32_t code_len, <span class="keywordtype">char</span>** errmsg);</div> |
| <div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> </div> |
| <div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> <span class="comment">/*</span></div> |
| <div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span><span class="comment"> * Unload code from a VM</span></div> |
| <div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span><span class="comment"> * This must be done before calling ubpf_load or ubpf_load_elf, except for the</span></div> |
| <div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span><span class="comment"> * first time those functions are called. It clears the VM instructions to</span></div> |
| <div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span><span class="comment"> * allow for new code to be loaded.</span></div> |
| <div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span><span class="comment"> * It does not unregister any external functions.</span></div> |
| <div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> </div> |
| <div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> <span class="keywordtype">void</span></div> |
| <div class="line"><a id="l00284" name="l00284"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25"> 284</a></span> <a class="code hl_function" href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25">ubpf_unload_code</a>(<span class="keyword">struct</span> ubpf_vm* vm);</div> |
| <div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span> </div> |
| <div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span><span class="preprocessor">#if defined(UBPF_HAS_ELF_H)</span></div> |
| <div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> ubpf_load_elf(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keyword">const</span> <span class="keywordtype">void</span>* elf, <span class="keywordtype">size_t</span> elf_len, <span class="keywordtype">char</span>** errmsg);</div> |
| <div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span> </div> |
| <div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span> ubpf_load_elf_ex(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keyword">const</span> <span class="keywordtype">void</span>* elf, <span class="keywordtype">size_t</span> elf_len, <span class="keyword">const</span> <span class="keywordtype">char</span>* main_section_name, <span class="keywordtype">char</span>** errmsg);</div> |
| <div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span> </div> |
| <div class="line"><a id="l00349" name="l00349"></a><span class="lineno"> 349</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00350" name="l00350"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95"> 350</a></span> <a class="code hl_function" href="ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95">ubpf_exec</a>(<span class="keyword">const</span> <span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">void</span>* mem, <span class="keywordtype">size_t</span> mem_len, uint64_t* bpf_return_value);</div> |
| <div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> </div> |
| <div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00353" name="l00353"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a6ded3ae17d5879d7c19f32fa52cbbe26"> 353</a></span> <a class="code hl_function" href="ubpf_8h.html#a6ded3ae17d5879d7c19f32fa52cbbe26">ubpf_exec_ex</a>(</div> |
| <div class="line"><a id="l00354" name="l00354"></a><span class="lineno"> 354</span> <span class="keyword">const</span> <span class="keyword">struct</span> ubpf_vm* vm,</div> |
| <div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> <span class="keywordtype">void</span>* mem,</div> |
| <div class="line"><a id="l00356" name="l00356"></a><span class="lineno"> 356</span> <span class="keywordtype">size_t</span> mem_len,</div> |
| <div class="line"><a id="l00357" name="l00357"></a><span class="lineno"> 357</span> uint64_t* bpf_return_value,</div> |
| <div class="line"><a id="l00358" name="l00358"></a><span class="lineno"> 358</span> uint8_t* stack,</div> |
| <div class="line"><a id="l00359" name="l00359"></a><span class="lineno"> 359</span> <span class="keywordtype">size_t</span> stack_len);</div> |
| <div class="line"><a id="l00360" name="l00360"></a><span class="lineno"> 360</span> </div> |
| <div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span> <a class="code hl_typedef" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf_jit_fn</a></div> |
| <div class="line"><a id="l00375" name="l00375"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba"> 375</a></span> <a class="code hl_function" href="ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba">ubpf_compile</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">char</span>** errmsg);</div> |
| <div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span> </div> |
| <div class="line"><a id="l00393" name="l00393"></a><span class="lineno"> 393</span> <a class="code hl_typedef" href="ubpf_8h.html#a30c41270d593fc7ffc2161f03f8c0b5b">ubpf_jit_ex_fn</a></div> |
| <div class="line"><a id="l00394" name="l00394"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a281772f3e99c3d8505751297c51aa22e"> 394</a></span> <a class="code hl_function" href="ubpf_8h.html#a281772f3e99c3d8505751297c51aa22e">ubpf_compile_ex</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">char</span>** errmsg, <span class="keyword">enum</span> <a class="code hl_enumeration" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd">JitMode</a> jit_mode);</div> |
| <div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span> </div> |
| <div class="line"><a id="l00410" name="l00410"></a><span class="lineno"> 410</span> <a class="code hl_typedef" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf_jit_fn</a></div> |
| <div class="line"><a id="l00411" name="l00411"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aa2604f93223a8f076b503ba144a6b1ce"> 411</a></span> <a class="code hl_function" href="ubpf_8h.html#aa2604f93223a8f076b503ba144a6b1ce">ubpf_copy_jit</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <span class="keywordtype">char</span>** errmsg);</div> |
| <div class="line"><a id="l00412" name="l00412"></a><span class="lineno"> 412</span> </div> |
| <div class="line"><a id="l00428" name="l00428"></a><span class="lineno"> 428</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00429" name="l00429"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ab34e26c0a46366345df354ce992448c4"> 429</a></span> <a class="code hl_function" href="ubpf_8h.html#ab34e26c0a46366345df354ce992448c4">ubpf_translate</a>(<span class="keyword">struct</span> ubpf_vm* vm, uint8_t* buffer, <span class="keywordtype">size_t</span>* size, <span class="keywordtype">char</span>** errmsg);</div> |
| <div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> </div> |
| <div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00448" name="l00448"></a><span class="lineno"><a class="line" href="ubpf_8h.html#afb2b46e62e54e7e8b81303def1014eb0"> 448</a></span> <a class="code hl_function" href="ubpf_8h.html#afb2b46e62e54e7e8b81303def1014eb0">ubpf_translate_ex</a>(<span class="keyword">struct</span> ubpf_vm* vm, uint8_t* buffer, <span class="keywordtype">size_t</span>* size, <span class="keywordtype">char</span>** errmsg, <span class="keyword">enum</span> <a class="code hl_enumeration" href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd">JitMode</a> jit_mode);</div> |
| <div class="line"><a id="l00449" name="l00449"></a><span class="lineno"> 449</span> </div> |
| <div class="line"><a id="l00461" name="l00461"></a><span class="lineno"> 461</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00462" name="l00462"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3"> 462</a></span> <a class="code hl_function" href="ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3">ubpf_set_unwind_function_index</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> idx);</div> |
| <div class="line"><a id="l00463" name="l00463"></a><span class="lineno"> 463</span> </div> |
| <div class="line"><a id="l00470" name="l00470"></a><span class="lineno"> 470</span> <span class="keywordtype">void</span></div> |
| <div class="line"><a id="l00471" name="l00471"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f"> 471</a></span> <a class="code hl_function" href="ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f">ubpf_set_registers</a>(<span class="keyword">struct</span> ubpf_vm* vm, uint64_t* regs);</div> |
| <div class="line"><a id="l00472" name="l00472"></a><span class="lineno"> 472</span> </div> |
| <div class="line"><a id="l00479" name="l00479"></a><span class="lineno"> 479</span> uint64_t*</div> |
| <div class="line"><a id="l00480" name="l00480"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aa27c1899a4e7e8d19d473111849d1a01"> 480</a></span> <a class="code hl_function" href="ubpf_8h.html#aa27c1899a4e7e8d19d473111849d1a01">ubpf_get_registers</a>(<span class="keyword">const</span> <span class="keyword">struct</span> ubpf_vm* vm);</div> |
| <div class="line"><a id="l00481" name="l00481"></a><span class="lineno"> 481</span> </div> |
| <div class="line"><a id="l00490" name="l00490"></a><span class="lineno"> 490</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00491" name="l00491"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701"> 491</a></span> <a class="code hl_function" href="ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701">ubpf_set_pointer_secret</a>(<span class="keyword">struct</span> ubpf_vm* vm, uint64_t secret);</div> |
| <div class="line"><a id="l00492" name="l00492"></a><span class="lineno"> 492</span> </div> |
| <div class="line"><a id="l00505" name="l00505"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391"> 505</a></span> <span class="keyword">typedef</span> uint64_t (*<a class="code hl_typedef" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391">ubpf_data_relocation</a>)(</div> |
| <div class="line"><a id="l00506" name="l00506"></a><span class="lineno"> 506</span> <span class="keywordtype">void</span>* user_context,</div> |
| <div class="line"><a id="l00507" name="l00507"></a><span class="lineno"> 507</span> <span class="keyword">const</span> uint8_t* data,</div> |
| <div class="line"><a id="l00508" name="l00508"></a><span class="lineno"> 508</span> uint64_t data_size,</div> |
| <div class="line"><a id="l00509" name="l00509"></a><span class="lineno"> 509</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* symbol_name,</div> |
| <div class="line"><a id="l00510" name="l00510"></a><span class="lineno"> 510</span> uint64_t symbol_offset,</div> |
| <div class="line"><a id="l00511" name="l00511"></a><span class="lineno"> 511</span> uint64_t symbol_size);</div> |
| <div class="line"><a id="l00512" name="l00512"></a><span class="lineno"> 512</span> </div> |
| <div class="line"><a id="l00520" name="l00520"></a><span class="lineno"> 520</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00521" name="l00521"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611"> 521</a></span> <a class="code hl_function" href="ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611">ubpf_register_data_relocation</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">void</span>* user_context, <a class="code hl_typedef" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391">ubpf_data_relocation</a> relocation);</div> |
| <div class="line"><a id="l00522" name="l00522"></a><span class="lineno"> 522</span> </div> |
| <div class="line"><a id="l00532" name="l00532"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699"> 532</a></span> <span class="keyword">typedef</span> bool (*<a class="code hl_typedef" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699">ubpf_bounds_check</a>)(<span class="keywordtype">void</span>* context, uint64_t addr, uint64_t size);</div> |
| <div class="line"><a id="l00533" name="l00533"></a><span class="lineno"> 533</span> </div> |
| <div class="line"><a id="l00543" name="l00543"></a><span class="lineno"> 543</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00544" name="l00544"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03"> 544</a></span> <a class="code hl_function" href="ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03">ubpf_register_data_bounds_check</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">void</span>* user_context, <a class="code hl_typedef" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699">ubpf_bounds_check</a> bounds_check);</div> |
| <div class="line"><a id="l00545" name="l00545"></a><span class="lineno"> 545</span> </div> |
| <div class="line"><a id="l00558" name="l00558"></a><span class="lineno"> 558</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00559" name="l00559"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a96cdff7433769540c61a1cf41a0c241a"> 559</a></span> <a class="code hl_function" href="ubpf_8h.html#a96cdff7433769540c61a1cf41a0c241a">ubpf_set_jit_code_size</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">size_t</span> code_size);</div> |
| <div class="line"><a id="l00560" name="l00560"></a><span class="lineno"> 560</span> </div> |
| <div class="line"><a id="l00572" name="l00572"></a><span class="lineno"> 572</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00573" name="l00573"></a><span class="lineno"><a class="line" href="ubpf_8h.html#adfaef65d4add64487f09c0bd1d0a08df"> 573</a></span> <a class="code hl_function" href="ubpf_8h.html#adfaef65d4add64487f09c0bd1d0a08df">ubpf_set_instruction_limit</a>(<span class="keyword">struct</span> ubpf_vm* vm, uint32_t limit, uint32_t* previous_limit);</div> |
| <div class="line"><a id="l00574" name="l00574"></a><span class="lineno"> 574</span> </div> |
| <div class="line"><a id="l00585" name="l00585"></a><span class="lineno"> 585</span> <span class="keywordtype">bool</span></div> |
| <div class="line"><a id="l00586" name="l00586"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a4033cc1ab40ffc0d3de6efb70bb91768"> 586</a></span> <a class="code hl_function" href="ubpf_8h.html#a4033cc1ab40ffc0d3de6efb70bb91768">ubpf_toggle_undefined_behavior_check</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">bool</span> enable);</div> |
| <div class="line"><a id="l00587" name="l00587"></a><span class="lineno"> 587</span> </div> |
| <div class="line"><a id="l00603" name="l00603"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aebce576f96f17df34a30029636515fcc"> 603</a></span> <span class="keyword">typedef</span> void (*<a class="code hl_typedef" href="ubpf_8h.html#aebce576f96f17df34a30029636515fcc">ubpf_debug_fn</a>)(</div> |
| <div class="line"><a id="l00604" name="l00604"></a><span class="lineno"> 604</span> <span class="keywordtype">void</span>* context,</div> |
| <div class="line"><a id="l00605" name="l00605"></a><span class="lineno"> 605</span> <span class="keywordtype">int</span> program_counter,</div> |
| <div class="line"><a id="l00606" name="l00606"></a><span class="lineno"> 606</span> <span class="keyword">const</span> uint64_t registers[16],</div> |
| <div class="line"><a id="l00607" name="l00607"></a><span class="lineno"> 607</span> <span class="keyword">const</span> uint8_t* stack_start,</div> |
| <div class="line"><a id="l00608" name="l00608"></a><span class="lineno"> 608</span> <span class="keywordtype">size_t</span> stack_length,</div> |
| <div class="line"><a id="l00609" name="l00609"></a><span class="lineno"> 609</span> uint64_t register_mask,</div> |
| <div class="line"><a id="l00610" name="l00610"></a><span class="lineno"> 610</span> <span class="keyword">const</span> uint8_t* stack_mask_start);</div> |
| <div class="line"><a id="l00611" name="l00611"></a><span class="lineno"> 611</span> </div> |
| <div class="line"><a id="l00621" name="l00621"></a><span class="lineno"> 621</span> <span class="keywordtype">int</span></div> |
| <div class="line"><a id="l00622" name="l00622"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aae07506453000ed9fc787a27fa3b9f9e"> 622</a></span> <a class="code hl_function" href="ubpf_8h.html#aae07506453000ed9fc787a27fa3b9f9e">ubpf_register_debug_fn</a>(<span class="keyword">struct</span> ubpf_vm* vm, <span class="keywordtype">void</span>* context, <a class="code hl_typedef" href="ubpf_8h.html#aebce576f96f17df34a30029636515fcc">ubpf_debug_fn</a> debug_function);</div> |
| <div class="line"><a id="l00623" name="l00623"></a><span class="lineno"> 623</span><span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a id="l00624" name="l00624"></a><span class="lineno"> 624</span>}</div> |
| <div class="line"><a id="l00625" name="l00625"></a><span class="lineno"> 625</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00626" name="l00626"></a><span class="lineno"> 626</span> </div> |
| <div class="line"><a id="l00627" name="l00627"></a><span class="lineno"> 627</span><span class="preprocessor">#endif</span></div> |
| <div class="ttc" id="aubpf_8h_html_a0046484ecdb72363d0c5ae710e7b96c3"><div class="ttname"><a href="ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3">ubpf_set_unwind_function_index</a></div><div class="ttdeci">int ubpf_set_unwind_function_index(struct ubpf_vm *vm, unsigned int idx)</div><div class="ttdoc">Instruct the uBPF runtime to apply unwind-on-success semantics to a helper function....</div></div> |
| <div class="ttc" id="aubpf_8h_html_a087420d1735791ffa6c5c436f52da00e"><div class="ttname"><a href="ubpf_8h.html#a087420d1735791ffa6c5c436f52da00e">stack_usage_calculator_t</a></div><div class="ttdeci">int(* stack_usage_calculator_t)(const struct ubpf_vm *vm, uint16_t pc, void *cookie)</div><div class="ttdoc">The type of a stack usage calculator callback function.</div><div class="ttdef"><b>Definition</b> ubpf.h:220</div></div> |
| <div class="ttc" id="aubpf_8h_html_a1ce3eb22d45ec43436758a139ffc8c95"><div class="ttname"><a href="ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95">ubpf_exec</a></div><div class="ttdeci">int ubpf_exec(const struct ubpf_vm *vm, void *mem, size_t mem_len, uint64_t *bpf_return_value)</div><div class="ttdoc">Execute a BPF program in the VM using the interpreter.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a27fbf5d30614b9c4b618209d681c3653"><div class="ttname"><a href="ubpf_8h.html#a27fbf5d30614b9c4b618209d681c3653">ubpf_register_external_dispatcher</a></div><div class="ttdeci">int ubpf_register_external_dispatcher(struct ubpf_vm *vm, external_function_dispatcher_t dispatcher, external_function_validate_t validater)</div><div class="ttdoc">Register a function that dispatches to external helpers The immediate field of a CALL instruction is ...</div></div> |
| <div class="ttc" id="aubpf_8h_html_a281772f3e99c3d8505751297c51aa22e"><div class="ttname"><a href="ubpf_8h.html#a281772f3e99c3d8505751297c51aa22e">ubpf_compile_ex</a></div><div class="ttdeci">ubpf_jit_ex_fn ubpf_compile_ex(struct ubpf_vm *vm, char **errmsg, enum JitMode jit_mode)</div><div class="ttdoc">Compile a BPF program in the VM to native code.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a286aa9da7688d1327756e967eafc2f03"><div class="ttname"><a href="ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03">ubpf_register_data_bounds_check</a></div><div class="ttdeci">int ubpf_register_data_bounds_check(struct ubpf_vm *vm, void *user_context, ubpf_bounds_check bounds_check)</div><div class="ttdoc">Set a bounds check function for the VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a30c41270d593fc7ffc2161f03f8c0b5b"><div class="ttname"><a href="ubpf_8h.html#a30c41270d593fc7ffc2161f03f8c0b5b">ubpf_jit_ex_fn</a></div><div class="ttdeci">uint64_t(* ubpf_jit_ex_fn)(void *mem, size_t mem_len, uint8_t *stack, size_t stack_len)</div><div class="ttdoc">Opaque type for a uBPF JIT compiled function with external stack.</div><div class="ttdef"><b>Definition</b> ubpf.h:85</div></div> |
| <div class="ttc" id="aubpf_8h_html_a3257e0611c177eeaba7053e2eca92701"><div class="ttname"><a href="ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701">ubpf_set_pointer_secret</a></div><div class="ttdeci">int ubpf_set_pointer_secret(struct ubpf_vm *vm, uint64_t secret)</div><div class="ttdoc">Optional secret to improve ROP protection.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a398c1c9b6d59876005eb64bbfab7b2b4"><div class="ttname"><a href="ubpf_8h.html#a398c1c9b6d59876005eb64bbfab7b2b4">ubpf_register</a></div><div class="ttdeci">int ubpf_register(struct ubpf_vm *vm, unsigned int index, const char *name, external_function_t fn)</div><div class="ttdoc">Register an external function. The immediate field of a CALL instruction is an index into an array of...</div></div> |
| <div class="ttc" id="aubpf_8h_html_a4033cc1ab40ffc0d3de6efb70bb91768"><div class="ttname"><a href="ubpf_8h.html#a4033cc1ab40ffc0d3de6efb70bb91768">ubpf_toggle_undefined_behavior_check</a></div><div class="ttdeci">bool ubpf_toggle_undefined_behavior_check(struct ubpf_vm *vm, bool enable)</div><div class="ttdoc">Enable or disable undefined behavior checks. Undefined behavior includes reading from uninitialized m...</div></div> |
| <div class="ttc" id="aubpf_8h_html_a4be1055c33e64a9f81abf25f8b5ddedd"><div class="ttname"><a href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedd">JitMode</a></div><div class="ttdeci">JitMode</div><div class="ttdoc">Enum to describe JIT mode.</div><div class="ttdef"><b>Definition</b> ubpf.h:105</div></div> |
| <div class="ttc" id="aubpf_8h_html_a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8"><div class="ttname"><a href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda03f63951ae56be0eb19aae34d83706f8">BasicJitMode</a></div><div class="ttdeci">@ BasicJitMode</div><div class="ttdef"><b>Definition</b> ubpf.h:107</div></div> |
| <div class="ttc" id="aubpf_8h_html_a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd"><div class="ttname"><a href="ubpf_8h.html#a4be1055c33e64a9f81abf25f8b5ddedda81527be9d9bf3b5e45d8b59a4d1f19fd">ExtendedJitMode</a></div><div class="ttdeci">@ ExtendedJitMode</div><div class="ttdef"><b>Definition</b> ubpf.h:106</div></div> |
| <div class="ttc" id="aubpf_8h_html_a53971fe3966198c6fec238d81d94bfe8"><div class="ttname"><a href="ubpf_8h.html#a53971fe3966198c6fec238d81d94bfe8">as_external_function_t</a></div><div class="ttdeci">external_function_t as_external_function_t(void *f)</div><div class="ttdoc">Cast an external function to external_function_t.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a626fc733422de6db211fa33fe1f19727"><div class="ttname"><a href="ubpf_8h.html#a626fc733422de6db211fa33fe1f19727">ubpf_create</a></div><div class="ttdeci">struct ubpf_vm * ubpf_create(void)</div><div class="ttdoc">Create a new uBPF VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a6334115c4408267ec35087ade6128fa0"><div class="ttname"><a href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf_jit_fn</a></div><div class="ttdeci">uint64_t(* ubpf_jit_fn)(void *mem, size_t mem_len)</div><div class="ttdoc">Opaque type for a uBPF JIT compiled function.</div><div class="ttdef"><b>Definition</b> ubpf.h:79</div></div> |
| <div class="ttc" id="aubpf_8h_html_a64bd2f640f675e3eeff48ea52583d699"><div class="ttname"><a href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699">ubpf_bounds_check</a></div><div class="ttdeci">bool(* ubpf_bounds_check)(void *context, uint64_t addr, uint64_t size)</div><div class="ttdoc">Function that is called by the VM to check if a memory access is within bounds.</div><div class="ttdef"><b>Definition</b> ubpf.h:532</div></div> |
| <div class="ttc" id="aubpf_8h_html_a67b901bf6d169b6b28f818f15bd17cba"><div class="ttname"><a href="ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba">ubpf_compile</a></div><div class="ttdeci">ubpf_jit_fn ubpf_compile(struct ubpf_vm *vm, char **errmsg)</div><div class="ttdoc">Compile a BPF program in the VM to native code.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a6ce8c1133902da4629c53aa82c159611"><div class="ttname"><a href="ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611">ubpf_register_data_relocation</a></div><div class="ttdeci">int ubpf_register_data_relocation(struct ubpf_vm *vm, void *user_context, ubpf_data_relocation relocation)</div><div class="ttdoc">Set a relocation function for the VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a6ded3ae17d5879d7c19f32fa52cbbe26"><div class="ttname"><a href="ubpf_8h.html#a6ded3ae17d5879d7c19f32fa52cbbe26">ubpf_exec_ex</a></div><div class="ttdeci">int ubpf_exec_ex(const struct ubpf_vm *vm, void *mem, size_t mem_len, uint64_t *bpf_return_value, uint8_t *stack, size_t stack_len)</div></div> |
| <div class="ttc" id="aubpf_8h_html_a70fb644d080e8448c1db17bb99858391"><div class="ttname"><a href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391">ubpf_data_relocation</a></div><div class="ttdeci">uint64_t(* ubpf_data_relocation)(void *user_context, const uint8_t *data, uint64_t data_size, const char *symbol_name, uint64_t symbol_offset, uint64_t symbol_size)</div><div class="ttdoc">Data relocation function that is called by the VM when it encounters a R_BPF_64_64 relocation in the ...</div><div class="ttdef"><b>Definition</b> ubpf.h:505</div></div> |
| <div class="ttc" id="aubpf_8h_html_a80938918080712ac0667359fd163f1a5"><div class="ttname"><a href="ubpf_8h.html#a80938918080712ac0667359fd163f1a5">ubpf_toggle_bounds_check</a></div><div class="ttdeci">bool ubpf_toggle_bounds_check(struct ubpf_vm *vm, bool enable)</div><div class="ttdoc">Enable / disable bounds_check. Bounds check is enabled by default, but it may be too restrictive.</div></div> |
| <div class="ttc" id="aubpf_8h_html_a8d32748c100c98d69dba8dcf0e9d4d0d"><div class="ttname"><a href="ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d">ubpf_load</a></div><div class="ttdeci">int ubpf_load(struct ubpf_vm *vm, const void *code, uint32_t code_len, char **errmsg)</div><div class="ttdoc">Load code into a VM. This must be done before calling ubpf_exec or ubpf_compile and after registering...</div></div> |
| <div class="ttc" id="aubpf_8h_html_a924a4a1a3e782846945d6adbabbcbb9c"><div class="ttname"><a href="ubpf_8h.html#a924a4a1a3e782846945d6adbabbcbb9c">external_function_validate_t</a></div><div class="ttdeci">bool(* external_function_validate_t)(unsigned int index, const struct ubpf_vm *vm)</div><div class="ttdoc">The type of an external helper validation function.</div><div class="ttdef"><b>Definition</b> ubpf.h:193</div></div> |
| <div class="ttc" id="aubpf_8h_html_a96cdff7433769540c61a1cf41a0c241a"><div class="ttname"><a href="ubpf_8h.html#a96cdff7433769540c61a1cf41a0c241a">ubpf_set_jit_code_size</a></div><div class="ttdeci">int ubpf_set_jit_code_size(struct ubpf_vm *vm, size_t code_size)</div><div class="ttdoc">Set a size for the buffer allocated to machine code generated during JIT compilation....</div></div> |
| <div class="ttc" id="aubpf_8h_html_a97c06ae6f43ae6e0cbca64ac1e70bc30"><div class="ttname"><a href="ubpf_8h.html#a97c06ae6f43ae6e0cbca64ac1e70bc30">external_function_t</a></div><div class="ttdeci">uint64_t(* external_function_t)(uint64_t p0, uint64_t p1, uint64_t p2, uint64_t p3, uint64_t p4)</div><div class="ttdoc">The type of an external helper function.</div><div class="ttdef"><b>Definition</b> ubpf.h:152</div></div> |
| <div class="ttc" id="aubpf_8h_html_aa2604f93223a8f076b503ba144a6b1ce"><div class="ttname"><a href="ubpf_8h.html#aa2604f93223a8f076b503ba144a6b1ce">ubpf_copy_jit</a></div><div class="ttdeci">ubpf_jit_fn ubpf_copy_jit(struct ubpf_vm *vm, void *buffer, size_t size, char **errmsg)</div><div class="ttdoc">Copy the JIT'd program code to the given buffer.</div></div> |
| <div class="ttc" id="aubpf_8h_html_aa27c1899a4e7e8d19d473111849d1a01"><div class="ttname"><a href="ubpf_8h.html#aa27c1899a4e7e8d19d473111849d1a01">ubpf_get_registers</a></div><div class="ttdeci">uint64_t * ubpf_get_registers(const struct ubpf_vm *vm)</div><div class="ttdoc">Retrieve the storage location for the BPF registers in the VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_aa819644ac2adf81271cf703f9eb5614b"><div class="ttname"><a href="ubpf_8h.html#aa819644ac2adf81271cf703f9eb5614b">external_function_dispatcher_t</a></div><div class="ttdeci">uint64_t(* external_function_dispatcher_t)(uint64_t, uint64_t, uint64_t, uint64_t, uint64_t, unsigned int index, void *cookie)</div><div class="ttdoc">The type of an external helper dispatcher function.</div><div class="ttdef"><b>Definition</b> ubpf.h:187</div></div> |
| <div class="ttc" id="aubpf_8h_html_aacb195bc0c95663214fe205613ff1c9a"><div class="ttname"><a href="ubpf_8h.html#aacb195bc0c95663214fe205613ff1c9a">ubpf_register_stack_usage_calculator</a></div><div class="ttdeci">int ubpf_register_stack_usage_calculator(struct ubpf_vm *vm, stack_usage_calculator_t calculator, void *cookie)</div><div class="ttdoc">Register a function that will be called during eBPF program validation to determine stack usage for a...</div></div> |
| <div class="ttc" id="aubpf_8h_html_aae07506453000ed9fc787a27fa3b9f9e"><div class="ttname"><a href="ubpf_8h.html#aae07506453000ed9fc787a27fa3b9f9e">ubpf_register_debug_fn</a></div><div class="ttdeci">int ubpf_register_debug_fn(struct ubpf_vm *vm, void *context, ubpf_debug_fn debug_function)</div><div class="ttdoc">Add option to invoke a debug function before each instruction. Note: This only applies to the interpr...</div></div> |
| <div class="ttc" id="aubpf_8h_html_ab34e26c0a46366345df354ce992448c4"><div class="ttname"><a href="ubpf_8h.html#ab34e26c0a46366345df354ce992448c4">ubpf_translate</a></div><div class="ttdeci">int ubpf_translate(struct ubpf_vm *vm, uint8_t *buffer, size_t *size, char **errmsg)</div><div class="ttdoc">Translate the eBPF byte code to machine code.</div></div> |
| <div class="ttc" id="aubpf_8h_html_adfaef65d4add64487f09c0bd1d0a08df"><div class="ttname"><a href="ubpf_8h.html#adfaef65d4add64487f09c0bd1d0a08df">ubpf_set_instruction_limit</a></div><div class="ttdeci">int ubpf_set_instruction_limit(struct ubpf_vm *vm, uint32_t limit, uint32_t *previous_limit)</div><div class="ttdoc">Set the instruction limit for the VM. This is the maximum number of instructions that a program may e...</div></div> |
| <div class="ttc" id="aubpf_8h_html_ae69dfc8e94c60e15a5db25fb6316274f"><div class="ttname"><a href="ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f">ubpf_destroy</a></div><div class="ttdeci">void ubpf_destroy(struct ubpf_vm *vm)</div><div class="ttdoc">Free a uBPF VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_ae7e25aeeb15d5dc04a58f99239c4774c"><div class="ttname"><a href="ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c">ubpf_set_error_print</a></div><div class="ttdeci">void ubpf_set_error_print(struct ubpf_vm *vm, int(*error_printf)(FILE *stream, const char *format,...))</div><div class="ttdoc">Set the function to be invoked if the program hits a fatal error.</div></div> |
| <div class="ttc" id="aubpf_8h_html_ae95b334d7eeb18072da3b9f4eeb66c25"><div class="ttname"><a href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25">ubpf_unload_code</a></div><div class="ttdeci">void ubpf_unload_code(struct ubpf_vm *vm)</div><div class="ttdoc">Unload code from a VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_aeb0990b88e11d2a0ba89fbaf8086cc0f"><div class="ttname"><a href="ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f">ubpf_set_registers</a></div><div class="ttdeci">void ubpf_set_registers(struct ubpf_vm *vm, uint64_t *regs)</div><div class="ttdoc">Override the storage location for the BPF registers in the VM.</div></div> |
| <div class="ttc" id="aubpf_8h_html_aebce576f96f17df34a30029636515fcc"><div class="ttname"><a href="ubpf_8h.html#aebce576f96f17df34a30029636515fcc">ubpf_debug_fn</a></div><div class="ttdeci">void(* ubpf_debug_fn)(void *context, int program_counter, const uint64_t registers[16], const uint8_t *stack_start, size_t stack_length, uint64_t register_mask, const uint8_t *stack_mask_start)</div><div class="ttdoc">A function to invoke before each instruction.</div><div class="ttdef"><b>Definition</b> ubpf.h:603</div></div> |
| <div class="ttc" id="aubpf_8h_html_afb2b46e62e54e7e8b81303def1014eb0"><div class="ttname"><a href="ubpf_8h.html#afb2b46e62e54e7e8b81303def1014eb0">ubpf_translate_ex</a></div><div class="ttdeci">int ubpf_translate_ex(struct ubpf_vm *vm, uint8_t *buffer, size_t *size, char **errmsg, enum JitMode jit_mode)</div><div class="ttdoc">Translate the eBPF byte code to machine code.</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
