[ViewVC] Diff of: cvs/OpenCL/OpenCL.pm

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.50 by root, Tue Apr 24 13:30:49 2012 UTC vs.
Revision 1.55 by root, Tue Apr 24 22:45:38 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
384	For this to work, the OpenGL library must be loaded, a GLX context must	377	For this to work, the OpenGL library must be loaded, a GLX context must
385	have been created and be made current, and C<dlsym> must be available and	378	have been created and be made current, and C<dlsym> must be available and
386	capable of finding the function via C<RTLD_DEFAULT>.	379	capable of finding the function via C<RTLD_DEFAULT>.
387		380
		381	=head2 EVENT SYSTEM
		382
		383	OpenCL can generate a number of (potentially) asynchronous events, for
		384	example, after compiling a program, to signal a context-related error or,
		385	perhaps most important, to signal completion of queued jobs (by setting
		386	callbacks on OpenCL::Event objects).
		387
		388	To facilitate this, this module maintains an event queue - each
		389	time an asynchronous event happens, it is queued, and perl will be
		390	interrupted. This is implemented via the L<Async::Interrupt> module. In
		391	addition, this module has L<AnyEvent> support, so it can seamlessly
		392	integrate itself into many event loops.
		393
		394	Since this module is a bit hard to understand, here are some case examples:
		395
		396	=head3 Don't use callbacks.
		397
		398	When your program never uses any callbacks, then there will never be any
		399	notifications you need to take care of, and therefore no need to worry
		400	about all this.
		401
		402	You can achieve a great deal by explicitly waiting for events, or using
		403	barriers and flush calls. In many programs, there is no need at all to
		404	tinker with asynchronous events.
		405
		406	=head3 Use AnyEvent
		407
		408	This module automatically registers a watcher that invokes all outstanding
		409	event callbacks when AnyEvent is initialised (and block asynchronous
		410	interruptions). Using this mode of operations is the safest and most
		411	recommended one.
		412
		413	To use this, simply use AnyEvent and this module normally, make sure you
		414	have an event loop running:
		415
		416	use Gtk2 -init;
		417	use AnyEvent;
		418
		419	# initialise AnyEvent, by creating a watcher, or:
		420	AnyEvent::detect;
		421
		422	my $e = $queue->enqueue_marker;
		423	$e->cb (sub {
		424	warn "opencl is finished\n";
		425	})
		426
		427	main Gtk2;
		428
		429	Note that this module will not initialise AnyEvent for you. Before
		430	AnyEvent is initialised, the module will asynchronously interrupt perl
		431	instead. To avoid any surprises, it's best to explicitly initialise
		432	AnyEvent.
		433
		434	You can temporarily enable asynchronous interruptions (see next paragraph)
		435	by calling C<$OpenCL::INTERRUPT->unblock> and disable them again by
		436	calling C<$OpenCL::INTERRUPT->block>.
		437
		438	=head3 Let yourself be interrupted at any time
		439
		440	This mode is the default unless AnyEvent is loaded and initialised. In
		441	this mode, OpenCL asynchronously interrupts a running perl program. The
		442	emphasis is on both I<asynchronously> and I<running> here.
		443
		444	Asynchronously means that perl might execute your callbacks at any
		445	time. For example, in the following code (I<THAT YOU SHOULD NOT COPY>),
		446	the C<until> loop following the marker call will be interrupted by the
		447	callback:
		448
		449	my $e = $queue->enqueue_marker;
		450	my $flag;
		451	$e->cb (sub { $flag = 1 });
		452	1 until $flag;
		453	# $flag is now 1
		454
		455	The reason why you shouldn't blindly copy the above code is that
		456	busy waiting is a really really bad thing, and really really bad for
		457	performance.
		458
		459	While at first this asynchronous business might look exciting, it can be
		460	really hard, because you need to be prepared for the callback code to be
		461	executed at any time, which limits the amount of things the callback code
		462	can do safely.
		463
		464	This can be mitigated somewhat by using C<<
		465	$OpenCL::INTERRUPT->scope_block >> (see the L<Async::Interrupt>
		466	documentation for details).
		467
		468	The other problem is that your program must be actively I<running> to be
		469	interrupted. When you calculate stuff, your program is running. When you
		470	hang in some C functions or other block execution (by calling C<sleep>,
		471	C<select>, running an event loop and so on), your program is waiting, not
		472	running.
		473
		474	One way around that would be to attach a read watcher to your event loop,
		475	listening for events on C<< $OpenCL::INTERRUPT->pipe_fileno >>, using a
		476	dummy callback (C<sub { }>) to temporarily execute some perl code.
		477
		478	That is then awfully close to using the built-in AnyEvent support above,
		479	though, so consider that one instead.
		480
		481	=head3 Be creative
		482
		483	OpenCL exports the L<Async::Interrupt> object it uses in the global
		484	variable C<$OpenCL::INTERRUPT>. You can configure it in any way you like.
		485
		486	So if you want to feel like a real pro, err, wait, if you feel no risk
		487	menas no fun, you can experiment by implementing your own mode of
		488	operations.
		489
		490	=cut
		491
		492	package OpenCL;
		493
		494	use common::sense;
		495	use Async::Interrupt ();
		496
		497	our $POLL_FUNC; # set by XS
		498
		499	BEGIN {
		500	our $VERSION = '0.97';
		501
		502	require XSLoader;
		503	XSLoader::load (__PACKAGE__, $VERSION);
		504
		505	@OpenCL::Platform::ISA =
		506	@OpenCL::Device::ISA =
		507	@OpenCL::Context::ISA =
		508	@OpenCL::Queue::ISA =
		509	@OpenCL::Memory::ISA =
		510	@OpenCL::Sampler::ISA =
		511	@OpenCL::Program::ISA =
		512	@OpenCL::Kernel::ISA =
		513	@OpenCL::Event::ISA = OpenCL::Object::;
		514
		515	@OpenCL::Buffer::ISA =
		516	@OpenCL::Image::ISA = OpenCL::Memory::;
		517
		518	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
		519
		520	@OpenCL::Image2D::ISA =
		521	@OpenCL::Image3D::ISA =
		522	@OpenCL::Image2DArray::ISA =
		523	@OpenCL::Image1D::ISA =
		524	@OpenCL::Image1DArray::ISA =
		525	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
		526
		527	@OpenCL::UserEvent::ISA = OpenCL::Event::;
		528	}
		529
