universe@422: /*
universe@422:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@422:  *
universe@422:  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
universe@422:  *
universe@422:  * Redistribution and use in source and binary forms, with or without
universe@422:  * modification, are permitted provided that the following conditions are met:
universe@422:  *
universe@422:  *   1. Redistributions of source code must retain the above copyright
universe@422:  *      notice, this list of conditions and the following disclaimer.
universe@422:  *
universe@422:  *   2. Redistributions in binary form must reproduce the above copyright
universe@422:  *      notice, this list of conditions and the following disclaimer in the
universe@422:  *      documentation and/or other materials provided with the distribution.
universe@422:  *
universe@422:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@422:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@422:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@422:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@422:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@422:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@422:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@422:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@422:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@422:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@422:  * POSSIBILITY OF SUCH DAMAGE.
universe@422:  */
universe@422: 
universe@422: #ifndef UCX_UTIL_ALLOCATOR_H
universe@422: #define UCX_UTIL_ALLOCATOR_H
universe@422: 
universe@422: #include "cx/allocator.h"
universe@422: 
universe@422: #ifdef __cplusplus
universe@422: extern "C" {
universe@422: #endif
universe@422: 
universe@422: #define CX_TESTING_ALLOCATOR_MAX_LIVE 1024
universe@422: 
universe@422: typedef struct {
universe@422:     /**
universe@422:      * Total number of all allocations (malloc, calloc, realloc).
universe@422:      * A realloc() does only count when the memory has to be moved.
universe@422:      */
universe@422:     int alloc_total;
universe@422:     /**
universe@422:      * Number of failed allocations (malloc, calloc, realloc).
universe@422:      */
universe@422:     int alloc_failed;
universe@422:     /**
universe@422:      * Total number of freed pointers.
universe@422:      * A reallocation also counts as a free when the memory has to be moved.
universe@422:      */
universe@422:     int free_total;
universe@422:     /**
universe@422:      * Number of failed free invocations.
universe@422:      * A free() is considered failed, if it has not been performed on tracked memory.
universe@422:      */
universe@422:     int free_failed;
universe@422:     /**
universe@422:      * Number of memory blocks that are currently live (and tracked).
universe@422:      * The maximum number of tracked blocks is defined in #CX_TESTING_ALLOCATOR_MAX_LIVE.
universe@422:      */
universe@422:     int live;
universe@422:     /**
universe@422:      * The array of tracked memory blocks.
universe@422:      */
universe@422:     void *tracked[CX_TESTING_ALLOCATOR_MAX_LIVE];
universe@422: } cx_testing_allocator_s;
universe@422: 
universe@422: extern CxAllocator cxTestingAllocator;
universe@422: 
universe@422: /**
universe@422:  * Resets the testing allocator information.
universe@422:  * This function SHOULD be called prior to any use of this allocator.
universe@422:  */
universe@422: void cxTestingAllocatorReset(void);
universe@422: 
universe@422: /**
universe@422:  * Checks whether all allocated memory is properly freed and no failed (de)allocations happened.
universe@422:  *
universe@422:  * @return true on success, false if there was any problem
universe@422:  */
universe@422: int cxTestingAllocatorVerify(void);
universe@422: 
universe@422: #ifdef __cplusplus
universe@422: }; /* extern "C" */
universe@422: #endif
universe@422: 
universe@422: #endif /* UCX_UTIL_ALLOCATOR_H */