#include <kis_tile_data_interface.h>

Public Types
enum	EnumTileDataState { NORMAL = 0 , COMPRESSED , SWAPPED }

Public Member Functions
bool	acquire ()

int	age () const

void	allocateMemory ()

void	blockSwapping ()

KisTileData *	clone ()

quint8 *	data () const

bool	deref ()

bool	historical () const

	KisTileData (qint32 pixelSize, const quint8 defPixel, KisTileDataStore store, bool checkFreeMemory=true)

void	markOld ()

bool	mementoed () const

qint32	numUsers () const

quint32	pixelSize () const

bool	ref () const

bool	release ()

void	releaseMemory ()

void	resetAge ()

void	setData (const quint8 *data)

void	setMementoed (bool value)

void	setSwapChunk (KisChunk chunk)

KisChunk	swapChunk () const

void	unblockSwapping ()

	~KisTileData ()

Static Public Member Functions
static void	releaseInternalPools ()

Static Public Attributes
static const qint32	HEIGHT = __TILE_DATA_HEIGHT

static const qint32	WIDTH = __TILE_DATA_WIDTH

Private Member Functions
void	fillWithPixel (const quint8 *defPixel)

	KisTileData (const KisTileData &rhs, bool checkFreeMemory=true)

Static Private Member Functions
static quint8 *	allocateData (const qint32 pixelSize)

static void	freeData (quint8 *ptr, const qint32 pixelSize)

Private Attributes
int	m_age

KisTileDataCache	m_clonesStack

quint8 *	m_data

qint32	m_mementoFlag

qint32	m_pixelSize

QAtomicInt	m_refCount

EnumTileDataState	m_state

KisTileDataStore *	m_store

KisChunk	m_swapChunk

QReadWriteLock	m_swapLock

int	m_tileNumber = -1

QAtomicInt	m_usersCount

Static Private Attributes
static SimpleCache	m_cache

Friends
class	KisLowMemoryTests

class	KisTile

class	KisTileDataPooler

class	KisTileDataPoolerTest

class	KisTileDataStore

class	KisTileDataStoreClockIterator

class	KisTileDataStoreIterator

class	KisTileDataStoreReverseIterator

Detailed Description

Stores actual tile's data

Definition at line 88 of file kis_tile_data_interface.h.

Member Enumeration Documentation

◆ EnumTileDataState

enum KisTileData::EnumTileDataState

Enumerator
NORMAL
COMPRESSED
SWAPPED

Definition at line 99 of file kis_tile_data_interface.h.

                           {
        NORMAL = 0,
        COMPRESSED,
        SWAPPED
    };

Constructor & Destructor Documentation

◆ KisTileData() [1/2]

KisTileData::KisTileData	(	qint32	pixelSize,
		const quint8 *	defPixel,
		KisTileDataStore *	store,
		bool	checkFreeMemory = true )

Definition at line 53 of file kis_tile_data.cc.

    : m_state(NORMAL),
      m_mementoFlag(0),
      m_age(0),
      m_usersCount(0),
      m_refCount(0),
      m_pixelSize(pixelSize),
      m_store(store)
{
    if (checkFreeMemory) {
        m_store->checkFreeMemory();
    }
    m_data = allocateData(m_pixelSize);
 
    fillWithPixel(defPixel);
}

References allocateData(), KisTileDataStore::checkFreeMemory(), fillWithPixel(), m_data, m_pixelSize, and m_store.

◆ KisTileData() [2/2]

KisTileData::KisTileData	(	const KisTileData &	rhs,
		bool	checkFreeMemory = true )

private

Duplicating tiledata

new object loaded in memory
it's unlocked and has refCount==0

NOTE: the memory allocated by the pooler for clones is not counted by the store in memoryHardLimit. The pooler has it's own slice of memory and keeps track of the its size itself. So we should be able to disable the memory check with checkFreeMemory, otherwise, there is a deadlock.

Definition at line 82 of file kis_tile_data.cc.

    : m_state(NORMAL),
      m_mementoFlag(0),
      m_age(0),
      m_usersCount(0),
      m_refCount(0),
      m_pixelSize(rhs.m_pixelSize),
      m_store(rhs.m_store)
{
    if (checkFreeMemory) {
        m_store->checkFreeMemory();
    }
    m_data = allocateData(m_pixelSize);
 
    memcpy(m_data, rhs.data(), m_pixelSize * WIDTH * HEIGHT);
}

References allocateData(), KisTileDataStore::checkFreeMemory(), data(), HEIGHT, m_data, m_pixelSize, m_store, and WIDTH.

◆ ~KisTileData()

