KisTileDataStore Class Reference

#include <kis_tile_data_store.h>

Classes
struct	MemoryStatistics

Public Member Functions
KisTileDataStoreClockIterator *	beginClockIteration ()
KisTileDataStoreIterator *	beginIteration ()
KisTileDataStoreReverseIterator *	beginReverseIteration ()
void	checkFreeMemory ()
KisTileData *	createDefaultTileData (qint32 pixelSize, const quint8 *defPixel)
void	debugPrintList ()
KisTileData *	duplicateTileData (KisTileData *rhs)
void	endIteration (KisTileDataStoreClockIterator *iterator)
void	endIteration (KisTileDataStoreIterator *iterator)
void	endIteration (KisTileDataStoreReverseIterator *iterator)
void	ensureTileDataLoaded (KisTileData *td)
void	freeTileData (KisTileData *td)
void	kickPooler ()
	KisTileDataStore ()
qint64	memoryMetric () const
MemoryStatistics	memoryStatistics ()
qint32	numTiles () const
qint32	numTilesInMemory () const
void	registerTileData (KisTileData *td)
void	tryForceUpdateMemoryStatisticsWhileIdle ()
bool	trySwapTileData (KisTileData *td)
void	unregisterTileData (KisTileData *td)
	~KisTileDataStore ()

Static Public Member Functions
static KisTileDataStore *	instance ()

Private Member Functions
KisTileData *	allocTileData (qint32 pixelSize, const quint8 *defPixel)
void	debugClear ()
void	debugSwapAll ()
void	freeRegisteredTiles ()
void	registerTileDataImp (KisTileData *td)
void	testingRereadConfig ()
void	testingResumePooler ()
void	testingSuspendPooler ()
void	unregisterTileDataImp (KisTileData *td)

Private Attributes
QAtomicInt	m_clockIndex
QAtomicInt	m_counter
QReadWriteLock	m_iteratorLock
QAtomicInt	m_memoryMetric
QAtomicInt	m_numTiles
KisTileDataPooler	m_pooler
KisSwappedDataStore	m_swappedStore
KisTileDataSwapper	m_swapper
ConcurrentMap< int, KisTileData * >	m_tileDataMap

Friends
class	DeadlockyThread
class	KisLowMemoryBenchmark
class	KisLowMemoryTests
class	KisTileDataPoolerTest
class	KisTileDataStoreTest
class	KisTiledDataManagerTest

Detailed Description

Stores tileData objects. When needed compresses them and swaps.

Definition at line 28 of file kis_tile_data_store.h.

Constructor & Destructor Documentation

KisTileDataStore()

KisTileDataStore::KisTileDataStore

(

)

Definition at line 58 of file kis_tile_data_store.cc.

    : m_pooler(this),
      m_swapper(this),
      m_numTiles(0),
      m_memoryMetric(0),
      m_counter(1),
      m_clockIndex(1)
{
    m_pooler.start();
    m_swapper.start();
}

References m_pooler, and m_swapper.

~KisTileDataStore()

KisTileDataStore::~KisTileDataStore

(

)

Definition at line 70 of file kis_tile_data_store.cc.

{
    m_pooler.terminatePooler();
    m_swapper.terminateSwapper();
 
    if (numTiles() > 0) {
        errKrita << "Warning: some tiles have leaked:";
        errKrita << "\tTiles in memory:" << numTilesInMemory() << "\n"
                 << "\tTotal tiles:" << numTiles();
    }
}

References errKrita, m_pooler, m_swapper, numTiles(), numTilesInMemory(), KisTileDataPooler::terminatePooler(), and KisTileDataSwapper::terminateSwapper().

Member Function Documentation

allocTileData()

KisTileData * KisTileDataStore::allocTileData ( qint32 pixelSize, const quint8 * defPixel )

private

Definition at line 167 of file kis_tile_data_store.cc.

{
    KisTileData *td = new KisTileData(pixelSize, defPixel, this);
    registerTileData(td);
    return td;
}

