/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org

Copyright (c) 2000-2016 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

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. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef _Ogre_MetalStagingBuffer_H_
#define _Ogre_MetalStagingBuffer_H_

#include "OgreMetalPrerequisites.h"

#import <dispatch/dispatch.h>

namespace Ogre
{
    /** A staging buffer is a buffer that resides on the GPU and be written to/from both CPU & GPU
        However the access in both cases is limited. GPUs can only copy (i.e. memcpy) to another
        real buffer (can't be used directly as i.e. texture or vertex buffer) and CPUs can only
        map it.
        In other words, a staging buffer is an intermediate buffer to transfer data between
        CPU & GPU
    */
    class _OgreMetalExport MetalStagingBuffer
    {
        struct Fence
        {
            size_t  start;
            size_t  end;

            Fence( size_t _start, size_t _end ) :
                start( _start ), end( _end )
            {
                assert( _start <= _end );
            }

            bool overlaps( const Fence &fence ) const
            {
                return !( fence.end <= this->start || fence.start >= this->end );
            }

            size_t length(void) const { return end - start; }
        };

    protected:
        id<MTLBuffer>   mVboName;
        void            *mMappedPtr;
        MetalDevice     *mDevice;

        size_t  mInternalBufferStart;
        size_t  mSizeBytes;
        bool    mUploadOnly;

        MappingState    mMappingState;
        size_t          mMappingStart;
        size_t          mMappingCount;

        /** How many bytes between the last fence and our current offset do we need to let
            through before we place another fence?
        @remarks
            When the ring buffer wraps around, a fence is always put.
            A threshold of zero means to put a fence after every unmap operation.
        */
        size_t  mFenceThreshold;

        struct MetalFence : Fence
        {
            dispatch_semaphore_t    fenceName;

            MetalFence( size_t _start, size_t _end ) :
                Fence( _start , _end ), fenceName( 0 )
            {
            }
        };

        //------------------------------------
        // Begin used for uploads
        //------------------------------------
        typedef std::vector<MetalFence> MetalFenceVec;
        MetalFenceVec mFences;

        /// Regions of memory that were unmapped but haven't
        /// been fenced due to not passing the threshold yet.
        MetalFenceVec mUnfencedHazards;
        size_t mUnfencedBytes;
        //------------------------------------
        // End used for uploads
        //------------------------------------

        /** Adds a fence to the region [from; to]. The region may actually be kept in
            mUnfencedHazards until the threshold is achieved or we're forced to fence
            it (i.e. when the internal buffer wraps around)
        @param forceFence
            When true, the region is merged with all the other unfenced hazards, and
            put behind a fence
        */
        void addFence( size_t from, size_t to, bool forceFence );

        void deleteFences( MetalFenceVec::iterator itor, MetalFenceVec::iterator end );

        /// Waits undefinitely on the given GLSync object. Can throw if failed to wait.
        void wait( dispatch_semaphore_t syncObj );

        /// Checks all the fences and compares them against current state (i.e. mMappingStart &
        /// mMappingCount), and stalls if needed (synchronize); also book-keeps mFences and
        /// mUnfencedHazards.
        /// May modify mMappingStart.
        void waitIfNeeded(void);

        virtual void* mapImpl( size_t sizeBytes );

        virtual const void* _mapForReadImpl( size_t offset, size_t sizeBytes );

    public:
        MetalStagingBuffer( size_t internalBufferStart, size_t sizeBytes,
                            bool uploadOnly,
                            id<MTLBuffer> vboName, MetalDevice *device );
        virtual ~MetalStagingBuffer();

        virtual StagingStallType uploadWillStall( size_t sizeBytes );

        void cleanUnfencedHazards(void);
        void _notifyDeviceStalled(void);

        void _unmapToV1( MetalHardwareBufferCommon *hwBuffer, size_t lockStart, size_t lockSize );

        virtual size_t _asyncDownloadV1( MetalHardwareBufferCommon *source,
                                         size_t srcOffset, size_t srcLength );

        id<MTLBuffer> getBufferName(void) const     { return mVboName; }

        const void* _mapForRead( size_t offset, size_t sizeBytes );

        /** Maps the given amount of bytes. May block if not ready.
            @see uploadWillStall if you wish to know.
        @remarks
            Will throw if sizeBytes > this->getMaxSize()
        */
        void* map( size_t sizeBytes );
    };
}

#endif