388	=head2 THE OpenCL PACKAGE	530	=head2 THE OpenCL PACKAGE
389		531
390	=over 4	532	=over 4
391		533
392	=item $int = OpenCL::errno	534	=item $int = OpenCL::errno
…		…
410		552
411	Returns all available OpenCL::Platform objects.	553	Returns all available OpenCL::Platform objects.
412		554
413	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>	555	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetPlatformIDs.html>
414		556
415	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef	557	=item $ctx = OpenCL::context_from_type $properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr
416		558
417	Tries to create a context from a default device and platform - never worked for me.	559	Tries to create a context from a default device and platform - never worked for me.
418		560
419	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	561	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
420		562
…		…
422		564
423	Waits for all events to complete.	565	Waits for all events to complete.
424		566
425	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	567	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
426		568
		569	=item OpenCL::poll
		570
		571	Checks if there are any outstanding events (see L<EVENT SYSTEM>) and
		572	invokes their callbacks.
		573
		574	=item $OpenCL::INTERRUPT
		575
		576	The L<Async::Interrupt> object used to signal asynchronous events (see
		577	L<EVENT SYSTEM>).
		578
		579	=cut
		580
		581	our $INTERRUPT = new Async::Interrupt c_cb => [$POLL_FUNC, 0];
		582
		583	&_eq_initialise ($INTERRUPT->signal_func);
		584
		585	=item $OpenCL::WATCHER
		586
		587	The L<AnyEvent> watcher object used to watch for asynchronous events (see
		588	L<EVENT SYSTEM>). This variable is C<undef> until L<AnyEvent> has been
		589	loaded I<and> initialised (e.g. by calling C<AnyEvent::detect>).
		590
		591	=cut
		592
		593	our $WATCHER;
		594
		595	sub _init_anyevent {
		596	$INTERRUPT->block;
		597	$WATCHER = AE::io ($INTERRUPT->pipe_fileno, 0, sub { $INTERRUPT->handle });
		598	}
		599
		600	if (defined $AnyEvent::MODEL) {
		601	_init_anyevent;
		602	} else {
		603	push @AnyEvent::post_detect, \&_init_anyevent;
		604	}
		605
427	=back	606	=back
428		607
		608	=head2 THE OpenCL::Object CLASS
		609
		610	This is the base class for all objects in the OpenCL module. The only
		611	method it implements is the C<id> method, which is only useful if you want
		612	to interface to OpenCL on the C level.
		613
		614	=over 4
		615
		616	=item $iv = $obj->id
		617
		618	OpenCL objects are represented by pointers or integers on the C level. If
		619	you want to interface to an OpenCL object directly on the C level, then
		620	you need this value, which is returned by this method. You should use an
		621	C<IV> type in your code and cast that to the correct type.
		622
		623	=cut
		624
		625	sub OpenCL::Object::id {
		626	ref $_[0] eq "SCALAR"
		627	? ${ $_[0] }
		628	: $_[0][0]
		629	}
		630
		631	=back
		632
