Updated documentation

Signed-off-by: Github Action <ubpf@users.noreply.github.com>

globals.html

@@ -89,6 +89,9 @@
 <li>ubpf_load()
 : <a class="el" href="ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d">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>

globals_defs.html

@@ -62,6 +62,9 @@
 
 <div class="contents">
 &#160;<ul>
+<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>

search/all_1.js

@@ -10,16 +10,17 @@ var searchData=
   ['ubpf_5fget_5fregisters_8',['ubpf_get_registers',['../ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4',1,'ubpf.h']]],
   ['ubpf_5fjit_5ffn_9',['ubpf_jit_fn',['../ubpf_8h.html#a6334115c4408267ec35087ade6128fa0',1,'ubpf.h']]],
   ['ubpf_5fload_10',['ubpf_load',['../ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d',1,'ubpf.h']]],
-  ['ubpf_5fmax_5finsts_11',['UBPF_MAX_INSTS',['../ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f',1,'ubpf.h']]],
-  ['ubpf_5fregister_12',['ubpf_register',['../ubpf_8h.html#af1849510fba48e825d754eeeb63367ac',1,'ubpf.h']]],
-  ['ubpf_5fregister_5fdata_5fbounds_5fcheck_13',['ubpf_register_data_bounds_check',['../ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03',1,'ubpf.h']]],
-  ['ubpf_5fregister_5fdata_5frelocation_14',['ubpf_register_data_relocation',['../ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611',1,'ubpf.h']]],
-  ['ubpf_5fset_5ferror_5fprint_15',['ubpf_set_error_print',['../ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c',1,'ubpf.h']]],
-  ['ubpf_5fset_5fpointer_5fsecret_16',['ubpf_set_pointer_secret',['../ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701',1,'ubpf.h']]],
-  ['ubpf_5fset_5fregisters_17',['ubpf_set_registers',['../ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f',1,'ubpf.h']]],
-  ['ubpf_5fset_5funwind_5ffunction_5findex_18',['ubpf_set_unwind_function_index',['../ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3',1,'ubpf.h']]],
-  ['ubpf_5fstack_5fsize_19',['UBPF_STACK_SIZE',['../ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12',1,'ubpf.h']]],
-  ['ubpf_5ftoggle_5fbounds_5fcheck_20',['ubpf_toggle_bounds_check',['../ubpf_8h.html#a80938918080712ac0667359fd163f1a5',1,'ubpf.h']]],
-  ['ubpf_5ftranslate_21',['ubpf_translate',['../ubpf_8h.html#ab34e26c0a46366345df354ce992448c4',1,'ubpf.h']]],
-  ['ubpf_5funload_5fcode_22',['ubpf_unload_code',['../ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25',1,'ubpf.h']]]
+  ['ubpf_5fmax_5fcall_5fdepth_11',['UBPF_MAX_CALL_DEPTH',['../ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8',1,'ubpf.h']]],
+  ['ubpf_5fmax_5finsts_12',['UBPF_MAX_INSTS',['../ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f',1,'ubpf.h']]],
+  ['ubpf_5fregister_13',['ubpf_register',['../ubpf_8h.html#af1849510fba48e825d754eeeb63367ac',1,'ubpf.h']]],
+  ['ubpf_5fregister_5fdata_5fbounds_5fcheck_14',['ubpf_register_data_bounds_check',['../ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03',1,'ubpf.h']]],
+  ['ubpf_5fregister_5fdata_5frelocation_15',['ubpf_register_data_relocation',['../ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611',1,'ubpf.h']]],
+  ['ubpf_5fset_5ferror_5fprint_16',['ubpf_set_error_print',['../ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c',1,'ubpf.h']]],
+  ['ubpf_5fset_5fpointer_5fsecret_17',['ubpf_set_pointer_secret',['../ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701',1,'ubpf.h']]],
+  ['ubpf_5fset_5fregisters_18',['ubpf_set_registers',['../ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f',1,'ubpf.h']]],
+  ['ubpf_5fset_5funwind_5ffunction_5findex_19',['ubpf_set_unwind_function_index',['../ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3',1,'ubpf.h']]],
+  ['ubpf_5fstack_5fsize_20',['UBPF_STACK_SIZE',['../ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12',1,'ubpf.h']]],
+  ['ubpf_5ftoggle_5fbounds_5fcheck_21',['ubpf_toggle_bounds_check',['../ubpf_8h.html#a80938918080712ac0667359fd163f1a5',1,'ubpf.h']]],
+  ['ubpf_5ftranslate_22',['ubpf_translate',['../ubpf_8h.html#ab34e26c0a46366345df354ce992448c4',1,'ubpf.h']]],
+  ['ubpf_5funload_5fcode_23',['ubpf_unload_code',['../ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25',1,'ubpf.h']]]
 ];

