https://github.com/nerett/hwc-cache
C++ LFU cache implementation
https://github.com/nerett/hwc-cache
cache cpp20 lfu-cache
Last synced: about 1 year ago
JSON representation
C++ LFU cache implementation
- Host: GitHub
- URL: https://github.com/nerett/hwc-cache
- Owner: nerett
- License: gpl-3.0
- Created: 2022-09-19T19:46:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-01T19:20:47.000Z (about 3 years ago)
- Last Synced: 2025-02-17T05:14:34.545Z (over 1 year ago)
- Topics: cache, cpp20, lfu-cache
- Language: C++
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HWC-Cache
This is *LFU (least frequently used)* cache emulation written in *C++*. This type of cache stores memory pages with high hit rate and replaces pages with low frequency with the new ones in case there is not enough free space to fit them both. Cached pages have low access time and others are loaded with slow lookup method provided by user.
## Usage
You're expected to type the following on startup (see [Running](https://github.com/nerett/hwc-cache/blob/main/README.md#running) section for more):
```bash
```
`cachesize` stands for the cache maximum capacity, `number of keys` - number of cache read attempts, `keyn` - id of the page to be red in current read iteration. After you're done, `hwc-cache` will simulate the process and display just one value - number of cache hits for current algorithm.
## Building from source
#### Downloading
Download this repository with
```bash
git clone https://github.com/nerett/hwc-cache.git
```
#### Installing dependencies
Install required packages automatically with
```bash
make install-dependencies-pkg PACKAGEMANAGER= #apt is used if PACKAGEMANAGER is not defined
```
...or install them manually with your distro package manager (check list [here](https://github.com/nerett/hwc-cache#Dependencies)).
#### Building
Build `hwc-cache` as a standalone program with
```bash
make MODE=DEBUG #or MODE=RELEASE; MODE=RELEASE if not defined
```
#### Running
You can run builded release/debug version of standalone `hwc-cache` with
```bash
make run-lfu MODE=DEBUG #MODE=RELEASE if MODE is not defined
```
Use `rund` instead of `run` to run with `valgrind`
...or run this binary with manually from project directory.
#### Testing
There are built-in end-to-end test. You can run current test pack for LFU cache with
```bash
make test-lfu
```
##### You'll see something like this:
Test pack for FLU cache is located in `test/lfu_testdata/`. There are 2 types of files: `*.in` for input data and `*.exp` for expected result. All of these files are scanned automatically on startup and added to the current test sequence.
#### Rebuilding
To totally rebuild the project run
```bash
make clean
make MODE=
```
## Dependencies
This project actually depends on `libc` and building requires `make`, `g++` and `git` (it can also require `valgrind` installed to use `rund` target).
## Documentation
This section isn't done yet.
## About project
This program was written during MIPT **Vladimirov's** cource.