Hello World example

Author: mkhaled87

.DS_Store

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020  | Parallall
+
+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 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 NON-INFRINGEMENT. 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.

0_HelloWorld/.DS_Store

@@ -0,0 +1,33 @@
+SUBDIRS = kernel-driver
+
+.PHONY: all clean
+
+all: check-pfaces-sdk
+	for dir in $(SUBDIRS); do $(MAKE) all -C $$dir $@; done
+
+clean:
+	rm -f ./kernel-pack/*.log
+	rm -f ./kernel-pack/*.render
+	rm -f ./kernel-pack/*.driver
+	rm -f ./kernel-pack/*.dll
+	rm -f ./kernel-pack/*.so
+	rm -f ./kernel-pack/*.exp
+	rm -f ./kernel-pack/*.ilk
+	rm -f ./kernel-pack/*.lib
+	rm -f ./kernel-pack/*.pdb
+	rm -f ./kernel-pack/*.ipdb
+	rm -f ./kernel-pack/*.iobj
+	rm -rf x64
+	rm -rf Release
+	rm -rf Debug
+	find . -name "*.raw" -type f -delete
+	find . -name "*.asv" -type f -delete
+	find . -name "*.exe" -type f -delete
+	find . -name "*.prism" -type f -delete
+	for dir in $(SUBDIRS); do $(MAKE) clean -C $$dir $@; done
+
+
+check-pfaces-sdk:
+ifeq ($(PFACES_SDK_ROOT),)
+	$(error PFACES_SDK_ROOT was not found. Please assign PFACES_SDK_ROOT to the root directory of pFaces SDK)
+endif

0_HelloWorld/LICENSE

@@ -0,0 +1 @@
+# pFaces-Example: Hello World

0_HelloWorld/Makefile

@@ -0,0 +1,8 @@
+#-----------------------------------------------------------------------
+# File: example.cfg
+# Date: 01.04.2020
+# Athr: M. Khaled
+# Desc: This file gives one confiigurartion file for the kernel.
+#-----------------------------------------------------------------------
+
+config_message = "Hello from a cfg file !";

0_HelloWorld/README.md

@@ -0,0 +1,48 @@
+#
+# Compiler
+#
+CC        		= g++
+CXXFLAGS 		= -Wall -Wextra -std=c++11 -O3 -DNDEBUG -Wno-deprecated -Wno-ignored-attributes
+
+
+#
+# pfaces-sdk
+# 
+PFACES_SDK_INC = -I$(PFACES_SDK_ROOT)/include
+EXTRA_LNK=-L/usr/local/opt/openssl/lib -lcpprest -lssl -lcrypto -lboost_system -ldl -lpthread
+
+OS := $(shell uname)
+ifeq ($(OS),Darwin)
+PFACES_SDK_LNK = -L$(PFACES_SDK_ROOT)/lib -Wl,-all_load -lpfaces-sdk -Wl,-noall_load -framework OpenCL -L/usr/local/opt/openssl/lib -lcpprest -lssl -lcrypto -lboost_system -ldl -lpthread
+EXTRA_LNK += -lboost_thread-mt -lboost_chrono-mt
+CXXFLAGS += -Wno-ignored-attributes
+else
+PFACES_SDK_LNK = -L$(PFACES_SDK_ROOT)/lib -Wl,--whole-archive -lpfaces-sdk -Wl,--no-whole-archive
+EXTRA_LNK += -lstdc++fs
+endif
+
+#
+# example code
+#
+KERNEL_NAME = example
+KERNEL_SRC  = $(KERNEL_NAME).cpp
+
+
+.PHONY: kernel
+
+TARGET = kernel
+
+all: $(TARGET)
+
+kernel: 	
+	$(CC) -c -o $(KERNEL_NAME).o -fPIC $(CXXFLAGS) $(PFACES_SDK_INC) $(KERNEL_SRC)
+	$(CC) -shared -o kernel.so $(PFACES_SDK_LNK) $(EXTRA_LNK) *.o
+	mv kernel.so ../kernel-pack/$(KERNEL_NAME).driver
+
+clean:
+	rm -f -r Debug
+	rm -f -r Release
+	rm -f -r x64
+	rm -f -r .vs
+	rm -f *.o
+	rm -f *.so

0_HelloWorld/example.cfg

@@ -0,0 +1,105 @@
+#include "example.h"
+
+namespace pFacesExamples{
+
+	/* some constants */
+	const std::string kernel_source = "example";
+	const std::string mem_cfg_file = "example.mem";
+	const size_t thread_grid_x = 1;
+	const size_t thread_grid_y = 1;
+
+	/* the driver constructor */
+	pFacesExample::pFacesExample(
+		const std::shared_ptr<pfacesKernelLaunchState>& spLaunchState, 
+		const std::shared_ptr<pfacesConfigurationReader>& spCfg) :
+		  pfaces2DKernel(
+			  spLaunchState->getDefaultSourceFilePath(
+				  kernel_source, 
+				  spLaunchState->kernelScope, 
+				  spLaunchState->kernelPackPath), 
+				  thread_grid_x,
+				  thread_grid_y, 
+				  spCfg), m_spCfg(spCfg){
+
+
+		// Create a kernel function and load its memory fingerprints
+		std::string memFile = spLaunchState->kernelPackPath + mem_cfg_file;
+		std::string funcName = "exampleKernelFunction";
+		std::vector<std::string> argNames = {"data_in"};
+		auto funcArgs = pfacesKernelFunctionArguments::loadFromFile(
+			memFile,		/* memory config file with the function memory fingerprint */
+			funcName,  		/* name of the function to add */
+			argNames		/* list of the names of its args */
+		);
+		pfacesKernelFunction theFunction(funcName, funcArgs);
+		addKernelFunction(theFunction);	  
+
+		// update params in the kernel source
+		updatePrameters({"@@param_message@@"}, {"\"Hello from the driver !\""});
+	}
+
+	/* provide an implementation of the virtual method: configureParallelProgram*/
+	void pFacesExample::configureParallelProgram(pfacesParallelProgram& parallelProgram){
+		
+		/* check this is one device */
+		bool multiple_devices = parallelProgram.countTargetDevices() > 1;
+		if(multiple_devices)
+			throw std::runtime_error("This example is supposed to work only within one device.");
+
+		auto thisMachine = parallelProgram.getMachine();
+		auto thisDevice = parallelProgram.getTargetDevices()[0];
+
+		/* the range/offset of this kernel : we just need one thread */
+		const cl::NDRange ndKernelRange(1,1);
+		const cl::NDRange ndKernelOffset(0,0);
+
+		/* allocate memory */
+		std::vector<std::pair<char*, size_t>> dataPool;
+		pFacesMemoryAllocationReport memReport;
+		memReport = allocateMemory(dataPool, thisMachine, parallelProgram.getTargetDevicesIndicies(), 1, false);
+		memReport.PrintReport();
+
+
+		/* the parallel program needs a alist of instructionss */
+		std::vector<std::shared_ptr<pfacesInstruction>> instrList;	
+
+		/* an instruction to show a simple message from the CPU side */
+		std::shared_ptr<pfacesInstruction> instrMsg_start = std::make_shared<pfacesInstruction>();
+		instrMsg_start->setAsMessage("Hello World from host side !");
+
+		/* an instruction to lauch parallel threadss in the device */
+		std::shared_ptr<pfacesDeviceExecuteTask> singleTask = std::make_shared<pfacesDeviceExecuteTask>(ndKernelOffset, ndKernelRange, ndKernelRange);
+		std::shared_ptr<pfacesDeviceExecuteJob> exampleFunctionJob = std::make_shared<pfacesDeviceExecuteJob>(thisDevice);
+		exampleFunctionJob->addTask(singleTask);
+		exampleFunctionJob->setKernelFunctionIdx(
+			0,  /* index of the kernel function we're to write data to */
+			1  /* how many arguments it has */
+		);		
+		std::shared_ptr<pfacesInstruction> devFunctionInstruction = std::make_shared<pfacesInstruction>();
+		devFunctionInstruction->setAsDeviceExecute(exampleFunctionJob);		
+
+		/* a synchronization instruction */
+		std::shared_ptr<pfacesInstruction> instrSyncPoint = std::make_shared<pfacesInstruction>();
+		instrSyncPoint->setAsBlockingSyncPoint();
+
+		/* build the parallel program */
+		instrList.push_back(instrMsg_start);
+		instrList.push_back(devFunctionInstruction);
+		instrList.push_back(instrSyncPoint);
+
+		/* complete the required settings in the parallel program */
+		parallelProgram.m_Universal_globalNDRange = ndKernelRange;
+		parallelProgram.m_Universal_offsetNDRange = ndKernelOffset;
+		parallelProgram.m_dataPool = dataPool;
+		parallelProgram.m_spInstructionList = instrList;
+	}
+
+	/* provide an implementation of the virtual method: configureTuneParallelProgram*/
+	void pFacesExample::configureTuneParallelProgram(pfacesParallelProgram& tuneParallelProgram, size_t targetFunctionIdx) {
+		(void)tuneParallelProgram;
+		(void)targetFunctionIdx;
+	}
+}
+
+/* register the kernel */
+PFACES_REGISTER_LOADABLE_KERNEL(pFacesExamples::pFacesExample)

