o3de/Code/CryEngine/CrySystem/StreamEngine/StreamReadStream.cpp

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

// Description : Streaming Engine


#include "CrySystem_precompiled.h"
#include <ISystem.h>
#include <ILog.h>

#include "StreamReadStream.h"
#include "StreamEngine.h"
#include "MTSafeAllocator.h"

extern CMTSafeHeap* g_pPakHeap;
SLockFreeSingleLinkedListHeader CReadStream::s_freeRequests;

CReadStream* CReadStream::Allocate(CStreamEngine* pEngine, const EStreamTaskType tSource, const char* szFilename, IStreamCallback* pCallback, const StreamReadParams* pParams)
{
    char* pFree = reinterpret_cast<char*>(CryInterlockedPopEntrySList(s_freeRequests));

    CReadStream* pReq;
    IF_LIKELY (pFree)
    {
        AZ_PUSH_DISABLE_WARNING(,"-Winvalid-offsetof")
        ptrdiff_t offs = offsetof(CReadStream, m_nextFree);
        AZ_POP_DISABLE_WARNING
        pReq = reinterpret_cast<CReadStream*>(pFree - offs);
    }
    else
    {
        pReq = new CReadStream;
    }

    pReq->m_pEngine = pEngine;
    pReq->m_Type = tSource;
    pReq->m_strFileName = szFilename;
    pReq->m_pCallback = pCallback;
    if (pParams)
    {
        pReq->m_Params = *pParams;
    }
    pReq->m_pBuffer = pReq->m_Params.pBuffer;

#ifdef STREAMENGINE_ENABLE_STATS
    pReq->m_requestTime = gEnv->pTimer->GetAsyncTime();
#endif

    return pReq;
}

void CReadStream::Flush()
{
    AZ_PUSH_DISABLE_WARNING(, "-Winvalid-offsetof")
    ptrdiff_t offs = offsetof(CReadStream, m_nextFree);
    AZ_POP_DISABLE_WARNING

    for (char* pFree = reinterpret_cast<char*>(CryInterlockedPopEntrySList(s_freeRequests));
         pFree;
         pFree = reinterpret_cast<char*>(CryInterlockedPopEntrySList(s_freeRequests)))
    {
        CReadStream* pReq = reinterpret_cast<CReadStream*>(pFree - offs);
        delete pReq;
    }
}

//////////////////////////////////////////////////////////////////////////
CReadStream::CReadStream()
{
    Reset();
}

//////////////////////////////////////////////////////////////////////////
CReadStream::~CReadStream()
{
}

// returns true if the file read was completed (successfully or unsuccessfully)
// check IsError to check if the whole requested file (piece) was read
bool CReadStream::IsFinished()
{
    return m_bFinished;
}

// returns the number of bytes read so far (the whole buffer size if IsFinished())
unsigned int CReadStream::GetBytesRead ([[maybe_unused]] bool bWait)
{
    if (!m_bError)
    {
        return m_Params.nSize;
    }
    return 0;
}


// returns the buffer into which the data has been or will be read
// at least GetBytesRead() bytes in this buffer are guaranteed to be already read
const void* CReadStream::GetBuffer ()
{
    return m_pBuffer;
}

void CReadStream::AbortShutdown()
{
    {
        CryAutoCriticalSection lock(m_callbackLock);

        m_bError = true;
        m_nIOError = ERROR_ABORTED_ON_SHUTDOWN;
        m_bFileRequestComplete = true;

        if (m_pFileRequest)
        {
            __debugbreak();
        }
    }

    // lock this object to avoid preliminary destruction
    CReadStream_AutoPtr pLock(this);

    {
        CryAutoCriticalSection lock(m_callbackLock);

        // all the callbacks have to handle error cases and needs to be called anyway, even if the stream I/O is aborted
        ExecuteAsyncCallback_CBLocked();
        ExecuteSyncCallback_CBLocked();

        m_pCallback = NULL;
    }
}

// tries to stop reading the stream; this is advisory and may have no effect
// all the callbacks    will be called after this. If you just destructing object,
// dereference this object and it will automatically abort and release all associated resources.
void CReadStream::Abort()
{
    {
        CryAutoCriticalSection lock(m_callbackLock);

        m_bError = true;
        m_nIOError = ERROR_USER_ABORT;
        m_bFileRequestComplete = true;

        if (m_pFileRequest)
        {
            m_pFileRequest->Cancel();
            m_pFileRequest = 0;
        }
    }

    // lock this object to avoid preliminary destruction
    CReadStream_AutoPtr pLock(this);

    {
        CryAutoCriticalSection lock(m_callbackLock);

        // all the callbacks have to handle error cases and needs to be called anyway, even if the stream I/O is aborted
        ExecuteAsyncCallback_CBLocked();
        ExecuteSyncCallback_CBLocked();

        m_pCallback = NULL;
    }

    m_pEngine->AbortJob(this);
}