429	=head2 THE OpenCL::Platform CLASS	633	=head2 THE OpenCL::Platform CLASS
430		634
431	=over 4	635	=over 4
432		636
433	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)	637	=item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL)
434		638
435	Returns a list of matching OpenCL::Device objects.	639	Returns a list of matching OpenCL::Device objects.
436		640
437	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	641	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = $print_stderr)
438		642
439	Tries to create a context. Never worked for me, and you need devices explicitly anyway.	643	Tries to create a context. Never worked for me, and you need devices explicitly anyway.
440		644
441	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	645	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
442		646
443	=item $ctx = $platform->context ($properties = undef, @$devices, $notify = undef)	647	=item $ctx = $platform->context ($properties, @$devices, $notify = $print_stderr)
444		648
445	Create a new OpenCL::Context object using the given device object(s)- a	649	Create a new OpenCL::Context object using the given device object(s)- a
446	CL_CONTEXT_PLATFORM property is supplied automatically.	650	CL_CONTEXT_PLATFORM property is supplied automatically.
447		651
448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>	652	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
…		…
772	=back	976	=back
773		977
774	=head2 THE OpenCL::Context CLASS	978	=head2 THE OpenCL::Context CLASS
775		979
776	=over 4	980	=over 4
		981
		982	=item $prog = $ctx->build_program ($program, $options = "")
		983
		984	This convenience function tries to build the program on all devices in
		985	the context. If the build fails, then the function will C<croak> with the
		986	build log. Otherwise ti returns the program object.
		987
		988	The C<$program> can either be a C<OpenCL::Program> object or a string
		989	containing the program. In the latter case, a program objetc will be
		990	created automatically.
		991
		992	=cut
		993
		994	sub OpenCL::Context::build_program {
		995	my ($self, $prog, $options) = @_;
		996
		997	require Carp;
		998
		999	$prog = $self->program_with_source ($prog)
		1000	unless ref $prog;
		1001
		1002	# we build separately per device so we instantly know which one failed
		1003	for my $dev ($self->devices) {
		1004	eval { $prog->build ([$dev], $options); 1 }
		1005	or Carp::croak ("Building OpenCL program for device '" . $dev->name . "' failed:\n"
		1006	. $prog->build_log ($dev));
		1007	}
		1008
		1009	$prog
		1010	}
777		1011
778	=item $queue = $ctx->queue ($device, $properties)	1012	=item $queue = $ctx->queue ($device, $properties)
779		1013
780	Create a new OpenCL::Queue object from the context and the given device.	1014	Create a new OpenCL::Queue object from the context and the given device.
781		1015
…		…
980		1214
981	Yeah.	1215	Yeah.
982		1216
983	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	1217	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
984		1218
		1219	=item $ev = $queue->enqueue_fill_buffer ($mem, $pattern, $offset, $size, ...)
		1220
		1221	Fills the given buffer object with repeated applications of C<$pattern>,
		1222	starting at C<$offset> for C<$size> octets.
		1223
		1224	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillBuffer.html>
		1225
		1226	=item $ev = $queue->enqueue_fill_image ($img, $r, $g, $b, $a, $x, $y, $z, $width, $height, $depth, ...)
		1227
		1228	Fills the given image area with the given rgba colour components. The
		1229	components are normally floating point values between C<0> and C<1>,
		1230	except when the image channel data type is a signe dor unsigned
		1231	unnormalised format, in which case the range is determined by the format.
		1232
		1233	L<http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clEnqueueFillImage.html>
		1234
985	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	1235	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
986		1236
987	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>	1237	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueTask.html>
988		1238
989	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)	1239	=item $ev = $queue->enqueue_nd_range_kernel ($kernel, @$global_work_offset, @$global_work_size, @$local_work_size, $wait_events...)
…		…
1157	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,	1407	OpenCL::Image1DArray, OpenCL::Image1DBuffer, OpenCL::Image2D,
1158	OpenCL::Image2DArray and OpenCL::Image3D.	1408	OpenCL::Image2DArray and OpenCL::Image3D.
1159		1409
1160	=over 4	1410	=over 4
1161		1411
1162	=item $packed_value = $ev->image_info ($name)	1412	=item $packed_value = $image->image_info ($name)
1163		1413
1164	See C<< $platform->info >> for details.	1414	See C<< $platform->info >> for details.
1165		1415
1166	The reason this method is not called C<info> is that there already is an	1416	The reason this method is not called C<info> is that there already is an
1167	C<< ->info >> method inherited from C<OpenCL::Memory>.	1417	C<< ->info >> method inherited from C<OpenCL::Memory>.
1168		1418
1169	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>	1419	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetImageInfo.html>
1170		1420
		1421	=item ($channel_order, $channel_data_type) = $image->format
		1422
		1423	Returns the channel order and type used to create the image by calling
		1424	C<clGetImageInfo> with C<CL_IMAGE_FORMAT>.
		1425
