Improve program callbacks

Author: raub

index.d.ts

@@ -501,7 +501,6 @@ declare namespace cl {
 	export type TClSampler = TClObject & { __brand: "cl_sampler" };
 	export type TClQueue = TClObject & { __brand: "cl_command_queue" };
 	export type TClEvent = TClObject & { __brand: "cl_event" };
-	export type TClMapped = TClObject & { __brand: "cl_mapped_ptr" };
 
 	export type TClEventOrVoid = TClEvent | undefined;
 	export type TClHostData = ArrayBuffer | ArrayBufferView | Buffer;
@@ -635,12 +634,13 @@ declare namespace cl {
 	) => TClImageFormat[];
 
 	/**
+	 * For cl.MEM_HOST_PTR returns `ArrayBuffer` for cl.MEM_USE_HOST_PTR buffers, and `null` for others.
 	 * @see [clGetMemObjectInfo](https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clGetMemObjectInfo.html)
 	 */
 	const getMemObjectInfo: (
 		mem: TClMem,
 		param_name: number,
-	) => (number | TClMem | TClContext | Object);
+	) => (number | TClMem | TClContext | ArrayBuffer | null);
 
 	/**
 	 * @see [clGetImageInfo](https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clGetImageInfo.html)
@@ -720,7 +720,7 @@ declare namespace cl {
 	 */
 	const releaseProgram: (program: TClProgram) => TClStatus;
 