KisTileData::~KisTileData ( )

Definition at line 100 of file kis_tile_data.cc.

{
    releaseMemory();
}

References releaseMemory().

Member Function Documentation

◆ acquire()

bool KisTileData::acquire ( )

inline

Increments usersCount of a TD and refs shared pointer counter Used by KisTile for COW

We need to ensure the clones in the stack are consistent with the data. When we have a single user, the most probably, the clone has already started stinking. So just clean it up.

Definition at line 35 of file kis_tile_data.h.

                                 {
    if(m_usersCount == 1) {
        KisTileData *clone = 0;
        while(m_clonesStack.pop(clone)) {
            delete clone;
        }
    }
 
    bool _ref = ref();
    m_usersCount.ref();
    return _ref;
}

References clone(), m_clonesStack, m_usersCount, KisLocklessStack< T >::pop(), and ref().

◆ age()

int KisTileData::age ( ) const

inline

Controlling methods for setting 'age' marks

Definition at line 110 of file kis_tile_data.h.

                                  {
    return m_age;
}

References m_age.

◆ allocateData()

quint8 * KisTileData::allocateData ( const qint32 pixelSize )

staticprivate

Definition at line 135 of file kis_tile_data.cc.

{
    quint8 *ptr = 0;
 
    if (!m_cache.pop(pixelSize, ptr)) {
        switch (pixelSize) {
        case 4:
            ptr = (quint8*)BoostPool4BPP::malloc();
            break;
        case 8:
            ptr = (quint8*)BoostPool8BPP::malloc();
            break;
        default:
            ptr = (quint8*) malloc(pixelSize * WIDTH * HEIGHT);
            break;
        }
    }
 
    return ptr;
}

References HEIGHT, m_cache, pixelSize(), SimpleCache::pop(), and WIDTH.

◆ allocateMemory()

void KisTileData::allocateMemory ( )

Used for swapping purposes only. Allocates memory for the tile data after it has been freed in releaseMemory(). NOTE: the new data can be not-initialized and you must fill it yourself!

See also: releaseMemory()

Definition at line 129 of file kis_tile_data.cc.

{
    Q_ASSERT(!m_data);
    m_data = allocateData(m_pixelSize);
}

References allocateData(), m_data, and m_pixelSize.

◆ blockSwapping()

void KisTileData::blockSwapping ( )

inline

Control the access of swapper to the tile data

Definition at line 79 of file kis_tile_data.h.

                                       {
    m_swapLock.lockForRead();
    if(!m_data) {
        m_swapLock.unlock();
        m_store->ensureTileDataLoaded(this);
    }
    resetAge();
}

References KisTileDataStore::ensureTileDataLoaded(), m_data, m_store, m_swapLock, and resetAge().

◆ clone()

KisTileData * KisTileData::clone ( )

inline

Creates a clone of the tile data safely. It will try to use the cached clones.

Definition at line 75 of file kis_tile_data.h.

                                       {
    return m_store->duplicateTileData(this);
}

References KisTileDataStore::duplicateTileData(), and m_store.

◆ data()

quint8 * KisTileData::data ( ) const

inline

Information about data stored

Some methods of KisTileData have a cyclic dependency to the KisTileDataStore, so we've moved the class declaration to a separate file, that will be included by the store.

Definition at line 21 of file kis_tile_data.h.

                                       {
        // WARN: be careful - it can be null when swapped out!
        return m_data;
    }

References m_data.

◆ deref()

bool KisTileData::deref ( )

inline

Only refs shared pointer counter. Used only by KisMementoManager without consideration of COW.

Definition at line 65 of file kis_tile_data.h.

                               {
    bool _ref;
 
    if (!(_ref = m_refCount.deref())) {
        m_store->freeTileData(this);
        return 0;
    }
    return _ref;
}

References KisTileDataStore::freeTileData(), m_refCount, and m_store.

◆ fillWithPixel()

void KisTileData::fillWithPixel ( const quint8 * defPixel )

private

Definition at line 105 of file kis_tile_data.cc.

{
    quint8 *it = m_data;
 
    for (int i = 0; i < WIDTH * HEIGHT; i++, it += m_pixelSize) {
        memcpy(it, defPixel, m_pixelSize);
    }
}

References HEIGHT, m_data, m_pixelSize, and WIDTH.

◆ freeData()

void KisTileData::freeData	(	quint8 *	ptr,
		const qint32	pixelSize )

staticprivate

Definition at line 156 of file kis_tile_data.cc.