1171	=for gengetinfo begin image	1426	=for gengetinfo begin image
1172		1427
1173	=item $int = $image->element_size	1428	=item $int = $image->element_size
1174		1429
1175	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.	1430	Calls C<clGetImageInfo> with C<CL_IMAGE_ELEMENT_SIZE> and returns the result.
…		…
1248		1503
1249	=head2 THE OpenCL::Program CLASS	1504	=head2 THE OpenCL::Program CLASS
1250		1505
1251	=over 4	1506	=over 4
1252		1507
1253	=item $program->build ($device, $options = "")	1508	=item $program->build (\@devices = undef, $options = "", $cb->($program) = undef)
1254		1509
1255	Tries to build the program with the givne options.	1510	Tries to build the program with the given options. See also the
		1511	C<$ctx->build> convenience function.
		1512
		1513	If a callback is specified, then it will be called when compilation is
		1514	finished. Note that many OpenCL implementations block your program while
		1515	compiling whether you use a callback or not. See C<build_async> if you
		1516	want to make sure the build is done in the background.
		1517
		1518	Note that some OpenCL implementations atc up badly, and don't call the
		1519	callback in some error cases (but call it in others). This implementation
		1520	assumes the callback will always be called, and leaks memory if this is
		1521	not so. So best make sure you don't pass in invalid values.
1256		1522
1257	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>	1523	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clBuildProgram.html>
		1524
		1525	=item $program->build_async (\@devices = undef, $options = "", $cb->($program) = undef)
		1526
		1527	Similar to C<< ->build >>, except it starts a thread, and never fails (you
		1528	need to check the compilation status form the callback, or by polling).
1258		1529
1259	=item $packed_value = $program->build_info ($device, $name)	1530	=item $packed_value = $program->build_info ($device, $name)
1260		1531
1261	Similar to C<< $platform->info >>, but returns build info for a previous	1532	Similar to C<< $platform->info >>, but returns build info for a previous
1262	build attempt for the given device.	1533	build attempt for the given device.
…		…
1439		1710
1440	Waits for the event to complete.	1711	Waits for the event to complete.
1441		1712
1442	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>	1713	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clWaitForEvents.html>
1443		1714
		1715	=item $ev->cb ($exec_callback_type, $callback->($event, $event_command_exec_status))
		1716
		1717	Adds a callback to the callback stack for the given event type. There is
		1718	no way to remove a callback again.
		1719
		1720	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetEventCallback.html>
		1721
1444	=item $packed_value = $ev->info ($name)	1722	=item $packed_value = $ev->info ($name)
1445		1723
1446	See C<< $platform->info >> for details.	1724	See C<< $platform->info >> for details.
1447		1725
1448	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>	1726	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetEventInfo.html>
…		…
1508		1786
1509	=over 4	1787	=over 4
1510		1788
1511	=item $ev->set_status ($execution_status)	1789	=item $ev->set_status ($execution_status)
1512		1790
		1791	Sets the execution status of the user event. Can only be called once,
		1792	either with OpenCL::COMPLETE or a negative number as status.
		1793
1513	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>	1794	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clSetUserEventStatus.html>
1514		1795
1515	=back	1796	=back
1516		1797
1517	=cut	1798	=cut
1518
1519	package OpenCL;
1520
1521	use common::sense;
1522
1523	BEGIN {
1524	our $VERSION = '0.96';
1525
1526	require XSLoader;
1527	XSLoader::load (__PACKAGE__, $VERSION);
1528
1529	@OpenCL::Buffer::ISA =
1530	@OpenCL::Image::ISA = OpenCL::Memory::;
1531
1532	@OpenCL::BufferObj::ISA = OpenCL::Buffer::;
1533
1534	@OpenCL::Image2D::ISA =
1535	@OpenCL::Image3D::ISA =
1536	@OpenCL::Image2DArray::ISA =
1537	@OpenCL::Image1D::ISA =
1538	@OpenCL::Image1DArray::ISA =
1539	@OpenCL::Image1DBuffer::ISA = OpenCL::Image::;
1540
1541	@OpenCL::UserEvent::ISA = OpenCL::Event::;
1542	}
1543		1799
1544	1;	1800	1;
1545		1801
1546	=head1 AUTHOR	1802	=head1 AUTHOR
1547		1803

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.50 by root, Tue Apr 24 13:30:49 2012 UTC vs. Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.50 by root, Tue Apr 24 13:30:49 2012 UTC vs.
Revision 1.55 by root, Tue Apr 24 22:45:38 2012 UTC