File: src\Shared\Buffers.MemoryPool\MemoryPoolThrowHelper.cs
Web Access
Project: src\src\Servers\Kestrel\test\InMemory.FunctionalTests\InMemory.FunctionalTests.csproj (InMemory.FunctionalTests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Diagnostics;
using System.Runtime.CompilerServices;
using System.Text;
 
namespace System.Buffers;
 
internal sealed class MemoryPoolThrowHelper
{
    public static void ThrowArgumentOutOfRangeException(int sourceLength, int offset)
    {
        throw GetArgumentOutOfRangeException(sourceLength, offset);
    }
 
    [MethodImpl(MethodImplOptions.NoInlining)]
    private static ArgumentOutOfRangeException GetArgumentOutOfRangeException(int sourceLength, int offset)
    {
        if ((uint)offset > (uint)sourceLength)
        {
            // Offset is negative or less than array length
            return new ArgumentOutOfRangeException(GetArgumentName(ExceptionArgument.offset));
        }
 
        // The third parameter (not passed) length must be out of range
        return new ArgumentOutOfRangeException(GetArgumentName(ExceptionArgument.length));
    }
 
    public static void ThrowInvalidOperationException_PinCountZero(DiagnosticPoolBlock block)
    {
        throw new InvalidOperationException(GenerateMessage("Can't unpin, pin count is zero", block));
    }
 
    public static void ThrowInvalidOperationException_ReturningPinnedBlock(DiagnosticPoolBlock block)
    {
        throw new InvalidOperationException(GenerateMessage("Disposing pinned block", block));
    }
 
    public static void ThrowInvalidOperationException_DoubleDispose()
    {
        throw new InvalidOperationException("Object is being disposed twice");
    }
 
    public static void ThrowInvalidOperationException_BlockDoubleDispose(DiagnosticPoolBlock block)
    {
        throw new InvalidOperationException(GenerateMessage("Block is being disposed twice", block));
    }
 
    public static void ThrowInvalidOperationException_BlockReturnedToDisposedPool(DiagnosticPoolBlock block)
    {
        throw new InvalidOperationException(GenerateMessage("Block is being returned to disposed pool", block));
    }
 
    public static void ThrowInvalidOperationException_BlockIsBackedByDisposedSlab(DiagnosticPoolBlock block)
    {
        throw new InvalidOperationException(GenerateMessage("Block is backed by disposed slab", block));
    }
 
    public static void ThrowInvalidOperationException_DisposingPoolWithActiveBlocks(int returned, int total, DiagnosticPoolBlock[] blocks)
    {
        throw new InvalidOperationException(GenerateMessage($"Memory pool with active blocks is being disposed, {returned} of {total} returned", blocks));
    }
 
    public static void ThrowInvalidOperationException_BlocksWereNotReturnedInTime(int returned, int total, DiagnosticPoolBlock[] blocks)
    {
        throw new InvalidOperationException(GenerateMessage($"Blocks were not returned in time, {returned} of {total} returned ", blocks));
    }
 
    private static string GenerateMessage(string message, params DiagnosticPoolBlock[] blocks)
    {
        StringBuilder builder = new StringBuilder(message);
        foreach (var diagnosticPoolBlock in blocks)
        {
            if (diagnosticPoolBlock.Leaser != null)
            {
                builder.AppendLine();
 
                builder.AppendLine("Block leased from:");
                builder.AppendLine(diagnosticPoolBlock.Leaser.ToString());
            }
        }
 
        return builder.ToString();
    }
 
    public static void ThrowArgumentOutOfRangeException_BufferRequestTooLarge(int maxSize)
    {
        throw GetArgumentOutOfRangeException_BufferRequestTooLarge(maxSize);
    }
 
    public static void ThrowObjectDisposedException(ExceptionArgument argument)
    {
        throw GetObjectDisposedException(argument);
    }
 
    [MethodImpl(MethodImplOptions.NoInlining)]
    private static ArgumentOutOfRangeException GetArgumentOutOfRangeException_BufferRequestTooLarge(int maxSize)
    {
        return new ArgumentOutOfRangeException(GetArgumentName(ExceptionArgument.size), $"Cannot allocate more than {maxSize} bytes in a single buffer");
    }
 
    [MethodImpl(MethodImplOptions.NoInlining)]
    private static ObjectDisposedException GetObjectDisposedException(ExceptionArgument argument)
    {
        return new ObjectDisposedException(GetArgumentName(argument));
    }
 
    private static string GetArgumentName(ExceptionArgument argument)
    {
        Debug.Assert(Enum.IsDefined(typeof(ExceptionArgument), argument), "The enum value is not defined, please check the ExceptionArgument Enum.");
 
        return argument.ToString();
    }
 
    internal enum ExceptionArgument
    {
        size,
        offset,
        length,
        MemoryPoolBlock,
        MemoryPool
    }
}