v0.17.0 #995

MrCroxx · 2025-04-28T09:52:31Z

MrCroxx
Apr 28, 2025
Maintainer

Releases

crate	version
foyer	0.17.0
foyer-common	0.17.0
foyer-memory	0.17.0
foyer-storage	0.17.0
foyer-bench	0.17.0

Changes

Refine entry-level properties.
- Packing ephemeral, hint, location into CacheProperties and HybridCacheProperties, use insert_with_properties() and fetch_with_properties() for setting them.
- Migration from foyer < v0.17.0: Repleace .insert_with_hint(..), .insert_ephemeral(..), etc with insert_with_properties(..) and fetch_with_properties(..).
Refine disk cache insertion with entries populated from the disk cache.
- Use an age-based FIFO policy to manager large object disk cache.
- Track the source of in-memory cache entries.
- When an in-memory cache entry is being inserted into the disk cache, the disk cache will determine if to skip it according to its resource and age. Entries populated from the disk cache and are not going to evicted soon will be skipped.
Support flush entries in the in-memory cache to the disk cache on closing the hybrid cache.
- Migration from foyer < v0.17.0: Enable by .with_flush_on_close(true) with the hybrid cache builder.
Refine io throttling.
- Support advanced io throttling by read/write IOPS/throughput, and support count IOs by IO count or by IO count with IO size.
- Migration from foyer < v0.17.0: Please set io throttling for device, instead of using RateLimiterAmissionPicker.
Support request deduplication and one-flight optimization with fetch(..) interface for the disk cache.
- Migration from foyer < v0.17.0: Use .fetch_with_properties(..) API and set the location of HybridCacheProperties to Location::OnDisk.
Miscs:
- Add builder() API for Cache and HybridCache to create builders.
- Opt-out tracing dependency by default, enable it by enabling tracing feature.
- Bump mixtrics to v0.1.

Latest foyer-bench usage:

bench tool for foyer - Hybrid cache for Rust

Usage: foyer-bench [OPTIONS] <--file <FILE>|--dir <DIR>|--no-disk>

Options:
      --no-disk
          Run with in-memory cache compatible mode
  -f, --file <FILE>
          File for disk cache data. Use `DirectFile` as device
  -d, --dir <DIR>
          Directory for disk cache data. Use `DirectFs` as device
      --mem <MEM>
          In-memory cache capacity [default: "1.0 GiB"]
      --disk <DISK>
          Disk cache capacity [default: "1.0 GiB"]
  -t, --time <TIME>
          (s) [default: 60]
      --report-interval <REPORT_INTERVAL>
          (s) [default: 2]
      --w-rate <W_RATE>
          Write rate limit per writer [default: "0 B"]
      --r-rate <R_RATE>
          Read rate limit per reader [default: "0 B"]
      --entry-size-min <ENTRY_SIZE_MIN>
          Min entry size [default: "64.0 KiB"]
      --entry-size-max <ENTRY_SIZE_MAX>
          Max entry size [default: "64.0 KiB"]
      --get-range <GET_RANGE>
          Reader lookup key range [default: 10000]
      --region-size <REGION_SIZE>
          Disk cache region size [default: "64.0 MiB"]
      --flushers <FLUSHERS>
          Flusher count [default: 4]
      --reclaimers <RECLAIMERS>
          Reclaimer count [default: 4]
      --writers <WRITERS>
          Writer count [default: 16]
      --readers <READERS>
          Reader count [default: 16]
      --recover-mode <RECOVER_MODE>
          [default: none] [possible values: none, quiet, strict]
      --recover-concurrency <RECOVER_CONCURRENCY>
          Recover concurrency [default: 16]
      --disk-write-iops <DISK_WRITE_IOPS>
          Disk write iops throttle [default: 0]
      --disk-read-iops <DISK_READ_IOPS>
          Disk read iops throttle [default: 0]
      --disk-write-throughput <DISK_WRITE_THROUGHPUT>
          Disk write throughput throttle [default: "0 B"]
      --disk-read-throughput <DISK_READ_THROUGHPUT>
          Disk read throughput throttle [default: "0 B"]
      --clean-region-threshold <CLEAN_REGION_THRESHOLD>
          `0` means use default [default: 0]
      --shards <SHARDS>
          Shards of both in-memory cache and disk cache indexer [default: 64]
      --metrics
          weigher to enable metrics exporter
      --user-runtime-worker-threads <USER_RUNTIME_WORKER_THREADS>
          Benchmark user runtime worker threads [default: 0]
      --runtime <RUNTIME>
          Dedicated runtime type [default: disabled] [possible values: disabled, unified, separated]
      --runtime-worker-threads <RUNTIME_WORKER_THREADS>
          Dedicated runtime worker threads [default: 0]
      --runtime-max-blocking-threads <RUNTIME_MAX_BLOCKING_THREADS>
          Max threads for blocking io [default: 0]
      --write-runtime-worker-threads <WRITE_RUNTIME_WORKER_THREADS>
          Dedicated runtime for writes worker threads [default: 0]
      --write-runtime-max-blocking-threads <WRITE_RUNTIME_MAX_BLOCKING_THREADS>
          Dedicated runtime for writes Max threads for blocking io [default: 0]
      --read-runtime-worker-threads <READ_RUNTIME_WORKER_THREADS>
          Dedicated runtime for reads worker threads [default: 0]
      --read-runtime-max-blocking-threads <READ_RUNTIME_MAX_BLOCKING_THREADS>
          Dedicated runtime for writes max threads for blocking io [default: 0]
      --compression <COMPRESSION>
          compression algorithm [default: none] [possible values: none, zstd, lz4]
      --engine <ENGINE>
          Disk cache engine [default: large]
      --distribution <DISTRIBUTION>
          Time-series operation distribution [default: none]
      --distribution-zipf-n <DISTRIBUTION_ZIPF_N>
          For `--distribution zipf` only [default: 100]
      --distribution-zipf-s <DISTRIBUTION_ZIPF_S>
          For `--distribution zipf` only [default: 0.5]
      --warm-up <WARM_UP>
          [default: 2]
      --flush
          
      --invalid-ratio <INVALID_RATIO>
          [default: 0.8]
      --eviction <EVICTION>
          [default: lru] [possible values: lru, lfu, fifo, s3fifo]
      --policy <POLICY>
          [default: eviction] [possible values: eviction, insertion]
      --buffer-pool-size <BUFFER_POOL_SIZE>
          [default: "16.0 MiB"]
      --blob-index-size <BLOB_INDEX_SIZE>
          [default: "4.0 KiB"]
      --set-size <SET_SIZE>
          [default: "16.0 KiB"]
      --set-cache-capacity <SET_CACHE_CAPACITY>
          [default: 64]
      --trace-insert <TRACE_INSERT>
          Record insert trace threshold. Only effective with "tracing" feature [default: 1s]
      --trace-get <TRACE_GET>
          Record get trace threshold. Only effective with "tracing" feature [default: 1s]
      --trace-obtain <TRACE_OBTAIN>
          Record obtain trace threshold. Only effective with "tracing" feature [default: 1s]
      --trace-remove <TRACE_REMOVE>
          Record remove trace threshold. Only effective with "tracing" feature [default: 1s]
      --trace-fetch <TRACE_FETCH>
          Record fetch trace threshold. Only effective with "tracing" feature [default: 1s]
      --flush-on-close
          
      --lodc-fifo-probation-ratio <LODC_FIFO_PROBATION_RATIO>
          [default: 0.1]
  -h, --help
          Print help (see more with '--help')
  -V, --version
          Print version

What's Changed

refactor: refine device io throttle by @MrCroxx in refactor: refine device io throttle #930
refactor: unify DeviceStats and Statistics by @MrCroxx in refactor: unify DeviceStats and Statistics #937
feat: impl disk cache read throttle by iops/throughput by @MrCroxx in feat: impl disk cache read throttle by iops/throughput #938
feat: support evict_all for in-mem cache by @MrCroxx in feat: support evict_all for in-mem cache #899
feat: support set cache location, support Default/InMem for now by @MrCroxx in feat: support set cache location, support Default/InMem for now #941
feat: avoid disk cache write on disk cache miss by read throttled by @MrCroxx in feat: avoid disk cache write on disk cache miss by read throttled #940
feat: make pick be aware of throttling by @MrCroxx in feat: make pick be aware of throttling #944
fix: fix panic if buffer_pool_size / flushers is not 4K aligned by @MrCroxx in fix: fix panic if buffer_pool_size / flushers is not 4K aligned #947
test: run CI on release branches by @MrCroxx in test: run CI on release branches #950
test: run license check on release branch by @MrCroxx in test: run license check on release branch #952
chore: bump foyer v0.16.1 (test: run CI on release branches (#950) (#951) #954) by @MrCroxx in chore: bump foyer v0.16.1 (#954) #955
feat: support flush in-mem data to disk on hybrid cache close by @MrCroxx in feat: support flush in-mem data to disk on hybrid cache close #946
refactor: refine flush on close to mitigate burst by @MrCroxx in refactor: refine flush on close to mitigate burst #956
doc: new user and tiny lints by @yihong0618 in doc: new user and tiny lints #962
chore: bump mixtrics to v0.1 by @MrCroxx in chore: bump mixtrics to v0.1 #965
feat: Add builder for Cache to make it easier to discover by @Xuanwo in feat: Add builder for Cache to make it easier to discover #967
feat: support OnDisk cache location advice by @MrCroxx in feat: support OnDisk cache location advice #959
feat: refine Grafana foyer dashboard variables by @MrCroxx in feat: refine Grafana foyer dashboard variables #958
feat: add metrics for lodc indexer insertion conflicts by @MrCroxx in feat: add metrics for lodc indexer insertion conflicts #974
chore: update changelog via chore: release foyer v0.15.4 #980 by @MrCroxx in chore: update changelog via #980 #981
refactor: move utils into a mod in foyer-common by @MrCroxx in refactor: move utils into a mod in foyer-common #984
refactor: combine properties and split mem-only and hybrid impl by @MrCroxx in refactor: combine properties and split mem-only and hybrid impl #985
feat: skip disk cache insert for young populated entries by @MrCroxx in feat: skip disk cache insert for young populated entries #987
refactor: refine evition info and fifo picker by @MrCroxx in refactor: refine evition info and fifo picker #989
refactor: opt out fastrace dep without feature tracing by @MrCroxx in refactor: opt out fastrace dep without feature tracing #992
feat: add builder for hybrid cache to make it easier to discover by @MrCroxx in feat: add builder for hybrid cache to make it easier to discover #994
chore: release foyer v0.17.0 by @MrCroxx in chore: release foyer v0.17.0 #993

Full Changelog: v0.16.1...v0.17.0

This discussion was created from the release v0.17.0.

MrCroxx · 2025-04-28T09:53:10Z

MrCroxx
Apr 28, 2025
Maintainer Author

Thank you, @yihong0618 and @Xuanwo . 🥰

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

v0.17.0 #995

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

v0.17.0 #995

Uh oh!

MrCroxx Apr 28, 2025 Maintainer

Releases

Changes

What's Changed

Replies: 1 comment

Uh oh!

MrCroxx Apr 28, 2025 Maintainer Author

MrCroxx
Apr 28, 2025
Maintainer

MrCroxx
Apr 28, 2025
Maintainer Author