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

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.10 by root, Thu Nov 17 02:10:39 2011 UTC vs.
Revision 1.19 by root, Sat Nov 19 19:54:04 2011 UTC

…		…
18	vendors) - usually there is only one.	18	vendors) - usually there is only one.
19		19
20	Each platform gives you access to a number of OpenCL::Device objects, e.g.	20	Each platform gives you access to a number of OpenCL::Device objects, e.g.
21	your graphics card.	21	your graphics card.
22		22
23	From a platform and some devices, you create an OpenCL::Context, which is	23	From a platform and some device(s), you create an OpenCL::Context, which is
24	a very central object in OpenCL: Once you have a context you can create	24	a very central object in OpenCL: Once you have a context you can create
25	most other objects:	25	most other objects:
26		26
27	OpenCL::Program objects, which store source code and, after building	27	OpenCL::Program objects, which store source code and, after building for a
28	("compiling and linking"), also binary programs. For each kernel function	28	specific device ("compiling and linking"), also binary programs. For each
29	in a program you can then create an OpenCL::Kernel object which represents	29	kernel function in a program you can then create an OpenCL::Kernel object
30	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::Buffers objects (flat
33	memory areas, think array) and OpenCL::Image objects (think 2d or 3d	33	memory areas, think arrays or structs) and OpenCL::Image objects (think 2d
34	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.
38		38
39	OpenCL::Queue objects - command queues, which allow you to submit memory	39	OpenCL::Queue objects - command queues, which allow you to submit memory
…		…
52		52
53	OpenCL manpages:	53	OpenCL manpages:
54		54
55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/	55	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/
56		56
		57	If you are into UML class diagrams, the following diagram might help - if
		58	not, it will be mildly cobfusing:
		59
		60	http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/classDiagram.html
		61
		62	Here's a tutorial from AMD (very AMD-centric, too), not sure how useful it
		63	is, but at least it's free of charge:
		64
		65	http://developer.amd.com/zones/OpenCLZone/courses/Documents/Introduction_to_OpenCL_Programming%20Training_Guide%20%28201005%29.pdf
		66
		67	And here's NVIDIA's OpenCL Best Practises Guide:
		68
		69	http://developer.download.nvidia.com/compute/cuda/3_2/toolkit/docs/OpenCL_Best_Practices_Guide.pdf
		70
57	=head1 BASIC WORKFLOW	71	=head1 BASIC WORKFLOW
58		72
59	To get something done, you basically have to do this once:	73	To get something done, you basically have to do this once (refer to the
		74	examples below for actual code, this is just a high-level description):
60		75
61	Find some platform (e.g. the first one) and some device (e.g. the first	76	Find some platform (e.g. the first one) and some device(s) (e.g. the first
62	device you can find), and create a context from those.	77	device of the platform), and create a context from those.
63		78
64	Create a command queue from your context, and program objects from your	79	Create program objects from your OpenCL source code, then build (compile)
65	OpenCL source code, build the programs.	80	the programs for each device you want to run them on.
66		81
67	Create kernel objects for all kernels you want to use.	82	Create kernel objects for all kernels you want to use (surprisingly, these
		83	are not device-specific).
68		84
69	Then, to execute stuff, you repeat this:	85	Then, to execute stuff, you repeat these steps, possibly resuing or
		86	sharing some buffers:
70		87
71	Create some input and output buffers from your context. Initialise the	88	Create some input and output buffers from your context. Set these as
72	input buffers with data. Set these as arguments to your kernel.	89	arguments to your kernel.
		90
		91	Enqueue buffer writes to initialise your input buffers (when not
		92	initialised at creation time).
73		93
74	Enqueue the kernel execution.	94	Enqueue the kernel execution.
75		95
76	Enqueue buffer reads for your output buffer to read results.	96	Enqueue buffer reads for your output buffer to read results.
77		97
78	The next section shows how this can be done.
79
80	=head1 EXAMPLES	98	=head1 EXAMPLES
81		99
82	=head2 Enumerate all devices and get contexts for them.	100	=head2 Enumerate all devices and get contexts for them.
		101
		102	Best run this once to get a feel for the platforms and devices in your
		103	system.
83		104
84	for my $platform (OpenCL::platforms) {	105	for my $platform (OpenCL::platforms) {
85	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);	106	printf "platform: %s\n", $platform->info (OpenCL::PLATFORM_NAME);
86	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);	107	printf "extensions: %s\n", $platform->info (OpenCL::PLATFORM_EXTENSIONS);
87	for my $device ($platform->devices) {	108	for my $device ($platform->devices) {
…		…
91	}	112	}
92	}	113	}
93		114
94	=head2 Get a useful context and a command queue.	115	=head2 Get a useful context and a command queue.
95		116
96	my $dev = ((OpenCL::platforms)[0]->devices)[0];	117	This is a useful boilerplate for any OpenCL program that only wants to use
97	my $ctx = $dev->context;	118	one device,
98	my $queue = $ctx->queue ($dev);	119
		120	my ($platform) = OpenCL::platforms; # find first platform
		121	my ($dev) = $platform->devices; # find first device of platform
		122	my $ctx = $platform->context (undef, [$dev]); # create context out of those
		123	my $queue = $ctx->queue ($dev); # create a command queue for the device
