opencl/source/openclconfig.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <unicode/regex.h>
  11
  12 #include <comphelper/configuration.hxx>
  13 #include <officecfg/Office/Common.hxx>
  14 #include <opencl/openclconfig.hxx>
  15 #include <opencl/platforminfo.hxx>
  16 #include <rtl/ustring.hxx>
  17 #include <sal/log.hxx>
  18 #include <sal/types.h>
  19
  20 OpenCLConfig::OpenCLConfig() :
  21     mbUseOpenCL(true)
  22 {
  23     // This entry we have had for some time (when blacklisting was
  24     // done elsewhere in the code), so presumably there is a known
  25     // good reason for it.
  26     maBlackList.insert(ImplMatcher("Windows", "", "Intel\\(R\\) Corporation", "", "9\\.17\\.10\\.2884"));
  27
  28     // This is what I have tested on Linux and it works for our unit tests.
  29     maWhiteList.insert(ImplMatcher("Linux", "", "Advanced Micro Devices, Inc\\.", "", "1445\\.5 \\(sse2,avx\\)"));
  30
  31     // For now, assume that AMD, Intel and NVIDIA drivers are good
  32     maWhiteList.insert(ImplMatcher("", "", "Advanced Micro Devices, Inc\\.", "", ""));
  33     maWhiteList.insert(ImplMatcher("", "", "Intel\\(R\\) Corporation", "", ""));
  34     maWhiteList.insert(ImplMatcher("", "", "NVIDIA Corporation", "", ""));
  35 }
  36
  37 bool OpenCLConfig::operator== (const OpenCLConfig& r) const
  38 {
  39     return (mbUseOpenCL == r.mbUseOpenCL &&
  40             maBlackList == r.maBlackList &&
  41             maWhiteList == r.maWhiteList &&
  42             true);
  43 }
  44
  45 bool OpenCLConfig::operator!= (const OpenCLConfig& r) const
  46 {
  47     return !operator== (r);
  48 }
  49
  50 namespace {
  51
  52 css::uno::Sequence<OUString> SetOfImplMatcherToStringSequence(const OpenCLConfig::ImplMatcherSet& rSet)
  53 {
  54     css::uno::Sequence<OUString> result(rSet.size());
  55
  56     size_t n(0);
  57     for (auto i = rSet.cbegin(); i != rSet.cend(); ++i)
  58     {
  59         result[n++] =
  60             (*i).maOS.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  61             (*i).maOSVersion.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  62             (*i).maPlatformVendor.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  63             (*i).maDevice.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  64             (*i).maDriverVersion.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B");
  65     }
  66
  67     return result;
  68 }
  69
  70 OUString getToken(const OUString& string, sal_Int32& index)
  71 {
  72     OUString token(string.getToken(0, '/', index));
  73     OUString result;
  74     sal_Int32 i(0);
  75     sal_Int32 p;
  76     while ((p = token.indexOf('%', i)) >= 0)
  77     {
  78         if (p > i)
  79             result += token.copy(i, p - i);
  80         if (p < token.getLength() - 2)
  81         {
  82             result += OUString(static_cast<sal_Unicode>(token.copy(p+1, 2).toInt32(16)));
  83             i = p + 3;
  84         }
  85         else
  86         {
  87             i = token.getLength();
  88         }
  89     }
  90     result += token.copy(i);
  91
  92     return result;
  93 }
  94
  95 OpenCLConfig::ImplMatcherSet StringSequenceToSetOfImplMatcher(const css::uno::Sequence<OUString>& rSequence)
  96 {
  97     OpenCLConfig::ImplMatcherSet result;
  98
  99     for (auto i = rSequence.begin(); i != rSequence.end(); ++i)
 100     {
 101         OpenCLConfig::ImplMatcher m;
 102         sal_Int32 index(0);
 103         m.maOS = getToken(*i, index);
 104         m.maOSVersion = getToken(*i, index);
 105         m.maPlatformVendor = getToken(*i, index);
 106         m.maDevice = getToken(*i, index);
 107         m.maDriverVersion = getToken(*i, index);
 108
 109         result.insert(m);
 110     }
 111
 112     return result;
 113 }
 114
 115 bool match(const OUString& rPattern, const OUString& rInput)
 116 {
 117     if (rPattern.isEmpty())
 118         return true;
 119
 120     UErrorCode nIcuError(U_ZERO_ERROR);
 121     icu::UnicodeString sIcuPattern(reinterpret_cast<const UChar*>(rPattern.getStr()), rPattern.getLength());
 122     icu::UnicodeString sIcuInput(reinterpret_cast<const UChar*>(rInput.getStr()), rInput.getLength());
 123     RegexMatcher aMatcher(sIcuPattern, sIcuInput, 0, nIcuError);
 124
 125     if (U_SUCCESS(nIcuError) && aMatcher.matches(nIcuError) && U_SUCCESS(nIcuError))
 126         return true;
 127
 128     return false;
 129 }
 130
 131 bool match(const OpenCLConfig::ImplMatcher& rListEntry, const OpenCLPlatformInfo& rPlatform, const OpenCLDeviceInfo& rDevice)
 132 {
 133 #if defined(_WIN32)
 134     if (!rListEntry.maOS.isEmpty() && rListEntry.maOS != "Windows")
 135         return false;
 136 #elif defined LINUX
 137     if (!rListEntry.maOS.isEmpty() && rListEntry.maOS != "Linux")
 138         return false;
 139 #elif defined MACOSX
 140     if (!rListEntry.maOS.isEmpty() && rListEntry.maOS != "OS X")
 141         return false;
 142 #endif
 143
 144     // OS version check not yet implemented
 145
 146     if (!match(rListEntry.maPlatformVendor, rPlatform.maVendor))
 147         return false;
 148
 149     if (!match(rListEntry.maDevice, rDevice.maName))
 150         return false;
 151
 152     if (!match(rListEntry.maDriverVersion, rDevice.maDriver))
 153         return false;
 154
 155     return true;
 156 }
 157
 158 bool match(const OpenCLConfig::ImplMatcherSet& rList, const OpenCLPlatformInfo& rPlatform, const OpenCLDeviceInfo& rDevice, const char* sKindOfList)
 159 {
 160     for (auto i = rList.cbegin(); i != rList.end(); ++i)
 161     {
 162         SAL_INFO("opencl", "Looking for match for platform=" << rPlatform << ", device=" << rDevice <<
 163                  " in " << sKindOfList << " entry=" << *i);
 164
 165         if (match(*i, rPlatform, rDevice))
 166         {
 167             SAL_INFO("opencl", "Match!");
 168             return true;
 169         }
 170     }
 171     return false;
 172 }
 173
 174 } // anonymous namespace
 175
 176 OpenCLConfig OpenCLConfig::get()
 177 {
 178     OpenCLConfig result;
 179
 180     result.mbUseOpenCL = officecfg::Office::Common::Misc::UseOpenCL::get();
 181
 182     result.maBlackList = StringSequenceToSetOfImplMatcher(officecfg::Office::Common::Misc::OpenCLBlackList::get());
 183     result.maWhiteList = StringSequenceToSetOfImplMatcher(officecfg::Office::Common::Misc::OpenCLWhiteList::get());
 184
 185     return result;
 186 }
 187
 188 void OpenCLConfig::set()
 189 {
 190     std::shared_ptr<comphelper::ConfigurationChanges> batch(comphelper::ConfigurationChanges::create());
 191
 192     officecfg::Office::Common::Misc::UseOpenCL::set(mbUseOpenCL, batch);
 193     officecfg::Office::Common::Misc::OpenCLBlackList::set(SetOfImplMatcherToStringSequence(maBlackList), batch);
 194     officecfg::Office::Common::Misc::OpenCLWhiteList::set(SetOfImplMatcherToStringSequence(maWhiteList), batch);
 195
 196     batch->commit();
 197 }
 198
 199 bool OpenCLConfig::checkImplementation(const OpenCLPlatformInfo& rPlatform, const OpenCLDeviceInfo& rDevice) const
 200 {
 201     // Check blacklist of known bad OpenCL implementations
 202     if (match(maBlackList, rPlatform, rDevice, "blacklist"))
 203     {
 204         SAL_INFO("opencl", "Rejecting");
 205         return true;
 206     }
 207
 208     // Check for whitelist of known good OpenCL implementations
 209     if (match(maWhiteList, rPlatform, rDevice, "whitelist"))
 210     {
 211         SAL_INFO("opencl", "Approving");
 212         return false;
 213     }
 214
 215     // Fallback: reject
 216     SAL_INFO("opencl", "Fallback: rejecting platform=" << rPlatform << ", device=" << rDevice);
 217     return true;
 218 }
 219
 220 std::ostream& operator<<(std::ostream& rStream, const OpenCLConfig& rConfig)
 221 {
 222     rStream << "{"
 223         "UseOpenCL=" << (rConfig.mbUseOpenCL ? "YES" : "NO") << ","
 224         "BlackList=" << rConfig.maBlackList << ","
 225         "WhiteList=" << rConfig.maWhiteList <<
 226         "}";
 227     return rStream;
 228 }
 229
 230 std::ostream& operator<<(std::ostream& rStream, const OpenCLConfig::ImplMatcher& rImpl)
 231 {
 232     rStream << "{"
 233         "OS=" << rImpl.maOS << ","
 234         "OSVersion=" << rImpl.maOSVersion << ","
 235         "PlatformVendor=" << rImpl.maPlatformVendor << ","
 236         "Device=" << rImpl.maDevice << ","
 237         "DriverVersion=" << rImpl.maDriverVersion <<
 238         "}";
 239
 240     return rStream;
 241 }
 242
 243 std::ostream& operator<<(std::ostream& rStream, const OpenCLConfig::ImplMatcherSet& rSet)
 244 {
 245     rStream << "{";
 246     for (auto i = rSet.cbegin(); i != rSet.cend(); ++i)
 247     {
 248         if (i != rSet.cbegin())
 249             rStream << ",";
 250         rStream << *i;
 251     }
 252     rStream << "}";
 253     return rStream;
 254 }
 255
 256 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */