KisSwappedDataStore Class Reference

#include <kis_swapped_data_store.h>

Public Member Functions
void	debugStatistics ()
void	forgetTileData (KisTileData *td)
	KisSwappedDataStore ()
quint64	numTiles () const
void	swapInTileData (KisTileData *td)
qint64	totalSwapMemoryUsed () const
bool	trySwapOutTileData (KisTileData *td)
	~KisSwappedDataStore ()

Private Attributes
KisChunkAllocator *	m_allocator
QByteArray	m_buffer
KisAbstractTileCompressor *	m_compressor
QMutex	m_lock
KisMemoryWindow *	m_swapSpace
qint64	m_totalSwapMemoryUsed

Detailed Description

Definition at line 22 of file kis_swapped_data_store.h.

Constructor & Destructor Documentation

KisSwappedDataStore()

KisSwappedDataStore::KisSwappedDataStore

(

)

Definition at line 17 of file kis_swapped_data_store.cpp.

    : m_totalSwapMemoryUsed(0)
{
    KisImageConfig config(true);
    const quint64 maxSwapSize = config.maxSwapSize() * MiB;
    const quint64 swapSlabSize = config.swapSlabSize() * MiB;
    const quint64 swapWindowSize = config.swapWindowSize() * MiB;
 
    m_allocator = new KisChunkAllocator(swapSlabSize, maxSwapSize);
    m_swapSpace = new KisMemoryWindow(config.swapDir(), swapWindowSize);
 
    // FIXME: use a factory after the patch is committed
    m_compressor = new KisTileCompressor2();
}

References m_allocator, m_compressor, m_swapSpace, KisImageConfig::maxSwapSize(), MiB, KisImageConfig::swapDir(), KisImageConfig::swapSlabSize(), and KisImageConfig::swapWindowSize().

~KisSwappedDataStore()

KisSwappedDataStore::~KisSwappedDataStore

(

)

Definition at line 32 of file kis_swapped_data_store.cpp.

{
    delete m_compressor;
    delete m_swapSpace;
    delete m_allocator;
}

References m_allocator, m_compressor, and m_swapSpace.

Member Function Documentation

debugStatistics()

void KisSwappedDataStore::debugStatistics

(

)

Some debugging output

Definition at line 115 of file kis_swapped_data_store.cpp.

{
    m_allocator->sanityCheck();
    m_allocator->debugFragmentation();
}

References KisChunkAllocator::debugFragmentation(), m_allocator, and KisChunkAllocator::sanityCheck().

forgetTileData()

void KisSwappedDataStore::forgetTileData

(

KisTileData *

td

)

Forget all the information linked with the tile data. This should be done before deleting of the tile data, whose actual data is swapped-out

Definition at line 100 of file kis_swapped_data_store.cpp.

{
    QMutexLocker locker(&m_lock);
 
    m_totalSwapMemoryUsed -= td->swapChunk().size();
 
    m_allocator->freeChunk(td->swapChunk());
    td->setSwapChunk(KisChunk());
}

References KisChunkAllocator::freeChunk(), m_allocator, m_lock, m_totalSwapMemoryUsed, KisTileData::setSwapChunk(), KisChunk::size(), and KisTileData::swapChunk().

numTiles()

quint64 KisSwappedDataStore::numTiles

(

)

const

Returns number of swapped out tile data objects

Definition at line 39 of file kis_swapped_data_store.cpp.

{
    // We are not acquiring the lock here...
    // Hope QLinkedList will ensure atomic access to it's size...
 
    return m_allocator->numChunks();
}

References m_allocator, and KisChunkAllocator::numChunks().

swapInTileData()

void KisSwappedDataStore::swapInTileData

(

KisTileData *

td

)

Restore the data of a td basing on information stored in the swap file. LOCKING: the lock on the tile data should be taken by the caller before making a call.

Definition at line 81 of file kis_swapped_data_store.cpp.

