tests/util_allocator.h

/*
 * 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_TEST_UTIL_ALLOCATOR_H
#define UCX_TEST_UTIL_ALLOCATOR_H

#include "cx/allocator.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * An allocator that verifies allocations / deallocations during testing.
 *
 * @par Typical Use
 * @code
 * CxTestingAllocator talloc;
 * cx_testing_allocator_init(&talloc);
 * CxAllocator *alloc = &talloc.base;
 * CX_TEST_DO {
 *     // do your tests and use alloc as allocator for all API calls
 *     // ...
 *     // optional: check that the allocator was used
 *     CX_TEST_ASSERT(cx_testing_allocator_used(&talloc));
 *     // verify
 *     CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
 * }
 * cx_testing_allocator_destroy(&talloc);
 * @endcode
 */
typedef struct CxTestingAllocator {
    CxAllocator base;
    /**
     * Total number of all allocations (malloc, calloc, realloc).
     * A realloc() does only count when the memory has to be moved.
     */
    unsigned alloc_total;
    /**
     * Number of failed allocations (malloc, calloc, realloc).
     */
    unsigned alloc_failed;
    /**
     * Total number of freed pointers.
     * A reallocation also counts as a free when the memory has to be moved.
     */
    unsigned free_total;
    /**
     * Number of failed free invocations.
     * A free() is considered failed, if it has not been performed on tracked memory.
     */
    unsigned free_failed;
    /**
     * The number of currently tracked memory blocks.
     */
    size_t tracked_count;
    /**
     * The capaciyty of the @c tracked array.
     */
    size_t tracked_capacity;
    /**
     * The set of tracked memory blocks.
     */
    void **tracked;
} CxTestingAllocator;


/**
 * Initializes a new testing allocator.
 * @see cx_testing_allocator_destroy()
 */
void cx_testing_allocator_init(CxTestingAllocator *alloc);

/**
 * Destroys a testing allocator.
 * @see cx_testing_allocator_init()
 */
void cx_testing_allocator_destroy(CxTestingAllocator *alloc);

/**
 * Verifies that this allocator has been used.
 *
 * @return true iff any allocation was attempted using this allocator
 */
bool cx_testing_allocator_used(const CxTestingAllocator *alloc);

/**
 * Verifies that all allocated memory blocks are freed and no free occurred twice.
 *
 * @return true iff all tracked allocations / deallocations were valid
 */
bool cx_testing_allocator_verify(const CxTestingAllocator *alloc);

#ifdef __cplusplus
} // extern "C"
#endif

#endif // UCX_TEST_UTIL_ALLOCATOR_H