6595777532

Committed 21 Oct 2023 06:27AM UTC coverage: 98.537% (-0.1%) from 98.644%

Build # 6595777532

Build Type

push

github

Committed by

web-flow

Commit Message

trim (#435)

Run Details

859 of 890 branches covered (0.0%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

4 existing lines in 1 file now uncovered.

3722 of 3759 relevant lines covered (99.02%)

16989709.23 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.44

/BitFaster.Caching/Buffers/MpscBoundedBuffer.cs

﻿using System;
using System.Diagnostics;
using System.Runtime.CompilerServices;
using System.Threading;

namespace BitFaster.Caching.Buffers
{
    /// <summary>
    /// Provides a multi-producer, single-consumer thread-safe ring buffer. When the buffer is full,
    /// TryAdd fails and returns false. When the buffer is empty, TryTake fails and returns false.
    /// </summary>
    /// Based on the BoundedBuffer class in the Caffeine library by ben.manes@gmail.com (Ben Manes).
    [DebuggerDisplay("Count = {Count}/{Capacity}")]
    public sealed class MpscBoundedBuffer<T> where T : class
    {
        private T[] buffer;
        private readonly int mask;
        private PaddedHeadAndTail headAndTail; // mutable struct, don't mark readonly

        /// <summary>
        /// Initializes a new instance of the MpscBoundedBuffer class with the specified bounded capacity.
        /// </summary>
        /// <param name="boundedLength">The bounded length.</param>
        /// <exception cref="ArgumentOutOfRangeException"></exception>
        public MpscBoundedBuffer(int boundedLength)
        {
            if (boundedLength < 0)
                Throw.ArgOutOfRange(nameof(boundedLength));

            // must be power of 2 to use & slotsMask instead of %
            boundedLength = BitOps.CeilingPowerOfTwo(boundedLength);

            buffer = new T[boundedLength];
            mask = boundedLength - 1;
        }

        /// <summary>
        /// The bounded capacity.
        /// </summary>
        public int Capacity => buffer.Length;

        /// <summary>
        /// Gets the number of items contained in the buffer.
        /// </summary>
        public int Count
        {
            get
            {
                var spinner = new SpinWait();
                while (true)
                {
                    var headNow = Volatile.Read(ref headAndTail.Head);
                    var tailNow = Volatile.Read(ref headAndTail.Tail);

                    if (headNow == Volatile.Read(ref headAndTail.Head) &&
                        tailNow == Volatile.Read(ref headAndTail.Tail))
                    {
                        return GetCount(headNow, tailNow);
                    }

                    spinner.SpinOnce();
                }
            }
        }

        private int GetCount(int head, int tail)
        {
            if (head != tail)
            {
                head &= mask;
                tail &= mask;

                return head < tail ? tail - head : buffer.Length - head + tail;
            }
            return 0;
        }

        /// <summary>
        /// Tries to add the specified item.
        /// </summary>
        /// <param name="item">The item to be added.</param>
        /// <returns>A BufferStatus value indicating whether the operation succeeded.</returns>
        /// <remarks>
        /// Thread safe.
        /// </remarks>
        public BufferStatus TryAdd(T item)
        {
            int head = Volatile.Read(ref headAndTail.Head);
            int tail = Volatile.Read(ref headAndTail.Tail);
            int size = tail - head;

            if (size >= buffer.Length)
            {
                return BufferStatus.Full;
            }

            if (Interlocked.CompareExchange(ref this.headAndTail.Tail, tail + 1, tail) == tail)
            {
                int index = tail & mask;
                Volatile.Write(ref buffer[index], item);

                return BufferStatus.Success;
            }

            return BufferStatus.Contended;
        }


        /// <summary>
        /// Tries to remove an item.
        /// </summary>
        /// <param name="item">The item to be removed.</param>
        /// <returns>A BufferStatus value indicating whether the operation succeeded.</returns>
        /// <remarks>
        /// Thread safe for single try take/drain + multiple try add.
        /// </remarks>
        public BufferStatus TryTake(out T item)
        {
            int head = Volatile.Read(ref headAndTail.Head);
            int tail = Volatile.Read(ref headAndTail.Tail);
            int size = tail - head;

            if (size == 0)
            {
                item = default;
                return BufferStatus.Empty;
            }

            int index = head & mask;

            item = Volatile.Read(ref buffer[index]);

            if (item == null)
            {
                // not published yet
                return BufferStatus.Contended;
            }

            Volatile.Write(ref buffer[index], null);
            Volatile.Write(ref this.headAndTail.Head, ++head);
            return BufferStatus.Success;
        }

        // On NETSTANDARD2_0 all code paths are internally based on ArraySegment<T>.
        // After NETSTANDARD2_0, all code paths are internally based on Span<T>.
#if NETSTANDARD2_0
        /// <summary>
        /// Drains the buffer into the specified array segment.
        /// </summary>
        /// <param name="output">The output buffer</param>
        /// <returns>The number of items written to the output buffer.</returns>
        /// <remarks>
        /// Thread safe for single try take/drain + multiple try add.
        /// </remarks>
        public int DrainTo(ArraySegment<T> output)
#else
        /// <summary>
        /// Drains the buffer into the specified array segment.
        /// </summary>
        /// <param name="output">The output buffer</param>
        /// <returns>The number of items written to the output buffer.</returns>
        /// <remarks>
        /// Thread safe for single try take/drain + multiple try add.
        /// </remarks>
        public int DrainTo(ArraySegment<T> output)
        { 
            return DrainTo(output.AsSpan());
        }

        /// <summary>
        /// Drains the buffer into the specified span.
        /// </summary>
        /// <param name="output">The output buffer</param>
        /// <returns>The number of items written to the output buffer.</returns>
        /// <remarks>
        /// Thread safe for single try take/drain + multiple try add.
        /// </remarks>
        public int DrainTo(Span<T> output)
#endif
        {
            return DrainToImpl(output);
        }

        // use an outer wrapper method to force the JIT to inline the inner adaptor methods
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
#if NETSTANDARD2_0
        private int DrainToImpl(ArraySegment<T> output)
#else
        private int DrainToImpl(Span<T> output)
#endif
        {
            int head = Volatile.Read(ref headAndTail.Head);
            int tail = Volatile.Read(ref headAndTail.Tail);
            int size = tail - head;

            if (size == 0)
            {
                return 0;
            }

            var localBuffer = buffer.AsSpanOrArray();

            int outCount = 0;

            do
            {
                int index = head & mask;

                T item = Volatile.Read(ref localBuffer[index]);

                if (item == null)
                {
                    // not published yet
                    break;
                }

                Volatile.Write(ref localBuffer[index], null);
                Write(output, outCount++, item);
                head++;
            }
            while (head != tail && outCount < Length(output));

            Volatile.Write(ref this.headAndTail.Head, head);

            return outCount;
        }

#if NETSTANDARD2_0
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static void Write(ArraySegment<T> output, int index, T item)
        {
            output.Array[output.Offset + index] = item;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static int Length(ArraySegment<T> output)
        {
            return output.Count;
        }
#else
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static void Write(Span<T> output, int index, T item)
        {
            output[index] = item;
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static int Length(Span<T> output)
        {
            return output.Length;
        }
#endif

        /// <summary>
        /// Removes all values from the buffer.
        /// </summary>
        /// <remarks>
        /// Not thread safe.
        /// </remarks>
        public void Clear()
        {
            buffer = new T[buffer.Length];
            headAndTail = new PaddedHeadAndTail();
        }
    }
}

1	using System;
2	using System.Diagnostics;
3	using System.Runtime.CompilerServices;
4	using System.Threading;
5
6	namespace BitFaster.Caching.Buffers
7	{
8	/// <summary>
9	/// Provides a multi-producer, single-consumer thread-safe ring buffer. When the buffer is full,
10	/// TryAdd fails and returns false. When the buffer is empty, TryTake fails and returns false.
11	/// </summary>
12	/// Based on the BoundedBuffer class in the Caffeine library by ben.manes@gmail.com (Ben Manes).
13	[DebuggerDisplay("Count = {Count}/{Capacity}")]
14	public sealed class MpscBoundedBuffer<T> where T : class
15	{
16	private T[] buffer;
17	private readonly int mask;
18	private PaddedHeadAndTail headAndTail; // mutable struct, don't mark readonly
19
20	/// <summary>
21	/// Initializes a new instance of the MpscBoundedBuffer class with the specified bounded capacity.
22	/// </summary>
23	/// <param name="boundedLength">The bounded length.</param>
24	/// <exception cref="ArgumentOutOfRangeException"></exception>
25	public MpscBoundedBuffer(int boundedLength)	1,144✔
26	{	1,144✔
27	if (boundedLength < 0)	1,144✔
28	Throw.ArgOutOfRange(nameof(boundedLength));	3✔
29
30	// must be power of 2 to use & slotsMask instead of %
31	boundedLength = BitOps.CeilingPowerOfTwo(boundedLength);	1,141✔
32
33	buffer = new T[boundedLength];	1,141✔
34	mask = boundedLength - 1;	1,141✔
35	}	1,141✔
36
37	/// <summary>
38	/// The bounded capacity.
39	/// </summary>
40	public int Capacity => buffer.Length;	366✔
41
42	/// <summary>
43	/// Gets the number of items contained in the buffer.
44	/// </summary>
45	public int Count
46	{
47	get
48	{	596✔
49	var spinner = new SpinWait();	596✔
50	while (true)	596✔
51	{	596✔
52	var headNow = Volatile.Read(ref headAndTail.Head);	596✔
53	var tailNow = Volatile.Read(ref headAndTail.Tail);	596✔
54
55	if (headNow == Volatile.Read(ref headAndTail.Head) &&	596!
56	tailNow == Volatile.Read(ref headAndTail.Tail))	596✔
57	{	596✔
58	return GetCount(headNow, tailNow);	596✔
59	}
60
UNCOV 61	spinner.SpinOnce();	×
UNCOV 62	}	×
63	}	596✔
64	}
65
66	private int GetCount(int head, int tail)
67	{	596✔
68	if (head != tail)	596✔
69	{	138✔
70	head &= mask;	138✔
71	tail &= mask;	138✔
72
73	return head < tail ? tail - head : buffer.Length - head + tail;	138✔
74	}
75	return 0;	458✔
76	}	596✔
77
78	/// <summary>
79	/// Tries to add the specified item.
80	/// </summary>
81	/// <param name="item">The item to be added.</param>
82	/// <returns>A BufferStatus value indicating whether the operation succeeded.</returns>
83	/// <remarks>
84	/// Thread safe.
85	/// </remarks>
86	public BufferStatus TryAdd(T item)
87	{	646,198,538✔
88	int head = Volatile.Read(ref headAndTail.Head);	646,198,538✔
89	int tail = Volatile.Read(ref headAndTail.Tail);	646,198,538✔
90	int size = tail - head;	646,198,538✔
91
92	if (size >= buffer.Length)	646,198,538✔
93	{	552,823,199✔
94	return BufferStatus.Full;	552,823,199✔
95	}
96
97	if (Interlocked.CompareExchange(ref this.headAndTail.Tail, tail + 1, tail) == tail)	93,375,339✔
98	{	93,009,345✔
99	int index = tail & mask;	93,009,345✔
100	Volatile.Write(ref buffer[index], item);	93,009,345✔
101
102	return BufferStatus.Success;	93,009,345✔
103	}
104
105	return BufferStatus.Contended;	365,994✔
106	}	646,198,538✔
107
108
109	/// <summary>
110	/// Tries to remove an item.
111	/// </summary>
112	/// <param name="item">The item to be removed.</param>
113	/// <returns>A BufferStatus value indicating whether the operation succeeded.</returns>
114	/// <remarks>
115	/// Thread safe for single try take/drain + multiple try add.
116	/// </remarks>
117	public BufferStatus TryTake(out T item)
118	{	3,084✔
119	int head = Volatile.Read(ref headAndTail.Head);	3,084✔
120	int tail = Volatile.Read(ref headAndTail.Tail);	3,084✔
121	int size = tail - head;	3,084✔
122
123	if (size == 0)	3,084✔
124	{	6✔
125	item = default;	6✔
126	return BufferStatus.Empty;	6✔
127	}
128
129	int index = head & mask;	3,078✔
130
131	item = Volatile.Read(ref buffer[index]);	3,078✔
132
133	if (item == null)	3,078!
UNCOV 134	{	×
135	// not published yet
UNCOV 136	return BufferStatus.Contended;	×
137	}
138
139	Volatile.Write(ref buffer[index], null);	3,078✔
140	Volatile.Write(ref this.headAndTail.Head, ++head);	3,078✔
141	return BufferStatus.Success;	3,078✔
142	}	3,084✔
143
144	// On NETSTANDARD2_0 all code paths are internally based on ArraySegment<T>.
145	// After NETSTANDARD2_0, all code paths are internally based on Span<T>.
146	#if NETSTANDARD2_0
147	/// <summary>
148	/// Drains the buffer into the specified array segment.
149	/// </summary>
150	/// <param name="output">The output buffer</param>
151	/// <returns>The number of items written to the output buffer.</returns>
152	/// <remarks>
153	/// Thread safe for single try take/drain + multiple try add.
154	/// </remarks>
155	public int DrainTo(ArraySegment<T> output)
156	#else
157	/// <summary>
158	/// Drains the buffer into the specified array segment.
159	/// </summary>
160	/// <param name="output">The output buffer</param>
161	/// <returns>The number of items written to the output buffer.</returns>
162	/// <remarks>
163	/// Thread safe for single try take/drain + multiple try add.
164	/// </remarks>
165	public int DrainTo(ArraySegment<T> output)
166	{	14✔
167	return DrainTo(output.AsSpan());	14✔
168	}	14✔
169
170	/// <summary>
171	/// Drains the buffer into the specified span.
172	/// </summary>
173	/// <param name="output">The output buffer</param>
174	/// <returns>The number of items written to the output buffer.</returns>
175	/// <remarks>
176	/// Thread safe for single try take/drain + multiple try add.
177	/// </remarks>
178	public int DrainTo(Span<T> output)
179	#endif
180	{	11,416,104✔
181	return DrainToImpl(output);	11,416,104✔
182	}	11,416,104✔
183
184	// use an outer wrapper method to force the JIT to inline the inner adaptor methods
185	[MethodImpl(MethodImplOptions.AggressiveInlining)]
186	#if NETSTANDARD2_0
187	private int DrainToImpl(ArraySegment<T> output)
188	#else
189	private int DrainToImpl(Span<T> output)
190	#endif
191	{	11,416,104✔
192	int head = Volatile.Read(ref headAndTail.Head);	11,416,104✔
193	int tail = Volatile.Read(ref headAndTail.Tail);	11,416,104✔
194	int size = tail - head;	11,416,104✔
195
196	if (size == 0)	11,416,104✔
197	{	8,122,037✔
198	return 0;	8,122,037✔
199	}
200
201	var localBuffer = buffer.AsSpanOrArray();	3,294,067✔
202
203	int outCount = 0;	3,294,067✔
204
205	do
206	{	92,972,361✔
207	int index = head & mask;	92,972,361✔
208
209	T item = Volatile.Read(ref localBuffer[index]);	92,972,361✔
210
211	if (item == null)	92,972,361✔
212	{	2,413✔
213	// not published yet
214	break;	2,413✔
215	}
216
217	Volatile.Write(ref localBuffer[index], null);	92,969,948✔
218	Write(output, outCount++, item);	92,969,948✔
219	head++;	92,969,948✔
220	}	92,969,948✔
221	while (head != tail && outCount < Length(output));	92,969,948✔
222
223	Volatile.Write(ref this.headAndTail.Head, head);	3,294,067✔
224
225	return outCount;	3,294,067✔
226	}	11,416,104✔
227
228	#if NETSTANDARD2_0
229	[MethodImpl(MethodImplOptions.AggressiveInlining)]
230	private static void Write(ArraySegment<T> output, int index, T item)
231	{
232	output.Array[output.Offset + index] = item;
233	}
234
235	[MethodImpl(MethodImplOptions.AggressiveInlining)]
236	private static int Length(ArraySegment<T> output)
237	{
238	return output.Count;
239	}
240	#else
241	[MethodImpl(MethodImplOptions.AggressiveInlining)]
242	private static void Write(Span<T> output, int index, T item)
243	{	92,969,948✔
244	output[index] = item;	92,969,948✔
245	}	92,969,948✔
246
247	[MethodImpl(MethodImplOptions.AggressiveInlining)]
248	private static int Length(Span<T> output)
249	{	89,678,297✔
250	return output.Length;	89,678,297✔
251	}	89,678,297✔
252	#endif
253
254	/// <summary>
255	/// Removes all values from the buffer.
256	/// </summary>
257	/// <remarks>
258	/// Not thread safe.
259	/// </remarks>
260	public void Clear()
261	{	1,215✔
262	buffer = new T[buffer.Length];	1,215✔
263	headAndTail = new PaddedHeadAndTail();	1,215✔
264	}	1,215✔
265	}
266	}

bitfaster / BitFaster.Caching / 6595777532

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous