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