This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.
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>PulseOperations (infer.Pulselib.PulseOperations)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.1"/><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">Pulselib</a>» PulseOperations</nav><h1>Module <code>Pulselib.PulseOperations</code></h1></header><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code><code> = <ahref="../PulseAbductiveDomain/index.html#type-t">PulseDomainInterface.AbductiveDomain.t</a></code></dt><dtclass="spec type"id="type-access_result"><ahref="#type-access_result"class="anchor"></a><code><spanclass="keyword">type</span><span>'a access_result</span></code><code> = <span><span>(<spanclass="type-var">'a</span>,<ahref="../PulseDiagnostic/index.html#type-t">PulseBasicInterface.Diagnostic.t</a> * <ahref="index.html#type-t">t</a>)</span><ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.result</span></code></dt></dl><dl><dtclass="spec value"id="val-ok_continue"><ahref="#val-ok_continue"class="anchor"></a><code><spanclass="keyword">val</span> ok_continue : <ahref="index.html#type-t">t</a><span>-></span><span><span>(<span><ahref="../PulseExecutionDomain/index.html#type-t">PulseDomainInterface.ExecutionDomain.t</a> list</span>,<spanclass="type-var">'a</span>)</span><ahref="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.result</span></code></dt><dtclass="spec value"id="val-check_addr_access"><ahref="#val-check_addr_access"class="anchor"></a><code><spanclass="keyword">val</span> check_addr_access : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>Check that the <code>address</code> is not known to be invalid</p></dd></dl><divclass="spec module"id="module-Closures"><ahref="#module-Closures"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Closures/index.html">Closures</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><dl><dtclass="spec value"id="val-eval"><ahref="#val-eval"class="anchor"></a><code><spanclass="keyword">val</span> eval : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../../IR/Exp/index.html#type-t">IR.Exp.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><span>(<ahref="index.html#type-t">t</a> * <span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span>)</span><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>Use the stack and heap to evaluate the given expression down to an abstract address representing its value.</p><p>Return an error state if it traverses some known invalid address or if the end destination is known to be invalid.</p></dd></dl><dl><dtclass="spec value"id="val-prune"><ahref="#val-prune"class="anchor"></a><code><spanclass="keyword">val</span> prune : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>condition:<ahref="../../IR/Exp/index.html#type-t">IR.Exp.t</a></span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dtclass="spec value"id="val-eval_deref"><ahref="#val-eval_deref"class="anchor"></a><code><spanclass="keyword">val</span> eval_deref : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../../IR/Exp/index.html#type-t">IR.Exp.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><span>(<ahref="index.html#type-t">t</a> * <span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span>)</span><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>Like <code>eval</code> but evaluates <code>*exp</code>.</p></dd></dl><dl><dtclass="spec value"id="val-eval_access"><ahref="#val-eval_access"class="anchor"></a><code><spanclass="keyword">val</span> eval_access : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="../../Pulselib__PulseBaseMemory/index.html#module-Access">Pulselib.PulseDomainInterface.BaseMemory.Access</a>.t <span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><span>(<ahref="index.html#type-t">t</a> * <span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span>)</span><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>Like <code>eval</code> but starts from an address instead of an expression, checks that it is valid, and if so dereferences it according to the access.</p></dd></dl><dl><dtclass="spec value"id="val-havoc_id"><ahref="#val-havoc_id"class="anchor"></a><code><spanclass="keyword">val</span> havoc_id : <ahref="../../IR/Ident/index.html#type-t">IR.Ident.t</a><span>-></span><ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-havoc_field"><ahref="#val-havoc_field"class="anchor"></a><code><spanclass="keyword">val</span> havoc_field : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dtclass="spec value"id="val-realloc_pvar"><ahref="#val-realloc_pvar"class="anchor"></a><code><spanclass="keyword">val</span> realloc_pvar : <ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a><span>-></span><ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-write_id"><ahref="#val-write_id"class="anchor"></a><code><spanclass="keyword">val</span> write_id : <ahref="../../IR/Ident/index.html#type-t">IR.Ident.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-write_field"><ahref="#val-write_field"class="anchor"></a><code><spanclass="keyword">val</span> write_field : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>ref:<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span>obj:<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span></span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>write the edge <code>ref --.field--> obj</code></p></dd></dl><dl><dtclass="spec value"id="val-write_arr_index"><ahref="#val-write_arr_index"class="anchor"></a><code><spanclass="keyword">val</span> write_arr_index : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>ref:<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span></span><span>-></span><span>index:<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a></span><span>-></span><span>obj:<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span></span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>write the edge <code>ref[index]--> obj</code></p></dd></dl><dl><dtclass="spec value"id="val-write_deref"><ahref="#val-write_deref"class="anchor"></a><code><spanclass="keyword">val</span> write_deref : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>ref:<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span></span><span>-></span><span>obj:<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span></span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>write the edge <code>ref --*--> obj</code></p></dd></dl><dl><dtclass="spec value"id="val-invalidate"><ahref="#val-invalidate"class="anchor"></a><code><spanclass="keyword">val</span> invalidate : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../PulseInvalidation/index.html#type-t">PulseBasicInterface.Invalidation.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>record that the address is invalid</p></dd></dl><dl><dtclass="spec value"id="val-allocate"><ahref="#val-allocate"class="anchor"></a><code><spanclass="keyword">val</span> allocate : <ahref="../../IR/Procname/index.html#type-t">IR.Procname.t</a><span>-></span><ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-add_dynamic_type"><ahref="#val-add_dynamic_type"class="anchor"></a><code><spanclass="keyword">val</span> add_dynamic_type : <ahref="../../IR/Typ/Name/index.html#type-t">IR.Typ.Name.t</a><span>-></span><ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-remove_allocation_attr"><ahref="#val-remove_allocation_attr"class="anchor"></a><code><spanclass="keyword">val</span> remove_allocation_attr : <ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dtclass="spec value"id="val-invalidate_access"><ahref="#val-invalidate_access"class="anchor"></a><code><spanclass="keyword">val</span> invalidate_access : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../PulseInvalidation/index.html#type-t">PulseBasicInterface.Invalidation.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="../../Pulselib__PulseBaseMemory/index.html#module-Access">Pulselib.PulseDomainInterface.BaseMemory.Access</a>.t <span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>record that what the address points via the access to is invalid</p></dd></dl><dl><dtclass="spec value"id="val-invalidate_array_elements"><ahref="#val-invalidate_array_elements"class="anchor"></a><code><spanclass="keyword">val</span> invalidate_array_elements : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../PulseInvalidation/index.html#type-t">PulseBasicInterface.Invalidation.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>record that all the array elements that address points to is invalid</p></dd></dl><dl><dtclass="spec value"id="val-shallow_copy"><ahref="#val-shallow_copy"class="anchor"></a><code><spanclass="keyword">val</span> shallow_copy : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><span>(<ahref="index.html#type-t">t</a> * <span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span>)</span><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>returns the address of a new cell with the same edges as the original</p></dd></dl><dl><dtclass="spec value"id="val-get_dynamic_type_unreachable_values"><ahref="#val-get_dynamic_type_unreachable_values"class="anchor"></a><code><spanclass="keyword">val</span> get_dynamic_type_unreachable_values : <span><ahref="../../IR/Var/index.html#type-t">IR.Var.t</a> list</span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><span>(<ahref="../../IR/Var/index.html#type-t">IR.Var.t</a> * <ahref="../../IR/Typ/Name/index.html#type-t">IR.Typ.Name.t</a>)</span> list</span></code></dt><dd><p>Given a list of variables, computes the unreachable values if the variables were removed from the stack, then return the dynamic types of those values if they are available</p></dd></dl><dl><dtclass="spec value"id="val-remove_vars"><ahref="#val-remove_vars"class="anchor"></a><code><spanclass="keyword">val</span> remove_vars : <span><ahref="../../IR/Var/index.html#type-t">IR.Var.t</a> list</span><span>-></span><ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dtclass="spec value"id="val-check_address_escape"><ahref="#val-check_address_escape"class="anchor"></a><code><spanclass="keyword">val</span> check_address_escape : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a><span>-></span><ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a><span>-></span><ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><ahref="index.html#type-t">t</a><ahref="index.html#type-access_result">access_result</a></span></code></dt><dtclass="spec value"id="val-call"><ahref="#val-call"class="anchor"></a><code><spanclass="keyword">val</span> call : <span>caller_proc_desc:<ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a></span><span>-></span><span>callee_data:<span><span>(<ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a> * <ahref="../PulseSummary/index.html#type-t">PulseSummary.t</a>)</span> option</span></span><span>-></span><ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../../IR/Procname/index.html#type-t">IR.Procname.t</a><span>-></span><span>ret:<span>(<ahref="../../IR/Ident/index.html#type-t">IR.Ident.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span></span><span>-></span><span>actuals:<span><span>(<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span></span><span>-></span><span>formals_opt:<span><span><span>(<ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span> option</span></span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span><span><ahref="../PulseExecutionDomain/index.html#type-t">PulseDomainInterface.ExecutionDomain.t</a> list</span><ahref="index.html#type-access_result">access_result</a></span></code></dt><dd><p>perform an interprocedural call: apply the summary for the call proc name passed as argument if it exists</p></dd></dl><dl><dtclass="spec value"id="val-unknown_call"><ahref="#val-unknown_call"class="anchor"></a><code><spanclass="keyword">val</span> unknown_call : <ahref="../../IBase/Location/index.html#type-t">IBase.Location.t</a><span>-></span><ahref="../PulseCallEvent/index.html#type-t">PulseBasicInterface.CallEvent.t</a><span>-></span><span>ret:<span>(<ahref="../../IR/Ident/index.html#type-t">IR.Ident.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span></span><span>-></span><span>actuals:<span><span>(<span>(<ahref="../PulseAbstractValue/index.html#type-t">PulseBasicInterface.AbstractValue.t</a> * <ahref="../PulseValueHistory/index.html#type-t">PulseBasicInterface.ValueHistory.t</a>)</span> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span></span><span>-></span><span>formals_opt:<span><span><span>(<ahref="../../IR/Pvar/index.html#type-t">IR.Pvar.t</a> * <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a>)</span> list</span> option</span></span><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dd><p>performs a call to a function with no summary by optimistically havoc'ing the by-ref actuals and the return value as appropriate</p></dd></dl></div></body></html>
