# webcl-validator

**Repository Path**: mirrors_KhronosGroup/webcl-validator

## Basic Information

- **Project Name**: webcl-validator
- **Description**: WebCL Validator
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

webcl-validator
===============

This document describes how to build and use WebCL Validator. Some example WebCL programs before and after protection are found here: http://wolfviking0.github.io/webcl-translator/ another test suite for testing plain OpenCL kernels with different vendor drivers is found from http://elhigu.github.io/opencl-testsuite/

Building
--------

Currently WebCL Validator is implemented as a Clang tool. Therefore
you need to fetch source code for LLVM and Clang and build WebCL
Validator along with them.

Checkout the required repositories into following locations:

        LLVM:            /path/llvm
        Clang:           /path/llvm/tools/clang
        WebCL Validator: /path/llvm/tools/clang/tools/webcl-validator

This can be done as follows:

        # Get LLVM 3.4 source

        cd /path/
        git clone --single-branch http://llvm.org/git/llvm.git -b release_34
        cd /path/llvm/

        # Get Clang 3.4
        
        cd /path/llvm/tools
        git clone --single-branch http://llvm.org/git/clang.git -b release_34
        

        # Get WebCL Validator source and add it to CMakeLists.txt for compiling

        cd /path/llvm/tools/clang/tools
        git clone https://github.com/KhronosGroup/webcl-validator.git
        echo "add_subdirectory(webcl-validator)" >> CMakeLists.txt

Depending on your OS/configuration, you may need to install some additional tools:

        sudo yum install git-svn
        sudo yum install cmake28
        alias cmake=cmake28

You can now create a build directory and build all three components:

        mkdir /path/build
        cd /path/build
        # cmake uses git-svn if you used git instead of svn
        # For smaller executable, use -DCMAKE_BUILD_TYPE=MinSizeRel
        cmake -DCMAKE_BUILD_TYPE=Debug /path/llvm
        make -j4 # webcl-validator
        # run regression tests
        make -j4 check-webcl-validator

To get more verbose output:

        make VERBOSE=1 -j4 check-webcl-validator


To select which OpenCL library should be used one can give `OpenCL_INCPATH` and `OpenCL_LIBPATH` variables when runnign cmake e.g.

    OpenCL_INCPATH=/usr/local/include OpenCL_LIBPATH=/usr/local/opt/pocl/lib cmake /path/llvm 

Running
-------

You can find the WebCL Validator and example WebCL kernels from:

        /path/build/bin
        /path/llvm/tools/clang/tools/webcl-validator/test
        
Run the following command to let WebCL Validator transform your WebCL
kernels:

        webcl-validator kernel.cl [CLANG OPTIONS]

For example, use -D to inform WebCL Validator about used
extensions. Passing -Dcl_khr_initialize memory tells that local memory
initialization shouldn't be done, because the driver should initialize
local memory with cl_khr_initialize_memory extension. See DESIGN.txt
for more details:

        webcl-validator kernel.cl -Dcl_khr_initialize_memory

The validator adds some Clang options automatically. Option *-x cl*
forces sources to be interpreted as OpenCL code even if they wouldn't
use the *.cl* suffix. Option *-include FILE* automatically includes
helper code, such as OpenCL type and builtin definitions.

To disable certain extensions from the default set of supported
extensions you may use the --disable=xx switch:

        webcl-validator kernel.cl --disable=cl_khr_fp16

Building with Windows / Visual Studio
-----------------------------

Get Visual Studio 2013 (I used Express for Windows Desktop version)

Get GIT and install it to default path (http://git-scm.com/downloads) (this will provide required tools like bash, grep, sed etc. for running test suite)

Get Python 2.7 (http://www.python.org/download/)

Get CMake 2.8 (http://www.cmake.org/cmake/resources/software.html)

Get Intel OpenCL SDK (http://software.intel.com/en-us/vcsource/tools/opencl-sdk)

NOTE: Nvidia SDK headers didn't work for building all the test runners / clv.h API.

To build 64bit version do:

    cmake -G "Visual Studio 12 Win64" ../llvm-3.4

If you have multiple OpenCL SDKs installed you can select which includes / libraries you like to use with `OpenCL_INCPATH=<path to CL/cl.h>` and `OpenCL_LIBPATH=<directory where opencl.lib is found>` e.g.

    OpenCL_INCPATH="C:\intelsdk\include" OpenCL_LIBPATH="C:\intelsdk\lib\x64" cmake -G "Visual Studio 12 Win64" ../llvm-3.4

Open the generated llvm.sln file. Build by building the "ALL_BUILD" project, don't use Build Solution / F7.

Run tests by building "check-webcl-validator" project, found under "WebCL Validator Tests" in the Solution Explorer.

Building with Windows MinGW + MSYS (not tested recently since we changed to Visual Studio express)
----------------------------------

Get CMake for Windows

Get MinGW64 4.6.3 and MSYS rev 12 from (NOTE: MinGW 4.8.1 failed compiling LLVM)

* http://sourceforge.net/projects/mingwbuilds/files/host-windows/
* http://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/

Extract mingw to C:\MinGW64 and MSYS to C:\MinGW64\msys 

Add C:\MinGW64\bin to PATH.

Open MSYS shell and according to normal build instructions except tell cmake to generate MSYS make files

        cmake -G "MSYS Makefiles" /path/llvm

CMake might fail to some error, if so run it again. Usually it works second time and build files will be generated. Compilation requires ~4GB RAM.

If you want to build also OpenCL programs and possibly run the tests, set

        export CPLUS_INCLUDE_PATH=/C/path/to/opencl/include
        export LIBRARY_PATH=/C/path/to/opencl/lib


Building with Xcode
--------------------

1. Generate xcode project:
        
        cmake -G Xcode /path/llvm


2. Open and build in Xcode or from commandline

        xcodebuild -configuration MinSizeRel -target check-webcl-validator