Google Git
Sign in
eclipse / www.eclipse.org / openj9 / docs / 53406771d3b0d31c9b09e343b567ac486a5f2cbd / . / api / jdk16 / openj9.dtfj / com / ibm / j9ddr / tools / ddrinteractive / commands / SnapTraceCommand.html
blob: 714d27416cfafc00af091c888fd0a6817e68381d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>SnapTraceCommand (OpenJ9 JDK 16)</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.tools.ddrinteractive.commands, class: SnapTraceCommand">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.j9ddr.tools.ddrinteractive.commands.SnapTraceCommand class">
<meta name="keywords" content="run()">
<meta name="keywords" content="writeBytesToTrace()">
<meta name="keywords" content="getCStringAtAddress()">
<meta name="keywords" content="writeHeaderBytesToTrace()">
<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">
<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 16</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/SnapTraceCommand.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>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>&nbsp;<a href="../../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.j9ddr.tools.ddrinteractive.commands</a></div>
<h1 title="Class SnapTraceCommand" class="title">Class SnapTraceCommand</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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"><a href="../Command.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">com.ibm.j9ddr.tools.ddrinteractive.Command</a>
<div class="inheritance"><a href="SnapBaseCommand.html" title="class in com.ibm.j9ddr.tools.ddrinteractive.commands">com.ibm.j9ddr.tools.ddrinteractive.commands.SnapBaseCommand</a>
<div class="inheritance">com.ibm.j9ddr.tools.ddrinteractive.commands.SnapTraceCommand</div>
</div>
</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../ICommand.html" title="interface in com.ibm.j9ddr.tools.ddrinteractive">ICommand</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SnapTraceCommand</span>
<span class="extends-implements">extends <a href="SnapBaseCommand.html" title="class in com.ibm.j9ddr.tools.ddrinteractive.commands">SnapBaseCommand</a></span></div>
<div class="block">Debug extension to extract trace buffers from a core dump
so they can be formatted.</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="inherited-list">
<h2 id="nested.classes.inherited.from.class.com.ibm.j9ddr.tools.ddrinteractive.Command">Nested classes/interfaces declared in class&nbsp;com.ibm.j9ddr.tools.ddrinteractive.<a href="../Command.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Command</a></h2>
<code><a href="../Command.CommandDescription.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Command.CommandDescription</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields.inherited.from.class.com.ibm.j9ddr.tools.ddrinteractive.Command">Fields declared in class&nbsp;com.ibm.j9ddr.tools.ddrinteractive.<a href="../Command.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Command</a></h3>
<code><a href="../Command.html#nl">nl</a></code></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><span class="member-name-link"><a href="#%3Cinit%3E()">SnapTraceCommand</a></span>()</code></div>
<div class="col-last even-row-color">&nbsp;</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-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-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#run(java.lang.String,java.lang.String%5B%5D,com.ibm.j9ddr.tools.ddrinteractive.Context,java.io.PrintStream)">run</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;command,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]&nbsp;args,
<a href="../Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Executes the command</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#writeBytesToTrace(com.ibm.j9ddr.tools.ddrinteractive.Context,long,int,java.io.PrintStream)">writeBytesToTrace</a></span>&#8203;(<a href="../Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a>&nbsp;context,
long&nbsp;address,
int&nbsp;bufferSize,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#writeHeaderBytesToTrace(com.ibm.j9ddr.tools.ddrinteractive.Context,byte%5B%5D,java.io.PrintStream)">writeHeaderBytesToTrace</a></span>&#8203;(<a href="../Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a>&nbsp;context,
byte[]&nbsp;headerBytes,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.j9ddr.tools.ddrinteractive.commands.SnapBaseCommand">Methods declared in class&nbsp;com.ibm.j9ddr.tools.ddrinteractive.commands.<a href="SnapBaseCommand.html" title="class in com.ibm.j9ddr.tools.ddrinteractive.commands">SnapBaseCommand</a></h3>
<code><a href="SnapBaseCommand.html#extractTraceData(com.ibm.j9ddr.tools.ddrinteractive.Context,java.io.PrintStream)">extractTraceData</a>, <a href="SnapBaseCommand.html#getCStringAtAddress(com.ibm.j9ddr.corereaders.memory.IProcess,long)">getCStringAtAddress</a>, <a href="SnapBaseCommand.html#getCStringAtAddress(com.ibm.j9ddr.corereaders.memory.IProcess,long,long)">getCStringAtAddress</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.com.ibm.j9ddr.tools.ddrinteractive.Command">Methods declared in class&nbsp;com.ibm.j9ddr.tools.ddrinteractive.<a href="../Command.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Command</a></h3>
<code><a href="../Command.html#addCommand(java.lang.String,java.lang.String,java.lang.String)">addCommand</a>, <a href="../Command.html#addSubCommand(com.ibm.j9ddr.tools.ddrinteractive.Command.CommandDescription,java.lang.String,java.lang.String,java.lang.String)">addSubCommand</a>, <a href="../Command.html#dbgFindPatternInRange(com.ibm.j9ddr.tools.ddrinteractive.Context,byte%5B%5D,int,long,java.math.BigInteger)">dbgFindPatternInRange</a>, <a href="../Command.html#getCommandDescriptions()">getCommandDescriptions</a>, <a href="../Command.html#getCommandNames()">getCommandNames</a>, <a href="../Command.html#printDetailedHelp(java.io.PrintStream)">printDetailedHelp</a>, <a href="../Command.html#recognises(java.lang.String,com.ibm.j9ddr.tools.ddrinteractive.Context)">recognises</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SnapTraceCommand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SnapTraceCommand</span>()</div>
</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="run(java.lang.String,java.lang.String[],com.ibm.j9ddr.tools.ddrinteractive.Context,java.io.PrintStream)">
<h3>run</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">run</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;command,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]&nbsp;args,
<a href="../Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a>&nbsp;context,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span>
throws <span class="exceptions"><a href="../DDRInteractiveCommandException.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">DDRInteractiveCommandException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../ICommand.html#run(java.lang.String,java.lang.String%5B%5D,com.ibm.j9ddr.tools.ddrinteractive.Context,java.io.PrintStream)">ICommand</a></code></span></div>
<div class="block">Executes the command</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>command</code> - Command string e.g. !j9x</dd>
<dd><code>args</code> - Arguments for command</dd>
<dd><code>context</code> - Context to work in</dd>
<dd><code>out</code> - PrintStream to write command output on</dd>
<dt>Throws:</dt>
<dd><code><a href="../DDRInteractiveCommandException.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">DDRInteractiveCommandException</a></code> - If there is any problem running the command (incorrect usage, CorruptData etc.)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="writeBytesToTrace(com.ibm.j9ddr.tools.ddrinteractive.Context,long,int,java.io.PrintStream)">
<h3>writeBytesToTrace</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">writeBytesToTrace</span>&#8203;<span class="parameters">(<a href="../Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a>&nbsp;context,
long&nbsp;address,
int&nbsp;bufferSize,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span></div>
</section>
</li>
<li>
<section class="detail" id="writeHeaderBytesToTrace(com.ibm.j9ddr.tools.ddrinteractive.Context,byte[],java.io.PrintStream)">
<h3>writeHeaderBytesToTrace</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">writeHeaderBytesToTrace</span>&#8203;<span class="parameters">(<a href="../Context.html" title="class in com.ibm.j9ddr.tools.ddrinteractive">Context</a>&nbsp;context,
byte[]&nbsp;headerBytes,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a>&nbsp;out)</span></div>
</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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>