search/defines_0.js

@@ -1,5 +1,6 @@
 var searchData=
 [
-  ['ubpf_5fmax_5finsts_44',['UBPF_MAX_INSTS',['../ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f',1,'ubpf.h']]],
-  ['ubpf_5fstack_5fsize_45',['UBPF_STACK_SIZE',['../ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12',1,'ubpf.h']]]
+  ['ubpf_5fmax_5fcall_5fdepth_45',['UBPF_MAX_CALL_DEPTH',['../ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8',1,'ubpf.h']]],
+  ['ubpf_5fmax_5finsts_46',['UBPF_MAX_INSTS',['../ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f',1,'ubpf.h']]],
+  ['ubpf_5fstack_5fsize_47',['UBPF_STACK_SIZE',['../ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12',1,'ubpf.h']]]
 ];

search/files_0.js

@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['mainpage_2edox_23',['mainpage.dox',['../mainpage_8dox.html',1,'']]]
+  ['mainpage_2edox_24',['mainpage.dox',['../mainpage_8dox.html',1,'']]]
 ];

search/files_1.js

@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['ubpf_2eh_24',['ubpf.h',['../ubpf_8h.html',1,'']]]
+  ['ubpf_2eh_25',['ubpf.h',['../ubpf_8h.html',1,'']]]
 ];

search/functions_0.js

