| <!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: 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 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&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&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> |
| <!-- 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 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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright (c) 2015 Big Switch Networks, Inc</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// SPDX-License-Identifier: Apache-2.0</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright 2015 Big Switch Networks, Inc</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div> |
| <div class="line"><a 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 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 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 name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div> |
| <div class="line"><a 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 name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> |
| <div class="line"><a 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef UBPF_H</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define UBPF_H</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <ubpf_config.h></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <stdio.h></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <stdint.h></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <stddef.h></span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <stdbool.h></span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#if !defined(UBPF_MAX_INSTS)</span></div> |
| <div class="line"><a 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 name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#if !defined(UBPF_STACK_SIZE)</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12"> 46</a></span> <span class="preprocessor">#define UBPF_STACK_SIZE 512</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#if !defined(UBPF_MAX_CALL_DEPTH)</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8"> 53</a></span> <span class="preprocessor">#define UBPF_MAX_CALL_DEPTH 10</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">struct </span>ubpf_vm;</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0"> 64</a></span>  <span class="keyword">typedef</span> uint64_t (*<a class="code" 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 name="l00065"></a><span class="lineno"> 65</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">struct </span>ubpf_vm*</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a845988047e3c2fe9713e2f8a404d0751"> 72</a></span>  <a class="code" href="ubpf_8h.html#a845988047e3c2fe9713e2f8a404d0751">ubpf_create</a>(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span></div> |
| <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f"> 80</a></span>  <a class="code" href="ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f">ubpf_destroy</a>(<span class="keyword">struct</span> ubpf_vm* vm);</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span></div> |
| <div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a80938918080712ac0667359fd163f1a5"> 90</a></span>  <a class="code" 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 name="l00091"></a><span class="lineno"> 91</span>  </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span></div> |
| <div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c"> 99</a></span>  <a class="code" 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 name="l00100"></a><span class="lineno"> 100</span>  </div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="ubpf_8h.html#af1849510fba48e825d754eeeb63367ac"> 115</a></span>  <a class="code" href="ubpf_8h.html#af1849510fba48e825d754eeeb63367ac">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, <span class="keywordtype">void</span>* fn);</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d"> 133</a></span>  <a class="code" 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 name="l00134"></a><span class="lineno"> 134</span>  </div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * Unload code from a VM</span></div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</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 name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * first time those functions are called. It clears the VM instructions to</span></div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * allow for new code to be loaded.</span></div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * It does not unregister any external functions.</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">void</span></div> |
| <div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25"> 153</a></span>  <a class="code" href="ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25">ubpf_unload_code</a>(<span class="keyword">struct</span> ubpf_vm* vm);</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#if defined(UBPF_HAS_ELF_H)</span></div> |
| <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</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 name="l00178"></a><span class="lineno"> 178</span>  </div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</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 name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  </div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95"> 219</a></span>  <a class="code" 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 name="l00220"></a><span class="lineno"> 220</span>  </div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <a class="code" href="ubpf_8h.html#a6334115c4408267ec35087ade6128fa0">ubpf_jit_fn</a></div> |
| <div class="line"><a name="l00232"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba"> 232</a></span>  <a class="code" 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 name="l00233"></a><span class="lineno"> 233</span>  </div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="comment">/*</span></div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * Translate the eBPF byte code to x64 machine code, store in buffer, and</span></div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * write the resulting count of bytes to size.</span></div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * This must be called after registering all functions.</span></div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * Returns 0 on success, -1 on error. In case of error a pointer to the error</span></div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * message will be stored in 'errmsg' and should be freed by the caller.</span></div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  </div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00258"></a><span class="lineno"><a class="line" href="ubpf_8h.html#ab34e26c0a46366345df354ce992448c4"> 258</a></span>  <a class="code" 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 name="l00259"></a><span class="lineno"> 259</span>  </div> |
| <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00272"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3"> 272</a></span>  <a class="code" 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 name="l00273"></a><span class="lineno"> 273</span>  </div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keywordtype">void</span></div> |
| <div class="line"><a name="l00281"></a><span class="lineno"><a class="line" href="ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f"> 281</a></span>  <a class="code" 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 name="l00282"></a><span class="lineno"> 282</span>  </div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  uint64_t*</div> |
| <div class="line"><a name="l00290"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4"> 290</a></span>  <a class="code" href="ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4">ubpf_get_registers</a>(<span class="keyword">const</span> <span class="keyword">struct</span> ubpf_vm* vm);</div> |
| <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  </div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00301"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701"> 301</a></span>  <a class="code" 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 name="l00302"></a><span class="lineno"> 302</span>  </div> |
| <div class="line"><a name="l00315"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391"> 315</a></span>  <span class="keyword">typedef</span> uint64_t (*<a class="code" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391">ubpf_data_relocation</a>)(</div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="keywordtype">void</span>* user_context,</div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  <span class="keyword">const</span> uint8_t* data,</div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  uint64_t data_size,</div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* symbol_name,</div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  uint64_t symbol_offset,</div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  uint64_t symbol_size);</div> |
| <div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  </div> |
| <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00331"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611"> 331</a></span>  <a class="code" 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" href="ubpf_8h.html#a70fb644d080e8448c1db17bb99858391">ubpf_data_relocation</a> relocation);</div> |
| <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  </div> |
| <div class="line"><a name="l00333"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699"> 333</a></span>  <span class="keyword">typedef</span> bool (*<a class="code" 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 name="l00334"></a><span class="lineno"> 334</span>  </div> |
| <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  <span class="keywordtype">int</span></div> |
| <div class="line"><a name="l00345"></a><span class="lineno"><a class="line" href="ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03"> 345</a></span>  <a class="code" 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" href="ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699">ubpf_bounds_check</a> bounds_check);</div> |
| <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  </div> |
| <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> }</div> |
| <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  </div> |
| <div class="line"><a name="l00351"></a><span class="lineno"> 351</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_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_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_a2e649a921bff795712a97d3ad849f6e4"><div class="ttname"><a href="ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4">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_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_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:64</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="ttdef"><b>Definition:</b> ubpf.h:333</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_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:315</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_a845988047e3c2fe9713e2f8a404d0751"><div class="ttname"><a href="ubpf_8h.html#a845988047e3c2fe9713e2f8a404d0751">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_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_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 x64 machine code.</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_af1849510fba48e825d754eeeb63367ac"><div class="ttname"><a href="ubpf_8h.html#af1849510fba48e825d754eeeb63367ac">ubpf_register</a></div><div class="ttdeci">int ubpf_register(struct ubpf_vm *vm, unsigned int index, const char *name, void *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><!-- 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.1 |
| </small></address> |
| </body> |
| </html> |
