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>InferModules__RacerDDomain (infer.InferModules__RacerDDomain)</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>» InferModules__RacerDDomain</nav><h1>Module <code>InferModules__RacerDDomain</code></h1></header><divclass="spec module"id="module-F"><ahref="#module-F"class="anchor"></a><code><spanclass="keyword">module</span> F = Stdlib.Format</code></div><divclass="spec module"id="module-Access"><ahref="#module-Access"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Access/index.html">Access</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><divclass="spec module"id="module-TraceElem"><ahref="#module-TraceElem"class="anchor"></a><code><spanclass="keyword">module</span><ahref="TraceElem/index.html">TraceElem</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><dl><dtclass="spec module"id="module-LocksDomain"><ahref="#module-LocksDomain"class="anchor"></a><code><spanclass="keyword">module</span><ahref="LocksDomain/index.html">LocksDomain</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></dt><dd><p>Overapproximation of number of locks that are currently held</p></dd></dl><dl><dtclass="spec module"id="module-ThreadsDomain"><ahref="#module-ThreadsDomain"class="anchor"></a><code><spanclass="keyword">module</span><ahref="ThreadsDomain/index.html">ThreadsDomain</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></dt><dd><p>Abstraction of threads that may run in parallel with the current thread. NoThread < AnyThreadExceptSelf < AnyThread</p></dd></dl><dl><dtclass="spec module"id="module-AccessSnapshot"><ahref="#module-AccessSnapshot"class="anchor"></a><code><spanclass="keyword">module</span><ahref="AccessSnapshot/index.html">AccessSnapshot</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></dt><dd><p>snapshot of the relevant state at the time of a heap access: concurrent thread(s), lock(s) held, ownership precondition</p></dd></dl><dl><dtclass="spec module"id="module-AccessDomain"><ahref="#module-AccessDomain"class="anchor"></a><code><spanclass="keyword">module</span><ahref="AccessDomain/index.html">AccessDomain</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></dt><dd><p>map of access metadata |-> set of accesses. the map should hold all accesses to a possibly-unowned access path</p></dd></dl><divclass="spec module"id="module-OwnershipAbstractValue"><ahref="#module-OwnershipAbstractValue"class="anchor"></a><code><spanclass="keyword">module</span><ahref="OwnershipAbstractValue/index.html">OwnershipAbstractValue</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><divclass="spec module"id="module-OwnershipDomain"><ahref="#module-OwnershipDomain"class="anchor"></a><code><spanclass="keyword">module</span><ahref="OwnershipDomain/index.html">OwnershipDomain</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><dl><dtclass="spec module"id="module-Choice"><ahref="#module-Choice"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Choice/index.html">Choice</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></dt><dd><p>attribute attached to a boolean variable specifying what it means when the boolean is true</p></dd></dl><divclass="spec module"id="module-Attribute"><ahref="#module-Attribute"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Attribute/index.html">Attribute</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><divclass="spec module"id="module-AttributeSetDomain"><ahref="#module-AttributeSetDomain"class="anchor"></a><code><spanclass="keyword">module</span><ahref="AttributeSetDomain/index.html">AttributeSetDomain</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><divclass="spec module"id="module-AttributeMapDomain"><ahref="#module-AttributeMapDomain"class="anchor"></a><code><spanclass="keyword">module</span><ahref="AttributeMapDomain/index.html">AttributeMapDomain</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code><code> = </code><code>{</code><tableclass="record"><trid="type-t.threads"class="anchored"><tdclass="def field"><ahref="#type-t.threads"class="anchor"></a><code>threads : <ahref="ThreadsDomain/index.html#type-t">ThreadsDomain.t</a>;</code></td><tdclass="doc"><p>current thread: main, background, or unknown</p></td></tr><trid="type-t.locks"class="anchored"><tdclass="def field"><ahref="#type-t.locks"class="anchor"></a><code>locks : <ahref="LocksDomain/index.html#type-t">LocksDomain.t</a>;</code></td><tdclass="doc"><p>boolean that is true if a lock must currently be held</p></td></tr><trid="type-t.accesses"class="anchored"><tdclass="def field"><ahref="#type-t.accesses"class="anchor"></a><code>accesses : <ahref="index.html#module-AccessDomain">AccessDomain</a>.t;</code></td><tdclass="doc"><p>read and writes accesses performed without ownership permissions</p></td></tr><trid="type-t.ownership"class="anchored"><tdclass="def field"><ahref="#type-t.ownership"class="anchor"></a><code>ownership : <ahref="OwnershipDomain/index.html#type-t">OwnershipDomain.t</a>;</code></td><tdclass="doc"><p>map of access paths to ownership predicates</p></td></tr><trid="type-t.attribute_map"class="anchored"><tdclass="def field"><ahref="#type-t.attribute_map"class="anchor"></a><code>attribute_map : <ahref="AttributeMapDomain/index.html#type-t">AttributeMapDomain.t</a>;</code></td><tdclass="doc"><p>map of access paths to attributes such as owned, functional, ...</p></td></tr></table><code>}</code></dt><dtclass="spec type"id="type-summary"><ahref="#type-summary"class="anchor"></a><code><spanclass="keyword">type</span> summary</code><code> = </code><code>{</code><tableclass="record"><trid="type-summary.threads"class="anchored"><tdclass="def field"><ahref="#type-summary.threads"class="anchor"></a><code>threads : <ahref="ThreadsDomain/index.html#type-t">ThreadsDomain.t</a>;</code></td></tr><trid="type-summary.locks"class="anchored"><tdclass="def field"><ahref="#type-summary.locks"class="anchor"></a><code>locks : <ahref="LocksDomain/index.html#type-t">LocksDomain.t</a>;</code></td></tr><trid="type-summary.accesses"class="anchored"><tdclass="def field"><ahref="#type-summary.accesses"class="anchor"></a><code>accesses : <ahref="index.html#module-AccessDomain">AccessDomain</a>.t;</code></td></tr><trid="type-summary.return_ownership"class="anchored"><tdclass="def field"><ahref="#type-summary.return_ownership"class="anchor"></a><code>return_ownership : <ahref="OwnershipAbstractValue/index.html#type-t">OwnershipAbstractValue.t</a>;</code></td></tr><trid="type-summary.return_attributes"class="anchored"><tdclass="def field"><ahref="#type-summary.return_attributes"class="anchor"></a><code>return_attributes : <ahref="AttributeSetDomain/index.html#type-t">AttributeSetDomain.t</a>;</code></td></tr></table><code>}</code></dt><dd><p>same as astate, but without <code>attribute_map</code> (since these involve locals) and with the addition of the ownership/attributes associated with the return value as well as the set of formals which may escape</p></dd></dl><dl><dtclass="spec value"id="val-empty_summary"><ahref="#val-empty_summary"class="anchor"></a><code><spanclass="keyword">val</span> empty_summary : <ahref="index.html#type-summary">summary</a></code></dt></dl><div><divclass="spec include"><divclass="doc"><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include</span><ahref="../InferModules/AbstractDomain/index.html#module-type-WithBottom">InferModules.AbstractDomain.WithBottom</a><spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="../InferModules/AbstractDomain/module-type-WithBottom/index.html#type-t">t</a> := <ahref="index.html#type-t">t</a></code></span></summary><div><divclass="spec include"><divclass="doc"><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include</span><ahref="../InferModules/AbstractDomain/index.html#module-type-S">InferModules.AbstractDomain.S</a></code></span></summary><div><divclass="spec include"><divclass="doc"><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include</span><ahref="../InferModules/AbstractDomain/index.html#module-type-NoJoin">InferModules.AbstractDomain.NoJoin</a></code></span></summary><div><divclass="spec include"><divclass="doc"><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include</span><ahref="../../InferStdlib/InferStdlib/PrettyPrintable/index.html#module-type-PrintableType">InferStdlib.PrettyPrintable.PrintableType</a></code></span></summary><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code></dt></dl><dl><dtclass="spec value"id="val-pp"><ahref="#val-pp"class="anchor"></a><code><spanclass="keyword">val</span> pp : <ahref="../../InferStdlib/InferStdlib/PrettyPrintable/index.html#module-F">InferStdlib.PrettyPrintable.F</a>.formatter <span>-></span><ahref="index.html#type-t">t</a><span>-></span> unit</code></dt></dl></details></div></div></div><dl><dtclass="spec value"id="val-(<=)"><ahref="#val-(<=)"class="anchor"></a><code><spanclass="keyword">val</span> (<=) : <span>lhs:<ahref="index.html#type-t">t</a></span><span>-></span><span>rhs:<ahref="index.html#type-t">t</a></span><span>-></span> bool</code></dt><dd><p>the implication relation: <code>lhs <= rhs</code> means <code>lhs |- rhs</code></p></dd></dl></details></div></div></div><dl><dtclass="spec value"id="val-join"><ahref="#val-join"class="anchor"></a><code><spanclass="keyword">val</span> join : <ahref="index.html#type-t">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-widen"><ahref="#val-widen"class="anchor"></a><code><spanclass="keyword">val</span> widen : <span>prev:<ahref="index.html#type-t">t</a></span><span>-></span><span>next:<ahref="index.html#type-t">t</a></span><span>-></span><span>num_iters:int</span><span>-></span><ahref="index.html#type-t">t</a></code></dt></dl></details></div></div></div><dl><dtclass="spec value"id="val-bottom"><ahref="#val-bottom"class="anchor"></a><code><spanclass="keyword">val</span> bottom : <ahref="index.html#type-t">t</a></code></dt><dd><p>The bottom value of the domain.</p></dd></dl><dl><dtclass="spec value"id="val-is_bottom"><ahref="#val-is_bottom"class="anchor"></a><code><spanclass="keyword">val</span> is_bottom : <ahref="index.html#type-t">t</a><span>-></span> bool</code></dt><dd><p>Return true if this is the bottom value</p></dd></dl></details></div></div></div><dl><dtclass="spec value"id="val-pp_summary"><ahref="#val-pp_summary"class="anchor"></a><code><spanclass="keyword">val</span> pp_summary : <ahref="index.html#module-F">F</a>.formatter <span>-></span><ahref="index.html#type-summary">summary</a><span>-></span> unit</code></dt><dtclass="spec value"id="val-add_unannotated_call_access"><ahref="#val-add_unannotated_call_access"class="anchor"></a><code><spanclass="keyword">val</span> add_unannotated_call_access : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><ahref="../../InferBase/InferBase/Location/index.html#type-t">InferBase.Location.t</a><span>-></span><ahref="../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt></dl></div></body></html>
