The purpose of this project is to provide a well tested, easy-to-use Slab allocator for OS kernels.
First, add the include/ directory to your header search path and include anslabs like this:
#include <anslabs>
All of the functionality of anslabs is under the namespace ANSlabs.
Raw slabs allocate a certain number of elements once using a new call. A raw slab will never allocate more elements, so you cannot use them exclusively unless you know the absolute maximum number of elements you will ever need.
While test/test_raw.cpp provides the best example, here I will show you how to use the raw slab allocator. Create an instance like this:
ANSlabs::Raw<X, Y> * allocator = new ANSlabs::Raw<X, Y>();
Here, X is the maximum number of elements the slab allocator may hold, and Y is the size of each element. It is recommended that each element is aligned the way you would like your instances aligned: probably by 16-bytes for the System V ABI.
Now, you can allocate and free buffers from the slab easily:
void * myBuffer = allocator->AllocBuf();
// ... do something here with myBuffer ...
allocator.FreeBuf(myBuffer);
The AllocBuf() method will return NULL when there are no free elements left in the slab.
Cap slabs are used pretty much identically to raw slabs, but if they run out of memory they will start returning objects from new and delete. This way any number of elements may be allocated, but the allocation will stop being O(1) after a certain cap (hence the name cap allocator).
You may use a cap allocator the same way you would use a raw allocator, but use the class name ANSlabs::Cap<X, Y>().
A structor allocator provides an alternative to new and delete to create and destroy objects quickly. Create a structor allocator on top of a different allocation pool like a cap allocator:
ANSlabs::Structor<MyClass, ANSlabs::Cap<0x10, sizeof(MyClass)> > aStructor();
This will create a new structor on top of a cap allocator that creates instances of MyClass. Now, you may allocate and delete instances like this:
MyClass * anInstance = aStructor.New(some, arguments, here)
/ ... do something here with anInstance ...
aStructor.Delete(anInstance);