#include <kis_tile_hash_table2.h>

Classes
struct	MemoryReclaimer

Public Types
typedef T	TileType

typedef KisSharedPtr< T >	TileTypeSP

typedef KisWeakSharedPtr< T >	TileTypeWSP

Public Member Functions
void	addTile (TileTypeSP tile)

void	clear ()

void	debugMaxListLength (qint32 &min, qint32 &max)

void	debugPrintInfo ()

KisTileData *	defaultTileData ()

bool	deleteTile (qint32 col, qint32 row)

bool	deleteTile (TileTypeSP tile)

TileTypeSP	getExistingTile (qint32 col, qint32 row)

TileTypeSP	getReadOnlyTileLazy (qint32 col, qint32 row, bool &existingTile)

TileTypeSP	getTileLazy (qint32 col, qint32 row, bool &newTile)

bool	isEmpty ()

	KisTileHashTableTraits2 (const KisTileHashTableTraits2< T > &ht, KisMementoManager *mm)

	KisTileHashTableTraits2 (KisMementoManager *mm)

qint32	numTiles ()

KisTileData *	refAndFetchDefaultTileData ()

void	setDefaultTileData (KisTileData *defaultTileData)

bool	tileExists (qint32 col, qint32 row)

	~KisTileHashTableTraits2 ()

Private Types
typedef ConcurrentMap< quint32, TileType * >	LockFreeTileMap

typedef LockFreeTileMap::Mutator	LockFreeTileMapMutator

Private Member Functions
quint32	calculateHash (qint32 col, qint32 row)

quint32	calculateHashImpl (qint32 col, qint32 row)

quint32	calculateHashSafe (qint32 col, qint32 row)

bool	erase (quint32 idx)

void	insert (quint32 idx, TileTypeSP item)

	Q_STATIC_ASSERT_X (isInherited, "Template must inherit KisShared")

Private Attributes
QReadWriteLock	m_defaultPixelDataLock

KisTileData *	m_defaultTileData

QReadWriteLock	m_iteratorLock

LockFreeTileMap	m_map

KisMementoManager *	m_mementoManager

QAtomicInt	m_numTiles

Static Private Attributes
static constexpr bool	isInherited = std::is_convertible<T, KisShared>::value

Friends
class	KisTileHashTableIteratorTraits2< T >

Detailed Description

template<class T>
class KisTileHashTableTraits2< T >

Definition at line 35 of file kis_tile_hash_table2.h.

Member Typedef Documentation

◆ LockFreeTileMap

template<class T >

typedef ConcurrentMap<quint32, TileType*> KisTileHashTableTraits2< T >::LockFreeTileMap

private

Definition at line 200 of file kis_tile_hash_table2.h.

◆ LockFreeTileMapMutator

template<class T >

typedef LockFreeTileMap::Mutator KisTileHashTableTraits2< T >::LockFreeTileMapMutator

private

Definition at line 201 of file kis_tile_hash_table2.h.

◆ TileType

template<class T >

typedef T KisTileHashTableTraits2< T >::TileType

Definition at line 41 of file kis_tile_hash_table2.h.

◆ TileTypeSP

template<class T >

typedef KisSharedPtr<T> KisTileHashTableTraits2< T >::TileTypeSP

Definition at line 42 of file kis_tile_hash_table2.h.

◆ TileTypeWSP

template<class T >

typedef KisWeakSharedPtr<T> KisTileHashTableTraits2< T >::TileTypeWSP

Definition at line 43 of file kis_tile_hash_table2.h.

Constructor & Destructor Documentation

◆ KisTileHashTableTraits2() [1/2]

template<class T >

KisTileHashTableTraits2< T >::KisTileHashTableTraits2 ( KisMementoManager * mm )

Definition at line 272 of file kis_tile_hash_table2.h.

    : m_numTiles(0), m_defaultTileData(0), m_mementoManager(mm)
{
}

◆ KisTileHashTableTraits2() [2/2]

template<class T >

KisTileHashTableTraits2< T >::KisTileHashTableTraits2	(	const KisTileHashTableTraits2< T > &	ht,
		KisMementoManager *	mm )

Definition at line 278 of file kis_tile_hash_table2.h.

    : KisTileHashTableTraits2(mm)
{
    setDefaultTileData(ht.m_defaultTileData);
 
    QWriteLocker locker(&ht.m_iteratorLock);
    typename ConcurrentMap<quint32, TileType*>::Iterator iter(ht.m_map);
 
    while (iter.isValid()) {
        TileTypeSP tile = new TileType(*iter.getValue(), m_mementoManager);
        insert(iter.getKey(), tile);
        iter.next();
    }
}

References ConcurrentMap< K, V, KT, VT >::Iterator::getKey(), ConcurrentMap< K, V, KT, VT >::Iterator::getValue(), KisTileHashTableTraits2< T >::insert(), ConcurrentMap< K, V, KT, VT >::Iterator::isValid(), KisTileHashTableTraits2< T >::m_defaultTileData, KisTileHashTableTraits2< T >::m_iteratorLock, KisTileHashTableTraits2< T >::m_map, KisTileHashTableTraits2< T >::m_mementoManager, ConcurrentMap< K, V, KT, VT >::Iterator::next(), and KisTileHashTableTraits2< T >::setDefaultTileData().

◆ ~KisTileHashTableTraits2()

template<class T >

KisTileHashTableTraits2< T >::~KisTileHashTableTraits2 ( )

Definition at line 294 of file kis_tile_hash_table2.h.

{
    clear();
    setDefaultTileData(0);
}

Member Function Documentation

◆ addTile()

template<class T >

void KisTileHashTableTraits2< T >::addTile ( TileTypeSP tile )

Definition at line 437 of file kis_tile_hash_table2.h.

{
    quint32 idx = calculateHash(tile->col(), tile->row());
    insert(idx, tile);
}

◆ calculateHash()

template<class T >

quint32 KisTileHashTableTraits2< T >::calculateHash	(	qint32	col,
		qint32	row )

inlineprivate

Definition at line 136 of file kis_tile_hash_table2.h.

    {
#ifdef SANITY_CHECK
        KIS_ASSERT_RECOVER_NOOP(qAbs(row) < 0x7FFF && qAbs(col) < 0x7FFF);
#endif // SANITY_CHECK
 
        return calculateHashImpl(col, row);
    }

References KisTileHashTableTraits2< T >::calculateHashImpl(), and KIS_ASSERT_RECOVER_NOOP.

◆ calculateHashImpl()

template<class T >

quint32 KisTileHashTableTraits2< T >::calculateHashImpl	(	qint32	col,
		qint32	row )

inlineprivate

Definition at line 126 of file kis_tile_hash_table2.h.

    {
        if (col == 0 && row == 0) {
            col = 0x7FFF;
            row = 0x7FFF;
        }
 
        return ((static_cast<quint32>(row) << 16) | (static_cast<quint32>(col) & 0xFFFF));
    }

◆ calculateHashSafe()

template<class T >

quint32 KisTileHashTableTraits2< T >::calculateHashSafe	(	qint32	col,
		qint32	row )

inlineprivate

A version of the hash function that returns an invalid hash in case the requested tile is out of range

Definition at line 149 of file kis_tile_hash_table2.h.

    {
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(qAbs(row) < 0x7FFF && qAbs(col) < 0x7FFF, 0);
        return calculateHashImpl(col, row);
    }

References KisTileHashTableTraits2< T >::calculateHashImpl(), and KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

◆ clear()

template<class T >

void KisTileHashTableTraits2< T >::clear ( )

Definition at line 462 of file kis_tile_hash_table2.h.

{
    {
        QWriteLocker locker(&m_iteratorLock);
 
        typename ConcurrentMap<quint32, TileType*>::Iterator iter(m_map);
        TileType *tile = 0;
 
        while (iter.isValid()) {
            m_map.getGC().lockRawPointerAccess();
            tile = m_map.erase(iter.getKey());
 
            if (tile) {
                tile->notifyDetachedFromDataManager();
                m_map.getGC().enqueue(&MemoryReclaimer::destroy, new MemoryReclaimer(tile));
            }
            m_map.getGC().unlockRawPointerAccess();
 
            iter.next();
        }
 
        m_numTiles.storeRelaxed(0);
    }
 
    // garbage collection must **not** be run with locks held
    m_map.getGC().update();
}

References ConcurrentMap< K, V, KT, VT >::Iterator::getKey(), ConcurrentMap< K, V, KT, VT >::Iterator::isValid(), and ConcurrentMap< K, V, KT, VT >::Iterator::next().

◆ debugMaxListLength()

template<class T >

void KisTileHashTableTraits2< T >::debugMaxListLength	(	qint32 &	min,
		qint32 &	max )

Definition at line 528 of file kis_tile_hash_table2.h.

529{

530}

◆ debugPrintInfo()

template<class T >

void KisTileHashTableTraits2< T >::debugPrintInfo ( )

Definition at line 523 of file kis_tile_hash_table2.h.

524{

525}

◆ defaultTileData()

template<class T >

KisTileData * KisTileHashTableTraits2< T >::defaultTileData ( )

inline

