1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/test/util_allocator.h Sun Sep 26 14:41:16 2021 +0200
1.3 @@ -0,0 +1,90 @@
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 +#ifdef __cplusplus
1.38 +extern "C" {
1.39 +#endif
1.40 +
1.41 +#define CX_TESTING_ALLOCATOR_MAX_LIVE 1024
1.42 +
1.43 +typedef struct {
1.44 + /**
1.45 + * Total number of all allocations (malloc, calloc, realloc).
1.46 + * A realloc() does only count when the memory has to be moved.
1.47 + */
1.48 + int alloc_total;
1.49 + /**
1.50 + * Number of failed allocations (malloc, calloc, realloc).
1.51 + */
1.52 + int alloc_failed;
1.53 + /**
1.54 + * Total number of freed pointers.
1.55 + * A reallocation also counts as a free when the memory has to be moved.
1.56 + */
1.57 + int free_total;
1.58 + /**
1.59 + * Number of failed free invocations.
1.60 + * A free() is considered failed, if it has not been performed on tracked memory.
1.61 + */
1.62 + int free_failed;
1.63 + /**
1.64 + * Number of memory blocks that are currently live (and tracked).
1.65 + * The maximum number of tracked blocks is defined in #CX_TESTING_ALLOCATOR_MAX_LIVE.
1.66 + */
1.67 + int live;
1.68 + /**
1.69 + * The array of tracked memory blocks.
1.70 + */
1.71 + void *tracked[CX_TESTING_ALLOCATOR_MAX_LIVE];
1.72 +} cx_testing_allocator_s;
1.73 +
1.74 +extern CxAllocator cxTestingAllocator;
1.75 +
1.76 +/**
1.77 + * Resets the testing allocator information.
1.78 + * This function SHOULD be called prior to any use of this allocator.
1.79 + */
1.80 +void cxTestingAllocatorReset(void);
1.81 +
1.82 +/**
1.83 + * Checks whether all allocated memory is properly freed and no failed (de)allocations happened.
1.84 + *
1.85 + * @return true on success, false if there was any problem
1.86 + */
1.87 +int cxTestingAllocatorVerify(void);
1.88 +
1.89 +#ifdef __cplusplus
1.90 +}; /* extern "C" */
1.91 +#endif
1.92 +
1.93 +#endif /* UCX_UTIL_ALLOCATOR_H */
