allow users to easily verify the gemm/trmm GPU results with the netlib cblas through client (#274)

* (1)update readme: netlib is preferred.(2)now you can verify the correctness of gemm&trmm through client

* give more details of how to get CBLAS on windows

* find the netlib library dir & library in Cmake files

* forget to add this file

* disable the validation on windows currently: no easy solution of building/linking netlib CBLAS on windows

Author: tingxingdong

README.md

@@ -197,8 +197,12 @@ The simple example below shows how to use clBLAS to compute an OpenCL accelerate
 
 ### Test infrastructure
 *  Googletest v1.6
-*  ACML on windows/linux; Accelerate on Mac OSX
 *  Latest Boost
+*  CPU BLAS
+  - Netlib CBLAS (recommended)
+    Ubuntu: install by "apt-get install libblas-dev"
+    Windows: download & install lapack-3.6.0 which comes with CBLAS
+  - or ACML on windows/linux; Accelerate on Mac OSX 
 
 ### Performance infrastructure
 * Python

src/CMakeLists.txt

@@ -265,6 +265,14 @@ if( BUILD_TEST )
 	endif( )
 endif( )
 
+if( BUILD_CLIENT )
+    if( NETLIB_FOUND )
+    else( )
+        message( WARNING "Not find Netlib; BUILD_CLIENT needs the Netlib CBLAS library" )
+    endif()
+endif()
+
+
 # This will define OPENCL_FOUND
 find_package( OpenCL ${OPENCL_VERSION} )
 

src/FindNetlib.cmake

@@ -100,6 +100,25 @@ if( NOT contains_BLAS EQUAL -1 )
 	FIND_PACKAGE_HANDLE_STANDARD_ARGS( NETLIB DEFAULT_MSG Netlib_BLAS_LIBRARY )
 endif( )
 
+
+#look for netlib cblas header
+if( UNIX )
+    find_path(Netlib_INCLUDE_DIRS cblas.h
+	    HINTS
+		    /usr/include
+	)
+else()
+    find_path(Netlib_INCLUDE_DIRS cblas.h
+        HINTS
+            ${Netlib_ROOT}/CBLAS/include/
+    )
+endif()
+
+if( Netlib_INCLUDE_DIRS )
+else()
+    message(WARNING "Cannot find cblas.h")
+endif()
+
 if( NETLIB_FOUND )
 	list( APPEND Netlib_LIBRARIES ${Netlib_BLAS_LIBRARY} )
 else( )

src/client/CMakeLists.txt

@@ -1,12 +1,12 @@
 # ########################################################################
 # Copyright 2013 Advanced Micro Devices, Inc.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 # http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -48,10 +48,11 @@ include_directories(
     ${clBLAS_SOURCE_DIR}
     ${clBLAS_SOURCE_DIR}/include
     ${clBLAS_SOURCE_DIR}/tests/include
+    ${Netlib_INCLUDE_DIRS}
     .)
 
 add_executable(client ${CLIENT_SRC} ${CLIENT_HEADER})
-target_link_libraries(client ${Boost_LIBRARIES} ${OPENCL_LIBRARIES} clBLAS)
+target_link_libraries(client  ${Netlib_LIBRARIES} ${Boost_LIBRARIES} ${OPENCL_LIBRARIES} clBLAS)
 set_target_properties( client PROPERTIES
   RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/staging"
   OUTPUT_NAME clBLAS-client )

src/client/clfunc_common.hpp

@@ -27,6 +27,11 @@
 #include "test-limits.h"
 #include "dis_warning.h"
 
+#if defined ( _WIN32 ) || defined ( _WIN64 )
+#else
+#include "cblas.h"
+#endif
+
 #include "clBLAS.h"
 #if defined(__APPLE__) || defined(__MACOSX)
 #include <OpenCL/cl_ext.h>
@@ -77,6 +82,57 @@ randomScale()
     return t;
 }
 
