Umap is a library that provides an mmap()-like interface to a simple, user- space page fault handler based on the userfaultfd Linux feature (starting with 4.3 linux kernel). The use case is to have an application specific buffer of pages cached from a large file, i.e. out-of-core execution using memory map.
The src directory in the top level contains the source code for the library.
The tests directory contains various tests written to test the library including a hello world program for userfaultfd based upon code from the userfaultfd-hello-world project.
Building umap is trivial. In the root directory of the repo
mkdir build cd build cmake -DCMAKE_INSTALL_PREFIX=<where you want the sofware> .. make install
The default for cmake is to build a Debug version of the software. If you would like to build an optimized (-O3) version, simply run
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=<install-dir> ..
The design and implementation of UMap is described in the following paper:
Peng, Ivy B., Marty McFadden, Eric Green, Keita Iwabuchi, Kai Wu, Dong Li, Roger Pearce, and Maya Gokhale. "UMap: Enabling Application-driven Optimizations for Page Management". In Proceedings of the Workshop on Memory Centric High Performance Computing. ACM, 2018.
Both user and code documentation is available here.
If you have build problems, we have comprehensive build sytem documentation too!