xref: /haiku/headers/os/support/BlockCache.h (revision 51978af14a173e7fae0563b562be5603bc652aeb)
1 /*
2  * Copyright (c) 2003 Marcus Overhagen
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 #ifndef _BLOCK_CACHE_H
23 #define _BLOCK_CACHE_H
24 
25 #include <BeBuild.h>
26 #include <Locker.h>
27 
28 /* The OpenBeOS implementation of the BBlockCache.
29  * A class used to manage a pool of memory blocks.
30  */
31 
32 /* The allocation type to be used in the constructor
33  */
34 enum {
35 	B_OBJECT_CACHE = 0,
36 	B_MALLOC_CACHE = 1
37 };
38 
39 /* The BBlockCache class:
40  */
41 class BBlockCache
42 {
43 public:
44 				BBlockCache(uint32 blockCount,
45 							size_t blockSize,
46 							uint32 allocationType);
47 	virtual		~BBlockCache();
48 
49 	void *		Get(size_t blockSize);
50 	void		Save(void *pointer, size_t blockSize);
51 
52 /* Private or reserved functions and data
53  */
54 private:
55 	virtual	void _ReservedBlockCache1();
56 	virtual	void _ReservedBlockCache2();
57 
58 				BBlockCache(const BBlockCache &);
59 	BBlockCache	&operator=(const BBlockCache &);
60 
61 	struct _FreeBlock;
62 
63 	_FreeBlock *fFreeList;
64 	size_t		fBlockSize;
65 	int32		fFreeBlocks;
66 	int32		fBlockCount;
67 	BLocker		fLocker;
68 	void *		(*fAlloc)(size_t size);
69 	void		(*fFree)(void *pointer);
70 	uint32		_reserved[2];
71 };
72 
73 #endif /* _BLOCK_CACHE_H */
74