28#if defined(UNICODE) && !defined(_UNICODE)
35QLatin1String QgsOpenClUtils::SETTINGS_GLOBAL_ENABLED_KEY = QLatin1String(
"OpenClEnabled" );
36QLatin1String QgsOpenClUtils::SETTINGS_DEFAULT_DEVICE_KEY = QLatin1String(
"OpenClDefaultDevice" );
38bool QgsOpenClUtils::sAvailable =
false;
45 std::vector<cl::Platform> platforms;
46 cl::Platform::get( &platforms );
47 std::vector<cl::Device> existingDevices;
48 for (
const auto &p : platforms )
50 const std::string platver = p.getInfo<CL_PLATFORM_VERSION>();
52 .arg( QString::fromStdString( platver ),
53 QString::fromStdString( p.getInfo<CL_PLATFORM_NAME>() ) ),
55 if ( platver.find(
"OpenCL " ) != std::string::npos )
57 std::vector<cl::Device> _devices;
61 p.getDevices( CL_DEVICE_TYPE_ALL, &_devices );
63 catch ( cl::Error &e )
66 .arg( errorText( e.err() ),
67 QString::fromStdString( e.what() ),
68 QString::fromStdString( p.getInfo<CL_PLATFORM_NAME>() ) ),
71 if ( _devices.size() > 0 )
73 for (
unsigned long i = 0; i < _devices.size(); i++ )
76 .arg( deviceId( _devices[i] ) ),
78 existingDevices.push_back( _devices[i] );
83 return existingDevices;
86void QgsOpenClUtils::init()
88 static std::once_flag initialized;
89 std::call_once( initialized, [ = ]( )
92 QLibrary openCLLib { QStringLiteral(
"/System/Library/Frameworks/OpenCL.framework/Versions/Current/OpenCL" ) };
94 QLibrary openCLLib { QStringLiteral(
"OpenCL" ) };
96 openCLLib.setLoadHints( QLibrary::LoadHint::ResolveAllSymbolsHint );
97 if ( ! openCLLib.load() )
100 .arg( openCLLib.errorString() ),
111 HMODULE hModule = GetModuleHandle( _T(
"OpenCL.dll" ) );
114 TCHAR pszFileName[1024];
115 if ( GetModuleFileName( hModule, pszFileName, 1024 ) < 1024 )
122 DWORD dwLen = GetFileVersionInfoSize( pszFileName, &dwUseless );
125 LPTSTR lpVI = ( LPTSTR ) malloc( dwLen *
sizeof( TCHAR ) );
128 if ( GetFileVersionInfo( pszFileName, 0, dwLen, lpVI ) )
130 VS_FIXEDFILEINFO *lpFFI;
131 if ( VerQueryValue( lpVI, _T(
"\\" ), ( LPVOID * ) &lpFFI, ( UINT * ) &dwUseless ) )
134 .arg( lpFFI->dwProductVersionMS >> 16 )
135 .arg( lpFFI->dwProductVersionMS & 0xffff )
136 .arg( lpFFI->dwProductVersionLS >> 16 )
137 .arg( lpFFI->dwProductVersionLS & 0xffff ),
141 struct LANGANDCODEPAGE
149 if ( VerQueryValue( lpVI, _T(
"\\VarFileInfo\\Translation" ), ( LPVOID * ) &lpTranslate, ( UINT * ) &cbTranslate ) && cbTranslate >=
sizeof(
struct LANGANDCODEPAGE ) )
151 QStringList items = QStringList()
152 << QStringLiteral(
"Comments" )
153 << QStringLiteral(
"InternalName" )
154 << QStringLiteral(
"ProductName" )
155 << QStringLiteral(
"CompanyName" )
156 << QStringLiteral(
"LegalCopyright" )
157 << QStringLiteral(
"ProductVersion" )
158 << QStringLiteral(
"FileDescription" )
159 << QStringLiteral(
"LegalTrademarks" )
160 << QStringLiteral(
"PrivateBuild" )
161 << QStringLiteral(
"FileVersion" )
162 << QStringLiteral(
"OriginalFilename" )
163 << QStringLiteral(
"SpecialBuild" );
164 for (
auto d : items )
167 QString subBlock = QString( QStringLiteral(
"\\StringFileInfo\\%1%2\\%3" ) )
168 .arg( lpTranslate[0].wLanguage, 4, 16, QLatin1Char(
'0' ) )
169 .arg( lpTranslate[0].wCodePage, 4, 16, QLatin1Char(
'0' ) )
172 QgsDebugMsgLevel( QString(
"d:%1 subBlock:%2" ).arg( d ).arg( subBlock ), 2 );
174 BOOL r = VerQueryValue( lpVI,
176 subBlock.toStdWString().c_str(),
180 ( LPVOID * )&lpBuffer, ( UINT * )&dwUseless );
182 if ( r && lpBuffer && lpBuffer != INVALID_HANDLE_VALUE && dwUseless < 1023 )
187 .arg( QString::fromUtf16( (
const ushort * ) lpBuffer ) ),
189 .arg( QString::fromLocal8Bit( lpBuffer ) ),
216 catch ( cl::Error &e )
219 .arg(
errorText( e.err() ), QString::fromStdString( e.what() ) ),
228 return *sSourcePath();
233 *sSourcePath() = value;
248 return QString::fromStdString( device.getInfo<CL_DEVICE_VENDOR>() );
250 return QString::fromStdString( device.getInfo<CL_DEVICE_PROFILE>() );
252 return QString::fromStdString( device.getInfo<CL_DEVICE_VERSION>() );
254 return device.getInfo<CL_DEVICE_IMAGE_SUPPORT>() ? QStringLiteral(
"True" ) : QStringLiteral(
"False" );
256 return QString::number( device.getInfo<CL_DEVICE_IMAGE2D_MAX_HEIGHT>() );
258 return QString::number( device.getInfo<CL_DEVICE_MAX_MEM_ALLOC_SIZE>() );
260 return QString::number( device.getInfo<CL_DEVICE_IMAGE2D_MAX_WIDTH>() );
263 const unsigned long type( device.getInfo<CL_DEVICE_TYPE>() );
267 case CL_DEVICE_TYPE_CPU:
270 case CL_DEVICE_TYPE_GPU:
276 const QMetaEnum metaEnum = QMetaEnum::fromType<QgsOpenClUtils::HardwareType>();
277 return metaEnum.valueToKey( mappedType );
280 return QString::fromStdString( device.getInfo<CL_DEVICE_NAME>() );
283 catch ( cl::Error &e )
286 QgsDebugMsgLevel( QStringLiteral(
"Error %1 getting info for OpenCL device: %2" )
287 .arg(
errorText( e.err() ), QString::fromStdString( e.what() ) ),
302 return cl::Device::getDefault();
308 if ( cl::Platform::getDefault()() )
310 const std::string platver = cl::Platform::getDefault().getInfo<CL_PLATFORM_VERSION>();
311 if ( platver.find(
"OpenCL " ) != std::string::npos )
313 version = QString::fromStdString( platver.substr( 7 ) ).split(
' ' ).first();
331 return QStringLiteral(
"%1|%2|%3|%4" )
338bool QgsOpenClUtils::activate(
const QString &preferredDeviceId )
347 std::vector<cl::Platform> platforms;
348 cl::Platform::get( &platforms );
351 bool deviceFound =
false;
352 for (
const auto &p : platforms )
356 const std::string platver = p.getInfo<CL_PLATFORM_VERSION>();
357 QgsDebugMsgLevel( QStringLiteral(
"Found OpenCL platform %1: %2" ).arg( QString::fromStdString( platver ), QString::fromStdString( p.getInfo<CL_PLATFORM_NAME>() ) ), 2 );
358 if ( platver.find(
"OpenCL " ) != std::string::npos )
360 std::vector<cl::Device>
devices;
364 p.getDevices( CL_DEVICE_TYPE_ALL, &
devices );
366 if ( ! preferredDeviceId.isEmpty() )
368 for (
const auto &_dev :
devices )
370 if ( preferredDeviceId ==
deviceId( _dev ) )
383 for (
const auto &_dev :
devices )
385 if ( _dev.getInfo<CL_DEVICE_TYPE>() == CL_DEVICE_TYPE_GPU )
398 for (
const auto &_dev :
devices )
400 if ( _dev.getInfo<CL_DEVICE_TYPE>() == CL_DEVICE_TYPE_CPU )
415 catch ( cl::Error &e )
417 QgsDebugError( QStringLiteral(
"Error %1 on platform %3 searching for OpenCL device: %2" )
419 QString::fromStdString( e.what() ),
420 QString::fromStdString( p.getInfo<CL_PLATFORM_NAME>() ) ) );
432 const cl::Platform newP = cl::Platform::setDefault( plat );
441 cl::Device::setDefault( dev );
443 .arg( QString::fromStdString( dev.getInfo<CL_DEVICE_NAME>() ) ),
450 catch ( cl::Error &e )
453 .arg(
errorText( e.err() ), QString::fromStdString( e.what() ) ),
462 return QStringLiteral(
463 "Type: <b>%9</b><br>"
464 "Name: <b>%1</b><br>"
465 "Vendor: <b>%2</b><br>"
466 "Profile: <b>%3</b><br>"
467 "Version: <b>%4</b><br>"
468 "Image support: <b>%5</b><br>"
469 "Max image2d width: <b>%6</b><br>"
470 "Max image2d height: <b>%7</b><br>"
471 "Max mem alloc size: <b>%8</b><br>"
485 for (
const auto &dev :
devices( ) )
512 if ( file.open( QFile::ReadOnly | QFile::Text ) )
514 QTextStream in( &file );
515 source_str = in.readAll();
527 const QString path = QStringLiteral(
"%1/%2.cl" ).arg(
sourcePath(), baseName );
533 cl::BuildLogType build_logs = error.getBuildLog();
535 if ( build_logs.size() > 0 )
536 build_log = QString::fromStdString( build_logs[0].second );
544 case 0:
return QStringLiteral(
"CL_SUCCESS" );
545 case -1:
return QStringLiteral(
"CL_DEVICE_NOT_FOUND" );
546 case -2:
return QStringLiteral(
"CL_DEVICE_NOT_AVAILABLE" );
547 case -3:
return QStringLiteral(
"CL_COMPILER_NOT_AVAILABLE" );
548 case -4:
return QStringLiteral(
"CL_MEM_OBJECT_ALLOCATION_FAILURE" );
549 case -5:
return QStringLiteral(
"CL_OUT_OF_RESOURCES" );
550 case -6:
return QStringLiteral(
"CL_OUT_OF_HOST_MEMORY" );
551 case -7:
return QStringLiteral(
"CL_PROFILING_INFO_NOT_AVAILABLE" );
552 case -8:
return QStringLiteral(
"CL_MEM_COPY_OVERLAP" );
553 case -9:
return QStringLiteral(
"CL_IMAGE_FORMAT_MISMATCH" );
554 case -10:
return QStringLiteral(
"CL_IMAGE_FORMAT_NOT_SUPPORTED" );
555 case -12:
return QStringLiteral(
"CL_MAP_FAILURE" );
556 case -13:
return QStringLiteral(
"CL_MISALIGNED_SUB_BUFFER_OFFSET" );
557 case -14:
return QStringLiteral(
"CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST" );
558 case -15:
return QStringLiteral(
"CL_COMPILE_PROGRAM_FAILURE" );
559 case -16:
return QStringLiteral(
"CL_LINKER_NOT_AVAILABLE" );
560 case -17:
return QStringLiteral(
"CL_LINK_PROGRAM_FAILURE" );
561 case -18:
return QStringLiteral(
"CL_DEVICE_PARTITION_FAILED" );
562 case -19:
return QStringLiteral(
"CL_KERNEL_ARG_INFO_NOT_AVAILABLE" );
563 case -30:
return QStringLiteral(
"CL_INVALID_VALUE" );
564 case -31:
return QStringLiteral(
"CL_INVALID_DEVICE_TYPE" );
565 case -32:
return QStringLiteral(
"CL_INVALID_PLATFORM" );
566 case -33:
return QStringLiteral(
"CL_INVALID_DEVICE" );
567 case -34:
return QStringLiteral(
"CL_INVALID_CONTEXT" );
568 case -35:
return QStringLiteral(
"CL_INVALID_QUEUE_PROPERTIES" );
569 case -36:
return QStringLiteral(
"CL_INVALID_COMMAND_QUEUE" );
570 case -37:
return QStringLiteral(
"CL_INVALID_HOST_PTR" );
571 case -38:
return QStringLiteral(
"CL_INVALID_MEM_OBJECT" );
572 case -39:
return QStringLiteral(
"CL_INVALID_IMAGE_FORMAT_DESCRIPTOR" );
573 case -40:
return QStringLiteral(
"CL_INVALID_IMAGE_SIZE" );
574 case -41:
return QStringLiteral(
"CL_INVALID_SAMPLER" );
575 case -42:
return QStringLiteral(
"CL_INVALID_BINARY" );
576 case -43:
return QStringLiteral(
"CL_INVALID_BUILD_OPTIONS" );
577 case -44:
return QStringLiteral(
"CL_INVALID_PROGRAM" );
578 case -45:
return QStringLiteral(
"CL_INVALID_PROGRAM_EXECUTABLE" );
579 case -46:
return QStringLiteral(
"CL_INVALID_KERNEL_NAME" );
580 case -47:
return QStringLiteral(
"CL_INVALID_KERNEL_DEFINITION" );
581 case -48:
return QStringLiteral(
"CL_INVALID_KERNEL" );
582 case -49:
return QStringLiteral(
"CL_INVALID_ARG_INDEX" );
583 case -50:
return QStringLiteral(
"CL_INVALID_ARG_VALUE" );
584 case -51:
return QStringLiteral(
"CL_INVALID_ARG_SIZE" );
585 case -52:
return QStringLiteral(
"CL_INVALID_KERNEL_ARGS" );
586 case -53:
return QStringLiteral(
"CL_INVALID_WORK_DIMENSION" );
587 case -54:
return QStringLiteral(
"CL_INVALID_WORK_GROUP_SIZE" );
588 case -55:
return QStringLiteral(
"CL_INVALID_WORK_ITEM_SIZE" );
589 case -56:
return QStringLiteral(
"CL_INVALID_GLOBAL_OFFSET" );
590 case -57:
return QStringLiteral(
"CL_INVALID_EVENT_WAIT_LIST" );
591 case -58:
return QStringLiteral(
"CL_INVALID_EVENT" );
592 case -59:
return QStringLiteral(
"CL_INVALID_OPERATION" );
593 case -60:
return QStringLiteral(
"CL_INVALID_GL_OBJECT" );
594 case -61:
return QStringLiteral(
"CL_INVALID_BUFFER_SIZE" );
595 case -62:
return QStringLiteral(
"CL_INVALID_MIP_LEVEL" );
596 case -63:
return QStringLiteral(
"CL_INVALID_GLOBAL_WORK_SIZE" );
597 case -64:
return QStringLiteral(
"CL_INVALID_PROPERTY" );
598 case -65:
return QStringLiteral(
"CL_INVALID_IMAGE_DESCRIPTOR" );
599 case -66:
return QStringLiteral(
"CL_INVALID_COMPILER_OPTIONS" );
600 case -67:
return QStringLiteral(
"CL_INVALID_LINKER_OPTIONS" );
601 case -68:
return QStringLiteral(
"CL_INVALID_DEVICE_PARTITION_COUNT" );
602 case -69:
return QStringLiteral(
"CL_INVALID_PIPE_SIZE" );
603 case -70:
return QStringLiteral(
"CL_INVALID_DEVICE_QUEUE" );
604 case -71:
return QStringLiteral(
"CL_INVALID_SPEC_ID" );
605 case -72:
return QStringLiteral(
"CL_MAX_SIZE_RESTRICTION_EXCEEDED" );
606 case -1002:
return QStringLiteral(
"CL_INVALID_D3D10_DEVICE_KHR" );
607 case -1003:
return QStringLiteral(
"CL_INVALID_D3D10_RESOURCE_KHR" );
608 case -1004:
return QStringLiteral(
"CL_D3D10_RESOURCE_ALREADY_ACQUIRED_KHR" );
609 case -1005:
return QStringLiteral(
"CL_D3D10_RESOURCE_NOT_ACQUIRED_KHR" );
610 case -1006:
return QStringLiteral(
"CL_INVALID_D3D11_DEVICE_KHR" );
611 case -1007:
return QStringLiteral(
"CL_INVALID_D3D11_RESOURCE_KHR" );
612 case -1008:
return QStringLiteral(
"CL_D3D11_RESOURCE_ALREADY_ACQUIRED_KHR" );
613 case -1009:
return QStringLiteral(
"CL_D3D11_RESOURCE_NOT_ACQUIRED_KHR" );
614 case -1010:
return QStringLiteral(
"CL_INVALID_DX9_MEDIA_ADAPTER_KHR" );
615 case -1011:
return QStringLiteral(
"CL_INVALID_DX9_MEDIA_SURFACE_KHR" );
616 case -1012:
return QStringLiteral(
"CL_DX9_MEDIA_SURFACE_ALREADY_ACQUIRED_KHR" );
617 case -1013:
return QStringLiteral(
"CL_DX9_MEDIA_SURFACE_NOT_ACQUIRED_KHR" );
618 case -1093:
return QStringLiteral(
"CL_INVALID_EGL_OBJECT_KHR" );
619 case -1092:
return QStringLiteral(
"CL_EGL_RESOURCE_NOT_ACQUIRED_KHR" );
620 case -1001:
return QStringLiteral(
"CL_PLATFORM_NOT_FOUND_KHR" );
621 case -1057:
return QStringLiteral(
"CL_DEVICE_PARTITION_FAILED_EXT" );
622 case -1058:
return QStringLiteral(
"CL_INVALID_PARTITION_COUNT_EXT" );
623 case -1059:
return QStringLiteral(
"CL_INVALID_PARTITION_NAME_EXT" );
624 case -1094:
return QStringLiteral(
"CL_INVALID_ACCELERATOR_INTEL" );
625 case -1095:
return QStringLiteral(
"CL_INVALID_ACCELERATOR_TYPE_INTEL" );
626 case -1096:
return QStringLiteral(
"CL_INVALID_ACCELERATOR_DESCRIPTOR_INTEL" );
627 case -1097:
return QStringLiteral(
"CL_ACCELERATOR_TYPE_NOT_SUPPORTED_INTEL" );
628 case -1000:
return QStringLiteral(
"CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR" );
629 case -1098:
return QStringLiteral(
"CL_INVALID_VA_API_MEDIA_ADAPTER_INTEL" );
630 case -1099:
return QStringLiteral(
"CL_INVALID_VA_API_MEDIA_SURFACE_INTEL" );
631 case -1100:
return QStringLiteral(
"CL_VA_API_MEDIA_SURFACE_ALREADY_ACQUIRED_INTEL" );
632 case -1101:
return QStringLiteral(
"CL_VA_API_MEDIA_SURFACE_NOT_ACQUIRED_INTEL" );
633 default:
return QStringLiteral(
"CL_UNKNOWN_ERROR" );
645 return cl::CommandQueue(
context );
650 const cl_command_queue_properties properties = 0;
652 cl_command_queue queue = clCreateCommandQueue(
context(), device(), properties,
nullptr );
654 return cl::CommandQueue( queue,
true );
661 static std::once_flag contextCreated;
662 std::call_once( contextCreated, [ = ]()
664 if (
available() && cl::Platform::getDefault()() && cl::Device::getDefault()() )
666 context = cl::Context( cl::Device::getDefault() );
688 if ( ok && version < 2.0f )
690 program.build( QStringLiteral(
"-cl-std=CL%1 -I\"%2\"" )
696 program.build( QStringLiteral(
"-I\"%1\"" )
700 catch ( cl::BuildError &e )
703 if ( build_log.isEmpty() )
704 build_log = QObject::tr(
"Build logs not available!" );
705 const QString err = QObject::tr(
"Error building OpenCL program: %1" )
708 if ( exceptionBehavior ==
Throw )
711 catch ( cl::Error &e )
713 const QString err = QObject::tr(
"Error %1 building OpenCL program in %2" )
714 .arg(
errorText( e.err() ), QString::fromStdString( e.what() ) );
@ Warning
Warning message.
@ Critical
Critical/error message.
@ Info
Information message.
@ Success
Used for reporting a successful operation.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
The QgsOpenClUtils class is responsible for common OpenCL operations such as.
static Q_DECL_DEPRECATED cl::Program buildProgram(const cl::Context &context, const QString &source, ExceptionBehavior exceptionBehavior=Catch)
Build the program from source in the given context and depending on exceptionBehavior can throw or ca...
static void setSourcePath(const QString &value)
Set the base path to OpenCL program directory.
static QString buildLog(cl::BuildError &error)
Extract and return the build log error from error.
static void storePreferredDevice(const QString deviceId)
Store in the settings the preferred deviceId device identifier.
static QString sourcePath()
Returns the base path to OpenCL program directory.
static cl::Context context()
Context factory.
static cl::Device activeDevice()
Returns the active device.
static bool enabled()
Returns true if OpenCL is enabled in the user settings.
static bool available()
Checks whether a suitable OpenCL platform and device is available on this system and initialize the Q...
static QString deviceDescription(const cl::Device device)
Returns a formatted description for the device.
static QString activeDeviceInfo(const Info infoType=Info::Name)
Returns infoType information about the active (default) device.
static const std::vector< cl::Device > devices()
Returns a list of OpenCL devices found on this sysytem.
static void setEnabled(bool enabled)
Set the OpenCL user setting to enabled.
static QString preferredDevice()
Read from the settings the preferred device identifier.
static QString deviceInfo(const Info infoType, cl::Device device)
Returns infoType information about the device.
static QString errorText(const int errorCode)
Returns a string representation from an OpenCL errorCode.
static cl::CommandQueue commandQueue()
Create an OpenCL command queue from the default context.
static QString sourceFromPath(const QString &path)
Read an OpenCL source file from path.
static QString sourceFromBaseName(const QString &baseName)
Returns the full path to a an OpenCL source file from the baseName ('.cl' extension is automatically ...
ExceptionBehavior
The ExceptionBehavior enum define how exceptions generated by OpenCL should be treated.
@ Throw
Write errors in the message log and re-throw exceptions.
static QString deviceId(const cl::Device device)
Create a string identifier from a device.
Info
The Info enum maps to OpenCL info constants.
static QLatin1String LOGMESSAGE_TAG
OpenCL string for message logs.
static QString activePlatformVersion()
Returns the active platform OpenCL version string (e.g.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
Q_GLOBAL_STATIC(QReadWriteLock, sDefinitionCacheLock)
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)