1 /* Copyright (C) 2011 Wildfire Games.
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining
4  * a copy of this software and associated documentation files (the
5  * "Software"), to deal in the Software without restriction, including
6  * without limitation the rights to use, copy, modify, merge, publish,
7  * distribute, sublicense, and/or sell copies of the Software, and to
8  * permit persons to whom the Software is furnished to do so, subject to
9  * the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef INCLUDED_ALLOCATORS_ALLOCATOR_CHECKER
24 #define INCLUDED_ALLOCATORS_ALLOCATOR_CHECKER
25 
26 #include <map>
27 
28 /**
29  * allocator test rig.
30  * call from each allocator operation to sanity-check them.
31  * should only be used during debug mode due to serious overhead.
32  **/
33 class AllocatorChecker
34 {
35 public:
OnAllocate(void * p,size_t size)36 	void OnAllocate(void* p, size_t size)
37 	{
38 		const Allocs::value_type item = std::make_pair(p, size);
39 		std::pair<Allocs::iterator, bool> ret = allocs.insert(item);
40 		ENSURE(ret.second == true);	// wasn't already in map
41 	}
42 
OnDeallocate(void * p,size_t size)43 	void OnDeallocate(void* p, size_t size)
44 	{
45 		Allocs::iterator it = allocs.find(p);
46 		if(it == allocs.end())
47 			DEBUG_WARN_ERR(ERR::LOGIC);	// freeing invalid pointer
48 		else
49 		{
50 			// size must match what was passed to OnAllocate
51 			const size_t allocated_size = it->second;
52 			ENSURE(size == allocated_size);
53 
54 			allocs.erase(it);
55 		}
56 	}
57 
58 	/**
59 	 * allocator is resetting itself, i.e. wiping out all allocs.
60 	 **/
OnClear()61 	void OnClear()
62 	{
63 		allocs.clear();
64 	}
65 
66 private:
67 	typedef std::map<void*, size_t> Allocs;
68 	Allocs allocs;
69 };
70 
71 #endif	// #ifndef INCLUDED_ALLOCATORS_ALLOCATOR_CHECKER
72