Skip to content

Commit

Permalink
Update Sphinx documentation, commit 12609d7 [skip ci].
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Sep 4, 2024
1 parent fc05f68 commit d073bec
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
14 changes: 9 additions & 5 deletions _sources/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@ Unsolved

The root cause is most likely a code-generation/optimisation problem in LLVM.
This issue is currently under investigation.
* The parallel compilation feature (added in heyoka 6.0.0) is currently disabled
by default on 64-bit ARM processors (this includes the Apple M1 and its successors).
* The parallel compilation feature (added in heyoka 6.0.0) is currently turned
off by default on all platforms and completely disabled on Windows.
The reason is a likely thread scheduling bug in LLVM's parallel compilation facilities
that very rarely results in a multiply-defined symbol, which ultimately leads to compilation
failure. The issue is currently under investigation by the LLVM developers. In the
meantime, you can explicitly turn on parallel compilation via the ``kw::parjit``
which, on Unix systems, rarely results in a multiply-defined symbol, ultimately leading to a compilation
failure. On Windows, parallel compilation under heavy loads results in segmentation faults.
The issue is currently under investigation by the LLVM developers. In the
meantime, you can explicitly turn on parallel compilation on Unix systems via the ``kw::parjit``
:ref:`keyword argument <kwargs>` when constructing an integrator or a compiled
function.
* The option for selecting the code used model for JIT compilation
(added in heyoka 6.0.0) is currently disabled on Windows due to what
looks like an LLVM bug. The issue is currently under investigation.

Solved
======
Expand Down
14 changes: 9 additions & 5 deletions known_issues.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,14 +436,18 @@ <h1>Unsolved<a class="headerlink" href="#unsolved" title="Link to this heading">
<p>The root cause is most likely a code-generation/optimisation problem in LLVM.
This issue is currently under investigation.</p>
</li>
<li><p>The parallel compilation feature (added in heyoka 6.0.0) is currently disabled
by default on 64-bit ARM processors (this includes the Apple M1 and its successors).
<li><p>The parallel compilation feature (added in heyoka 6.0.0) is currently turned
off by default on all platforms and completely disabled on Windows.
The reason is a likely thread scheduling bug in LLVM’s parallel compilation facilities
that very rarely results in a multiply-defined symbol, which ultimately leads to compilation
failure. The issue is currently under investigation by the LLVM developers. In the
meantime, you can explicitly turn on parallel compilation via the <code class="docutils literal notranslate"><span class="pre">kw::parjit</span></code>
which, on Unix systems, rarely results in a multiply-defined symbol, ultimately leading to a compilation
failure. On Windows, parallel compilation under heavy loads results in segmentation faults.
The issue is currently under investigation by the LLVM developers. In the
meantime, you can explicitly turn on parallel compilation on Unix systems via the <code class="docutils literal notranslate"><span class="pre">kw::parjit</span></code>
<a class="reference internal" href="kwargs.html#kwargs"><span class="std std-ref">keyword argument</span></a> when constructing an integrator or a compiled
function.</p></li>
<li><p>The option for selecting the code used model for JIT compilation
(added in heyoka 6.0.0) is currently disabled on Windows due to what
looks like an LLVM bug. The issue is currently under investigation.</p></li>
</ul>
</section>
<section id="solved">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit d073bec

Please sign in to comment.