Definition at line 507 of file kis_tile_hash_table2.h.

{
    QReadLocker locker(&m_defaultPixelDataLock);
    return m_defaultTileData;
}

◆ deleteTile() [1/2]

template<class T >

bool KisTileHashTableTraits2< T >::deleteTile	(	qint32	col,
		qint32	row )

when invalid tile index is requested, just do nothing

Definition at line 450 of file kis_tile_hash_table2.h.

{
    const quint32 idx = calculateHashSafe(col, row);
    if (!idx) {
        return false;
    }
 
    return erase(idx);
}

◆ deleteTile() [2/2]

template<class T >

bool KisTileHashTableTraits2< T >::deleteTile ( TileTypeSP tile )

Definition at line 444 of file kis_tile_hash_table2.h.

{
    return deleteTile(tile->col(), tile->row());
}

◆ erase()

template<class T >

bool KisTileHashTableTraits2< T >::erase ( quint32 idx )

inlineprivate

Definition at line 178 of file kis_tile_hash_table2.h.

    {
        m_map.getGC().lockRawPointerAccess();
 
        bool wasDeleted = false;
        TileType *tile = m_map.erase(idx);
 
        if (tile) {
            tile->notifyDetachedFromDataManager();
 
            wasDeleted = true;
            m_numTiles.fetchAndSubRelaxed(1);
            m_map.getGC().enqueue(&MemoryReclaimer::destroy, new MemoryReclaimer(tile));
        }
 
        m_map.getGC().unlockRawPointerAccess();
 
        m_map.getGC().update();
        return wasDeleted;
    }

References KisTileHashTableTraits2< T >::MemoryReclaimer::destroy(), QSBR::enqueue(), ConcurrentMap< K, V, KT, VT >::erase(), ConcurrentMap< K, V, KT, VT >::getGC(), QSBR::lockRawPointerAccess(), KisTileHashTableTraits2< T >::m_map, KisTileHashTableTraits2< T >::m_numTiles, QSBR::unlockRawPointerAccess(), and QSBR::update().

◆ getExistingTile()

template<class T >

KisTileHashTableTraits2< T >::TileTypeSP KisTileHashTableTraits2< T >::getExistingTile	(	qint32	col,
		qint32	row )

Returns a tile in position (col,row). If no tile exists, returns null.

Parameters

col	column of the tile
row	row of the tile

a tile with invalid index obviously doesn't exist

Definition at line 307 of file kis_tile_hash_table2.h.

{
    const quint32 idx = calculateHashSafe(col, row);
    if (!idx) {
        return TileTypeSP();
    }
 
    m_map.getGC().lockRawPointerAccess();
    TileTypeSP tile = m_map.get(idx);
    m_map.getGC().unlockRawPointerAccess();
 
    m_map.getGC().update();
    return tile;
}

◆ getReadOnlyTileLazy()

template<class T >

KisTileHashTableTraits2< T >::TileTypeSP KisTileHashTableTraits2< T >::getReadOnlyTileLazy	(	qint32	col,
		qint32	row,
		bool &	existingTile )

Returns a tile in position (col,row). If no tile exists, creates nothing, but returns shared default tile object of the table. Be careful, this object has column and row parameters set to (qint32_MIN, qint32_MIN).

Parameters

col	column of the tile
row	row of the tile
existingTile	returns true if the tile actually exists in the table and it is not a lazily created default wrapper tile

when invalid tile index is requested, just return a detached tile with the default data

we pretend as if this tile hasn't existed, it will allow the calling code to avoid modifying the extent manager (note, that is opposite to what happens in getTileLazy())

Definition at line 404 of file kis_tile_hash_table2.h.

{
    const quint32 idx = calculateHashSafe(col, row);
    if (!idx) {
 
        existingTile = false;
 
        QReadLocker locker(&m_defaultPixelDataLock);
        return new TileType(col, row, m_defaultTileData, 0);
    }
 
    m_map.getGC().lockRawPointerAccess();
    TileTypeSP tile = m_map.get(idx);
    m_map.getGC().unlockRawPointerAccess();
 
    existingTile = tile;
 
    if (!existingTile) {
        QReadLocker locker(&m_defaultPixelDataLock);
        tile = new TileType(col, row, m_defaultTileData, 0);
    }
 
    m_map.getGC().update();
    return tile;
}

◆ getTileLazy()

template<class T >

KisTileHashTableTraits2< T >::TileTypeSP KisTileHashTableTraits2< T >::getTileLazy	(	qint32	col,
		qint32	row,
		bool &	newTile )

Returns a tile in position (col,row). If no tile exists, creates a new one, attaches it to the list and returns.

