1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/tests/util_allocator.h Tue Feb 07 21:55:37 2023 +0100
1.3 @@ -0,0 +1,81 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + */
1.31 +
1.32 +#ifndef UCX_UTIL_ALLOCATOR_H
1.33 +#define UCX_UTIL_ALLOCATOR_H
1.34 +
1.35 +#include "cx/allocator.h"
1.36 +
1.37 +#include <set>
1.38 +
1.39 +struct CxTestingAllocator : public CxAllocator {
1.40 + /**
1.41 + * Total number of all allocations (malloc, calloc, realloc).
1.42 + * A realloc() does only count when the memory has to be moved.
1.43 + */
1.44 + unsigned alloc_total = 0;
1.45 + /**
1.46 + * Number of failed allocations (malloc, calloc, realloc).
1.47 + */
1.48 + unsigned alloc_failed = 0;
1.49 + /**
1.50 + * Total number of freed pointers.
1.51 + * A reallocation also counts as a free when the memory has to be moved.
1.52 + */
1.53 + unsigned free_total = 0;
1.54 + /**
1.55 + * Number of failed free invocations.
1.56 + * A free() is considered failed, if it has not been performed on tracked memory.
1.57 + */
1.58 + unsigned free_failed = 0;
1.59 + /**
1.60 + * The set of tracked memory blocks.
1.61 + */
1.62 + std::set<void *> tracked;
1.63 +
1.64 + /**
1.65 + * Constructs a new testing allocator.
1.66 + */
1.67 + CxTestingAllocator();
1.68 +
1.69 + /**
1.70 + * Verifies that this allocator has been used.
1.71 + *
1.72 + * @return true if any allocation was attempted using this allocator
1.73 + */
1.74 + [[nodiscard]] bool used() const;
1.75 +
1.76 + /**
1.77 + * Verifies that all allocated memory blocks are freed and no free occurred twice.
1.78 + *
1.79 + * @return true iff all tracked allocations / deallocations were valid
1.80 + */
1.81 + [[nodiscard]] bool verify() const;
1.82 +};
1.83 +
1.84 +#endif // UCX_UTIL_ALLOCATOR_H
