#if DEBUG && !PROFILE_SVELTO #define ENABLE_DEBUG_CHECKS #endif #if DEBUG && !PROFILE_SVELTO //#define ENABLE_THREAD_SAFE_CHECKS #endif using System; using System.Diagnostics; using System.Runtime.CompilerServices; using Svelto.Common; namespace Svelto.ECS.DataStructures { /// /// Burst friendly RingBuffer on steroid: /// it can: Enqueue/Dequeue, it wraps if there is enough space after dequeuing /// It resizes if there isn't enough space left. /// It's a "bag", you can queue and dequeue any T. Just be sure that you dequeue what you queue! No check on type /// is done. /// You can reserve a position in the queue to update it later. /// The datastructure is a struct and it's "copyable" /// I eventually decided to call it NativeBag and not NativeBag because it can also be used as /// a preallocated memory pool where any kind of T can be stored as long as T is unmanaged /// public struct NativeBag : IDisposable { public uint count { [MethodImpl(MethodImplOptions.AggressiveInlining)] get { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif return _queue->size; #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } } public uint capacity { [MethodImpl(MethodImplOptions.AggressiveInlining)] get { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif return _queue->capacity; #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } } public NativeBag(Allocator allocator) { unsafe { var listData = (UnsafeBlob*) MemoryUtilities.Alloc((uint) 1, allocator); //clear to nullify the pointers //MemoryUtilities.MemClear((IntPtr) listData, (uint) sizeOf); listData->allocator = allocator; _queue = listData; #if ENABLE_THREAD_SAFE_CHECKS _threadSentinel = 0; #endif } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public bool IsEmpty() { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif if (_queue == null || _queue->ptr == null) return true; #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } return count == 0; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public unsafe void Dispose() { if (_queue != null) { #if ENABLE_THREAD_SAFE_CHECKS //todo: this must be unit tested if (Interlocked.CompareExchange(ref _threadSentinel, 1, 0) != 0) throw new Exception("NativeBag is not thread safe, reading and writing operations can happen" + "on different threads, but not simultaneously"); try { #endif _queue->Dispose(); MemoryUtilities.Free((IntPtr) _queue, _queue->allocator); _queue = null; #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public ref T ReserveEnqueue(out UnsafeArrayIndex index) where T : struct { unsafe { BasicTests(); var sizeOf = MemoryUtilities.SizeOf(); if (_queue->space - sizeOf < 0) //Todo: NativeBag is very complicated. At the time of writing of this comment I don't remember if the sizeof really needs to be aligned by 4. To check and change this comment _queue->Realloc((uint) ((_queue->capacity + MemoryUtilities.Align4((uint) sizeOf)) * 2.0f)); #if ENABLE_THREAD_SAFE_CHECKS try { #endif return ref _queue->Reserve(out index); #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Enqueue(in T item) where T : struct { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif var sizeOf = MemoryUtilities.SizeOf(); if (_queue->space - sizeOf < 0) //Todo: NativeBag is very complicated. At the time of writing of this comment I don't remember if the sizeof really needs to be aligned by 4. To check and change this comment _queue->Realloc((uint) ((_queue->capacity + MemoryUtilities.Align4((uint) sizeOf)) * 2.0f)); _queue->Write(item); #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } [MethodImpl(MethodImplOptions.AggressiveInlining)] public void Clear() { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif _queue->Clear(); #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } public T Dequeue() where T : struct { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif return _queue->Read(); #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } internal ref T AccessReserved(UnsafeArrayIndex reserverIndex) where T : struct { unsafe { BasicTests(); #if ENABLE_THREAD_SAFE_CHECKS try { #endif return ref _queue->AccessReserved(reserverIndex); #if ENABLE_THREAD_SAFE_CHECKS } finally { Volatile.Write(ref _threadSentinel, 0); } #endif } } [Conditional("ENABLE_DEBUG_CHECKS")] unsafe void BasicTests() { if (_queue == null) throw new Exception("SimpleNativeArray: null-access"); #if ENABLE_THREAD_SAFE_CHECKS todo: this must be unit tested if (Interlocked.CompareExchange(ref _threadSentinel, 1, 0) != 0) throw new Exception("NativeBag is not thread safe, reading and writing operations can happen" + "on different threads, but not simultaneously"); #endif } #if ENABLE_THREAD_SAFE_CHECKS int _threadSentinel; #endif #if UNITY_COLLECTIONS || UNITY_JOBS || UNITY_BURST [global::Unity.Collections.LowLevel.Unsafe.NativeDisableUnsafePtrRestriction] #endif unsafe UnsafeBlob* _queue; } }