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