Update multicore-magic doc for 1.0.0

ocaml-multicore · Dec 26, 2023 · f64e5fa · f64e5fa
1 parent 3cb8bf1
commit f64e5fa
Show file tree

Hide file tree

Showing 20 changed files with 987 additions and 154 deletions.
diff --git a/1.0.0/multicore-magic/Multicore_magic/.dummy b/1.0.0/multicore-magic/Multicore_magic/.dummy
diff --git a/1.0.0/multicore-magic/Multicore_magic/index.html b/1.0.0/multicore-magic/Multicore_magic/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Multicore_magic (multicore-magic.Multicore_magic)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">multicore-magic</a> &#x00BB; Multicore_magic</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_magic</span></code></h1><p>This is a library of magic multicore utilities intended for experts for extracting the best possible performance from multicore OCaml.</p><p>Hopefully future releases of multicore OCaml will make this library obsolete!</p></header><nav class="odoc-toc"><ul><li><a href="#helpers-for-using-padding-to-avoid-false-sharing">Helpers for using padding to avoid false sharing</a></li><li><a href="#missing-atomic-operations">Missing <code>Atomic</code> operations</a></li></ul></nav><div class="odoc-content"><h2 id="helpers-for-using-padding-to-avoid-false-sharing"><a href="#helpers-for-using-padding-to-avoid-false-sharing" class="anchor"></a>Helpers for using padding to avoid false sharing</h2><div class="odoc-spec"><div class="spec value anchored" id="val-copy_as_padded"><a href="#val-copy_as_padded" class="anchor"></a><code><span><span class="keyword">val</span> copy_as_padded : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Creates a shallow clone of the given object. The clone will have extra padding words added after the last used word.</p><p>This is designed to help avoid <a href="https://en.wikipedia.org/wiki/False_sharing">false sharing</a>. False sharing has a negative impact on multicore performance. Accesses of both atomic and non-atomic locations, whether read-only or read-write, may suffer from false sharing.</p><p>The intended use case for this is to pad all long lived objects that are being accessed highly frequently (read or written).</p><p>Many kinds of objects can be padded, for example:</p><pre class="language-ocaml"><code>let padded_atomic = Multicore_magic.copy_as_padded (Atomic.make 101)
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Multicore_magic (multicore-magic.Multicore_magic)</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">multicore-magic</a> &#x00BB; Multicore_magic</nav><header class="odoc-preamble"><h1>Module <code><span>Multicore_magic</span></code></h1><p>This is a library of magic multicore utilities intended for experts for extracting the best possible performance from multicore OCaml.</p><p>Hopefully future releases of multicore OCaml will make this library obsolete!</p></header><nav class="odoc-toc"><ul><li><a href="#helpers-for-using-padding-to-avoid-false-sharing">Helpers for using padding to avoid false sharing</a></li><li><a href="#missing-atomic-operations">Missing <code>Atomic</code> operations</a></li></ul></nav><div class="odoc-content"><h2 id="helpers-for-using-padding-to-avoid-false-sharing"><a href="#helpers-for-using-padding-to-avoid-false-sharing" class="anchor"></a>Helpers for using padding to avoid false sharing</h2><div class="odoc-spec"><div class="spec value anchored" id="val-copy_as_padded"><a href="#val-copy_as_padded" class="anchor"></a><code><span><span class="keyword">val</span> copy_as_padded : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Creates a shallow clone of the given object. The clone will have extra padding words added after the last used word.</p><p>This is designed to help avoid <a href="https://en.wikipedia.org/wiki/False_sharing">false sharing</a>. False sharing has a negative impact on multicore performance. Accesses of both atomic and non-atomic locations, whether read-only or read-write, may suffer from false sharing.</p><p>The intended use case for this is to pad all long lived objects that are being accessed highly frequently (read or written).</p><p>Many kinds of objects can be padded, for example:</p><pre class="language-ocaml"><code>let padded_atomic = Multicore_magic.copy_as_padded (Atomic.make 101)
 
 let padded_ref = Multicore_magic.copy_as_padded (ref 42)
 