References registerTileData().

beginClockIteration()

KisTileDataStoreClockIterator * KisTileDataStore::beginClockIteration

(

)

Definition at line 305 of file kis_tile_data_store.cc.

{
    m_iteratorLock.lockForWrite();
    return new KisTileDataStoreClockIterator(m_tileDataMap, m_clockIndex.loadAcquire(), this);
}

References m_clockIndex, m_iteratorLock, and m_tileDataMap.

beginIteration()

KisTileDataStoreIterator * KisTileDataStore::beginIteration

(

)

Definition at line 282 of file kis_tile_data_store.cc.

{
    m_iteratorLock.lockForWrite();
    return new KisTileDataStoreIterator(m_tileDataMap, this);
}

References m_iteratorLock, and m_tileDataMap.

beginReverseIteration()

KisTileDataStoreReverseIterator * KisTileDataStore::beginReverseIteration

(

)

Definition at line 293 of file kis_tile_data_store.cc.

{
    m_iteratorLock.lockForWrite();
    return new KisTileDataStoreReverseIterator(m_tileDataMap, this);
}

References m_iteratorLock, and m_tileDataMap.

checkFreeMemory()

void KisTileDataStore::checkFreeMemory ( )

inline

Definition at line 67 of file kis_tile_data_store.h.

    {
        m_swapper.checkFreeMemory();
    }

createDefaultTileData()

KisTileData * KisTileDataStore::createDefaultTileData ( qint32 pixelSize, const quint8 * defPixel )

inline

Definition at line 89 of file kis_tile_data_store.h.

    {
        return allocTileData(pixelSize, defPixel);
    }

debugClear()

void KisTileDataStore::debugClear ( )

private

Definition at line 350 of file kis_tile_data_store.cc.

{
    QWriteLocker l(&m_iteratorLock);
    ConcurrentMap<int, KisTileData*>::Iterator iter(m_tileDataMap);
 
    while (iter.isValid()) {
        delete iter.getValue();
        iter.next();
    }
 
    m_counter = 1;
    m_clockIndex = 1;
    m_numTiles = 0;
    m_memoryMetric = 0;
}

References ConcurrentMap< K, V, KT, VT >::Iterator::getValue(), ConcurrentMap< K, V, KT, VT >::Iterator::isValid(), m_clockIndex, m_counter, m_iteratorLock, m_memoryMetric, m_numTiles, m_tileDataMap, and ConcurrentMap< K, V, KT, VT >::Iterator::next().

debugPrintList()

void KisTileDataStore::debugPrintList

(

)

Definition at line 318 of file kis_tile_data_store.cc.

{
    KisTileDataStoreIterator* iter = beginIteration();
    KisTileData *item = 0;
 
    while (iter->hasNext()) {
        item = iter->next();
        dbgTiles << "-------------------------\n"
                 << "TileData:\t\t\t" << item
                 << "\n  refCount:\t" << item->m_refCount;
    }
 
    endIteration(iter);
}

References beginIteration(), dbgTiles, endIteration(), KisTileDataStoreIterator::hasNext(), KisTileData::m_refCount, and KisTileDataStoreIterator::next().

debugSwapAll()

void KisTileDataStore::debugSwapAll ( )

private

Definition at line 333 of file kis_tile_data_store.cc.

{
    KisTileDataStoreIterator* iter = beginIteration();
    KisTileData *item = 0;
 
    while (iter->hasNext()) {
        item = iter->next();
        iter->trySwapOut(item);
    }
 
    endIteration(iter);
 
//    dbgKrita << "Number of tiles:" << numTiles();
//    dbgKrita << "Tiles in memory:" << numTilesInMemory();
//    m_swappedStore.debugStatistics();
}

References beginIteration(), endIteration(), KisTileDataStoreIterator::hasNext(), KisTileDataStoreIterator::next(), and KisTileDataStoreIterator::trySwapOut().