0_HelloWorld/kernel-driver/.DS_Store

@@ -0,0 +1,38 @@
+/*
+ * example.h
+ *
+ *  Created on: 01.04.2020
+ *      Author: M. Khaled
+ */
+
+#ifndef PFACES_KERNEL_EXAMPLE_H_
+#define PFACES_KERNEL_EXAMPLE_H_
+
+#include <pfaces-sdk.h>
+
+namespace pFacesExamples{
+
+	// class: pFacesExample
+	class pFacesExample : public pfaces2DKernel {
+	private:
+		const std::shared_ptr<pfacesConfigurationReader> m_spCfg;
+	
+	public:
+		pFacesExample(
+			const std::shared_ptr<pfacesKernelLaunchState>& spLaunchState, 
+			const std::shared_ptr<pfacesConfigurationReader>& spCfg);
+			
+		~pFacesExample() = default;
+
+		void configureParallelProgram(
+			pfacesParallelProgram& parallelProgram);
+
+		void configureTuneParallelProgram(
+			pfacesParallelProgram& tuneParallelProgram, 
+			size_t targetFunctionIdx);
+
+	};
+
+}
+
+#endif /* PFACES_KERNEL_EXAMPLE_H_ */

0_HelloWorld/kernel-driver/Makefile

@@ -0,0 +1,9 @@
+#-----------------------------------------------------------------------
+# File: example.mem
+# Date: 01.04.2020
+# Athr: M. Khaled
+# Desc: This file describes the defaults of any config file that
+# will be loaded later to the kernel.
+#-----------------------------------------------------------------------
+
+config_message = "no message";

