blob: e9ca3cfe4fa1cd4515b219d70c293622b19aba34 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CudaLinker (OpenJ9 CUDA Classes)</title>
<meta name="keywords" content="com.ibm.cuda.CudaLinker class">
<meta name="keywords" content="add()">
<meta name="keywords" content="complete()">
<meta name="keywords" content="destroy()">
<meta name="keywords" content="getErrorLogBuffer()">
<meta name="keywords" content="getInfoLogBuffer()">
<meta name="keywords" content="getWallTime()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CudaLinker (OpenJ9 CUDA Classes)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/ibm/cuda/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CudaLinker.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 CUDA Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/ibm/cuda/CudaKernel.Parameters.html" title="class in com.ibm.cuda"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/ibm/cuda/CudaModule.html" title="class in com.ibm.cuda"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/ibm/cuda/CudaLinker.html" target="_top">Frames</a></li>
<li><a href="CudaLinker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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="subNavList">
<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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ibm.cuda</div>
<h2 title="Class CudaLinker" class="title">Class CudaLinker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.ibm.cuda.CudaLinker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">CudaLinker</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a></pre>
<div class="block">The <code>CudaLinker</code> class supports combining one or more code fragments
to form a module that can be then loaded on a CUDA-capable device.
<p>
When no longer required, a linker must be destroyed (see <a href="../../../com/ibm/cuda/CudaLinker.html#destroy--"><code>destroy()</code></a>).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#CudaLinker-com.ibm.cuda.CudaDevice-">CudaLinker</a></span>(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device)</code>
<div class="block">Creates a new linker for the specified <code>device</code>
using default options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#CudaLinker-com.ibm.cuda.CudaDevice-com.ibm.cuda.CudaJitOptions-">CudaLinker</a></span>(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device,
<a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a>&nbsp;options)</code>
<div class="block">Creates a new linker for the specified <code>device</code>
using the specified <code>options</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#add-com.ibm.cuda.CudaJitInputType-byte:A-java.lang.String-">add</a></span>(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the default options.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#add-com.ibm.cuda.CudaJitInputType-byte:A-java.lang.String-com.ibm.cuda.CudaJitOptions-">add</a></span>(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a>&nbsp;options)</code>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the specified options.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#add-com.ibm.cuda.CudaJitInputType-java.io.InputStream-java.lang.String-">add</a></span>(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" target="_blank" title="class or interface in java.io">InputStream</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the default options.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#add-com.ibm.cuda.CudaJitInputType-java.io.InputStream-java.lang.String-com.ibm.cuda.CudaJitOptions-">add</a></span>(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" target="_blank" title="class or interface in java.io">InputStream</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a>&nbsp;options)</code>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the default options.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#complete--">complete</a></span>()</code>
<div class="block">Completes the module under construction and return an image suitable
for loading.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#destroy--">destroy</a></span>()</code>
<div class="block">Destroys this linker, releasing associated resources.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#getErrorLogBuffer--">getErrorLogBuffer</a></span>()</code>
<div class="block">Returns the contents of the error log.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#getInfoLogBuffer--">getInfoLogBuffer</a></span>()</code>
<div class="block">Returns the contents of the information log.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaLinker.html#getWallTime--">getWallTime</a></span>()</code>
<div class="block">Answers the total elapsed time, in milliseconds,
spent in the compiler and linker.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CudaLinker-com.ibm.cuda.CudaDevice-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CudaLinker</h4>
<pre>public&nbsp;CudaLinker(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Creates a new linker for the specified <code>device</code>
using default options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>device</code> - the device on which the resulting module is to be loaded</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</li>
</ul>
<a name="CudaLinker-com.ibm.cuda.CudaDevice-com.ibm.cuda.CudaJitOptions-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CudaLinker</h4>
<pre>public&nbsp;CudaLinker(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device,
<a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a>&nbsp;options)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Creates a new linker for the specified <code>device</code>
using the specified <code>options</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>device</code> - the device on which the resulting module is to be loaded</dd>
<dd><code>options</code> - the desired options, or null for the default options</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add-com.ibm.cuda.CudaJitInputType-byte:A-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;<a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a>&nbsp;add(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the default options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of input data</dd>
<dd><code>data</code> - the content of the new code fragment</dd>
<dd><code>name</code> - the name to be used in log messages in reference to this code fragment</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this linker object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this linker has been destroyed (see <a href="../../../com/ibm/cuda/CudaLinker.html#destroy--"><code>destroy()</code></a>)</dd>
</dl>
</li>
</ul>
<a name="add-com.ibm.cuda.CudaJitInputType-byte:A-java.lang.String-com.ibm.cuda.CudaJitOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;<a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a>&nbsp;add(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a>&nbsp;options)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the specified options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of input data</dd>
<dd><code>data</code> - the content of the new code fragment</dd>
<dd><code>name</code> - the name to be used in log messages in reference to this code fragment</dd>
<dd><code>options</code> - the desired options</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this linker object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this linker has been destroyed (see <a href="../../../com/ibm/cuda/CudaLinker.html#destroy--"><code>destroy()</code></a>)</dd>
</dl>
</li>
</ul>
<a name="add-com.ibm.cuda.CudaJitInputType-java.io.InputStream-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;<a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a>&nbsp;add(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" target="_blank" title="class or interface in java.io">InputStream</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io">IOException</a></pre>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the default options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of input data</dd>
<dd><code>input</code> - the content of the new code fragment</dd>
<dd><code>name</code> - the name to be used in log messages in reference to this code fragment</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this linker object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this linker has been destroyed (see <a href="../../../com/ibm/cuda/CudaLinker.html#destroy--"><code>destroy()</code></a>)</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs reading <code>input</code></dd>
</dl>
</li>
</ul>
<a name="add-com.ibm.cuda.CudaJitInputType-java.io.InputStream-java.lang.String-com.ibm.cuda.CudaJitOptions-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;<a href="../../../com/ibm/cuda/CudaLinker.html" title="class in com.ibm.cuda">CudaLinker</a>&nbsp;add(<a href="../../../com/ibm/cuda/CudaJitInputType.html" title="enum in com.ibm.cuda">CudaJitInputType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" target="_blank" title="class or interface in java.io">InputStream</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../com/ibm/cuda/CudaJitOptions.html" title="class in com.ibm.cuda">CudaJitOptions</a>&nbsp;options)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io">IOException</a></pre>
<div class="block">Adds a new code fragment to be linked into the module under construction
using the default options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the type of input data</dd>
<dd><code>input</code> - the content of the new code fragment</dd>
<dd><code>name</code> - the name to be used in log messages in reference to this code fragment</dd>
<dd><code>options</code> - the desired options</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this linker object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this linker has been destroyed (see <a href="../../../com/ibm/cuda/CudaLinker.html#destroy--"><code>destroy()</code></a>)</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" target="_blank" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs reading <code>input</code></dd>
</dl>
</li>
</ul>
<a name="complete--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>complete</h4>
<pre>public&nbsp;byte[]&nbsp;complete()
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Completes the module under construction and return an image suitable
for loading.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the image suitable for loading</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this linker has been destroyed (see <a href="../../../com/ibm/cuda/CudaLinker.html#destroy--"><code>destroy()</code></a>)</dd>
</dl>
</li>
</ul>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public&nbsp;void&nbsp;destroy()
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Destroys this linker, releasing associated resources.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</li>
</ul>
<a name="getErrorLogBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorLogBuffer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;getErrorLogBuffer()</pre>
<div class="block">Returns the contents of the error log.
<p>
The result will be empty unless this linker was created with options
which specified a positive error log buffer size
(see <a href="../../../com/ibm/cuda/CudaJitOptions.html#setErrorLogBufferSize-int-"><code>CudaJitOptions.setErrorLogBufferSize(int)</code></a>)
and errors were reported.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the contents of the error log</dd>
</dl>
</li>
</ul>
<a name="getInfoLogBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfoLogBuffer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;getInfoLogBuffer()</pre>
<div class="block">Returns the contents of the information log.
<p>
The result will be empty unless this linker was created with options
which specified a positive information log buffer size
(see <a href="../../../com/ibm/cuda/CudaJitOptions.html#setInfoLogBufferSize-int-"><code>CudaJitOptions.setInfoLogBufferSize(int)</code></a>)
and informational messages were reported.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the contents of the information log</dd>
</dl>
</li>
</ul>
<a name="getWallTime--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWallTime</h4>
<pre>public&nbsp;float&nbsp;getWallTime()</pre>
<div class="block">Answers the total elapsed time, in milliseconds,
spent in the compiler and linker.
<p>
Applies to: compiler and linker.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total elapsed time, in milliseconds, spent in the compiler and linker</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/ibm/cuda/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CudaLinker.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 CUDA Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/ibm/cuda/CudaKernel.Parameters.html" title="class in com.ibm.cuda"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/ibm/cuda/CudaModule.html" title="class in com.ibm.cuda"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/ibm/cuda/CudaLinker.html" target="_top">Frames</a></li>
<li><a href="CudaLinker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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="subNavList">
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<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; 2013, 2021, IBM Corp. and others.</small></p>
</body>
</html>