stgsharp/StgSharp.Common/HighPerformance/Memory/HLSFAllocator.SegmentEntry.cs

//-----------------------------------------------------------------------
// -----------------------------------------------------------------------
// file="HLSFAllocator.SegmentEntry"
// Project: StgSharp
// AuthorGroup: Nitload
// Copyright (c) Nitload. All rights reserved.
//     
// 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.
//     
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
using System;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

namespace StgSharp.HighPerformance.Memory
{
    public unsafe partial class HybridLayerSegregatedFitAllocator
    {

        /// <summary>
        ///   check out if a bucket is within the same higher-level boundary as currentOffset
        /// </summary>
        private bool AssertBoundary(Entry* previous, Entry* current, int level)
        {
            level = int.Min(level, MaxLevel);
            int nextLevelSize = levelSizeArray[level] * 4;
            ulong prevHead = previous->Position - (ulong)m_Buffer,
                currHead = current->Position - (ulong)m_Buffer;
            return (currHead / (ulong)nextLevelSize) == (prevHead / (ulong)nextLevelSize);
        }

        /// <summary>
        ///   Determine segment index based on size and originLevel
        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private int DetermineSegmentIndex(uint size, int level)
        {
            level = int.Min(level, MaxLevel);
            return (int)(size - 1) / levelSizeArray[level];
        }

        /// <summary>
        ///   Check if two Entries are adjacent in memory
        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static bool IsAdjacentTo(Entry* current, Entry* other)
        {
            // Check if this immediately follows other
            return other->Position + other->Size == current->Position ||
                   current->Position + current->Size == other->Position;
        }

        /// <summary>
        ///   Used in Free operations, efficiently remove from buckets and merge adjacent blocks.
        ///   Current Entry will serve as the final merged block. The Merge will be in lazy
        ///   strategy.
        /// </summary>
        private void MergeAndRemoveFromBuckets(Entry* entry)
        {
            // TODO 后续提供HLSF.Collect全量整理API，从头遍历邻接块进行彻底的合并
            if (entry == null)
            {
                return;
            }

            Entry* result = entry;

            uint size = entry->Size;
            int originLevel = entry->Level;
            int segment = DetermineSegmentIndex(size, originLevel);

            do
            {
                // previous direction merge
                Entry* p = entry->PreviousNear;
                if (p == null ||
                    p->State != EntryState.Empty ||
                    !IsAdjacentTo(result, p) ||
                    p->Level != entry->Level ||
                    !AssertBoundary(p, entry, originLevel))
                {
                    break;
                }

                // Console.WriteLine($"{(ulong)p->Size} merged to {(ulong)entry->Size} previous");
                entry->Size += p->Size;
                entry->Position = p->Position;
                RemoveFromBucket(originLevel, DetermineSegmentIndex(p->Size, originLevel), (BucketNode*)p->Position);
                RemoveFromPositionChain(p);
            } while (true);

            do
            {
                // next direction merge
                Entry* n = entry->NextNear;
                if (n == null ||
                    n->State != EntryState.Empty ||
                    !IsAdjacentTo(result, n) ||
                    n->Level != entry->Level ||
                    !AssertBoundary(n, entry, originLevel))
                {
                    break;
                }

                // Console.WriteLine($"{(ulong)n->Size} merged to {(ulong)entry->Size} next");
                entry->Size += n->Size;
                RemoveFromBucket(originLevel, DetermineSegmentIndex(n->Size, originLevel), (BucketNode*)n->Position);
                RemoveFromPositionChain(n);
            } while (true);
            originLevel = int.Min(9, originLevel);
            entry->Level += entry->Size >= levelSizeArray[originLevel] * 4 ? 1 : 0;
            entry->Level &= 15;

            BucketNode* bucket = (BucketNode*)entry->Position;
            bucket->EntryRef = entry;
        }

        /// <summary>
        ///   Remove node from position linked list
        /// </summary>
        private void RemoveFromPositionChain(Entry* entry)
        {
            Entry* prev = entry->PreviousNear;
            Entry* next = entry->NextNear;

            if (prev != null)
            {
                prev->NextNear = entry->NextNear;
            } else
            {
                _positionHead = entry->NextNear;
            }

            if (next != null) {
                next->PreviousNear = entry->PreviousNear;
            }

            // Clear node pointers
            entry->NextNear = null;
            entry->PreviousNear = null;

            // Console.WriteLine("entry recycled.");
            _entries.Free((nuint)entry);
        }

        /// <summary>
        ///   Entry structure - streamlined version (only position and state information) Stored in
        ///   external SLAB
        /// </summary>
        [StructLayout(LayoutKind.Explicit, Size = 36)]
        internal struct Entry
        {

            [FieldOffset(8)]  internal Entry* NextNear;      // Position linked list: next pointer
            [FieldOffset(16)] internal Entry* PreviousNear;  // Position linked list: previous pointer

            [FieldOffset(28)] internal int _Level;           // Level of the block in the allocator
            [FieldOffset(24)] internal uint Size;           // Block size information
            [FieldOffset(32)] public EntryState State;
            [FieldOffset(0)]  public nuint Position;        // Memory block position

            public int Level
            {
                get => _Level;
                set
                {
                    if (value > 15 || value < 0) {
                        throw new InvalidOperationException();
                    }
                    _Level = value;
                }
            }

        }

        internal enum EntryState : uint
        {

            Spare,
            Empty,
            Allocated

        }

        #region Entry Operations

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static bool IsNullOrEmptyEntryIndex(ulong index)
        {
            return index == 0;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static bool IsNullOrEmptyEntryIndex(Entry* entry)
        {
            return entry == null;
        }

        #endregion
    }
}