| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>GCHeapMap (OpenJ9 JDK 18)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.dtfj, package: com.ibm.j9ddr.vm29.j9.gc, class: GCHeapMap"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.j9ddr.vm29.j9.gc.GCHeapMap class"> |
| <meta name="keywords" content="J9BITS_BITS_IN_SLOT"> |
| <meta name="keywords" content="BITS_IN_BYTES"> |
| <meta name="keywords" content="J9MODRON_HEAP_SLOTS_PER_HEAPMAP_SLOT"> |
| <meta name="keywords" content="J9MODRON_HEAP_BYTES_PER_HEAPMAP_BIT"> |
| <meta name="keywords" content="J9MODRON_HEAP_BYTES_PER_HEAPMAP_BYTE"> |
| <meta name="keywords" content="J9MODRON_HEAP_BYTES_PER_HEAPMAP_SLOT"> |
| <meta name="keywords" content="_heapMap"> |
| <meta name="keywords" content="_heapBase"> |
| <meta name="keywords" content="_heapTop"> |
| <meta name="keywords" content="_heapMapBits"> |
| <meta name="keywords" content="_maxOffset"> |
| <meta name="keywords" content="_heapMapIndexShift"> |
| <meta name="keywords" content="_heapMapBitMask"> |
| <meta name="keywords" content="_heapMapBitShift"> |
| <meta name="keywords" content="from()"> |
| <meta name="keywords" content="fromHeapMap()"> |
| <meta name="keywords" content="getHeapMap()"> |
| <meta name="keywords" content="getHeapBase()"> |
| <meta name="keywords" content="getHeapMapBits()"> |
| <meta name="keywords" content="getHeapTop()"> |
| <meta name="keywords" content="getObjectGrain()"> |
| <meta name="keywords" content="getPageSize()"> |
| <meta name="keywords" content="getSlotIndexAndMask()"> |
| <meta name="keywords" content="isBitSet()"> |
| <meta name="keywords" content="isMarked()"> |
| <meta name="keywords" content="isBitSetNoCheck()"> |
| <meta name="keywords" content="queryObject()"> |
| <meta name="keywords" content="queryRange()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 18</strong></div></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/GCHeapMap.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li><a href="#field-detail">Field</a></li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../../module-summary.html">openj9.dtfj</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.j9ddr.vm29.j9.gc</a></div> |
| <h1 title="Class GCHeapMap" class="title">Class GCHeapMap</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.j9ddr.vm29.j9.gc.GCHeapMap</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="GCMarkMap.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCMarkMap</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">GCHeapMap</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="GCHeapMap.MarkedObject.html" class="type-name-link" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap.MarkedObject</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#_heapBase" class="member-name-link">_heapBase</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer</code></div> |
| <div class="col-second odd-row-color"><code><a href="#_heapMap" class="member-name-link">_heapMap</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#_heapMapBitMask" class="member-name-link">_heapMapBitMask</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../../pointer/UDATAPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">UDATAPointer</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_heapMapBits" class="member-name-link">_heapMapBits</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#_heapMapBitShift" class="member-name-link">_heapMapBitShift</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_heapMapIndexShift" class="member-name-link">_heapMapIndexShift</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#_heapTop" class="member-name-link">_heapTop</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_maxOffset" class="member-name-link">_maxOffset</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#BITS_IN_BYTES" class="member-name-link">BITS_IN_BYTES</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#J9BITS_BITS_IN_SLOT" class="member-name-link">J9BITS_BITS_IN_SLOT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#J9MODRON_HEAP_BYTES_PER_HEAPMAP_BIT" class="member-name-link">J9MODRON_HEAP_BYTES_PER_HEAPMAP_BIT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#J9MODRON_HEAP_BYTES_PER_HEAPMAP_BYTE" class="member-name-link">J9MODRON_HEAP_BYTES_PER_HEAPMAP_BYTE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#J9MODRON_HEAP_BYTES_PER_HEAPMAP_SLOT" class="member-name-link">J9MODRON_HEAP_BYTES_PER_HEAPMAP_SLOT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#J9MODRON_HEAP_SLOTS_PER_HEAPMAP_SLOT" class="member-name-link">J9MODRON_HEAP_SLOTS_PER_HEAPMAP_SLOT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer)" class="member-name-link">GCHeapMap</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer heapMap)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="GCHeapMap.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#from()" class="member-name-link">from</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="GCHeapMap.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromHeapMap(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer)" class="member-name-link">fromHeapMap</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer heapMap)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeapBase()" class="member-name-link">getHeapBase</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeapMap()" class="member-name-link">getHeapMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../pointer/UDATAPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">UDATAPointer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeapMapBits()" class="member-name-link">getHeapMapBits</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeapTop()" class="member-name-link">getHeapTop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectGrain()" class="member-name-link">getObjectGrain</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPageSize(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">getPageSize</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSlotIndexAndMask(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">getSlotIndexAndMask</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the index into the heap map bits array and the bitmask to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isBitSet(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">isBitSet</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer address)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Check if a bit is set in the GCHeapMap</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isBitSetNoCheck(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">isBitSetNoCheck</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Check if a bit is set without checking the pointer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMarked(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">isMarked</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer address)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Check if a bit is set in the GCHeapMap.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GCHeapMap.MarkedObject.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap.MarkedObject</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">queryObject</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Query the mark map to see if the specified object is found.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GCHeapMap.MarkedObject.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap.MarkedObject</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryRange(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer,com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)" class="member-name-link">queryRange</a><wbr>(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer base, |
| com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer top)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Query the mark map to see what objects are marked within the specified range.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="J9BITS_BITS_IN_SLOT"> |
| <h3>J9BITS_BITS_IN_SLOT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name">J9BITS_BITS_IN_SLOT</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BITS_IN_BYTES"> |
| <h3>BITS_IN_BYTES</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name">BITS_IN_BYTES</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#com.ibm.j9ddr.vm29.j9.gc.GCHeapMap.BITS_IN_BYTES">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="J9MODRON_HEAP_SLOTS_PER_HEAPMAP_SLOT"> |
| <h3>J9MODRON_HEAP_SLOTS_PER_HEAPMAP_SLOT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">J9MODRON_HEAP_SLOTS_PER_HEAPMAP_SLOT</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="J9MODRON_HEAP_BYTES_PER_HEAPMAP_BIT"> |
| <h3>J9MODRON_HEAP_BYTES_PER_HEAPMAP_BIT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">J9MODRON_HEAP_BYTES_PER_HEAPMAP_BIT</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="J9MODRON_HEAP_BYTES_PER_HEAPMAP_BYTE"> |
| <h3>J9MODRON_HEAP_BYTES_PER_HEAPMAP_BYTE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">J9MODRON_HEAP_BYTES_PER_HEAPMAP_BYTE</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="J9MODRON_HEAP_BYTES_PER_HEAPMAP_SLOT"> |
| <h3>J9MODRON_HEAP_BYTES_PER_HEAPMAP_SLOT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">J9MODRON_HEAP_BYTES_PER_HEAPMAP_SLOT</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapMap"> |
| <h3>_heapMap</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer</span> <span class="element-name">_heapMap</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapBase"> |
| <h3>_heapBase</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">_heapBase</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapTop"> |
| <h3>_heapTop</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">_heapTop</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapMapBits"> |
| <h3>_heapMapBits</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../pointer/UDATAPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">UDATAPointer</a></span> <span class="element-name">_heapMapBits</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_maxOffset"> |
| <h3>_maxOffset</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">_maxOffset</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapMapIndexShift"> |
| <h3>_heapMapIndexShift</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">_heapMapIndexShift</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapMapBitMask"> |
| <h3>_heapMapBitMask</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">_heapMapBitMask</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_heapMapBitShift"> |
| <h3>_heapMapBitShift</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a></span> <span class="element-name">_heapMapBitShift</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer)"> |
| <h3>GCHeapMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GCHeapMap</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer heapMap)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="from()"> |
| <h3>from</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GCHeapMap.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap</a></span> <span class="element-name">from</span>() |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromHeapMap(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer)"> |
| <h3>fromHeapMap</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GCHeapMap.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap</a></span> <span class="element-name">fromHeapMap</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer heapMap)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapMap()"> |
| <h3>getHeapMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ibm.j9ddr.vm29.pointer.generated.MM_HeapMapPointer</span> <span class="element-name">getHeapMap</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapBase()"> |
| <h3>getHeapBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">getHeapBase</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapMapBits()"> |
| <h3>getHeapMapBits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../pointer/UDATAPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">UDATAPointer</a></span> <span class="element-name">getHeapMapBits</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapTop()"> |
| <h3>getHeapTop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../pointer/VoidPointer.html" title="class in com.ibm.j9ddr.vm29.pointer">VoidPointer</a></span> <span class="element-name">getHeapTop</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectGrain()"> |
| <h3>getObjectGrain</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getObjectGrain</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPageSize(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>getPageSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getPageSize</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSlotIndexAndMask(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>getSlotIndexAndMask</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/UDATA.html" title="class in com.ibm.j9ddr.vm29.types">UDATA</a>[]</span> <span class="element-name">getSlotIndexAndMask</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</span></div> |
| <div class="block">Return the index into the heap map bits array and the bitmask to use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - </dd> |
| <dt>Returns:</dt> |
| <dd>an array containing the slot index and bit mask</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBitSet(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>isBitSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isBitSet</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer address)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Check if a bit is set in the GCHeapMap</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - Must be a pointer into the heap. The pointer must point to |
| committed heap memory.</dd> |
| <dt>Returns:</dt> |
| <dd>True if the bit is set. False otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMarked(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>isMarked</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMarked</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer address)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Check if a bit is set in the GCHeapMap. Differs from isBitSet(J9Object) |
| in that it will return true if the address is not in the heap.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>address</code> - An address. If the address is not in the Heap, will return |
| True.</dd> |
| <dt>Returns:</dt> |
| <dd>True if the bit is set. True if the address of the object is not |
| in the heap. False otherwise.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBitSetNoCheck(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>isBitSetNoCheck</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isBitSetNoCheck</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Check if a bit is set without checking the pointer. Will throw an |
| exception if the pointer is forces HeapMap to read from uncommitted |
| memory.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - </dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="queryObject(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>queryObject</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GCHeapMap.MarkedObject.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap.MarkedObject</a></span> <span class="element-name">queryObject</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer object)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Query the mark map to see if the specified object is found. |
| If so return a MarkedObject describing it, otherwise null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - The object to query</dd> |
| <dt>Returns:</dt> |
| <dd>A MarkedObject, or null</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="queryRange(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer,com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer)"> |
| <h3>queryRange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GCHeapMap.MarkedObject.html" title="class in com.ibm.j9ddr.vm29.j9.gc">GCHeapMap.MarkedObject</a>[]</span> <span class="element-name">queryRange</span><wbr><span class="parameters">(com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer base, |
| com.ibm.j9ddr.vm29.pointer.generated.J9ObjectPointer top)</span> |
| throws <span class="exceptions"><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></span></div> |
| <div class="block">Query the mark map to see what objects are marked within the specified range. |
| Return an array of MarkedObject records describing each entry found.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>base</code> - Bottom of the range to query (inclusive)</dd> |
| <dd><code>top</code> - Top of the range to query (exclusive)</dd> |
| <dt>Returns:</dt> |
| <dd>A MarkedObject[] containing the results</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../../CorruptDataException.html" title="class in com.ibm.j9ddr">CorruptDataException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2022 IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |