This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
<!DOCTYPE html>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>State (infer.InferModules.State)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc %%VERSION%%"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">InferModules</a>» State</nav><h1>Module <code>InferModules.State</code></h1></header><aside><p>State of symbolic execution</p></aside><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code></dt><dd><p>Internal state</p></dd></dl><dl><dtclass="spec value"id="val-add_diverging_states"><ahref="#val-add_diverging_states"class="anchor"></a><code><spanclass="keyword">val</span> add_diverging_states : <ahref="../Paths/PathSet/index.html#type-t">Paths.PathSet.t</a><span>-></span> unit</code></dt><dd><p>Add diverging states</p></dd></dl><dl><dtclass="spec value"id="val-get_diverging_states_node"><ahref="#val-get_diverging_states_node"class="anchor"></a><code><spanclass="keyword">val</span> get_diverging_states_node : unit <span>-></span><ahref="../Paths/PathSet/index.html#type-t">Paths.PathSet.t</a></code></dt><dd><p>Get the diverging states for the node</p></dd></dl><dl><dtclass="spec value"id="val-get_diverging_states_proc"><ahref="#val-get_diverging_states_proc"class="anchor"></a><code><spanclass="keyword">val</span> get_diverging_states_proc : unit <span>-></span><ahref="../Paths/PathSet/index.html#type-t">Paths.PathSet.t</a></code></dt><dd><p>Get the diverging states for the procedure</p></dd></dl><dl><dtclass="spec value"id="val-get_inst_update"><ahref="#val-get_inst_update"class="anchor"></a><code><spanclass="keyword">val</span> get_inst_update : <ahref="../../../InferIR/InferIR/PredSymb/index.html#type-path_pos">InferIR.PredSymb.path_pos</a><span>-></span><ahref="../../../InferIR/InferIR/Sil/index.html#type-inst">InferIR.Sil.inst</a></code></dt><dd><p>Get update instrumentation for the current loc</p></dd></dl><dl><dtclass="spec value"id="val-get_instr"><ahref="#val-get_instr"class="anchor"></a><code><spanclass="keyword">val</span> get_instr : unit <span>-></span><span><ahref="../../../InferIR/InferIR/Sil/index.html#type-instr">InferIR.Sil.instr</a> option</span></code></dt><dd><p>Get last instruction seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_loc_exn"><ahref="#val-get_loc_exn"class="anchor"></a><code><spanclass="keyword">val</span> get_loc_exn : unit <span>-></span><ahref="../../../InferBase/InferBase/Location/index.html#type-t">InferBase.Location.t</a></code></dt><dd><p>Get last location seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_loc"><ahref="#val-get_loc"class="anchor"></a><code><spanclass="keyword">val</span> get_loc : unit <span>-></span><span><ahref="../../../InferBase/InferBase/Location/index.html#type-t">InferBase.Location.t</a> option</span></code></dt><dd><p>Get last location seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_loc_trace"><ahref="#val-get_loc_trace"class="anchor"></a><code><spanclass="keyword">val</span> get_loc_trace : unit <span>-></span><ahref="../../../InferIR/InferIR/Errlog/index.html#type-loc_trace">InferIR.Errlog.loc_trace</a></code></dt><dd><p>Get the location trace of the last path seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_node_exn"><ahref="#val-get_node_exn"class="anchor"></a><code><spanclass="keyword">val</span> get_node_exn : unit <span>-></span><ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a></code></dt><dd><p>Get last node seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_node"><ahref="#val-get_node"class="anchor"></a><code><spanclass="keyword">val</span> get_node : unit <span>-></span><span><ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a> option</span></code></dt><dd><p>Get last node seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_normalized_pre"><ahref="#val-get_normalized_pre"class="anchor"></a><code><spanclass="keyword">val</span> get_normalized_pre : <span>(<ahref="../../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span><span><ahref="../Prop/index.html#type-normal">Prop.normal</a><ahref="../Prop/index.html#type-t">Prop.t</a></span><span>-></span><span><ahref="../Prop/index.html#type-normal">Prop.normal</a><ahref="../Prop/index.html#type-t">Prop.t</a></span>)</span><span>-></span><span><span><ahref="../Prop/index.html#type-normal">Prop.normal</a><ahref="../Prop/index.html#type-t">Prop.t</a></span> option</span></code></dt><dd><p>return the normalized precondition extracted form the last prop seen, if any the abstraction function is a parameter to get around module dependencies</p></dd></dl><dl><dtclass="spec value"id="val-get_path"><ahref="#val-get_path"class="anchor"></a><code><spanclass="keyword">val</span> get_path : unit <span>-></span><ahref="../Paths/Path/index.html#type-t">Paths.Path.t</a> * <span><ahref="../../../InferIR/InferIR/PredSymb/index.html#type-path_pos">InferIR.PredSymb.path_pos</a> option</span></code></dt><dd><p>Get last path seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_path_pos"><ahref="#val-get_path_pos"class="anchor"></a><code><spanclass="keyword">val</span> get_path_pos : unit <span>-></span><ahref="../../../InferIR/InferIR/PredSymb/index.html#type-path_pos">InferIR.PredSymb.path_pos</a></code></dt><dd><p>Get the last path position seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_prop_tenv_pdesc"><ahref="#val-get_prop_tenv_pdesc"class="anchor"></a><code><spanclass="keyword">val</span> get_prop_tenv_pdesc : unit <span>-></span><span><span>(<span><ahref="../Prop/index.html#type-normal">Prop.normal</a><ahref="../Prop/index.html#type-t">Prop.t</a></span> * <ahref="../../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a> * <ahref="../../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a>)</span> option</span></code></dt><dd><p>Get last last prop,tenv,pdesc seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-get_session"><ahref="#val-get_session"class="anchor"></a><code><spanclass="keyword">val</span> get_session : unit <span>-></span> int</code></dt><dd><p>Get last session seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-mark_execution_end"><ahref="#val-mark_execution_end"class="anchor"></a><code><spanclass="keyword">val</span> mark_execution_end : <ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a><span>-></span> unit</code></dt><dd><p>Mark the end of symbolic execution of a node</p></dd></dl><dl><dtclass="spec value"id="val-mark_execution_start"><ahref="#val-mark_execution_start"class="anchor"></a><code><spanclass="keyword">val</span> mark_execution_start : <ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a><span>-></span> unit</code></dt><dd><p>Mark the start of symbolic execution of a node</p></dd></dl><dl><dtclass="spec value"id="val-mark_instr_fail"><ahref="#val-mark_instr_fail"class="anchor"></a><code><spanclass="keyword">val</span> mark_instr_fail : exn <span>-></span> unit</code></dt><dd><p>Mark that the execution of the current instruction failed</p></dd></dl><dl><dtclass="spec value"id="val-mark_instr_ok"><ahref="#val-mark_instr_ok"class="anchor"></a><code><spanclass="keyword">val</span> mark_instr_ok : unit <span>-></span> unit</code></dt><dd><p>Mark that the execution of the current instruction was OK</p></dd></dl><dl><dtclass="spec value"id="val-mk_find_duplicate_nodes"><ahref="#val-mk_find_duplicate_nodes"class="anchor"></a><code><spanclass="keyword">val</span> mk_find_duplicate_nodes : <ahref="../../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a><span>-></span><ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a><span>-></span><ahref="../../../InferIR/InferIR__Procdesc/index.html#module-NodeSet">InferIR.Procdesc.NodeSet</a>.t</code></dt><dd><p>Create a function to find duplicate nodes. A node is a duplicate of another one if they have the same kind and location and normalized (w.r.t. renaming of let - bound ids) list of instructions.</p></dd></dl><dl><dtclass="spec type"id="type-log_issue"><ahref="#type-log_issue"class="anchor"></a><code><spanclass="keyword">type</span> log_issue</code><code> = <ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><span>?⁠node:<ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a></span><span>-></span><span>?⁠loc:<ahref="../../../InferBase/InferBase/Location/index.html#type-t">InferBase.Location.t</a></span><span>-></span><span>?⁠ltr:<ahref="../../../InferIR/InferIR/Errlog/index.html#type-loc_trace">InferIR.Errlog.loc_trace</a></span><span>-></span> exn <span>-></span> unit</code></dt></dl><dl><dtclass="spec value"id="val-process_execution_failures"><ahref="#val-process_execution_failures"class="anchor"></a><code><spanclass="keyword">val</span> process_execution_failures : <ahref="index.html#type-log_issue">log_issue</a><span>-></span><ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span> unit</code></dt><dd><p>Process the failures during symbolic execution of a procedure</p></dd></dl><dl><dtclass="spec value"id="val-reset"><ahref="#val-reset"class="anchor"></a><code><spanclass="keyword">val</span> reset : unit <span>-></span> unit</code></dt><dd><p>Reset all the global data.</p></dd></dl><dl><dtclass="spec value"id="val-reset_diverging_states_node"><ahref="#val-reset_diverging_states_node"class="anchor"></a><code><spanclass="keyword">val</span> reset_diverging_states_node : unit <span>-></span> unit</code></dt><dd><p>Reset the diverging states information for the node</p></dd></dl><dl><dtclass="spec value"id="val-restore_state"><ahref="#val-restore_state"class="anchor"></a><code><spanclass="keyword">val</span> restore_state : <ahref="index.html#type-t">t</a><span>-></span> unit</code></dt><dd><p>Restore the old state.</p></dd></dl><dl><dtclass="spec value"id="val-save_state"><ahref="#val-save_state"class="anchor"></a><code><spanclass="keyword">val</span> save_state : unit <span>-></span><ahref="index.html#type-t">t</a></code></dt><dd><p>Return the old state, and revert the current state to the initial one.</p></dd></dl><dl><dtclass="spec value"id="val-set_instr"><ahref="#val-set_instr"class="anchor"></a><code><spanclass="keyword">val</span> set_instr : <ahref="../../../InferIR/InferIR/Sil/index.html#type-instr">InferIR.Sil.instr</a><span>-></span> unit</code></dt><dd><p>Set last instruction seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-set_node"><ahref="#val-set_node"class="anchor"></a><code><spanclass="keyword">val</span> set_node : <ahref="../../../InferIR/InferIR/Procdesc/Node/index.html#type-t">InferIR.Procdesc.Node.t</a><span>-></span> unit</code></dt><dd><p>Set last node seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-set_path"><ahref="#val-set_path"class="anchor"></a><code><spanclass="keyword">val</span> set_path : <ahref="../Paths/Path/index.html#type-t">Paths.Path.t</a><span>-></span><span><ahref="../../../InferIR/InferIR/PredSymb/index.html#type-path_pos">InferIR.PredSymb.path_pos</a> option</span><span>-></span> unit</code></dt><dd><p>Get last path seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-set_prop_tenv_pdesc"><ahref="#val-set_prop_tenv_pdesc"class="anchor"></a><code><spanclass="keyword">val</span> set_prop_tenv_pdesc : <span><ahref="../Prop/index.html#type-normal">Prop.normal</a><ahref="../Prop/index.html#type-t">Prop.t</a></span><span>-></span><ahref="../../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span><ahref="../../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a><span>-></span> unit</code></dt><dd><p>Set last prop,tenv,pdesc seen in symbolic execution</p></dd></dl><dl><dtclass="spec value"id="val-set_session"><ahref="#val-set_session"class="anchor"></a><code><spanclass="keyword">val</span> set_session : int <span>-></span> unit</code></dt><dd><p>Set last session seen in symbolic execution</p></dd></dl></div></body></html>