bool CReadStream::TryAbort()
{
    if (!m_callbackLock.TryLock())
    {
        return false;
    }

    if (m_pFileRequest && !m_pFileRequest->TryCancel())
    {
        m_callbackLock.Unlock();
        return false;
    }

    m_bError = true;
    m_nIOError = ERROR_USER_ABORT;
    m_bFileRequestComplete = true;
    m_pFileRequest = 0;

    // lock this object to avoid preliminary destruction
    CReadStream_AutoPtr pLock(this);

    // all the callbacks have to handle error cases and needs to be called anyway, even if the stream I/O is aborted
    ExecuteAsyncCallback_CBLocked();
    ExecuteSyncCallback_CBLocked();

    m_pCallback = NULL;

    m_callbackLock.Unlock();

    m_pEngine->AbortJob(this);

    return true;
}

// tries to raise the priority of the read; this is advisory and may have no effect
void CReadStream::SetPriority (EStreamTaskPriority ePriority)
{
    if (m_Params.ePriority != ePriority)
    {
        m_Params.ePriority = ePriority;
        if (m_pFileRequest && m_pFileRequest->m_status == CAsyncIOFileRequest::eStatusInFileQueue)
        {
            m_pEngine->UpdateJobPriority(this);
        }
    }
}

// unconditionally waits until the callback is called
// i.e. if the stream hasn't yet finish, it's guaranteed that the user-supplied callback
// is called before return from this function (unless no callback was specified)
void CReadStream::Wait(int nMaxWaitMillis)
{
    // lock this object to avoid preliminary destruction
    CReadStream_AutoPtr pLock(this);

    bool bNeedFinalize = (m_Params.nFlags & IStreamEngine::FLAGS_NO_SYNC_CALLBACK) == 0;

    if (!m_bFinished && !m_bError && !m_pFileRequest)
    {
        assert(m_pFileRequest != NULL);   // If we want to Wait for stream its file request must not be NULL.
        // This will almost certainly cause Dead-Lock
        CryFatalError("Waiting for stream when StreamingEngine is paused");
    }

    CTimeValue t0;

    if (nMaxWaitMillis > 0)
    {
        t0 = gEnv->pTimer->GetAsyncTime();
    }

    while (!m_bFinished && !m_bError)
    {
        if (bNeedFinalize)
        {
            m_pEngine->MainThread_FinalizeIOJobs();
        }
        if (!m_bFileRequestComplete)
        {
            CrySleep(5);
        }

        if (nMaxWaitMillis > 0)
        {
            CTimeValue t1 = gEnv->pTimer->GetAsyncTime();
            if (CTimeValue(t1 - t0).GetMilliSeconds() > nMaxWaitMillis)
            {
                // Break if we are waiting for too long.
                break;
            }
        }
    }
}

//////////////////////////////////////////////////////////////////////////
uint64 CReadStream::GetPriority() const
{
    return 0;
}

// this gets called upon the IO has been executed to call the callbacks
void CReadStream::MainThread_Finalize()
{
    FUNCTION_PROFILER(gEnv->pSystem, PROFILE_SYSTEM);

    // call asynchronous callback function if needed synchronously
    {
        CryAutoCriticalSection lock(m_callbackLock);
        ExecuteSyncCallback_CBLocked();
    }
    m_pFileRequest = 0;
}

IStreamCallback* CReadStream::GetCallback() const
{
    return m_pCallback;
}

unsigned CReadStream::GetError() const
{
    return m_nIOError;
}

const char* CReadStream::GetErrorName() const
{
    switch (m_nIOError)
    {
    case ERROR_UNKNOWN_ERROR:
        return "Unknown error";
    case ERROR_UNEXPECTED_DESTRUCTION:
        return "Unexpected destruction";
    case ERROR_INVALID_CALL:
        return "Invalid call";
    case ERROR_CANT_OPEN_FILE:
        return "Cannot open the file";
    case ERROR_REFSTREAM_ERROR:
        return "Refstream error";
    case ERROR_OFFSET_OUT_OF_RANGE:
        return "Offset out of range";
    case ERROR_REGION_OUT_OF_RANGE:
        return "Region out of range";
    case ERROR_SIZE_OUT_OF_RANGE:
        return "Size out of range";
    case ERROR_CANT_START_READING:
        return "Cannot start reading";
    case ERROR_OUT_OF_MEMORY:
        return "Out of memory";
    case ERROR_ABORTED_ON_SHUTDOWN:
        return "Aborted on shutdown";
    case ERROR_OUT_OF_MEMORY_QUOTA:
        return "Out of memory quota";
    case ERROR_ZIP_CACHE_FAILURE:
        return "ZIP cache failure";
    case ERROR_USER_ABORT:
        return "User aborted";
    }
    return "Unrecognized error";
}

int CReadStream::AddRef()
{
    return CryInterlockedIncrement(&m_nRefCount);
}

int CReadStream::Release()
{
    int nRef = CryInterlockedDecrement(&m_nRefCount);

#ifndef _RELEASE
    if (nRef < 0)
    {
        __debugbreak();
    }
#endif

    if (nRef == 0)
    {
        Reset();
        CryInterlockedPushEntrySList(s_freeRequests, m_nextFree);
    }

    return nRef;
}

