Skip to content

Commit

Permalink
add readme for segcache crate (#116)
Browse files Browse the repository at this point in the history
* add readme for segcache module

* bump revision
  • Loading branch information
thinkingfish authored Jan 3, 2024
1 parent 3ce36a4 commit 9ffea34
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/storage/segcache/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "segcache"
version = "0.1.0"
version = "0.1.1"
description = "Pelikan segment-structured cache"
authors = ["Brian Martin <brian@pelikan.io>"]

Expand Down
20 changes: 20 additions & 0 deletions src/storage/segcache/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Segcache is a cache storage engine that delivers high memory efficiency, high
throughput, and excellent scalability for web cache workloads.

The design is optimized for workloads that access predominantly small objects
and use TTL (time-to-live). These workloads, which represent most of what social
media websites, as well as a good portion of web workloads in general, have
historically paid a significant memory overhead due to their small object sizes
and transient nature. In Twitter's case, which was where this design was
originally developed in collaboration with Carnegie Mellon University, the cache
memory footprint was reduced by as much as 60%. This was achieved while
maintaining comparable or better throughput to best-in-kind alternatives, such
as the slab memory allocator in [Memcached](https://memcached.org) and its
cousin in [Twemcache](https://github.com/twitter/twemcache). Segcache also
offers much better (write) scalability compared to Memcached.

The design was first published as a conference paper at NSDI’21, titled “Pelikan
Segcache: a memory-efficient and scalable in-memory key-value cache for small
objects”. It received NSDI Community Award, and the code used in the paper is
merged into Pelikan codebase as of April 2021. A more detailed description can
be found in the form of a [blog post](https://pelikan.io/2021/segcache.html).

0 comments on commit 9ffea34

Please sign in to comment.