/root/bitcoin/src/test/util/poolresourcetester.h

Source
// Copyright (c) 2022 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_TEST_UTIL_POOLRESOURCETESTER_H
#define BITCOIN_TEST_UTIL_POOLRESOURCETESTER_H

#include <support/allocators/pool.h>
#include <util/check.h>

#include <algorithm>
#include <cassert>
#include <cstddef>
#include <cstdint>
#include <vector>

/**
 * Helper to get access to private parts of PoolResource. Used in unit tests and in the fuzzer
 */
class PoolResourceTester
{
    struct PtrAndBytes {
        uintptr_t ptr;
        std::size_t size;

        PtrAndBytes(const void* p, std::size_t s)
            : ptr(reinterpret_cast<uintptr_t>(p)), size(s)
        {
        }

        /**
         * defines a sort ordering by the pointer value
         */
        friend bool operator<(PtrAndBytes const& a, PtrAndBytes const& b)
        {
            return a.ptr < b.ptr;
        }
    };

public:
    /**
     * Extracts the number of elements per freelist
     */
    template <std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
    static std::vector<std::size_t> FreeListSizes(const PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>& resource)
    {
        auto sizes = std::vector<std::size_t>();
        for (const auto* ptr : resource.m_free_lists) {
            size_t size = 0;
            while (ptr != nullptr) {
                ++size;
                const auto* ptr_ = ptr;
                ASAN_UNPOISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
                ptr = ptr->m_next;
                ASAN_POISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
            }
            sizes.push_back(size);
        }
        return sizes;
    }

    /**
     * How many bytes are still available from the last allocated chunk
     */
    template <std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
    static std::size_t AvailableMemoryFromChunk(const PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>& resource)
    {
        return resource.m_available_memory_end - resource.m_available_memory_it;
    }

    /**
     * Once all blocks are given back to the resource, tests that the freelists are consistent:
     *
     * * All data in the freelists must come from the chunks
     * * Memory doesn't overlap
     * * Each byte in the chunks can be accounted for in either the freelist or as available bytes.
     */
    template <std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
    static void CheckAllDataAccountedFor(const PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>& resource)
    {
        // collect all free blocks by iterating all freelists
        std::vector<PtrAndBytes> free_blocks;
        for (std::size_t freelist_idx = 0; freelist_idx < resource.m_free_lists.size(); ++freelist_idx) {
            std::size_t bytes = freelist_idx * resource.ELEM_ALIGN_BYTES;
            auto* ptr = resource.m_free_lists[freelist_idx];
            while (ptr != nullptr) {
                free_blocks.emplace_back(ptr, bytes);
                const auto* ptr_ = ptr;
                ASAN_UNPOISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
                ptr = ptr->m_next;
                ASAN_POISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
            }
        }
        // also add whatever has not yet been used for blocks
        auto num_available_bytes = resource.m_available_memory_end - resource.m_available_memory_it;
        if (num_available_bytes > 0) {
            free_blocks.emplace_back(resource.m_available_memory_it, num_available_bytes);
        }

        // collect all chunks
        std::vector<PtrAndBytes> chunks;
        for (const std::byte* ptr : resource.m_allocated_chunks) {
            chunks.emplace_back(ptr, resource.ChunkSizeBytes());
        }

        // now we have all the data from all freelists on the one hand side, and all chunks on the other hand side.
        // To check if all of them match, sort by address and iterate.
        std::sort(free_blocks.begin(), free_blocks.end());
        std::sort(chunks.begin(), chunks.end());

        auto chunk_it = chunks.begin();
        auto chunk_ptr_remaining = chunk_it->ptr;
        auto chunk_size_remaining = chunk_it->size;
        for (const auto& free_block : free_blocks) {
            if (chunk_size_remaining == 0) {
                assert(chunk_it != chunks.end());
                ++chunk_it;
                assert(chunk_it != chunks.end());
                chunk_ptr_remaining = chunk_it->ptr;
                chunk_size_remaining = chunk_it->size;
            }
            assert(free_block.ptr == chunk_ptr_remaining);                   // ensure addresses match
            assert(free_block.size <= chunk_size_remaining);                 // ensure no overflow
            assert((free_block.ptr & (resource.ELEM_ALIGN_BYTES - 1)) == 0); // ensure correct alignment
            chunk_ptr_remaining += free_block.size;
            chunk_size_remaining -= free_block.size;
        }
        // ensure we are at the end of the chunks
        assert(chunk_ptr_remaining == chunk_it->ptr + chunk_it->size);
        ++chunk_it;
        assert(chunk_it == chunks.end());
        assert(chunk_size_remaining == 0);
    }
};

#endif // BITCOIN_TEST_UTIL_POOLRESOURCETESTER_H

Line	Count	Source
1		// Copyright (c) 2022 The Bitcoin Core developers
2		// Distributed under the MIT software license, see the accompanying
3		// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5		#ifndef BITCOIN_TEST_UTIL_POOLRESOURCETESTER_H
6		#define BITCOIN_TEST_UTIL_POOLRESOURCETESTER_H
7
8		#include <support/allocators/pool.h>
9		#include <util/check.h>
10
11		#include <algorithm>
12		#include <cassert>
13		#include <cstddef>
14		#include <cstdint>
15		#include <vector>
16
17		/**
18		* Helper to get access to private parts of PoolResource. Used in unit tests and in the fuzzer
19		*/
20		class PoolResourceTester
21		{
22		struct PtrAndBytes {
23		uintptr_t ptr;
24		std::size_t size;
25
26		PtrAndBytes(const void* p, std::size_t s)
27	0	: ptr(reinterpret_cast<uintptr_t>(p)), size(s)
28	0	{
29	0	}
30
31		/**
32		* defines a sort ordering by the pointer value
33		*/
34		friend bool operator<(PtrAndBytes const& a, PtrAndBytes const& b)
35	0	{
36	0	return a.ptr < b.ptr;
37	0	}
38		};
39
40		public:
41		/**
42		* Extracts the number of elements per freelist
43		*/
44		template <std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
45		static std::vector<std::size_t> FreeListSizes(const PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>& resource)
46		{
47		auto sizes = std::vector<std::size_t>();
48		for (const auto* ptr : resource.m_free_lists) {
49		size_t size = 0;
50		while (ptr != nullptr) {
51		++size;
52		const auto* ptr_ = ptr;
53		ASAN_UNPOISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
54		ptr = ptr->m_next;
55		ASAN_POISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
56		}
57		sizes.push_back(size);
58		}
59		return sizes;
60		}
61
62		/**
63		* How many bytes are still available from the last allocated chunk
64		*/
65		template <std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
66		static std::size_t AvailableMemoryFromChunk(const PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>& resource)
67		{
68		return resource.m_available_memory_end - resource.m_available_memory_it;
69		}
70
71		/**
72		* Once all blocks are given back to the resource, tests that the freelists are consistent:
73		*
74		* * All data in the freelists must come from the chunks
75		* * Memory doesn't overlap
76		* * Each byte in the chunks can be accounted for in either the freelist or as available bytes.
77		*/
78		template <std::size_t MAX_BLOCK_SIZE_BYTES, std::size_t ALIGN_BYTES>
79		static void CheckAllDataAccountedFor(const PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>& resource)
80	0	{
81		// collect all free blocks by iterating all freelists
82	0	std::vector<PtrAndBytes> free_blocks;
83	0	for (std::size_t freelist_idx = 0; freelist_idx < resource.m_free_lists.size(); ++freelist_idx) {
84	0	std::size_t bytes = freelist_idx * resource.ELEM_ALIGN_BYTES;
85	0	auto* ptr = resource.m_free_lists[freelist_idx];
86	0	while (ptr != nullptr) {
87	0	free_blocks.emplace_back(ptr, bytes);
88	0	const auto* ptr_ = ptr;
89	0	ASAN_UNPOISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
90	0	ptr = ptr->m_next;
91	0	ASAN_POISON_MEMORY_REGION(ptr_, sizeof(typename PoolResource<MAX_BLOCK_SIZE_BYTES, ALIGN_BYTES>::ListNode));
92	0	}
93	0	}
94		// also add whatever has not yet been used for blocks
95	0	auto num_available_bytes = resource.m_available_memory_end - resource.m_available_memory_it;
96	0	if (num_available_bytes > 0) {
97	0	free_blocks.emplace_back(resource.m_available_memory_it, num_available_bytes);
98	0	}
99
100		// collect all chunks
101	0	std::vector<PtrAndBytes> chunks;
102	0	for (const std::byte* ptr : resource.m_allocated_chunks) {
103	0	chunks.emplace_back(ptr, resource.ChunkSizeBytes());
104	0	}
105
106		// now we have all the data from all freelists on the one hand side, and all chunks on the other hand side.
107		// To check if all of them match, sort by address and iterate.
108	0	std::sort(free_blocks.begin(), free_blocks.end());
109	0	std::sort(chunks.begin(), chunks.end());
110
111	0	auto chunk_it = chunks.begin();
112	0	auto chunk_ptr_remaining = chunk_it->ptr;
113	0	auto chunk_size_remaining = chunk_it->size;
114	0	for (const auto& free_block : free_blocks) {
115	0	if (chunk_size_remaining == 0) {
116	0	assert(chunk_it != chunks.end());
117	0	++chunk_it;
118	0	assert(chunk_it != chunks.end());
119	0	chunk_ptr_remaining = chunk_it->ptr;
120	0	chunk_size_remaining = chunk_it->size;
121	0	}
122	0	assert(free_block.ptr == chunk_ptr_remaining); // ensure addresses match
123	0	assert(free_block.size <= chunk_size_remaining); // ensure no overflow
124	0	assert((free_block.ptr & (resource.ELEM_ALIGN_BYTES - 1)) == 0); // ensure correct alignment
125	0	chunk_ptr_remaining += free_block.size;
126	0	chunk_size_remaining -= free_block.size;
127	0	}
128		// ensure we are at the end of the chunks
129	0	assert(chunk_ptr_remaining == chunk_it->ptr + chunk_it->size);
130	0	++chunk_it;
131	0	assert(chunk_it == chunks.end());
132	0	assert(chunk_size_remaining == 0);
133	0	} Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm128ELm1EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm128ELm2EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm128ELm4EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm128ELm8EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm8ELm8EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm16ELm16EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm256ELm16EEEvRK12PoolResourceIXT_EXT0_EE Unexecuted instantiation: _ZN18PoolResourceTester24CheckAllDataAccountedForILm256ELm64EEEvRK12PoolResourceIXT_EXT0_EE
134		};
135
136		#endif // BITCOIN_TEST_UTIL_POOLRESOURCETESTER_H

Coverage Report

Created: 2025-09-19 18:31