void CReadStream::Reset()
{
    m_strFileName.clear();
    m_pFileRequest = NULL;
    m_Params = StreamReadParams();
    memset((void*)&m_nRefCount, 0, (char*)(this + 1) - (char*)(&m_nRefCount));
}

void CReadStream::SetUserData(DWORD_PTR dwUserData)
{
    m_Params.dwUserData = dwUserData;
}

//////////////////////////////////////////////////////////////////////////
void CReadStream::ExecuteAsyncCallback_CBLocked()
{
    FUNCTION_PROFILER(gEnv->pSystem, PROFILE_SYSTEM);

    if (!m_bIsAsyncCallbackExecuted && m_pCallback)
    {
        m_bIsAsyncCallbackExecuted = true;
        m_pCallback->StreamAsyncOnComplete(this, m_nIOError);
    }
}

void CReadStream::ExecuteSyncCallback_CBLocked()
{
    FUNCTION_PROFILER(gEnv->pSystem, PROFILE_SYSTEM);

    if (!m_bIsSyncCallbackExecuted && m_pCallback && (0 == (m_Params.nFlags & IStreamEngine::FLAGS_NO_SYNC_CALLBACK)))
    {
        m_bIsSyncCallbackExecuted = true;

        CReadStream_AutoPtr protectMe(this); // Stream can be freed inside the callback!

        m_pCallback->StreamOnComplete(this, m_nIOError);

        // We do not need FileRequest here anymore, and not its temporary memory.
        m_pFileRequest = 0;
        m_pBuffer = NULL;
        m_bFinished = true;
    }
    else
    {
        m_pFileRequest = 0;
        m_pBuffer = NULL;
        m_bFinished = true;
    }

#ifdef STREAMENGINE_ENABLE_LISTENER
    IStreamEngineListener* pListener = m_pEngine->GetListener();
    if (pListener)
    {
        pListener->OnStreamDone(this);
    }
#endif
}

void* CReadStream::operator new (size_t sz)
{
    return CryModuleMemalign(sz, alignof(CReadStream));
}

void CReadStream::operator delete(void* p)
{
    CryModuleMemalignFree(p);
}

//////////////////////////////////////////////////////////////////////////
void CReadStream::FreeTemporaryMemory()
{
    // Free temporary block.
    if (m_pFileRequest)
    {
        m_pFileRequest->SyncWithDecompress();
        m_pFileRequest->FreeBuffer();
    }
    m_pBuffer = 0;
}

//////////////////////////////////////////////////////////////////////////
bool CReadStream::IsReqReading()
{
    if (m_strFileName.empty())
    {
        return false;
    }
    return true;
}

//////////////////////////////////////////////////////////////////////////
CAsyncIOFileRequest* CReadStream::CreateFileRequest()
{
    m_pFileRequest = CAsyncIOFileRequest::Allocate(m_Type);
    m_pFileRequest->m_nRequestedSize = m_Params.nSize;
    m_pFileRequest->m_nRequestedOffset = m_Params.nOffset;
    m_pFileRequest->m_pExternalMemoryBuffer = m_pBuffer;
    m_pFileRequest->m_bWriteOnlyExternal = (m_Params.nFlags & IStreamEngine::FLAGS_WRITE_ONLY_EXTERNAL_BUFFER) != 0;
    m_pFileRequest->m_pReadStream = this;
    m_pFileRequest->m_strFileName = m_strFileName;
    m_pFileRequest->m_ePriority = m_Params.ePriority;
    m_pFileRequest->m_eMediaType = m_Params.eMediaType;

    m_bFileRequestComplete = false;
    return m_pFileRequest;
}

void* CReadStream::OnNeedStorage(size_t size, bool& bAbortOnFailToAlloc)
{
    CryAutoCriticalSection lock(m_callbackLock);

    if (m_pCallback)
    {
        return m_pCallback->StreamOnNeedStorage(this, size, bAbortOnFailToAlloc);
    }
    return NULL;
}

//////////////////////////////////////////////////////////////////////////
void CReadStream::OnAsyncFileRequestComplete()
{
    CryAutoCriticalSection lock(m_callbackLock);

    if (!m_bFileRequestComplete)
    {
        if (m_pFileRequest)
        {
            m_Params.nSize = m_pFileRequest->m_nRequestedSize;
            m_pBuffer = m_pFileRequest->m_pOutputMemoryBuffer;
            m_nBytesRead = m_pFileRequest->m_nSizeOnMedia;
            m_nIOError = m_pFileRequest->m_nError;
            m_bError = m_nIOError != 0;
            if (m_bError)
            {
                m_nBytesRead = 0;
            }

#ifdef STREAMENGINE_ENABLE_STATS
            m_ReadTime = m_pFileRequest->m_readTime;
#endif
        }

        ExecuteAsyncCallback_CBLocked();

        if (m_Params.nFlags & IStreamEngine::FLAGS_NO_SYNC_CALLBACK)
        {
            // We do not need FileRequest here anymore, and not its temporary memory.
            m_pFileRequest = 0;
            m_bFinished = true;
        }

        m_bFileRequestComplete = true;
    }
}