TAPsOpenCL.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsOpenCL.hpp
******************************************************************************/
/******************************************************************************
SUKITTI PUNAK   (03/23/2011)
UPDATE          (07/07/2011)
******************************************************************************/
#ifndef TAPs_OPENCL_HPP
#define TAPs_OPENCL_HPP

#include "../Core/TAPsStdLib.hpp"
#include "CL/opencl.h"


BEGIN_NAMESPACE_TAPs__OpenCL

//=============================================================================
 //=============================================================================
class OpenCL_Util {
public:

    static std::string StrOpenCLErrorCode ( cl_int errCode );

    static bool CheckOpenCLErrorCode ( cl_int errCode )
    #ifdef  _DEBUG
    {
        if ( errCode == CL_SUCCESS )    return true;
        std::cerr << StrOpenCLErrorCode( errCode ) << std::endl;
        exit( errCode );
        return false;
    }
    #else //_DEBUG
    {
        return true;
    }
    #endif//_DEBUG

    static std::string StrOpenCLDeviceTypeCode ( cl_device_type deviceType );

//=============================================================================
};  // END CLASS OpenCL_Util
//=============================================================================




//=============================================================================
class OpenCL_Device {
//=============================================================================
public:
    // Member Functions -------------------------------------------------------
    friend std::ostream & operator<< ( std::ostream &output, OpenCL_Device const &obj )
    {
        output << obj.StrInfo();
        return output;
    }

    OpenCL_Device ( cl_device_id deviceID );

    virtual ~OpenCL_Device ();

    virtual std::string StrInfo () const;

    cl_platform_id  PlatformID () const { return m_PlatformID; }
    cl_device_id    DeviceID () const   { return m_DeviceID; }

    std::string DeviceName () const { return m_DeviceName; }
    std::string DeviceVendor () const   { return m_DeviceVendor; }
    std::string DeviceVersion () const  { return m_DeviceVersion; }

    cl_device_type  DeviceType () const { return m_DeviceType; }
    cl_uint DeviceMaxComputeUnits () const  { return m_DeviceMaxComputeUnits; }
    cl_uint DeviceMaxWorkItemDimensions () const    { return m_DeviceMaxWorkItemDimensions; }
    std::vector< size_t >   DeviceMaxWorkItemSizes () const { return m_DeviceMaxWorkItemSizes; }
    size_t DeviceMaxWorkItemSizeInDemension ( unsigned int d ) const    { return m_DeviceMaxWorkItemSizes[d]; }
    size_t DeviceMaxWorkGroupSize () const  { return m_DeviceMaxWorkGroupSize; }

    //---------------------------------------------------------------
    // Get functions for the OpenCL device info that is not stored in this object

    //
    // Image
    
    cl_bool DeviceImageSupport () const;
    cl_uint DeviceMaxReadImageArguments () const;
    cl_uint DeviceMaxWriteImageArguments () const;
    size_t DeviceImage2DMaxWidth () const;
    size_t DeviceImage2DMaxHeight () const;
    size_t DeviceImage3DMaxWidth () const;
    size_t DeviceImage3DMaxHeight () const;
    size_t DeviceImage3DMaxDepth () const;
    cl_uint DeviceMaxSamplers () const;

    //
    // Mem

    cl_uint DeviceAddressBits () const;
    cl_uint DeviceMaxClockFrequency () const;
    cl_ulong DeviceGlobalMemSize () const;
    cl_ulong DeviceLocalMemSize () const;
    cl_ulong DeviceMaxMemAllocSize () const;
    cl_uint DeviceMemBaseAddrAlign () const;
    cl_uint DeviceMinDataAlignSize () const;
    cl_device_fp_config DeviceSingleFPConfig () const;
    std::string StrOfDeviceSingleFPConfig () const;
    cl_device_mem_cache_type DeviceGlobalMemCacheType () const;
    std::string OpenCL_Device::StrOfDeviceGlobalMemCacheType () const;
    cl_ulong DeviceGlobalMemCacheSize () const;
    cl_uint DeviceGlobalMemCachelineSize () const;
    cl_device_local_mem_type DeviceLocalMemType () const;
    std::string StrOfDeviceLocalMemType () const;
    cl_bool DeviceErrCorrectionSupport () const;
    cl_bool DeviceHostUnifiedMem () const;

    //
    // Limitation

