… | |
… | |
27 | OpenCL::Program objects, which store source code and, after building for a |
27 | OpenCL::Program objects, which store source code and, after building for a |
28 | specific device ("compiling and linking"), also binary programs. For each |
28 | specific device ("compiling and linking"), also binary programs. For each |
29 | kernel function in a program you can then create an OpenCL::Kernel object |
29 | kernel function in a program you can then create an OpenCL::Kernel object |
30 | which represents basically a function call with argument values. |
30 | which represents basically a function call with argument values. |
31 | |
31 | |
32 | OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat |
32 | OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat |
33 | memory areas, think arrays or structs) and OpenCL::Image objects (think 2d |
33 | memory areas, think arrays or structs) and OpenCL::Image objects (think 2d |
34 | or 3d array) for bulk data and input and output for kernels. |
34 | or 3d array) for bulk data and input and output for kernels. |
35 | |
35 | |
36 | OpenCL::Sampler objects, which are kind of like texture filter modes in |
36 | OpenCL::Sampler objects, which are kind of like texture filter modes in |
37 | OpenGL. |
37 | OpenGL. |
… | |
… | |
43 | |
43 | |
44 | OpenCL::Event objects are used to signal when something is complete. |
44 | OpenCL::Event objects are used to signal when something is complete. |
45 | |
45 | |
46 | =head2 HELPFUL RESOURCES |
46 | =head2 HELPFUL RESOURCES |
47 | |
47 | |
48 | The OpenCL spec used to develop this module (1.2 spec was available, but |
48 | The OpenCL specs used to develop this module: |
49 | no implementation was available to me :). |
|
|
50 | |
49 | |
51 | http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf |
50 | http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf |
|
|
51 | http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf |
|
|
52 | http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf |
52 | |
53 | |
53 | OpenCL manpages: |
54 | OpenCL manpages: |
54 | |
55 | |
55 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ |
56 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/ |
|
|
57 | http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/ |
|
|
58 | |
|
|
59 | If you are into UML class diagrams, the following diagram might help - if |
|
|
60 | not, it will be mildly confusing (also, the class hierarchy of this module |
|
|
61 | is much more fine-grained): |
|
|
62 | |
|
|
63 | http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/classDiagram.html |
56 | |
64 | |
57 | Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it |
65 | Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it |
58 | is, but at least it's free of charge: |
66 | is, but at least it's free of charge: |
59 | |
67 | |
60 | http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf |
68 | http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf |
61 | |
69 | |
62 | If you are into UML class diagrams, the following diagram might help - if |
70 | And here's NVIDIA's OpenCL Best Practises Guide: |
63 | not, it will be mildly cofusing: |
|
|
64 | |
71 | |
65 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html |
72 | http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf |
66 | |
73 | |
67 | =head1 BASIC WORKFLOW |
74 | =head1 BASIC WORKFLOW |
68 | |
75 | |
69 | To get something done, you basically have to do this once (refer to the |
76 | To get something done, you basically have to do this once (refer to the |
70 | examples below for actual code, this is just a high-level description): |
77 | examples below for actual code, this is just a high-level description): |
… | |
… | |
97 | |
104 | |
98 | Best run this once to get a feel for the platforms and devices in your |
105 | Best run this once to get a feel for the platforms and devices in your |
99 | system. |
106 | system. |
100 | |
107 | |
101 | for my $platform (OpenCL::platforms) { |
108 | for my $platform (OpenCL::platforms) { |
102 | printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME); |
109 | printf "platform: %s\n", $platform->name; |
103 | printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS); |
110 | printf "extensions: %s\n", $platform->extensions; |
104 | for my $device ($platform->devices) { |
111 | for my $device ($platform->devices) { |
105 | printf "+ device: %s\n", $device->info (OpenCL::DEVICE_NAME); |
112 | printf "+ device: %s\n", $device->name; |
106 | my $ctx = $device->context; |
113 | my $ctx = $platform->context (undef, [$device]); |
107 | # do stuff |
114 | # do stuff |
108 | } |
115 | } |
109 | } |
116 | } |
110 | |
117 | |
111 | =head2 Get a useful context and a command queue. |
118 | =head2 Get a useful context and a command queue. |
… | |
… | |
134 | =head2 Create a buffer with some predefined data, read it back synchronously, |
141 | =head2 Create a buffer with some predefined data, read it back synchronously, |
135 | then asynchronously. |
142 | then asynchronously. |
136 | |
143 | |
137 | my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); |
144 | my $buf = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, "helmut"); |
138 | |
145 | |
139 | $queue->enqueue_read_buffer ($buf, 1, 1, 3, my $data); |
146 | $queue->read_buffer ($buf, 1, 1, 3, my $data); |
140 | print "$data\n"; |
147 | print "$data\n"; |
141 | |
148 | |
142 | my $ev = $queue->enqueue_read_buffer ($buf, 0, 1, 3, my $data); |
149 | my $ev = $queue->read_buffer ($buf, 0, 1, 3, my $data); |
143 | $ev->wait; |
150 | $ev->wait; |
144 | print "$data\n"; # prints "elm" |
151 | print "$data\n"; # prints "elm" |
145 | |
152 | |
146 | =head2 Create and build a program, then create a kernel out of one of its |
153 | =head2 Create and build a program, then create a kernel out of one of its |
147 | functions. |
154 | functions. |
148 | |
155 | |
149 | my $src = ' |
156 | my $src = ' |
150 | __kernel void |
157 | kernel void |
151 | squareit (__global float *input, __global float *output) |
158 | squareit (global float *input, global float *output) |
152 | { |
159 | { |
153 | $id = get_global_id (0); |
160 | $id = get_global_id (0); |
154 | output [id] = input [id] * input [id]; |
161 | output [id] = input [id] * input [id]; |
155 | } |
162 | } |
156 | '; |
163 | '; |
157 | |
164 | |
158 | my $prog = $ctx->program_with_source ($src); |
165 | my $prog = $ctx->build_program ($src); |
159 | |
|
|
160 | # build croaks on compile errors, so catch it and print the compile errors |
|
|
161 | eval { $prog->build ($dev); 1 } |
|
|
162 | or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG); |
|
|
163 | |
|
|
164 | my $kernel = $prog->kernel ("squareit"); |
166 | my $kernel = $prog->kernel ("squareit"); |
165 | |
167 | |
166 | =head2 Create some input and output float buffers, then call the |
168 | =head2 Create some input and output float buffers, then call the |
167 | 'squareit' kernel on them. |
169 | 'squareit' kernel on them. |
168 | |
170 | |
… | |
… | |
172 | # set buffer |
174 | # set buffer |
173 | $kernel->set_buffer (0, $input); |
175 | $kernel->set_buffer (0, $input); |
174 | $kernel->set_buffer (1, $output); |
176 | $kernel->set_buffer (1, $output); |
175 | |
177 | |
176 | # execute it for all 4 numbers |
178 | # execute it for all 4 numbers |
177 | $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); |
179 | $queue->nd_range_kernel ($kernel, undef, [4], undef); |
178 | |
180 | |
179 | # enqueue a synchronous read |
181 | # enqueue a synchronous read |
180 | $queue->enqueue_read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); |
182 | $queue->read_buffer ($output, 1, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); |
181 | |
183 | |
182 | # print the results: |
184 | # print the results: |
183 | printf "%s\n", join ", ", unpack "f*", $data; |
185 | printf "%s\n", join ", ", unpack "f*", $data; |
184 | |
186 | |
185 | =head2 The same enqueue operations as before, but assuming an out-of-order queue, |
187 | =head2 The same enqueue operations as before, but assuming an out-of-order queue, |
186 | showing off barriers. |
188 | showing off barriers. |
187 | |
189 | |
188 | # execute it for all 4 numbers |
190 | # execute it for all 4 numbers |
189 | $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); |
191 | $queue->nd_range_kernel ($kernel, undef, [4], undef); |
190 | |
192 | |
191 | # enqueue a barrier to ensure in-order execution |
193 | # enqueue a barrier to ensure in-order execution |
192 | $queue->enqueue_barrier; |
194 | $queue->barrier; |
193 | |
195 | |
194 | # enqueue an async read |
196 | # enqueue an async read |
195 | $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); |
197 | $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data); |
196 | |
198 | |
197 | # wait for all requests to finish |
199 | # wait for all requests to finish |
198 | $queue->finish; |
200 | $queue->finish; |
199 | |
201 | |
200 | =head2 The same enqueue operations as before, but assuming an out-of-order queue, |
202 | =head2 The same enqueue operations as before, but assuming an out-of-order queue, |
201 | showing off event objects and wait lists. |
203 | showing off event objects and wait lists. |
202 | |
204 | |
203 | # execute it for all 4 numbers |
205 | # execute it for all 4 numbers |
204 | my $ev = $queue->enqueue_nd_range_kernel ($kernel, undef, [4], undef); |
206 | my $ev = $queue->nd_range_kernel ($kernel, undef, [4], undef); |
205 | |
207 | |
206 | # enqueue an async read |
208 | # enqueue an async read |
207 | $ev = $queue->enqueue_read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); |
209 | $ev = $queue->read_buffer ($output, 0, 0, OpenCL::SIZEOF_FLOAT * 4, my $data, $ev); |
208 | |
210 | |
209 | # wait for the last event to complete |
211 | # wait for the last event to complete |
210 | $ev->wait; |
212 | $ev->wait; |
|
|
213 | |
|
|
214 | =head2 Use the OpenGL module to share a texture between OpenCL and OpenGL and draw some julia |
|
|
215 | set tunnel effect. |
|
|
216 | |
|
|
217 | This is quite a long example to get you going. |
|
|
218 | |
|
|
219 | use OpenGL ":all"; |
|
|
220 | use OpenCL; |
|
|
221 | |
|
|
222 | # open a window and create a gl texture |
|
|
223 | OpenGL::glpOpenWindow width => 256, height => 256; |
|
|
224 | my $texid = glGenTextures_p 1; |
|
|
225 | glBindTexture GL_TEXTURE_2D, $texid; |
|
|
226 | glTexImage2D_c GL_TEXTURE_2D, 0, GL_RGBA8, 256, 256, 0, GL_RGBA, GL_UNSIGNED_BYTE, 0; |
|
|
227 | |
|
|
228 | # find and use the first opencl device that let's us get a shared opengl context |
|
|
229 | my $platform; |
|
|
230 | my $dev; |
|
|
231 | my $ctx; |
|
|
232 | |
|
|
233 | for (OpenCL::platforms) { |
|
|
234 | $platform = $_; |
|
|
235 | for ($platform->devices) { |
|
|
236 | $dev = $_; |
|
|
237 | $ctx = $platform->context ([OpenCL::GLX_DISPLAY_KHR, undef, OpenCL::GL_CONTEXT_KHR, undef], [$dev]) |
|
|
238 | and last; |
|
|
239 | } |
|
|
240 | } |
|
|
241 | |
|
|
242 | $ctx |
|
|
243 | or die "cannot find suitable OpenCL device\n"; |
|
|
244 | |
|
|
245 | my $queue = $ctx->queue ($dev); |
|
|
246 | |
|
|
247 | # now attach an opencl image2d object to the opengl texture |
|
|
248 | my $tex = $ctx->gl_texture2d (OpenCL::MEM_WRITE_ONLY, GL_TEXTURE_2D, 0, $texid); |
|
|
249 | |
|
|
250 | # now the boring opencl code |
|
|
251 | my $src = <<EOF; |
|
|
252 | kernel void |
|
|
253 | juliatunnel (write_only image2d_t img, float time) |
|
|
254 | { |
|
|
255 | float2 p = (float2)(get_global_id (0), get_global_id (1)) / 256.f * 2.f - 1.f; |
|
|
256 | |
|
|
257 | float2 m = (float2)(1.f, p.y) / fabs (p.x); |
|
|
258 | m.x = fabs (fmod (m.x + time * 0.05f, 4.f)) - 2.f; |
|
|
259 | |
|
|
260 | float2 z = m; |
|
|
261 | float2 c = (float2)(sin (time * 0.05005), cos (time * 0.06001)); |
|
|
262 | |
|
|
263 | for (int i = 0; i < 25 && dot (z, z) < 4.f; ++i) |
|
|
264 | z = (float2)(z.x * z.x - z.y * z.y, 2.f * z.x * z.y) + c; |
|
|
265 | |
|
|
266 | float3 colour = (float3)(z.x, z.y, z.x * z.y); |
|
|
267 | write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.)); |
|
|
268 | } |
|
|
269 | EOF |
|
|
270 | |
|
|
271 | my $prog = $ctx->build_program ($src); |
|
|
272 | my $kernel = $prog->kernel ("juliatunnel"); |
|
|
273 | |
|
|
274 | # program compiled, kernel ready, now draw and loop |
|
|
275 | |
|
|
276 | for (my $time; ; ++$time) { |
|
|
277 | # acquire objects from opengl |
|
|
278 | $queue->acquire_gl_objects ([$tex]); |
|
|
279 | |
|
|
280 | # configure and run our kernel |
|
|
281 | $kernel->set_image2d (0, $tex); |
|
|
282 | $kernel->set_float (1, $time); |
|
|
283 | $queue->nd_range_kernel ($kernel, undef, [256, 256], undef); |
|
|
284 | |
|
|
285 | # release objects to opengl again |
|
|
286 | $queue->release_gl_objects ([$tex]); |
|
|
287 | |
|
|
288 | # wait |
|
|
289 | $queue->finish; |
|
|
290 | |
|
|
291 | # now draw the texture, the defaults should be all right |
|
|
292 | glTexParameterf GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST; |
|
|
293 | |
|
|
294 | glEnable GL_TEXTURE_2D; |
|
|
295 | glBegin GL_QUADS; |
|
|
296 | glTexCoord2f 0, 1; glVertex3i -1, -1, -1; |
|
|
297 | glTexCoord2f 0, 0; glVertex3i 1, -1, -1; |
|
|
298 | glTexCoord2f 1, 0; glVertex3i 1, 1, -1; |
|
|
299 | glTexCoord2f 1, 1; glVertex3i -1, 1, -1; |
|
|
300 | glEnd; |
|
|
301 | |
|
|
302 | glXSwapBuffers; |
|
|
303 | |
|
|
304 | select undef, undef, undef, 1/60; |
|
|
305 | } |
211 | |
306 | |
212 | =head1 DOCUMENTATION |
307 | =head1 DOCUMENTATION |
213 | |
308 | |
214 | =head2 BASIC CONVENTIONS |
309 | =head2 BASIC CONVENTIONS |
215 | |
310 | |
… | |
… | |
222 | |
317 | |
223 | =item * Object lifetime managament is automatic - there is no need |
318 | =item * Object lifetime managament is automatic - there is no need |
224 | to free objects explicitly (C<clReleaseXXX>), the release function |
319 | to free objects explicitly (C<clReleaseXXX>), the release function |
225 | is called automatically once all Perl references to it go away. |
320 | is called automatically once all Perl references to it go away. |
226 | |
321 | |
227 | =item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>), |
322 | =item * OpenCL uses CamelCase for function names |
|
|
323 | (e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>), while this module |
228 | while this module uses underscores as word separator and often leaves out |
324 | uses underscores as word separator and often leaves out prefixes |
229 | prefixes (C<< $platform->info >>). |
325 | (C<OpenCL::platforms>, C<< $platform->info >>). |
230 | |
326 | |
231 | =item * OpenCL often specifies fixed vector function arguments as short |
327 | =item * OpenCL often specifies fixed vector function arguments as short |
232 | arrays (C<$origin[3]>), while this module explicitly expects the |
328 | arrays (C<size_t origin[3]>), while this module explicitly expects the |
233 | components as separate arguments- |
329 | components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in |
|
|
330 | function calls. |
234 | |
331 | |
235 | =item * Structures are often specified with their components, and returned |
332 | =item * Structures are often specified by flattening out their components |
236 | as arrayrefs. |
333 | as with short vectors, and returned as arrayrefs. |
237 | |
|
|
238 | =item * Where possible, one of the pitch values is calculated from the |
|
|
239 | perl scalar length and need not be specified. |
|
|
240 | |
334 | |
241 | =item * When enqueuing commands, the wait list is specified by adding |
335 | =item * When enqueuing commands, the wait list is specified by adding |
242 | extra arguments to the function - anywhere a C<$wait_events...> argument |
336 | extra arguments to the function - anywhere a C<$wait_events...> argument |
243 | is documented this can be any number of event objects. |
337 | is documented this can be any number of event objects. As an extsnion |
|
|
338 | implemented by this module, C<undef> values will be ignored in the event |
|
|
339 | list. |
244 | |
340 | |
245 | =item * When enqueuing commands, if the enqueue method is called in void |
341 | =item * When enqueuing commands, if the enqueue method is called in void |
246 | context, no event is created. In all other contexts an event is returned |
342 | context, no event is created. In all other contexts an event is returned |
247 | by the method. |
343 | by the method. |
248 | |
344 | |
… | |
… | |
268 | ulong IV - Q |
364 | ulong IV - Q |
269 | float NV float f |
365 | float NV float f |
270 | half IV ushort S |
366 | half IV ushort S |
271 | double NV double d |
367 | double NV double d |
272 | |
368 | |
|
|
369 | =head2 GLX SUPPORT |
|
|
370 | |
|
|
371 | Due to the sad state that OpenGL support is in in Perl (mostly the OpenGL |
|
|
372 | module, which has little to no documentation and has little to no support |
|
|
373 | for glX), this module, as a special extension, treats context creation |
|
|
374 | properties C<OpenCL::GLX_DISPLAY_KHR> and C<OpenCL::GL_CONTEXT_KHR> |
|
|
375 | specially: If either or both of these are C<undef>, then the OpenCL |
|
|
376 | module tries to dynamically resolve C<glXGetCurrentDisplay> and |
|
|
377 | C<glXGetCurrentContext>, call these functions and use their return values |
|
|
378 | instead. |
|
|
379 | |
|
|
380 | For this to work, the OpenGL library must be loaded, a GLX context must |
|
|
381 | have been created and be made current, and C<dlsym> must be available and |
|
|
382 | capable of finding the function via C<RTLD_DEFAULT>. |
|
|
383 | |
|
|
384 | =head2 EVENT SYSTEM |
|
|
385 | |
|
|
386 | OpenCL can generate a number of (potentially) asynchronous events, for |
|
|
387 | example, after compiling a program, to signal a context-related error or, |
|
|
388 | perhaps most important, to signal completion of queued jobs (by setting |
|
|
389 | callbacks on OpenCL::Event objects). |
|
|
390 | |
|
|
391 | To facilitate this, this module maintains an event queue - each |
|
|
392 | time an asynchronous event happens, it is queued, and perl will be |
|
|
393 | interrupted. This is implemented via the L<Async::Interrupt> module. In |
|
|
394 | addition, this module has L<AnyEvent> support, so it can seamlessly |
|
|
395 | integrate itself into many event loops. |
|
|
396 | |
|
|
397 | Since this module is a bit hard to understand, here are some case examples: |
|
|
398 | |
|
|
399 | =head3 Don't use callbacks. |
|
|
400 | |
|
|
401 | When your program never uses any callbacks, then there will never be any |
|
|
402 | notifications you need to take care of, and therefore no need to worry |
|
|
403 | about all this. |
|
|
404 | |
|
|
405 | You can achieve a great deal by explicitly waiting for events, or using |
|
|
406 | barriers and flush calls. In many programs, there is no need at all to |
|
|
407 | tinker with asynchronous events. |
|
|
408 | |
|
|
409 | =head3 Use AnyEvent |
|
|
410 | |
|
|
411 | This module automatically registers a watcher that invokes all outstanding |
|
|
412 | event callbacks when AnyEvent is initialised (and block asynchronous |
|
|
413 | interruptions). Using this mode of operations is the safest and most |
|
|
414 | recommended one. |
|
|
415 | |
|
|
416 | To use this, simply use AnyEvent and this module normally, make sure you |
|
|
417 | have an event loop running: |
|
|
418 | |
|
|
419 | use Gtk2 -init; |
|
|
420 | use AnyEvent; |
|
|
421 | |
|
|
422 | # initialise AnyEvent, by creating a watcher, or: |
|
|
423 | AnyEvent::detect; |
|
|
424 | |
|
|
425 | my $e = $queue->marker; |
|
|
426 | $e->cb (sub { |
|
|
427 | warn "opencl is finished\n"; |
|
|
428 | }) |
|
|
429 | |
|
|
430 | main Gtk2; |
|
|
431 | |
|
|
432 | Note that this module will not initialise AnyEvent for you. Before |
|
|
433 | AnyEvent is initialised, the module will asynchronously interrupt perl |
|
|
434 | instead. To avoid any surprises, it's best to explicitly initialise |
|
|
435 | AnyEvent. |
|
|
436 | |
|
|
437 | You can temporarily enable asynchronous interruptions (see next paragraph) |
|
|
438 | by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by |
|
|
439 | calling C<$OpenCL::INTERRUPT->block>. |
|
|
440 | |
|
|
441 | =head3 Let yourself be interrupted at any time |
|
|
442 | |
|
|
443 | This mode is the default unless AnyEvent is loaded and initialised. In |
|
|
444 | this mode, OpenCL asynchronously interrupts a running perl program. The |
|
|
445 | emphasis is on both I<asynchronously> and I<running> here. |
|
|
446 | |
|
|
447 | Asynchronously means that perl might execute your callbacks at any |
|
|
448 | time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>), |
|
|
449 | the C<until> loop following the marker call will be interrupted by the |
|
|
450 | callback: |
|
|
451 | |
|
|
452 | my $e = $queue->marker; |
|
|
453 | my $flag; |
|
|
454 | $e->cb (sub { $flag = 1 }); |
|
|
455 | 1 until $flag; |
|
|
456 | # $flag is now 1 |
|
|
457 | |
|
|
458 | The reason why you shouldn't blindly copy the above code is that |
|
|
459 | busy waiting is a really really bad thing, and really really bad for |
|
|
460 | performance. |
|
|
461 | |
|
|
462 | While at first this asynchronous business might look exciting, it can be |
|
|
463 | really hard, because you need to be prepared for the callback code to be |
|
|
464 | executed at any time, which limits the amount of things the callback code |
|
|
465 | can do safely. |
|
|
466 | |
|
|
467 | This can be mitigated somewhat by using C<< |
|
|
468 | $OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt> |
|
|
469 | documentation for details). |
|
|
470 | |
|
|
471 | The other problem is that your program must be actively I<running> to be |
|
|
472 | interrupted. When you calculate stuff, your program is running. When you |
|
|
473 | hang in some C functions or other block execution (by calling C<sleep>, |
|
|
474 | C<select>, running an event loop and so on), your program is waiting, not |
|
|
475 | running. |
|
|
476 | |
|
|
477 | One way around that would be to attach a read watcher to your event loop, |
|
|
478 | listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a |
|
|
479 | dummy callback (C<sub { }>) to temporarily execute some perl code. |
|
|
480 | |
|
|
481 | That is then awfully close to using the built-in AnyEvent support above, |
|
|
482 | though, so consider that one instead. |
|
|
483 | |
|
|
484 | =head3 Be creative |
|
|
485 | |
|
|
486 | OpenCL exports the L<Async::Interrupt> object it uses in the global |
|
|
487 | variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like. |
|
|
488 | |
|
|
489 | So if you want to feel like a real pro, err, wait, if you feel no risk |
|
|
490 | menas no fun, you can experiment by implementing your own mode of |
|
|
491 | operations. |
|
|
492 | |
|
|
493 | =cut |
|
|
494 | |
|
|
495 | package OpenCL; |
|
|
496 | |
|
|
497 | use common::sense; |
|
|
498 | use Carp (); |
|
|
499 | use Async::Interrupt (); |
|
|
500 | |
|
|
501 | our $POLL_FUNC; # set by XS |
|
|
502 | |
|
|
503 | BEGIN { |
|
|
504 | our $VERSION = '0.98'; |
|
|
505 | |
|
|
506 | require XSLoader; |
|
|
507 | XSLoader::load (__PACKAGE__, $VERSION); |
|
|
508 | |
|
|
509 | @OpenCL::Platform::ISA = |
|
|
510 | @OpenCL::Device::ISA = |
|
|
511 | @OpenCL::Context::ISA = |
|
|
512 | @OpenCL::Queue::ISA = |
|
|
513 | @OpenCL::Memory::ISA = |
|
|
514 | @OpenCL::Sampler::ISA = |
|
|
515 | @OpenCL::Program::ISA = |
|
|
516 | @OpenCL::Kernel::ISA = |
|
|
517 | @OpenCL::Event::ISA = OpenCL::Object::; |
|
|
518 | |
|
|
519 | @OpenCL::Buffer::ISA = |
|
|
520 | @OpenCL::Image::ISA = OpenCL::Memory::; |
|
|
521 | |
|
|
522 | @OpenCL::BufferObj::ISA = OpenCL::Buffer::; |
|
|
523 | |
|
|
524 | @OpenCL::Image2D::ISA = |
|
|
525 | @OpenCL::Image3D::ISA = |
|
|
526 | @OpenCL::Image2DArray::ISA = |
|
|
527 | @OpenCL::Image1D::ISA = |
|
|
528 | @OpenCL::Image1DArray::ISA = |
|
|
529 | @OpenCL::Image1DBuffer::ISA = OpenCL::Image::; |
|
|
530 | |
|
|
531 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
|
|
532 | } |
|
|
533 | |
273 | =head2 THE OpenCL PACKAGE |
534 | =head2 THE OpenCL PACKAGE |
274 | |
535 | |
275 | =over 4 |
536 | =over 4 |
276 | |
537 | |
277 | =item $int = OpenCL::errno |
538 | =item $int = OpenCL::errno |
278 | |
539 | |
279 | The last error returned by a function - it's only valid after an error occured |
540 | The last error returned by a function - it's only valid after an error occured |
280 | and before calling another OpenCL function. |
541 | and before calling another OpenCL function. |
281 | |
542 | |
282 | =item $str = OpenCL::err2str $errval |
543 | =item $str = OpenCL::err2str [$errval] |
283 | |
544 | |
284 | Comverts an error value into a human readable string. |
545 | Converts an error value into a human readable string. IF no error value is |
|
|
546 | given, then the last error will be used (as returned by OpenCL::errno). |
285 | |
547 | |
286 | =item $str = OpenCL::enum2str $enum |
548 | =item $str = OpenCL::enum2str $enum |
287 | |
549 | |
288 | Converts most enum values (inof parameter names, image format constants, |
550 | Converts most enum values (of parameter names, image format constants, |
289 | object types, addressing and filter modes, command types etc.) into a |
551 | object types, addressing and filter modes, command types etc.) into a |
290 | human readbale string. When confronted with some random integer it can be |
552 | human readable string. When confronted with some random integer it can be |
291 | very helpful to pass it through this function to maybe get some readable |
553 | very helpful to pass it through this function to maybe get some readable |
292 | string out of it. |
554 | string out of it. |
293 | |
555 | |
294 | =item @platforms = OpenCL::platforms |
556 | =item @platforms = OpenCL::platforms |
295 | |
557 | |
296 | Returns all available OpenCL::Platform objects. |
558 | Returns all available OpenCL::Platform objects. |
297 | |
559 | |
298 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> |
560 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html> |
299 | |
561 | |
300 | =item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef |
562 | =item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr |
301 | |
563 | |
302 | Tries to create a context from a default device and platform - never worked for me. |
564 | Tries to create a context from a default device and platform type - never worked for me. |
303 | |
565 | |
304 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
566 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
305 | |
567 | |
|
|
568 | =item $ctx = OpenCL::context $properties, \@devices, $callback->($err, $pvt) = $print_stderr) |
|
|
569 | |
|
|
570 | Create a new OpenCL::Context object using the given device object(s). This |
|
|
571 | function isn't implemented yet, use C<< $platform->context >> instead. |
|
|
572 | |
|
|
573 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
|
|
574 | |
306 | =item OpenCL::wait_for_events $wait_events... |
575 | =item OpenCL::wait_for_events $wait_events... |
307 | |
576 | |
308 | Waits for all events to complete. |
577 | Waits for all events to complete. |
309 | |
578 | |
310 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> |
579 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> |
311 | |
580 | |
|
|
581 | =item OpenCL::poll |
|
|
582 | |
|
|
583 | Checks if there are any outstanding events (see L<EVENT SYSTEM>) and |
|
|
584 | invokes their callbacks. |
|
|
585 | |
|
|
586 | =item $OpenCL::INTERRUPT |
|
|
587 | |
|
|
588 | The L<Async::Interrupt> object used to signal asynchronous events (see |
|
|
589 | L<EVENT SYSTEM>). |
|
|
590 | |
|
|
591 | =cut |
|
|
592 | |
|
|
593 | our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0]; |
|
|
594 | |
|
|
595 | &_eq_initialise ($INTERRUPT->signal_func); |
|
|
596 | |
|
|
597 | =item $OpenCL::WATCHER |
|
|
598 | |
|
|
599 | The L<AnyEvent> watcher object used to watch for asynchronous events (see |
|
|
600 | L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been |
|
|
601 | loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>). |
|
|
602 | |
|
|
603 | =cut |
|
|
604 | |
|
|
605 | our $WATCHER; |
|
|
606 | |
|
|
607 | sub _init_anyevent { |
|
|
608 | $INTERRUPT->block; |
|
|
609 | $WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle }); |
|
|
610 | } |
|
|
611 | |
|
|
612 | if (defined $AnyEvent::MODEL) { |
|
|
613 | _init_anyevent; |
|
|
614 | } else { |
|
|
615 | push @AnyEvent::post_detect, \&_init_anyevent; |
|
|
616 | } |
|
|
617 | |
312 | =back |
618 | =back |
313 | |
619 | |
|
|
620 | =head2 THE OpenCL::Object CLASS |
|
|
621 | |
|
|
622 | This is the base class for all objects in the OpenCL module. The only |
|
|
623 | method it implements is the C<id> method, which is only useful if you want |
|
|
624 | to interface to OpenCL on the C level. |
|
|
625 | |
|
|
626 | =over 4 |
|
|
627 | |
|
|
628 | =item $iv = $obj->id |
|
|
629 | |
|
|
630 | OpenCL objects are represented by pointers or integers on the C level. If |
|
|
631 | you want to interface to an OpenCL object directly on the C level, then |
|
|
632 | you need this value, which is returned by this method. You should use an |
|
|
633 | C<IV> type in your code and cast that to the correct type. |
|
|
634 | |
|
|
635 | =cut |
|
|
636 | |
|
|
637 | sub OpenCL::Object::id { |
|
|
638 | ref $_[0] eq "SCALAR" |
|
|
639 | ? ${ $_[0] } |
|
|
640 | : $_[0][0] |
|
|
641 | } |
|
|
642 | |
|
|
643 | =back |
|
|
644 | |
314 | =head2 THE OpenCL::Platform CLASS |
645 | =head2 THE OpenCL::Platform CLASS |
315 | |
646 | |
316 | =over 4 |
647 | =over 4 |
317 | |
648 | |
318 | =item $packed_value = $platform->info ($name) |
|
|
319 | |
|
|
320 | Calls C<clGetPlatformInfo> and returns the packed, raw value - for |
|
|
321 | strings, this will be the string, for other values you probably need to |
|
|
322 | use the correct C<unpack>. This might get improved in the future. Hopefully. |
|
|
323 | |
|
|
324 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> |
|
|
325 | |
|
|
326 | =item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) |
649 | =item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) |
327 | |
650 | |
328 | Returns a list of matching OpenCL::Device objects. |
651 | Returns a list of matching OpenCL::Device objects. |
329 | |
652 | |
330 | =item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) |
653 | =item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $callback->($err, $pvt) = $print_stderr) |
331 | |
654 | |
332 | Tries to create a context. Never worked for me, and you need devices explitly anyway. |
655 | Tries to create a context. Never worked for me, and you need devices explicitly anyway. |
333 | |
656 | |
334 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
657 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html> |
335 | |
658 | |
336 | =item $ctx = $device->context ($properties = undef, @$devices, $notify = undef) |
659 | =item $ctx = $platform->context ($properties, \@devices, $callback->($err, $pvt) = $print_stderr) |
337 | |
660 | |
338 | Create a new OpenCL::Context object using the given device object(s)- a |
661 | Create a new OpenCL::Context object using the given device object(s)- a |
339 | CL_CONTEXT_PLATFORM property is supplied automatically. |
662 | CL_CONTEXT_PLATFORM property is supplied automatically. |
340 | |
663 | |
341 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
664 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html> |
342 | |
665 | |
|
|
666 | =item $packed_value = $platform->info ($name) |
|
|
667 | |
|
|
668 | Calls C<clGetPlatformInfo> and returns the packed, raw value - for |
|
|
669 | strings, this will be the string (possibly including terminating \0), for |
|
|
670 | other values you probably need to use the correct C<unpack>. |
|
|
671 | |
|
|
672 | It's best to avoid this method and use one of the following convenience |
|
|
673 | wrappers. |
|
|
674 | |
|
|
675 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> |
|
|
676 | |
|
|
677 | =item $platform->unload_compiler |
|
|
678 | |
|
|
679 | Attempts to unload the compiler for this platform, for endless |
|
|
680 | profit. Does nothing on OpenCL 1.1. |
|
|
681 | |
|
|
682 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html> |
|
|
683 | |
|
|
684 | =for gengetinfo begin platform |
|
|
685 | |
|
|
686 | =item $string = $platform->profile |
|
|
687 | |
|
|
688 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. |
|
|
689 | |
|
|
690 | =item $string = $platform->version |
|
|
691 | |
|
|
692 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VERSION> and returns the result. |
|
|
693 | |
|
|
694 | =item $string = $platform->name |
|
|
695 | |
|
|
696 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_NAME> and returns the result. |
|
|
697 | |
|
|
698 | =item $string = $platform->vendor |
|
|
699 | |
|
|
700 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_VENDOR> and returns the result. |
|
|
701 | |
|
|
702 | =item $string = $platform->extensions |
|
|
703 | |
|
|
704 | Calls C<clGetPlatformInfo> with C<CL_PLATFORM_EXTENSIONS> and returns the result. |
|
|
705 | |
|
|
706 | =for gengetinfo end platform |
|
|
707 | |
343 | =back |
708 | =back |
344 | |
709 | |
345 | =head2 THE OpenCL::Device CLASS |
710 | =head2 THE OpenCL::Device CLASS |
346 | |
711 | |
347 | =over 4 |
712 | =over 4 |
… | |
… | |
350 | |
715 | |
351 | See C<< $platform->info >> for details. |
716 | See C<< $platform->info >> for details. |
352 | |
717 | |
353 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> |
718 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html> |
354 | |
719 | |
|
|
720 | =for gengetinfo begin device |
|
|
721 | |
|
|
722 | =item $device_type = $device->type |
|
|
723 | |
|
|
724 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_TYPE> and returns the result. |
|
|
725 | |
|
|
726 | =item $uint = $device->vendor_id |
|
|
727 | |
|
|
728 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR_ID> and returns the result. |
|
|
729 | |
|
|
730 | =item $uint = $device->max_compute_units |
|
|
731 | |
|
|
732 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_COMPUTE_UNITS> and returns the result. |
|
|
733 | |
|
|
734 | =item $uint = $device->max_work_item_dimensions |
|
|
735 | |
|
|
736 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS> and returns the result. |
|
|
737 | |
|
|
738 | =item $int = $device->max_work_group_size |
|
|
739 | |
|
|
740 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_GROUP_SIZE> and returns the result. |
|
|
741 | |
|
|
742 | =item @ints = $device->max_work_item_sizes |
|
|
743 | |
|
|
744 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WORK_ITEM_SIZES> and returns the result. |
|
|
745 | |
|
|
746 | =item $uint = $device->preferred_vector_width_char |
|
|
747 | |
|
|
748 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR> and returns the result. |
|
|
749 | |
|
|
750 | =item $uint = $device->preferred_vector_width_short |
|
|
751 | |
|
|
752 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT> and returns the result. |
|
|
753 | |
|
|
754 | =item $uint = $device->preferred_vector_width_int |
|
|
755 | |
|
|
756 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT> and returns the result. |
|
|
757 | |
|
|
758 | =item $uint = $device->preferred_vector_width_long |
|
|
759 | |
|
|
760 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG> and returns the result. |
|
|
761 | |
|
|
762 | =item $uint = $device->preferred_vector_width_float |
|
|
763 | |
|
|
764 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT> and returns the result. |
|
|
765 | |
|
|
766 | =item $uint = $device->preferred_vector_width_double |
|
|
767 | |
|
|
768 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE> and returns the result. |
|
|
769 | |
|
|
770 | =item $uint = $device->max_clock_frequency |
|
|
771 | |
|
|
772 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CLOCK_FREQUENCY> and returns the result. |
|
|
773 | |
|
|
774 | =item $bitfield = $device->address_bits |
|
|
775 | |
|
|
776 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ADDRESS_BITS> and returns the result. |
|
|
777 | |
|
|
778 | =item $uint = $device->max_read_image_args |
|
|
779 | |
|
|
780 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_READ_IMAGE_ARGS> and returns the result. |
|
|
781 | |
|
|
782 | =item $uint = $device->max_write_image_args |
|
|
783 | |
|
|
784 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_WRITE_IMAGE_ARGS> and returns the result. |
|
|
785 | |
|
|
786 | =item $ulong = $device->max_mem_alloc_size |
|
|
787 | |
|
|
788 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_MEM_ALLOC_SIZE> and returns the result. |
|
|
789 | |
|
|
790 | =item $int = $device->image2d_max_width |
|
|
791 | |
|
|
792 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_WIDTH> and returns the result. |
|
|
793 | |
|
|
794 | =item $int = $device->image2d_max_height |
|
|
795 | |
|
|
796 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE2D_MAX_HEIGHT> and returns the result. |
|
|
797 | |
|
|
798 | =item $int = $device->image3d_max_width |
|
|
799 | |
|
|
800 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_WIDTH> and returns the result. |
|
|
801 | |
|
|
802 | =item $int = $device->image3d_max_height |
|
|
803 | |
|
|
804 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_HEIGHT> and returns the result. |
|
|
805 | |
|
|
806 | =item $int = $device->image3d_max_depth |
|
|
807 | |
|
|
808 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE3D_MAX_DEPTH> and returns the result. |
|
|
809 | |
|
|
810 | =item $uint = $device->image_support |
|
|
811 | |
|
|
812 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_IMAGE_SUPPORT> and returns the result. |
|
|
813 | |
|
|
814 | =item $int = $device->max_parameter_size |
|
|
815 | |
|
|
816 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_PARAMETER_SIZE> and returns the result. |
|
|
817 | |
|
|
818 | =item $uint = $device->max_samplers |
|
|
819 | |
|
|
820 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_SAMPLERS> and returns the result. |
|
|
821 | |
|
|
822 | =item $uint = $device->mem_base_addr_align |
|
|
823 | |
|
|
824 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MEM_BASE_ADDR_ALIGN> and returns the result. |
|
|
825 | |
|
|
826 | =item $uint = $device->min_data_type_align_size |
|
|
827 | |
|
|
828 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE> and returns the result. |
|
|
829 | |
|
|
830 | =item $device_fp_config = $device->single_fp_config |
|
|
831 | |
|
|
832 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_SINGLE_FP_CONFIG> and returns the result. |
|
|
833 | |
|
|
834 | =item $device_mem_cache_type = $device->global_mem_cache_type |
|
|
835 | |
|
|
836 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_TYPE> and returns the result. |
|
|
837 | |
|
|
838 | =item $uint = $device->global_mem_cacheline_size |
|
|
839 | |
|
|
840 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE> and returns the result. |
|
|
841 | |
|
|
842 | =item $ulong = $device->global_mem_cache_size |
|
|
843 | |
|
|
844 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_CACHE_SIZE> and returns the result. |
|
|
845 | |
|
|
846 | =item $ulong = $device->global_mem_size |
|
|
847 | |
|
|
848 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_GLOBAL_MEM_SIZE> and returns the result. |
|
|
849 | |
|
|
850 | =item $ulong = $device->max_constant_buffer_size |
|
|
851 | |
|
|
852 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE> and returns the result. |
|
|
853 | |
|
|
854 | =item $uint = $device->max_constant_args |
|
|
855 | |
|
|
856 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_MAX_CONSTANT_ARGS> and returns the result. |
|
|
857 | |
|
|
858 | =item $device_local_mem_type = $device->local_mem_type |
|
|
859 | |
|
|
860 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_TYPE> and returns the result. |
|
|
861 | |
|
|
862 | =item $ulong = $device->local_mem_size |
|
|
863 | |
|
|
864 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_LOCAL_MEM_SIZE> and returns the result. |
|
|
865 | |
|
|
866 | =item $boolean = $device->error_correction_support |
|
|
867 | |
|
|
868 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ERROR_CORRECTION_SUPPORT> and returns the result. |
|
|
869 | |
|
|
870 | =item $int = $device->profiling_timer_resolution |
|
|
871 | |
|
|
872 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILING_TIMER_RESOLUTION> and returns the result. |
|
|
873 | |
|
|
874 | =item $boolean = $device->endian_little |
|
|
875 | |
|
|
876 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_ENDIAN_LITTLE> and returns the result. |
|
|
877 | |
|
|
878 | =item $boolean = $device->available |
|
|
879 | |
|
|
880 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AVAILABLE> and returns the result. |
|
|
881 | |
|
|
882 | =item $boolean = $device->compiler_available |
|
|
883 | |
|
|
884 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_COMPILER_AVAILABLE> and returns the result. |
|
|
885 | |
|
|
886 | =item $device_exec_capabilities = $device->execution_capabilities |
|
|
887 | |
|
|
888 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXECUTION_CAPABILITIES> and returns the result. |
|
|
889 | |
|
|
890 | =item $command_queue_properties = $device->properties |
|
|
891 | |
|
|
892 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_QUEUE_PROPERTIES> and returns the result. |
|
|
893 | |
|
|
894 | =item $ = $device->platform |
|
|
895 | |
|
|
896 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PLATFORM> and returns the result. |
|
|
897 | |
|
|
898 | =item $string = $device->name |
|
|
899 | |
|
|
900 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NAME> and returns the result. |
|
|
901 | |
|
|
902 | =item $string = $device->vendor |
|
|
903 | |
|
|
904 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VENDOR> and returns the result. |
|
|
905 | |
|
|
906 | =item $string = $device->driver_version |
|
|
907 | |
|
|
908 | Calls C<clGetDeviceInfo> with C<CL_DRIVER_VERSION> and returns the result. |
|
|
909 | |
|
|
910 | =item $string = $device->profile |
|
|
911 | |
|
|
912 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PROFILE> and returns the result. |
|
|
913 | |
|
|
914 | =item $string = $device->version |
|
|
915 | |
|
|
916 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_VERSION> and returns the result. |
|
|
917 | |
|
|
918 | =item $string = $device->extensions |
|
|
919 | |
|
|
920 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_EXTENSIONS> and returns the result. |
|
|
921 | |
|
|
922 | =item $uint = $device->preferred_vector_width_half |
|
|
923 | |
|
|
924 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF> and returns the result. |
|
|
925 | |
|
|
926 | =item $uint = $device->native_vector_width_char |
|
|
927 | |
|
|
928 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR> and returns the result. |
|
|
929 | |
|
|
930 | =item $uint = $device->native_vector_width_short |
|
|
931 | |
|
|
932 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT> and returns the result. |
|
|
933 | |
|
|
934 | =item $uint = $device->native_vector_width_int |
|
|
935 | |
|
|
936 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_INT> and returns the result. |
|
|
937 | |
|
|
938 | =item $uint = $device->native_vector_width_long |
|
|
939 | |
|
|
940 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG> and returns the result. |
|
|
941 | |
|
|
942 | =item $uint = $device->native_vector_width_float |
|
|
943 | |
|
|
944 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT> and returns the result. |
|
|
945 | |
|
|
946 | =item $uint = $device->native_vector_width_double |
|
|
947 | |
|
|
948 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE> and returns the result. |
|
|
949 | |
|
|
950 | =item $uint = $device->native_vector_width_half |
|
|
951 | |
|
|
952 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF> and returns the result. |
|
|
953 | |
|
|
954 | =item $device_fp_config = $device->double_fp_config |
|
|
955 | |
|
|
956 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_DOUBLE_FP_CONFIG> and returns the result. |
|
|
957 | |
|
|
958 | =item $device_fp_config = $device->half_fp_config |
|
|
959 | |
|
|
960 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_HALF_FP_CONFIG> and returns the result. |
|
|
961 | |
|
|
962 | =item $boolean = $device->host_unified_memory |
|
|
963 | |
|
|
964 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_HOST_UNIFIED_MEMORY> and returns the result. |
|
|
965 | |
|
|
966 | =item $device = $device->parent_device_ext |
|
|
967 | |
|
|
968 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARENT_DEVICE_EXT> and returns the result. |
|
|
969 | |
|
|
970 | =item @device_partition_property_exts = $device->partition_types_ext |
|
|
971 | |
|
|
972 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_TYPES_EXT> and returns the result. |
|
|
973 | |
|
|
974 | =item @device_partition_property_exts = $device->affinity_domains_ext |
|
|
975 | |
|
|
976 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. |
|
|
977 | |
|
|
978 | =item $uint = $device->reference_count_ext |
|
|
979 | |
|
|
980 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result. |
|
|
981 | |
|
|
982 | =item @device_partition_property_exts = $device->partition_style_ext |
|
|
983 | |
|
|
984 | Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. |
|
|
985 | |
|
|
986 | =for gengetinfo end device |
|
|
987 | |
355 | =back |
988 | =back |
356 | |
989 | |
357 | =head2 THE OpenCL::Context CLASS |
990 | =head2 THE OpenCL::Context CLASS |
358 | |
991 | |
359 | =over 4 |
992 | =over 4 |
360 | |
993 | |
361 | =item $packed_value = $ctx->info ($name) |
994 | =item $prog = $ctx->build_program ($program, $options = "") |
362 | |
995 | |
363 | See C<< $platform->info >> for details. |
996 | This convenience function tries to build the program on all devices in |
|
|
997 | the context. If the build fails, then the function will C<croak> with the |
|
|
998 | build log. Otherwise ti returns the program object. |
364 | |
999 | |
365 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> |
1000 | The C<$program> can either be a C<OpenCL::Program> object or a string |
|
|
1001 | containing the program. In the latter case, a program objetc will be |
|
|
1002 | created automatically. |
|
|
1003 | |
|
|
1004 | =cut |
|
|
1005 | |
|
|
1006 | sub OpenCL::Context::build_program { |
|
|
1007 | my ($self, $prog, $options) = @_; |
|
|
1008 | |
|
|
1009 | $prog = $self->program_with_source ($prog) |
|
|
1010 | unless ref $prog; |
|
|
1011 | |
|
|
1012 | eval { $prog->build (undef, $options); 1 } |
|
|
1013 | or errno == BUILD_PROGRAM_FAILURE |
|
|
1014 | or errno == INVALID_BINARY # workaround nvidia bug |
|
|
1015 | or Carp::croak "OpenCL::Context->build_program: " . err2str; |
|
|
1016 | |
|
|
1017 | # we check status for all devices |
|
|
1018 | for my $dev ($self->devices) { |
|
|
1019 | $prog->build_status ($dev) == BUILD_SUCCESS |
|
|
1020 | or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n" |
|
|
1021 | . $prog->build_log ($dev); |
|
|
1022 | } |
|
|
1023 | |
|
|
1024 | $prog |
|
|
1025 | } |
366 | |
1026 | |
367 | =item $queue = $ctx->queue ($device, $properties) |
1027 | =item $queue = $ctx->queue ($device, $properties) |
368 | |
1028 | |
369 | Create a new OpenCL::Queue object from the context and the given device. |
1029 | Create a new OpenCL::Queue object from the context and the given device. |
370 | |
1030 | |
371 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> |
1031 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> |
372 | |
1032 | |
|
|
1033 | Example: create an out-of-order queue. |
|
|
1034 | |
|
|
1035 | $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE); |
|
|
1036 | |
373 | =item $ev = $ctx->user_event |
1037 | =item $ev = $ctx->user_event |
374 | |
1038 | |
375 | Creates a new OpenCL::UserEvent object. |
1039 | Creates a new OpenCL::UserEvent object. |
376 | |
1040 | |
377 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> |
1041 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateUserEvent.html> |
378 | |
1042 | |
379 | =item $buf = $ctx->buffer ($flags, $len) |
1043 | =item $buf = $ctx->buffer ($flags, $len) |
380 | |
1044 | |
381 | Creates a new OpenCL::Buffer object with the given flags and octet-size. |
1045 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object with the |
|
|
1046 | given flags and octet-size. |
382 | |
1047 | |
383 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> |
1048 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateBuffer.html> |
384 | |
1049 | |
385 | =item $buf = $ctx->buffer_sv ($flags, $data) |
1050 | =item $buf = $ctx->buffer_sv ($flags, $data) |
386 | |
1051 | |
387 | Creates a new OpenCL::Buffer object and initialise it with the given data values. |
1052 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and |
|
|
1053 | initialise it with the given data values. |
388 | |
1054 | |
|
|
1055 | =item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth = 0, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef) |
|
|
1056 | |
|
|
1057 | Creates a new OpenCL::Image object and optionally initialises it with |
|
|
1058 | the given data values. |
|
|
1059 | |
|
|
1060 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html> |
|
|
1061 | |
389 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data) |
1062 | =item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) |
390 | |
1063 | |
391 | Creates a new OpenCL::Image2D object and optionally initialises it with the given data values. |
1064 | Creates a new OpenCL::Image2D object and optionally initialises it with |
|
|
1065 | the given data values. |
392 | |
1066 | |
393 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> |
1067 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html> |
394 | |
1068 | |
395 | =item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data) |
1069 | =item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef) |
396 | |
1070 | |
397 | Creates a new OpenCL::Image3D object and optionally initialises it with the given data values. |
1071 | Creates a new OpenCL::Image3D object and optionally initialises it with |
|
|
1072 | the given data values. |
398 | |
1073 | |
399 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> |
1074 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html> |
|
|
1075 | |
|
|
1076 | =item $buffer = $ctx->gl_buffer ($flags, $bufobj) |
|
|
1077 | |
|
|
1078 | Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given |
|
|
1079 | OpenGL buffer object. |
|
|
1080 | |
|
|
1081 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html |
|
|
1082 | |
|
|
1083 | =item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture) |
|
|
1084 | |
|
|
1085 | Creates a new OpenCL::Image object that refers to the given OpenGL |
|
|
1086 | texture object or buffer. |
|
|
1087 | |
|
|
1088 | http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html |
|
|
1089 | |
|
|
1090 | =item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) |
|
|
1091 | |
|
|
1092 | Creates a new OpenCL::Image2D object that refers to the given OpenGL |
|
|
1093 | 2D texture object. |
|
|
1094 | |
|
|
1095 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html |
|
|
1096 | |
|
|
1097 | =item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture) |
|
|
1098 | |
|
|
1099 | Creates a new OpenCL::Image3D object that refers to the given OpenGL |
|
|
1100 | 3D texture object. |
|
|
1101 | |
|
|
1102 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html |
|
|
1103 | |
|
|
1104 | =item $ctx->gl_renderbuffer ($flags, $renderbuffer) |
|
|
1105 | |
|
|
1106 | Creates a new OpenCL::Image2D object that refers to the given OpenGL |
|
|
1107 | render buffer. |
|
|
1108 | |
|
|
1109 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLRenderbuffer.html |
400 | |
1110 | |
401 | =item @formats = $ctx->supported_image_formats ($flags, $image_type) |
1111 | =item @formats = $ctx->supported_image_formats ($flags, $image_type) |
402 | |
1112 | |
403 | Returns a list of matching image formats - each format is an arrayref with |
1113 | Returns a list of matching image formats - each format is an arrayref with |
404 | two values, $channel_order and $channel_type, in it. |
1114 | two values, $channel_order and $channel_type, in it. |
… | |
… | |
415 | |
1125 | |
416 | Creates a new OpenCL::Program object from the given source code. |
1126 | Creates a new OpenCL::Program object from the given source code. |
417 | |
1127 | |
418 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> |
1128 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateProgramWithSource.html> |
419 | |
1129 | |
|
|
1130 | =item $packed_value = $ctx->info ($name) |
|
|
1131 | |
|
|
1132 | See C<< $platform->info >> for details. |
|
|
1133 | |
|
|
1134 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetContextInfo.html> |
|
|
1135 | |
|
|
1136 | =for gengetinfo begin context |
|
|
1137 | |
|
|
1138 | =item $uint = $context->reference_count |
|
|
1139 | |
|
|
1140 | Calls C<clGetContextInfo> with C<CL_CONTEXT_REFERENCE_COUNT> and returns the result. |
|
|
1141 | |
|
|
1142 | =item @devices = $context->devices |
|
|
1143 | |
|
|
1144 | Calls C<clGetContextInfo> with C<CL_CONTEXT_DEVICES> and returns the result. |
|
|
1145 | |
|
|
1146 | =item @property_ints = $context->properties |
|
|
1147 | |
|
|
1148 | Calls C<clGetContextInfo> with C<CL_CONTEXT_PROPERTIES> and returns the result. |
|
|
1149 | |
|
|
1150 | =item $uint = $context->num_devices |
|
|
1151 | |
|
|
1152 | Calls C<clGetContextInfo> with C<CL_CONTEXT_NUM_DEVICES> and returns the result. |
|
|
1153 | |
|
|
1154 | =for gengetinfo end context |
|
|
1155 | |
420 | =back |
1156 | =back |
421 | |
1157 | |
422 | =head2 THE OpenCL::Queue CLASS |
1158 | =head2 THE OpenCL::Queue CLASS |
423 | |
1159 | |
424 | An OpenCL::Queue represents an execution queue for OpenCL. You execute |
1160 | An OpenCL::Queue represents an execution queue for OpenCL. You execute |
425 | requests by calling their respective C<enqueue_xxx> method and waitinf for |
1161 | requests by calling their respective method and waiting for it to complete |
426 | it to complete in some way. |
1162 | in some way. |
427 | |
1163 | |
428 | All the enqueue methods return an event object that can be used to wait |
1164 | Most methods that enqueue some request return an event object that can |
429 | for completion, unless the method is called in void context, in which case |
1165 | be used to wait for completion (optionally using a callback), unless |
430 | no event object is created. |
1166 | the method is called in void context, in which case no event object is |
|
|
1167 | created. |
431 | |
1168 | |
432 | They also allow you to specify any number of other event objects that this |
1169 | They also allow you to specify any number of other event objects that this |
433 | request has to wait for before it starts executing, by simply passing the |
1170 | request has to wait for before it starts executing, by simply passing the |
434 | event objects as extra parameters to the enqueue methods. |
1171 | event objects as extra parameters to the enqueue methods. To simplify |
|
|
1172 | program design, this module ignores any C<undef> values in the list of |
|
|
1173 | events. This makes it possible to code operations such as this, without |
|
|
1174 | having to put a valid event object into C<$event> first: |
|
|
1175 | |
|
|
1176 | $event = $queue->xxx (..., $event); |
435 | |
1177 | |
436 | Queues execute in-order by default, without any parallelism, so in most |
1178 | Queues execute in-order by default, without any parallelism, so in most |
437 | cases (i.e. you use only one queue) it's not necessary to wait for or |
1179 | cases (i.e. you use only one queue) it's not necessary to wait for or |
438 | create event objects. |
1180 | create event objects, althoguh an our of order queue is often a bit |
|
|
1181 | faster. |
439 | |
1182 | |
440 | =over 4 |
1183 | =over 4 |
441 | |
1184 | |
442 | =item $packed_value = $ctx->info ($name) |
|
|
443 | |
|
|
444 | See C<< $platform->info >> for details. |
|
|
445 | |
|
|
446 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> |
|
|
447 | |
|
|
448 | =item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) |
1185 | =item $ev = $queue->read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) |
449 | |
1186 | |
450 | Reads data from buffer into the given string. |
1187 | Reads data from buffer into the given string. |
451 | |
1188 | |
452 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> |
1189 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBuffer.html> |
453 | |
1190 | |
454 | =item $ev = $queue->enqueue_write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) |
1191 | =item $ev = $queue->write_buffer ($buffer, $blocking, $offset, $data, $wait_events...) |
455 | |
1192 | |
456 | Writes data to buffer from the given string. |
1193 | Writes data to buffer from the given string. |
457 | |
1194 | |
458 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html> |
1195 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBuffer.html> |
459 | |
1196 | |
460 | =item $ev = $queue->enqueue_copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) |
1197 | =item $ev = $queue->copy_buffer ($src, $dst, $src_offset, $dst_offset, $len, $wait_events...) |
461 | |
1198 | |
462 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> |
1199 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBuffer.html> |
463 | |
1200 | |
|
|
1201 | =item $ev = $queue->read_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...) |
|
|
1202 | |
|
|
1203 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadBufferRect.html |
|
|
1204 | |
|
|
1205 | =item $ev = $queue->write_buffer_rect (OpenCL::Memory buf, cl_bool blocking, $buf_x, $buf_y, $buf_z, $host_x, $host_y, $host_z, $width, $height, $depth, $buf_row_pitch, $buf_slice_pitch, $host_row_pitch, $host_slice_pitch, $data, $wait_events...) |
|
|
1206 | |
|
|
1207 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteBufferRect.html |
|
|
1208 | |
464 | =item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
1209 | =item $ev = $queue->read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
|
|
1210 | |
|
|
1211 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> |
|
|
1212 | |
|
|
1213 | =item $ev = $queue->copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
465 | |
1214 | |
466 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> |
1215 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html> |
467 | |
1216 | |
468 | =item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...) |
1217 | =item $ev = $queue->write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...) |
469 | |
1218 | |
470 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> |
1219 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html> |
471 | |
1220 | |
|
|
1221 | =item $ev = $queue->copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
|
|
1222 | |
|
|
1223 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> |
|
|
1224 | |
|
|
1225 | =item $ev = $queue->copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...) |
|
|
1226 | |
|
|
1227 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html> |
|
|
1228 | |
472 | =item $ev = $queue->enqueue_copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, 4dst_row_pitch, $dst_slice_pitch, $wait_event...) |
1229 | =item $ev = $queue->copy_buffer_rect ($src, $dst, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $src_row_pitch, $src_slice_pitch, $dst_row_pitch, $dst_slice_pitch, $wait_event...) |
473 | |
1230 | |
474 | Yeah. |
1231 | Yeah. |
475 | |
1232 | |
476 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html> |
|
|
477 | |
|
|
478 | =item $ev = $queue->enqueue_copy_buffer_to_image ($src_buffer, $dst_image, $src_offset, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
|
|
479 | |
|
|
480 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. |
1233 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. |
481 | |
1234 | |
482 | =item $ev = $queue->enqueue_copy_image ($src_image, $dst_image, $src_x, $src_y, $src_z, $dst_x, $dst_y, $dst_z, $width, $height, $depth, $wait_events...) |
1235 | =item $ev = $queue->fill_buffer ($mem, $pattern, $offset, $size, ...) |
483 | |
1236 | |
|
|
1237 | Fills the given buffer object with repeated applications of C<$pattern>, |
|
|
1238 | starting at C<$offset> for C<$size> octets. |
|
|
1239 | |
|
|
1240 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html> |
|
|
1241 | |
|
|
1242 | =item $ev = $queue->fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...) |
|
|
1243 | |
|
|
1244 | Fills the given image area with the given rgba colour components. The |
|
|
1245 | components are normally floating point values between C<0> and C<1>, |
|
|
1246 | except when the image channel data type is a signe dor unsigned |
|
|
1247 | unnormalised format, in which case the range is determined by the format. |
|
|
1248 | |
484 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html> |
1249 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html> |
485 | |
1250 | |
486 | =item $ev = $queue->enqueue_copy_image_to_buffer ($src_image, $dst_image, $src_x, $src_y, $src_z, $width, $height, $depth, $dst_offset, $wait_events...) |
|
|
487 | |
|
|
488 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html> |
|
|
489 | |
|
|
490 | =item $ev = $queue->enqueue_task ($kernel, $wait_events...) |
1251 | =item $ev = $queue->task ($kernel, $wait_events...) |
491 | |
1252 | |
492 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> |
1253 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> |
493 | |
1254 | |
494 | =item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) |
1255 | =item $ev = $queue->nd_range_kernel ($kernel, \@global_work_offset, \@global_work_size, \@local_work_size, $wait_events...) |
495 | |
1256 | |
496 | Enqueues a kernel execution. |
1257 | Enqueues a kernel execution. |
497 | |
1258 | |
498 | @$global_work_size must be specified as a reference to an array of |
1259 | \@global_work_size must be specified as a reference to an array of |
499 | integers specifying the work sizes (element counts). |
1260 | integers specifying the work sizes (element counts). |
500 | |
1261 | |
501 | @$global_work_offset must be either C<undef> (in which case all offsets |
1262 | \@global_work_offset must be either C<undef> (in which case all offsets |
502 | are C<0>), or a reference to an array of work offsets, with the same number |
1263 | are C<0>), or a reference to an array of work offsets, with the same number |
503 | of elements as @$global_work_size. |
1264 | of elements as \@global_work_size. |
504 | |
1265 | |
505 | @$local_work_size must be either C<undef> (in which case the |
1266 | \@local_work_size must be either C<undef> (in which case the |
506 | implementation is supposed to choose good local work sizes), or a |
1267 | implementation is supposed to choose good local work sizes), or a |
507 | reference to an array of local work sizes, with the same number of |
1268 | reference to an array of local work sizes, with the same number of |
508 | elements as @$global_work_size. |
1269 | elements as \@global_work_size. |
509 | |
1270 | |
510 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> |
1271 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> |
511 | |
1272 | |
512 | =item $ev = $queue->enqueue_marker |
1273 | =item $ev = $queue->acquire_gl_objects ([object, ...], $wait_events...) |
513 | |
1274 | |
|
|
1275 | Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired |
|
|
1276 | for subsequent OpenCL usage. |
|
|
1277 | |
514 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html> |
1278 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueAcquireGLObjects.html> |
515 | |
1279 | |
|
|
1280 | =item $ev = $queue->release_gl_objects ([object, ...], $wait_events...) |
|
|
1281 | |
|
|
1282 | Enqueues a list (an array-ref of OpenCL::Memory objects) to be released |
|
|
1283 | for subsequent OpenGL usage. |
|
|
1284 | |
|
|
1285 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReleaseGLObjects.html> |
|
|
1286 | |
516 | =item $ev = $queue->enqueue_wait_for_events ($wait_events...) |
1287 | =item $ev = $queue->wait_for_events ($wait_events...) |
517 | |
1288 | |
518 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> |
1289 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> |
519 | |
1290 | |
520 | =item $queue->enqueue_barrier |
1291 | =item $ev = $queue->marker ($wait_events...) |
521 | |
1292 | |
|
|
1293 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html> |
|
|
1294 | |
|
|
1295 | =item $ev = $queue->barrier ($wait_events...) |
|
|
1296 | |
522 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> |
1297 | L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html> |
523 | |
1298 | |
524 | =item $queue->flush |
1299 | =item $queue->flush |
525 | |
1300 | |
526 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> |
1301 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> |
527 | |
1302 | |
528 | =item $queue->finish |
1303 | =item $queue->finish |
529 | |
1304 | |
530 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> |
1305 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFinish.html> |
531 | |
1306 | |
|
|
1307 | =item $packed_value = $queue->info ($name) |
|
|
1308 | |
|
|
1309 | See C<< $platform->info >> for details. |
|
|
1310 | |
|
|
1311 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetCommandQueueInfo.html> |
|
|
1312 | |
|
|
1313 | =for gengetinfo begin command_queue |
|
|
1314 | |
|
|
1315 | =item $ctx = $command_queue->context |
|
|
1316 | |
|
|
1317 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_CONTEXT> and returns the result. |
|
|
1318 | |
|
|
1319 | =item $device = $command_queue->device |
|
|
1320 | |
|
|
1321 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_DEVICE> and returns the result. |
|
|
1322 | |
|
|
1323 | =item $uint = $command_queue->reference_count |
|
|
1324 | |
|
|
1325 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_REFERENCE_COUNT> and returns the result. |
|
|
1326 | |
|
|
1327 | =item $command_queue_properties = $command_queue->properties |
|
|
1328 | |
|
|
1329 | Calls C<clGetCommandQueueInfo> with C<CL_QUEUE_PROPERTIES> and returns the result. |
|
|
1330 | |
|
|
1331 | =for gengetinfo end command_queue |
|
|
1332 | |
532 | =back |
1333 | =back |
533 | |
1334 | |
534 | =head2 THE OpenCL::Memory CLASS |
1335 | =head2 THE OpenCL::Memory CLASS |
535 | |
1336 | |
536 | This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, |
1337 | This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, |
537 | OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class |
1338 | OpenCL::Image2D and OpenCL::Image3D. |
538 | currently only exist to allow type-checking. |
|
|
539 | |
1339 | |
540 | =over 4 |
1340 | =over 4 |
541 | |
1341 | |
542 | =item $packed_value = $memory->info ($name) |
1342 | =item $packed_value = $memory->info ($name) |
543 | |
1343 | |
544 | See C<< $platform->info >> for details. |
1344 | See C<< $platform->info >> for details. |
545 | |
1345 | |
546 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> |
1346 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetMemObjectInfo.html> |
547 | |
1347 | |
|
|
1348 | =for gengetinfo begin mem |
|
|
1349 | |
|
|
1350 | =item $mem_object_type = $mem->type |
|
|
1351 | |
|
|
1352 | Calls C<clGetMemObjectInfo> with C<CL_MEM_TYPE> and returns the result. |
|
|
1353 | |
|
|
1354 | =item $mem_flags = $mem->flags |
|
|
1355 | |
|
|
1356 | Calls C<clGetMemObjectInfo> with C<CL_MEM_FLAGS> and returns the result. |
|
|
1357 | |
|
|
1358 | =item $int = $mem->size |
|
|
1359 | |
|
|
1360 | Calls C<clGetMemObjectInfo> with C<CL_MEM_SIZE> and returns the result. |
|
|
1361 | |
|
|
1362 | =item $ptr_value = $mem->host_ptr |
|
|
1363 | |
|
|
1364 | Calls C<clGetMemObjectInfo> with C<CL_MEM_HOST_PTR> and returns the result. |
|
|
1365 | |
|
|
1366 | =item $uint = $mem->map_count |
|
|
1367 | |
|
|
1368 | Calls C<clGetMemObjectInfo> with C<CL_MEM_MAP_COUNT> and returns the result. |
|
|
1369 | |
|
|
1370 | =item $uint = $mem->reference_count |
|
|
1371 | |
|
|
1372 | Calls C<clGetMemObjectInfo> with C<CL_MEM_REFERENCE_COUNT> and returns the result. |
|
|
1373 | |
|
|
1374 | =item $ctx = $mem->context |
|
|
1375 | |
|
|
1376 | Calls C<clGetMemObjectInfo> with C<CL_MEM_CONTEXT> and returns the result. |
|
|
1377 | |
|
|
1378 | =item $mem = $mem->associated_memobject |
|
|
1379 | |
|
|
1380 | Calls C<clGetMemObjectInfo> with C<CL_MEM_ASSOCIATED_MEMOBJECT> and returns the result. |
|
|
1381 | |
|
|
1382 | =item $int = $mem->offset |
|
|
1383 | |
|
|
1384 | Calls C<clGetMemObjectInfo> with C<CL_MEM_OFFSET> and returns the result. |
|
|
1385 | |
|
|
1386 | =for gengetinfo end mem |
|
|
1387 | |
|
|
1388 | =item ($type, $name) = $mem->gl_object_info |
|
|
1389 | |
|
|
1390 | Returns the OpenGL object type (e.g. OpenCL::GL_OBJECT_TEXTURE2D) and the |
|
|
1391 | object "name" (e.g. the texture name) used to create this memory object. |
|
|
1392 | |
|
|
1393 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetGLObjectInfo.html> |
|
|
1394 | |
548 | =back |
1395 | =back |
549 | |
1396 | |
|
|
1397 | =head2 THE OpenCL::Buffer CLASS |
|
|
1398 | |
|
|
1399 | This is a subclass of OpenCL::Memory, and the superclass of |
|
|
1400 | OpenCL::BufferObj. Its purpose is simply to distinguish between buffers |
|
|
1401 | and sub-buffers. |
|
|
1402 | |
|
|
1403 | =head2 THE OpenCL::BufferObj CLASS |
|
|
1404 | |
|
|
1405 | This is a subclass of OpenCL::Buffer and thus OpenCL::Memory. It exists |
|
|
1406 | because one cna create sub buffers of OpenLC::BufferObj objects, but not |
|
|
1407 | sub buffers from these sub buffers. |
|
|
1408 | |
|
|
1409 | =over 4 |
|
|
1410 | |
|
|
1411 | =item $subbuf = $buf_obj->sub_buffer_region ($flags, $origin, $size) |
|
|
1412 | |
|
|
1413 | Creates an OpenCL::Buffer objects from this buffer and returns it. The |
|
|
1414 | C<buffer_create_type> is assumed to be C<CL_BUFFER_CREATE_TYPE_REGION>. |
|
|
1415 | |
|
|
1416 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateSubBuffer.html> |
|
|
1417 | |
|
|
1418 | =back |
|
|
1419 | |
|
|
1420 | =head2 THE OpenCL::Image CLASS |
|
|
1421 | |
|
|
1422 | This is the superclass of all image objects - OpenCL::Image1D, |
|
|
1423 | OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D, |
|
|
1424 | OpenCL::Image2DArray and OpenCL::Image3D. |
|
|
1425 | |
|
|
1426 | =over 4 |
|
|
1427 | |
|
|
1428 | =item $packed_value = $image->image_info ($name) |
|
|
1429 | |
|
|
1430 | See C<< $platform->info >> for details. |
|
|
1431 | |
|
|
1432 | The reason this method is not called C<info> is that there already is an |
|
|
1433 | C<< ->info >> method inherited from C<OpenCL::Memory>. |
|
|
1434 | |
|
|
1435 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> |
|
|
1436 | |
|
|
1437 | =item ($channel_order, $channel_data_type) = $image->format |
|
|
1438 | |
|
|
1439 | Returns the channel order and type used to create the image by calling |
|
|
1440 | C<clGetImageInfo> with C<CL_IMAGE_FORMAT>. |
|
|
1441 | |
|
|
1442 | =for gengetinfo begin image |
|
|
1443 | |
|
|
1444 | =item $int = $image->element_size |
|
|
1445 | |
|
|
1446 | Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. |
|
|
1447 | |
|
|
1448 | =item $int = $image->row_pitch |
|
|
1449 | |
|
|
1450 | Calls C<clGetImageInfo> with C<CL_IMAGE_ROW_PITCH> and returns the result. |
|
|
1451 | |
|
|
1452 | =item $int = $image->slice_pitch |
|
|
1453 | |
|
|
1454 | Calls C<clGetImageInfo> with C<CL_IMAGE_SLICE_PITCH> and returns the result. |
|
|
1455 | |
|
|
1456 | =item $int = $image->width |
|
|
1457 | |
|
|
1458 | Calls C<clGetImageInfo> with C<CL_IMAGE_WIDTH> and returns the result. |
|
|
1459 | |
|
|
1460 | =item $int = $image->height |
|
|
1461 | |
|
|
1462 | Calls C<clGetImageInfo> with C<CL_IMAGE_HEIGHT> and returns the result. |
|
|
1463 | |
|
|
1464 | =item $int = $image->depth |
|
|
1465 | |
|
|
1466 | Calls C<clGetImageInfo> with C<CL_IMAGE_DEPTH> and returns the result. |
|
|
1467 | |
|
|
1468 | =for gengetinfo end image |
|
|
1469 | |
|
|
1470 | =for gengetinfo begin gl_texture |
|
|
1471 | |
|
|
1472 | =item $GLenum = $gl_texture->target |
|
|
1473 | |
|
|
1474 | Calls C<clGetGLTextureInfo> with C<CL_GL_TEXTURE_TARGET> and returns the result. |
|
|
1475 | |
|
|
1476 | =item $GLint = $gl_texture->gl_mipmap_level |
|
|
1477 | |
|
|
1478 | Calls C<clGetGLTextureInfo> with C<CL_GL_MIPMAP_LEVEL> and returns the result. |
|
|
1479 | |
|
|
1480 | =for gengetinfo end gl_texture |
|
|
1481 | |
|
|
1482 | =back |
|
|
1483 | |
550 | =head2 THE OpenCL::Sampler CLASS |
1484 | =head2 THE OpenCL::Sampler CLASS |
551 | |
1485 | |
552 | =over 4 |
1486 | =over 4 |
553 | |
1487 | |
554 | =item $packed_value = $sampler->info ($name) |
1488 | =item $packed_value = $sampler->info ($name) |
555 | |
1489 | |
556 | See C<< $platform->info >> for details. |
1490 | See C<< $platform->info >> for details. |
557 | |
1491 | |
558 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> |
1492 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetSamplerInfo.html> |
559 | |
1493 | |
|
|
1494 | =for gengetinfo begin sampler |
|
|
1495 | |
|
|
1496 | =item $uint = $sampler->reference_count |
|
|
1497 | |
|
|
1498 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_REFERENCE_COUNT> and returns the result. |
|
|
1499 | |
|
|
1500 | =item $ctx = $sampler->context |
|
|
1501 | |
|
|
1502 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_CONTEXT> and returns the result. |
|
|
1503 | |
|
|
1504 | =item $addressing_mode = $sampler->normalized_coords |
|
|
1505 | |
|
|
1506 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_NORMALIZED_COORDS> and returns the result. |
|
|
1507 | |
|
|
1508 | =item $filter_mode = $sampler->addressing_mode |
|
|
1509 | |
|
|
1510 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_ADDRESSING_MODE> and returns the result. |
|
|
1511 | |
|
|
1512 | =item $boolean = $sampler->filter_mode |
|
|
1513 | |
|
|
1514 | Calls C<clGetSamplerInfo> with C<CL_SAMPLER_FILTER_MODE> and returns the result. |
|
|
1515 | |
|
|
1516 | =for gengetinfo end sampler |
|
|
1517 | |
560 | =back |
1518 | =back |
561 | |
1519 | |
562 | =head2 THE OpenCL::Program CLASS |
1520 | =head2 THE OpenCL::Program CLASS |
563 | |
1521 | |
564 | =over 4 |
1522 | =over 4 |
565 | |
1523 | |
566 | =item $packed_value = $program->info ($name) |
1524 | =item $program->build (\@devices = undef, $options = "", $cb->($program) = undef) |
567 | |
1525 | |
568 | See C<< $platform->info >> for details. |
|
|
569 | |
|
|
570 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> |
|
|
571 | |
|
|
572 | =item $program->build ($device, $options = "") |
|
|
573 | |
|
|
574 | Tries to build the program with the givne options. |
1526 | Tries to build the program with the given options. See also the |
|
|
1527 | C<$ctx->build> convenience function. |
|
|
1528 | |
|
|
1529 | If a callback is specified, then it will be called when compilation is |
|
|
1530 | finished. Note that many OpenCL implementations block your program while |
|
|
1531 | compiling whether you use a callback or not. See C<build_async> if you |
|
|
1532 | want to make sure the build is done in the background. |
|
|
1533 | |
|
|
1534 | Note that some OpenCL implementations act up badly, and don't call the |
|
|
1535 | callback in some error cases (but call it in others). This implementation |
|
|
1536 | assumes the callback will always be called, and leaks memory if this is |
|
|
1537 | not so. So best make sure you don't pass in invalid values. |
|
|
1538 | |
|
|
1539 | Some implementations fail with C<OpenCL::INVALID_BINARY> when the |
|
|
1540 | compilation state is successful but some later stage fails. |
575 | |
1541 | |
576 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> |
1542 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> |
|
|
1543 | |
|
|
1544 | =item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef) |
|
|
1545 | |
|
|
1546 | Similar to C<< ->build >>, except it starts a thread, and never fails (you |
|
|
1547 | need to check the compilation status form the callback, or by polling). |
577 | |
1548 | |
578 | =item $packed_value = $program->build_info ($device, $name) |
1549 | =item $packed_value = $program->build_info ($device, $name) |
579 | |
1550 | |
580 | Similar to C<< $platform->info >>, but returns build info for a previous |
1551 | Similar to C<< $platform->info >>, but returns build info for a previous |
581 | build attempt for the given device. |
1552 | build attempt for the given device. |
… | |
… | |
587 | Creates an OpenCL::Kernel object out of the named C<__kernel> function in |
1558 | Creates an OpenCL::Kernel object out of the named C<__kernel> function in |
588 | the program. |
1559 | the program. |
589 | |
1560 | |
590 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> |
1561 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> |
591 | |
1562 | |
|
|
1563 | =item @kernels = $program->kernels_in_program |
|
|
1564 | |
|
|
1565 | Returns all kernels successfully compiled for all devices in program. |
|
|
1566 | |
|
|
1567 | http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html |
|
|
1568 | |
|
|
1569 | =for gengetinfo begin program_build |
|
|
1570 | |
|
|
1571 | =item $build_status = $program->build_status ($device) |
|
|
1572 | |
|
|
1573 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_STATUS> and returns the result. |
|
|
1574 | |
|
|
1575 | =item $string = $program->build_options ($device) |
|
|
1576 | |
|
|
1577 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_OPTIONS> and returns the result. |
|
|
1578 | |
|
|
1579 | =item $string = $program->build_log ($device) |
|
|
1580 | |
|
|
1581 | Calls C<clGetProgramBuildInfo> with C<CL_PROGRAM_BUILD_LOG> and returns the result. |
|
|
1582 | |
|
|
1583 | =for gengetinfo end program_build |
|
|
1584 | |
|
|
1585 | =item $packed_value = $program->info ($name) |
|
|
1586 | |
|
|
1587 | See C<< $platform->info >> for details. |
|
|
1588 | |
|
|
1589 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> |
|
|
1590 | |
|
|
1591 | =for gengetinfo begin program |
|
|
1592 | |
|
|
1593 | =item $uint = $program->reference_count |
|
|
1594 | |
|
|
1595 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_REFERENCE_COUNT> and returns the result. |
|
|
1596 | |
|
|
1597 | =item $ctx = $program->context |
|
|
1598 | |
|
|
1599 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_CONTEXT> and returns the result. |
|
|
1600 | |
|
|
1601 | =item $uint = $program->num_devices |
|
|
1602 | |
|
|
1603 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_NUM_DEVICES> and returns the result. |
|
|
1604 | |
|
|
1605 | =item @devices = $program->devices |
|
|
1606 | |
|
|
1607 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_DEVICES> and returns the result. |
|
|
1608 | |
|
|
1609 | =item $string = $program->source |
|
|
1610 | |
|
|
1611 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_SOURCE> and returns the result. |
|
|
1612 | |
|
|
1613 | =item @ints = $program->binary_sizes |
|
|
1614 | |
|
|
1615 | Calls C<clGetProgramInfo> with C<CL_PROGRAM_BINARY_SIZES> and returns the result. |
|
|
1616 | |
|
|
1617 | =for gengetinfo end program |
|
|
1618 | |
|
|
1619 | =item @blobs = $program->binaries |
|
|
1620 | |
|
|
1621 | Returns a string for the compiled binary for every device associated with |
|
|
1622 | the program, empty strings indicate missing programs, and an empty result |
|
|
1623 | means no program binaries are available. |
|
|
1624 | |
|
|
1625 | These "binaries" are often, in fact, informative low-level assembly |
|
|
1626 | sources. |
|
|
1627 | |
|
|
1628 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProgramInfo.html> |
|
|
1629 | |
592 | =back |
1630 | =back |
593 | |
1631 | |
594 | =head2 THE OpenCL::Kernel CLASS |
1632 | =head2 THE OpenCL::Kernel CLASS |
595 | |
1633 | |
596 | =over 4 |
1634 | =over 4 |
… | |
… | |
599 | |
1637 | |
600 | See C<< $platform->info >> for details. |
1638 | See C<< $platform->info >> for details. |
601 | |
1639 | |
602 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> |
1640 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelInfo.html> |
603 | |
1641 | |
|
|
1642 | =for gengetinfo begin kernel |
|
|
1643 | |
|
|
1644 | =item $string = $kernel->function_name |
|
|
1645 | |
|
|
1646 | Calls C<clGetKernelInfo> with C<CL_KERNEL_FUNCTION_NAME> and returns the result. |
|
|
1647 | |
|
|
1648 | =item $uint = $kernel->num_args |
|
|
1649 | |
|
|
1650 | Calls C<clGetKernelInfo> with C<CL_KERNEL_NUM_ARGS> and returns the result. |
|
|
1651 | |
|
|
1652 | =item $uint = $kernel->reference_count |
|
|
1653 | |
|
|
1654 | Calls C<clGetKernelInfo> with C<CL_KERNEL_REFERENCE_COUNT> and returns the result. |
|
|
1655 | |
|
|
1656 | =item $ctx = $kernel->context |
|
|
1657 | |
|
|
1658 | Calls C<clGetKernelInfo> with C<CL_KERNEL_CONTEXT> and returns the result. |
|
|
1659 | |
|
|
1660 | =item $program = $kernel->program |
|
|
1661 | |
|
|
1662 | Calls C<clGetKernelInfo> with C<CL_KERNEL_PROGRAM> and returns the result. |
|
|
1663 | |
|
|
1664 | =for gengetinfo end kernel |
|
|
1665 | |
|
|
1666 | =item $packed_value = $kernel->work_group_info ($device, $name) |
|
|
1667 | |
|
|
1668 | See C<< $platform->info >> for details. |
|
|
1669 | |
|
|
1670 | The reason this method is not called C<info> is that there already is an |
|
|
1671 | C<< ->info >> method. |
|
|
1672 | |
|
|
1673 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetKernelWorkGroupInfo.html> |
|
|
1674 | |
|
|
1675 | =for gengetinfo begin kernel_work_group |
|
|
1676 | |
|
|
1677 | =item $int = $kernel->work_group_size ($device) |
|
|
1678 | |
|
|
1679 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_WORK_GROUP_SIZE> and returns the result. |
|
|
1680 | |
|
|
1681 | =item @ints = $kernel->compile_work_group_size ($device) |
|
|
1682 | |
|
|
1683 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_COMPILE_WORK_GROUP_SIZE> and returns the result. |
|
|
1684 | |
|
|
1685 | =item $ulong = $kernel->local_mem_size ($device) |
|
|
1686 | |
|
|
1687 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_LOCAL_MEM_SIZE> and returns the result. |
|
|
1688 | |
|
|
1689 | =item $int = $kernel->preferred_work_group_size_multiple ($device) |
|
|
1690 | |
|
|
1691 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE> and returns the result. |
|
|
1692 | |
|
|
1693 | =item $ulong = $kernel->private_mem_size ($device) |
|
|
1694 | |
|
|
1695 | Calls C<clGetKernelWorkGroupInfo> with C<CL_KERNEL_PRIVATE_MEM_SIZE> and returns the result. |
|
|
1696 | |
|
|
1697 | =for gengetinfo end kernel_work_group |
|
|
1698 | |
|
|
1699 | =item $kernel->setf ($format, ...) |
|
|
1700 | |
|
|
1701 | Sets the arguments of a kernel. Since OpenCL 1.1 doesn't have a generic |
|
|
1702 | way to set arguments (and with OpenCL 1.2 it might be rather slow), you |
|
|
1703 | need to specify a format argument, much as with C<printf>, to tell OpenCL |
|
|
1704 | what type of argument it is. |
|
|
1705 | |
|
|
1706 | The format arguments are single letters: |
|
|
1707 | |
|
|
1708 | c char |
|
|
1709 | C unsigned char |
|
|
1710 | s short |
|
|
1711 | S unsigned short |
|
|
1712 | i int |
|
|
1713 | I unsigned int |
|
|
1714 | l long |
|
|
1715 | L unsigned long |
|
|
1716 | |
|
|
1717 | h half float (0..65535) |
|
|
1718 | f float |
|
|
1719 | d double |
|
|
1720 | |
|
|
1721 | z local (octet size) |
|
|
1722 | |
|
|
1723 | m memory object (buffer or image) |
|
|
1724 | a sampler |
|
|
1725 | e event |
|
|
1726 | |
|
|
1727 | Space characters in the format string are ignored. |
|
|
1728 | |
|
|
1729 | Example: set the arguments for a kernel that expects an int, two floats, a buffer and an image. |
|
|
1730 | |
|
|
1731 | $kernel->setf ("i ff mm", 5, 0.5, 3, $buffer, $image); |
|
|
1732 | |
604 | =item $kernel->set_TYPE ($index, $value) |
1733 | =item $kernel->set_TYPE ($index, $value) |
605 | |
1734 | |
|
|
1735 | =item $kernel->set_char ($index, $value) |
|
|
1736 | |
|
|
1737 | =item $kernel->set_uchar ($index, $value) |
|
|
1738 | |
|
|
1739 | =item $kernel->set_short ($index, $value) |
|
|
1740 | |
|
|
1741 | =item $kernel->set_ushort ($index, $value) |
|
|
1742 | |
|
|
1743 | =item $kernel->set_int ($index, $value) |
|
|
1744 | |
|
|
1745 | =item $kernel->set_uint ($index, $value) |
|
|
1746 | |
|
|
1747 | =item $kernel->set_long ($index, $value) |
|
|
1748 | |
|
|
1749 | =item $kernel->set_ulong ($index, $value) |
|
|
1750 | |
|
|
1751 | =item $kernel->set_half ($index, $value) |
|
|
1752 | |
|
|
1753 | =item $kernel->set_float ($index, $value) |
|
|
1754 | |
|
|
1755 | =item $kernel->set_double ($index, $value) |
|
|
1756 | |
|
|
1757 | =item $kernel->set_memory ($index, $value) |
|
|
1758 | |
|
|
1759 | =item $kernel->set_buffer ($index, $value) |
|
|
1760 | |
|
|
1761 | =item $kernel->set_image ($index, $value) |
|
|
1762 | |
|
|
1763 | =item $kernel->set_sampler ($index, $value) |
|
|
1764 | |
|
|
1765 | =item $kernel->set_local ($index, $value) |
|
|
1766 | |
|
|
1767 | =item $kernel->set_event ($index, $value) |
|
|
1768 | |
606 | This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. |
1769 | This is a family of methods to set the kernel argument with the number |
607 | |
1770 | C<$index> to the give C<$value>. |
608 | TYPE is one of C<char>, C<uchar>, C<short>, C<ushort>, C<int>, C<uint>, |
|
|
609 | C<long>, C<ulong>, C<half>, C<float>, C<double>, C<memory>, C<buffer>, |
|
|
610 | C<image2d>, C<image3d>, C<sampler> or C<event>. |
|
|
611 | |
1771 | |
612 | Chars and integers (including the half type) are specified as integers, |
1772 | Chars and integers (including the half type) are specified as integers, |
613 | float and double as floating point values, memory/buffer/image2d/image3d |
1773 | float and double as floating point values, memory/buffer/image must be |
614 | must be an object of that type or C<undef>, and sampler and event must be |
1774 | an object of that type or C<undef>, local-memory arguments are set by |
615 | objects of that type. |
1775 | specifying the size, and sampler and event must be objects of that type. |
|
|
1776 | |
|
|
1777 | Note that C<set_memory> works for all memory objects (all types of buffers |
|
|
1778 | and images) - the main purpose of the more specific C<set_TYPE> functions |
|
|
1779 | is type checking. |
|
|
1780 | |
|
|
1781 | Setting an argument for a kernel does NOT keep a reference to the object - |
|
|
1782 | for example, if you set an argument to some image object, free the image, |
|
|
1783 | and call the kernel, you will run into undefined behaviour. |
616 | |
1784 | |
617 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> |
1785 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> |
618 | |
1786 | |
619 | =back |
1787 | =back |
620 | |
1788 | |
… | |
… | |
623 | This is the superclass for all event objects (including OpenCL::UserEvent |
1791 | This is the superclass for all event objects (including OpenCL::UserEvent |
624 | objects). |
1792 | objects). |
625 | |
1793 | |
626 | =over 4 |
1794 | =over 4 |
627 | |
1795 | |
|
|
1796 | =item $ev->wait |
|
|
1797 | |
|
|
1798 | Waits for the event to complete. |
|
|
1799 | |
|
|
1800 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> |
|
|
1801 | |
|
|
1802 | =item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status)) |
|
|
1803 | |
|
|
1804 | Adds a callback to the callback stack for the given event type. There is |
|
|
1805 | no way to remove a callback again. |
|
|
1806 | |
|
|
1807 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html> |
|
|
1808 | |
628 | =item $packed_value = $ev->info ($name) |
1809 | =item $packed_value = $ev->info ($name) |
629 | |
1810 | |
630 | See C<< $platform->info >> for details. |
1811 | See C<< $platform->info >> for details. |
631 | |
1812 | |
632 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> |
1813 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html> |
633 | |
1814 | |
634 | =item $ev->wait |
1815 | =for gengetinfo begin event |
635 | |
1816 | |
636 | Waits for the event to complete. |
1817 | =item $queue = $event->command_queue |
637 | |
1818 | |
|
|
1819 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_QUEUE> and returns the result. |
|
|
1820 | |
|
|
1821 | =item $command_type = $event->command_type |
|
|
1822 | |
|
|
1823 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_TYPE> and returns the result. |
|
|
1824 | |
|
|
1825 | =item $uint = $event->reference_count |
|
|
1826 | |
|
|
1827 | Calls C<clGetEventInfo> with C<CL_EVENT_REFERENCE_COUNT> and returns the result. |
|
|
1828 | |
|
|
1829 | =item $uint = $event->command_execution_status |
|
|
1830 | |
|
|
1831 | Calls C<clGetEventInfo> with C<CL_EVENT_COMMAND_EXECUTION_STATUS> and returns the result. |
|
|
1832 | |
|
|
1833 | =item $ctx = $event->context |
|
|
1834 | |
|
|
1835 | Calls C<clGetEventInfo> with C<CL_EVENT_CONTEXT> and returns the result. |
|
|
1836 | |
|
|
1837 | =for gengetinfo end event |
|
|
1838 | |
|
|
1839 | =item $packed_value = $ev->profiling_info ($name) |
|
|
1840 | |
|
|
1841 | See C<< $platform->info >> for details. |
|
|
1842 | |
|
|
1843 | The reason this method is not called C<info> is that there already is an |
|
|
1844 | C<< ->info >> method. |
|
|
1845 | |
638 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> |
1846 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetProfilingInfo.html> |
|
|
1847 | |
|
|
1848 | =for gengetinfo begin profiling |
|
|
1849 | |
|
|
1850 | =item $ulong = $event->profiling_command_queued |
|
|
1851 | |
|
|
1852 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_QUEUED> and returns the result. |
|
|
1853 | |
|
|
1854 | =item $ulong = $event->profiling_command_submit |
|
|
1855 | |
|
|
1856 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_SUBMIT> and returns the result. |
|
|
1857 | |
|
|
1858 | =item $ulong = $event->profiling_command_start |
|
|
1859 | |
|
|
1860 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_START> and returns the result. |
|
|
1861 | |
|
|
1862 | =item $ulong = $event->profiling_command_end |
|
|
1863 | |
|
|
1864 | Calls C<clGetEventProfilingInfo> with C<CL_PROFILING_COMMAND_END> and returns the result. |
|
|
1865 | |
|
|
1866 | =for gengetinfo end profiling |
639 | |
1867 | |
640 | =back |
1868 | =back |
641 | |
1869 | |
642 | =head2 THE OpenCL::UserEvent CLASS |
1870 | =head2 THE OpenCL::UserEvent CLASS |
643 | |
1871 | |
… | |
… | |
645 | |
1873 | |
646 | =over 4 |
1874 | =over 4 |
647 | |
1875 | |
648 | =item $ev->set_status ($execution_status) |
1876 | =item $ev->set_status ($execution_status) |
649 | |
1877 | |
|
|
1878 | Sets the execution status of the user event. Can only be called once, |
|
|
1879 | either with OpenCL::COMPLETE or a negative number as status. |
|
|
1880 | |
650 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> |
1881 | L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html> |
651 | |
1882 | |
652 | =back |
1883 | =back |
653 | |
1884 | |
654 | =cut |
1885 | =cut |
655 | |
|
|
656 | package OpenCL; |
|
|
657 | |
|
|
658 | use common::sense; |
|
|
659 | |
|
|
660 | BEGIN { |
|
|
661 | our $VERSION = '0.14'; |
|
|
662 | |
|
|
663 | require XSLoader; |
|
|
664 | XSLoader::load (__PACKAGE__, $VERSION); |
|
|
665 | |
|
|
666 | @OpenCL::Buffer::ISA = |
|
|
667 | @OpenCL::Image::ISA = OpenCL::Memory::; |
|
|
668 | |
|
|
669 | @OpenCL::Image2D::ISA = |
|
|
670 | @OpenCL::Image3D::ISA = OpenCL::Image::; |
|
|
671 | |
|
|
672 | @OpenCL::UserEvent::ISA = OpenCL::Event::; |
|
|
673 | } |
|
|
674 | |
1886 | |
675 | 1; |
1887 | 1; |
676 | |
1888 | |
677 | =head1 AUTHOR |
1889 | =head1 AUTHOR |
678 | |
1890 | |