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 <sal/config.h>
  11
  12 #include <string_view>
  13
  14 #include <unicode/regex.h>
  15
  16 #include <comphelper/configuration.hxx>
  17 #include <officecfg/Office/Common.hxx>
  18 #include <opencl/openclconfig.hxx>
  19 #include <opencl/platforminfo.hxx>
  20 #include <rtl/ustring.hxx>
  21 #include <rtl/ustrbuf.hxx>
  22 #include <sal/log.hxx>
  23 #include <sal/types.h>
  24
  25 OpenCLConfig::OpenCLConfig() :
  26     mbUseOpenCL(true)
  27 {
  28     // This entry we have had for some time (when denylisting was
  29     // done elsewhere in the code), so presumably there is a known
  30     // good reason for it.
  31     maDenyList.insert(ImplMatcher("Windows", "", "Intel\\(R\\) Corporation", "", "9\\.17\\.10\\.2884"));
  32     // This was reported to produce bogus values in unit tests
  33     maDenyList.insert(ImplMatcher("Windows", "", "Intel\\(R\\) Corporation", "", "27\\.20\\.100\\.8681"));
  34
  35     // For now, assume that AMD, Intel and NVIDIA drivers are good
  36     maAllowList.insert(ImplMatcher("", "", "Advanced Micro Devices, Inc\\.", "", ""));
  37     maAllowList.insert(ImplMatcher("", "", "Intel\\(R\\) Corporation", "", ""));
  38     maAllowList.insert(ImplMatcher("", "", "NVIDIA Corporation", "", ""));
  39 }
  40
  41 bool OpenCLConfig::operator== (const OpenCLConfig& r) const
  42 {
  43     return (mbUseOpenCL == r.mbUseOpenCL &&
  44             maDenyList == r.maDenyList &&
  45             maAllowList == r.maAllowList);
  46 }
  47
  48 bool OpenCLConfig::operator!= (const OpenCLConfig& r) const
  49 {
  50     return !operator== (r);
  51 }
  52
  53 namespace {
  54
  55 css::uno::Sequence<OUString> SetOfImplMatcherToStringSequence(const OpenCLConfig::ImplMatcherSet& rSet)
  56 {
  57     css::uno::Sequence<OUString> result(rSet.size());
  58     auto resultRange = asNonConstRange(result);
  59     size_t n(0);
  60     for (const auto& rItem : rSet)
  61     {
  62         resultRange[n++] =
  63             rItem.maOS.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  64             rItem.maOSVersion.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  65             rItem.maPlatformVendor.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  66             rItem.maDevice.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B") + "/" +
  67             rItem.maDriverVersion.replaceAll("%", "%25").replaceAll("/", "%2F").replaceAll(";", "%3B");
  68     }
  69
  70     return result;
  71 }
  72
  73 OUString getToken(const OUString& string, sal_Int32& index)
  74 {
  75     OUString token(string.getToken(0, '/', index));
  76     OUStringBuffer result;
  77     sal_Int32 i(0);
  78     sal_Int32 p;
  79     while ((p = token.indexOf('%', i)) >= 0)
  80     {
  81         if (p > i)
  82             result.append(token.subView(i, p - i));
  83         if (p < token.getLength() - 2)
  84         {
  85             result.append(sal_Unicode(token.copy(p+1, 2).toInt32(16)));
  86             i = p + 3;
  87         }
  88         else
  89         {
  90             i = token.getLength();
  91         }
  92     }
  93     result.append(token.subView(i));
  94
  95     return result.makeStringAndClear();
  96 }
  97
  98 OpenCLConfig::ImplMatcherSet StringSequenceToSetOfImplMatcher(const css::uno::Sequence<OUString>& rSequence)
  99 {
 100     OpenCLConfig::ImplMatcherSet result;
 101
 102     for (const auto& rItem : rSequence)
 103     {
 104         OpenCLConfig::ImplMatcher m;
 105         sal_Int32 index(0);
 106         m.maOS = getToken(rItem, index);
 107         m.maOSVersion = getToken(rItem, index);
 108         m.maPlatformVendor = getToken(rItem, index);
 109         m.maDevice = getToken(rItem, index);
 110         m.maDriverVersion = getToken(rItem, index);
 111
 112         result.insert(m);
 113     }
 114
 115     return result;
 116 }
 117
 118 bool match(const OUString& rPattern, const OUString& rInput)
 119 {
 120     if (rPattern.isEmpty())
 121         return true;
 122
 123     UErrorCode nIcuError(U_ZERO_ERROR);
 124     icu::UnicodeString sIcuPattern(reinterpret_cast<const UChar*>(rPattern.getStr()), rPattern.getLength());
 125     icu::UnicodeString sIcuInput(reinterpret_cast<const UChar*>(rInput.getStr()), rInput.getLength());
 126     icu::RegexMatcher aMatcher(sIcuPattern, sIcuInput, 0, nIcuError);
 127
 128     return U_SUCCESS(nIcuError) && aMatcher.matches(nIcuError) && U_SUCCESS(nIcuError);
 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 (const auto& rListEntry : rList)
 161     {
 162         SAL_INFO("opencl", "Looking for match for platform=" << rPlatform << ", device=" << rDevice <<
 163                  " in " << sKindOfList << " entry=" << rListEntry);
 164
 165         if (match(rListEntry, 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.maDenyList = StringSequenceToSetOfImplMatcher(officecfg::Office::Common::Misc::OpenCLDenyList::get());
 183     result.maAllowList = StringSequenceToSetOfImplMatcher(officecfg::Office::Common::Misc::OpenCLAllowList::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::OpenCLDenyList::set(SetOfImplMatcherToStringSequence(maDenyList), batch);
 194     officecfg::Office::Common::Misc::OpenCLAllowList::set(SetOfImplMatcherToStringSequence(maAllowList), batch);
 195
 196     batch->commit();
 197 }
 198
 199 bool OpenCLConfig::checkImplementation(const OpenCLPlatformInfo& rPlatform, const OpenCLDeviceInfo& rDevice) const
 200 {
 201     // Check denylist of known bad OpenCL implementations
 202     if (match(maDenyList, rPlatform, rDevice, "denylist"))
 203     {
 204         SAL_INFO("opencl", "Rejecting");
 205         return true;
 206     }
 207
 208     // Check for allowlist of known good OpenCL implementations
 209     if (match(maAllowList, rPlatform, rDevice, "allowlist"))
 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         "DenyList=" << rConfig.maDenyList << ","
 225         "AllowList=" << rConfig.maAllowList <<
 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: */