File indexing completed on 2024-05-19 04:26:39

 /*
  *  SPDX-FileCopyrightText: 2010 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #include "kis_updater_context.h"
 
 #include <QThread>
 #include <QThreadPool>
 
 #include "kis_update_job_item.h"
 #include "kis_stroke_job.h"
 
 const int KisUpdaterContext::useIdealThreadCountTag = -1;
 
 KisUpdaterContext::KisUpdaterContext(qint32 threadCount, KisUpdateScheduler *parent)
     : m_scheduler(parent)
 {
     if(threadCount <= 0) {
         threadCount = QThread::idealThreadCount();
         threadCount = threadCount > 0 ? threadCount : 1;
     }
 
     setThreadsLimit(threadCount);
 }
 
 KisUpdaterContext::~KisUpdaterContext()
 {
     m_threadPool.waitForDone();
 
     if (m_testingMode) {
         clear();
     }
 
     qDeleteAll(m_jobs);
 }
 
 void KisUpdaterContext::getJobsSnapshot(qint32 &numMergeJobs,
                                         qint32 &numStrokeJobs)
 {
     numMergeJobs = 0;
     numStrokeJobs = 0;
 
     /**
      * We cannot use Q_FOREACH here since the function may
      * be called concurrently without any locks, causing detaching
      * of the vector and causing a crash. Only read-only accesses
      * are allowed in such environment
      */
     for (const KisUpdateJobItem *item : std::as_const(m_jobs)) {
 
         if(item->type() == KisUpdateJobItem::Type::MERGE ||
            item->type() == KisUpdateJobItem::Type::SPONTANEOUS) {
             numMergeJobs++;
         }
         else if(item->type() == KisUpdateJobItem::Type::STROKE) {
             numStrokeJobs++;
         }
     }
 }
 
 KisUpdaterContextSnapshotEx KisUpdaterContext::getContextSnapshotEx() const
 {
     KisUpdaterContextSnapshotEx state = ContextEmpty;
 
     /**
      * We cannot use Q_FOREACH here since the function may
      * be called concurrently without any locks, causing detaching
      * of the vector and causing a crash. Only read-only accesses
      * are allowed in such environment
      */
     for (const KisUpdateJobItem *item : std::as_const(m_jobs)) {
         if (item->type() == KisUpdateJobItem::Type::MERGE ||
             item->type() == KisUpdateJobItem::Type::SPONTANEOUS) {
             state |= HasMergeJob;
         } else if(item->type() == KisUpdateJobItem::Type::STROKE) {
             switch (item->strokeJobSequentiality()) {
             case KisStrokeJobData::SEQUENTIAL:
                 state |= HasSequentialJob;
                 break;
             case KisStrokeJobData::CONCURRENT:
                 state |= HasConcurrentJob;
                 break;
             case KisStrokeJobData::BARRIER:
                 state |= HasBarrierJob;
                 break;
             case KisStrokeJobData::UNIQUELY_CONCURRENT:
                 state |= HasUniquelyConcurrentJob;
                 break;
             }
         }
     }
 
     return state;
 }
 
 int KisUpdaterContext::currentLevelOfDetail() const
 {
     return m_lodCounter.readLod();
 }
 
 bool KisUpdaterContext::hasSpareThread()
 {
     bool found = false;
 
     /**
      * We cannot use Q_FOREACH here since the function may
      * be called concurrently without any locks, causing detaching
      * of the vector and causing a crash. Only read-only accesses
      * are allowed in such environment
      */
     for (const KisUpdateJobItem *item : std::as_const(m_jobs)) {
         if(!item->isRunning()) {
             found = true;
             break;
         }
     }
     return found;
 }
 
 bool KisUpdaterContext::isJobAllowed(KisBaseRectsWalkerSP walker)
 {
     int lod = this->currentLevelOfDetail();
     if (lod >= 0 && walker->levelOfDetail() != lod) return false;
 
     bool intersects = false;
 
     /**
      * We cannot use Q_FOREACH here since the function may
      * be called concurrently without any locks, causing detaching
      * of the vector and causing a crash. Only read-only accesses
      * are allowed in such environment
      */
     for (const KisUpdateJobItem *item : std::as_const(m_jobs)) {
         if(item->isRunning() && walkerIntersectsJob(walker, item)) {
             intersects = true;
             break;
         }
     }
 
     return !intersects;
 }
 
 void KisUpdaterContext::startThread(int index)
 {
     {
         QMutexLocker l(&m_runningThreadsMutex);
         m_numRunningThreads++;
     }
 
     m_threadPool.start(m_jobs[index]);
 }
 
 /**
  * NOTE: In theory, isJobAllowed() and addMergeJob() should be merged into
  * one atomic method like `bool push()`, because this implementation
  * of KisUpdaterContext will not work in case of multiple
  * producers. But currently we have only one producer (one thread
  * in a time), that is guaranteed by the lock()/unlock() pair in
  * KisAbstractUpdateQueue::processQueue.
  */
 void KisUpdaterContext::addMergeJob(KisBaseRectsWalkerSP walker)
 {
     m_lodCounter.addLod(walker->levelOfDetail());
     qint32 jobIndex = findSpareThread();
     Q_ASSERT(jobIndex >= 0);
 
     const bool shouldStartThread = m_jobs[jobIndex]->setWalker(walker);
 
     // it might happen that we call this function from within
     // the thread itself, right when it finished its work
     if (shouldStartThread && !m_testingMode) {
         startThread(jobIndex);
     }
 }
 
 void KisUpdaterContext::addStrokeJob(KisStrokeJob *strokeJob)
 {
     m_lodCounter.addLod(strokeJob->levelOfDetail());
     qint32 jobIndex = findSpareThread();
     Q_ASSERT(jobIndex >= 0);
 
     const bool shouldStartThread = m_jobs[jobIndex]->setStrokeJob(strokeJob);
 
     // it might happen that we call this function from within
     // the thread itself, right when it finished its work
     if (shouldStartThread && !m_testingMode) {
         startThread(jobIndex);
     }
 }
 
 void KisUpdaterContext::addSpontaneousJob(KisSpontaneousJob *spontaneousJob)
 {
     m_lodCounter.addLod(spontaneousJob->levelOfDetail());
     qint32 jobIndex = findSpareThread();
     Q_ASSERT(jobIndex >= 0);
 
     const bool shouldStartThread = m_jobs[jobIndex]->setSpontaneousJob(spontaneousJob);
 
     // it might happen that we call this function from within
     // the thread itself, right when it finished its work
     if (shouldStartThread && !m_testingMode) {
         startThread(jobIndex);
     }
 }
 
 void KisUpdaterContext::waitForDone()
 {
     QMutexLocker l(&m_runningThreadsMutex);
 
     while(m_numRunningThreads > 0) {
         m_waitForDoneCondition.wait(l.mutex());
     }
 }
 
 bool KisUpdaterContext::walkerIntersectsJob(KisBaseRectsWalkerSP walker,
                                             const KisUpdateJobItem* job)
 {
     /**
      * TODO: theoretically, we should compare rects intersection
      * on a per-layer basis. The current solution is too rough and
      * basically makes updates single-threaded in some cases (e.g.
      * when a transform mask is present in the stack)
      */
     return walker->accessRect().intersects(job->accessRect());
 }
 
 qint32 KisUpdaterContext::findSpareThread()
 {
     for(qint32 i=0; i < m_jobs.size(); i++)
         if(!m_jobs[i]->isRunning())
             return i;
 
     return -1;
 }
 
 void KisUpdaterContext::lock()
 {
     m_lock.lock();
 }
 
 void KisUpdaterContext::unlock()
 {
     m_lock.unlock();
 }
 
 void KisUpdaterContext::setThreadsLimit(int value)
 {
     m_threadPool.setMaxThreadCount(value);
 
     for (int i = 0; i < m_jobs.size(); i++) {
         KIS_SAFE_ASSERT_RECOVER_RETURN(!m_jobs[i]->isRunning());
         // don't delete the jobs until all of them are checked!
     }
 
     for (int i = 0; i < m_jobs.size(); i++) {
         delete m_jobs[i];
     }
 
     m_jobs.resize(value);
 
     for(qint32 i = 0; i < m_jobs.size(); i++) {
         m_jobs[i] = new KisUpdateJobItem(this);
     }
 }
 
 int KisUpdaterContext::threadsLimit() const
 {
     KIS_SAFE_ASSERT_RECOVER_NOOP(m_jobs.size() == m_threadPool.maxThreadCount());
     return m_jobs.size();
 }
 
 void KisUpdaterContext::continueUpdate(const QRect& rc)
 {
     if (m_scheduler) m_scheduler->continueUpdate(rc);
 }
 
 void KisUpdaterContext::doSomeUsefulWork()
 {
     if (m_scheduler) m_scheduler->doSomeUsefulWork();
 }
 
 void KisUpdaterContext::jobFinished()
 {
     m_lodCounter.removeLod();
     if (m_scheduler) m_scheduler->spareThreadAppeared();
 }
 
 void KisUpdaterContext::jobThreadExited()
 {
     QMutexLocker l(&m_runningThreadsMutex);
     m_numRunningThreads--;
     KIS_SAFE_ASSERT_RECOVER_NOOP(m_numRunningThreads >= 0);
 
     if (m_numRunningThreads <= 0) {
         m_waitForDoneCondition.wakeAll();
     }
 }
 
 void KisUpdaterContext::setTestingMode(bool value)
 {
     m_testingMode = value;
 }
 
 const QVector<KisUpdateJobItem*> KisUpdaterContext::getJobs()
 {
     return m_jobs;
 }
 
 void KisUpdaterContext::clear()
 {
     Q_FOREACH (KisUpdateJobItem *item, m_jobs) {
         item->testingSetDone();
     }
 
     m_lodCounter.testingClear();
 }
 
 
 KisTestableUpdaterContext::KisTestableUpdaterContext(qint32 threadCount)
     : KisUpdaterContext(threadCount)
 {
     setTestingMode(true);
 }