Zero/ZeroLevel/Services/FASTER/Allocator/GenericFrame.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System;

namespace FASTER.core
{
    /// <summary>
    /// A frame is an in-memory circular buffer of log pages
    /// </summary>
    internal sealed class GenericFrame<Key, Value> : IDisposable
    {
        private readonly Record<Key, Value>[][] frame;
        public readonly int frameSize, pageSize;
        private readonly int recordSize = Utility.GetSize(default(Record<Key, Value>));

        public GenericFrame(int frameSize, int pageSize)
        {
            this.frameSize = frameSize;
            this.pageSize = pageSize;
            frame = new Record<Key, Value>[frameSize][];
        }

        public void Allocate(int index)
        {
            Record<Key, Value>[] tmp;
            if (pageSize % recordSize == 0)
                tmp = new Record<Key, Value>[pageSize / recordSize];
            else
                tmp = new Record<Key, Value>[1 + (pageSize / recordSize)];
            Array.Clear(tmp, 0, tmp.Length);
            frame[index] = tmp;
        }

        public void Clear(int pageIndex)
        {
            Array.Clear(frame[pageIndex], 0, frame[pageIndex].Length);
        }

        public ref Key GetKey(long frameNumber, long offset)
        {
            return ref frame[frameNumber][offset].key;
        }

        public ref Value GetValue(long frameNumber, long offset)
        {
            return ref frame[frameNumber][offset].value;
        }

        public ref RecordInfo GetInfo(long frameNumber, long offset)
        {
            return ref frame[frameNumber][offset].info;
        }

        public ref Record<Key, Value>[] GetPage(long frameNumber)
        {
            return ref frame[frameNumber];
        }

        public void Dispose()
        {
            Array.Clear(frame, 0, frame.Length);
        }
    }
}