blob: 62a3ce071d08ec1f95facf5b174df139a69fdeac [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>CudaJitOptions (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.cuda, package: com.ibm.cuda, class: CudaJitOptions">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.cuda.CudaJitOptions class">
<meta name="keywords" content="clone()">
<meta name="keywords" content="getErrorLogBuffer()">
<meta name="keywords" content="getInfoLogBuffer()">
<meta name="keywords" content="getThreadsPerBlock()">
<meta name="keywords" content="getWallTime()">
<meta name="keywords" content="recordWallTime()">
<meta name="keywords" content="setCacheMode()">
<meta name="keywords" content="setErrorLogBufferSize()">
<meta name="keywords" content="setGenerateDebugInfo()">
<meta name="keywords" content="setGenerateLineInfo()">
<meta name="keywords" content="setInfoLogBufferSize()">
<meta name="keywords" content="setJitFallbackStrategy()">
<meta name="keywords" content="setLogVerbose()">
<meta name="keywords" content="setMaxRegisters()">
<meta name="keywords" content="setOptimizationLevel()">
<meta name="keywords" content="setTarget()">
<meta name="keywords" content="setTargetFromCuContext()">
<meta name="keywords" content="setThreadsPerBlock()">
<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/CudaJitOptions.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>Field&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.cuda</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.cuda</a></div>
<h1 title="Class CudaJitOptions" class="title">Class CudaJitOptions</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">com.ibm.cuda.CudaJitOptions</div>
</div>
<section class="description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link" target="_blank">Cloneable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CudaJitOptions</span>
<span class="extends-implements">extends <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>
implements <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link" target="_blank">Cloneable</a></span></div>
<div class="block">The <code>CudaJitOptions</code> class represents a set of options that influence
the behavior of linking and loading modules.</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&nbsp;</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="CudaJitOptions.CacheMode.html" title="enum class in com.ibm.cuda">CudaJitOptions.CacheMode</a></span></code></div>
<div class="col-last even-row-color">
<div class="block"><code>CacheMode</code> identifies the cache management choices.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="CudaJitOptions.Fallback.html" title="enum class in com.ibm.cuda">CudaJitOptions.Fallback</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block"><code>Fallback</code> identifies the available fall-back strategies
when an exactly matching object is not available.</div>
</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><span class="member-name-link"><a href="#%3Cinit%3E()">CudaJitOptions</a></span>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new options object.</div>
</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>protected <a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#clone()">clone</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Creates a new options object with the same state as this object.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><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></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="#getErrorLogBuffer()">getErrorLogBuffer</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the contents of the error log.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><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></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="#getInfoLogBuffer()">getInfoLogBuffer</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the contents of the information log.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</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="#getThreadsPerBlock()">getThreadsPerBlock</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the maximum number of threads per block.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>float</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="#getWallTime()">getWallTime</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns the total elapsed time, in milliseconds,
spent in the compiler and linker.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#recordWallTime()">recordWallTime</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Requests recording of the total wall clock time,
in milliseconds, spent in the compiler and linker.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setCacheMode(com.ibm.cuda.CudaJitOptions.CacheMode)">setCacheMode</a></span>&#8203;(<a href="CudaJitOptions.CacheMode.html" title="enum class in com.ibm.cuda">CudaJitOptions.CacheMode</a>&nbsp;mode)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the desired caching behavior (-dlcm).</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setErrorLogBufferSize(int)">setErrorLogBufferSize</a></span>&#8203;(int&nbsp;size)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the size, in bytes, to allocate for capturing error messages.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setGenerateDebugInfo(boolean)">setGenerateDebugInfo</a></span>&#8203;(boolean&nbsp;enabled)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies whether to generate debug information.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setGenerateLineInfo(boolean)">setGenerateLineInfo</a></span>&#8203;(boolean&nbsp;enabled)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies whether to generate line number information.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setInfoLogBufferSize(int)">setInfoLogBufferSize</a></span>&#8203;(int&nbsp;size)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the size, in bytes, to allocate for capturing informational
messages.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setJitFallbackStrategy(com.ibm.cuda.CudaJitOptions.Fallback)">setJitFallbackStrategy</a></span>&#8203;(<a href="CudaJitOptions.Fallback.html" title="enum class in com.ibm.cuda">CudaJitOptions.Fallback</a>&nbsp;strategy)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the fallback strategy if an exactly matching
binary object cannot be found.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setLogVerbose(boolean)">setLogVerbose</a></span>&#8203;(boolean&nbsp;verbose)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies whether to generate verbose log messages.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setMaxRegisters(int)">setMaxRegisters</a></span>&#8203;(int&nbsp;limit)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the maximum number of registers that a thread may use.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setOptimizationLevel(int)">setOptimizationLevel</a></span>&#8203;(int&nbsp;level)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the level of optimization to be applied to generated code
(0 - 4), with 4 being the default and highest level of optimization.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setTarget(com.ibm.cuda.CudaJitTarget)">setTarget</a></span>&#8203;(<a href="CudaJitTarget.html" title="enum class in com.ibm.cuda">CudaJitTarget</a>&nbsp;target)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the desired compute target.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setTargetFromCuContext()">setTargetFromCuContext</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies that the target should be determined based on the current
attached context.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></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="#setThreadsPerBlock(int)">setThreadsPerBlock</a></span>&#8203;(int&nbsp;limit)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Specifies the minimum number of threads per block for compilation.</div>
</div>
</div>
</div>
</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#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>CudaJitOptions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CudaJitOptions</span>()</div>
<div class="block">Creates a new options object.</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="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">clone</span>()</div>
<div class="block">Creates a new options object with the same state as this object.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt>Returns:</dt>
<dd>Object
a shallow copy of this object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getErrorLogBuffer()">
<h3>getErrorLogBuffer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">getErrorLogBuffer</span>()</div>
<div class="block">Returns the contents of the error log.
<p>
The result will be empty unless <a href="#setErrorLogBufferSize(int)"><code>setErrorLogBufferSize(int)</code></a>
was called with a positive value, this object was used in connection
with a <a href="CudaModule.html" title="class in com.ibm.cuda"><code>CudaModule</code></a> or a <a href="CudaLinker.html" title="class in com.ibm.cuda"><code>CudaLinker</code></a>, and errors were
reported.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the contents of the error log</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getInfoLogBuffer()">
<h3>getInfoLogBuffer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">getInfoLogBuffer</span>()</div>
<div class="block">Returns the contents of the information log.
<p>
The result will be empty unless <a href="#setInfoLogBufferSize(int)"><code>setInfoLogBufferSize(int)</code></a>
was called with a positive value, this object was used in connection
with a <a href="CudaModule.html" title="class in com.ibm.cuda"><code>CudaModule</code></a> or a <a href="CudaLinker.html" title="class in com.ibm.cuda"><code>CudaLinker</code></a>, and informational
messages were reported.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the contents of the information log</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getThreadsPerBlock()">
<h3>getThreadsPerBlock</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getThreadsPerBlock</span>()</div>
<div class="block">Returns the maximum number of threads per block.
<p>
The result will only be meaningful if <a href="#setThreadsPerBlock(int)"><code>setThreadsPerBlock(int)</code></a> was
called with a positive value, and this object was used in connection
with a <a href="CudaModule.html" title="class in com.ibm.cuda"><code>CudaModule</code></a> or a <a href="CudaLinker.html" title="class in com.ibm.cuda"><code>CudaLinker</code></a> involving PTX code.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the maximum number of threads per block</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getWallTime()">
<h3>getWallTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">float</span>&nbsp;<span class="element-name">getWallTime</span>()</div>
<div class="block">Returns the total elapsed time, in milliseconds,
spent in the compiler and linker.
<p>
Applies to: compiler and linker.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the total elapsed time, in milliseconds, spent in the compiler and linker</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="recordWallTime()">
<h3>recordWallTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">recordWallTime</span>()</div>
<div class="block">Requests recording of the total wall clock time,
in milliseconds, spent in the compiler and linker.
<p>
Applies to: compiler and linker.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCacheMode(com.ibm.cuda.CudaJitOptions.CacheMode)">
<h3>setCacheMode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setCacheMode</span>&#8203;<span class="parameters">(<a href="CudaJitOptions.CacheMode.html" title="enum class in com.ibm.cuda">CudaJitOptions.CacheMode</a>&nbsp;mode)</span></div>
<div class="block">Specifies the desired caching behavior (-dlcm).
<p>
Applies to compiler only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>mode</code> - the desired caching behavior</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setErrorLogBufferSize(int)">
<h3>setErrorLogBufferSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setErrorLogBufferSize</span>&#8203;<span class="parameters">(int&nbsp;size)</span></div>
<div class="block">Specifies the size, in bytes, to allocate for capturing error messages.
<p>
Applies to compiler and linker.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>size</code> - the size, in bytes, of the error log buffer</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setGenerateDebugInfo(boolean)">
<h3>setGenerateDebugInfo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setGenerateDebugInfo</span>&#8203;<span class="parameters">(boolean&nbsp;enabled)</span></div>
<div class="block">Specifies whether to generate debug information.
<p>
Applies to compiler and linker.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>enabled</code> - whether debug information should be generated</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setGenerateLineInfo(boolean)">
<h3>setGenerateLineInfo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setGenerateLineInfo</span>&#8203;<span class="parameters">(boolean&nbsp;enabled)</span></div>
<div class="block">Specifies whether to generate line number information.
<p>
Applies to compiler only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>enabled</code> - whether line number information should be generated</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setInfoLogBufferSize(int)">
<h3>setInfoLogBufferSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setInfoLogBufferSize</span>&#8203;<span class="parameters">(int&nbsp;size)</span></div>
<div class="block">Specifies the size, in bytes, to allocate for capturing informational
messages.
<p>
Applies to compiler and linker.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>size</code> - the size, in bytes, of the information log buffer</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setJitFallbackStrategy(com.ibm.cuda.CudaJitOptions.Fallback)">
<h3>setJitFallbackStrategy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setJitFallbackStrategy</span>&#8203;<span class="parameters">(<a href="CudaJitOptions.Fallback.html" title="enum class in com.ibm.cuda">CudaJitOptions.Fallback</a>&nbsp;strategy)</span></div>
<div class="block">Specifies the fallback strategy if an exactly matching
binary object cannot be found.
<p>
Applies to: compiler only</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>strategy</code> - the desired fallback strategy</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setLogVerbose(boolean)">
<h3>setLogVerbose</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setLogVerbose</span>&#8203;<span class="parameters">(boolean&nbsp;verbose)</span></div>
<div class="block">Specifies whether to generate verbose log messages.
<p>
Applies to: compiler and linker</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>verbose</code> - whether verbose log messages should be generated</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setMaxRegisters(int)">
<h3>setMaxRegisters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setMaxRegisters</span>&#8203;<span class="parameters">(int&nbsp;limit)</span></div>
<div class="block">Specifies the maximum number of registers that a thread may use.
<p>
Applies to: compiler only</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>limit</code> - the maximum number of registers a thread may use</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setOptimizationLevel(int)">
<h3>setOptimizationLevel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setOptimizationLevel</span>&#8203;<span class="parameters">(int&nbsp;level)</span></div>
<div class="block">Specifies the level of optimization to be applied to generated code
(0 - 4), with 4 being the default and highest level of optimization.
<p>
Applies to compiler only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>level</code> - the desired optimization level</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setTarget(com.ibm.cuda.CudaJitTarget)">
<h3>setTarget</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setTarget</span>&#8203;<span class="parameters">(<a href="CudaJitTarget.html" title="enum class in com.ibm.cuda">CudaJitTarget</a>&nbsp;target)</span></div>
<div class="block">Specifies the desired compute target.
<p>
Cannot be combined with <a href="#setThreadsPerBlock(int)"><code>setThreadsPerBlock(int)</code></a>.
<p>
Applies to compiler and linker.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>target</code> - the desired compute target</dd>
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setTargetFromCuContext()">
<h3>setTargetFromCuContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setTargetFromCuContext</span>()</div>
<div class="block">Specifies that the target should be determined based on the current
attached context.
<p>
Applies to compiler and linker.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>this options object</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setThreadsPerBlock(int)">
<h3>setThreadsPerBlock</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a></span>&nbsp;<span class="element-name">setThreadsPerBlock</span>&#8203;<span class="parameters">(int&nbsp;limit)</span></div>
<div class="block">Specifies the minimum number of threads per block for compilation.
<p>
This restricts the resource utilization of the compiler (e.g. maximum
registers) such that a block with the given number of threads should be
able to launch based on register limitations. Note, this option does not
currently take into account any other resource limitations, such as
shared memory utilization.
<p>
Cannot be combined with <a href="#setTarget(com.ibm.cuda.CudaJitTarget)"><code>setTarget(CudaJitTarget)</code></a>.
<p>
Applies to compiler only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>limit</code> - the desired minimum number of threads per block</dd>
<dt>Returns:</dt>
<dd>this options object</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 &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>