/usr/share/doc/libghc-ghc-events-doc/html/GHC-RTS-Events-Analysis-Capability.html is in libghc-ghc-events-doc 0.4.2.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GHC.RTS.Events.Analysis.Capability</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_GHC-RTS-Events-Analysis-Capability.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/GHC-RTS-Events-Analysis-Capability.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">ghc-events-0.4.2.0: Library and tool for parsing .eventlog files from GHC</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Inferred</td></tr></table><p class="caption">GHC.RTS.Events.Analysis.Capability</p></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:capabilityThreadPoolMachine">capabilityThreadPoolMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a></li><li class="src short"><a href="#v:capabilityThreadRunMachine">capabilityThreadRunMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a></li><li class="src short"><a href="#v:capabilityThreadIndexer">capabilityThreadIndexer</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a> -> <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a></li><li class="src short"><a href="#v:capabilityTaskPoolMachine">capabilityTaskPoolMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:TaskId">TaskId</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a></li><li class="src short"><a href="#v:capabilityTaskOSMachine">capabilityTaskOSMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:KernelThreadId">KernelThreadId</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:TaskId">TaskId</a> <a href="GHC-RTS-Events.html#t:KernelThreadId">KernelThreadId</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:capabilityThreadPoolMachine" class="def">capabilityThreadPoolMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a><a href="src/GHC-RTS-Events-Analysis-Capability.html#capabilityThreadPoolMachine" class="link">Source</a></p><div class="doc"><p>This state machine tracks threads residing on capabilities.
Each thread can only reside on one capability, but can be migrated between
them.
</p></div></div><div class="top"><p class="src"><a name="v:capabilityThreadRunMachine" class="def">capabilityThreadRunMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a><a href="src/GHC-RTS-Events-Analysis-Capability.html#capabilityThreadRunMachine" class="link">Source</a></p><div class="doc"><p>This state machine tracks threads running on capabilities, only one thread
may run on a capability at a time.
</p></div></div><div class="top"><p class="src"><a name="v:capabilityThreadIndexer" class="def">capabilityThreadIndexer</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a> -> <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> <a href="GHC-RTS-Events.html#t:ThreadId">ThreadId</a><a href="src/GHC-RTS-Events-Analysis-Capability.html#capabilityThreadIndexer" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:capabilityTaskPoolMachine" class="def">capabilityTaskPoolMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:TaskId">TaskId</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a><a href="src/GHC-RTS-Events-Analysis-Capability.html#capabilityTaskPoolMachine" class="link">Source</a></p><div class="doc"><p>This state machine tracks Haskell tasks, represented by TaskId,
residing on capabilities.
Each Haskell task can only reside on one capability, but can be migrated
between them.
</p></div></div><div class="top"><p class="src"><a name="v:capabilityTaskOSMachine" class="def">capabilityTaskOSMachine</a> :: <a href="GHC-RTS-Events-Analysis.html#t:Machine">Machine</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:KernelThreadId">KernelThreadId</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a>, <a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> <a href="GHC-RTS-Events.html#t:TaskId">TaskId</a> <a href="GHC-RTS-Events.html#t:KernelThreadId">KernelThreadId</a>) <a href="GHC-RTS-Events.html#t:CapEvent">CapEvent</a><a href="src/GHC-RTS-Events-Analysis-Capability.html#capabilityTaskOSMachine" class="link">Source</a></p><div class="doc"><p>This state machine tracks Haskell tasks (represented by the KernelThreadId
of their OS thread) residing on capabilities and additionally
tracks the (immutable) assignment of OS thread ids (KernelThreadId)
to tasks ids (TaskId).
Each Haskell task can only reside on one capability, but can be migrated
between them.
</p><p>Invariant for the <code>(Map KernelThreadId Int, Map TaskId KernelThreadId)</code>
type: the second map is an injection (verified by the machine
in <code>insertTaskOS</code>) and the following sets are equal:
keys of the fist map and values of the second
(follows from the construction of the maps by the machine).
</p><p>The machine verifies as much as <code><a href="GHC-RTS-Events-Analysis-Capability.html#v:capabilityTaskPoolMachine">capabilityTaskPoolMachine</a></code> and additionally
the data invariant, and offers a richer verification profile.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|