blob: aa6979ca01f4039e44e0d4258617c3a9dead0ad7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>J9MemTagIterator (OpenJ9 JDK 11)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="com.ibm.j9ddr.vm29.j9.walkers.J9MemTagIterator class">
<meta name="keywords" content="hasNext()">
<meta name="keywords" content="moveCurrentSearchAddress()">
<meta name="keywords" content="isFooterCorrupted()">
<meta name="keywords" content="next()">
<meta name="keywords" content="remove()">
<meta name="keywords" content="iterateHeaders()">
<meta name="keywords" content="iterateAllocatedHeaders()">
<meta name="keywords" content="iterateFreedHeaders()">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="J9MemTagIterator (OpenJ9 JDK 11)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" 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="navBarCell1Rev">Class</li>
<li><a href="class-use/J9MemTagIterator.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">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.ibm.j9ddr.vm29.j9.walkers</a></div>
<h2 title="Class J9MemTagIterator" class="title">Class J9MemTagIterator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.ibm.j9ddr.vm29.j9.walkers.J9MemTagIterator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9MemTagPointer&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">J9MemTagIterator</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a>&lt;com.ibm.j9ddr.vm29.pointer.generated.J9MemTagPointer&gt;</pre>
<div class="block">Iterator encapsulating the knowledge of how to search for J9-malloc'd sections in
memory.
Iterates over header tags. Use J9MemTagHelper to get from headers to footers and vice-versa.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFooterCorrupted()">isFooterCorrupted</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateAllocatedHeaders()">iterateAllocatedHeaders</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateAllocatedHeaders(long,long)">iterateAllocatedHeaders</a></span>&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateFreedHeaders()">iterateFreedHeaders</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateFreedHeaders(long)">iterateFreedHeaders</a></span>&#8203;(long&nbsp;baseAddress)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateFreedHeaders(long,long)">iterateFreedHeaders</a></span>&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateHeaders(long,long,long,long)">iterateHeaders</a></span>&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress,
long&nbsp;headerEyecatcher,
long&nbsp;footerEyecatcher)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterateHeaders(long,long,long,long,boolean)">iterateHeaders</a></span>&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress,
long&nbsp;headerEyecatcher,
long&nbsp;footerEyecatcher,
boolean&nbsp;lookingForFreedCallSites)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveCurrentSearchAddress(long)">moveCurrentSearchAddress</a></span>&#8203;(long&nbsp;jumpSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink" target="_blank">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.util.Iterator">
<!-- -->
</a>
<h3>Methods declared in interface&nbsp;java.util.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink" target="_blank">Iterator</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true#forEachRemaining(java.util.function.Consumer)" title="class or interface in java.util" class="externalLink" target="_blank">forEachRemaining</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util" class="externalLink" target="_blank">hasNext</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util" class="externalLink" target="_blank">next</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html?is-external=true#remove()" title="class or interface in java.util" class="externalLink" target="_blank">remove</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="moveCurrentSearchAddress(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveCurrentSearchAddress</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;moveCurrentSearchAddress&#8203;(long&nbsp;jumpSize)</pre>
</li>
</ul>
<a id="isFooterCorrupted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFooterCorrupted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFooterCorrupted()</pre>
</li>
</ul>
<a id="iterateHeaders(long,long,long,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateHeaders&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress,
long&nbsp;headerEyecatcher,
long&nbsp;footerEyecatcher)</pre>
</li>
</ul>
<a id="iterateHeaders(long,long,long,long,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateHeaders&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress,
long&nbsp;headerEyecatcher,
long&nbsp;footerEyecatcher,
boolean&nbsp;lookingForFreedCallSites)</pre>
</li>
</ul>
<a id="iterateAllocatedHeaders(long,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateAllocatedHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateAllocatedHeaders&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress)</pre>
</li>
</ul>
<a id="iterateAllocatedHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateAllocatedHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateAllocatedHeaders()</pre>
</li>
</ul>
<a id="iterateFreedHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateFreedHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateFreedHeaders()</pre>
</li>
</ul>
<a id="iterateFreedHeaders(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterateFreedHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateFreedHeaders&#8203;(long&nbsp;baseAddress)</pre>
</li>
</ul>
<a id="iterateFreedHeaders(long,long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>iterateFreedHeaders</h4>
<pre class="methodSignature">public static&nbsp;<a href="J9MemTagIterator.html" title="class in com.ibm.j9ddr.vm29.j9.walkers">J9MemTagIterator</a>&nbsp;iterateFreedHeaders&#8203;(long&nbsp;baseAddress,
long&nbsp;topAddress)</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" 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="navBarCell1Rev">Class</li>
<li><a href="class-use/J9MemTagIterator.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">Help</a></li>
</ul>
<div class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</body>
</html>