-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
2,034 additions
and
24 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mode (kcas.Kcas.Mode)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">kcas</a> » <a href="../index.html">Kcas</a> » Mode</nav><header class="odoc-preamble"><h1>Module <code><span>Kcas.Mode</span></code></h1><p>Operating modes of the <code>k-CAS-n-CMP</code> algorithm.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>[ </span></code><ol><li id="type-t.Lock_free" class="def variant constructor anchored"><a href="#type-t.Lock_free" class="anchor"></a><code><span>| </span><span>`Lock_free</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>In <code>`Lock_free</code> mode the algorithm makes sure that at least one domain will be able to make progress at the cost of performing read-only operations as read-write operations.</p><span class="comment-delim">*)</span></div></li><li id="type-t.Obstruction_free" class="def variant constructor anchored"><a href="#type-t.Obstruction_free" class="anchor"></a><code><span>| </span><span>`Obstruction_free</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>In <code>`Obstruction_free</code> mode the algorithm proceeds optimistically and allows read-only operations to fail due to interference from other domains that might have been prevented in the <code>`Lock_free</code> mode.</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Type of an operating mode of the <code>k-CAS-n-CMP</code> algorithm.</p></div></div></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mode (kcas.Kcas.Mode)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../'; | ||
let search_urls = ['../../db.js','../../../sherlodoc.js']; | ||
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">kcas</a> » <a href="../index.html">Kcas</a> » Mode</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Kcas.Mode</span></code></h1><p>Operating modes of the <code>k-CAS-n-CMP</code> algorithm.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>[ </span></code><ol><li id="type-t.Lock_free" class="def variant constructor anchored"><a href="#type-t.Lock_free" class="anchor"></a><code><span>| </span><span>`Lock_free</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>In <code>`Lock_free</code> mode the algorithm makes sure that at least one domain will be able to make progress at the cost of performing read-only operations as read-write operations.</p><span class="comment-delim">*)</span></div></li><li id="type-t.Obstruction_free" class="def variant constructor anchored"><a href="#type-t.Obstruction_free" class="anchor"></a><code><span>| </span><span>`Obstruction_free</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>In <code>`Obstruction_free</code> mode the algorithm proceeds optimistically and allows read-only operations to fail due to interference from other domains that might have been prevented in the <code>`Lock_free</code> mode.</p><span class="comment-delim">*)</span></div></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Type of an operating mode of the <code>k-CAS-n-CMP</code> algorithm.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Retry (kcas.Kcas.Retry)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">kcas</a> » <a href="../index.html">Kcas</a> » Retry</nav><header class="odoc-preamble"><h1>Module <code><span>Kcas.Retry</span></code></h1><p>Retry support.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-Later"><a href="#exception-Later" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Later</span></span></code></div><div class="spec-doc"><p>Exception that may be raised to signal that the operation, such as <a href="../Loc/index.html#val-get_as"><code>Loc.get_as</code></a>, <a href="../Loc/index.html#val-update"><code>Loc.update</code></a>, or <a href="../Xt/index.html#val-commit"><code>Xt.commit</code></a>, should be retried, at some point in the future, after the examined shared memory location or locations have changed.</p><p><b>NOTE</b>: It is important to understand that "<i>after</i>" may effectively mean "<i>immediately</i>", because it may be the case that the examined shared memory locations have already changed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-later"><a href="#val-later" class="anchor"></a><code><span><span class="keyword">val</span> later : <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>later ()</code> is equivalent to <code>raise Later</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unless"><a href="#val-unless" class="anchor"></a><code><span><span class="keyword">val</span> unless : <span>bool <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>unless condition</code> is equivalent to <code>if not condition then later ()</code>.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Invalid"><a href="#exception-Invalid" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Invalid</span></span></code></div><div class="spec-doc"><p>Exception that may be raised to signal that the transaction log is no longer valid, e.g. because shared memory locations have been changed outside of the transaction, and the transaction should be retried.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-invalid"><a href="#val-invalid" class="anchor"></a><code><span><span class="keyword">val</span> invalid : <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>invalid ()</code> is equivalent to <code>raise Invalid</code>.</p></div></div></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Retry (kcas.Kcas.Retry)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../'; | ||
let search_urls = ['../../db.js','../../../sherlodoc.js']; | ||
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">kcas</a> » <a href="../index.html">Kcas</a> » Retry</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Kcas.Retry</span></code></h1><p>Retry support.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-Later"><a href="#exception-Later" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Later</span></span></code></div><div class="spec-doc"><p>Exception that may be raised to signal that the operation, such as <a href="../Loc/index.html#val-get_as"><code>Loc.get_as</code></a>, <a href="../Loc/index.html#val-update"><code>Loc.update</code></a>, or <a href="../Xt/index.html#val-commit"><code>Xt.commit</code></a>, should be retried, at some point in the future, after the examined shared memory location or locations have changed.</p><p><b>NOTE</b>: It is important to understand that "<i>after</i>" may effectively mean "<i>immediately</i>", because it may be the case that the examined shared memory locations have already changed.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-later"><a href="#val-later" class="anchor"></a><code><span><span class="keyword">val</span> later : <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>later ()</code> is equivalent to <code>raise Later</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unless"><a href="#val-unless" class="anchor"></a><code><span><span class="keyword">val</span> unless : <span>bool <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>unless condition</code> is equivalent to <code>if not condition then later ()</code>.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Invalid"><a href="#exception-Invalid" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Invalid</span></span></code></div><div class="spec-doc"><p>Exception that may be raised to signal that the transaction log is no longer valid, e.g. because shared memory locations have been changed outside of the transaction, and the transaction should be retried.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-invalid"><a href="#val-invalid" class="anchor"></a><code><span><span class="keyword">val</span> invalid : <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>invalid ()</code> is equivalent to <code>raise Invalid</code>.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,4 @@ | ||
<!DOCTYPE html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Timeout (kcas.Kcas.Timeout)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">kcas</a> » <a href="../index.html">Kcas</a> » Timeout</nav><header class="odoc-preamble"><h1>Module <code><span>Kcas.Timeout</span></code></h1><p>Timeout support.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-Timeout"><a href="#exception-Timeout" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Timeout</span></span></code></div><div class="spec-doc"><p>Exception that may be raised by operations such as <a href="../Loc/index.html#val-get_as"><code>Loc.get_as</code></a>, <a href="../Loc/index.html#val-update"><code>Loc.update</code></a>, <a href="../Loc/index.html#val-modify"><code>Loc.modify</code></a>, or <a href="../Xt/index.html#val-commit"><code>Xt.commit</code></a> when given a <code>~timeoutf</code> in seconds.</p></div></div></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Timeout (kcas.Kcas.Timeout)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../'; | ||
let search_urls = ['../../db.js','../../../sherlodoc.js']; | ||
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">kcas</a> » <a href="../index.html">Kcas</a> » Timeout</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Kcas.Timeout</span></code></h1><p>Timeout support.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-Timeout"><a href="#exception-Timeout" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Timeout</span></span></code></div><div class="spec-doc"><p>Exception that may be raised by operations such as <a href="../Loc/index.html#val-get_as"><code>Loc.get_as</code></a>, <a href="../Loc/index.html#val-update"><code>Loc.update</code></a>, <a href="../Loc/index.html#val-modify"><code>Loc.modify</code></a>, or <a href="../Xt/index.html#val-commit"><code>Xt.commit</code></a> when given a <code>~timeoutf</code> in seconds.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.