| <?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_flag_test_and_set</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> |
| <meta name="keywords" content="atomic_flag_test_and_set" /> |
| </head> |
| <body> |
| <div class="refentry"> |
| <a id="id-1"></a> |
| <div class="titlepage"></div> |
| <div xmlns="" class="refnamediv"> |
| <a xmlns="http://www.w3.org/1999/xhtml" id="atomic_flag_test_and_set"></a> |
| <h1>atomic_flag_test_and_set functions</h1> |
| <p> |
| Atomically sets the value pointed to by <code xmlns="http://www.w3.org/1999/xhtml" class="varname">object</code> to true. |
| </p> |
| </div> |
| <div class="refsynopsisdiv"> |
| <h2></h2> |
| <div class="funcsynopsis"> |
| <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> |
| <tr valign="bottom"> |
| <td> |
| <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"> |
| <a class="link" href="scalarDataTypes.html" target="pagedisplay">bool</a> |
| <strong class="fsfunc">atomic_flag_test_and_set</strong> |
| (</code> |
| <td>volatile <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="atomic_flag.html" target="pagedisplay">atomic_flag</a> |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*object</var> |
| <code>)</code></td> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="funcsynopsis"> |
| <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> |
| <tr valign="bottom"> |
| <td> |
| <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"> |
| <a class="link" href="scalarDataTypes.html" target="pagedisplay">bool</a> |
| <strong class="fsfunc">atomic_flag_test_and_set_explicit</strong> |
| (</code> |
| <td>volatile <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="atomic_flag.html" target="pagedisplay">atomic_flag</a> |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*object</var> |
| , </td> |
| </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="memory_order.html" target="pagedisplay">memory_order</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">order</var><code>)</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="funcsynopsis"> |
| <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> |
| <tr valign="bottom"> |
| <td> |
| <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"> |
| <a class="link" href="scalarDataTypes.html" target="pagedisplay">bool</a> |
| <strong class="fsfunc">atomic_flag_test_and_set_explicit</strong> |
| (</code> |
| <td>volatile <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="atomic_flag.html" target="pagedisplay">atomic_flag</a> |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*object</var> |
| , </td> |
| </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="memory_order.html" target="pagedisplay">memory_order</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">order</var>, </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="memory_scope.html" target="pagedisplay">memory_scope</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">scope</var><code>)</code></td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="parameters"></a> |
| <h2>Parameters</h2> |
| <div class="variablelist"> |
| <dl class="variablelist"> |
| <dt> |
| <span class="term"> |
| <code class="varname">object</code> |
| </span> |
| </dt> |
| <dd></dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">order</code> |
| </span> |
| </dt> |
| <dd></dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">scope</code> |
| </span> |
| </dt> |
| <dd></dd> |
| </dl> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="description"></a> |
| <h2>Description</h2> |
| <p> |
| Atomically sets the value pointed to by |
| <code class="varname">object</code> to true. Memory is |
| affected according to the |
| value of <code class="varname">order</code>. These |
| operations are atomic read-modify-write operations (as defined by |
| section 5.1.2.4 of the C11 specification). |
| Returns atomically, the value of the object immediately |
| before the effects. |
| </p> |
| <p> |
| In these operation definitions: |
| </p> |
| <p> |
| </p> |
| <div class="itemizedlist"> |
| <ul class="itemizedlist" style="list-style-type: disc; "> |
| <li class="listitem"> |
| An <code class="code">A</code> refers to one of the atomic types. |
| </li> |
| <li class="listitem"> |
| A <code class="code">C</code> refers to its corresponding non-atomic type. |
| </li> |
| <li class="listitem"> |
| An <code class="code">M</code> refers to the type of the other |
| argument for arithmetic operations. For atomic |
| integer types, <code class="code">M</code> is <code class="code">C</code>. |
| </li> |
| <li class="listitem"> |
| The functions not ending in explicit have the same semantics as the corresponding |
| explicit function with <code class="constant">memory_order_seq_cst</code> |
| for the <code class="code">memory_order</code> argument. |
| </li> |
| <li class="listitem"> |
| The functions that do not have <code class="code">memory_scope</code> |
| argument have the same semantics as |
| the corresponding functions with the <code class="code">memory_scope</code> argument set to |
| <code class="constant">memory_scope_device</code>. |
| </li> |
| </ul> |
| </div> |
| <p> |
| </p> |
| <p> |
| NOTE: With fine-grained system SVM, sharing |
| happens at the granularity of individual loads |
| and stores anywhere in host memory. Memory |
| consistency is always guaranteed at |
| synchronization points, but to obtain finer |
| control over consistency, the OpenCL atomics |
| functions may be used to ensure that the updates |
| to individual data values made by one unit of |
| execution are visible to other execution units. |
| In particular, when a host thread needs fine |
| control over the consistency of memory that is |
| shared with one or more OpenCL devices, it must |
| use atomic and fence operations that are |
| compatible with the C11 atomic operations. |
| </p> |
| <p> |
| We can't require C11 atomics since host programs can |
| be implemented in other programming languages and |
| versions of C or C++, but we do require that the host |
| programs use atomics and that those atomics be compatible |
| with those in C11. |
| </p> |
| <h4><a id="id-1.6.7"></a>Restrictions</h4> |
| <p> |
| All operations on atomic types must be performed using the built-in atomic |
| functions. C11 and C++11 support operators on atomic types. OpenCL C does not |
| support operators with atomic types. Using atomic types with operators should result in a |
| compilation error. |
| </p> |
| <p> |
| The <span class="type">atomic_bool</span>, <span class="type">atomic_char</span>, |
| <span class="type">atomic_uchar</span>, <span class="type">atomic_short</span>, |
| <span class="type">atomic_ushort</span>, <span class="type">atomic_intmax_t</span> |
| and <span class="type">atomic_uintmax_t</span> types are not |
| supported by OpenCL C. |
| </p> |
| <p> |
| OpenCL C requires that the built-in atomic functions on |
| atomic types are lock-free. |
| </p> |
| <p> |
| The <code class="code">_Atomic</code> type specifier and <code class="code">_Atomic</code> |
| type qualifier are not supported by OpenCL C. |
| </p> |
| <p> |
| The behavior of atomic operations where pointer |
| arguments to the atomic functions refers |
| to an atomic type in the private address space is undefined. |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="specification"></a> |
| <h2>Specification</h2> |
| <p> |
| <img src="pdficon_small1.gif" /> |
| |
| <a href="https://www.khronos.org/registry/cl/specs/opencl-2.0-openclc.pdf#namedest=atomic_flag_test_and_set" target="OpenCL Spec">OpenCL Specification</a> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="seealso"></a> |
| <h2>Also see</h2> |
| <p> |
| <a class="citerefentry" href="atomicFunctions.html"><span class="citerefentry"><span class="refentrytitle">Atomic Functions</span></span></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-2015 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> |