    size_t DeviceMaxParameterSize () const;
    cl_ulong DeviceMaxConstBufferSize () const;
    cl_uint DeviceMaxConstArgs () const;
    cl_bool DeviceAvailable () const;
    cl_bool DeviceEndainLittle () const;
    size_t DeviceProfilingTimerResolution () const;
    cl_bool DeviceCompilerAvailable () const;
    cl_device_exec_capabilities DeviceExecCapabilities () const;
    std::string StrOfDeviceExecCapabilities () const;
    cl_command_queue_properties DeviceQueueProperties () const;
    std::string StrOfDeviceQueueProperties () const;
    std::string DeviceExtensions () const;


    //
    // Misc

    cl_uint DeviceVendorID () const;
    std::vector< cl_uint >  DevicePreferredVectorWidthSizes () const;
    std::vector< cl_uint >  DeviceNativeVectorWidthSizes () const;
    std::string StrOfOpenCLDevicePreferredVectorWidthSizes () const;
    std::string StrOfOpenCLDeviceNativeVectorWidthSizes () const;

    // Data Members -----------------------------------------------------------
//=============================================================================
protected:
    // Member Functions -------------------------------------------------------
    void GetOpenCLDeviceInfo ();

    // Data Members -----------------------------------------------------------
    cl_platform_id  m_PlatformID;   
    cl_device_id    m_DeviceID;     

    std::string     m_DeviceName;       
    std::string     m_DeviceVendor;     
    cl_device_type  m_DeviceType;                   
    std::string     m_DeviceProfile;            
    std::string     m_DeviceVersion;    
    std::string     m_DeviceOpenCL_C_Version;   

    cl_uint         m_DeviceMaxComputeUnits;        
    cl_uint         m_DeviceMaxWorkItemDimensions;  
    std::vector< size_t >   m_DeviceMaxWorkItemSizes;   
    size_t          m_DeviceMaxWorkGroupSize;       


//=============================================================================
private:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================


//=============================================================================
// OpenGL
#if defined(__gl_h_) || defined(__GL_H__)
//-----------------------------------------------------------------------------
public:
    //virtual void Draw () const;
//-----------------------------------------------------------------------------
#endif  // OpenGL
//=============================================================================


//=============================================================================
}; // END CLASS OpenCL_Device
//=============================================================================




//=============================================================================
class OpenCL_Platform {
//=============================================================================
public:
    // Member Functions -------------------------------------------------------
    friend std::ostream & operator<< ( std::ostream &output, OpenCL_Platform const &obj )
    {
        output << obj.StrInfo();
        return output;
    }

    OpenCL_Platform ( cl_platform_id id );

    virtual ~OpenCL_Platform ();

    virtual std::string StrInfo () const;

    cl_platform_id  PlatformID () const { return m_PlatformID; }

    std::string PlatformName () const       { return m_PlatformName; }
    std::string PlatformVersion () const    { return m_PlatformVersion; }
    std::string PlatformProfile () const    { return m_PlatformProfile; }
    std::string PlatformVendor () const     { return m_PlatformVendor; }
    std::string PlatformExtensions () const;

    cl_uint NumOfOpenCLDevices () const { return m_OpenCLDeviceIDs.size(); }
    cl_device_id OpenCLDeviceID ( cl_uint i ) const { return m_OpenCLDeviceIDs[i]; }
    OpenCL_Device const &   OpenCLDevice ( cl_uint i ) const    { return m_OpenCLDevices[i]; }
    OpenCL_Device & OpenCLDevice ( cl_uint i )          { return m_OpenCLDevices[i]; }


    // Data Members -----------------------------------------------------------
//=============================================================================
protected:
    // Member Functions -------------------------------------------------------
    void GetOpenCLPlatformInfo ();

    void GetListOfOpenCLDevices ();

    // Data Members -----------------------------------------------------------
    cl_platform_id  m_PlatformID;       

    std::string m_PlatformName;         
    std::string m_PlatformVersion;      
    std::string m_PlatformProfile;      
    std::string m_PlatformVendor;       

    std::vector< cl_device_id > m_OpenCLDeviceIDs;  

    std::vector< OpenCL_Device > m_OpenCLDevices;   
//=============================================================================
private:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================


//=============================================================================
// OpenGL
#if defined(__gl_h_) || defined(__GL_H__)
//-----------------------------------------------------------------------------
public:
    //virtual void Draw () const;
//-----------------------------------------------------------------------------
#endif  // OpenGL
//=============================================================================


//=============================================================================
}; // END CLASS OpenCL_Platform
//=============================================================================




//=============================================================================
END_NAMESPACE_TAPs__OpenCL
//-----------------------------------------------------------------------------
//#include "TAPsOpenCL.cpp"

// Include definition if TAPs_USE_EXPORT is not defined
#if !defined( TAPs_USE_EXPORT )
    #include "TAPsOpenCL.cpp"
#endif
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----