99		124
100	=head2 Print all supported image formats of a context.	125	=head2 Print all supported image formats of a context.
		126
		127	Best run this once for your context, to see whats available and how to
		128	gather information.
101		129
102	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {	130	for my $type (OpenCL::MEM_OBJECT_IMAGE2D, OpenCL::MEM_OBJECT_IMAGE3D) {
103	print "supported image formats for ", OpenCL::enum2str $type, "\n";	131	print "supported image formats for ", OpenCL::enum2str $type, "\n";
104		132
105	for my $f ($ctx->supported_image_formats (0, $type)) {	133	for my $f ($ctx->supported_image_formats (0, $type)) {
…		…
124		152
125	my $src = '	153	my $src = '
126	__kernel void	154	__kernel void
127	squareit (__global float input, __global float output)	155	squareit (__global float input, __global float output)
128	{	156	{
129	size_t id = get_global_id (0);	157	$id = get_global_id (0);
130	output [id] = input [id] * input [id];	158	output [id] = input [id] * input [id];
131	}	159	}
132	';	160	';
133		161
134	my $prog = $ctx->program_with_source ($src);	162	my $prog = $ctx->program_with_source ($src);
135		163
		164	# build croaks on compile errors, so catch it and print the compile errors
136	eval { $prog->build ($dev); 1 }	165	eval { $prog->build ($dev); 1 }
137	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);	166	or die $prog->build_info ($dev, OpenCL::PROGRAM_BUILD_LOG);
138		167
139	my $kernel = $prog->kernel ("squareit");	168	my $kernel = $prog->kernel ("squareit");
140		169
141	=head2 Create some input and output float buffers, then call squareit on them.	170	=head2 Create some input and output float buffers, then call the
		171	'squareit' kernel on them.
142		172
143	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);	173	my $input = $ctx->buffer_sv (OpenCL::MEM_COPY_HOST_PTR, pack "f*", 1, 2, 3, 4.5);
144	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);	174	my $output = $ctx->buffer (0, OpenCL::SIZEOF_FLOAT * 5);
145		175
146	# set buffer	176	# set buffer
…		…
185		215
186	=head1 DOCUMENTATION	216	=head1 DOCUMENTATION
187		217
188	=head2 BASIC CONVENTIONS	218	=head2 BASIC CONVENTIONS
189		219
190	This is not a 1:1 C-style translation of OpenCL to Perl - instead I	220	This is not a one-to-one C-style translation of OpenCL to Perl - instead
191	attempted to make the interface as type-safe as possible and introducing	221	I attempted to make the interface as type-safe as possible by introducing
192	object syntax where it makes sense. There are a number of important	222	object syntax where it makes sense. There are a number of important
193	differences between the OpenCL C API and this module:	223	differences between the OpenCL C API and this module:
194		224
195	=over 4	225	=over 4
196		226
197	=item * Object lifetime managament is automatic - there is no need	227	=item * Object lifetime managament is automatic - there is no need
198	to free objects explicitly (C<clReleaseXXX>), the release function	228	to free objects explicitly (C<clReleaseXXX>), the release function
199	is called automatically once all Perl references to it go away.	229	is called automatically once all Perl references to it go away.
200		230
201	=item * OpenCL uses CamelCase for function names (C<clGetPlatformInfo>),	231	=item * OpenCL uses CamelCase for function names (e.g. C<clGetPlatformIDs>, C<clGetPlatformInfo>),
202	while this module uses underscores as word separator and often leaves out	232	while this module uses underscores as word separator and often leaves out
203	prefixes (C<< $platform->info >>).	233	prefixes (C<OpenCL::platforms>, C<< $platform->info >>).
204		234
205	=item * OpenCL often specifies fixed vector function arguments as short	235	=item * OpenCL often specifies fixed vector function arguments as short
206	arrays (C<size_t origin[3]>), while this module explicitly expects the	236	arrays (C<size_t origin[3]>), while this module explicitly expects the
207	components as separate arguments-	237	components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in
		238	function calls.
208		239
209	=item * Where possible, one of the pitch values is calculated from the	240	=item * Structures are often specified by flattening out their components
210	perl scalar length and need not be specified.	241	as with short vectors, and returned as arrayrefs.
211		242
212	=item * When enqueuing commands, the wait list is specified by adding	243	=item * When enqueuing commands, the wait list is specified by adding
213	extra arguments to the function - anywhere a C<$wait_events...> argument	244	extra arguments to the function - anywhere a C<$wait_events...> argument
214	is documented this can be any number of event objects.	245	is documented this can be any number of event objects.
215		246
…		…
245		276
246	=over 4	277	=over 4
247		278
248	=item $int = OpenCL::errno	279	=item $int = OpenCL::errno
249		280
250	The last error returned by a function - it's only changed on errors.	281	The last error returned by a function - it's only valid after an error occured
		282	and before calling another OpenCL function.
251		283
252	=item $str = OpenCL::err2str $errval	284	=item $str = OpenCL::err2str $errval
253		285
254	Comverts an error value into a human readable string.	286	Comverts an error value into a human readable string.
255		287
…		…
297		329
298	Returns a list of matching OpenCL::Device objects.	330	Returns a list of matching OpenCL::Device objects.
299		331
300	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)	332	=item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef)
301		333
302	Tries to create a context. Never worked for me.	334	Tries to create a context. Never worked for me, and you need devices explitly anyway.
303		335
304	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>	336	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContextFromType.html>
305		337
		338	=item $ctx = $device->context ($properties = undef, @$devices, $notify = undef)
		339
		340	Create a new OpenCL::Context object using the given device object(s)- a
		341	CL_CONTEXT_PLATFORM property is supplied automatically.
		342
		343	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
		344
