path: root/tests/util/piglit-util-cl.c

/*
 * Copyright © 2012 Blaž Tomažič <blaz.tomazic@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#include <inttypes.h>

#include "piglit-util-cl.h"

bool
piglit_cl_probe_integer(int64_t value, int64_t expect, uint64_t tolerance)
{
	int64_t diff = value > expect ? value-expect : expect-value;

	if(diff > tolerance) {
		printf("Expecting %"PRId64" (0x%"PRIx64") with tolerance %"PRIu64
		       ", but got %"PRId64" (0x%"PRIx64")\n",
		       expect, (uint64_t)expect, tolerance, value, (uint64_t)value);
		return false;
	}

	return true;
}

bool
piglit_cl_probe_uinteger(uint64_t value, uint64_t expect, uint64_t tolerance)
{
	uint64_t diff = value > expect ? value-expect : expect-value;

	if(diff > tolerance) {
		printf("Expecting %"PRIu64" (0x%"PRIx64") with tolerance %"PRIu64
		", but got %"PRIu64" (0x%"PRIx64")\n",
		       expect, expect, tolerance, value, value);
		return false;
	}

	return true;
}

# define probe_float_check_nan_inf(value, expect) \
	((isnan(value) && isnan(expect)) || \
	(isinf(value) && isinf(expect) && ((value > 0) == (expect > 0))))

static float float_from_cl_half(uint32_t in)
{
	union {
		uint32_t bits;
		float val;
	} convert;
	uint32_t exponent = ((in >> 10) & 0x1f);
	convert.bits = (((in >> 15) & 0x1) << 31) | //sign
	               ((exponent ? (exponent != 0x1f ? exponent + 112 : 0xff)
	                 : 0) << 23) | //exponent (0 and 1f are special cases)
	               (((in >>  0) & 0x3ff) << 13); // mantissa
	return convert.val;
}

bool piglit_cl_probe_half(cl_half value, cl_half expect, uint32_t ulp)
{
	// after conversion to float the last 13 digits are 0, adjust ulp
	return piglit_cl_probe_floating(float_from_cl_half(value),
	                                float_from_cl_half(expect),
	                                ulp * 8192);
}

bool piglit_cl_probe_floating(float value, float expect, uint32_t ulp)
{
	float diff;
	union {
		float f;
		uint32_t u;
	} v, e;

	v.f = value;
	e.f = expect;

	/* Treat infinity and nan separately */
	if (probe_float_check_nan_inf(value, expect)) {
		return true;
	}

	/* Check "any value" */
	if (ulp >= (1u << 24)) {
		return true;
	}

	/* expect is correctly rounded, 1 ULP is the distance to next
	 * representable value */
	float direction = signbit(expect) ?  -INFINITY : INFINITY;
	float one_ulp = nextafterf(expect, direction) - expect;
	float tolerance = fabsf(ulp * one_ulp);

	diff = fabsf(value - expect);

	if (diff > tolerance || isnan(value)) {
		printf("Expecting %f (0x%x) with tolerance %f (%u ulps), but got %f (0x%x)\n",
		       e.f, e.u, tolerance, ulp, v.f, v.u);
		return false;
	}

	return true;
}

bool piglit_cl_probe_double(double value, double expect, uint64_t ulp)
{
	double diff;
	union {
		double f;
		uint64_t u;
	} v, e;

	v.f = value;
	e.f = expect;

	/* Treat infinity and nan separately */
	if (probe_float_check_nan_inf(value, expect)) {
		return true;
	}
	/* Check "any value" */
	if (ulp >= (1ul << 53)) {
		return true;
	}

	double direction = signbit(expect) ?  -INFINITY : INFINITY;
	double one_ulp = nextafter(expect, direction) - expect;
	double tolerance = fabs(ulp * one_ulp);

	diff = fabs(value - expect);

	if(diff > tolerance || isnan(value)) {
		printf("Expecting %f (0x%" PRIx64") with tolerance %f (%lu ulps), but got %f (0x%" PRIx64")\n",
		       e.f, e.u, tolerance, ulp, v.f, v.u);
		return false;
	}

	return true;

}

cl_half convert_cl_half(double in)
{
	union {
		uint64_t bits;
		double val;
	} convert = { .val = in };
	/* Bit 63 is sign bit */
	cl_half sign = (cl_half)((convert.bits >> 63) << 15);
	/* Get only the top 10 bits of mantissa */
	cl_half mantissa = (cl_half)((convert.bits >> 42) & 0x3ff);
	/* 11 bits of exponent */
	uint64_t exp = (convert.bits >> 52) & 0x7ff;
	/* 0 and ~0 are special cases that are not adjusted,
	 * half bias is 15, double bias is 1023 */
	cl_half exponent = ((exp == 0 || exp == 0x7ff) ? (exp & 0x3ff) :
	                   (exp - 1008)) << 10;
	return (sign | exponent | mantissa);
}