0_HelloWorld/kernel-driver/example.cpp

@@ -0,0 +1,9 @@
+#-----------------------------------------------------------------------
+# File: example.mem
+# Date: 01.04.2020
+# Athr: M. Khaled
+# Desc: This file describes the template of any later config file to be loaded to the kernel.
+#-----------------------------------------------------------------------
+
+config_message = string
+

0_HelloWorld/kernel-driver/example.h

@@ -0,0 +1,16 @@
+/*
+* example.cl
+*
+*  date    : 01.04.2020
+*  author  : M. Khaled
+*/
+
+#define CFG_MSG @pfaces-configValueString:"config_message"
+#define PARAM_MSG @@param_message@@
+
+
+kernel void exampleKernelFunction(global char* data_in){
+    printf("Hello World from the device side!\n");
+    printf("The value of the config item (config_message) is: %s\n", CFG_MSG);
+    printf("The value of the kernel param (param_message) is: %s\n", PARAM_MSG);
+}

0_HelloWorld/kernel-pack/.DS_Store

@@ -0,0 +1,10 @@
+/*
+* example.cpu.cl
+*
+*  date    : 01.04.2020
+*  author  : M. Khaled
+*/
+
+#define CPU_VERSION
+@pfaces-include:"example.cl"
+

0_HelloWorld/kernel-pack/config.defaults

@@ -0,0 +1,10 @@
+/*
+* example.gpu.cl
+*
+*  date    : 01.04.2020
+*  author  : M. Khaled
+*/
+
+#define GPU_VERSION
+@pfaces-include:"example.cl"
+

0_HelloWorld/kernel-pack/config.template

@@ -0,0 +1,10 @@
+/*
+* example.hwa.cl
+*
+*  date    : 01.04.2020
+*  author  : M. Khaled
+*/
+
+#define HWA_VERSION
+@pfaces-include:"example.cl"
+

0_HelloWorld/kernel-pack/example.cl

@@ -0,0 +1,16 @@
+#-----------------------------------------------------------------------
+# File: example.mem
+# Date: 01.04.2020
+# Athr: M. Khaled
+# Desc: This file describes the memory buffers needed by the kernel.
+#-----------------------------------------------------------------------
+
+# function 0: exampleKernelFunction
+exampleKernelFunction{ 
+
+	# argument 0.0: data_in
+	data_in{
+        MemConfig               = "pfaces_rw_global";
+		isNewOrResident			= "true"; 
+	}
+}