diff -r 2e6e9d9f2159 -r c9d008861178 tests/util_allocator.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tests/util_allocator.h Wed Feb 08 20:26:26 2023 +0100 @@ -0,0 +1,81 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef UCX_UTIL_ALLOCATOR_H +#define UCX_UTIL_ALLOCATOR_H + +#include "cx/allocator.h" + +#include + +struct CxTestingAllocator : public CxAllocator { + /** + * Total number of all allocations (malloc, calloc, realloc). + * A realloc() does only count when the memory has to be moved. + */ + unsigned alloc_total = 0; + /** + * Number of failed allocations (malloc, calloc, realloc). + */ + unsigned alloc_failed = 0; + /** + * Total number of freed pointers. + * A reallocation also counts as a free when the memory has to be moved. + */ + unsigned free_total = 0; + /** + * Number of failed free invocations. + * A free() is considered failed, if it has not been performed on tracked memory. + */ + unsigned free_failed = 0; + /** + * The set of tracked memory blocks. + */ + std::set tracked; + + /** + * Constructs a new testing allocator. + */ + CxTestingAllocator(); + + /** + * Verifies that this allocator has been used. + * + * @return true if any allocation was attempted using this allocator + */ + [[nodiscard]] bool used() const; + + /** + * Verifies that all allocated memory blocks are freed and no free occurred twice. + * + * @return true iff all tracked allocations / deallocations were valid + */ + [[nodiscard]] bool verify() const; +}; + +#endif // UCX_UTIL_ALLOCATOR_H