duplicateTileData()

KisTileData * KisTileDataStore::duplicateTileData

(

KisTileData *

rhs

)

WARN: The following three method are only for usage in KisTileData. Do not call them directly!

Definition at line 174 of file kis_tile_data_store.cc.

{
    KisTileData *td = 0;
 
    if (rhs->m_clonesStack.pop(td)) {
        DEBUG_PRECLONE_ACTION("+ Pre-clone HIT", rhs, td);
        DEBUG_COUNT_PRECLONE_HIT(rhs);
    } else {
        rhs->blockSwapping();
        td = new KisTileData(*rhs);
        rhs->unblockSwapping();
        DEBUG_PRECLONE_ACTION("- Pre-clone #MISS#", rhs, td);
        DEBUG_COUNT_PRECLONE_MISS(rhs);
    }
 
    registerTileData(td);
    return td;
}

References KisTileData::blockSwapping(), DEBUG_COUNT_PRECLONE_HIT, DEBUG_COUNT_PRECLONE_MISS, DEBUG_PRECLONE_ACTION, KisTileData::m_clonesStack, KisLocklessStack< T >::pop(), registerTileData(), and KisTileData::unblockSwapping().

endIteration() [1/3]

void KisTileDataStore::endIteration

(

KisTileDataStoreClockIterator *

iterator

)

Definition at line 311 of file kis_tile_data_store.cc.

{
    m_clockIndex = iterator->getFinalPosition();
    delete iterator;
    m_iteratorLock.unlock();
}

References KisTileDataStoreClockIterator::getFinalPosition(), m_clockIndex, and m_iteratorLock.

endIteration() [2/3]

void KisTileDataStore::endIteration

(

KisTileDataStoreIterator *

iterator

)

Definition at line 287 of file kis_tile_data_store.cc.

{
    delete iterator;
    m_iteratorLock.unlock();
}

References m_iteratorLock.

endIteration() [3/3]

void KisTileDataStore::endIteration

(

KisTileDataStoreReverseIterator *

iterator

)

Definition at line 298 of file kis_tile_data_store.cc.

{
    delete iterator;
    m_iteratorLock.unlock();
    DEBUG_REPORT_PRECLONE_EFFICIENCY();
}

References DEBUG_REPORT_PRECLONE_EFFICIENCY, and m_iteratorLock.

ensureTileDataLoaded()

void KisTileDataStore::ensureTileDataLoaded

(

KisTileData *

td

)

Ensures that the tile data is totally present in memory and it's swapping is blocked by holding td->m_swapLock in a read mode. PRECONDITIONS: td->m_swapLock is unlocked m_listRWLock is unlocked POSTCONDITIONS: td->m_data is in memory and td->m_swapLock is locked m_listRWLock is unlocked

The order of this heavy locking is very important. Change it only in case, you really know what you are doing.

If someone has managed to load the td from swap, then, most probably, they have already taken the swap lock. This may lead to a deadlock, because COW mechanism breaks lock ordering rules in duplicateTileData() (it takes m_listLock while the swap lock is held). In our case it is enough just to check whether the other thread has already fetched the data. Please notice that we do not take both of the locks while checking this, because holding m_listLock is enough. Nothing can happen to the tile while we hold m_listLock.

<– In theory, livelock is possible here...

Definition at line 214 of file kis_tile_data_store.cc.

{
//    dbgKrita << "#### SWAP MISS! ####" << td << ppVar(td->mementoed()) << ppVar(td->age()) << ppVar(td->numUsers());
    checkFreeMemory();
 
    td->m_swapLock.lockForRead();
 
    while (!td->data()) {
        td->m_swapLock.unlock();
 
        m_iteratorLock.lockForWrite();
 
        if (!td->data()) {
            td->m_swapLock.lockForWrite();
 
            m_swappedStore.swapInTileData(td);
            registerTileDataImp(td);
 
            td->m_swapLock.unlock();
        }
 
        m_iteratorLock.unlock();
 
        td->m_swapLock.lockForRead();
    }
}