@@ -1,19 +1,19 @@
 var searchData=
 [
-  ['ubpf_5fcompile_25',['ubpf_compile',['../ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba',1,'ubpf.h']]],
-  ['ubpf_5fcreate_26',['ubpf_create',['../ubpf_8h.html#a845988047e3c2fe9713e2f8a404d0751',1,'ubpf.h']]],
-  ['ubpf_5fdestroy_27',['ubpf_destroy',['../ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f',1,'ubpf.h']]],
-  ['ubpf_5fexec_28',['ubpf_exec',['../ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95',1,'ubpf.h']]],
-  ['ubpf_5fget_5fregisters_29',['ubpf_get_registers',['../ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4',1,'ubpf.h']]],
-  ['ubpf_5fload_30',['ubpf_load',['../ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d',1,'ubpf.h']]],
-  ['ubpf_5fregister_31',['ubpf_register',['../ubpf_8h.html#af1849510fba48e825d754eeeb63367ac',1,'ubpf.h']]],
-  ['ubpf_5fregister_5fdata_5fbounds_5fcheck_32',['ubpf_register_data_bounds_check',['../ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03',1,'ubpf.h']]],
-  ['ubpf_5fregister_5fdata_5frelocation_33',['ubpf_register_data_relocation',['../ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611',1,'ubpf.h']]],
-  ['ubpf_5fset_5ferror_5fprint_34',['ubpf_set_error_print',['../ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c',1,'ubpf.h']]],
-  ['ubpf_5fset_5fpointer_5fsecret_35',['ubpf_set_pointer_secret',['../ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701',1,'ubpf.h']]],
-  ['ubpf_5fset_5fregisters_36',['ubpf_set_registers',['../ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f',1,'ubpf.h']]],
-  ['ubpf_5fset_5funwind_5ffunction_5findex_37',['ubpf_set_unwind_function_index',['../ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3',1,'ubpf.h']]],
-  ['ubpf_5ftoggle_5fbounds_5fcheck_38',['ubpf_toggle_bounds_check',['../ubpf_8h.html#a80938918080712ac0667359fd163f1a5',1,'ubpf.h']]],
-  ['ubpf_5ftranslate_39',['ubpf_translate',['../ubpf_8h.html#ab34e26c0a46366345df354ce992448c4',1,'ubpf.h']]],
-  ['ubpf_5funload_5fcode_40',['ubpf_unload_code',['../ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25',1,'ubpf.h']]]
+  ['ubpf_5fcompile_26',['ubpf_compile',['../ubpf_8h.html#a67b901bf6d169b6b28f818f15bd17cba',1,'ubpf.h']]],
+  ['ubpf_5fcreate_27',['ubpf_create',['../ubpf_8h.html#a845988047e3c2fe9713e2f8a404d0751',1,'ubpf.h']]],
+  ['ubpf_5fdestroy_28',['ubpf_destroy',['../ubpf_8h.html#ae69dfc8e94c60e15a5db25fb6316274f',1,'ubpf.h']]],
+  ['ubpf_5fexec_29',['ubpf_exec',['../ubpf_8h.html#a1ce3eb22d45ec43436758a139ffc8c95',1,'ubpf.h']]],
+  ['ubpf_5fget_5fregisters_30',['ubpf_get_registers',['../ubpf_8h.html#a2e649a921bff795712a97d3ad849f6e4',1,'ubpf.h']]],
+  ['ubpf_5fload_31',['ubpf_load',['../ubpf_8h.html#a8d32748c100c98d69dba8dcf0e9d4d0d',1,'ubpf.h']]],
+  ['ubpf_5fregister_32',['ubpf_register',['../ubpf_8h.html#af1849510fba48e825d754eeeb63367ac',1,'ubpf.h']]],
+  ['ubpf_5fregister_5fdata_5fbounds_5fcheck_33',['ubpf_register_data_bounds_check',['../ubpf_8h.html#a286aa9da7688d1327756e967eafc2f03',1,'ubpf.h']]],
+  ['ubpf_5fregister_5fdata_5frelocation_34',['ubpf_register_data_relocation',['../ubpf_8h.html#a6ce8c1133902da4629c53aa82c159611',1,'ubpf.h']]],
+  ['ubpf_5fset_5ferror_5fprint_35',['ubpf_set_error_print',['../ubpf_8h.html#ae7e25aeeb15d5dc04a58f99239c4774c',1,'ubpf.h']]],
+  ['ubpf_5fset_5fpointer_5fsecret_36',['ubpf_set_pointer_secret',['../ubpf_8h.html#a3257e0611c177eeaba7053e2eca92701',1,'ubpf.h']]],
+  ['ubpf_5fset_5fregisters_37',['ubpf_set_registers',['../ubpf_8h.html#aeb0990b88e11d2a0ba89fbaf8086cc0f',1,'ubpf.h']]],
+  ['ubpf_5fset_5funwind_5ffunction_5findex_38',['ubpf_set_unwind_function_index',['../ubpf_8h.html#a0046484ecdb72363d0c5ae710e7b96c3',1,'ubpf.h']]],
+  ['ubpf_5ftoggle_5fbounds_5fcheck_39',['ubpf_toggle_bounds_check',['../ubpf_8h.html#a80938918080712ac0667359fd163f1a5',1,'ubpf.h']]],
+  ['ubpf_5ftranslate_40',['ubpf_translate',['../ubpf_8h.html#ab34e26c0a46366345df354ce992448c4',1,'ubpf.h']]],
+  ['ubpf_5funload_5fcode_41',['ubpf_unload_code',['../ubpf_8h.html#ae95b334d7eeb18072da3b9f4eeb66c25',1,'ubpf.h']]]
 ];

