4431206970

Build # 4431206970

Build Type

push

github

Committed by GitHub

Commit Message

TLruTickCount64Policy uses 64 bit time (#337)

Run Details

739 of 792 branches covered (93.31%)

Branch coverage included in aggregate %.

7 of 8 new or added lines in 1 file covered. (87.5%)

8 existing lines in 2 files now uncovered.

3274 of 3373 relevant lines covered (97.06%)

3401948.51 hits per line

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

97.22

/BitFaster.Caching/Lru/TlruTickCount64Policy.cs

﻿using System;
using System.Runtime.CompilerServices;

namespace BitFaster.Caching.Lru
{
#if NETCOREAPP3_0_OR_GREATER
    /// <summary>
    /// Time aware Least Recently Used (TLRU) is a variant of LRU which discards the least 
    /// recently used items first, and any item that has expired.
    /// </summary>
    /// <remarks>
    /// This class measures time using Environment.TickCount64, which is significantly faster
    /// than both Stopwatch.GetTimestamp and DateTime.UtcNow. However, resolution is lower (typically 
    /// between 10-16ms), vs 1us for Stopwatch.GetTimestamp.
    /// </remarks>
    public readonly struct TLruTickCount64Policy<K, V> : IItemPolicy<K, V, LongTickCountLruItem<K, V>>
    {
        private readonly long timeToLive;

        ///<inheritdoc/>
        public TimeSpan TimeToLive => TimeSpan.FromMilliseconds(timeToLive);

        /// <summary>
        /// Initializes a new instance of the TLruTicksPolicy class with the specified time to live.
        /// </summary>
        /// <param name="timeToLive">The time to live.</param>
        public TLruTickCount64Policy(TimeSpan timeToLive)
        {
            TimeSpan maxRepresentable = TimeSpan.FromTicks(9223372036854769664);
            if (timeToLive < TimeSpan.Zero || timeToLive > maxRepresentable)
            {
                Ex.ThrowArgOutOfRange(nameof(timeToLive), $"Value must greater than zero and less than {maxRepresentable}");
            }

            this.timeToLive = (long)timeToLive.TotalMilliseconds;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public LongTickCountLruItem<K, V> CreateItem(K key, V value)
        {
            return new LongTickCountLruItem<K, V>(key, value, Environment.TickCount64);
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void Touch(LongTickCountLruItem<K, V> item)
        {
            item.WasAccessed = true;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public void Update(LongTickCountLruItem<K, V> item)
        {
            item.TickCount = Environment.TickCount64;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool ShouldDiscard(LongTickCountLruItem<K, V> item)
        {
            if (Environment.TickCount64 - item.TickCount > this.timeToLive)
            {
                return true;
            }

            return false;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool CanDiscard()
        {
            return true;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public ItemDestination RouteHot(LongTickCountLruItem<K, V> item)
        {
            if (this.ShouldDiscard(item))
            {
                return ItemDestination.Remove;
            }

            if (item.WasAccessed)
            {
                return ItemDestination.Warm;
            }

            return ItemDestination.Cold;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public ItemDestination RouteWarm(LongTickCountLruItem<K, V> item)
        {
            if (this.ShouldDiscard(item))
            {
                return ItemDestination.Remove;
            }

            if (item.WasAccessed)
            {
                return ItemDestination.Warm;
            }

            return ItemDestination.Cold;
        }

        ///<inheritdoc/>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public ItemDestination RouteCold(LongTickCountLruItem<K, V> item)
        {
            if (this.ShouldDiscard(item))
            {
                return ItemDestination.Remove;
            }

            if (item.WasAccessed)
            {
                return ItemDestination.Warm;
            }

            return ItemDestination.Remove;
        }
    }
#endif
}

1	using System;
2	using System.Runtime.CompilerServices;
3
4	namespace BitFaster.Caching.Lru
5	{
6	#if NETCOREAPP3_0_OR_GREATER
7	/// <summary>
8	/// Time aware Least Recently Used (TLRU) is a variant of LRU which discards the least
9	/// recently used items first, and any item that has expired.
10	/// </summary>
11	/// <remarks>
12	/// This class measures time using Environment.TickCount64, which is significantly faster
13	/// than both Stopwatch.GetTimestamp and DateTime.UtcNow. However, resolution is lower (typically
14	/// between 10-16ms), vs 1us for Stopwatch.GetTimestamp.
15	/// </remarks>
16	public readonly struct TLruTickCount64Policy<K, V> : IItemPolicy<K, V, LongTickCountLruItem<K, V>>
17	{
18	private readonly long timeToLive;
19
20	///<inheritdoc/>
21	public TimeSpan TimeToLive => TimeSpan.FromMilliseconds(timeToLive);	6✔
22
23	/// <summary>
24	/// Initializes a new instance of the TLruTicksPolicy class with the specified time to live.
25	/// </summary>
26	/// <param name="timeToLive">The time to live.</param>
27	public TLruTickCount64Policy(TimeSpan timeToLive)
28	{	104✔
29	TimeSpan maxRepresentable = TimeSpan.FromTicks(9223372036854769664);	104✔
30	if (timeToLive < TimeSpan.Zero \|\| timeToLive > maxRepresentable)	104!
31	{	4✔
32	Ex.ThrowArgOutOfRange(nameof(timeToLive), $"Value must greater than zero and less than {maxRepresentable}");	4✔
NEW 33	}	×
34
35	this.timeToLive = (long)timeToLive.TotalMilliseconds;	100✔
36	}	100✔
37
38	///<inheritdoc/>
39	[MethodImpl(MethodImplOptions.AggressiveInlining)]
40	public LongTickCountLruItem<K, V> CreateItem(K key, V value)
41	{	120✔
42	return new LongTickCountLruItem<K, V>(key, value, Environment.TickCount64);	120✔
43	}	120✔
44
45	///<inheritdoc/>
46	[MethodImpl(MethodImplOptions.AggressiveInlining)]
47	public void Touch(LongTickCountLruItem<K, V> item)
48	{	14✔
49	item.WasAccessed = true;	14✔
50	}	14✔
51
52	///<inheritdoc/>
53	[MethodImpl(MethodImplOptions.AggressiveInlining)]
54	public void Update(LongTickCountLruItem<K, V> item)
55	{	4✔
56	item.TickCount = Environment.TickCount64;	4✔
57	}	4✔
58
59	///<inheritdoc/>
60	[MethodImpl(MethodImplOptions.AggressiveInlining)]
61	public bool ShouldDiscard(LongTickCountLruItem<K, V> item)
62	{	112✔
63	if (Environment.TickCount64 - item.TickCount > this.timeToLive)	112✔
64	{	64✔
65	return true;	64✔
66	}
67
68	return false;	48✔
69	}	112✔
70
71	///<inheritdoc/>
72	[MethodImpl(MethodImplOptions.AggressiveInlining)]
73	public bool CanDiscard()
74	{	26✔
75	return true;	26✔
76	}	26✔
77
78	///<inheritdoc/>
79	[MethodImpl(MethodImplOptions.AggressiveInlining)]
80	public ItemDestination RouteHot(LongTickCountLruItem<K, V> item)
81	{	24✔
82	if (this.ShouldDiscard(item))	24✔
83	{	8✔
84	return ItemDestination.Remove;	8✔
85	}
86
87	if (item.WasAccessed)	16✔
88	{	2✔
89	return ItemDestination.Warm;	2✔
90	}
91
92	return ItemDestination.Cold;	14✔
93	}	24✔
94
95	///<inheritdoc/>
96	[MethodImpl(MethodImplOptions.AggressiveInlining)]
97	public ItemDestination RouteWarm(LongTickCountLruItem<K, V> item)
98	{	8✔
99	if (this.ShouldDiscard(item))	8✔
100	{	4✔
101	return ItemDestination.Remove;	4✔
102	}
103
104	if (item.WasAccessed)	4✔
105	{	2✔
106	return ItemDestination.Warm;	2✔
107	}
108
109	return ItemDestination.Cold;	2✔
110	}	8✔
111
112	///<inheritdoc/>
113	[MethodImpl(MethodImplOptions.AggressiveInlining)]
114	public ItemDestination RouteCold(LongTickCountLruItem<K, V> item)
115	{	12✔
116	if (this.ShouldDiscard(item))	12✔
117	{	4✔
118	return ItemDestination.Remove;	4✔
119	}
120
121	if (item.WasAccessed)	8✔
122	{	2✔
123	return ItemDestination.Warm;	2✔
124	}
125
126	return ItemDestination.Remove;	6✔
127	}	12✔
128	}
129	#endif
130	}

bitfaster / BitFaster.Caching / 4431206970

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