/******************************************************************************

 *

 * Project:  GDAL Core

 * Purpose:  Store cached blocks

 * Author:   Even Rouault, <even dot rouault at spatialys dot org>

 *

 ******************************************************************************

 * Copyright (c) 2015, Even Rouault <even dot rouault at spatialys dot org>

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#include "cpl_port.h"

#include "gdal_priv.h"

#include <algorithm>

#include <cstddef>

#include <new>

#include "cpl_atomic_ops.h"

#include "cpl_error.h"

#include "cpl_multiproc.h"

#include "gdal_abstractbandblockcache.h"

//! @cond Doxygen_Suppress

#ifdef DEBUG_VERBOSE_ABBC

static int nAllBandsKeptAlivedBlocks = 0;

#endif

/************************************************************************/

/*                       GDALArrayBandBlockCache()                      */

/************************************************************************/

GDALAbstractBandBlockCache::GDALAbstractBandBlockCache(GDALRasterBand *poBandIn)

    : hSpinLock(CPLCreateLock(LOCK_SPIN)), hCond(CPLCreateCond()),

      hCondMutex(CPLCreateMutex()), poBand(poBandIn)

{

    if (hCondMutex)

        CPLReleaseMutex(hCondMutex);

}

/************************************************************************/

/*                      ~GDALAbstractBandBlockCache()                   */

/************************************************************************/

GDALAbstractBandBlockCache::~GDALAbstractBandBlockCache()

{

    CPLAssert(nKeepAliveCounter == 0);

    FreeDanglingBlocks();

    if (hSpinLock)

        CPLDestroyLock(hSpinLock);

    if (hCondMutex)

        CPLDestroyMutex(hCondMutex);

    if (hCond)

        CPLDestroyCond(hCond);

}

/************************************************************************/

/*                            UnreferenceBlockBase()                    */

/*                                                                      */

/*      This is called by GDALRasterBlock::Internalize() and            */

/*      FlushCacheBlock() when they remove a block from the linked list */

/*      but haven't yet flushed it to disk or recovered its pData member*/

/*      We must be aware that they are blocks in that state, since the  */

/*      band must be kept alive while AddBlockToFreeList() hasn't been  */

/*      called (in case a block is being flushed while the final        */

/*      FlushCache() of the main thread of the dataset is running).     */

/************************************************************************/

void GDALAbstractBandBlockCache::UnreferenceBlockBase()

{

    CPLAtomicInc(&nKeepAliveCounter);

}

/************************************************************************/

/*                          AddBlockToFreeList()                        */

/*                                                                      */

/*      This is called by GDALRasterBlock::Internalize() and            */

/*      FlushCacheBlock() after they have been finished with a block.   */

/************************************************************************/

void GDALAbstractBandBlockCache::AddBlockToFreeList(GDALRasterBlock *poBlock)

{

    CPLAssert(poBlock->poPrevious == nullptr);

    CPLAssert(poBlock->poNext == nullptr);

    {

#ifdef DEBUG_VERBOSE_ABBC

        CPLAtomicInc(&nAllBandsKeptAlivedBlocks);

        fprintf(/*ok*/ stderr,

                "AddBlockToFreeList(): nAllBandsKeptAlivedBlocks=%d\n",

                nAllBandsKeptAlivedBlocks);

#endif

        CPLLockHolderOptionalLockD(hSpinLock);

        poBlock->poNext = psListBlocksToFree;

        psListBlocksToFree = poBlock;

    }

    // If no more blocks in transient state, then warn

    // WaitCompletionPendingTasks()

    CPLAcquireMutex(hCondMutex, 1000);

    if (CPLAtomicDec(&nKeepAliveCounter) == 0)

    {

        CPLCondSignal(hCond);

    }

    CPLReleaseMutex(hCondMutex);

}

/************************************************************************/

/*                      WaitCompletionPendingTasks()                    */

/************************************************************************/

void GDALAbstractBandBlockCache::WaitCompletionPendingTasks()

{

#ifdef DEBUG_VERBOSE

    CPLDebug("GDAL", "WaitCompletionPendingTasks()");

#endif

    CPLAcquireMutex(hCondMutex, 1000);

    while (nKeepAliveCounter != 0)

    {

        CPLDebug("GDAL", "Waiting for other thread to finish working with our "

                         "blocks");

        CPLCondWait(hCond, hCondMutex);

    }

    CPLReleaseMutex(hCondMutex);

}

/************************************************************************/

/*                           FreeDanglingBlocks()                       */

/************************************************************************/

void GDALAbstractBandBlockCache::FreeDanglingBlocks()

{

    GDALRasterBlock *poList;

    {

        CPLLockHolderOptionalLockD(hSpinLock);

        poList = psListBlocksToFree;

        psListBlocksToFree = nullptr;

    }

    while (poList)

    {

#ifdef DEBUG_VERBOSE_ABBC

        CPLAtomicDec(&nAllBandsKeptAlivedBlocks);

        fprintf(/*ok*/ stderr,

                "FreeDanglingBlocks(): nAllBandsKeptAlivedBlocks=%d\n",

                nAllBandsKeptAlivedBlocks);

#endif

        GDALRasterBlock *poNext = poList->poNext;

        poList->poNext = nullptr;

        delete poList;

        poList = poNext;

    }

}

/************************************************************************/

/*                            CreateBlock()                             */

/************************************************************************/

GDALRasterBlock *GDALAbstractBandBlockCache::CreateBlock(int nXBlockOff,

                                                         int nYBlockOff)

{

    GDALRasterBlock *poBlock;

    {

        CPLLockHolderOptionalLockD(hSpinLock);

        poBlock = psListBlocksToFree;

        if (poBlock)

        {

#ifdef DEBUG_VERBOSE_ABBC

            CPLAtomicDec(&nAllBandsKeptAlivedBlocks);

            fprintf(/*ok*/ stderr,

                    "CreateBlock(): nAllBandsKeptAlivedBlocks=%d\n",

                    nAllBandsKeptAlivedBlocks);

#endif

            psListBlocksToFree = poBlock->poNext;

        }

    }

    if (poBlock)

        poBlock->RecycleFor(nXBlockOff, nYBlockOff);

    else

        poBlock =

            new (std::nothrow) GDALRasterBlock(poBand, nXBlockOff, nYBlockOff);

    return poBlock;

}

/************************************************************************/

/*                         IncDirtyBlocks()                             */

/************************************************************************/

/**

 * \brief Increment/decrement the number of dirty blocks

 */

void GDALAbstractBandBlockCache::IncDirtyBlocks(int nInc)

{

    CPLAtomicAdd(&m_nDirtyBlocks, nInc);

}

/************************************************************************/

/*                      StartDirtyBlockFlushingLog()                    */

/************************************************************************/

void GDALAbstractBandBlockCache::StartDirtyBlockFlushingLog()

{

    m_nInitialDirtyBlocksInFlushCache = 0;

    if (m_nDirtyBlocks > 0 && CPLIsDefaultErrorHandlerAndCatchDebug())

    {

        if (CPLIsDebugEnabled() &&

            CPLGetConfigOption("GDAL_REPORT_DIRTY_BLOCK_FLUSHING", nullptr) ==

                nullptr)

        {

            m_nInitialDirtyBlocksInFlushCache = m_nDirtyBlocks;

            m_nLastTick = -1;

        }

    }

}

/************************************************************************/

/*                      UpdateDirtyBlockFlushingLog()                   */

/************************************************************************/

void GDALAbstractBandBlockCache::UpdateDirtyBlockFlushingLog()

{

    // Poor man progress report for console applications

    if (m_nInitialDirtyBlocksInFlushCache)

    {

        const auto nRemainingDirtyBlocks = m_nDirtyBlocks;

        const auto nFlushedBlocks =

            m_nInitialDirtyBlocksInFlushCache - nRemainingDirtyBlocks + 1;

        const double dfComplete =

            double(nFlushedBlocks) / m_nInitialDirtyBlocksInFlushCache;

        const int nThisTick =

            std::min(40, std::max(0, static_cast<int>(dfComplete * 40.0)));

        if (nThisTick > m_nLastTick)

        {

            if (m_nLastTick < 0)

            {

                fprintf(stderr, "GDAL: Flushing dirty blocks: "); /*ok*/

                fflush(stderr);                                   /*ok*/

            }

            while (nThisTick > m_nLastTick)

            {

                ++m_nLastTick;

                if (m_nLastTick % 4 == 0)

                    fprintf(stderr, "%d", (m_nLastTick / 4) * 10); /*ok*/

                else

                    fprintf(stderr, "."); /*ok*/

            }

            if (nThisTick == 40)

                fprintf(stderr, " - done.\n"); /*ok*/

            else

                fflush(stderr); /*ok*/

        }

    }

}

/************************************************************************/

/*                       EndDirtyBlockFlushingLog()                     */

/************************************************************************/

void GDALAbstractBandBlockCache::EndDirtyBlockFlushingLog()

{

    m_nInitialDirtyBlocksInFlushCache = 0;

    m_nLastTick = -1;

}

//! @endcond