xref: /haiku/headers/private/kernel/slab/Slab.h (revision ef9d9a1720573321434f36b5ad1fabfd9f4c519e)

/*
 * Copyright 2008-2010, Axel Dörfler. All Rights Reserved.
 * Copyright 2007, Hugo Santos. All Rights Reserved.
 *
 * Distributed under the terms of the MIT License.
 */
#ifndef _SLAB_SLAB_H_
#define _SLAB_SLAB_H_


#include <heap.h>


enum {
	/* object_cache_{alloc,free}() flags  */
	CACHE_DONT_WAIT_FOR_MEMORY		= HEAP_DONT_WAIT_FOR_MEMORY,
	CACHE_DONT_LOCK_KERNEL_SPACE	= HEAP_DONT_LOCK_KERNEL_SPACE,
	CACHE_PRIORITY_VIP				= HEAP_PRIORITY_VIP,
	CACHE_ALLOC_FLAGS				= CACHE_DONT_WAIT_FOR_MEMORY
										| CACHE_DONT_LOCK_KERNEL_SPACE
										| CACHE_PRIORITY_VIP,

	/* create_object_cache_etc flags */
	CACHE_NO_DEPOT					= 0x08000000,
	CACHE_UNLOCKED_PAGES			= 0x10000000,	// unsupported
	CACHE_LARGE_SLAB				= 0x20000000,

	/* internal */
	CACHE_ALIGN_ON_SIZE				= 0x40000000,
	CACHE_DURING_BOOT				= 0x80000000
};

struct ObjectCache;
typedef struct ObjectCache object_cache;

typedef status_t (*object_cache_constructor)(void* cookie, void* object);
typedef void (*object_cache_destructor)(void* cookie, void* object);
typedef void (*object_cache_reclaimer)(void* cookie, int32 level);


#ifdef __cplusplus
extern "C" {
#endif

object_cache* create_object_cache(const char* name, size_t objectSize,
	size_t alignment, void* cookie, object_cache_constructor constructor,
	object_cache_destructor destructor);
object_cache* create_object_cache_etc(const char* name, size_t objectSize,
	size_t alignment, size_t maxByteUsage, size_t magazineCapacity,
	size_t maxMagazineCount, uint32 flags, void* cookie,
	object_cache_constructor constructor, object_cache_destructor destructor,
	object_cache_reclaimer reclaimer);

void delete_object_cache(object_cache* cache);

status_t object_cache_set_minimum_reserve(object_cache* cache,
	size_t objectCount);

void* object_cache_alloc(object_cache* cache, uint32 flags);
void object_cache_free(object_cache* cache, void* object, uint32 flags);

status_t object_cache_reserve(object_cache* cache, size_t object_count,
	uint32 flags);

void object_cache_get_usage(object_cache* cache, size_t* _allocatedMemory);

#ifdef __cplusplus
}
#endif


#ifdef __cplusplus

#include <new>


inline void*
operator new(size_t size, ObjectCache* objectCache, uint32 flags) throw()
{
	return object_cache_alloc(objectCache, flags);
}


template<typename Type>
inline void
object_cache_delete(ObjectCache* objectCache, Type* object, uint32 flags = 0)
{
	if (object != NULL) {
		object->~Type();
		object_cache_free(objectCache, object, flags);
	}
}

#endif	// __cplusplus


#endif	/* _SLAB_SLAB_H_ */