References checkFreeMemory(), KisTileData::data(), m_iteratorLock, KisTileData::m_swapLock, m_swappedStore, registerTileDataImp(), and KisSwappedDataStore::swapInTileData().

freeRegisteredTiles()

void KisTileDataStore::freeRegisteredTiles ( )

private

freeTileData()

void KisTileDataStore::freeTileData

(

KisTileData *

td

)

Definition at line 193 of file kis_tile_data_store.cc.

{
    Q_ASSERT(td->m_store == this);
 
    DEBUG_FREE_ACTION(td);
 
    m_iteratorLock.lockForRead();
    td->m_swapLock.lockForWrite();
 
    if (!td->data()) {
        m_swappedStore.forgetTileData(td);
    } else {
        unregisterTileDataImp(td);
    }
 
    td->m_swapLock.unlock();
    m_iteratorLock.unlock();
 
    delete td;
}

References KisTileData::data(), DEBUG_FREE_ACTION, KisSwappedDataStore::forgetTileData(), m_iteratorLock, KisTileData::m_store, KisTileData::m_swapLock, m_swappedStore, and unregisterTileDataImp().

instance()

KisTileDataStore * KisTileDataStore::instance ( )

static

Definition at line 82 of file kis_tile_data_store.cc.

{
    return s_instance;
}

kickPooler()

void KisTileDataStore::kickPooler ( )

inline

Definition at line 95 of file kis_tile_data_store.h.

    {
        m_pooler.kick();
 
        //FIXME: maybe, rename a function?
        m_swapper.kick();
    }

memoryMetric()

qint64 KisTileDataStore::memoryMetric ( ) const

inline

See also

m_memoryMetric

Definition at line 75 of file kis_tile_data_store.h.

    {
        return m_memoryMetric.loadAcquire();
    }

memoryStatistics()

KisTileDataStore::MemoryStatistics KisTileDataStore::memoryStatistics

(

)

Definition at line 87 of file kis_tile_data_store.cc.

{
    QReadLocker lock(&m_iteratorLock);
 
    MemoryStatistics stats;
 
    const qint64 metricCoeff = qint64(KisTileData::WIDTH) * KisTileData::HEIGHT;
 
    stats.realMemorySize = m_pooler.lastRealMemoryMetric() * metricCoeff;
    stats.historicalMemorySize = m_pooler.lastHistoricalMemoryMetric() * metricCoeff;
    stats.poolSize = m_pooler.lastPoolMemoryMetric() * metricCoeff;
 
    stats.totalMemorySize = memoryMetric() * metricCoeff + stats.poolSize;
 
    stats.swapSize = m_swappedStore.totalSwapMemoryUsed();
 
    return stats;
}

References KisTileData::HEIGHT, KisTileDataStore::MemoryStatistics::historicalMemorySize, KisTileDataPooler::lastHistoricalMemoryMetric(), KisTileDataPooler::lastPoolMemoryMetric(), KisTileDataPooler::lastRealMemoryMetric(), m_iteratorLock, m_pooler, m_swappedStore, memoryMetric(), KisTileDataStore::MemoryStatistics::poolSize, KisTileDataStore::MemoryStatistics::realMemorySize, KisTileDataStore::MemoryStatistics::swapSize, KisTileDataStore::MemoryStatistics::totalMemorySize, KisSwappedDataStore::totalSwapMemoryUsed(), and KisTileData::WIDTH.

numTiles()

qint32 KisTileDataStore::numTiles ( ) const

inline

Returns total number of tiles present: in memory or in a swap file

Definition at line 54 of file kis_tile_data_store.h.

    {
        return m_numTiles.loadAcquire() + m_swappedStore.numTiles();
    }

numTilesInMemory()

qint32 KisTileDataStore::numTilesInMemory ( ) const

inline

Returns the number of tiles present in memory only

