FastCache.Cached 1.8.2

FastCache.Cached

<p><img src="https://raw.githubusercontent.com/neon-sunset/fast-cache/main/img/cached-small-transparent.png" width="180" height="180" align="right" /></p>

The fastest cache library written in C# for items with set expiration time. Easy to use, thread-safe and light on memory.

Optimized to scale from dozens to millions of items. Features lock-free reads and writes, allocation-free reads and automatic eviction.

Credit to Vladimir Sadov for his implementation of NonBlocking.ConcurrentDictionary which is used as an underlying store.

When to use FastCache.Cached over M.E.C.M.MemoryCache

• When cache is used for expirable items only or does not need complex behavior (eviction delegates, multiple expiration modes, etc.), ~80% use cases fall into this category
• When there are strict memory limits (381MB for 10 million items vs 2136MB for MemoryCache)
• When you need pseudo-memoization: cached.Save(value, TimeSpan.MaxValue)
• When deployed to highly-parallel systems (much better multi-core scaling vs all alternatives thanks to lock-free reads/writes)
• When you need convenient limit API: cached.Save(value, TimeSpan.FromSeconds(180), limit: 50_000) (auto trim logic included)
• When you need the fastest solution - read/write paths are hand tuned to be as short as possible, no interface calls, all static dispatch, etc.
• When global static cache is an acceptable choice (vs instanced, works best for medium and fine-grained highly loaded microservices)

Quick start

Install

dotnet add package FastCache.Cached or Install-Package FastCache.Cached

How to use

Get cached value or save a new one with expiration of 60 minutes

public SalesReport GetReport(Guid companyId)
{
  if (Cached<SalesReport>.TryGet(companyId, out var cached))
  {
    return cached;
  }

  var report = // Expensive operation: retrieve and compute data

  return cached.Save(report, TimeSpan.FromMinutes(60));
}

Get cached value or call a method to compute and cache it

var report = Cached.GetOrCompute(companyId, GetReport, TimeSpan.FromMinutes(60));

Async version (works with Task<T> and ValueTask<T>)

var report = await Cached.GetOrCompute(companyId, GetReportAsync, TimeSpan.FromMinutes(60));

Use multiple arguments as key (up to 7)

public async Task<Picture> GetPictureOfTheDay(DateOnly date, FeedKind kind, bool compressed)
{
  if (Cached<Picture>.TryGet(date, kind, compressed, out var cached))
  {
    return cached;
  }

  var api = GetApiService(kind);
  var picture = await api.GetPictureOfTheDay(date, compressed);

  return cached.Save(picture, TimeSpan.FromHours(3));
}

Use multiple arguments with GetOrCompute

var expiration = TimeSpan.FromHours(3);
var picture = await Cached.GetOrCompute(date, kind, compressed, GetPictureOfTheDay, expiration);

Save the value to cache (if it fits) and keep the cached items count below specified limit

public SalesReport GetReport(Guid companyId)
{
  if (Cached<SalesReport>.TryGet(companyId, out var cached))
  {
    return cached;
  }
  ...
  return cached.Save(report, TimeSpan.FromMinutes(60), limit: 500_000);
}

// GetOrCompute with maximum cache size limit.
// RAM is usually plenty but what if the user runs Chrome?
var report = Cached.GetOrCompute(companyId, GetReport, TimeSpan.FromMinutes(60), limit: 500_000);

Add new data without accessing cache item first

Cached<SalesReport>.Save(companyId, report, TimeSpan.FromMinutes(60));

// Same as above but via extension method for more concise syntax
using FastCache.Extensions;
...
report.Cache(companyId, TimeSpan.FromMinutes(60));

Save an entire range of values in one call. Fast for IEnumerable, extremely fast for lists, arrays and ROM/Memory.

using FastCache.Collections;
...
var reports = ReportsService
  .GetReports(11, 2022)
  .Select(report => (report.CompanyId, report));

CachedRange<SalesReport>.Save(reports, TimeSpan.FromMinutes(60));

Save range of cached values with multiple arguments as key

var februaryReports = reports.Select(report => ((report.CompanyId, 02, 2022), report));

CachedRange<SalesReport>.Save(februaryReports, TimeSpan.FromMinutes(60));

var companyId = februaryReports.First().CompanyId;
var reportFound = Cached<SalesReport>.TryGet(companyId, 02, 2022, out _);
Assert.True(reportFound);

Store common type (string) in a shared cache store (other users may share the cache for the same <K, V> type, this time it's <int, string>)

// GetOrCompute<...V> where V is string.
// To save some other string for the same 'int' number simultaneously, look at the option below :)
var userNote = Cached.GetOrCompute(userId, GetUserNoteString, TimeSpan.FromMinutes(5));

Or in a separate one by using value object (Recommended)

readonly record struct UserNote(string Value);

// GetOrCompute<...V> where V is UserNote
var userNote = Cached.GetOrCompute(userId, GetUserNote, TimeSpan.FromMinutes(5));

// This is how it looks for TryGet
if (Cached<UserNote>.TryGet(userId, out var cached))
{
  return cached;
}
...
return cached.Save(userNote, TimeSpan.FromMinutes(5));

Features and design philosophy

• In-memory cache for items with expiration time and automatic eviction
• Little to no ceremony - no need to configure or initialize, just add the package and you are ready to go. Behavior can be further customized via env variables
• Focused design allows to reduce memory footprint per item and minimize overhead via inlining and static dispatch
• High performance and scaling covering both simplest applications and highly loaded services. Can handle 1-100M+ items with O(1) read/write time and up to O(n~) memory cost/cpu time cost for full eviction
• Lock-free and wait-free reads/writes of cached items. Performance will improve with threads, data synchronization cost is minimal thanks to NonBlocking.ConcurrentDictionary
• Multi-key store access without collisions between key types. Collisions are avoided by statically dispatching on the composite key type signature e.g. (string, CustomEnum, int) together with the type of cached value - composite keys are structurally evaluated for equality, different combinations will correspond to different cache items
• Handles timezone/DST updates on most platforms by relying on system uptime timestamp for item expiration - Environment.TickCount64 which is also significantly faster than DateTime.UtcNow

Performance

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.22000
AMD Ryzen 7 5800X, 1 CPU, 16 logical and 8 physical cores
.NET 6.0.5 (6.0.522.21309), X64 RyuJIT

TLDR: FastCache.Cached vs Microsoft.Extensions.Caching.Memory.MemoryCache | Library | Lowest read latency | Read throughput (M/1s) | Lowest write latency | Write throughput (M/1s) | Cost per item | Cost per 10M items | | ------------------ | ------------------- | ---------------------- | -------------------- | ----------------------- | ------------- | ------------------ | | FastCache.Cached | 15.63 ns | 114-288M MT / 9-72M ST | 33.75 ns | 39-81M MT / 6-31M ST | 40 B | 381 MB | | MemoryCache | 56.93 ns | 41-46M MT / 4-10M ST | 203.32 ns | 11-26M MT / 2-6M ST | 224 B | 2,136 MB | | CacheManager | 87.54 ns | N/A | ~436.85 ns | N/A MT / 1.5-5M ST | (+alloc)360 B | 1,602 MB |

+CachedRange.Save(ReadOnlySpan<(K, V)>) provides parallelized bulk writes out of box

++CacheManager doesn't have read throughput results because test suite would take too long to run to include CacheManager and LazyCache. Given higher CPU usage by CacheManager and higher RAM usage by LazyCache it is reasonable to assume they would score lower and scale worse due to higher number of locks

Read/Write lowest achievable latency

Read throughput detailed

Further reading

• Keys and composite keys performance estimation: Code / Results

Notes

• FastCache.Cached defaults provide highest performance and don't require spending time on finding a way to use API optimally. The design goal is to nudge a developer to use the fastest way to achieve his or her goals while strictly adhering to the principle of "pay for play".
• Comparison was made with a string-based key. Composite keys supported by FastCache.Cached have additional performance cost. Numeric keys have significantly higher performance in some instances (down to 5ns read latency on x86_64 where K is int or uint and V fits in a single register).
• *CacheManger documentation suggests using WithMicrosoftMemoryCacheHandle() by default which has terrible performance (and uses obsolete System.Runtime.Caching). We give it a better fighting chance by using WithDictionaryHandle() instead.
• **CachedRange.Save(ReadOnlyMemory<(K, V)>) (and CachedRange.Save(ReadOnlyMemory<K>, ReadOnlyMemory<V>)) automatically splits the range into slices of 1024 or length / cpu cores elements and saves them in parallel which dramatically improves throughput. This works especially well because the execution flow is lock-free and does not suffer from false sharing of CPU cache lines (except for the adjacent entries at the edges of slices)
• ***Forced single-threaded execution of CachedRange.Save(ReadOnlyMemory<(K, V)>)
• Overall, performance stays relatively comparable when downgrading to .NET 5 and decreases further by 15-30% when using .NET Core 3.1 with the difference ratio between libraries staying close to provided above.
• Non-standard platforms (the ones that aren't CLR based) use DateTime.UtcNow fallback instead of Environment.TickCount64, which will perform slower depending on the platform-specific implementation.

On benchmark data

Throughput saturation means that all necessary data structures are fully available in the CPU cache and branch predictor has learned branch patters of the executed code. This is only possible in scenarios such as items being retrieved or added/updated in a tight loop or very frequently on the same cores. This means that real world performance will not saturate maximum throughput and will be bottlenecked by memory access latency and branch misprediction stalls. As a result, you can expect resulting performance variance of 1-10x min latency depending on hardware and outside factors.

From 🇺🇦 Ukraine with ♥️