bool
piglit_cl_check_error(cl_int error, cl_int expected_error)
{
	if (error == expected_error) {
		return true;
	}

	/*
	 * If the lookup of the error's name is successful, then print
	 *     Unexpected CL error: NAME DEC
	 * Else, print
	 *     Unexpected CL error: DEC
	 */
	printf("Unexpected CL error: %s %d\n",
	       piglit_cl_get_error_name(error), error);

	/* Print the expected error, but only if an error was really expected. */
	if (expected_error != CL_SUCCESS) {
		printf("Expected CL error: %s %d\n",
		        piglit_cl_get_error_name(expected_error),
		        expected_error);
	}

	return false;
}

void
piglit_cl_expect_error(cl_int error,
                       cl_int expected_error,
                       enum piglit_result result)
{
	if(!piglit_cl_check_error(error, expected_error)) {
		piglit_report_result(result);
	}
}

int
piglit_cl_get_platform_version(cl_platform_id platform)
{
	char* version_string;
	const char *version_number_string;
	int scanf_count;
	int major;
	int minor;
	
	/*
	 * Returned format:
	 *   OpenCL<space><major_version.minor_version><space><platform-specific information>
	 */
	version_string = piglit_cl_get_platform_info(platform, CL_PLATFORM_VERSION);

	/* skip to version number */
	version_number_string = version_string + 6;

	/* Interpret version number */
	scanf_count = sscanf(version_number_string, "%i.%i", &major, &minor);
	if (scanf_count != 2) {
		printf("Unable to interpret CL_PLATFORM_VERSION string: %s\n",
		       version_string);
		free(version_string);
		piglit_report_result(PIGLIT_FAIL);
	}
	free(version_string);

	return 10*major+minor;
}

void
piglit_cl_require_platform_version(cl_platform_id platform,
                                   int required_version_times_10)
{
	if (piglit_cl_get_platform_version(platform) < required_version_times_10) {
		printf("Test requires OpenCL version %g\n",
		       required_version_times_10 / 10.0);
		piglit_report_result(PIGLIT_SKIP);
	}
}

int
piglit_cl_get_device_version(cl_device_id device)
{
	char* version_string;
	const char *version_number_string;
	int scanf_count;
	int major;
	int minor;

	/*
	 * Returned format:
	 *   OpenCL<space><major_version.minor_version><space><platform-specific information>
	 */
	version_string = piglit_cl_get_device_info(device, CL_DEVICE_VERSION);

	/* skip to version number */
	version_number_string = version_string + 6;

	/* Interpret version number */
	scanf_count = sscanf(version_number_string, "%i.%i", &major, &minor);
	if (scanf_count != 2) {
		printf("Unable to interpret CL_DEVICE_VERSION string: %s\n",
		       version_string);
		free(version_string);
		piglit_report_result(PIGLIT_FAIL);
	}
	free(version_string);

	return 10*major+minor;
}

void
piglit_cl_require_device_version(cl_device_id device,
                                 int required_version_times_10)
{
	if (piglit_cl_get_device_version(device) < required_version_times_10) {
		printf("Test requires OpenCL version %g\n",
		       required_version_times_10 / 10.0);
		piglit_report_result(PIGLIT_SKIP);
	}
}

int
piglit_cl_get_device_cl_c_version(cl_device_id device)
{
	char* version_string;
	const char *version_number_string;
	int scanf_count;
	int major;
	int minor;

	/* OpenCL 1.0 does not have enum CL_DEVICE_OPENCL_C_VERSION */
	if(piglit_cl_get_device_version(device) == 10) {
		return 10;
	}

	/*
	 * Returned format:
	 *   OpenCL<space>C<space><major_version.minor_version><space><vendor-specific information>
	 */
	version_string = piglit_cl_get_device_info(device,
	                                           CL_DEVICE_OPENCL_C_VERSION);

	/* skip to version number */
	version_number_string = version_string + 8;

	/* Interpret version number */
	scanf_count = sscanf(version_number_string, "%i.%i", &major, &minor);
	if (scanf_count != 2) {
		printf("Unable to interpret CL_DEVICE_OPENCL_C_VERSION string: %s\n",
		       version_string);
		free(version_string);
		piglit_report_result(PIGLIT_FAIL);
	}
	free(version_string);

	return 10*major+minor;
}

void
piglit_cl_require_device_cl_c_version(cl_device_id device,
                                      int required_version_times_10)
{
	if (piglit_cl_get_device_cl_c_version(device) < required_version_times_10) {
		printf("Test requires OpenCL C version %g\n",
		       required_version_times_10 / 10.0);
		piglit_report_result(PIGLIT_SKIP);
	}
}

struct _program_build_info_args {
	cl_program program;
	cl_device_id device;
};
struct _kernel_work_group_info_args {
	cl_kernel kernel;
	cl_device_id device;
};