Definition at line 62 of file kis_tile_data_store.h.

    {
        return m_numTiles.loadAcquire();
    }

registerTileData()

void KisTileDataStore::registerTileData

(

KisTileData *

td

)

Definition at line 132 of file kis_tile_data_store.cc.

{
    QReadLocker lock(&m_iteratorLock);
    registerTileDataImp(td);
}

References m_iteratorLock, and registerTileDataImp().

registerTileDataImp()

void KisTileDataStore::registerTileDataImp ( KisTileData * td )

inlineprivate

Definition at line 115 of file kis_tile_data_store.cc.

{
    int index = m_counter.fetchAndAddOrdered(1);
    td->m_tileNumber = index;
 
    // make sure that access to the hash table is guarded by GC block
    // (it avoids removal of the referenced cells caused by concurrent
    // migrations)
    m_tileDataMap.getGC().lockRawPointerAccess();
    m_tileDataMap.assign(index, td);
    m_tileDataMap.getGC().unlockRawPointerAccess();
    m_tileDataMap.getGC().update();
 
    m_numTiles.ref();
    m_memoryMetric += td->pixelSize();
}

References ConcurrentMap< K, V, KT, VT >::assign(), ConcurrentMap< K, V, KT, VT >::getGC(), QSBR::lockRawPointerAccess(), m_counter, m_memoryMetric, m_numTiles, m_tileDataMap, KisTileData::m_tileNumber, KisTileData::pixelSize(), QSBR::unlockRawPointerAccess(), and QSBR::update().

testingRereadConfig()

void KisTileDataStore::testingRereadConfig ( )

private

Definition at line 366 of file kis_tile_data_store.cc.

{
    m_pooler.testingRereadConfig();
    m_swapper.testingRereadConfig();
    kickPooler();
}

References kickPooler(), m_pooler, m_swapper, KisTileDataPooler::testingRereadConfig(), and KisTileDataSwapper::testingRereadConfig().

testingResumePooler()

void KisTileDataStore::testingResumePooler ( )

private

Definition at line 378 of file kis_tile_data_store.cc.

{
    m_pooler.start();
}

References m_pooler.

testingSuspendPooler()

void KisTileDataStore::testingSuspendPooler ( )

private

Definition at line 373 of file kis_tile_data_store.cc.

{
    m_pooler.terminatePooler();
}

References m_pooler, and KisTileDataPooler::terminatePooler().

tryForceUpdateMemoryStatisticsWhileIdle()

void KisTileDataStore::tryForceUpdateMemoryStatisticsWhileIdle

(

)

Definition at line 106 of file kis_tile_data_store.cc.

{
    // in case the pooler is disabled, we should force it
    // to update the stats
    if (!m_pooler.isRunning()) {
        m_pooler.forceUpdateMemoryStats();
    }
}

References KisTileDataPooler::forceUpdateMemoryStats(), and m_pooler.

trySwapTileData()

bool KisTileDataStore::trySwapTileData

(

KisTileData *

td

)

Try swap out the tile data. It may fail in case the tile is being accessed at the same moment of time.

This function is called with m_listLock acquired

Definition at line 262 of file kis_tile_data_store.cc.

{
    bool result = false;
    if (!td->m_swapLock.tryLockForWrite()) return result;
 
    if (td->data()) {
        if (m_swappedStore.trySwapOutTileData(td)) {
            unregisterTileDataImp(td);
            result = true;
        }
    }
    td->m_swapLock.unlock();
 
    return result;
}

References KisTileData::data(), KisTileData::m_swapLock, m_swappedStore, KisSwappedDataStore::trySwapOutTileData(), and unregisterTileDataImp().

unregisterTileData()

void KisTileDataStore::unregisterTileData

(

KisTileData *

td

)

Definition at line 161 of file kis_tile_data_store.cc.

{
    QReadLocker lock(&m_iteratorLock);
    unregisterTileDataImp(td);
}

References m_iteratorLock, and unregisterTileDataImp().

