ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/OpenCL/OpenCL.pm
(Generate patch)

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.49 by root, Sat Apr 21 20:48:03 2012 UTC vs.
Revision 1.53 by root, Tue Apr 24 14:30:57 2012 UTC

… …
157 $id = get_global_id (0); 157 $id = get_global_id (0);
158 output [id] = input [id] * input [id]; 158 output [id] = input [id] * input [id];
159 } 159 }
160 '; 160 ';
161 161
162 my $prog = $ctx->program_with_source ($src); 162 my $prog = $ctx->build_program ($src);
163
164 # build croaks on compile errors, so catch it and print the compile errors
165 eval { $prog->build ($dev, "-cl-fast-relaxed-math"); 1 }
166 or die $prog->build_log;
167
168 my $kernel = $prog->kernel ("squareit"); 163 my $kernel = $prog->kernel ("squareit");
169 164
170=head2 Create some input and output float buffers, then call the 165=head2 Create some input and output float buffers, then call the
171'squareit' kernel on them. 166'squareit' kernel on them.
172 167
… …
267 262
268 float3 colour = (float3)(z.x, z.y, z.x * z.y); 263 float3 colour = (float3)(z.x, z.y, z.x * z.y);
269 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.)); 264 write_imagef (img, (int2)(get_global_id (0), get_global_id (1)), (float4)(colour * p.x * p.x, 1.));
270 } 265 }
271 EOF 266 EOF
267
272 my $prog = $ctx->program_with_source ($src); 268 my $prog = $ctx->build_program ($src);
273 eval { $prog->build ($dev); 1 }
274 or die $prog->build_log ($dev);
275
276 my $kernel = $prog->kernel ("juliatunnel"); 269 my $kernel = $prog->kernel ("juliatunnel");
277 270
278 # program compiled, kernel ready, now draw and loop 271 # program compiled, kernel ready, now draw and loop
279 272
280 for (my $time; ; ++$time) { 273 for (my $time; ; ++$time) {
… …
383 376
384For this to work, the OpenGL library must be loaded, a GLX context must 377For this to work, the OpenGL library must be loaded, a GLX context must
385have been created and be made current, and C<dlsym> must be available and 378have been created and be made current, and C<dlsym> must be available and
386capable of finding the function via C<RTLD_DEFAULT>. 379capable of finding the function via C<RTLD_DEFAULT>.
387 380
381=cut
382
383package OpenCL;
384
385use common::sense;
386
387BEGIN {
388 our $VERSION = '0.96';
389
390 require XSLoader;
391 XSLoader::load (__PACKAGE__, $VERSION);
392
393 @OpenCL::Platform::ISA =
394 @OpenCL::Device::ISA =
395 @OpenCL::Context::ISA =
396 @OpenCL::Queue::ISA =
397 @OpenCL::Memory::ISA =
398 @OpenCL::Sampler::ISA =
399 @OpenCL::Program::ISA =
400 @OpenCL::Kernel::ISA =
401 @OpenCL::Event::ISA = OpenCL::Object::;
402
403 @OpenCL::Buffer::ISA =
404 @OpenCL::Image::ISA = OpenCL::Memory::;
405
406 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
407
408 @OpenCL::Image2D::ISA =
409 @OpenCL::Image3D::ISA =
410 @OpenCL::Image2DArray::ISA =
411 @OpenCL::Image1D::ISA =
412 @OpenCL::Image1DArray::ISA =
413 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
414
415 @OpenCL::UserEvent::ISA = OpenCL::Event::;
416}
417
388=head2 THE OpenCL PACKAGE 418=head2 THE OpenCL PACKAGE
389 419
390=over 4 420=over 4
391 421
392=item $int = OpenCL::errno 422=item $int = OpenCL::errno
… …
424 454
425L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html> 455L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
426 456
427=back 457=back
428 458
459=head2 THE OpenCL::Object CLASS
460
461This is the base class for all objects in the OpenCL module. The only
462method it implements is the C<id> method, which is only useful if you want
463to interface to OpenCL on the C level.
464
465=over 4
466
467=item $iv = $obj->id
468
469OpenCL objects are represented by pointers or integers on the C level. If
470you want to interface to an OpenCL object directly on the C level, then
471you need this value, which is returned by this method. You should use an
472C<IV> type in your code and cast that to the correct type.
473
474=cut
475
476sub OpenCL::Object::id {
477 ${$_[0]}
478}
479
480=back
481
429=head2 THE OpenCL::Platform CLASS 482=head2 THE OpenCL::Platform CLASS
430 483
431=over 4 484=over 4
432 485
433=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) 486=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
… …
456It's best to avoid this method and use one of the following convenience 509It's best to avoid this method and use one of the following convenience
457wrappers. 510wrappers.
458 511
459L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html> 512L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformInfo.html>
460 513
514=item $platform->unload_compiler
515
516Attempts to unload the compiler for this platform, for endless
517profit. Does nothing on OpenCL 1.1.
518
519L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clUnloadPlatformCompiler.html>
520
461=for gengetinfo begin platform 521=for gengetinfo begin platform
462 522
463=item $string = $platform->profile 523=item $string = $platform->profile
464 524
465Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result. 525Calls C<clGetPlatformInfo> with C<CL_PLATFORM_PROFILE> and returns the result.
… …
765=back 825=back
766 826
767=head2 THE OpenCL::Context CLASS 827=head2 THE OpenCL::Context CLASS
768 828
769=over 4 829=over 4
830
831=item $prog = $ctx->build_program ($program, $options = "")
832
833This convenience function tries to build the program on all devices in
834the context. If the build fails, then the function will C<croak> with the
835build log. Otherwise ti returns the program object.
836
837The C<$program> can either be a C<OpenCL::Program> object or a string
838containing the program. In the latter case, a program objetc will be
839created automatically.
840
841=cut
842
843sub OpenCL::Context::build_program {
844 my ($self, $prog, $options) = @_;
845
846 $prog = $self->program_with_source ($prog)
847 unless ref $prog;
848
849 for my $dev ($self->devices) {
850 eval { $prog->build ($dev, $options); 1 }
851 or Carp::croak "Building OpenCL program for device '" . $dev->name . "' failed:\n"
852 . $prog->build_log ($dev);
853 }
854
855 $prog
856}
770 857
771=item $queue = $ctx->queue ($device, $properties) 858=item $queue = $ctx->queue ($device, $properties)
772 859
773Create a new OpenCL::Queue object from the context and the given device. 860Create a new OpenCL::Queue object from the context and the given device.
774 861
… …
973 1060
974Yeah. 1061Yeah.
975 1062
976L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1063L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
977 1064
1065=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
1066
1067Fills the given buffer object with repeated applications of C<$pattern>,
1068starting at C<$offset> for C<$size> octets.
1069
1070L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1071
1072=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1073
1074Fills the given image area with the given rgba colour components. The
1075components are normally floating point values between C<0> and C<1>,
1076except when the image channel data type is a signe dor unsigned
1077unnormalised format, in which case the range is determined by the format.
1078
1079L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1080
978=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1081=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
979 1082
980L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1083L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
981 1084
982=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) 1085=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)
… …
1150OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D, 1253OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1151OpenCL::Image2DArray and OpenCL::Image3D. 1254OpenCL::Image2DArray and OpenCL::Image3D.
1152 1255
1153=over 4 1256=over 4
1154 1257
1155=item $packed_value = $ev->image_info ($name) 1258=item $packed_value = $image->image_info ($name)
1156 1259
1157See C<< $platform->info >> for details. 1260See C<< $platform->info >> for details.
1158 1261
1159The reason this method is not called C<info> is that there already is an 1262The reason this method is not called C<info> is that there already is an
1160C<< ->info >> method inherited from C<OpenCL::Memory>. 1263C<< ->info >> method inherited from C<OpenCL::Memory>.
1161 1264
1162L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1265L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1163 1266
1267=item ($channel_order, $channel_data_type) = $image->format
1268
1269Returns the channel order and type used to create the image by calling
1270C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1271
1164=for gengetinfo begin image 1272=for gengetinfo begin image
1165 1273
1166=item $int = $image->element_size 1274=item $int = $image->element_size
1167 1275
1168Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1276Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
… …
1243 1351
1244=over 4 1352=over 4
1245 1353
1246=item $program->build ($device, $options = "") 1354=item $program->build ($device, $options = "")
1247 1355
1248Tries to build the program with the givne options. 1356Tries to build the program with the given options. See also the
1357C<$ctx->build> convenience function.
1249 1358
1250L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1359L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1251 1360
1252=item $packed_value = $program->build_info ($device, $name) 1361=item $packed_value = $program->build_info ($device, $name)
1253 1362
… …
1260 1369
1261Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1370Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1262the program. 1371the program.
1263 1372
1264L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1373L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1374
1375=item @kernels = $program->kernels_in_program
1376
1377Returns all kernels successfully compiled for all devices in program.
1378
1379http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1265 1380
1266=for gengetinfo begin program_build 1381=for gengetinfo begin program_build
1267 1382
1268=item $build_status = $program->build_status ($device) 1383=item $build_status = $program->build_status ($device)
1269 1384
… …
1405float and double as floating point values, memory/buffer/image2d/image3d 1520float and double as floating point values, memory/buffer/image2d/image3d
1406must be an object of that type or C<undef>, local-memory arguments are 1521must be an object of that type or C<undef>, local-memory arguments are
1407set by specifying the size, and sampler and event must be objects of that 1522set by specifying the size, and sampler and event must be objects of that
1408type. 1523type.
1409 1524
1525Setting an argument for a kernel does NOT keep a reference to the object -
1526for example, if you set an argument to some image object, free the image,
1527and call the kernel, you will run into undefined behaviour.
1528
1410L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1529L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1411 1530
1412=back 1531=back
1413 1532
1414=head2 THE OpenCL::Event CLASS 1533=head2 THE OpenCL::Event CLASS
… …
1497 1616
1498=back 1617=back
1499 1618
1500=cut 1619=cut
1501 1620
1502package OpenCL;
1503
1504use common::sense;
1505
1506BEGIN {
1507 our $VERSION = '0.96';
1508
1509 require XSLoader;
1510 XSLoader::load (__PACKAGE__, $VERSION);
1511
1512 @OpenCL::Buffer::ISA =
1513 @OpenCL::Image::ISA = OpenCL::Memory::;
1514
1515 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1516
1517 @OpenCL::Image2D::ISA =
1518 @OpenCL::Image3D::ISA =
1519 @OpenCL::Image2DArray::ISA =
1520 @OpenCL::Image1D::ISA =
1521 @OpenCL::Image1DArray::ISA =
1522 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1523
1524 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1525}
1526
15271; 16211;
1528 1622
1529=head1 AUTHOR 1623=head1 AUTHOR
1530 1624
1531 Marc Lehmann <schmorp@schmorp.de> 1625 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines