blob: 2ca6dcacc3c571c67c3d0f542e8e48ad7169f12f [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style xmlns="" type="text/css">
/* This style sets a margin around the entire page */
html, body {
margin: 10px;
}
p {
font: normal 16px verdana, sans-serif;
margin: 0;
padding-bottom:12px;
}
h1 {
font: bold 25px verdana, sans-serif;
margin-top: 0;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h2 {
font: bold 19px verdana, sans-serif;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h3 {
font: bold 19px verdana, sans-serif !important;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
li {
font: normal 16px verdana, sans-serif;
margin-top: 0;
margin-bottom: 18px;
padding-top: 0;
padding-bottom: 0;
}
.pdparam {
font: italic 16px verdana, sans-serif;
}
.term {
font: italic 16px verdana, sans-serif;
font-weight: normal;
}
.type {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
a:link, a:visited {
color: blue;
text-decoration: none;
font: normal 16px;
}
a:hover {
background-color: #FFFF99;
font: normal 16px;
}
div.funcsynopsis {
text-align: left;
background-color: #e6e6e6;
font: normal 16px verdana, sans-serif;
padding-top: 10px;
padding-bottom: 10px;
}
div.funcsynopsis table {
border-collapse: separate;
font: normal 16px verdana, sans-serif;
}
div.funcsynopsis td {
background-color: #e6e6e6;
border: 0 solid #000;
padding: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 {
font-family: verdana, sans-serif;
font-size: 16px;
}
code.constant {
font: normal 16px courier new, monospace !important;
}
span.errorname {
font: normal 16px verdana, sans-serif !important;
}
code.function {
font: bold 16px verdana, sans-serif !important;
}
b.fsfunc {
font: bold 16px verdana, sans-serif !important;
}
code.varname {
font: italic 16px verdana, sans-serif;
}
code.replaceable {
font: italic 16px courier new, monospace;
}
code.funcdef {
font: normal 16px verdana, sans-serif !important;
}
.citerefentry {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
code.fsfunc {
font: normal 16px verdana, sans-serif !important;
}
/* PARAMETER: This style controls spacing between the terms in Parameter section */
dt {
margin-top: 15px;
}
/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
div.refsect1 table {
width: 100%;
margin-top: 10px;
background-color: #FFF;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 th {
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: bold 16px verdana, sans-serif;
}
div.refsect1 td {
background-color: #FFF;
padding: 5px;
vertical-align: text-top;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 p{
font: normal 16px verdana, sans-serif;
margin-top: 8px;
margin-bottom: 8px;
padding-top: 0;
padding-bottom: 0;
}
/* EXAMPLE: These styles apply only to the Example section */
div.refsect2 {
font: normal 16px courier new, monospace !important;
}
div.refsect2 table {
margin-top: 0;
background-color: #e6e6e6;
width: 100%;
border: 0 solid #000;
padding: 2px;
font: normal 16px courier new, monospace !important;
}
div.refsect2 td {
background-color: #e6e6e6;
font: normal 16px courier new, monospace !important;
white-space:pre;
}
/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
div.refsect3 {
font: normal 11px verdana, sans-serif;
margin-top: 50px;
margin-bottom: 20px;
padding-top: 0;
padding-bottom: 0;
}
</style>
<title>Atomic Functions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
<meta name="keywords" content="Atomic Functions" />
</head>
<body>
<div class="refentry">
<a id="id-1"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<h1>Atomic Functions</h1>
<p>
The atomic functions are shown below.
Click an item in the table below for details about that function.
</p>
</div>
<div class="refsect1">
<a id="springboard"></a>
<h2></h2>
<div class="informaltable">
<table border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
<col align="left" class="col3" />
<col align="left" class="col4" />
</colgroup>
<tbody>
<tr>
<td align="left">
<a class="citerefentry" href="atomic_add.html"><span class="citerefentry"><span class="refentrytitle">atomic_add</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_sub.html"><span class="citerefentry"><span class="refentrytitle">atomic_sub</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_xchg.html"><span class="citerefentry"><span class="refentrytitle">atomic_xchg</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_inc.html"><span class="citerefentry"><span class="refentrytitle">atomic_inc</span></span></a>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="atomic_dec.html"><span class="citerefentry"><span class="refentrytitle">atomic_dec</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_cmpxchg.html"><span class="citerefentry"><span class="refentrytitle">atomic_cmpxchg</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_min.html"><span class="citerefentry"><span class="refentrytitle">atomic_min</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_max.html"><span class="citerefentry"><span class="refentrytitle">atomic_max</span></span></a>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="atomic_and.html"><span class="citerefentry"><span class="refentrytitle">atomic_and</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_or.html"><span class="citerefentry"><span class="refentrytitle">atomic_or</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atomic_xor.html"><span class="citerefentry"><span class="refentrytitle">atomic_xor</span></span></a>
</td>
<td align="left">
</td>
</tr>
</tbody>
</table>
</div>
<p>
The <a class="citerefentry" href="cl_khr_int64_base_atomics.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_int64_base_atomics</span></span></a>
extension enables additional atomic functions using types <span class="type">long</span>
and <span class="type">unsigned long</span>. An application that wants to use
this extension will need to include the <code class="code">#pragma OPENCL EXTENSION
<a class="citerefentry" href="cl_khr_int64_base_atomics.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_int64_base_atomics</span></span></a> :
enable</code> in the OpenCL program source.
</p>
<div class="informaltable">
<table border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
<col align="left" class="col3" />
<col align="left" class="col4" />
</colgroup>
<tbody>
<tr>
<td align="left">
<a class="citerefentry" href="atom_add.html"><span class="citerefentry"><span class="refentrytitle">atom_add</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_sub.html"><span class="citerefentry"><span class="refentrytitle">atom_sub</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_xchg.html"><span class="citerefentry"><span class="refentrytitle">atom_xchg</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_inc.html"><span class="citerefentry"><span class="refentrytitle">atom_inc</span></span></a>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="atom_dec.html"><span class="citerefentry"><span class="refentrytitle">atom_dec</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_cmpxchg.html"><span class="citerefentry"><span class="refentrytitle">atom_cmpxchg</span></span></a>
</td>
<td class="auto-generated"> </td>
<td class="auto-generated"> </td>
</tr>
</tbody>
</table>
</div>
<p>
The <a class="citerefentry" href="cl_khr_int64_extended_atomics.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_int64_extended_atomics</span></span></a>
extension enables additional atomic functions using types <span class="type">long</span>
and <span class="type">unsigned long</span>. An application that wants to use
this extension will need to include the <code class="code">#pragma OPENCL EXTENSION
<a class="citerefentry" href="cl_khr_int64_extended_atomics.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_int64_extended_atomics</span></span></a>
: enable</code> in the OpenCL program source.
</p>
<div class="informaltable">
<table border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
<col align="left" class="col3" />
</colgroup>
<tbody>
<tr>
<td align="left">
<a class="citerefentry" href="atom_min.html"><span class="citerefentry"><span class="refentrytitle">atom_min</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_max.html"><span class="citerefentry"><span class="refentrytitle">atom_max</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_xor.html"><span class="citerefentry"><span class="refentrytitle">atom_xor</span></span></a>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="atom_and.html"><span class="citerefentry"><span class="refentrytitle">atom_and</span></span></a>
</td>
<td align="left">
<a class="citerefentry" href="atom_or.html"><span class="citerefentry"><span class="refentrytitle">atom_or</span></span></a>
</td>
<td class="auto-generated"> </td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
These functions provide atomic operations on 32-bit signed, unsigned
integers and single precision floating-point to locations in <a class="citerefentry" href="global.html"><span class="citerefentry"><span class="refentrytitle">__global</span></span></a> or <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a> memory. Only the
<code class="function">atomic_xchg</code> operation is supported for single precision
floating-point data type.
</p>
<p>
The atomic built-in functions that use the <code class="constant">atom_</code> prefix and are
described in the <a href="http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf#page=10" target="OpenCL Spec">OpenCL Extension Specification</a> and are
enabled by: cl_khr_global_int32_base_atomics, cl_khr_global_int32_extended_atomics,
cl_khr_local_int32_base_atomics, and cl_khr_local_int32_extended_atomics in sections
9.5 and 9.6 of the OpenCL 1.0 specification are also supported. .
</p>
<p>
The 64-bit transactions are atomic for the device executing these atomic functions. There
is no guarantee of atomicity if the atomic operations to the same memory location
are being performed by kernels executing on multiple devices.
</p>
</div>
<div class="refsect1">
<a id="specification"></a>
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
<a href="http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf#page=279" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2011 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
</div>
</body>
</html>