facebook
/
zstd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a README

dev
Nick Terrell 2017-04-04 18:39:22 -07:00
parent 7f510a7797
commit 97693aff98
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
contrib/linux-kernel/README.md Normal file
View File

@ -0,0 +1,26 @@
# Linux Kernel Patch
There are two pieces, the `zstd_compress` and `zstd_decompress` kernel modules, and the BtrFS patch.
The patches are based off of the linux kernel version 4.9.
The BtrFS patch is not present in its entirety yet.
## Zstd Kernel modules
* The header is in `include/linux/zstd.h`.
* It is split up into `zstd_compress` and `zstd_decompress`, which can be loaded independently.
* Source files are in `lib/zstd/`.
* `lib/Kconfig` and `lib/Makefile` need to be modified by applying `lib/Kconfig.diff` and `lib/Makefile.diff` respectively.
* `test/UserlandTest.cpp` contains tests for the patch in userland by mocking the kernel headers.
It can be run with the following commands:
```
cd test
make googletest
make UserlandTest
./UserlandTest
```
## BtrFS
* `fs/btrfs/zstd.c` is provided.
* Some more glue is required to integrate it with BtrFS, but I haven't included the patches yet.
In the meantime see https://github.com/terrelln/linux/commit/1914f7d4ca6c539369c84853eafa4ac104883047 if you're interested.