Parameters

col	column of the tile
row	row of the tile
newTile	out-parameter, returns true if a new tile was created

when invalid tile index is requested, just return a detached tile with the default data

we pretend as if this tile has already existed, it will allow the calling code to avoid modifying the extent manager

Definition at line 324 of file kis_tile_hash_table2.h.

{
    newTile = false;
    const quint32 idx = calculateHashSafe(col, row);
    if (!idx) {
 
        newTile = false;
 
        QReadLocker locker(&m_defaultPixelDataLock);
        return new TileType(col, row, m_defaultTileData, 0);
    }
 
    // we are going to assign a raw-pointer tile from the table
    // to a shared pointer...
    m_map.getGC().lockRawPointerAccess();
 
    TileTypeSP tile = m_map.get(idx);
 
    while (!tile) {
        // we shouldn't try to acquire **any** lock with
        // raw-pointer lock held
        m_map.getGC().unlockRawPointerAccess();
 
        {
            QReadLocker locker(&m_defaultPixelDataLock);
            tile = new TileType(col, row, m_defaultTileData, 0);
        }
 
        TileTypeSP::ref(&tile, tile.data());
        TileType *discardedTile = 0;
 
        // iterator lock should be taken **before**
        // the pointers are locked
        m_iteratorLock.lockForRead();
 
        // and now lock raw-pointers again
        m_map.getGC().lockRawPointerAccess();
 
        // mutator might have become invalidated when
        // we released raw pointers, so we need to reinitialize it
        LockFreeTileMapMutator mutator = m_map.insertOrFind(idx);
        if (!mutator.getValue()) {
            discardedTile = mutator.exchangeValue(tile.data());
        } else {
            discardedTile = tile.data();
        }
 
        m_iteratorLock.unlock();
 
        if (discardedTile) {
            // we've got our tile back, it didn't manage to
            // get into the table. Now release the allocated
            // tile and push TO/GA switch.
            tile = 0;
 
            discardedTile->notifyDeadWithoutDetaching();
            m_map.getGC().enqueue(&MemoryReclaimer::destroy, new MemoryReclaimer(discardedTile));
 
            tile = m_map.get(idx);
            continue;
 
        } else {
            newTile = true;
            m_numTiles.fetchAndAddRelaxed(1);
 
            tile->notifyAttachedToDataManager(m_mementoManager);
        }
    }
    m_map.getGC().unlockRawPointerAccess();
 
    m_map.getGC().update();
    return tile;
}

References KisSharedPtr< T >::data(), and newTile().

◆ insert()

template<class T >

void KisTileHashTableTraits2< T >::insert	(	quint32	idx,
		TileTypeSP	item )

inlineprivate

Definition at line 155 of file kis_tile_hash_table2.h.

    {
        TileTypeSP::ref(&item, item.data());
        TileType *tile = 0;
 
        {
            QReadLocker locker(&m_iteratorLock);
            m_map.getGC().lockRawPointerAccess();
            tile = m_map.assign(idx, item.data());
        }
 
        if (tile) {
            tile->notifyDeadWithoutDetaching();
            m_map.getGC().enqueue(&MemoryReclaimer::destroy, new MemoryReclaimer(tile));
        } else {
            m_numTiles.fetchAndAddRelaxed(1);
        }
 
        m_map.getGC().unlockRawPointerAccess();
 
        m_map.getGC().update();
    }

References ConcurrentMap< K, V, KT, VT >::assign(), KisSharedPtr< T >::data(), KisTileHashTableTraits2< T >::MemoryReclaimer::destroy(), QSBR::enqueue(), ConcurrentMap< K, V, KT, VT >::getGC(), QSBR::lockRawPointerAccess(), KisTileHashTableTraits2< T >::m_iteratorLock, KisTileHashTableTraits2< T >::m_map, KisTileHashTableTraits2< T >::m_numTiles, KisSharedPtr< T >::ref(), QSBR::unlockRawPointerAccess(), and QSBR::update().

◆ isEmpty()

template<class T >

bool KisTileHashTableTraits2< T >::isEmpty ( )

inline

Definition at line 49 of file kis_tile_hash_table2.h.

    {
        return !m_numTiles.loadRelaxed();
    }

References KisTileHashTableTraits2< T >::m_numTiles.

◆ numTiles()

template<class T >

qint32 KisTileHashTableTraits2< T >::numTiles ( )

inline

Definition at line 102 of file kis_tile_hash_table2.h.

    {
        return m_numTiles.loadRelaxed();
    }

References KisTileHashTableTraits2< T >::m_numTiles.

◆ Q_STATIC_ASSERT_X()

