mirror of
https://github.com/status-im/evmc.git
synced 2025-02-22 07:58:19 +00:00
93 lines
17 KiB
HTML
93 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EVMC: include/evmc/loader.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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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">EVMC
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('loader_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">loader.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="loader_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">/* EVMC: Ethereum Client-VM Connector API.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2018-2019 The EVMC Authors.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Licensed under the Apache License, Version 2.0.</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> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#if __cplusplus</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="group__loader.html#ga6f2571d256d3a78cd57b57b9db4a3d22"> 22</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structevmc__vm.html">evmc_vm</a>* (*evmc_create_fn)(void);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="group__loader.html#gadf193ed1d2d7e9053e9c592fc201bd7d"> 25</a></span> <span class="keyword">enum</span> <a class="code" href="group__loader.html#gadf193ed1d2d7e9053e9c592fc201bd7d">evmc_loader_error_code</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da0cead101d164fef2ac74efd4d6e1ae6d"> 28</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da0cead101d164fef2ac74efd4d6e1ae6d">EVMC_LOADER_SUCCESS</a> = 0,</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da199bb0c460fa6263b26badcc6f6e65fb"> 31</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da199bb0c460fa6263b26badcc6f6e65fb">EVMC_LOADER_CANNOT_OPEN</a> = 1,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da397b783d11709ec470bf5782c377deb2"> 34</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da397b783d11709ec470bf5782c377deb2">EVMC_LOADER_SYMBOL_NOT_FOUND</a> = 2,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da36c6ba4f96cdd1b5407aa0f26a9aa379"> 37</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da36c6ba4f96cdd1b5407aa0f26a9aa379">EVMC_LOADER_INVALID_ARGUMENT</a> = 3,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da504de7833560037be4d2c620345767f5"> 40</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da504de7833560037be4d2c620345767f5">EVMC_LOADER_VM_CREATION_FAILURE</a> = 4,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da0d4eb3a48d3f8c500b96f43e1aa7c458"> 43</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da0d4eb3a48d3f8c500b96f43e1aa7c458">EVMC_LOADER_ABI_VERSION_MISMATCH</a> = 5,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da53b3d46623f93646389aaf65d977aff2"> 46</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da53b3d46623f93646389aaf65d977aff2">EVMC_LOADER_INVALID_OPTION_NAME</a> = 6,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7dad2625a5c71f0c585cf0493c47c805e1b"> 49</a></span>  <a class="code" href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7dad2625a5c71f0c585cf0493c47c805e1b">EVMC_LOADER_INVALID_OPTION_VALUE</a> = 7</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <a class="code" href="group__loader.html#ga6f2571d256d3a78cd57b57b9db4a3d22">evmc_create_fn</a> <a class="code" href="group__loader.html#gabcf5733eb4dd80c1ce060aec9ed60600">evmc_load</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename, <span class="keyword">enum</span> <a class="code" href="group__loader.html#gadf193ed1d2d7e9053e9c592fc201bd7d">evmc_loader_error_code</a>* error_code);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">struct </span><a class="code" href="structevmc__vm.html">evmc_vm</a>* <a class="code" href="group__loader.html#gaa74216a5d639e886fd1f1142e893acf6">evmc_load_and_create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename, <span class="keyword">enum</span> <a class="code" href="group__loader.html#gadf193ed1d2d7e9053e9c592fc201bd7d">evmc_loader_error_code</a>* error_code);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">struct </span><a class="code" href="structevmc__vm.html">evmc_vm</a>* <a class="code" href="group__loader.html#gabd3a005d5ac0ca5230e71df1b1940f9c">evmc_load_and_configure</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* config,</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">enum</span> <a class="code" href="group__loader.html#gadf193ed1d2d7e9053e9c592fc201bd7d">evmc_loader_error_code</a>* error_code);</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__loader.html#ga1b36106eb4b0d1c06580071a85225cf0">evmc_last_error_msg</a>();</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#if __cplusplus</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> }</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="ttc" id="group__loader_html_gabd3a005d5ac0ca5230e71df1b1940f9c"><div class="ttname"><a href="group__loader.html#gabd3a005d5ac0ca5230e71df1b1940f9c">evmc_load_and_configure</a></div><div class="ttdeci">struct evmc_vm * evmc_load_and_configure(const char *config, enum evmc_loader_error_code *error_code)</div><div class="ttdoc">Dynamically loads the EVMC module, then creates and configures the VM instance. </div></div>
|
|
<div class="ttc" id="group__loader_html_ga1b36106eb4b0d1c06580071a85225cf0"><div class="ttname"><a href="group__loader.html#ga1b36106eb4b0d1c06580071a85225cf0">evmc_last_error_msg</a></div><div class="ttdeci">const char * evmc_last_error_msg()</div><div class="ttdoc">Returns the human-readable message describing the most recent error that occurred in EVMC loading sin...</div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da53b3d46623f93646389aaf65d977aff2"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da53b3d46623f93646389aaf65d977aff2">EVMC_LOADER_INVALID_OPTION_NAME</a></div><div class="ttdoc">The VM option is invalid. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00046">loader.h:46</a></div></div>
|
|
<div class="ttc" id="group__loader_html_ga6f2571d256d3a78cd57b57b9db4a3d22"><div class="ttname"><a href="group__loader.html#ga6f2571d256d3a78cd57b57b9db4a3d22">evmc_create_fn</a></div><div class="ttdeci">struct evmc_vm *(* evmc_create_fn)(void)</div><div class="ttdoc">The function pointer type for EVMC create functions. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00022">loader.h:22</a></div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da0cead101d164fef2ac74efd4d6e1ae6d"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da0cead101d164fef2ac74efd4d6e1ae6d">EVMC_LOADER_SUCCESS</a></div><div class="ttdoc">The loader succeeded. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00028">loader.h:28</a></div></div>
|
|
<div class="ttc" id="group__loader_html_gaa74216a5d639e886fd1f1142e893acf6"><div class="ttname"><a href="group__loader.html#gaa74216a5d639e886fd1f1142e893acf6">evmc_load_and_create</a></div><div class="ttdeci">struct evmc_vm * evmc_load_and_create(const char *filename, enum evmc_loader_error_code *error_code)</div><div class="ttdoc">Dynamically loads the EVMC module and creates the VM instance. </div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7dad2625a5c71f0c585cf0493c47c805e1b"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7dad2625a5c71f0c585cf0493c47c805e1b">EVMC_LOADER_INVALID_OPTION_VALUE</a></div><div class="ttdoc">The VM option value is invalid. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00049">loader.h:49</a></div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da36c6ba4f96cdd1b5407aa0f26a9aa379"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da36c6ba4f96cdd1b5407aa0f26a9aa379">EVMC_LOADER_INVALID_ARGUMENT</a></div><div class="ttdoc">The invalid argument value provided. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00037">loader.h:37</a></div></div>
|
|
<div class="ttc" id="structevmc__vm_html"><div class="ttname"><a href="structevmc__vm.html">evmc_vm</a></div><div class="ttdoc">The VM instance. </div><div class="ttdef"><b>Definition:</b> <a href="evmc_8h_source.html#l00855">evmc.h:855</a></div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da504de7833560037be4d2c620345767f5"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da504de7833560037be4d2c620345767f5">EVMC_LOADER_VM_CREATION_FAILURE</a></div><div class="ttdoc">The creation of a VM instance has failed. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00040">loader.h:40</a></div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da199bb0c460fa6263b26badcc6f6e65fb"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da199bb0c460fa6263b26badcc6f6e65fb">EVMC_LOADER_CANNOT_OPEN</a></div><div class="ttdoc">The loader cannot open the given file name. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00031">loader.h:31</a></div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da397b783d11709ec470bf5782c377deb2"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da397b783d11709ec470bf5782c377deb2">EVMC_LOADER_SYMBOL_NOT_FOUND</a></div><div class="ttdoc">The VM create function not found. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00034">loader.h:34</a></div></div>
|
|
<div class="ttc" id="group__loader_html_gabcf5733eb4dd80c1ce060aec9ed60600"><div class="ttname"><a href="group__loader.html#gabcf5733eb4dd80c1ce060aec9ed60600">evmc_load</a></div><div class="ttdeci">evmc_create_fn evmc_load(const char *filename, enum evmc_loader_error_code *error_code)</div><div class="ttdoc">Dynamically loads the EVMC module with a VM implementation. </div></div>
|
|
<div class="ttc" id="group__loader_html_ggadf193ed1d2d7e9053e9c592fc201bd7da0d4eb3a48d3f8c500b96f43e1aa7c458"><div class="ttname"><a href="group__loader.html#ggadf193ed1d2d7e9053e9c592fc201bd7da0d4eb3a48d3f8c500b96f43e1aa7c458">EVMC_LOADER_ABI_VERSION_MISMATCH</a></div><div class="ttdoc">The ABI version of the VM instance has mismatched. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00043">loader.h:43</a></div></div>
|
|
<div class="ttc" id="group__loader_html_gadf193ed1d2d7e9053e9c592fc201bd7d"><div class="ttname"><a href="group__loader.html#gadf193ed1d2d7e9053e9c592fc201bd7d">evmc_loader_error_code</a></div><div class="ttdeci">evmc_loader_error_code</div><div class="ttdoc">Error codes for the EVMC loader. </div><div class="ttdef"><b>Definition:</b> <a href="loader_8h_source.html#l00025">loader.h:25</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_5298d49f5985e350bcac49a99c9a871c.html">evmc</a></li><li class="navelem"><a class="el" href="loader_8h.html">loader.h</a></li>
|
|
<li class="footer">Generated on Tue Jan 7 2020 15:35:10 for EVMC by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|