{
    if (!m_cache.push(pixelSize, ptr)) {
        switch (pixelSize) {
        case 4:
            BoostPool4BPP::free(ptr);
            break;
        case 8:
            BoostPool8BPP::free(ptr);
            break;
        default:
            free(ptr);
            break;
        }
    }
}

References m_cache, pixelSize(), and SimpleCache::push().

◆ historical()

bool KisTileData::historical ( ) const

inline

Convenience method. Returns true iff the tile data is linked to information only and therefore can be swapped out easily.

Effectively equivalent to: (mementoed() && numUsers() <= 1)

Definition at line 106 of file kis_tile_data.h.

                                          {
    return mementoed() && numUsers() <= 1;
}

References mementoed(), and numUsers().

◆ markOld()

void KisTileData::markOld ( )

inline

Definition at line 116 of file kis_tile_data.h.

                                 {
    m_age++;
}

References m_age.

◆ mementoed()

bool KisTileData::mementoed ( ) const

inline

Show whether a tile data is a part of history

Definition at line 99 of file kis_tile_data.h.

                                         {
    return m_mementoFlag;
}

References m_mementoFlag.

◆ numUsers()

qint32 KisTileData::numUsers ( ) const

inline

Returns number of tiles (or memento items), referencing the tile data.

Definition at line 120 of file kis_tile_data.h.

                                          {
    return m_usersCount;
}

References m_usersCount.

◆ pixelSize()

quint32 KisTileData::pixelSize ( ) const

inline

Definition at line 31 of file kis_tile_data.h.

                                            {
    return m_pixelSize;
}

References m_pixelSize.

◆ ref()

bool KisTileData::ref ( ) const

inline

Only refs shared pointer counter. Used only by KisMementoManager without consideration of COW.

Definition at line 61 of file kis_tile_data.h.

                                   {
    return m_refCount.ref();
}

References m_refCount.

◆ release()

bool KisTileData::release ( )

inline

Decrements usersCount of a TD and derefs shared pointer counter Used by KisTile for COW

Definition at line 55 of file kis_tile_data.h.

                                 {
    m_usersCount.deref();
    bool _ref = deref();
    return _ref;
}

References deref(), and m_usersCount.

◆ releaseInternalPools()

void KisTileData::releaseInternalPools ( )

static

Releases internal pools, which keep blobs where the tiles are stored. The point is that we don't allocate the tiles from glibc directly, but use pools (implemented via boost) to allocate bigger chunks. This method should be called when one knows that we have just free'd quite a lot of memory and we won't need it anymore. E.g. when a document has been closed.

Definition at line 179 of file kis_tile_data.cc.

{
    const int maxMigratedTiles = 100;
 
    if (KisTileDataStore::instance()->numTilesInMemory() < maxMigratedTiles) {
 
        QVector<KisTileData*> dataObjects;
        QVector<QByteArray> memoryChunks;
        bool failedToLock = false;
 
        KisTileDataStoreIterator *iter = KisTileDataStore::instance()->beginIteration();
 
        while (iter->hasNext()) {
            KisTileData *item = iter->next();
 
            // first release all the clones
            KisTileData *clone = 0;
            while (item->m_clonesStack.pop(clone)) {
                delete clone;
            }
 
            // check if the tile data has actually been pooled
            if (item->m_pixelSize != 4 &&
                item->m_pixelSize != 8 &&
                item->m_pixelSize != 16) {
 
                continue;
            }
 
            // check if the tile has been swapped out
            if (item->m_data) {
                const bool locked = item->m_swapLock.tryLockForWrite();
                if (!locked) {
                    failedToLock = true;
                    break;
                }
 
                const int chunkSize = item->m_pixelSize * WIDTH * HEIGHT;
                dataObjects << item;
                memoryChunks << QByteArray((const char*)item->m_data, chunkSize);
            }
 
        }
 
        if (!failedToLock) {
            // purge the pools memory
            m_cache.clear();
            BoostPool4BPP::purge_memory();
            BoostPool8BPP::purge_memory();
 
            auto it = dataObjects.begin();
            auto chunkIt = memoryChunks.constBegin();
 
            for (; it != dataObjects.end(); ++it, ++chunkIt) {
                KisTileData *item = *it;
                const int chunkSize = item->m_pixelSize * WIDTH * HEIGHT;
 
                item->m_data = allocateData(item->m_pixelSize);
                memcpy(item->m_data, chunkIt->data(), chunkSize);
 
                item->m_swapLock.unlock();
            }
        } else {
            Q_FOREACH (KisTileData *item, dataObjects) {
                item->m_swapLock.unlock();
            }
 
            warnKrita << "WARNING: Failed to lock the tiles while trying to release the pooled memory";
        }
 
        KisTileDataStore::instance()->endIteration(iter);
 
#ifdef DEBUG_POOL_RELEASE
        dbgKrita << "After purging unused memory:";
 
        char command[256];
        sprintf(command, "cat /proc/%d/status | grep -i vm", (int)getpid());
        printf("--- %s ---\n", command);
        (void)system(command);
#endif /* DEBUG_POOL_RELEASE */
 
    } else {
        dbgKrita << "DEBUG: releasing of the pooled memory has been cancelled:"
                 << "there are still"
                 << KisTileDataStore::instance()->numTilesInMemory()
                 << "tiles in memory";
    }
}