306	=back	345	=back
307		346
308	=head2 THE OpenCL::Device CLASS	347	=head2 THE OpenCL::Device CLASS
309		348
310	=over 4	349	=over 4
…		…
313		352
314	See C<< $platform->info >> for details.	353	See C<< $platform->info >> for details.
315		354
316	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>	355	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clGetDeviceInfo.html>
317		356
318	=item $ctx = $device->context ($properties = undef, $notify = undef)
319
320	Create a new OpenCL::Context object.
321
322	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateContext.html>
323
324	=back	357	=back
325		358
326	=head2 THE OpenCL::Context CLASS	359	=head2 THE OpenCL::Context CLASS
327		360
328	=over 4	361	=over 4
…		…
353		386
354	=item $buf = $ctx->buffer_sv ($flags, $data)	387	=item $buf = $ctx->buffer_sv ($flags, $data)
355		388
356	Creates a new OpenCL::Buffer object and initialise it with the given data values.	389	Creates a new OpenCL::Buffer object and initialise it with the given data values.
357		390
358	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $data)	391	=item $img = $ctx->image2d ($flags, $channel_order, $channel_type, $width, $height, $row_pitch = 0, $data = undef)
359		392
360	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.	393	Creates a new OpenCL::Image2D object and optionally initialises it with the given data values.
361		394
362	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>	395	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage2D.html>
363		396
364	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $slice_pitch, $data)	397	=item $img = $ctx->image3d ($flags, $channel_order, $channel_type, $width, $height, $depth, $row_pitch = 0, $slice_pitch = 0, $data = undef)
365		398
366	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.	399	Creates a new OpenCL::Image3D object and optionally initialises it with the given data values.
367		400
368	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>	401	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clCreateImage3D.html>
369		402
…		…
432		465
433	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)	466	=item $ev = $queue->enqueue_read_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
434		467
435	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>	468	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueReadImage.html>
436		469
437	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $data, $wait_events...)	470	=item $ev = $queue->enqueue_write_image ($src, $blocking, $x, $y, $z, $width, $height, $depth, $row_pitch, $slice_pitch, $data, $wait_events...)
438		471
439	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>	472	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueWriteImage.html>
440		473
441	=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, $ait_event...)	474	=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...)
442		475
443	Yeah.	476	Yeah.
444		477
445	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>	478	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferRect.html>
446		479
447	=item $ev = $queue->enqueue_copy_buffer_to_image (OpenCL::Buffer src, OpenCL::Image dst, size_t src_offset, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)	480	=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...)
448		481
449	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.	482	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyBufferToImage.html>.
450		483
451	=item $ev = $queue->enqueue_copy_image (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t dst_x, size_t dst_y, size_t dst_z, size_t width, size_t height, size_t depth, ...)	484	=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...)
452		485
453	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>	486	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImage.html>
454		487
455	=item $ev = $queue->enqueue_copy_image_to_buffer (OpenCL::Image src, OpenCL::Buffer dst, size_t src_x, size_t src_y, size_t src_z, size_t width, size_t height, size_t depth, size_t dst_offset, ...)	488	=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...)
456		489
457	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>	490	L<http://www.khronos.org/registry/cl/sdk/1.1/docs/man/xhtml/clEnqueueCopyImageToBuffer.html>
458		491
459	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)	492	=item $ev = $queue->enqueue_task ($kernel, $wait_events...)
460		493
…		…
625	package OpenCL;	658	package OpenCL;
626		659
627	use common::sense;	660	use common::sense;
628		661
629	BEGIN {	662	BEGIN {
630	our $VERSION = '0.03';	663	our $VERSION = '0.15';
631		664
632	require XSLoader;	665	require XSLoader;
633	XSLoader::load (__PACKAGE__, $VERSION);	666	XSLoader::load (__PACKAGE__, $VERSION);
634		667
635	@OpenCL::Buffer::ISA =	668	@OpenCL::Buffer::ISA =

Diff Legend

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

Comparing OpenCL/OpenCL.pm (file contents): Revision 1.10 by root, Thu Nov 17 02:10:39 2011 UTC vs. Revision 1.19 by root, Sat Nov 19 19:54:04 2011 UTC

Diff Legend

Comparing OpenCL/OpenCL.pm (file contents):
Revision 1.10 by root, Thu Nov 17 02:10:39 2011 UTC vs.
Revision 1.19 by root, Sat Nov 19 19:54:04 2011 UTC