--- OpenCL/OpenCL.pm 2011/11/17 06:22:29 1.18 +++ OpenCL/OpenCL.pm 2011/11/20 10:25:17 1.22 @@ -29,7 +29,7 @@ kernel function in a program you can then create an OpenCL::Kernel object which represents basically a function call with argument values. -OpenCL::Memory objects of various flavours: OpenCL::Buffers objects (flat +OpenCL::Memory objects of various flavours: OpenCL::Buffer objects (flat memory areas, think arrays or structs) and OpenCL::Image objects (think 2d or 3d array) for bulk data and input and output for kernels. @@ -228,19 +228,18 @@ to free objects explicitly (C), the release function is called automatically once all Perl references to it go away. -=item * OpenCL uses CamelCase for function names (C), -while this module uses underscores as word separator and often leaves out -prefixes (C<< $platform->info >>). +=item * OpenCL uses CamelCase for function names +(e.g. C, C), while this module +uses underscores as word separator and often leaves out prefixes +(C, C<< $platform->info >>). =item * OpenCL often specifies fixed vector function arguments as short -arrays (C<$origin[3]>), while this module explicitly expects the -components as separate arguments- +arrays (C), while this module explicitly expects the +components as separate arguments (C<$orig_x, $orig_y, $orig_z>) in +function calls. -=item * Structures are often specified with their components, and returned -as arrayrefs. - -=item * Where possible, one of the pitch values is calculated from the -perl scalar length and need not be specified. +=item * Structures are often specified by flattening out their components +as with short vectors, and returned as arrayrefs. =item * When enqueuing commands, the wait list is specified by adding extra arguments to the function - anywhere a C<$wait_events...> argument @@ -319,21 +318,13 @@ =over 4 -=item $packed_value = $platform->info ($name) - -Calls C and returns the packed, raw value - for -strings, this will be the string, for other values you probably need to -use the correct C. This might get improved in the future. Hopefully. - -L - =item @devices = $platform->devices ($type = OpenCL::DEVICE_TYPE_ALL) Returns a list of matching OpenCL::Device objects. =item $ctx = $platform->context_from_type ($properties, $type = OpenCL::DEVICE_TYPE_DEFAULT, $notify = undef) -Tries to create a context. Never worked for me, and you need devices explitly anyway. +Tries to create a context. Never worked for me, and you need devices explicitly anyway. L @@ -344,6 +335,41 @@ L +=item $packed_value = $platform->info ($name) + +Calls C and returns the packed, raw value - for +strings, this will be the string (possibly including terminating \0), for +other values you probably need to use the correct C. + +It's best to avoid this method and use one of the following convenience +wrappers. + +L + +=for gengetinfo begin platform + +=item $string = $platform->profile + +Calls C with C and returns the result(s). + +=item $string = $platform->version + +Calls C with C and returns the result(s). + +=item $string = $platform->name + +Calls C with C and returns the result(s). + +=item $string = $platform->vendor + +Calls C with C and returns the result(s). + +=item $string = $platform->extensions + +Calls C with C and returns the result(s). + +=for gengetinfo end platform + =back =head2 THE OpenCL::Device CLASS @@ -356,17 +382,279 @@ L -=back +=for gengetinfo begin device -=head2 THE OpenCL::Context CLASS +=item $device_type = $device->type -=over 4 +Calls C with C and returns the result(s). -=item $packed_value = $ctx->info ($name) +=item $uint = $device->vendor_id -See C<< $platform->info >> for details. +Calls C with C and returns the result(s). -L +=item $uint = $device->max_compute_units + +Calls C with C and returns the result(s). + +=item $uint = $device->max_work_item_dimensions + +Calls C with C and returns the result(s). + +=item $int = $device->max_work_group_size + +Calls C with C and returns the result(s). + +=item @ints = $device->max_work_item_sizes + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_char + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_short + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_int + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_long + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_float + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_double + +Calls C with C and returns the result(s). + +=item $uint = $device->max_clock_frequency + +Calls C with C and returns the result(s). + +=item $bitfield = $device->address_bits + +Calls C with C and returns the result(s). + +=item $uint = $device->max_read_image_args + +Calls C with C and returns the result(s). + +=item $uint = $device->max_write_image_args + +Calls C with C and returns the result(s). + +=item $ulong = $device->max_mem_alloc_size + +Calls C with C and returns the result(s). + +=item $int = $device->image2d_max_width + +Calls C with C and returns the result(s). + +=item $int = $device->image2d_max_height + +Calls C with C and returns the result(s). + +=item $int = $device->image3d_max_width + +Calls C with C and returns the result(s). + +=item $int = $device->image3d_max_height + +Calls C with C and returns the result(s). + +=item $int = $device->image3d_max_depth + +Calls C with C and returns the result(s). + +=item $uint = $device->image_support + +Calls C with C and returns the result(s). + +=item $int = $device->max_parameter_size + +Calls C with C and returns the result(s). + +=item $uint = $device->max_samplers + +Calls C with C and returns the result(s). + +=item $uint = $device->mem_base_addr_align + +Calls C with C and returns the result(s). + +=item $uint = $device->min_data_type_align_size + +Calls C with C and returns the result(s). + +=item $device_fp_config = $device->single_fp_config + +Calls C with C and returns the result(s). + +=item $device_mem_cache_type = $device->global_mem_cache_type + +Calls C with C and returns the result(s). + +=item $uint = $device->global_mem_cacheline_size + +Calls C with C and returns the result(s). + +=item $ulong = $device->global_mem_cache_size + +Calls C with C and returns the result(s). + +=item $ulong = $device->global_mem_size + +Calls C with C and returns the result(s). + +=item $ulong = $device->max_constant_buffer_size + +Calls C with C and returns the result(s). + +=item $uint = $device->max_constant_args + +Calls C with C and returns the result(s). + +=item $device_local_mem_type = $device->local_mem_type + +Calls C with C and returns the result(s). + +=item $ulong = $device->local_mem_size + +Calls C with C and returns the result(s). + +=item $boolean = $device->error_correction_support + +Calls C with C and returns the result(s). + +=item $int = $device->profiling_timer_resolution + +Calls C with C and returns the result(s). + +=item $boolean = $device->endian_little + +Calls C with C and returns the result(s). + +=item $boolean = $device->available + +Calls C with C and returns the result(s). + +=item $boolean = $device->compiler_available + +Calls C with C and returns the result(s). + +=item $device_exec_capabilities = $device->execution_capabilities + +Calls C with C and returns the result(s). + +=item $command_queue_properties = $device->properties + +Calls C with C and returns the result(s). + +=item $ = $device->platform + +Calls C with C and returns the result(s). + +=item $string = $device->name + +Calls C with C and returns the result(s). + +=item $string = $device->vendor + +Calls C with C and returns the result(s). + +=item $string = $device->driver_version + +Calls C with C and returns the result(s). + +=item $string = $device->profile + +Calls C with C and returns the result(s). + +=item $string = $device->version + +Calls C with C and returns the result(s). + +=item $string = $device->extensions + +Calls C with C and returns the result(s). + +=item $uint = $device->preferred_vector_width_half + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_char + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_short + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_int + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_long + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_float + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_double + +Calls C with C and returns the result(s). + +=item $uint = $device->native_vector_width_half + +Calls C with C and returns the result(s). + +=item $device_fp_config = $device->double_fp_config + +Calls C with C and returns the result(s). + +=item $device_fp_config = $device->half_fp_config + +Calls C with C and returns the result(s). + +=item $boolean = $device->host_unified_memory + +Calls C with C and returns the result(s). + +=item $device = $device->parent_device_ext + +Calls C with C and returns the result(s). + +=item @device_partition_property_exts = $device->partition_types_ext + +Calls C with C and returns the result(s). + +=item @device_partition_property_exts = $device->affinity_domains_ext + +Calls C with C and returns the result(s). + +=item $uint = $device->reference_count_ext + +Calls C with C and returns the result(s). + +=item @device_partition_property_exts = $device->partition_style_ext + +Calls C with C and returns the result(s). + +=for gengetinfo end device + +=back + +=head2 THE OpenCL::Context CLASS + +=over 4 =item $queue = $ctx->queue ($device, $properties) @@ -421,6 +709,32 @@ L +=item $packed_value = $ctx->info ($name) + +See C<< $platform->info >> for details. + +L + +=for gengetinfo begin context + +=item $uint = $context->reference_count + +Calls C with C and returns the result(s). + +=item @devices = $context->devices + +Calls C with C and returns the result(s). + +=item @property_ints = $context->properties + +Calls C with C and returns the result(s). + +=item $uint = $context->num_devices + +Calls C with C and returns the result(s). + +=for gengetinfo end context + =back =head2 THE OpenCL::Queue CLASS @@ -443,12 +757,6 @@ =over 4 -=item $packed_value = $ctx->info ($name) - -See C<< $platform->info >> for details. - -L - =item $ev = $queue->enqueue_read_buffer ($buffer, $blocking, $offset, $len, $data, $wait_events...) Reads data from buffer into the given string. @@ -533,13 +841,38 @@ L +=item $packed_value = $queue->info ($name) + +See C<< $platform->info >> for details. + +L + +=for gengetinfo begin command_queue + +=item $ctx = $command_queue->context + +Calls C with C and returns the result(s). + +=item $device = $command_queue->device + +Calls C with C and returns the result(s). + +=item $uint = $command_queue->reference_count + +Calls C with C and returns the result(s). + +=item $command_queue_properties = $command_queue->properties + +Calls C with C and returns the result(s). + +=for gengetinfo end command_queue + =back =head2 THE OpenCL::Memory CLASS This the superclass of all memory objects - OpenCL::Buffer, OpenCL::Image, -OpenCL::Image2D and OpenCL::Image3D. The subclasses of this class -currently only exist to allow type-checking. +OpenCL::Image2D and OpenCL::Image3D. =over 4 @@ -549,29 +882,132 @@ L +=for gengetinfo begin mem + +=item $mem_object_type = $mem->type + +Calls C with C and returns the result(s). + +=item $mem_flags = $mem->flags + +Calls C with C and returns the result(s). + +=item $int = $mem->size + +Calls C with C and returns the result(s). + +=item $ptr_value = $mem->host_ptr + +Calls C with C and returns the result(s). + +=item $uint = $mem->map_count + +Calls C with C and returns the result(s). + +=item $uint = $mem->reference_count + +Calls C with C and returns the result(s). + +=item $ctx = $mem->context + +Calls C with C and returns the result(s). + +=item $mem = $mem->associated_memobject + +Calls C with C and returns the result(s). + +=item $int = $mem->offset + +Calls C with C and returns the result(s). + +=for gengetinfo end mem + =back -=head2 THE OpenCL::Sampler CLASS +=head2 THE OpenCL::Image CLASS + +This is the superclass of all image objects - OpenCL::Image2D and OpenCL::Image3D. =over 4 -=item $packed_value = $sampler->info ($name) +=item $packed_value = $ev->image_info ($name) See C<< $platform->info >> for details. -L +The reason this method is not called C is that there already is an +C<< ->info >> method inherited from C. + +L + +=for gengetinfo begin image + +=item $int = $image->element_size + +Calls C with C and returns the result(s). + +=item $int = $image->row_pitch + +Calls C with C and returns the result(s). + +=item $int = $image->slice_pitch + +Calls C with C and returns the result(s). + +=item $int = $image->width + +Calls C with C and returns the result(s). + +=item $int = $image->height + +Calls C with C and returns the result(s). + +=item $int = $image->depth + +Calls C with C and returns the result(s). + +=for gengetinfo end image =back -=head2 THE OpenCL::Program CLASS +=head2 THE OpenCL::Sampler CLASS =over 4 -=item $packed_value = $program->info ($name) +=item $packed_value = $sampler->info ($name) See C<< $platform->info >> for details. -L +L + +=for gengetinfo begin sampler + +=item $uint = $sampler->reference_count + +Calls C with C and returns the result(s). + +=item $ctx = $sampler->context + +Calls C with C and returns the result(s). + +=item $addressing_mode = $sampler->normalized_coords + +Calls C with C and returns the result(s). + +=item $filter_mode = $sampler->addressing_mode + +Calls C with C and returns the result(s). + +=item $boolean = $sampler->filter_mode + +Calls C with C and returns the result(s). + +=for gengetinfo end sampler + +=back + +=head2 THE OpenCL::Program CLASS + +=over 4 =item $program->build ($device, $options = "") @@ -593,6 +1029,56 @@ L +=for gengetinfo begin program_build + +=item $build_status = $program->build_status ($device) + +Calls C with C and returns the result(s). + +=item $string = $program->build_options ($device) + +Calls C with C and returns the result(s). + +=item $string = $program->build_log ($device) + +Calls C with C and returns the result(s). + +=for gengetinfo end program_build + +=item $packed_value = $program->info ($name) + +See C<< $platform->info >> for details. + +L + +=for gengetinfo begin program + +=item $uint = $program->reference_count + +Calls C with C and returns the result(s). + +=item $ctx = $program->context + +Calls C with C and returns the result(s). + +=item $uint = $program->num_devices + +Calls C with C and returns the result(s). + +=item @devices = $program->devices + +Calls C with C and returns the result(s). + +=item $string = $program->source + +Calls C with C and returns the result(s). + +=item @ints = $program->binary_sizes + +Calls C with C and returns the result(s). + +=for gengetinfo end program + =back =head2 THE OpenCL::Kernel CLASS @@ -605,6 +1091,63 @@ L +=for gengetinfo begin kernel + +=item $string = $kernel->function_name + +Calls C with C and returns the result(s). + +=item $uint = $kernel->num_args + +Calls C with C and returns the result(s). + +=item $uint = $kernel->reference_count + +Calls C with C and returns the result(s). + +=item $ctx = $kernel->context + +Calls C with C and returns the result(s). + +=item $program = $kernel->program + +Calls C with C and returns the result(s). + +=for gengetinfo end kernel + +=item $packed_value = $kernel->work_group_info ($device, $name) + +See C<< $platform->info >> for details. + +The reason this method is not called C is that there already is an +C<< ->info >> method. + +L + +=for gengetinfo begin kernel_work_group + +=item $int = $kernel->work_group_size ($device) + +Calls C with C and returns the result(s). + +=item @ints = $kernel->compile_work_group_size ($device) + +Calls C with C and returns the result(s). + +=item $ulong = $kernel->local_mem_size ($device) + +Calls C with C and returns the result(s). + +=item $int = $kernel->preferred_work_group_size_multiple ($device) + +Calls C with C and returns the result(s). + +=item $ulong = $kernel->private_mem_size ($device) + +Calls C with C and returns the result(s). + +=for gengetinfo end kernel_work_group + =item $kernel->set_TYPE ($index, $value) This is a family of methods to set the kernel argument with the number C<$index> to the give C<$value>. @@ -629,17 +1172,70 @@ =over 4 +=item $ev->wait + +Waits for the event to complete. + +L + =item $packed_value = $ev->info ($name) See C<< $platform->info >> for details. L -=item $ev->wait +=for gengetinfo begin event -Waits for the event to complete. +=item $queue = $event->command_queue -L +Calls C with C and returns the result(s). + +=item $command_type = $event->command_type + +Calls C with C and returns the result(s). + +=item $uint = $event->reference_count + +Calls C with C and returns the result(s). + +=item $uint = $event->command_execution_status + +Calls C with C and returns the result(s). + +=item $ctx = $event->context + +Calls C with C and returns the result(s). + +=for gengetinfo end event + +=item $packed_value = $ev->profiling_info ($name) + +See C<< $platform->info >> for details. + +The reason this method is not called C is that there already is an +C<< ->info >> method. + +L + +=for gengetinfo begin profiling + +=item $ulong = $event->profiling_command_queued + +Calls C with C and returns the result(s). + +=item $ulong = $event->profiling_command_submit + +Calls C with C and returns the result(s). + +=item $ulong = $event->profiling_command_start + +Calls C with C and returns the result(s). + +=item $ulong = $event->profiling_command_end + +Calls C with C and returns the result(s). + +=for gengetinfo end profiling =back @@ -662,7 +1258,7 @@ use common::sense; BEGIN { - our $VERSION = '0.15'; + our $VERSION = '0.55'; require XSLoader; XSLoader::load (__PACKAGE__, $VERSION);