References allocateData(), KisTileDataStore::beginIteration(), SimpleCache::clear(), clone(), dbgKrita, KisTileDataStore::endIteration(), KisTileDataStoreIterator::hasNext(), HEIGHT, KisTileDataStore::instance(), m_cache, m_clonesStack, m_data, m_pixelSize, m_swapLock, KisTileDataStoreIterator::next(), KisTileDataStore::numTilesInMemory(), KisLocklessStack< T >::pop(), void(), warnKrita, and WIDTH.

◆ releaseMemory()

void KisTileData::releaseMemory ( )

Used for swapping purposes only. Frees the memory occupied by the tile data. (the caller must save the data beforehand)

Definition at line 114 of file kis_tile_data.cc.

{
    if (m_data) {
        freeData(m_data, m_pixelSize);
        m_data = 0;
    }
 
    KisTileData *clone = 0;
    while (m_clonesStack.pop(clone)) {
        delete clone;
    }
 
    Q_ASSERT(m_clonesStack.isEmpty());
}

References clone(), freeData(), KisLocklessStack< T >::isEmpty(), m_clonesStack, m_data, m_pixelSize, and KisLocklessStack< T >::pop().

◆ resetAge()

void KisTileData::resetAge ( )

inline

Definition at line 113 of file kis_tile_data.h.

                                  {
    m_age = 0;
}

References m_age.

◆ setData()

void KisTileData::setData ( const quint8 * data )

inline

Definition at line 26 of file kis_tile_data.h.

                                            {
    Q_ASSERT(m_data);
    memcpy(m_data, data, m_pixelSize*WIDTH*HEIGHT);
}

References data(), HEIGHT, m_data, m_pixelSize, and WIDTH.

◆ setMementoed()

void KisTileData::setMementoed ( bool value )

inline

Definition at line 102 of file kis_tile_data.h.

                                                {
    m_mementoFlag += value ? 1 : -1;
}

References m_mementoFlag, and value().

◆ setSwapChunk()

void KisTileData::setSwapChunk ( KisChunk chunk )

inline

Definition at line 95 of file kis_tile_data.h.

                                                    {
    m_swapChunk = chunk;
}

References m_swapChunk.

◆ swapChunk()

KisChunk KisTileData::swapChunk ( ) const

inline

The position of the tile data in a swap file

Definition at line 92 of file kis_tile_data.h.

                                             {
    return m_swapChunk;
}

References m_swapChunk.

◆ unblockSwapping()

void KisTileData::unblockSwapping ( )

inline

Definition at line 88 of file kis_tile_data.h.

                                         {
    m_swapLock.unlock();
}

References m_swapLock.

Friends And Related Symbol Documentation

◆ KisLowMemoryTests

friend class KisLowMemoryTests

friend

Definition at line 284 of file kis_tile_data_interface.h.

◆ KisTile

friend class KisTile

friend

Definition at line 227 of file kis_tile_data_interface.h.

◆ KisTileDataPooler

friend class KisTileDataPooler

friend

Definition at line 217 of file kis_tile_data_interface.h.

◆ KisTileDataPoolerTest

friend class KisTileDataPoolerTest

friend

Definition at line 218 of file kis_tile_data_interface.h.

◆ KisTileDataStore

friend class KisTileDataStore

friend

Definition at line 228 of file kis_tile_data_interface.h.

◆ KisTileDataStoreClockIterator

friend class KisTileDataStoreClockIterator

friend

Definition at line 232 of file kis_tile_data_interface.h.

◆ KisTileDataStoreIterator

friend class KisTileDataStoreIterator

friend

Definition at line 230 of file kis_tile_data_interface.h.

◆ KisTileDataStoreReverseIterator

friend class KisTileDataStoreReverseIterator

friend

Definition at line 231 of file kis_tile_data_interface.h.

Member Data Documentation

◆ HEIGHT

const qint32 KisTileData::HEIGHT = __TILE_DATA_HEIGHT

static

Definition at line 312 of file kis_tile_data_interface.h.