{
    Q_ASSERT(!td->data());
    QMutexLocker locker(&m_lock);
 
    // see comment in swapOutTileData()
 
    KisChunk chunk = td->swapChunk();
    m_totalSwapMemoryUsed -= chunk.size();
 
    td->allocateMemory();
    td->setSwapChunk(KisChunk());
 
    quint8 *ptr = m_swapSpace->getReadChunkPtr(chunk);
    Q_ASSERT(ptr);
    m_compressor->decompressTileData(ptr, chunk.size(), td);
    m_allocator->freeChunk(chunk);
}

References KisTileData::allocateMemory(), KisTileData::data(), KisAbstractTileCompressor::decompressTileData(), KisChunkAllocator::freeChunk(), KisMemoryWindow::getReadChunkPtr(), m_allocator, m_compressor, m_lock, m_swapSpace, m_totalSwapMemoryUsed, KisTileData::setSwapChunk(), KisChunk::size(), and KisTileData::swapChunk().

totalSwapMemoryUsed()

qint64 KisSwappedDataStore::totalSwapMemoryUsed

(

)

const

Returns the metric of the total memory stored in the swap in uncompressed form!

Definition at line 110 of file kis_swapped_data_store.cpp.

{
    return m_totalSwapMemoryUsed;
}

References m_totalSwapMemoryUsed.

trySwapOutTileData()

bool KisSwappedDataStore::trySwapOutTileData

(

KisTileData *

td

)

Swap out the data stored in the td to the swap file and free memory occupied by td->data(). LOCKING: the lock on the tile data should be taken by the caller before making a call.

We are expecting that the lock of KisTileData has already been taken by the caller for us. So we can modify the tile data freely.

Definition at line 47 of file kis_swapped_data_store.cpp.

{
    Q_ASSERT(td->data());
    QMutexLocker locker(&m_lock);
 
    const qint32 expectedBufferSize = m_compressor->tileDataBufferSize(td);
    if(m_buffer.size() < expectedBufferSize)
        m_buffer.resize(expectedBufferSize);
 
    qint32 bytesWritten;
    m_compressor->compressTileData(td, (quint8*) m_buffer.data(), m_buffer.size(), bytesWritten);
 
    KisChunk chunk = m_allocator->getChunk(bytesWritten);
    quint8 *ptr = m_swapSpace->getWriteChunkPtr(chunk);
    if (!ptr) {
        qWarning() << "swap out of tile failed";
        return false;
    }
    memcpy(ptr, m_buffer.data(), bytesWritten);
 
    td->releaseMemory();
    td->setSwapChunk(chunk);
 
    m_totalSwapMemoryUsed += chunk.size();
 
    return true;
}

References KisAbstractTileCompressor::compressTileData(), KisTileData::data(), KisChunkAllocator::getChunk(), KisMemoryWindow::getWriteChunkPtr(), m_allocator, m_buffer, m_compressor, m_lock, m_swapSpace, m_totalSwapMemoryUsed, KisTileData::releaseMemory(), KisTileData::setSwapChunk(), KisChunk::size(), and KisAbstractTileCompressor::tileDataBufferSize().

Member Data Documentation

m_allocator

KisChunkAllocator* KisSwappedDataStore::m_allocator

private

Definition at line 71 of file kis_swapped_data_store.h.

m_buffer

QByteArray KisSwappedDataStore::m_buffer

private

Definition at line 68 of file kis_swapped_data_store.h.

m_compressor

KisAbstractTileCompressor* KisSwappedDataStore::m_compressor

private

Definition at line 69 of file kis_swapped_data_store.h.

m_lock

QMutex KisSwappedDataStore::m_lock

private

Definition at line 74 of file kis_swapped_data_store.h.

m_swapSpace

KisMemoryWindow* KisSwappedDataStore::m_swapSpace

private

Definition at line 72 of file kis_swapped_data_store.h.

m_totalSwapMemoryUsed

qint64 KisSwappedDataStore::m_totalSwapMemoryUsed

private

Definition at line 76 of file kis_swapped_data_store.h.

---

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

• libs/image/tiles3/swap/kis_swapped_data_store.h
• libs/image/tiles3/swap/kis_swapped_data_store.cpp