xref: /xnu-10002.81.5/tests/safe_allocation_src/test_utils.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions #ifndef TESTS_SAFE_ALLOCATION_TEST_UTILS_H
2*5e3eaea3SApple OSS Distributions #define TESTS_SAFE_ALLOCATION_TEST_UTILS_H
3*5e3eaea3SApple OSS Distributions 
4*5e3eaea3SApple OSS Distributions #include <libkern/c++/bounded_ptr.h>
5*5e3eaea3SApple OSS Distributions #include <libkern/c++/safe_allocation.h>
6*5e3eaea3SApple OSS Distributions #include <darwintest_utils.h>
7*5e3eaea3SApple OSS Distributions #include <cassert>
8*5e3eaea3SApple OSS Distributions #include <cstddef>
9*5e3eaea3SApple OSS Distributions #include <cstdlib>
10*5e3eaea3SApple OSS Distributions #include <cstring>
11*5e3eaea3SApple OSS Distributions 
12*5e3eaea3SApple OSS Distributions namespace {
13*5e3eaea3SApple OSS Distributions struct assert_trapping_policy {
14*5e3eaea3SApple OSS Distributions 	static void
trapassert_trapping_policy15*5e3eaea3SApple OSS Distributions 	trap(char const*)
16*5e3eaea3SApple OSS Distributions 	{
17*5e3eaea3SApple OSS Distributions 		assert(false);
18*5e3eaea3SApple OSS Distributions 	}
19*5e3eaea3SApple OSS Distributions };
20*5e3eaea3SApple OSS Distributions 
21*5e3eaea3SApple OSS Distributions struct malloc_allocator {
22*5e3eaea3SApple OSS Distributions 	static void*
allocatemalloc_allocator23*5e3eaea3SApple OSS Distributions 	allocate(size_t n)
24*5e3eaea3SApple OSS Distributions 	{
25*5e3eaea3SApple OSS Distributions 		return std::malloc(n);
26*5e3eaea3SApple OSS Distributions 	}
27*5e3eaea3SApple OSS Distributions 
28*5e3eaea3SApple OSS Distributions 	static void*
allocate_zeromalloc_allocator29*5e3eaea3SApple OSS Distributions 	allocate_zero(size_t n)
30*5e3eaea3SApple OSS Distributions 	{
31*5e3eaea3SApple OSS Distributions 		const auto result = malloc_allocator::allocate(n);
32*5e3eaea3SApple OSS Distributions 		std::memset(result, 0, n);
33*5e3eaea3SApple OSS Distributions 		return result;
34*5e3eaea3SApple OSS Distributions 	}
35*5e3eaea3SApple OSS Distributions 
36*5e3eaea3SApple OSS Distributions 	static void
deallocatemalloc_allocator37*5e3eaea3SApple OSS Distributions 	deallocate(void* p, size_t n)
38*5e3eaea3SApple OSS Distributions 	{
39*5e3eaea3SApple OSS Distributions 		std::free(p);
40*5e3eaea3SApple OSS Distributions 	}
41*5e3eaea3SApple OSS Distributions };
42*5e3eaea3SApple OSS Distributions 
43*5e3eaea3SApple OSS Distributions struct tracking_allocator {
44*5e3eaea3SApple OSS Distributions 	static void
resettracking_allocator45*5e3eaea3SApple OSS Distributions 	reset()
46*5e3eaea3SApple OSS Distributions 	{
47*5e3eaea3SApple OSS Distributions 		allocated_size = 0;
48*5e3eaea3SApple OSS Distributions 		deallocated_size = 0;
49*5e3eaea3SApple OSS Distributions 		did_allocate = false;
50*5e3eaea3SApple OSS Distributions 		did_deallocate = false;
51*5e3eaea3SApple OSS Distributions 	}
52*5e3eaea3SApple OSS Distributions 	static std::size_t allocated_size;
53*5e3eaea3SApple OSS Distributions 	static std::size_t deallocated_size;
54*5e3eaea3SApple OSS Distributions 	static bool did_allocate;
55*5e3eaea3SApple OSS Distributions 	static bool did_deallocate;
56*5e3eaea3SApple OSS Distributions 
57*5e3eaea3SApple OSS Distributions 	static void*
allocatetracking_allocator58*5e3eaea3SApple OSS Distributions 	allocate(std::size_t n)
59*5e3eaea3SApple OSS Distributions 	{
60*5e3eaea3SApple OSS Distributions 		did_allocate = true;
61*5e3eaea3SApple OSS Distributions 		allocated_size = n;
62*5e3eaea3SApple OSS Distributions 		return std::malloc(n);
63*5e3eaea3SApple OSS Distributions 	}
64*5e3eaea3SApple OSS Distributions 
65*5e3eaea3SApple OSS Distributions 	static void*
allocate_zerotracking_allocator66*5e3eaea3SApple OSS Distributions 	allocate_zero(std::size_t n)
67*5e3eaea3SApple OSS Distributions 	{
68*5e3eaea3SApple OSS Distributions 		const auto result = tracking_allocator::allocate(n);
69*5e3eaea3SApple OSS Distributions 		std::memset(result, 0, n);
70*5e3eaea3SApple OSS Distributions 		return result;
71*5e3eaea3SApple OSS Distributions 	}
72*5e3eaea3SApple OSS Distributions 
73*5e3eaea3SApple OSS Distributions 	static void
deallocatetracking_allocator74*5e3eaea3SApple OSS Distributions 	deallocate(void* p, std::size_t n)
75*5e3eaea3SApple OSS Distributions 	{
76*5e3eaea3SApple OSS Distributions 		did_deallocate = true;
77*5e3eaea3SApple OSS Distributions 		deallocated_size = n;
78*5e3eaea3SApple OSS Distributions 		std::free(p);
79*5e3eaea3SApple OSS Distributions 	}
80*5e3eaea3SApple OSS Distributions };
81*5e3eaea3SApple OSS Distributions 
82*5e3eaea3SApple OSS Distributions std::size_t tracking_allocator::allocated_size = 0;
83*5e3eaea3SApple OSS Distributions std::size_t tracking_allocator::deallocated_size = 0;
84*5e3eaea3SApple OSS Distributions bool tracking_allocator::did_allocate = false;
85*5e3eaea3SApple OSS Distributions bool tracking_allocator::did_deallocate = false;
86*5e3eaea3SApple OSS Distributions 
87*5e3eaea3SApple OSS Distributions struct tracking_trapping_policy {
88*5e3eaea3SApple OSS Distributions 	static void
resettracking_trapping_policy89*5e3eaea3SApple OSS Distributions 	reset()
90*5e3eaea3SApple OSS Distributions 	{
91*5e3eaea3SApple OSS Distributions 		did_trap = false;
92*5e3eaea3SApple OSS Distributions 	}
93*5e3eaea3SApple OSS Distributions 	static bool did_trap;
94*5e3eaea3SApple OSS Distributions 	static void
traptracking_trapping_policy95*5e3eaea3SApple OSS Distributions 	trap(char const*)
96*5e3eaea3SApple OSS Distributions 	{
97*5e3eaea3SApple OSS Distributions 		did_trap = true;
98*5e3eaea3SApple OSS Distributions 	}
99*5e3eaea3SApple OSS Distributions };
100*5e3eaea3SApple OSS Distributions bool tracking_trapping_policy::did_trap = false;
101*5e3eaea3SApple OSS Distributions 
102*5e3eaea3SApple OSS Distributions template <typename T>
103*5e3eaea3SApple OSS Distributions using test_safe_allocation = libkern::safe_allocation<T, malloc_allocator, assert_trapping_policy>;
104*5e3eaea3SApple OSS Distributions 
105*5e3eaea3SApple OSS Distributions template <typename T>
106*5e3eaea3SApple OSS Distributions using tracked_safe_allocation = libkern::safe_allocation<T, tracking_allocator, assert_trapping_policy>;
107*5e3eaea3SApple OSS Distributions 
108*5e3eaea3SApple OSS Distributions template <typename T>
109*5e3eaea3SApple OSS Distributions using test_bounded_ptr = libkern::bounded_ptr<T, assert_trapping_policy>;
110*5e3eaea3SApple OSS Distributions } // end anonymous namespace
111*5e3eaea3SApple OSS Distributions 
112*5e3eaea3SApple OSS Distributions #define CHECK(...) T_ASSERT_TRUE((__VA_ARGS__), # __VA_ARGS__)
113*5e3eaea3SApple OSS Distributions 
114*5e3eaea3SApple OSS Distributions #endif // !TESTS_SAFE_ALLOCATION_TEST_UTILS_H
115