◆ m_age

int KisTileData::m_age

private

Counts up time after last access to the tile data. 0 - recently accessed 1+ - not recently accessed

Definition at line 271 of file kis_tile_data_interface.h.

◆ m_cache

SimpleCache KisTileData::m_cache

staticprivate

Definition at line 308 of file kis_tile_data_interface.h.

◆ m_clonesStack

KisTileDataCache KisTileData::m_clonesStack

private

A list of pre-duplicated tiledatas. To make a COW faster, KisTileDataPooler thread duplicates a tile beforehand and stores clones here, in this stack

Definition at line 224 of file kis_tile_data_interface.h.

◆ m_data

quint8* KisTileData::m_data

mutableprivate

FIXME: We should be able to work in const environment even when actual data is swapped out to disk

Definition at line 290 of file kis_tile_data_interface.h.

◆ m_mementoFlag

qint32 KisTileData::m_mementoFlag

private

The flag is set by KisMementoItem to show this tile data is going down in history.

(m_mementoFlag && m_usersCount == 1) means that the only user of tile data is a memento manager.

Definition at line 263 of file kis_tile_data_interface.h.

◆ m_pixelSize

qint32 KisTileData::m_pixelSize

private

Definition at line 304 of file kis_tile_data_interface.h.

◆ m_refCount

QAtomicInt KisTileData::m_refCount

mutableprivate

Shared pointer counter

Definition at line 301 of file kis_tile_data_interface.h.

◆ m_state

EnumTileDataState KisTileData::m_state

mutableprivate

The state of the tile. Filled in by tileDataStore and checked in KisTile::acquireFor* see also: comment for @m_data

Definition at line 240 of file kis_tile_data_interface.h.

◆ m_store

KisTileDataStore* KisTileData::m_store

private

Definition at line 307 of file kis_tile_data_interface.h.

◆ m_swapChunk

KisChunk KisTileData::m_swapChunk

private

The chunk of the swap file, that corresponds to this tile data. Used by KisSwappedDataStore.

Definition at line 253 of file kis_tile_data_interface.h.

◆ m_swapLock

QReadWriteLock KisTileData::m_swapLock

private

The primitive for controlling swapping of the tile. lockForRead() - used by regular threads to ensure swapper won't touch this tile data. tryLockForWrite() - used by swapper to check no-one reads this tile data

Definition at line 281 of file kis_tile_data_interface.h.

◆ m_tileNumber

int KisTileData::m_tileNumber = -1

private

Iterator that points to a position in the list where the tile data is stored

Definition at line 246 of file kis_tile_data_interface.h.

◆ m_usersCount

QAtomicInt KisTileData::m_usersCount

mutableprivate

How many tiles/mementoes use this tiledata through COW?

Definition at line 296 of file kis_tile_data_interface.h.

◆ WIDTH

const qint32 KisTileData::WIDTH = __TILE_DATA_WIDTH

static

Definition at line 311 of file kis_tile_data_interface.h.

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

libs/image/tiles3/kis_tile_data_interface.h
libs/image/tiles3/kis_tile_data.cc
libs/image/tiles3/kis_tile_data.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ EnumTileDataState

Constructor & Destructor Documentation

◆ KisTileData() [1/2]

◆ KisTileData() [2/2]

◆ ~KisTileData()

Member Function Documentation

◆ acquire()

◆ age()

◆ allocateData()

◆ allocateMemory()

◆ blockSwapping()

◆ clone()

◆ data()

◆ deref()

◆ fillWithPixel()

◆ freeData()

◆ historical()

◆ markOld()

◆ mementoed()

◆ numUsers()

◆ pixelSize()

◆ ref()

◆ release()

◆ releaseInternalPools()

◆ releaseMemory()

◆ resetAge()

◆ setData()

◆ setMementoed()

◆ setSwapChunk()

◆ swapChunk()

◆ unblockSwapping()

Friends And Related Symbol Documentation

◆ KisLowMemoryTests

◆ KisTile

◆ KisTileDataPooler

◆ KisTileDataPoolerTest

◆ KisTileDataStore

◆ KisTileDataStoreClockIterator

◆ KisTileDataStoreIterator

◆ KisTileDataStoreReverseIterator

Member Data Documentation

◆ HEIGHT

◆ m_age

◆ m_cache

◆ m_clonesStack

◆ m_data

◆ m_mementoFlag

◆ m_pixelSize

◆ m_refCount

◆ m_state

◆ m_store

◆ m_swapChunk

◆ m_swapLock

◆ m_tileNumber

◆ m_usersCount

◆ WIDTH