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