unregisterTileDataImp()

void KisTileDataStore::unregisterTileDataImp ( KisTileData * td )

inlineprivate

Definition at line 138 of file kis_tile_data_store.cc.

{
    // make sure that access to the hash table is guarded by GC block
    // (it avoids removal of the referenced cells caused by concurrent
    // migrations)
    m_tileDataMap.getGC().lockRawPointerAccess();
 
    if (m_clockIndex == td->m_tileNumber) {
        do {
            m_clockIndex.ref();
        } while (!m_tileDataMap.get(m_clockIndex.loadAcquire()) && m_clockIndex < m_counter);
    }
 
    int index = td->m_tileNumber;
    td->m_tileNumber = -1;
    m_tileDataMap.erase(index);
    m_numTiles.deref();
    m_memoryMetric -= td->pixelSize();
 
    m_tileDataMap.getGC().unlockRawPointerAccess();
    m_tileDataMap.getGC().update();
}

References KisTileData::deref(), ConcurrentMap< K, V, KT, VT >::erase(), ConcurrentMap< K, V, KT, VT >::get(), ConcurrentMap< K, V, KT, VT >::getGC(), QSBR::lockRawPointerAccess(), m_clockIndex, m_counter, m_memoryMetric, m_numTiles, m_tileDataMap, KisTileData::m_tileNumber, KisTileData::pixelSize(), QSBR::unlockRawPointerAccess(), and QSBR::update().

Friends And Related Symbol Documentation

DeadlockyThread

friend class DeadlockyThread

friend

Definition at line 142 of file kis_tile_data_store.h.

KisLowMemoryBenchmark

friend class KisLowMemoryBenchmark

friend

Definition at line 151 of file kis_tile_data_store.h.

KisLowMemoryTests

friend class KisLowMemoryTests

friend

Definition at line 143 of file kis_tile_data_store.h.

KisTileDataPoolerTest

friend class KisTileDataPoolerTest

friend

Definition at line 158 of file kis_tile_data_store.h.

KisTileDataStoreTest

friend class KisTileDataStoreTest

friend

Definition at line 157 of file kis_tile_data_store.h.

KisTiledDataManagerTest

friend class KisTiledDataManagerTest

friend

Definition at line 147 of file kis_tile_data_store.h.

Member Data Documentation

m_clockIndex

QAtomicInt KisTileDataStore::m_clockIndex

private

Definition at line 169 of file kis_tile_data_store.h.

m_counter

QAtomicInt KisTileDataStore::m_counter

private

Definition at line 168 of file kis_tile_data_store.h.

m_iteratorLock

QReadWriteLock KisTileDataStore::m_iteratorLock

private

Definition at line 171 of file kis_tile_data_store.h.

m_memoryMetric

QAtomicInt KisTileDataStore::m_memoryMetric

private

Definition at line 167 of file kis_tile_data_store.h.

m_numTiles

QAtomicInt KisTileDataStore::m_numTiles

private

This metric is used for computing the volume of memory occupied by tile data objects. metric = num_bytes / (KisTileData::WIDTH * KisTileData::HEIGHT)

Definition at line 166 of file kis_tile_data_store.h.

m_pooler

KisTileDataPooler KisTileDataStore::m_pooler

private

Definition at line 154 of file kis_tile_data_store.h.

m_swappedStore

KisSwappedDataStore KisTileDataStore::m_swappedStore

private

Definition at line 159 of file kis_tile_data_store.h.

m_swapper

KisTileDataSwapper KisTileDataStore::m_swapper

private

Definition at line 155 of file kis_tile_data_store.h.

m_tileDataMap

ConcurrentMap<int, KisTileData*> KisTileDataStore::m_tileDataMap

private

Definition at line 170 of file kis_tile_data_store.h.

---

The documentation for this class was generated from the following files:

• libs/image/tiles3/kis_tile_data_store.h
• libs/image/tiles3/kis_tile_data_store.cc