sc/source/core/tool/formulagroup.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 <config_feature_opencl.h>
  11
  12 #include <formulagroup.hxx>
  13 #include <formulagroupcl.hxx>
  14 #include <document.hxx>
  15 #include <formulacell.hxx>
  16 #include <interpre.hxx>
  17 #include <globalnames.hxx>
  18
  19 #include <officecfg/Office/Common.hxx>
  20 #if HAVE_FEATURE_OPENCL
  21 #include <opencl/platforminfo.hxx>
  22 #endif
  23 #include <sal/log.hxx>
  24
  25 #include <cstdio>
  26 #include <limits>
  27 #include <unordered_map>
  28 #include <vector>
  29
  30 #if HAVE_FEATURE_OPENCL
  31 #  include <opencl/openclwrapper.hxx>
  32 #endif
  33
  34 namespace sc {
  35
  36 FormulaGroupEntry::FormulaGroupEntry( ScFormulaCell** pCells, size_t nRow, size_t nLength ) :
  37     mpCells(pCells), mnRow(nRow), mnLength(nLength), mbShared(true) {}
  38
  39 FormulaGroupEntry::FormulaGroupEntry( ScFormulaCell* pCell, size_t nRow ) :
  40     mpCell(pCell), mnRow(nRow), mnLength(0), mbShared(false) {}
  41
  42 size_t FormulaGroupContext::ColKey::Hash::operator ()( const FormulaGroupContext::ColKey& rKey ) const
  43 {
  44     return rKey.mnTab * MAXCOLCOUNT_JUMBO + rKey.mnCol;
  45 }
  46
  47 FormulaGroupContext::ColKey::ColKey( SCTAB nTab, SCCOL nCol ) : mnTab(nTab), mnCol(nCol) {}
  48
  49 bool FormulaGroupContext::ColKey::operator== ( const ColKey& r ) const
  50 {
  51     return mnTab == r.mnTab && mnCol == r.mnCol;
  52 }
  53
  54 FormulaGroupContext::ColArray::ColArray( NumArrayType* pNumArray, StrArrayType* pStrArray ) :
  55     mpNumArray(pNumArray), mpStrArray(pStrArray), mnSize(0)
  56 {
  57     if (mpNumArray)
  58         mnSize = mpNumArray->size();
  59     else if (mpStrArray)
  60         mnSize = mpStrArray->size();
  61 }
  62
  63 FormulaGroupContext::ColArray* FormulaGroupContext::getCachedColArray( SCTAB nTab, SCCOL nCol, size_t nSize )
  64 {
  65     ColArraysType::iterator itColArray = maColArrays.find(ColKey(nTab, nCol));
  66     if (itColArray == maColArrays.end())
  67         // Not cached for this column.
  68         return nullptr;
  69
  70     ColArray& rCached = itColArray->second;
  71     if (nSize > rCached.mnSize)
  72         // Cached data array is not long enough for the requested range.
  73         return nullptr;
  74
  75     return &rCached;
  76 }
  77
  78 FormulaGroupContext::ColArray* FormulaGroupContext::setCachedColArray(
  79     SCTAB nTab, SCCOL nCol, NumArrayType* pNumArray, StrArrayType* pStrArray )
  80 {
  81     ColArraysType::iterator it = maColArrays.find(ColKey(nTab, nCol));
  82     if (it == maColArrays.end())
  83     {
  84         std::pair<ColArraysType::iterator,bool> r =
  85             maColArrays.emplace(ColKey(nTab, nCol), ColArray(pNumArray, pStrArray));
  86
  87         if (!r.second)
  88             // Somehow the insertion failed.
  89             return nullptr;
  90
  91         return &r.first->second;
  92     }
  93
  94     // Prior array exists for this column. Overwrite it.
  95     ColArray& rArray = it->second;
  96     rArray = ColArray(pNumArray, pStrArray);
  97     return &rArray;
  98 }
  99
 100 void FormulaGroupContext::discardCachedColArray( SCTAB nTab, SCCOL nCol )
 101 {
 102     ColArraysType::iterator itColArray = maColArrays.find(ColKey(nTab, nCol));
 103     if (itColArray != maColArrays.end())
 104         maColArrays.erase(itColArray);
 105 }
 106
 107 void FormulaGroupContext::ensureStrArray( ColArray& rColArray, size_t nArrayLen )
 108 {
 109     if (rColArray.mpStrArray)
 110         return;
 111
 112     m_StrArrays.push_back(
 113         std::make_unique<sc::FormulaGroupContext::StrArrayType>(nArrayLen, nullptr));
 114     rColArray.mpStrArray = m_StrArrays.back().get();
 115 }
 116
 117 void FormulaGroupContext::ensureNumArray( ColArray& rColArray, size_t nArrayLen )
 118 {
 119     if (rColArray.mpNumArray)
 120         return;
 121
 122     m_NumArrays.push_back(
 123         std::make_unique<sc::FormulaGroupContext::NumArrayType>(nArrayLen,
 124             std::numeric_limits<double>::quiet_NaN()));
 125     rColArray.mpNumArray = m_NumArrays.back().get();
 126 }
 127
 128 FormulaGroupContext::FormulaGroupContext()
 129 {
 130 }
 131
 132 FormulaGroupContext::~FormulaGroupContext()
 133 {
 134 }
 135
 136 CompiledFormula::CompiledFormula() {}
 137
 138 CompiledFormula::~CompiledFormula() {}
 139
 140 FormulaGroupInterpreter *FormulaGroupInterpreter::msInstance = nullptr;
 141
 142 void FormulaGroupInterpreter::MergeCalcConfig(const ScDocument& rDoc)
 143 {
 144     maCalcConfig = ScInterpreter::GetGlobalConfig();
 145     maCalcConfig.MergeDocumentSpecific(rDoc.GetCalcConfig());
 146 }
 147
 148 /// load and/or configure the correct formula group interpreter
 149 FormulaGroupInterpreter *FormulaGroupInterpreter::getStatic()
 150 {
 151     if ( !msInstance )
 152     {
 153 #if HAVE_FEATURE_OPENCL
 154         if (ScCalcConfig::isOpenCLEnabled())
 155         {
 156             const ScCalcConfig& rConfig = ScInterpreter::GetGlobalConfig();
 157             if( !switchOpenCLDevice(rConfig.maOpenCLDevice, rConfig.mbOpenCLAutoSelect))
 158             {
 159                 if( ScCalcConfig::getForceCalculationType() == ForceCalculationOpenCL )
 160                 {
 161                     SAL_WARN( "opencl", "OpenCL forced but failed to initialize" );
 162                     abort();
 163                 }
 164             }
 165         }
 166 #endif
 167     }
 168
 169     return msInstance;
 170 }
 171
 172 #if HAVE_FEATURE_OPENCL
 173 void FormulaGroupInterpreter::fillOpenCLInfo(std::vector<OpenCLPlatformInfo>& rPlatforms)
 174 {
 175     const std::vector<OpenCLPlatformInfo>& rPlatformsFromWrapper =
 176         openclwrapper::fillOpenCLInfo();
 177
 178     rPlatforms.assign(rPlatformsFromWrapper.begin(), rPlatformsFromWrapper.end());
 179 }
 180
 181 bool FormulaGroupInterpreter::switchOpenCLDevice(std::u16string_view rDeviceId, bool bAutoSelect, bool bForceEvaluation)
 182 {
 183     bool bOpenCLEnabled = ScCalcConfig::isOpenCLEnabled();
 184     if (!bOpenCLEnabled || (rDeviceId == u"" OPENCL_SOFTWARE_DEVICE_CONFIG_NAME))
 185     {
 186         delete msInstance;
 187         msInstance = nullptr;
 188         return false;
 189     }
 190
 191     OUString aSelectedCLDeviceVersionID;
 192     bool bSuccess = openclwrapper::switchOpenCLDevice(rDeviceId, bAutoSelect, bForceEvaluation, aSelectedCLDeviceVersionID);
 193
 194     if (!bSuccess)
 195         return false;
 196
 197     delete msInstance;
 198     msInstance = new sc::opencl::FormulaGroupInterpreterOpenCL();
 199
 200     return true;
 201 }
 202
 203 void FormulaGroupInterpreter::getOpenCLDeviceInfo(sal_Int32& rDeviceId, sal_Int32& rPlatformId)
 204 {
 205     rDeviceId = -1;
 206     rPlatformId = -1;
 207     bool bOpenCLEnabled = ScCalcConfig::isOpenCLEnabled();
 208     if(!bOpenCLEnabled)
 209         return;
 210
 211     size_t aDeviceId = static_cast<size_t>(-1);
 212     size_t aPlatformId = static_cast<size_t>(-1);
 213
 214     openclwrapper::getOpenCLDeviceInfo(aDeviceId, aPlatformId);
 215     rDeviceId = aDeviceId;
 216     rPlatformId = aPlatformId;
 217 }
 218
 219 void FormulaGroupInterpreter::enableOpenCL_UnitTestsOnly()
 220 {
 221     std::shared_ptr<comphelper::ConfigurationChanges> batch(comphelper::ConfigurationChanges::create());
 222     officecfg::Office::Common::Misc::UseOpenCL::set(true, batch);
 223     batch->commit();
 224
 225     ScCalcConfig aConfig = ScInterpreter::GetGlobalConfig();
 226
 227     aConfig.mbOpenCLSubsetOnly = false;
 228     aConfig.mnOpenCLMinimumFormulaGroupSize = 2;
 229
 230     ScInterpreter::SetGlobalConfig(aConfig);
 231 }
 232
 233 void FormulaGroupInterpreter::disableOpenCL_UnitTestsOnly()
 234 {
 235     std::shared_ptr<comphelper::ConfigurationChanges> batch(comphelper::ConfigurationChanges::create());
 236     officecfg::Office::Common::Misc::UseOpenCL::set(false, batch);
 237     batch->commit();
 238 }
 239
 240 #endif
 241
 242 } // namespace sc
 243
 244 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */