rom_cache 0.0.1-alpha1

A rust crate to cache ROM in memory like CPU caching RAM.
Documentation

Contributors Forks Stargazers Issues MIT License

Import

[dependencies]
rom_cache = { version = "0.0.1-alpha1" }

About The Project

A rust crate to cache ROM in memory like CPU caching RAM.

Trait Cacheable is provided to let user define how to load and store data in Secondary Storage.

  1. Retrieve data (&T)
  • cache miss: CacheError::Miss.
  • cache hit: return &T from cache.
  1. Retrieve mutable data (&mut T)
  • cache miss: CacheError::Miss
  • cache hit: return &mut T from cache, and mark CacheLine dirty.
  1. Load data
  • empty cache: load data from Secondary Storage (Cacheable::load()).
  • full cache: LRU algorithm to evict data.
  • already loaded: refresh.

Any dirty CacheLine will be written back (Cacheable::store()) to Secondary Storage when evicted.

Built With

  • Rust
  • Miri (Testing)

Usage

Example

# use rom_cache::Cache;
// e.g 2-way set associative cache (8 sets)
let mut cache: Cache<8, 2> = Default::default();
cache.load::<String>();
let s = cache.retrieve::<String>().unwrap();
assert_eq!(s, "hello, world.");
cache.load::<i8>();
cache.load::<i16>();
cache.load::<i32>();
cache.load::<i64>();
cache.load::<isize>();

let n = cache.retrieve_mut::<isize>().unwrap();
*n = 0;

cache.load::<u8>();
cache.load::<u16>();
cache.load::<u32>();
cache.load::<u64>();
cache.load::<usize>();
let n = cache.retrieve::<usize>().unwrap();
assert_eq!(*n, 0);

For more examples, please refer to the Tests, Example or Documentation

Changelog

todo

more detailed changelog

Roadmap

  • allow concurrent access
  • auto load when cache miss

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Louis - 836250617@qq.com

Project Link: https://github.com/kingwingfly/rom-cache