Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk16 / openj9.cuda / com / ibm / cuda / CudaFunction.html
blob: 1c9a9d54dbd41e85b021d3caa3c824defdd8c5f5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>CudaFunction (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: CudaFunction">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.cuda.CudaFunction class">
<meta name="keywords" content="ATTRIBUTE_BINARY_VERSION">
<meta name="keywords" content="ATTRIBUTE_CONST_SIZE_BYTES">
<meta name="keywords" content="ATTRIBUTE_LOCAL_SIZE_BYTES">
<meta name="keywords" content="ATTRIBUTE_MAX_THREADS_PER_BLOCK">
<meta name="keywords" content="ATTRIBUTE_NUM_REGS">
<meta name="keywords" content="ATTRIBUTE_PTX_VERSION">
<meta name="keywords" content="ATTRIBUTE_SHARED_SIZE_BYTES">
<meta name="keywords" content="getAttribute()">
<meta name="keywords" content="setCacheConfig()">
<meta name="keywords" content="setSharedMemConfig()">
<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/CudaFunction.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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 CudaFunction" class="title">Class CudaFunction</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.CudaFunction</div>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CudaFunction</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></span></div>
<div class="block">The <code>CudaFunction</code> class represents a kernel entry point found in
a specific <code>CudaModule</code> loaded on a CUDA-capable device.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== 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>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_BINARY_VERSION">ATTRIBUTE_BINARY_VERSION</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">The binary architecture version for which the function was compiled.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_CONST_SIZE_BYTES">ATTRIBUTE_CONST_SIZE_BYTES</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">The size in bytes of user-allocated constant memory required by this
function.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_LOCAL_SIZE_BYTES">ATTRIBUTE_LOCAL_SIZE_BYTES</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">The size in bytes of local memory used by each thread of this function.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_MAX_THREADS_PER_BLOCK">ATTRIBUTE_MAX_THREADS_PER_BLOCK</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">The maximum number of threads per block, beyond which a launch of the
function would fail.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_NUM_REGS">ATTRIBUTE_NUM_REGS</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">The number of registers used by each thread of this function.</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_PTX_VERSION">ATTRIBUTE_PTX_VERSION</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">The PTX virtual architecture version for which the function was
compiled.</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#ATTRIBUTE_SHARED_SIZE_BYTES">ATTRIBUTE_SHARED_SIZE_BYTES</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">The size in bytes of statically-allocated shared memory required by
this function.</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>int</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="#getAttribute(int)">getAttribute</a></span>&#8203;(int&nbsp;attribute)</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 value of the specified @{code attribute}.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>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="#setCacheConfig(com.ibm.cuda.CudaDevice.CacheConfig)">setCacheConfig</a></span>&#8203;(<a href="CudaDevice.CacheConfig.html" title="enum class in com.ibm.cuda">CudaDevice.CacheConfig</a>&nbsp;config)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Configures the cache for this function.</div>
</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="#setSharedMemConfig(com.ibm.cuda.CudaDevice.SharedMemConfig)">setSharedMemConfig</a></span>&#8203;(<a href="CudaDevice.SharedMemConfig.html" title="enum class in com.ibm.cuda">CudaDevice.SharedMemConfig</a>&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Configures the shared memory of this function.</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#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">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="ATTRIBUTE_BINARY_VERSION">
<h3>ATTRIBUTE_BINARY_VERSION</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_BINARY_VERSION</span></div>
<div class="block">The binary architecture version for which the function was compiled.
This value is the major binary version * 10 + the minor binary version,
so a binary version 1.3 function would return the value 13. Note that
this will return a value of 10 for legacy cubins that do not have a
properly-encoded binary architecture version.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_BINARY_VERSION">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ATTRIBUTE_CONST_SIZE_BYTES">
<h3>ATTRIBUTE_CONST_SIZE_BYTES</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_CONST_SIZE_BYTES</span></div>
<div class="block">The size in bytes of user-allocated constant memory required by this
function.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_CONST_SIZE_BYTES">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ATTRIBUTE_LOCAL_SIZE_BYTES">
<h3>ATTRIBUTE_LOCAL_SIZE_BYTES</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_LOCAL_SIZE_BYTES</span></div>
<div class="block">The size in bytes of local memory used by each thread of this function.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_LOCAL_SIZE_BYTES">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ATTRIBUTE_MAX_THREADS_PER_BLOCK">
<h3>ATTRIBUTE_MAX_THREADS_PER_BLOCK</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_MAX_THREADS_PER_BLOCK</span></div>
<div class="block">The maximum number of threads per block, beyond which a launch of the
function would fail. This number depends on both the function and the
device on which the function is currently loaded.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_MAX_THREADS_PER_BLOCK">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ATTRIBUTE_NUM_REGS">
<h3>ATTRIBUTE_NUM_REGS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_NUM_REGS</span></div>
<div class="block">The number of registers used by each thread of this function.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_NUM_REGS">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ATTRIBUTE_PTX_VERSION">
<h3>ATTRIBUTE_PTX_VERSION</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_PTX_VERSION</span></div>
<div class="block">The PTX virtual architecture version for which the function was
compiled. This value is the major PTX version * 10 + the minor PTX
version, so a PTX version 1.3 function would return the value 13.
Note that this may return the undefined value of 0 for cubins
compiled prior to CUDA 3.0.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_PTX_VERSION">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ATTRIBUTE_SHARED_SIZE_BYTES">
<h3>ATTRIBUTE_SHARED_SIZE_BYTES</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ATTRIBUTE_SHARED_SIZE_BYTES</span></div>
<div class="block">The size in bytes of statically-allocated shared memory required by
this function. This does not include dynamically-allocated shared
memory requested by the user at runtime.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../constant-values.html#com.ibm.cuda.CudaFunction.ATTRIBUTE_SHARED_SIZE_BYTES">Constant Field Values</a></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="getAttribute(int)">
<h3>getAttribute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getAttribute</span>&#8203;<span class="parameters">(int&nbsp;attribute)</span>
throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div>
<div class="block">Returns the value of the specified @{code attribute}.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>attribute</code> - the attribute to be queried (see ATTRIBUTE_XXX)</dd>
<dt>Returns:</dt>
<dd>the attribute value</dd>
<dt>Throws:</dt>
<dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCacheConfig(com.ibm.cuda.CudaDevice.CacheConfig)">
<h3>setCacheConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCacheConfig</span>&#8203;<span class="parameters">(<a href="CudaDevice.CacheConfig.html" title="enum class in com.ibm.cuda">CudaDevice.CacheConfig</a>&nbsp;config)</span>
throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div>
<div class="block">Configures the cache for this function.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - the desired cache configuration</dd>
<dt>Throws:</dt>
<dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setSharedMemConfig(com.ibm.cuda.CudaDevice.SharedMemConfig)">
<h3>setSharedMemConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSharedMemConfig</span>&#8203;<span class="parameters">(<a href="CudaDevice.SharedMemConfig.html" title="enum class in com.ibm.cuda">CudaDevice.SharedMemConfig</a>&nbsp;config)</span>
throws <span class="exceptions"><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></span></div>
<div class="block">Configures the shared memory of this function.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - the desired shared memory configuration</dd>
<dt>Throws:</dt>
<dd><code><a href="CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</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>