/*     Copyright 2015-2018 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF ANY PROPRIETARY RIGHTS.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#pragma once

#include "Atomics.h"
#include "BasicTypes.h"
#include "ReferenceCounters.h"
#include "RefCntAutoPtr.h"

namespace Diligent
{

/// Base implementation of the device context for next-generation backends.

template<class TBase>
class DeviceContextNextGenBase : public TBase
{
public:
    DeviceContextNextGenBase(IReferenceCounters* pRefCounters,
                             IRenderDevice*      pRenderDevice,
                             Uint32              ContextId,
                             Uint32              CommandQueueId,
                             Uint32              NumCommandsToFlush,
                             bool                bIsDeferred) :
        TBase(pRefCounters,
              pRenderDevice,
              bIsDeferred),
        m_ContextId                   (ContextId),
        m_CommandQueueId              (CommandQueueId),
        m_ContextFrameNumber          (0),
        m_NumCommandsToFlush          (NumCommandsToFlush),
        m_SubmittedBuffersCmdQueueMask(bIsDeferred ? 0 : Uint64{1} << Uint64{CommandQueueId})
    {
    }

    ~DeviceContextNextGenBase()
    {
    }

protected:

    // Should be called at the end of FinishFrame()
    template<typename RenderDeviceImplType>
    void EndFrame(RenderDeviceImplType& RenderDeviceImpl)
    {
        if (m_bIsDeferred)
        {
            // For deferred context, reset submitted cmd queue mask
            m_SubmittedBuffersCmdQueueMask = 0;
        }
        else
        {
            RenderDeviceImpl.FlushStaleResources(m_CommandQueueId);
        }
        Atomics::AtomicIncrement(m_ContextFrameNumber);
    }

    const Uint32 m_ContextId;
    const Uint32 m_CommandQueueId;
    const Uint32 m_NumCommandsToFlush;
    Atomics::AtomicInt64 m_ContextFrameNumber;

    // This mask indicates which command queues command buffers from this context were submitted to.
    // For immediate context, this will always be 1 << m_CommandQueueId. 
    // For deferred contexts, this will accumulate bits of the queues to which command buffers
    // were submitted to before FinishFrame() was called. This mask is used to release resources
    // allocated by the context during the frame when FinishFrame() is called.
    Uint64 m_SubmittedBuffersCmdQueueMask = 0;
};

}