-	export type TBuildProgramCb = (program: TClProgram, user_data: Object) => undefined;
+	export type TBuildProgramCb = (program: TClProgram, userData: unknown) => void;
 
 	/**
 	 * @see [clBuildProgram](https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/clBuildProgram.html)
@@ -730,7 +730,7 @@ declare namespace cl {
 		devices?: TClDevice[] | null,
 		options?: string | null,
 		cb?: TBuildProgramCb | null,
-		user_data?: Object,
+		userData?: unknown,
 	) => TClStatus;
 
 	/**
@@ -743,7 +743,7 @@ declare namespace cl {
 		headers?: TClProgram[] | null,
 		names?: string[] | null,
 		cb?: TBuildProgramCb | null,
-		user_data?: Object,
+		userData?: unknown,
 	) => TClStatus;
 
 	/**
@@ -755,7 +755,7 @@ declare namespace cl {
 		options?: string | null,
 		programs?: TClProgram[],
 		cb?: TBuildProgramCb | null,
-		user_data?: Object,
+		userData?: unknown,
 	) => TClProgram;
 
 	/**

src/cpp/memobj.cpp

@@ -246,15 +246,29 @@ JS_METHOD(getMemObjectInfo) { NAPI_ENV;
 			RET_NUM(val);
 		}
 		case CL_MEM_HOST_PTR: {
-			void* val;
+			size_t memSize;
+			CHECK_ERR(clGetMemObjectInfo(
+				mem,
+				CL_MEM_SIZE,
+				sizeof(size_t),
+				&memSize,
+				nullptr
+			));
+			if (!memSize) {
+				RET_NULL;
+			}
+			void* memPtr;
 			CHECK_ERR(clGetMemObjectInfo(
 				mem,
 				param_name,
 				sizeof(void*),
-				&val,
+				&memPtr,
 				nullptr
 			));
-			RET_WRAPPER(val);
+			if (!memPtr) {
+				RET_NULL;
+			}
+			RET_VALUE(Napi::ArrayBuffer::New(env, memPtr, memSize));
 		}
 		case CL_MEM_CONTEXT: {
 			cl_context val;

src/cpp/program.cpp

@@ -116,40 +116,40 @@ JS_METHOD(releaseProgram) { NAPI_ENV;
 	RET_NUM(CL_SUCCESS);
 }
 
-class ProgramWorker : public Napi::AsyncWorker {
+class NotifyHelper {
 public:
-	ProgramWorker(Napi::Function callback, Napi::Object userData, Napi::Object wrapper):
-	Napi::AsyncWorker(callback, "CL::ProgramWorker") {
-		_refProgram.Reset(wrapper, 1);
-		_refData.Reset(userData, 1);
+	NotifyHelper(Napi::Function callback, Napi::Value userData) {
+		_ref.Reset(Napi::Object::New(callback.Env()), 1);
+		_ref.Set("cb", callback);
+		_ref.Set("data", userData);
 	}
 
-	~ProgramWorker() {}
-	
-	// Executed inside the worker-thread.
-	void Execute() {}
+	~NotifyHelper() {
+		Napi::Env env = _ref.Env();
+		_ref.Set("cb", env.Undefined());
+		_ref.Set("data", env.Undefined());
+		_ref.Reset();
+	}
 
-	// Executed when the async work is complete
-	// this function will be run inside the main event loop
-	void OnOK () {
-		Napi::Env env = Env();
-		NAPI_HS;
-		Callback().Call({
-			_refProgram.Value(), // program
-			_refData.Value() // userdata
-		});
+	static void CL_CALLBACK callNotify(cl_program prog, void *ptr) {
+		NotifyHelper *notifier = reinterpret_cast<NotifyHelper*>(ptr);
+		notifier->notify(prog);
+		delete notifier;
 	}
 
 private:
-	Napi::ObjectReference _refProgram;
-	Napi::ObjectReference _refData;
+	Napi::ObjectReference _ref;
+	
+	void notify(cl_program prog) {
+		Napi::Env env = _ref.Env(); NAPI_HS;
+		
+		_ref.Get("cb").As<Napi::Function>().Call({
+			Wrapper::fromRaw(env, prog),
+			_ref.Get("data")
+		});
+	}
 };
 
-void CL_CALLBACK notifyPCB (cl_program prog, void *user_data) {
-	ProgramWorker* asyncCB = reinterpret_cast<ProgramWorker*>(user_data);
-	asyncCB->Queue();
-}
-
 JS_METHOD(buildProgram) { NAPI_ENV;
 	REQ_CL_ARG(0, p, cl_program);
 
@@ -172,19 +172,13 @@ JS_METHOD(buildProgram) { NAPI_ENV;
 	// callback + userdata
 	if (!IS_ARG_EMPTY(3)) {
 		REQ_FUN_ARG(3, callback);
-		ProgramWorker* cb = new ProgramWorker(
-			callback,
-			info[4].As<Napi::Object>(),
-			info[0].As<Napi::Object>()
-		);
-		
 		err = clBuildProgram(
 			p,
 			(cl_uint) cl_devices.size(),
 			&cl_devices.front(),
 			options.length() > 0 ? options.c_str() : nullptr,
-			notifyPCB,
-			cb
+			NotifyHelper::callNotify,
+			new NotifyHelper(callback, info[4])
 		);
 	} else {
 		err = clBuildProgram(
@@ -250,11 +244,6 @@ JS_METHOD(compileProgram) { NAPI_ENV;
 
 	if (!IS_ARG_EMPTY(5)) {
 		REQ_FUN_ARG(5, callback);
-		ProgramWorker* cb = new ProgramWorker(
-			callback,
-			info[6].As<Napi::Object>(),
-			info[0].As<Napi::Object>()
-		);
 		err = clCompileProgram(
 			p,
 			(cl_uint) cl_devices.size(),
@@ -263,8 +252,8 @@ JS_METHOD(compileProgram) { NAPI_ENV;
 			(cl_uint) program_headers.size(),
 			&program_headers.front(),
 			&names.front(),
-			notifyPCB,
-			cb
+			NotifyHelper::callNotify,
+			new NotifyHelper(callback, info[6])
 		);
 	} else {
 		err = clCompileProgram(
@@ -311,27 +300,21 @@ JS_METHOD(linkProgram) { NAPI_ENV;
 		}
 	}
 
-	// OSX ISSUE: ret always equals to CL_SUCCESS
 	cl_int ret = CL_SUCCESS;
 
 	cl_program prg;
 
 	if (!IS_ARG_EMPTY(4)) {
 		REQ_FUN_ARG(4, callback);
-		ProgramWorker* cb = new ProgramWorker(
-			callback,
-			info[5].As<Napi::Object>(),
-			info[0].As<Napi::Object>()
-		);
 		prg = clLinkProgram(
 			ctx,
 			(cl_uint) cl_devices.size(),
 			&cl_devices.front(),
 			options.length() > 0 ? options.c_str() : nullptr,
 			(cl_uint) cl_programs.size(),
 			&cl_programs.front(),
-			notifyPCB,
-			cb,
+			NotifyHelper::callNotify,
+			new NotifyHelper(callback, info[5]),
 			&ret
 		);
 	} else {

src/cpp/types.cpp

@@ -53,7 +53,6 @@ TypeInfo typeInfo[] = {
 		reinterpret_cast<cl_func>(clReleaseEvent),
 		reinterpret_cast<cl_func>(clRetainEvent)
 	},
-	{ "cl_mapped_ptr", noop, noop }
 };
 
 
@@ -63,6 +62,7 @@ IMPLEMENT_ES5_CLASS(Wrapper);
 void Wrapper::init(Napi::Env env, Napi::Object exports) {
 	Napi::Function ctor = wrap(env);
 	JS_ASSIGN_METHOD(toString);
+	JS_ASSIGN_GETTER(_);
 	exports.Set("Wrapper", ctor);
 }
 
@@ -94,9 +94,6 @@ Napi::Object Wrapper::fromRaw(Napi::Env env, cl_command_queue raw) {
 Napi::Object Wrapper::fromRaw(Napi::Env env, cl_event raw) {
 	return _ctorEs5.New({ JS_EXT(raw), JS_NUM(9) });
 }
-Napi::Object Wrapper::fromRaw(Napi::Env env, cl_mapped_ptr raw) {
-	return _ctorEs5.New({ JS_EXT(raw), JS_NUM(10) });
-}
 
 
 Wrapper::Wrapper(const Napi::CallbackInfo& info) { NAPI_ENV;
@@ -116,15 +113,13 @@ Wrapper::Wrapper(const Napi::CallbackInfo& info) { NAPI_ENV;
 	int32_t infoIdx = info[1].ToNumber().Int32Value();
 
 	_data = extParam.Data();
-	_released = 1;
 	_acquire = typeInfo[infoIdx].acquire;
 	_release = typeInfo[infoIdx].release;
 	_typeName = typeInfo[infoIdx].typeName;
 }
 
 
 Wrapper::~Wrapper() {
-	release();
 }
 
 
@@ -134,6 +129,9 @@ JS_IMPLEMENT_METHOD(Wrapper, toString) { NAPI_ENV;
 	RET_STR(out.str());
 }
 
+JS_IMPLEMENT_GETTER(Wrapper, _) { NAPI_ENV;
+	RET_X64(reinterpret_cast<uint64_t>(_data));
+}
 
 void Wrapper::throwArrayEx(Napi::Env env, int i, const char* msg) {
 	std::stringstream out;
@@ -143,16 +141,11 @@ void Wrapper::throwArrayEx(Napi::Env env, int i, const char* msg) {
 
 
 cl_int Wrapper::acquire() {
-	_released++;
 	return _acquire(_data);
 }
 
 
 cl_int Wrapper::release() {
-	if (_released < 1) {
-		return CL_SUCCESS;
-	}
-	_released--;
 	return _release(_data);
 }
 

src/cpp/types.hpp

@@ -9,7 +9,6 @@
 
 namespace opencl {
 
-typedef void *cl_mapped_ptr;
 typedef int (*cl_func)(void*);
 
 
@@ -28,12 +27,12 @@ DECLARE_ES5_CLASS(Wrapper, Wrapper);
 	static Napi::Object fromRaw(Napi::Env env, cl_sampler raw);
 	static Napi::Object fromRaw(Napi::Env env, cl_command_queue raw);
 	static Napi::Object fromRaw(Napi::Env env, cl_event raw);
-	static Napi::Object fromRaw(Napi::Env env, cl_mapped_ptr raw);
 
 	explicit Wrapper(const Napi::CallbackInfo& info);
 	~Wrapper();
 
 	JS_DECLARE_METHOD(Wrapper, toString);
+	JS_DECLARE_GETTER(Wrapper, _);
 
 	cl_int acquire();
 	cl_int release();

test/device.test.ts

@@ -16,21 +16,21 @@ describe('Device', () => {
 	});
 
 	const testBoolean = (name: keyof typeof cl) => {
-		it(name + ' returns a boolean', (t, done) => {
+		it(name + ' returns a boolean', (_t, done) => {
 			const val = cl.getDeviceInfo(device, cl[name] as number);
 			U.assertType(val, 'boolean');
 			done();
 		});
 	};
 	const testInteger = (name: keyof typeof cl) => {
-		it(name + ' returns an integer', (t, done) => {
+		it(name + ' returns an integer', (_t, done) => {
 			const val = cl.getDeviceInfo(device, cl[name] as number);
 			U.assertType(val, 'number');
 			done();
 		});
 	};
 	const testString = (name: keyof typeof cl) => {
-		it(name + ' returns a string', (t, done) => {
+		it(name + ' returns a string', (_t, done) => {
 			const val = cl.getDeviceInfo(device, cl[name] as number);
 			U.assertType(val, 'string');
 			done();
@@ -43,7 +43,7 @@ describe('Device', () => {
 		});
 	};
 	const testArray = (name: keyof typeof cl) => {
-		it(name + ' returns an array', (t, done) => {
+		it(name + ' returns an array', (_t, done) => {
 			const val = cl.getDeviceInfo(device, cl[name] as number);
 			U.assertType(val, 'array');
 			done();

test/event.test.ts

@@ -106,7 +106,7 @@ describe('Event', () => {
 	});
 
 	describe('#setEventCallback', () => {
-		it('calls cb', (t, done) => {
+		it('calls cb', (_t, done) => {
 			const uEvent = cl.createUserEvent(context);
 			cl.setEventCallback(
 				uEvent,

test/memobj-info.test.ts

@@ -7,7 +7,7 @@ import * as U from './utils.ts';
 describe('MemObj', () => {
 	const { context } = cl.quickStart();
 
-	const buffer = cl.createBuffer(context, cl.MEM_WRITE_ONLY, 8, null);
+	const buffer = cl.createBuffer(context, cl.MEM_WRITE_ONLY, 8);
 	const format: cl.TClImageFormat = {
 		'channel_order': cl.RGBA,
 		'channel_data_type': cl.UNSIGNED_INT8,
@@ -105,7 +105,7 @@ describe('MemObj', () => {
 		});
 
 		it('returns cl.MEM_HOST_PTR', () => {
-			const buffer = cl.createBuffer(context, cl.MEM_ALLOC_HOST_PTR, 8, null);
+			const buffer = cl.createBuffer(context, cl.MEM_USE_HOST_PTR, 32, Buffer.alloc(32));
 			const ret = cl.getMemObjectInfo(buffer, cl.MEM_HOST_PTR);
 			U.assertType(ret, 'object');
 		});