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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.44 by root, Sat Apr 21 17:47:23 2012 UTC vs.
Revision 1.52 by root, Tue Apr 24 14:24:42 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.
… …
750 810
751=item @device_partition_property_exts = $device->affinity_domains_ext 811=item @device_partition_property_exts = $device->affinity_domains_ext
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
… …
766 826
767=head2 THE OpenCL::Context CLASS 827=head2 THE OpenCL::Context CLASS
768 828
769=over 4 829=over 4
770 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}
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
775L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html> 862L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateCommandQueue.html>
863
864Example: create an out-of-order queue.
865
866 $queue = $ctx->queue ($device, OpenCL::QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE);
776 867
777=item $ev = $ctx->user_event 868=item $ev = $ctx->user_event
778 869
779Creates a new OpenCL::UserEvent object. 870Creates a new OpenCL::UserEvent object.
780 871
… …
790=item $buf = $ctx->buffer_sv ($flags, $data) 881=item $buf = $ctx->buffer_sv ($flags, $data)
791 882
792Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and 883Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object and
793initialise it with the given data values. 884initialise it with the given data values.
794 885
886=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)
887
888Creates a new OpenCL::Image object and optionally initialises it with
889the given data values.
890
891L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html>
892
795=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef) 893=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
796 894
797Creates a new OpenCL::Image2D object and optionally initialises it with 895Creates a new OpenCL::Image2D object and optionally initialises it with
798the given data values. 896the given data values.
799 897
… …
811Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given 909Creates a new OpenCL::Buffer (actually OpenCL::BufferObj) object that refers to the given
812OpenGL buffer object. 910OpenGL buffer object.
813 911
814http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html 912http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLBuffer.html
815 913
914=item $img = $ctx->gl_texture ($flags, $target, $miplevel, $texture)
915
916Creates a new OpenCL::Image object that refers to the given OpenGL
917texture object or buffer.
918
919http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html
920
816=item $ctx->gl_texture2d ($flags, $target, $miplevel, $texture) 921=item $img = $ctx->gl_texture2d ($flags, $target, $miplevel, $texture)
817 922
818Creates a new OpenCL::Image2D object that refers to the given OpenGL 923Creates a new OpenCL::Image2D object that refers to the given OpenGL
8192D texture object. 9242D texture object.
820 925
821http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html 926http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture2D.html
822 927
823=item $ctx->gl_texture3d ($flags, $target, $miplevel, $texture) 928=item $img = $ctx->gl_texture3d ($flags, $target, $miplevel, $texture)
824 929
825Creates a new OpenCL::Image3D object that refers to the given OpenGL 930Creates a new OpenCL::Image3D object that refers to the given OpenGL
8263D texture object. 9313D texture object.
827 932
828http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html 933http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateFromGLTexture3D.html
… …
891for completion, unless the method is called in void context, in which case 996for completion, unless the method is called in void context, in which case
892no event object is created. 997no event object is created.
893 998
894They also allow you to specify any number of other event objects that this 999They also allow you to specify any number of other event objects that this
895request has to wait for before it starts executing, by simply passing the 1000request has to wait for before it starts executing, by simply passing the
896event objects as extra parameters to the enqueue methods. 1001event objects as extra parameters to the enqueue methods. To simplify
1002program design, this module ignores any C<undef> values in the list of
1003events. This makes it possible to code operations such as this, without
1004having to put a valid event object into C<$event> first:
1005
1006 $event = $queue->enqueue_xxx (..., $event);
897 1007
898Queues execute in-order by default, without any parallelism, so in most 1008Queues execute in-order by default, without any parallelism, so in most
899cases (i.e. you use only one queue) it's not necessary to wait for or 1009cases (i.e. you use only one queue) it's not necessary to wait for or
900create event objects. 1010create event objects, althoguh an our of order queue is often a bit
1011faster.
901 1012
902=over 4 1013=over 4
903 1014
904=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) 1015=item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...)
905 1016
… …
948=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, $dst_row_pitch, $dst_slice_pitch, $wait_event...) 1059=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, $dst_row_pitch, $dst_slice_pitch, $wait_event...)
949 1060
950Yeah. 1061Yeah.
951 1062
952L<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>.
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>
953 1080
954=item $ev = $queue->enqueue_task ($kernel, $wait_events...) 1081=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
955 1082
956L<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>
957 1084
… …
971reference to an array of local work sizes, with the same number of 1098reference to an array of local work sizes, with the same number of
972elements as @$global_work_size. 1099elements as @$global_work_size.
973 1100
974L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html> 1101L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueNDRangeKernel.html>
975 1102
976=item $ev = $queue->enqueue_marker ($wait_events...)
977
978L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueMarker.html>
979
980=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...) 1103=item $ev = $queue->enqueue_acquire_gl_objects ([object, ...], $wait_events...)
981 1104
982Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired 1105Enqueues a list (an array-ref of OpenCL::Memory objects) to be acquired
983for subsequent OpenCL usage. 1106for subsequent OpenCL usage.
984 1107
… …
993 1116
994=item $ev = $queue->enqueue_wait_for_events ($wait_events...) 1117=item $ev = $queue->enqueue_wait_for_events ($wait_events...)
995 1118
996L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html> 1119L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWaitForEvents.html>
997 1120
998=item $queue->enqueue_barrier 1121=item $ev = $queue->enqueue_marker ($wait_events...)
999 1122
1123L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueMarkerWithWaitList.html>
1124
1125=item $ev = $queue->enqueue_barrier ($wait_events...)
1126
1000L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueBarrier.html> 1127L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueBarrierWithWaitList.html>
1001 1128
1002=item $queue->flush 1129=item $queue->flush
1003 1130
1004L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html> 1131L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clFlush.html>
1005 1132
… …
1120 1247
1121=back 1248=back
1122 1249
1123=head2 THE OpenCL::Image CLASS 1250=head2 THE OpenCL::Image CLASS
1124 1251
1125This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. 1252This is the superclass of all image objects - OpenCL::Image1D,
1253OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1254OpenCL::Image2DArray and OpenCL::Image3D.
1126 1255
1127=over 4 1256=over 4
1128 1257
1129=item $packed_value = $ev->image_info ($name) 1258=item $packed_value = $ev->image_info ($name)
1130 1259
… …
1217 1346
1218=over 4 1347=over 4
1219 1348
1220=item $program->build ($device, $options = "") 1349=item $program->build ($device, $options = "")
1221 1350
1222Tries to build the program with the givne options. 1351Tries to build the program with the given options. See also the
1352C<$ctx->build> convenience function.
1223 1353
1224L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html> 1354L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
1225 1355
1226=item $packed_value = $program->build_info ($device, $name) 1356=item $packed_value = $program->build_info ($device, $name)
1227 1357
… …
1234 1364
1235Creates an OpenCL::Kernel object out of the named C<__kernel> function in 1365Creates an OpenCL::Kernel object out of the named C<__kernel> function in
1236the program. 1366the program.
1237 1367
1238L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html> 1368L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernel.html>
1369
1370=item @kernels = $program->kernels_in_program
1371
1372Returns all kernels successfully compiled for all devices in program.
1373
1374http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateKernelsInProgram.html
1239 1375
1240=for gengetinfo begin program_build 1376=for gengetinfo begin program_build
1241 1377
1242=item $build_status = $program->build_status ($device) 1378=item $build_status = $program->build_status ($device)
1243 1379
… …
1379float and double as floating point values, memory/buffer/image2d/image3d 1515float and double as floating point values, memory/buffer/image2d/image3d
1380must be an object of that type or C<undef>, local-memory arguments are 1516must be an object of that type or C<undef>, local-memory arguments are
1381set by specifying the size, and sampler and event must be objects of that 1517set by specifying the size, and sampler and event must be objects of that
1382type. 1518type.
1383 1519
1520Setting an argument for a kernel does NOT keep a reference to the object -
1521for example, if you set an argument to some image object, free the image,
1522and call the kernel, you will run into undefined behaviour.
1523
1384L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html> 1524L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetKernelArg.html>
1385 1525
1386=back 1526=back
1387 1527
1388=head2 THE OpenCL::Event CLASS 1528=head2 THE OpenCL::Event CLASS
… …
1471 1611
1472=back 1612=back
1473 1613
1474=cut 1614=cut
1475 1615
1476package OpenCL;
1477
1478use common::sense;
1479
1480BEGIN {
1481 our $VERSION = '0.96';
1482
1483 require XSLoader;
1484 XSLoader::load (__PACKAGE__, $VERSION);
1485
1486 @OpenCL::Buffer::ISA =
1487 @OpenCL::Image::ISA = OpenCL::Memory::;
1488
1489 @OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1490
1491 @OpenCL::Image2D::ISA =
1492 @OpenCL::Image3D::ISA = OpenCL::Image::;
1493
1494 @OpenCL::UserEvent::ISA = OpenCL::Event::;
1495}
1496
14971; 16161;
1498 1617
1499=head1 AUTHOR 1618=head1 AUTHOR
1500 1619
1501 Marc Lehmann <schmorp@schmorp.de> 1620 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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