search/typedefs_0.js

@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['ubpf_5fbounds_5fcheck_41',['ubpf_bounds_check',['../ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699',1,'ubpf.h']]],
-  ['ubpf_5fdata_5frelocation_42',['ubpf_data_relocation',['../ubpf_8h.html#a70fb644d080e8448c1db17bb99858391',1,'ubpf.h']]],
-  ['ubpf_5fjit_5ffn_43',['ubpf_jit_fn',['../ubpf_8h.html#a6334115c4408267ec35087ade6128fa0',1,'ubpf.h']]]
+  ['ubpf_5fbounds_5fcheck_42',['ubpf_bounds_check',['../ubpf_8h.html#a64bd2f640f675e3eeff48ea52583d699',1,'ubpf.h']]],
+  ['ubpf_5fdata_5frelocation_43',['ubpf_data_relocation',['../ubpf_8h.html#a70fb644d080e8448c1db17bb99858391',1,'ubpf.h']]],
+  ['ubpf_5fjit_5ffn_44',['ubpf_jit_fn',['../ubpf_8h.html#a6334115c4408267ec35087ade6128fa0',1,'ubpf.h']]]
 ];

ubpf_8h.html

@@ -87,8 +87,11 @@
 <tr class="memdesc:a7b029668bfe717c5d7b33fba3847a00f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default maximum number of instructions that a program can contain.  <a href="ubpf_8h.html#a7b029668bfe717c5d7b33fba3847a00f">More...</a><br /></td></tr>
 <tr class="separator:a7b029668bfe717c5d7b33fba3847a00f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab41a6986b0045cc2e5c84a75d08c7a12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12">UBPF_STACK_SIZE</a>&#160;&#160;&#160;512</td></tr>
-<tr class="memdesc:ab41a6986b0045cc2e5c84a75d08c7a12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default stack size for the VM.  <a href="ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12">More...</a><br /></td></tr>
+<tr class="memdesc:ab41a6986b0045cc2e5c84a75d08c7a12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default stack size for the VM. Must be divisible by 16.  <a href="ubpf_8h.html#ab41a6986b0045cc2e5c84a75d08c7a12">More...</a><br /></td></tr>
 <tr class="separator:ab41a6986b0045cc2e5c84a75d08c7a12"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a23e70b5f29f0296e69a72ec5cfc588d8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8">UBPF_MAX_CALL_DEPTH</a>&#160;&#160;&#160;10</td></tr>
+<tr class="memdesc:a23e70b5f29f0296e69a72ec5cfc588d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default maximum number of nested calls in the VM.  <a href="ubpf_8h.html#a23e70b5f29f0296e69a72ec5cfc588d8">More...</a><br /></td></tr>
+<tr class="separator:a23e70b5f29f0296e69a72ec5cfc588d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 Typedefs</h2></td></tr>
@@ -153,6 +156,22 @@
 <tr class="separator:a286aa9da7688d1327756e967eafc2f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a23e70b5f29f0296e69a72ec5cfc588d8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a23e70b5f29f0296e69a72ec5cfc588d8">&#9670;&nbsp;</a></span>UBPF_MAX_CALL_DEPTH</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define UBPF_MAX_CALL_DEPTH&#160;&#160;&#160;10</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Default maximum number of nested calls in the VM. </p>
+
+</div>
+</div>
 <a id="a7b029668bfe717c5d7b33fba3847a00f"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a7b029668bfe717c5d7b33fba3847a00f">&#9670;&nbsp;</a></span>UBPF_MAX_INSTS</h2>
 
@@ -181,7 +200,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab41a6986b0045cc2e5c84a75
       </table>
 </div><div class="memdoc">
 
-<p>Default stack size for the VM. </p>
+<p>Default stack size for the VM. Must be divisible by 16. </p>
 
 </div>
 </div>