static void*
piglit_cl_get_info(void* fn_ptr, void* obj, cl_uint param)
{
	cl_int errNo;
	size_t param_size;
	void* param_ptr = NULL;

	/* get param size */
	if(fn_ptr == clGetPlatformInfo) {
		errNo = clGetPlatformInfo(*(cl_platform_id*)obj, param, 0, NULL,
		                          &param_size);
	} else if(fn_ptr == clGetDeviceInfo) {
		errNo = clGetDeviceInfo(*(cl_device_id*)obj, param, 0, NULL,
		                        &param_size);
	} else if(fn_ptr == clGetContextInfo) {
		errNo = clGetContextInfo(*(cl_context*)obj, param, 0, NULL,
		                         &param_size);
	} else if(fn_ptr == clGetCommandQueueInfo) {
		errNo = clGetCommandQueueInfo(*(cl_command_queue*)obj, param, 0, NULL,
		                              &param_size);
	} else if(fn_ptr == clGetMemObjectInfo) {
		errNo = clGetMemObjectInfo(*(cl_mem*)obj, param, 0, NULL,
		                           &param_size);
	} else if(fn_ptr == clGetImageInfo) {
		errNo = clGetImageInfo(*(cl_mem*)obj, param, 0, NULL,
		                       &param_size);
	} else if(fn_ptr == clGetSamplerInfo) {
		errNo = clGetSamplerInfo(*(cl_sampler*)obj, param, 0, NULL,
		                         &param_size);
	} else if(fn_ptr == clGetProgramInfo) {
		errNo = clGetProgramInfo(*(cl_program*)obj, param, 0, NULL,
		                         &param_size);
	} else if(fn_ptr == clGetProgramBuildInfo) {
		errNo = clGetProgramBuildInfo(((struct _program_build_info_args*)obj)->program,
		                              ((struct _program_build_info_args*)obj)->device,
		                              param, 0, NULL, &param_size);
	} else if(fn_ptr == clGetKernelInfo) {
		errNo = clGetKernelInfo(*(cl_kernel*)obj, param, 0, NULL,
		                        &param_size);
	} else if(fn_ptr == clGetKernelWorkGroupInfo) {
		errNo = clGetKernelWorkGroupInfo(((struct _kernel_work_group_info_args*)obj)->kernel,
		                                 ((struct _kernel_work_group_info_args*)obj)->device,
		                                 param, 0, NULL, &param_size);
	} else if(fn_ptr == clGetEventInfo) {
		errNo = clGetEventInfo(*(cl_event*)obj, param, 0, NULL,
		                       &param_size);
	} else if(fn_ptr == clGetEventProfilingInfo) {
		errNo = clGetEventProfilingInfo(*(cl_event*)obj, param, 0, NULL,
		                                &param_size);
	} else {
		fprintf(stderr,
		        "Trying to get %s information from undefined function.\n",
		        piglit_cl_get_enum_name(param));
		piglit_report_result(PIGLIT_FAIL);
	}

	if(errNo == CL_SUCCESS) {
		param_ptr = calloc(param_size, sizeof(char));
		
		/* retrieve param */
		if(fn_ptr == clGetPlatformInfo) {
			errNo = clGetPlatformInfo(*(cl_platform_id*)obj, param,
			                          param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetDeviceInfo) {
			errNo = clGetDeviceInfo(*(cl_device_id*)obj, param,
			                        param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetContextInfo) {
			errNo = clGetContextInfo(*(cl_context*)obj, param,
			                         param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetCommandQueueInfo) {
			errNo = clGetCommandQueueInfo(*(cl_command_queue*)obj,
			                              param, param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetMemObjectInfo) {
			errNo = clGetMemObjectInfo(*(cl_mem*)obj, param,
			                           param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetImageInfo) {
			errNo = clGetImageInfo(*(cl_mem*)obj, param,
			                       param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetSamplerInfo) {
			errNo = clGetSamplerInfo(*(cl_sampler*)obj, param,
			                         param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetProgramInfo) {
			errNo = clGetProgramInfo(*(cl_program*)obj, param,
			                         param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetProgramBuildInfo) {
			errNo = clGetProgramBuildInfo(((struct _program_build_info_args*)obj)->program,
			                              ((struct _program_build_info_args*)obj)->device,
			                              param, param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetKernelInfo) {
			errNo = clGetKernelInfo(*(cl_kernel*)obj, param,
			                        param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetKernelWorkGroupInfo) {
			errNo = clGetKernelWorkGroupInfo(((struct _kernel_work_group_info_args*)obj)->kernel,
			                                 ((struct _kernel_work_group_info_args*)obj)->device,
			                                 param, param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetEventInfo) {
			errNo = clGetEventInfo(*(cl_event*)obj, param,
			                       param_size, param_ptr, NULL);
		} else if(fn_ptr == clGetEventProfilingInfo) {
			errNo = clGetEventProfilingInfo(*(cl_event*)obj, param,
			                                param_size, param_ptr, NULL);
		}

		if(errNo != CL_SUCCESS) {
			free(param_ptr);
			param_ptr = NULL;
		}
	}

	if(param_ptr == NULL) {
		fprintf(stderr,
		        "Unable to get %s information (Error: %s)\n",
		        piglit_cl_get_enum_name(param),
		        piglit_cl_get_error_name(errNo));
		piglit_report_result(PIGLIT_FAIL);
	}

	return param_ptr;
}

void*
piglit_cl_get_platform_info(cl_platform_id platform, cl_platform_info param) {
	return piglit_cl_get_info(clGetPlatformInfo, &platform, param);
}

void*
piglit_cl_get_device_info(cl_device_id device, cl_device_info param) {
	return piglit_cl_get_info(clGetDeviceInfo, &device, param);
}

void*
piglit_cl_get_context_info(cl_context context, cl_context_info param) {
	return piglit_cl_get_info(clGetContextInfo, &context, param);
}

void*
piglit_cl_get_command_queue_info(cl_command_queue command_queue,
                                 cl_command_queue_info param) {
	return piglit_cl_get_info(clGetCommandQueueInfo, &command_queue, param);
}

void*
piglit_cl_get_mem_object_info(cl_mem mem_obj, cl_mem_info param) {
	return piglit_cl_get_info(clGetMemObjectInfo, &mem_obj, param);
}

void*
piglit_cl_get_image_info(cl_mem image, cl_image_info param) {
	return piglit_cl_get_info(clGetImageInfo, &image, param);
}

void*
piglit_cl_get_sampler_info(cl_sampler sampler, cl_sampler_info param) {
	return piglit_cl_get_info(clGetSamplerInfo, &sampler, param);
}

void*
piglit_cl_get_program_info(cl_program program, cl_program_info param) {
	return piglit_cl_get_info(clGetProgramInfo, &program, param);
}

void*
piglit_cl_get_program_build_info(cl_program program, cl_device_id device,
                                 cl_program_build_info param) {
	struct _program_build_info_args args = {
		.program = program,
		.device = device
	};
	
	return piglit_cl_get_info(clGetProgramBuildInfo, &args, param);
}

void*
piglit_cl_get_kernel_info(cl_kernel kernel, cl_mem_info param) {
	return piglit_cl_get_info(clGetKernelInfo, &kernel, param);
}

void*
piglit_cl_get_kernel_work_group_info(cl_kernel kernel, cl_device_id device,
                                     cl_mem_info param) {
	struct _kernel_work_group_info_args args = {
		.kernel = kernel,
		.device = device
	};
	
	return piglit_cl_get_info(clGetKernelWorkGroupInfo, &args, param);
}

void*
piglit_cl_get_event_info(cl_event event, cl_event_info param) {
	return piglit_cl_get_info(clGetEventInfo, &event, param);
}

void*
piglit_cl_get_event_profiling_info(cl_event event, cl_profiling_info param) {
	return piglit_cl_get_info(clGetEventProfilingInfo, &event, param);
}

bool
piglit_cl_is_platform_extension_supported(cl_platform_id platform,
                                          const char *name)
{
	char* extensions = piglit_cl_get_platform_info(platform,
	                                               CL_PLATFORM_EXTENSIONS);
	bool supported = piglit_is_extension_in_string(extensions, name);

	free(extensions);

	return supported;
}

void
piglit_cl_require_platform_extension(cl_platform_id platform, const char *name)
{
	if (!piglit_cl_is_platform_extension_supported(platform, name)) {
		printf("Test requires %s platform extension\n", name);
		piglit_report_result(PIGLIT_SKIP);
	}
}

void
piglit_cl_require_not_platform_extension(cl_platform_id platform,
                                         const char *name)
{
	if (piglit_cl_is_platform_extension_supported(platform, name)) {
		printf("Test requires absence of %s\n platform extension\n", name);
		piglit_report_result(PIGLIT_SKIP);
	}
}

bool
piglit_cl_is_device_extension_supported(cl_device_id device, const char *name)
{
	char* extensions = piglit_cl_get_device_info(device, CL_DEVICE_EXTENSIONS);
	bool supported = piglit_is_extension_in_string(extensions, name);

	free(extensions);

	return supported;
}

void
piglit_cl_require_device_extension(cl_device_id device, const char *name)
{
	if (!piglit_cl_is_device_extension_supported(device, name)) {
		printf("Test requires %s device extension\n", name);
		piglit_report_result(PIGLIT_SKIP);
	}
}

void
piglit_cl_require_not_device_extension(cl_device_id device, const char *name)
{
	if (piglit_cl_is_device_extension_supported(device, name)) {
		printf("Test requires absence of %s device extension\n", name);
		piglit_report_result(PIGLIT_SKIP);
	}
}

unsigned int
piglit_cl_get_platform_ids(cl_platform_id** platform_ids)
{
	cl_int errNo;
	cl_uint num_platform_ids;

	/* get number of platforms */
	errNo = clGetPlatformIDs(0, NULL, &num_platform_ids);
	if(errNo != CL_SUCCESS) {
		fprintf(stderr,
		        "Could not get number of platforms: %s\n",
		        piglit_cl_get_error_name(errNo));
		return 0;
	}

	/* get platform list */
	if(platform_ids != NULL && num_platform_ids > 0) {
		*platform_ids = malloc(num_platform_ids * sizeof(cl_platform_id));
		errNo = clGetPlatformIDs(num_platform_ids, *platform_ids, NULL);
		if(errNo != CL_SUCCESS) {
			free(platform_ids);
			*platform_ids = malloc(0);
			fprintf(stderr,
			        "Could not get get platform list: %s\n",
			        piglit_cl_get_error_name(errNo));
			return 0;
		}
	}

	return num_platform_ids;
}

unsigned int
piglit_cl_get_device_ids(cl_platform_id platform_id, cl_device_type device_type,
                         cl_device_id** device_ids)
{
	cl_int errNo;
	cl_uint num_device_ids;
	cl_uint num_platform_ids;
	cl_platform_id *platform_ids;
	int i;

	/* get platform_ids */
	num_platform_ids = piglit_cl_get_platform_ids(&platform_ids);

	/* find the right platform */
	for(i = 0; i < num_platform_ids; i++) {
		if(platform_ids[i] == platform_id) {
			/* get number of devices */
			errNo = clGetDeviceIDs(platform_id,
			                       device_type,
			                       0,
			                       NULL,
			                       &num_device_ids);
			if(errNo == CL_DEVICE_NOT_FOUND) {
				*device_ids = malloc(0);
				return 0;
			}
			if(errNo != CL_SUCCESS) {
				free(platform_ids);
				*device_ids = malloc(0);
				fprintf(stderr,
				        "Could not get number of devices: %s\n",
				        piglit_cl_get_error_name(errNo));
				return 0;
			}
		
			/* get device list */
			if(device_ids != NULL && num_device_ids > 0) {
				*device_ids = malloc(num_device_ids * sizeof(cl_device_id));
				errNo = clGetDeviceIDs(platform_id,
				                       CL_DEVICE_TYPE_ALL,
				                       num_device_ids,
				                       *device_ids,
				                       NULL);
				if(errNo != CL_SUCCESS) {
					free(platform_ids);
					free(device_ids);
					*device_ids = malloc(0);
					fprintf(stderr,
					        "Could not get get device list: %s\n",
					        piglit_cl_get_error_name(errNo));
					return 0;
				}
			}

			free(platform_ids);

			return num_device_ids;
		}
	}

	free(platform_ids);

	/* received invalid platform_id */
	fprintf(stderr, "Trying to get a device from invalid platform_id\n");

	*device_ids = malloc(0);
	return 0;
}

piglit_cl_context
piglit_cl_create_context(cl_platform_id platform_id,
                         const cl_device_id device_ids[],
                        unsigned int num_devices)
{
	piglit_cl_context context = malloc(sizeof(struct _piglit_cl_context));

	int i;
	cl_int errNo;
	cl_context_properties cl_ctx_properties[] = {
		CL_CONTEXT_PLATFORM, (cl_context_properties)platform_id,
		0
	};

	/* assign platform */
	context->platform_id = platform_id;

	/* assign devices */
	context->num_devices = num_devices;
	context->device_ids = malloc(num_devices * sizeof(cl_device_id));
	memcpy(context->device_ids, device_ids, num_devices * sizeof(cl_device_id));

	/* create and assign context */
	context->cl_ctx = clCreateContext(cl_ctx_properties,
	                                  context->num_devices,
	                                  context->device_ids,
	                                  NULL,
	                                  NULL,
	                                  &errNo);
	if(errNo != CL_SUCCESS) {
		free(context->device_ids);
		free(context);
		fprintf(stderr,
		        "Could not create context: %s\n",
		        piglit_cl_get_error_name(errNo));
		return NULL;
	}

	/* create and assign command queues */
	context->command_queues = malloc(num_devices * sizeof(cl_command_queue));
	for(i = 0; i < num_devices; i++) {
		context->command_queues[i] = clCreateCommandQueue(context->cl_ctx,
		                                                  context->device_ids[i],
		                                                  0,
		                                                  &errNo);
		if(errNo != CL_SUCCESS) {
			clReleaseContext(context->cl_ctx);
			free(context->device_ids);
			free(context->command_queues);
			free(context);
			fprintf(stderr,
			        "Could not create command queue: %s\n",
			        piglit_cl_get_error_name(errNo));
			return NULL;
		}
	}

	return context;
}

void
piglit_cl_release_context(piglit_cl_context context)
{
	int i;

	if(context == NULL) {
		return;
	}

	/* release command queues */
	for(i = 0; i < context->num_devices; i++) {
		if(clReleaseCommandQueue(context->command_queues[i]) != CL_SUCCESS) {
			printf("Command queue already released\n");
		}
	}

	/* release context */
	if(clReleaseContext(context->cl_ctx) != CL_SUCCESS) {
		printf("Context already released\n");
	}

	/* free memory */
	free(context->device_ids);
	free(context->command_queues);
	free(context);
}

cl_program
piglit_cl_build_program_with_source_extended(piglit_cl_context context,
                                             cl_uint count, char** strings,
                                             const char* options, bool fail)
{
	cl_int errNo;
	cl_program program;

	program = clCreateProgramWithSource(context->cl_ctx,
	                                    count,
	                                    (const char**)strings,
	                                    NULL,
	                                    &errNo);
	if(errNo != CL_SUCCESS) {
		fprintf(stderr,
		        "Could not create program with source: %s\n",
		        piglit_cl_get_error_name(errNo));
		return NULL;
	}
	
	errNo = clBuildProgram(program,
	                       context->num_devices,
	                       context->device_ids,
	                       options,
	                       NULL,
	                       NULL);
	if(   (!fail && errNo != CL_SUCCESS)
	   || ( fail && errNo == CL_SUCCESS)) {
		int i;

		fprintf(stderr,
		        !fail ? "Could not build program: %s\n"
		              : "Program built when it should have failed: %s\n",
		        piglit_cl_get_error_name(errNo));

		/*printf("Build log for source:\n");
		for(i = 0; i < count; i++) {
			printf("%s\n", strings[i]);
		}*/

		for(i = 0; i < context->num_devices; i++) {
			char* device_name = piglit_cl_get_device_info(context->device_ids[i],
			                                              CL_DEVICE_NAME);
			char* log = piglit_cl_get_program_build_info(program,
			                                             context->device_ids[i],
			                                             CL_PROGRAM_BUILD_LOG);
			
			printf("Build log for device %s:\n -------- \n%s\n -------- \n",
			       device_name,
			       log);

			free(device_name);
			free(log);
		}

		clReleaseProgram(program);
		return NULL;
	}

	return program;
}

cl_program
piglit_cl_build_program_with_source(piglit_cl_context context, cl_uint count,
                                    char** strings, const char* options)
{
	return piglit_cl_build_program_with_source_extended(context, count, strings, options, false);
}

cl_program
piglit_cl_fail_build_program_with_source(piglit_cl_context context,
                                         cl_uint count, char** strings,
                                         const char* options)
{
	return piglit_cl_build_program_with_source_extended(context, count, strings, options, true);
}

cl_program
piglit_cl_build_program_with_binary_extended(piglit_cl_context context,
                                             size_t* lengths,
                                             unsigned char** binaries,
                                             const char* options, bool fail)
{
	cl_int errNo;
	cl_program program;

	cl_int* binary_status = malloc(sizeof(cl_int) * context->num_devices);

	program = clCreateProgramWithBinary(context->cl_ctx,
	                                    context->num_devices,
	                                    context->device_ids,
	                                    lengths,
	                                    (const unsigned char**)binaries,
	                                    binary_status,
	                                    &errNo);
	if(errNo != CL_SUCCESS) {
		int i;

		fprintf(stderr,
		        "Could not create program with binary: %s\n",
		        piglit_cl_get_error_name(errNo));

		printf("Create error with binaries:\n");
		for(i = 0; i < context->num_devices; i++) {
			char* device_name = piglit_cl_get_device_info(context->device_ids[i],
			                                              CL_DEVICE_NAME);
			
			printf("Error for %s: %s\n",
			       device_name,
			       piglit_cl_get_error_name(binary_status[i]));
			
			free(device_name);
		}

		free(binary_status);
		return NULL;
	}
	free(binary_status);
	
	errNo = clBuildProgram(program,
	                       context->num_devices,
	                       context->device_ids,
	                       options,
	                       NULL,
	                       NULL);
	if(   (!fail && errNo != CL_SUCCESS)
	   || ( fail && errNo == CL_SUCCESS)) {
		int i;

		fprintf(stderr,
		        !fail ? "Could not build program: %s\n"
		              : "Program built when it should have failed: %s\n",
		        piglit_cl_get_error_name(errNo));

		printf("Build log for binaries.\n");

		for(i = 0; i < context->num_devices; i++) {
			char* device_name = piglit_cl_get_device_info(context->device_ids[i],
			                                              CL_DEVICE_NAME);
			char* log = piglit_cl_get_program_build_info(program,
			                                             context->device_ids[i],
			                                             CL_PROGRAM_BUILD_LOG);
			
			printf("Build log for device %s:\n -------- \n%s\n -------- \n",
			       device_name,
			       log);
			
			free(device_name);
			free(log);
		}

		clReleaseProgram(program);
		return NULL;
	}

	return program;
}

cl_program
piglit_cl_build_program_with_binary(piglit_cl_context context, size_t* lengths,
                                    unsigned char** binaries,
                                    const char* options)
{
	return piglit_cl_build_program_with_binary_extended(context, lengths,
	                                                    binaries, options,
	                                                    false);
}

cl_program
piglit_cl_fail_build_program_with_binary(piglit_cl_context context,
                                         size_t* lengths,
                                         unsigned char** binaries,
                                         const char* options)
{
	return piglit_cl_build_program_with_binary_extended(context, lengths,
	                                                    binaries, options,
	                                                    true);
}

cl_mem
piglit_cl_create_buffer(piglit_cl_context context, cl_mem_flags flags,
                                                   size_t size)
{
	cl_int errNo;
	cl_mem buffer;

	buffer = clCreateBuffer(context->cl_ctx, flags, size, NULL, &errNo);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not create buffer: %s\n",
		        piglit_cl_get_error_name(errNo));
	}

	return buffer;
}

bool
piglit_cl_write_buffer(cl_command_queue command_queue, cl_mem buffer,
                       size_t offset, size_t cb, const void *ptr)
{
	cl_int errNo;

	errNo = clEnqueueWriteBuffer(command_queue, buffer, CL_TRUE, offset, cb,
	                             ptr, 0, NULL, NULL);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not enqueue buffer write: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_write_whole_buffer(cl_command_queue command_queue, cl_mem buffer,
                             const void *ptr)
{
	bool success;
	size_t* buffer_size;

	buffer_size = piglit_cl_get_mem_object_info(buffer, CL_MEM_SIZE);
	success = piglit_cl_write_buffer(command_queue, buffer, 0, *buffer_size,
	                                 ptr);
	free(buffer_size);

	return success;
}

bool
piglit_cl_read_buffer(cl_command_queue command_queue, cl_mem buffer,
                      size_t offset, size_t cb, void *ptr)
{
	cl_int errNo;

	errNo = clEnqueueReadBuffer(command_queue, buffer, CL_TRUE, offset, cb, ptr,
	                            0, NULL, NULL);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not enqueue buffer read: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_read_whole_buffer(cl_command_queue command_queue, cl_mem buffer,
                            void *ptr)
{
	bool success;
	size_t* buffer_size;

	buffer_size = piglit_cl_get_mem_object_info(buffer, CL_MEM_SIZE);
	success = piglit_cl_read_buffer(command_queue, buffer, 0, *buffer_size,
	                                ptr);
	free(buffer_size);

	return success;
}

bool
piglit_cl_get_context_image_support(const piglit_cl_context context)
{
	bool ret = false;

	unsigned i;
	for(i = 0; i < context->num_devices; i++)
		ret |= piglit_cl_get_device_image_support(context->device_ids[i]);

	return ret;
}

bool
piglit_cl_get_device_image_support(cl_device_id device)
{
	bool ret = false;

	cl_bool *image_support =
		piglit_cl_get_device_info(device, CL_DEVICE_IMAGE_SUPPORT);

	if (image_support)
		ret = *image_support;

	free(image_support);

	return ret;
}

cl_mem
piglit_cl_create_image(piglit_cl_context context, cl_mem_flags flags,
                       const cl_image_format *format,
                       const piglit_image_desc *desc)
{
	cl_int errNo;
	cl_mem image = NULL;

#ifdef CL_VERSION_1_2
	if (piglit_cl_get_platform_version(context->platform_id) >= 12) {
		image = clCreateImage(context->cl_ctx, flags, format, desc, NULL, &errNo);
	} else
#endif
	if (desc->image_type == CL_MEM_OBJECT_IMAGE2D) {
		image = clCreateImage2D(context->cl_ctx, flags, format,
		                        desc->image_width, desc->image_height, 0,
		                        NULL, &errNo);
	} else if (desc->image_type == CL_MEM_OBJECT_IMAGE3D) {
		image = clCreateImage3D(context->cl_ctx, flags, format,
		                        desc->image_width, desc->image_height,
		                        desc->image_depth, 0, 0,
		                        NULL, &errNo);
	} else {
		errNo = CL_INVALID_OPERATION;
		fprintf(stderr,
		        "Invalid image mem object type: %s\n",
		        piglit_cl_get_enum_name(desc->image_type));
	}
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not create image: %s\n",
		        piglit_cl_get_error_name(errNo));
	}

	return image;
}

bool
piglit_cl_write_image(cl_command_queue command_queue, cl_mem image,
                      const size_t *origin, const size_t *region,
                      const void *ptr)
{
	cl_int errNo;

	errNo = clEnqueueWriteImage(command_queue, image, CL_TRUE, origin, region,
	                            0, 0, ptr, 0, NULL, NULL);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not enqueue image write: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

static void
piglit_get_image_region(cl_mem image, size_t *region)
{
	size_t *p = NULL;
	cl_mem_object_type *type;

	type = piglit_cl_get_mem_object_info(image, CL_MEM_TYPE);

	p = piglit_cl_get_image_info(image, CL_IMAGE_WIDTH);
	region[0] = *p;
	free(p);

	switch (*type) {
#ifdef CL_VERSION_1_2
		case CL_MEM_OBJECT_IMAGE1D_ARRAY:
			p = piglit_cl_get_image_info(image, CL_IMAGE_ARRAY_SIZE);
			region[1] = *p;
			free(p);
			region[2] = 1;
			break;
		case CL_MEM_OBJECT_IMAGE1D:
		case CL_MEM_OBJECT_IMAGE1D_BUFFER:
			region[1] = 1;
			region[2] = 1;
			break;
		case CL_MEM_OBJECT_IMAGE2D_ARRAY:
			p = piglit_cl_get_image_info(image, CL_IMAGE_HEIGHT);
			region[1] = *p;
			free(p);
			p = piglit_cl_get_image_info(image, CL_IMAGE_ARRAY_SIZE);
			region[2] = *p;
			free(p);
			break;
#endif
		case CL_MEM_OBJECT_IMAGE2D:
			p = piglit_cl_get_image_info(image, CL_IMAGE_HEIGHT);
			region[1] = *p;
			free(p);
			region[2] = 1;
			break;
		case CL_MEM_OBJECT_IMAGE3D:
			p = piglit_cl_get_image_info(image, CL_IMAGE_HEIGHT);
			region[1] = *p;
			free(p);
			p = piglit_cl_get_image_info(image, CL_IMAGE_DEPTH);
			region[2] = *p;
			free(p);
			break;
	}

	free(type);
}

bool
piglit_cl_write_whole_image(cl_command_queue command_queue, cl_mem image,
                            const void *ptr)
{
	bool success;
	size_t origin[3], region[3];

	memset(origin, 0, sizeof(origin));
	piglit_get_image_region(image, region);
	success = piglit_cl_write_image(command_queue, image, origin, region, ptr);

	return success;
}

bool
piglit_cl_read_image(cl_command_queue command_queue, cl_mem image,
                     const size_t *origin, const size_t *region,
                     void *ptr)
{
	cl_int errNo;

	errNo = clEnqueueReadImage(command_queue, image, CL_TRUE, origin, region,
	                           0, 0, ptr, 0, NULL, NULL);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not enqueue image read: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_read_whole_image(cl_command_queue command_queue, cl_mem image,
                           void *ptr)
{
	bool success;
	size_t origin[3], region[3];

	memset(origin, 0, sizeof(origin));
	piglit_get_image_region(image, region);
	success = piglit_cl_read_image(command_queue, image, origin, region, ptr);

	return success;
}

cl_kernel
piglit_cl_create_kernel(cl_program program, const char* kernel_name)
{
	cl_int errNo;
	cl_kernel kernel;

	kernel = clCreateKernel(program, kernel_name, &errNo);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not create kernel %s: %s\n",
		        kernel_name,
		        piglit_cl_get_error_name(errNo));
	}

	return kernel;
}

cl_sampler
piglit_cl_create_sampler(piglit_cl_context context,
                         cl_bool normalized_coords,
                         cl_addressing_mode addressing_mode,
                         cl_filter_mode filter_mode)
{
	cl_int errNo;
	cl_sampler sampler;

	sampler = clCreateSampler(context->cl_ctx, normalized_coords,
	                          addressing_mode, filter_mode, &errNo);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not create sampler: %s\n",
		        piglit_cl_get_error_name(errNo));
	}

	return sampler;
}

bool
piglit_cl_set_kernel_arg(cl_kernel kernel, cl_uint arg_index, size_t size,
                         const void* arg_value)
{
	cl_int errNo;

	errNo = clSetKernelArg(kernel, arg_index, size, arg_value);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not set kernel argument %u: %s\n",
		        arg_index,
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_set_kernel_buffer_arg(cl_kernel kernel, cl_uint arg_index,
                                cl_mem *buffer)
{
	bool success;

	success = piglit_cl_set_kernel_arg(kernel, arg_index, sizeof(cl_mem),
	                                   buffer);
	if(!success) {
		fprintf(stderr,
		        "Could not set kernel buffer argument %u\n",
		        arg_index);
		return false;
	}

	return success;
}

bool
piglit_cl_enqueue_ND_range_kernel(cl_command_queue command_queue,
                                  cl_kernel kernel, cl_uint work_dim,
                                  const size_t* global_offset,
                                  const size_t* global_work_size,
                                  const size_t* local_work_size,
				  cl_event *ev)
{
	cl_int errNo;

	errNo = clEnqueueNDRangeKernel(command_queue, kernel, work_dim,
	                               global_offset, global_work_size,
	                               local_work_size, 0, NULL, ev);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not enqueue ND range kernel: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_execute_ND_range_kernel(cl_command_queue command_queue,
                                  cl_kernel kernel, cl_uint work_dim,
                                  const size_t* global_offset,
                                  const size_t* global_work_size,
                                  const size_t* local_work_size)
{
	int errNo;
	cl_event ev;

	if(!piglit_cl_enqueue_ND_range_kernel(command_queue,
	                                     kernel,
	                                     work_dim,
	                                     global_offset,
	                                     global_work_size,
	                                     local_work_size,
					     &ev)) {
		return false;
	}

	errNo = clWaitForEvents(1, &ev);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not wait for kernel to finish: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_enqueue_task(cl_command_queue command_queue, cl_kernel kernel)
{
	cl_int errNo;

	errNo = clEnqueueTask(command_queue, kernel,
	                      0, NULL, NULL);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not enqueue task: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}

bool
piglit_cl_execute_task(cl_command_queue command_queue, cl_kernel kernel)
{
	int errNo;

	if(!piglit_cl_enqueue_task(command_queue,
	                           kernel)) {
		return false;
	}

	errNo = clFinish(command_queue);
	if(!piglit_cl_check_error(errNo, CL_SUCCESS)) {
		fprintf(stderr,
		        "Could not wait for kernel to finish: %s\n",
		        piglit_cl_get_error_name(errNo));
		return false;
	}

	return true;
}