+#if defined ( _WIN32 ) || defined ( _WIN64 )
+#else
+
+CBLAS_ORDER
+clblasToCblas_order(clblasOrder value)
+{
+    switch (value) {
+        case clblasRowMajor:           return CblasRowMajor;
+        case clblasColumnMajor:        return CblasColMajor;
+    }
+}
+
+CBLAS_TRANSPOSE
+clblasToCblas_operation(clblasTranspose value)
+{
+    switch (value) {
+        case clblasNoTrans:      return CblasNoTrans;
+        case clblasTrans:        return CblasTrans;
+        case clblasConjTrans:    return CblasConjTrans;
+    }
+}
+
+CBLAS_UPLO
+clblasToCblas_fill(clblasUplo value)
+{
+    switch (value) {
+        case clblasUpper:           return CblasUpper;
+        case clblasLower:           return CblasLower;
+    }
+}
+
+CBLAS_SIDE
+clblasToCblas_side(clblasSide value)
+{
+    switch (value) {
+        case clblasLeft:           return CblasLeft;
+        case clblasRight:          return CblasRight;
+    }
+}
+
+CBLAS_DIAG
+clblasToCblas_diag(clblasDiag value)
+{
+    switch (value) {
+        case clblasNonUnit:           return CblasNonUnit;
+        case clblasUnit:              return CblasUnit;
+    }
+}
+
+#endif
+
 std::string
 prettyPrintClStatus( const cl_int& status )
 {
@@ -269,7 +325,7 @@ class clblasFunc
     virtual ~clblasFunc()
     {
         clblasTeardown();
-        
+
         for (unsigned int i = 0; i < numQueues; i++) {
           OPENCL_V_THROW( clReleaseCommandQueue(queues_[i]), "releasing command queue" );
         }
@@ -278,36 +334,38 @@ class clblasFunc
 
     void wait_and_check()
     {
-		cl_int err;
+        cl_int err;
         cl_int wait_status = clWaitForEvents(1, &event_);
 
         if( wait_status != CL_SUCCESS )
         {
-    	    if( wait_status == CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST )
-    	    {
-    	    	clGetEventInfo( event_, CL_EVENT_COMMAND_EXECUTION_STATUS,
+            if( wait_status == CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST )
+            {
+                clGetEventInfo( event_, CL_EVENT_COMMAND_EXECUTION_STATUS,
                                 sizeof(cl_int), &err, NULL );
-    	    	std::cout << "blas function execution status error: " << err << std::endl;
+                std::cout << "blas function execution status error: " << err << std::endl;
                 exit(1);
-    	    }
+            }
             else
             {
-    	    	std::cout << "blas function wait status error: " << wait_status << std::endl;
+                std::cout << "blas function wait status error: " << wait_status << std::endl;
                 exit(1);
             }
         }
     }
 
     double time_in_ns()
     {
-	    StatisticalTimer& timer = StatisticalTimer::getInstance( );
+        StatisticalTimer& timer = StatisticalTimer::getInstance( );
         return timer.getAverageTime( timer_id ) * 1e9;
     }
 
+    virtual void validate_with_cblas(int v) {}
+
     virtual void call_func() = 0;
     virtual double gflops() = 0;
     virtual std::string gflops_formula() = 0;
-	virtual void setup_apiCallCount(cl_uint apiCallCount){}
+    virtual void setup_apiCallCount(cl_uint apiCallCount){}
     virtual void setup_buffer(int order_option, int side_option,
                               int uplo_option, int diag_option, int
                               transA_option, int transB_option,
@@ -317,20 +375,20 @@ class clblasFunc
     virtual void initialize_cpu_buffer() = 0;
     virtual void initialize_gpu_buffer() = 0;
     virtual void reset_gpu_write_buffer() = 0;
-	virtual void read_gpu_buffer() = 0;
-	virtual void roundtrip_func() = 0;
-	virtual void roundtrip_func_rect() {}
-	virtual void allochostptr_roundtrip_func() {}
-	virtual void usehostptr_roundtrip_func() {}
-	virtual void copyhostptr_roundtrip_func() {}
-	virtual void usepersismem_roundtrip_func() {}
-	virtual void roundtrip_setup_buffer(int order_option, int side_option,
+    virtual void read_gpu_buffer() = 0;
+    virtual void roundtrip_func() = 0;
+    virtual void roundtrip_func_rect() {}
+    virtual void allochostptr_roundtrip_func() {}
+    virtual void usehostptr_roundtrip_func() {}
+    virtual void copyhostptr_roundtrip_func() {}
+    virtual void usepersismem_roundtrip_func() {}
+    virtual void roundtrip_setup_buffer(int order_option, int side_option,
                               int uplo_option, int diag_option, int
                               transA_option, int transB_option,
                               size_t M, size_t N, size_t K, size_t lda,
                               size_t ldb, size_t ldc, size_t offA, size_t offBX,
                               size_t offCY, double alpha, double beta) = 0;
-	virtual void releaseGPUBuffer_deleteCPUBuffer()=0;
+    virtual void releaseGPUBuffer_deleteCPUBuffer()=0;
     StatisticalTimer& timer;
     StatisticalTimer::sTimerID timer_id;
 
@@ -347,7 +405,7 @@ class clblasFunc
     clblasOrder order_;
     cl_event event_;
     size_t maxMemAllocSize;
+    int validate_;
 }; // class clblasFunc
 
 #endif // ifndef CLBLAS_BENCHMARK_COMMON_HXX__
-