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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.47 by root, Sat Apr 21 19:48:58 2012 UTC vs.
Revision 1.54 by root, Tue Apr 24 14:57:06 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.97';
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.
… …
752 812
753Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result. 813Calls C<clGetDeviceInfo> with C<CL_DEVICE_AFFINITY_DOMAINS_EXT> and returns the result.
754 814
755=item $uint = $device->reference_count_ext 815=item $uint = $device->reference_count_ext
756 816
757Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT > and returns the result. 817Calls C<clGetDeviceInfo> with C<CL_DEVICE_REFERENCE_COUNT_EXT> and returns the result.
758 818
759=item @device_partition_property_exts = $device->partition_style_ext 819=item @device_partition_property_exts = $device->partition_style_ext
760 820
761Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result. 821Calls C<clGetDeviceInfo> with C<CL_DEVICE_PARTITION_STYLE_EXT> and returns the result.
762 822
… …
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 require Carp;
847
848 $prog = $self->program_with_source ($prog)
849 unless ref $prog;
850
851 for my $dev ($self->devices) {
852 eval { $prog->build ($dev, $options); 1 }
853 or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
854 . $prog->build_log ($dev));
855 }
856
857 $prog
858}
770 859
771=item $queue = $ctx->queue ($device, $properties) 860=item $queue = $ctx->queue ($device, $properties)
772 861
773Create a new OpenCL::Queue object from the context and the given device. 862Create a new OpenCL::Queue object from the context and the given device.
774 863
… …
793 882
794=item $buf = $ctx->buffer_sv ($flags, $data) 883=item $buf = $ctx->buffer_sv ($flags, $data)
795 884
796Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 885Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
797initialise it with the given data values. 886initialise it with the given data values.
887
888=item $img = $ctx->image ($self, $flags, $channel_order, $channel_type, $type, $width, $height, $depth, $array_size = 0, $row_pitch = 0, $slice_pitch = 0, $num_mip_level = 0, $num_samples = 0, $*data = &PL_sv_undef)
889
890Creates a new OpenCL::Image object and optionally initialises it with
891the given data values.
892
893L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
798 894
799=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 895=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
800 896
801Creates a new OpenCL::Image2D object and optionally initialises it with 897Creates a new OpenCL::Image2D object and optionally initialises it with
802the given data values. 898the given data values.
… …
966 1062
967Yeah. 1063Yeah.
968 1064
969L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>. 1065L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
970 1066
1067=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
1068
1069Fills the given buffer object with repeated applications of C<$pattern>,
1070starting at C<$offset> for C<$size> octets.
1071
1072L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
1073
1074=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
1075
1076Fills the given image area with the given rgba colour components. The
1077components are normally floating point values between C<0> and C<1>,
1078except when the image channel data type is a signe dor unsigned
1079unnormalised format, in which case the range is determined by the format.
1080
1081L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
1082
971=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1083=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
972 1084
973L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html> 1085L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
974 1086
975=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...) 1087=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)
… …
1143OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D, 1255OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1144OpenCL::Image2DArray and OpenCL::Image3D. 1256OpenCL::Image2DArray and OpenCL::Image3D.
1145 1257
1146=over 4 1258=over 4
1147 1259
1148=item $packed_value = $ev->image_info ($name) 1260=item $packed_value = $image->image_info ($name)
1149 1261
1150See C<< $platform->info >> for details. 1262See C<< $platform->info >> for details.
1151 1263
1152The reason this method is not called C<info> is that there already is an 1264The reason this method is not called C<info> is that there already is an
1153C<< ->info >> method inherited from C<OpenCL::Memory>. 1265C<< ->info >> method inherited from C<OpenCL::Memory>.
1154 1266
1155L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html> 1267L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1156 1268
1269=item ($channel_order, $channel_data_type) = $image->format
1270
1271Returns the channel order and type used to create the image by calling
1272C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
1273
1157=for gengetinfo begin image 1274=for gengetinfo begin image
1158 1275
1159=item $int = $image->element_size 1276=item $int = $image->element_size
1160 1277
1161Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result. 1278Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
… …
1236 1353
1237=over 4 1354=over 4
1238 1355
1239=item $program->build ($device, $options = "") 1356=item $program->build ($device, $options = "")
1240 1357
1241Tries to build the program with the givne options. 1358Tries to build the program with the given options. See also the
1359C<$ctx->build> convenience function.
1242 1360
1243L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1361L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1244 1362
1245=item $packed_value = $program->build_info ($device, $name) 1363=item $packed_value = $program->build_info ($device, $name)
1246 1364
… …
1253 1371
1254Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1372Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1255the program. 1373the program.
1256 1374
1257L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1375L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1376
1377=item @kernels = $program->kernels_in_program
1378
1379Returns all kernels successfully compiled for all devices in program.
1380
1381http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1258 1382
1259=for gengetinfo begin program_build 1383=for gengetinfo begin program_build
1260 1384
1261=item $build_status = $program->build_status ($device) 1385=item $build_status = $program->build_status ($device)
1262 1386
… …
1398float and double as floating point values, memory/buffer/image2d/image3d 1522float and double as floating point values, memory/buffer/image2d/image3d
1399must be an object of that type or C<undef>, local-memory arguments are 1523must be an object of that type or C<undef>, local-memory arguments are
1400set by specifying the size, and sampler and event must be objects of that 1524set by specifying the size, and sampler and event must be objects of that
1401type. 1525type.
1402 1526
1527Setting an argument for a kernel does NOT keep a reference to the object -
1528for example, if you set an argument to some image object, free the image,
1529and call the kernel, you will run into undefined behaviour.
1530
1403L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1531L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1404 1532
1405=back 1533=back
1406 1534
1407=head2 THE OpenCL::Event CLASS 1535=head2 THE OpenCL::Event CLASS
… …
1490 1618
1491=back 1619=back
1492 1620
1493=cut 1621=cut
1494 1622
1495package OpenCL;
1496
1497use common::sense;
1498
1499BEGIN {
1500 our $VERSION = '0.96';
1501
1502 require XSLoader;
1503 XSLoader::load (__PACKAGE__, $VERSION);
1504
1505 @OpenCL::Buffer::ISA =
1506 @OpenCL::Image::ISA = OpenCL::Memory::;
1507
1508 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1509
1510 @OpenCL::Image2D::ISA =
1511 @OpenCL::Image3D::ISA =
1512 @OpenCL::Image2DArray::ISA =
1513 @OpenCL::Image1D::ISA =
1514 @OpenCL::Image1DArray::ISA =
1515 @OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1516
1517 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1518}
1519
15201; 16231;
1521 1624
1522=head1 AUTHOR 1625=head1 AUTHOR
1523 1626
1524 Marc Lehmann <schmorp@schmorp.de> 1627 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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