template<class T >

KisTileHashTableTraits2< T >::Q_STATIC_ASSERT_X	(	isInherited	,
		"Template must inherit KisShared"	)

private

◆ refAndFetchDefaultTileData()

template<class T >

KisTileData * KisTileHashTableTraits2< T >::refAndFetchDefaultTileData ( )

inline

Returns a pointer to the default tile data object with ref counter increased by one. Make sure you call deref() after you finished using this object.

Definition at line 514 of file kis_tile_hash_table2.h.

{
    QReadLocker locker(&m_defaultPixelDataLock);
    m_defaultTileData->ref();
    return m_defaultTileData;
}

◆ setDefaultTileData()

template<class T >

void KisTileHashTableTraits2< T >::setDefaultTileData ( KisTileData * defaultTileData )

inline

Definition at line 491 of file kis_tile_hash_table2.h.

{
    QWriteLocker locker(&m_defaultPixelDataLock);
 
    if (m_defaultTileData) {
        m_defaultTileData->release();
        m_defaultTileData = 0;
    }
 
    if (defaultTileData) {
        defaultTileData->acquire();
        m_defaultTileData = defaultTileData;
    }
}

References KisTileData::acquire().

◆ tileExists()

template<class T >

bool KisTileHashTableTraits2< T >::tileExists	(	qint32	col,
		qint32	row )

Definition at line 301 of file kis_tile_hash_table2.h.

{
    return getExistingTile(col, row);
}

Friends And Related Symbol Documentation

◆ KisTileHashTableIteratorTraits2< T >

template<class T >

friend class KisTileHashTableIteratorTraits2< T >

friend

Definition at line 108 of file kis_tile_hash_table2.h.

Member Data Documentation

◆ isInherited

template<class T >

constexpr bool KisTileHashTableTraits2< T >::isInherited = std::is_convertible<T*, KisShared*>::value

staticconstexprprivate

Definition at line 37 of file kis_tile_hash_table2.h.

◆ m_defaultPixelDataLock

template<class T >

QReadWriteLock KisTileHashTableTraits2< T >::m_defaultPixelDataLock

private

We still need something to guard changes in m_defaultTileData, otherwise there will be concurrent read/writes, resulting in broken memory.

Definition at line 208 of file kis_tile_hash_table2.h.

◆ m_defaultTileData

template<class T >

KisTileData* KisTileHashTableTraits2< T >::m_defaultTileData

private

Definition at line 212 of file kis_tile_hash_table2.h.

◆ m_iteratorLock

template<class T >

QReadWriteLock KisTileHashTableTraits2< T >::m_iteratorLock

mutableprivate

Definition at line 209 of file kis_tile_hash_table2.h.

◆ m_map

template<class T >

LockFreeTileMap KisTileHashTableTraits2< T >::m_map

mutableprivate

Definition at line 202 of file kis_tile_hash_table2.h.

◆ m_mementoManager

template<class T >

KisMementoManager* KisTileHashTableTraits2< T >::m_mementoManager

private

Definition at line 213 of file kis_tile_hash_table2.h.

◆ m_numTiles

template<class T >

QAtomicInt KisTileHashTableTraits2< T >::m_numTiles

private

Definition at line 211 of file kis_tile_hash_table2.h.

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

libs/image/tiles3/kis_tile_hash_table2.h

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ LockFreeTileMap

◆ LockFreeTileMapMutator

◆ TileType

◆ TileTypeSP

◆ TileTypeWSP

Constructor & Destructor Documentation

◆ KisTileHashTableTraits2() [1/2]

◆ KisTileHashTableTraits2() [2/2]

◆ ~KisTileHashTableTraits2()

Member Function Documentation

◆ addTile()

◆ calculateHash()

◆ calculateHashImpl()

◆ calculateHashSafe()

◆ clear()

◆ debugMaxListLength()

◆ debugPrintInfo()

◆ defaultTileData()

◆ deleteTile() [1/2]

◆ deleteTile() [2/2]

◆ erase()

◆ getExistingTile()

◆ getReadOnlyTileLazy()

◆ getTileLazy()

◆ insert()

◆ isEmpty()

◆ numTiles()

◆ Q_STATIC_ASSERT_X()

◆ refAndFetchDefaultTileData()

◆ setDefaultTileData()

◆ tileExists()

Friends And Related Symbol Documentation

◆ KisTileHashTableIteratorTraits2< T >

Member Data Documentation

◆ isInherited

◆ m_defaultPixelDataLock

◆ m_defaultTileData

◆ m_iteratorLock

◆ m_map

◆ m_mementoManager

◆ m_numTiles