Svelto.ECS/DataStructures/Unmanaged/UnsafeBlob.cs

using System;
using System.Runtime.CompilerServices;
using Svelto.Common;

namespace Svelto.ECS.DataStructures
{
    //ToDO to complete in future version of svelto, maybe removed
    public struct UnsafeArrayIndex
    {
        internal uint index;
        internal uint capacity;
    }

    /// <summary>
    ///     Note: this must work inside burst, so it must follow burst restrictions
    ///     Note: All the svelto native structures
    /// </summary>
    struct UnsafeBlob : IDisposable
    {
        internal unsafe byte* ptr { get; set; }

        //expressed in bytes
        internal uint capacity { get; private set; }

        //expressed in bytes
        internal uint size => (uint)_writeIndex - _readIndex;

        //expressed in bytes
        internal uint space => capacity - size;

        /// <summary>
        /// </summary>
        internal Allocator allocator;
        
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal void Write<T>(in T item) where T : struct
        {
            unsafe
            {
                var structSize = (uint) MemoryUtilities.SizeOf<T>();

                //the idea is, considering the wrap, a read pointer must always be behind a writer pointer
#if DEBUG && !PROFILE_SVELTO
                if (space - (int) structSize < 0)
                    throw new Exception("no writing authorized");
#endif
                var writeHead = _writeIndex % capacity;

                if (writeHead + structSize <= capacity)
                {
                    Unsafe.Write(ptr + writeHead, item);
                }
                else
                    //copy with wrap, will start to copy and wrap for the reminder
                {
                    var byteCountToEnd = capacity - writeHead;

                    var localCopyToAvoidGcIssues = item;
                    //read and copy the first portion of Item until the end of the stream
                    Unsafe.CopyBlock(ptr + writeHead, Unsafe.AsPointer(ref localCopyToAvoidGcIssues), (uint)byteCountToEnd);

                    var restCount = structSize - byteCountToEnd;

                    //read and copy the remainder
                    Unsafe.CopyBlock(ptr, (byte*) Unsafe.AsPointer(ref localCopyToAvoidGcIssues) + byteCountToEnd
                                   , (uint)restCount);
                }

                //this is may seems a waste if you are going to use an unsafeBlob just for bytes, but it's necessary for mixed types.
                //it's still possible to use WriteUnaligned though
                int paddedStructSize = (int) MemoryUtilities.Align4(structSize);

                _writeIndex += paddedStructSize;
            }
        }
        
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal void Write<T>(in T item, uint writeIndex) where T : struct
        {
            unsafe
            {
                var  structSize = (uint) MemoryUtilities.SizeOf<T>();

                //the idea is, considering the wrap, a read pointer must always be behind a writer pointer
                var writeHead = writeIndex % capacity;

                if (writeHead + structSize <= capacity)
                {
                    Unsafe.Write(ptr + writeHead, item);
                }
                else //copy with wrap, will start to copy and wrap for the reminder
                {
                    var byteCountToEnd = capacity - writeHead;

                    var localCopyToAvoidGcIssues = item;
                    //read and copy the first portion of Item until the end of the stream
                    Unsafe.CopyBlock(ptr + writeHead, Unsafe.AsPointer(ref localCopyToAvoidGcIssues), byteCountToEnd);

                    var restCount = structSize - byteCountToEnd;

                    //read and copy the remainder
                    Unsafe.CopyBlock(ptr, (byte*) Unsafe.AsPointer(ref localCopyToAvoidGcIssues) + byteCountToEnd
                                   , restCount);
                }
            }
        }

//         [MethodImpl(MethodImplOptions.AggressiveInlining)]
//         //ToDo: remove this and create an UnsafeBlobUnaligned, used on NativeRingBuffer where T cannot change
//         internal void WriteUnaligned<T>(in T item) where T : struct
//         {
//             unsafe
//             {
//                 var structSize = (uint) MemoryUtilities.SizeOf<T>();
//
//                 //the idea is, considering the wrap, a read pointer must always be behind a writer pointer
// #if DEBUG && !PROFILE_SVELTO
//                 if (space - (int) structSize < 0)
//                     throw new Exception("no writing authorized");
// #endif
//                 var pointer = _writeIndex % capacity;
//
//                 if (pointer + structSize <= capacity)
//                 {
//                     Unsafe.Write(ptr + pointer, item);
//                 }
//                 else
//                 {
//                     var byteCount = capacity - pointer;
//
//                     var localCopyToAvoidGCIssues = item;
//
//                     Unsafe.CopyBlockUnaligned(ptr + pointer, Unsafe.AsPointer(ref localCopyToAvoidGCIssues), byteCount);
//
//                     var restCount = structSize - byteCount;
//                     Unsafe.CopyBlockUnaligned(ptr, (byte*) Unsafe.AsPointer(ref localCopyToAvoidGCIssues) + byteCount
//                                             , restCount);
//                 }
//
//                 _writeIndex += structSize;
//             }
//         }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal T Read<T>() where T : struct
        {
            unsafe
            {
                var structSize = (uint) MemoryUtilities.SizeOf<T>();

#if DEBUG && !PROFILE_SVELTO
                if (size < structSize) //are there enough bytes to read?
                    throw new Exception("dequeuing empty queue or unexpected type dequeued");
                if (_readIndex > _writeIndex)
                    throw new Exception("unexpected read");
#endif
                var head             = _readIndex % capacity;
                var paddedStructSize = MemoryUtilities.Align4(structSize);
                _readIndex += paddedStructSize;

                if (_readIndex == _writeIndex)
                {
                    //resetting the Indices has the benefit to let the Reserve work in more occasions and
                    //the rapping happening less often. If the _readIndex reached the _writeIndex, it means
                    //that there is no data left to read, so we can start to write again from the begin of the memory
                    _writeIndex = 0;
                    _readIndex  = 0;
                }

                if (head + paddedStructSize <= capacity)
                    return Unsafe.Read<T>(ptr + head);

                T   item           = default;
                var byteCountToEnd = capacity - head;
                Unsafe.CopyBlock(Unsafe.AsPointer(ref item), ptr + head, byteCountToEnd);

                var restCount = structSize - byteCountToEnd;
                Unsafe.CopyBlock((byte*) Unsafe.AsPointer(ref item) + byteCountToEnd, ptr, restCount);

                return item;
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal ref T Reserve<T>(out UnsafeArrayIndex index) where T : struct
        {
            unsafe
            {
                var sizeOf = (uint) MemoryUtilities.SizeOf<T>();

                ref var buffer = ref Unsafe.AsRef<T>(ptr + _writeIndex);

#if DEBUG && !PROFILE_SVELTO
                if (_writeIndex > capacity)
                    throw new Exception(
                        $"can't reserve if the writeIndex wrapped around the capacity, writeIndex {_writeIndex} capacity {capacity}");
                if (_writeIndex + sizeOf > capacity)
                    throw new Exception("out of bound reserving");
#endif
                index = new UnsafeArrayIndex
                {
                    capacity = capacity
                  , index    = (uint)_writeIndex
                };

                int align4 = (int) MemoryUtilities.Align4(sizeOf);
                _writeIndex += align4;

                return ref buffer;
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal ref T AccessReserved<T>(UnsafeArrayIndex index) where T : struct
        {
            unsafe
            {
#if DEBUG && !PROFILE_SVELTO
                var size = MemoryUtilities.SizeOf<T>();
                if (index.index + size > capacity)
                    throw new Exception($"out of bound access, index {index.index} size {size} capacity {capacity}");
#endif
                return ref Unsafe.AsRef<T>(ptr + index.index);
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal void Realloc(uint newCapacity)
        {
            unsafe
            {
                //be sure it's multiple of 4. Assuming that what we write is aligned to 4, then we will always have aligned wrapped heads
                newCapacity = MemoryUtilities.Align4(newCapacity);

                byte* newPointer = null;
#if DEBUG && !PROFILE_SVELTO
                if (newCapacity <= capacity)
                    throw new Exception("new capacity must be bigger than current");
#endif
                if (newCapacity > 0)
                {
                    newPointer = (byte*) MemoryUtilities.Alloc(newCapacity, allocator);
                    if (size > 0)
                    {
                        var readerHead = _readIndex % capacity;
                        var writerHead = _writeIndex % capacity;

                        if (readerHead < writerHead)
                        {
                            //copy to the new pointer, from th reader position
                            var currentSize = _writeIndex - _readIndex;
                            Unsafe.CopyBlock(newPointer, ptr + readerHead, (uint)currentSize);
                        }
                        //the assumption is that if size > 0 (so readerPointer and writerPointer are not the same)
                        //writerHead wrapped and reached readerHead. so I have to copy from readerHead to the end
                        //and from the start to writerHead (which is the same position of readerHead)
                        else
                        {
                            var byteCountToEnd = capacity - readerHead;

                            Unsafe.CopyBlock(newPointer, ptr + readerHead, byteCountToEnd);
                            Unsafe.CopyBlock(newPointer + byteCountToEnd, ptr, (uint)writerHead);
                        }
                    }
                }

                if (ptr != null)
                    MemoryUtilities.Free((IntPtr) ptr, allocator);

                ptr      = newPointer;
                capacity = newCapacity;
                
                _readIndex  = 0;
                _writeIndex = (int)size;
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void Dispose()
        {
            unsafe
            {
                if (ptr != null)
                    MemoryUtilities.Free((IntPtr) ptr, allocator);

                ptr         = null;
                _writeIndex = 0;
                capacity    = 0;
            }
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void Clear()
        {
            _writeIndex = 0;
            _readIndex  = 0;
        }

        internal int  _writeIndex;
        internal uint _readIndex;
    }
}