1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry>
<refentryinfo>
<keywordset>
<keyword>async_work_group_copy</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>async_work_group_copy</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</year>
<holder>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.</holder>
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
</refmeta>
<!-- ================================ SYNOPSIS -->
<refnamediv id="async_work_group_copy">
<refname>async_work_group_copy</refname>
<refpurpose>
Perform an async copy.
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="otherDataTypes.html">event_t</link>
<function>
async_work_group_copy
</function>
</funcdef>
<paramdef><link xlink:href="local.html">__local</link> gentype<parameter>*dst</parameter></paramdef>
<paramdef>const <link xlink:href="global.html">__global</link> gentype<parameter>*src</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">size_t</link>
<parameter>num_gentypes</parameter></paramdef>
<paramdef><link xlink:href="otherDataTypes.html">event_t</link><parameter>event</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="otherDataTypes.html">event_t</link>
<function>
async_work_group_copy
</function>
</funcdef>
<paramdef><link xlink:href="global.html">__global</link> gentype<parameter>*dst</parameter></paramdef>
<paramdef>const <link xlink:href="local.html">__local</link> gentype<parameter>*src</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>num_gentypes</parameter></paramdef>
<paramdef><link xlink:href="otherDataTypes.html">event_t</link><parameter>event</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
The OpenCL C programming language implements these functions that provide asynchronous
copies between global and local memory and a prefetch from global memory.
</para>
<para>
Perform an async copy of <varname>num_gentypes</varname> elements from
<varname>src</varname> to <varname>dst</varname>. The async copy is performed by all
work-items in a work-group and this built-in function must therefore be encountered
by all work-items in a work-group executing the kernel with the same argument values;
otherwise the results are undefined.
</para>
<para>
Returns an event object that can be used by
<citerefentry><refentrytitle>wait_group_events</refentrytitle></citerefentry> to
wait for the async copy to finish. The <varname>event</varname> argument can also be
used to associate the <function>async_work_group_copy</function> with a previous
async copy allowing an event to be shared by multiple async copies; otherwise
<varname>event</varname> should be zero.
</para>
<para>
If <varname>event</varname> argument is non-zero, the event object supplied in
<varname>event</varname> argument will be returned.
</para>
<para>
This function does not perform any implicit synchronization of source data such as
using a <citerefentry><refentrytitle>barrier</refentrytitle></citerefentry> before
performing the copy.
</para>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
<para>
The generic type name <type>gentype</type> indicates the built-in data
types <type>char</type>, <type>char{2|3|4|8|16}</type>, <type>uchar</type>,
<type>uchar{2|3|4|8|16}</type>, <type>short</type>, <type>short{2|3|4|8|16}</type>,
<type>ushort</type>, <type>ushort{2|3|4|8|16}</type>, <type>int</type>,
<type>int{2|3|4|8|16}</type>, <type>uint</type>, <type>uint{2|3|4|8|16}</type>,
<type>long</type>, <type>long{2|3|4|8|16}</type>, <type>ulong</type>,
<type>ulong{2|3|4|8|16}</type> or <type>float</type>, <type>float{2|3|4|8|16}</type>
as the type for the arguments unless otherwise stated.
</para>
<para>
Optionally, generic type name <type>gentype</type> may indicate <type>double</type>
and <type>double{2|3|4|8|16}</type> as arguments and return values. If extended with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>, generic type
name <type>gentype</type> may indicate <type>half</type> and <type>half{2|3|4|8|16}</type>
as arguments and return values.
</para>
<para>
<function>async_work_group_copy</function> and
<function>async_work_group_strided_copy</function> for 3-component
vector types behave as <function>async_work_group_copy</function> and
<function>async_work_group_strided_copy</function> respectively for 4-component vector
types.
</para>
</refsect1>
<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
<refsect2 id="example1">
<title>
Example
</title>
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
<tbody>
<row>
<entry>
Example goes here - it will be set in "code" type with white space preserved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect2>
-->
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="asyncCopyFunctions">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry href="asyncCopyFunctions"><refentrytitle>Async Copy and Prefetch Functions</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>wait_group_events</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
<!-- 23-Oct-2011 -->
</refentry>
|
