test/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_UTIL_ALLOCATOR_H
#define UCX_UTIL_ALLOCATOR_H

#include "cx/allocator.h"

#ifdef __cplusplus
extern "C" {
#endif

#define CX_TESTING_ALLOCATOR_MAX_LIVE 1024

typedef struct {
    /**
     * Total number of all allocations (malloc, calloc, realloc).
     * A realloc() does only count when the memory has to be moved.
     */
    int alloc_total;
    /**
     * Number of failed allocations (malloc, calloc, realloc).
     */
    int alloc_failed;
    /**
     * Total number of freed pointers.
     * A reallocation also counts as a free when the memory has to be moved.
     */
    int free_total;
    /**
     * Number of failed free invocations.
     * A free() is considered failed, if it has not been performed on tracked memory.
     */
    int free_failed;
    /**
     * Number of memory blocks that are currently live (and tracked).
     * The maximum number of tracked blocks is defined in #CX_TESTING_ALLOCATOR_MAX_LIVE.
     */
    int live;
    /**
     * The array of tracked memory blocks.
     */
    void *tracked[CX_TESTING_ALLOCATOR_MAX_LIVE];
} cx_testing_allocator_s;

extern CxAllocator cxTestingAllocator;

/**
 * Resets the testing allocator information.
 * This function SHOULD be called prior to any use of this allocator.
 */
void cxTestingAllocatorReset(void);

/**
 * Checks whether all allocated memory is properly freed and no failed (de)allocations happened.
 *
 * @return true on success, false if there was any problem
 */
bool cxTestingAllocatorVerify(void);

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

#endif /* UCX_UTIL_ALLOCATOR_H */