SPDX-License-Identifier: MIT
MIT License
 
Copyright (c) 2019 Western Digital Corporation or its affiliates.
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Typical Usage:

init_nmallocator() - call at the start of the program initialization, passing it the numa node
where memory should be allocated throughout the life of the program. Returns 0 on success,
check the return value of the call before proceeding with memory allocation.

nmalloc() - zeroed out memory is handed over to the caller for a successful allocation

nmfree() - user memory freed and zeroed out to prevent information leak

*********************************
Build:
sudo make clean; sudo make

Linking with the library:
Use -lnmem as a linker flag to the application (see the sample Makefile in test/)

*********************************
Build with debug option:
sudo make debug=1

*********************************
Unittest:
sudo make debug=1 unittest

Runs the test code in test/