mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-28 00:01:33 -08:00
264 lines
No EOL
18 KiB
HTML
264 lines
No EOL
18 KiB
HTML
|
|
|
|
<!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>Reference — Memory Pool System 1.111.0 documentation</title>
|
|
|
|
<link rel="stylesheet" href="../_static/mps.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '../',
|
|
VERSION: '1.111.0',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
<link rel="copyright" title="Copyright" href="../copyright.html" />
|
|
<link rel="top" title="Memory Pool System 1.111.0 documentation" href="../index.html" />
|
|
<link rel="next" title="1. Interface conventions" href="interface.html" />
|
|
<link rel="prev" title="6. Advanced topics" href="../guide/advanced.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="interface.html" title="1. Interface conventions"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="../guide/advanced.html" title="6. Advanced topics"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="../index.html">Memory Pool System 1.111.0 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="reference">
|
|
<span id="id1"></span><h1>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="interface.html">1. Interface conventions</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#support-policy">1.1. Support policy</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#language">1.2. Language</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#headers">1.3. Headers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#index-4">1.4. Identifiers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#types">1.5. Types</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#functions">1.6. Functions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#type-punning">1.7. Type punning</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#macros">1.8. Macros</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="interface.html#general-types">1.9. General types</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="keyword.html">2. Keyword arguments</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="error.html">3. Error handing</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="error.html#result-codes">3.1. Result codes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="error.html#assertions">3.2. Assertions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="error.html#common-assertions-and-their-causes">3.3. Common assertions and their causes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="error.html#varieties">3.4. Varieties</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="arena.html">4. Arenas</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#client-arenas">4.1. Client arenas</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#virtual-memory-arenas">4.2. Virtual memory arenas</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#arena-properties">4.3. Arena properties</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#arena-states">4.4. Arena states</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#running-garbage-collections">4.5. Running garbage collections</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#using-idle-time-for-collection">4.6. Using idle time for collection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#arena-introspection">4.7. Arena introspection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="arena.html#protection-interface">4.8. Protection interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pool.html">5. Pools</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="pool.html#pool-classes">5.1. Pool classes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pool.html#pool-introspection">5.2. Pool introspection</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="allocation.html">6. Allocation</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#manual-allocation">6.1. Manual allocation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#allocation-points">6.2. Allocation points</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#allocation-point-protocol">6.3. Allocation point protocol</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#example-allocating-a-symbol">6.4. Example: allocating a symbol</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#cautions">6.5. Cautions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#example-inserting-into-a-doubly-linked-list">6.6. Example: inserting into a doubly linked list</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="allocation.html#allocation-point-implementation">6.7. Allocation point implementation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="format.html">7. Object formats</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="format.html#creating-an-object-format">7.1. Creating an object format</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="format.html#cautions">7.2. Cautions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="format.html#format-methods">7.3. Format methods</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="format.html#object-format-introspection">7.4. Object format introspection</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="scanning.html">8. Scanning</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#scanning-protocol">8.1. Scanning protocol</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#tagged-references">8.2. Tagged references</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#critical-path">8.3. Critical path</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#ambiguous-references">8.4. Ambiguous references</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#unfixed-references">8.5. Unfixed references</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#example-scheme-objects">8.6. Example: Scheme objects</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#scanning-interface">8.7. Scanning interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="scanning.html#fixing-interface">8.8. Fixing interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="thread.html">9. Threads</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="thread.html#thread-safety">9.1. Thread safety</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="thread.html#thread-registration">9.2. Thread registration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="thread.html#signal-handling-issues">9.3. Signal handling issues</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="thread.html#thread-interface">9.4. Thread interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="root.html">10. Roots</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#registering-roots">10.1. Registering roots</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#cautions">10.2. Cautions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#thread-roots">10.3. Thread roots</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#ranks">10.4. Ranks</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#root-modes">10.5. Root modes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#root-interface">10.6. Root interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="root.html#root-introspection">10.7. Root introspection</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="collection.html">11. Garbage collection</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="collection.html#generation-chains">11.1. Generation chains</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="collection.html#scheduling-of-collections">11.2. Scheduling of collections</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="collection.html#garbage-collection-start-messages">11.3. Garbage collection start messages</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="collection.html#garbage-collection-messages">11.4. Garbage collection messages</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="message.html">12. Messages</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="message.html#finalization-messages">12.1. Finalization messages</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="message.html#example-interactive-chatter">12.2. Example: interactive chatter</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="message.html#message-types">12.3. Message types</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="message.html#message-interface">12.4. Message interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="message.html#message-queue-interface">12.5. Message queue interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="finalization.html">13. Finalization</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="finalization.html#multiple-finalizations">13.1. Multiple finalizations</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="finalization.html#cautions">13.2. Cautions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="finalization.html#finalization-interface">13.3. Finalization interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="finalization.html#finalization-messages">13.4. Finalization messages</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="location.html">14. Location dependency</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="location.html#terminology">14.1. Terminology</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="location.html#creating-dependencies">14.2. Creating dependencies</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="location.html#adding-dependencies">14.3. Adding dependencies</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="location.html#testing-dependencies-for-staleness">14.4. Testing dependencies for staleness</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="location.html#thread-safety">14.5. Thread safety</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="location.html#location-dependency-interface">14.6. Location dependency interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cache.html">15. Segregated allocation caches</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="cache.html#cache-interface">15.1. Cache interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cache.html#allocation-interface">15.2. Allocation interface</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="pattern.html">16. Allocation patterns</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="pattern.html#ramp-allocation">16.1. Ramp allocation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="frame.html">17. Allocation frames</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="debugging.html">18. Debugging pools</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="telemetry.html">19. Telemetry</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#telemetry-utilities">19.1. Telemetry utilities</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#example">19.2. Example</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#event-categories">19.3. Event categories</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#environment-variables">19.4. Environment variables</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#decoding-the-telemetry-stream">19.5. Decoding the telemetry stream</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#making-the-telemetry-stream-readable">19.6. Making the telemetry stream readable</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#loading-the-telemetry-stream-into-sqlite">19.7. Loading the telemetry stream into SQLite</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#telemetry-interface">19.8. Telemetry interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#telemetry-labels">19.9. Telemetry labels</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="weak.html">20. Weak references</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="plinth.html">21. Plinth</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="plinth.html#i-o-module">21.1. I/O module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="plinth.html#library-module">21.2. Library module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="platform.html">22. Platforms</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="platform.html#platform-codes">22.1. Platform codes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="platform.html#platform-interface">22.2. Platform interface</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="platform.html#historical-platform-codes">22.3. Historical platform codes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="platform.html#historical-platform-list">22.4. Historical platform list</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../index.html">
|
|
<img class="logo" src="../_static/logo.png" alt="Logo"/>
|
|
</a></p>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="../guide/advanced.html"
|
|
title="previous chapter">6. Advanced topics</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="interface.html"
|
|
title="next chapter">1. Interface conventions</a></p><h4>Downloads</h4>
|
|
|
|
<p class="topless">
|
|
<a href="http://www.ravenbrook.com/project/mps/release/1.111.0/">MPS Kit release 1.111.0</a><br>
|
|
<a href="http://www.ravenbrook.com/project/mps/release/">All MPS Kit releases</a>
|
|
</p>
|
|
|
|
<h4>Issues</h4>
|
|
|
|
<p class="topless">
|
|
<a href="http://www.ravenbrook.com/project/mps/issue/?action=list&view=status%3dopen&display=Job:Priority:Title&sort=Priority">Known issues</a><br>
|
|
<a href="http://www.ravenbrook.com/project/mps/issue/?action=fixed&release_fixed=1.111.0">Issues fixed in release 1.111.0</a>
|
|
</p><h4>Contact us</h4>
|
|
|
|
<p class="topless"><a href="mailto:mps-questions@ravenbrook.com">mps-questions@ravenbrook.com</a></p>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="interface.html" title="1. Interface conventions"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="../guide/advanced.html" title="6. Advanced topics"
|
|
>previous</a> |</li>
|
|
<li><a href="../index.html">Memory Pool System 1.111.0 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© <a href="../copyright.html">Copyright</a> 2013, Ravenbrook Limited.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
|
</div>
|
|
</body>
|
|
</html> |