@@ -30,4 +30,4 @@
 (* prepare data_structure referring to new_atomic *)
 Multicore_magic.fenceless_set new_atomic data_structure;
 (* publish the data_structure: *)
-Atomic.exchance old_atomic data_structure</code></pre><p>Now only a single full fence is performed by <code>Atomic.exchange</code> and performance may be improved.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fence"><a href="#val-fence" class="anchor"></a><code><span><span class="keyword">val</span> fence : <span><span>int <span class="xref-unresolved">Stdlib</span>.Atomic.t</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Perform a full acquire-release fence on the given atomic.</p><p><code>fence atomic</code> is equivalent to <code>ignore (Atomic.fetch_and_add atomic 0)</code>.</p></div></div></div></body></html>
+Atomic.exchance old_atomic data_structure</code></pre><p>Now only a single full fence is performed by <code>Atomic.exchange</code> and performance may be improved.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fence"><a href="#val-fence" class="anchor"></a><code><span><span class="keyword">val</span> fence : <span><span>int <span class="xref-unresolved">Stdlib</span>.Atomic.t</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Perform a full acquire-release fence on the given atomic.</p><p><code>fence atomic</code> is equivalent to <code>ignore (Atomic.fetch_and_add atomic 0)</code>.</p></div></div></div></body></html>
diff --git a/1.0.0/multicore-magic/index.html b/1.0.0/multicore-magic/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (multicore-magic.index)</title><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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> – multicore-magic</nav><header class="odoc-preamble"><h1 id="multicore-magic-index"><a href="#multicore-magic-index" class="anchor"></a>multicore-magic index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-multicore-magic">Library multicore-magic</a></li></ul></nav><div class="odoc-content"><h2 id="library-multicore-magic"><a href="#library-multicore-magic" class="anchor"></a>Library multicore-magic</h2><p>The entry point of this library is the module: <a href="Multicore_magic/index.html"><code>Multicore_magic</code></a>.</p></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (multicore-magic.index)</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> – multicore-magic</nav><header class="odoc-preamble"><h1 id="multicore-magic-index"><a href="#multicore-magic-index" class="anchor"></a>multicore-magic index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-multicore-magic">Library multicore-magic</a></li></ul></nav><div class="odoc-content"><h2 id="library-multicore-magic"><a href="#library-multicore-magic" class="anchor"></a>Library multicore-magic</h2><p>The entry point of this library is the module: <a href="Multicore_magic/index.html"><code>Multicore_magic</code></a>.</p></div></body></html>
diff --git a/1.0.0/odoc.support/fonts/fira-mono-v14-latin-500.woff2 b/1.0.0/odoc.support/fonts/fira-mono-v14-latin-500.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-mono-v14-latin-regular.woff2 b/1.0.0/odoc.support/fonts/fira-mono-v14-latin-regular.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-sans-v17-latin-500.woff2 b/1.0.0/odoc.support/fonts/fira-sans-v17-latin-500.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2 b/1.0.0/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-sans-v17-latin-700.woff2 b/1.0.0/odoc.support/fonts/fira-sans-v17-latin-700.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2 b/1.0.0/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-sans-v17-latin-italic.woff2 b/1.0.0/odoc.support/fonts/fira-sans-v17-latin-italic.woff2
diff --git a/1.0.0/odoc.support/fonts/fira-sans-v17-latin-regular.woff2 b/1.0.0/odoc.support/fonts/fira-sans-v17-latin-regular.woff2
diff --git a/1.0.0/odoc.support/fonts/noticia-text-v15-latin-700.woff2 b/1.0.0/odoc.support/fonts/noticia-text-v15-latin-700.woff2
diff --git a/1.0.0/odoc.support/fonts/noticia-text-v15-latin-italic.woff2 b/1.0.0/odoc.support/fonts/noticia-text-v15-latin-italic.woff2
diff --git a/1.0.0/odoc.support/fonts/noticia-text-v15-latin-regular.woff2 b/1.0.0/odoc.support/fonts/noticia-text-v15-latin-regular.woff2