9693b82cf9
The purpose of this change is not to write superblock to the cache drive untill all other sections are initilized on disk in attach() path. Combined with superblock clearing at the erarlier stage of attach(), this assures there are no residual mappings in the collision section in case of power failure during attach with pre-existing metadata. This is implemented by removing ocf_metadata_flush_all_set_status() step at the beginning of ocf_metadata_flush_all(). ocf_metadata_flush_all() is called, except for the attach() case described above, in two cases: 1. at the end of cache load - potentially after cache recovery 2. during detaching cache drive in cache stop. To make sure there are no regressions in the first case, an explicit _ocf_mngt_attach_shutdown_status() is added to load pipeline before ocf_metadata_flush_all(). The second case is always ran after cache drive is attached, so dirty status bit must have already be written to the disk. Signed-off-by: Adam Rutkowski <adam.j.rutkowski@intel.com> |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| doc | ||
| env/posix | ||
| example/simple | ||
| inc | ||
| src | ||
| tests | ||
| .pep8speaks.yml | ||
| codecov.yml | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
Open CAS Framework
Open CAS Framework (OCF) is high performance block storage caching meta-library written in C. It's entirely platform and system independent, accessing system API through user provided environment wrappers layer. OCF tightly integrates with the rest of software stack, providing flawless, high performance, low latency caching utility.
In this readme:
- Documentation
- Source Code
- Deployment
- Examples
- Unit Tests
- Build Test
- Functional Tests
- Contributing
- Security
Documentation
OCF documentation is available on GitHub Pages. Doxygen API documentation is available here.
Source Code
Source code is available in the official OCF GitHub repository:
git clone https://github.com/Open-CAS/ocf.git
cd ocf
Deployment
OCF doesn't compile as separate library. It's designed to be included into another software stack. For this purpose OCF provides Makefile with two useful targets for deploying its source into target directories. Assuming OCFDIR is OCF directory, and SRCDIR and INCDIR are respectively your source and include directories, use following commands to deploy OCF into your project:
make -C $OCFDIR src O=$SRCDIR
make -C $OCFDIR inc O=$INCDIR
By default this will not copy OCF source files but create symbolic links to them, to avoid source duplication and allow for easy OCF code modification. If you prefer to copy OCF source files (e.g. you don't want to distribute whole OCF repository as your submodule) you can use following commands:
make -C $OCFDIR src O=$SRCDIR CMD=cp
make -C $OCFDIR inc O=$INCDIR CMD=cp
Examples
OCF is shipped with examples, which are complete, compillable and working programs, containing lot of comments that explain basics of caching. They are great starting point for everyone who wants to start working with OCF.
Examples can be found in directory example/.
Each example contains Makefile which can be used to compile it.
Unit Tests
OCF is shipped with dedicated unit test framework based on Cmocka.
To run unit tests you need to install following packages:
- Cmake (>= 3.8.1)
- Cmocka (>= 1.1.1)
- ctags (>= 5.8)
To run unit tests use following command:
./tests/unit/framework/run_unit_tests.py
Build Test
OCF repository contains basic build test. It uses default POSIX environment. To run this test, use following commands:
cd tests/build/
make
Functional Tests
OCF repository contains dedicated functional test framework written in python and executed via pytest. With the use of ctypes it is possible to call, wrap ocf functions and use C compatible data types.
To run functional tests you need to install the following:
- python3 (>=3.6.7)
- pytest (Install with
pip3 install pytest)
To run all functional tests (in compliance with the configuration file) compile using makefile located in ./tests/functional/Makefile and then use the following command:
pytest
Contributing
Feel like making OCF better? Don't hesitate to submit a pull request!
You can find more information about our contribution process
here.
In case of any questions feel free to contact maintainer.
Security
To report a potential security vulnerability please follow the instructions here