# HG changeset patch # User Mike Becker # Date 1632660351 -7200 # Node ID ec92b4ed23aaa7fcfb3c98bf750041c16fa05066 # Parent 4cea6e50175b3536f32263543b10259210958199# Parent 9aa38cd4c992f456099d80edbe960cd397cbf393 Automated merge diff -r 9aa38cd4c992 -r ec92b4ed23aa CMakeLists.txt --- a/CMakeLists.txt Sun Sep 26 14:41:49 2021 +0200 +++ b/CMakeLists.txt Sun Sep 26 14:45:51 2021 +0200 @@ -16,14 +16,16 @@ add_subdirectory(docs/src) # API Documentation +message(CHECK_START "Seaching for Doxygen") find_package(Doxygen) -option(BUILD_DOCUMENTATION "Create API documentation." ${DOXYGEN_FOUND}) +if(DOXYGEN_FOUND) + message(CHECK_PASS "found.") +else() + message(CHECK_FAIL "not found - documentation will not be generated.") +endif() +option(BUILD_API_DOC "Create API documentation." ON) -if(BUILD_DOCUMENTATION) - if(NOT DOXYGEN_FOUND) - message(FATAL_ERROR "Doxygen is needed to build the documentation.") - endif() - +if(BUILD_API_DOC AND DOXYGEN_FOUND) set(DOXY_INPUT ${CMAKE_SOURCE_DIR}/src) set(DOXY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/docs) set(DOXY_PROJECT_LOGO ${CMAKE_SOURCE_DIR}/uaplogo.png) diff -r 9aa38cd4c992 -r ec92b4ed23aa src/linked_list.c --- a/src/linked_list.c Sun Sep 26 14:41:49 2021 +0200 +++ b/src/linked_list.c Sun Sep 26 14:45:51 2021 +0200 @@ -171,7 +171,8 @@ } void cxLinkedListDestroy(CxList list) { - + // TODO: free contents + cxFree(list->data.allocator, list); } size_t cxLinkedListRecalculateSize(CxList list) { diff -r 9aa38cd4c992 -r ec92b4ed23aa test/CMakeLists.txt --- a/test/CMakeLists.txt Sun Sep 26 14:41:49 2021 +0200 +++ b/test/CMakeLists.txt Sun Sep 26 14:45:51 2021 +0200 @@ -14,7 +14,7 @@ ) foreach(test ${TESTS}) - add_executable(${test} ${test}.c) + add_executable(${test} util_allocator.c ${test}.c) target_link_libraries(${test} PRIVATE ucx_static ${CUNIT_LIBRARY}) target_include_directories(${test} PRIVATE ${CUNIT_INCLUDE_DIR}) add_test(NAME ${test} COMMAND ${test} WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}") diff -r 9aa38cd4c992 -r ec92b4ed23aa test/test_allocator.c --- a/test/test_allocator.c Sun Sep 26 14:41:49 2021 +0200 +++ b/test/test_allocator.c Sun Sep 26 14:45:51 2021 +0200 @@ -28,6 +28,7 @@ #include "cx/allocator.h" #include "test_config.h" +#include void test_default_allocator_available(void) { cx_allocator_class *clazz = cxDefaultAllocator->cl; @@ -42,7 +43,7 @@ void test_default_realloc(void) { void *test = calloc(8, 1); - memcpy(test, "Test", 4); + memcpy(test, "Test", 5); test = cxRealloc(cxDefaultAllocator, test, 16); CU_ASSERT_PTR_NOT_NULL(test) CU_ASSERT_STRING_EQUAL("Test", test) @@ -51,7 +52,7 @@ void test_default_reallocate(void) { void *test = calloc(8, 1); - memcpy(test, "Test", 4); + memcpy(test, "Test", 5); int rval = cxReallocate(cxDefaultAllocator, &test, 16); CU_ASSERT_EQUAL(rval, 0); CU_ASSERT_PTR_NOT_NULL(test) @@ -61,7 +62,8 @@ void test_reallocate_null(void) { int rval = cxReallocate(cxDefaultAllocator, NULL, 16); - CU_ASSERT_EQUAL(rval, EINVAL); + CU_ASSERT_NOT_EQUAL(rval, 0); + CU_ASSERT_EQUAL(errno, EINVAL); } void test_default_calloc(void) { @@ -94,7 +96,7 @@ !CU_add_test(suite, "test of malloc()", test_default_malloc)|| !CU_add_test(suite, "test of realloc()", test_default_realloc) || !CU_add_test(suite, "test of realloc() via cxReallocate", test_default_reallocate) || - !CU_add_test(suite, "test of cxReallocate with NULL", test_default_reallocate) || + !CU_add_test(suite, "test of cxReallocate with NULL", test_reallocate_null) || !CU_add_test(suite, "test of calloc()", test_default_calloc) || !CU_add_test(suite, "test of free()", test_default_free) ) { diff -r 9aa38cd4c992 -r ec92b4ed23aa test/test_list.c --- a/test/test_list.c Sun Sep 26 14:41:49 2021 +0200 +++ b/test/test_list.c Sun Sep 26 14:45:51 2021 +0200 @@ -28,6 +28,7 @@ #include "cx/linked_list.h" #include "test_config.h" +#include "util_allocator.h" int cmp_int(int const *l, int const *r) { int left = *l, right = *r; @@ -35,27 +36,32 @@ } void test_linked_list_create() { - CxList list = cxLinkedListCreate(cxDefaultAllocator, (CxListComparator) cmp_int, sizeof(int)); + cxTestingAllocatorReset(); + + CxList list = cxLinkedListCreate(cxTestingAllocator, (CxListComparator) cmp_int, sizeof(int)); CU_ASSERT_EQUAL(list->data.size, 0) CU_ASSERT_EQUAL(list->data.capacity, (size_t) -1) - CU_ASSERT_PTR_EQUAL(list->data.allocator, cxDefaultAllocator) + CU_ASSERT_PTR_EQUAL(list->data.allocator, cxTestingAllocator) CU_ASSERT_EQUAL(list->data.itemsize, sizeof(int)) CU_ASSERT_PTR_EQUAL(list->data.cmpfunc, cmp_int) struct node { - void* begin; void* end; ptrdiff_t ploc; ptrdiff_t nloc; + void *begin; + void *end; + ptrdiff_t ploc; + ptrdiff_t nloc; }; - struct node* actual = (struct node*) list->data.listdata; + struct node *actual = (struct node *) list->data.listdata; CU_ASSERT_PTR_NULL(actual->begin) CU_ASSERT_PTR_NULL(actual->end) CU_ASSERT_EQUAL(0, actual->ploc) - CU_ASSERT_EQUAL(sizeof(void*), actual->nloc) + CU_ASSERT_EQUAL(sizeof(void *), actual->nloc) cxLinkedListDestroy(list); - // TODO: use allocator that keeps track of the freed memory + CU_ASSERT_TRUE(cxTestingAllocatorVerify()) } int main() { diff -r 9aa38cd4c992 -r ec92b4ed23aa test/util_allocator.c --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test/util_allocator.c Sun Sep 26 14:45:51 2021 +0200 @@ -0,0 +1,126 @@ +/* + * 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. + */ + +#include "util_allocator.h" +#include + +void cx_testing_allocator_add(cx_testing_allocator_s *data, void *ptr) { + data->tracked[data->live] = ptr; + data->live++; +} + +int cx_testing_allocator_remove(cx_testing_allocator_s *data, void *ptr) { + for (int i = 0; i < data->live; i++) { + if (data->tracked[i] == ptr) { + data->tracked[i] = data->tracked[data->live - 1]; + data->live--; + return 0; + } + } + return 1; +} + +void *cx_malloc_testing(void *d, size_t n) { + cx_testing_allocator_s *data = d; + void *ptr = malloc(n); + data->alloc_total++; + if (ptr == NULL) { + data->alloc_failed++; + } else { + cx_testing_allocator_add(data, ptr); + } + return ptr; +} + +void *cx_realloc_testing(void *d, void *mem, size_t n) { + cx_testing_allocator_s *data = d; + void *ptr = realloc(mem, n); + if (ptr == mem) { + return ptr; + } else { + data->alloc_total++; + if (ptr == NULL) { + data->alloc_failed++; + } else { + data->free_total++; + if (cx_testing_allocator_remove(data, mem)) { + data->free_failed++; + } + cx_testing_allocator_add(data, ptr); + } + return ptr; + } +} + +void *cx_calloc_testing(void *d, size_t nelem, size_t n) { + cx_testing_allocator_s *data = d; + void *ptr = calloc(nelem, n); + data->alloc_total++; + if (ptr == NULL) { + data->alloc_failed++; + } else { + cx_testing_allocator_add(data, ptr); + } + return ptr; +} + +void cx_free_testing(void *d, void *mem) { + cx_testing_allocator_s *data = d; + data->free_total++; + if (cx_testing_allocator_remove(data, mem)) { + data->free_failed++; + // do not even attempt to free mem, because it is likely to segfault + } else { + free(mem); + } +} + +cx_allocator_class cx_testing_allocator_class = { + cx_malloc_testing, + cx_realloc_testing, + cx_calloc_testing, + cx_free_testing +}; + +cx_testing_allocator_s cx_testing_allocator_data; + +struct cx_allocator_s cx_testing_allocator = { + &cx_testing_allocator_class, + &cx_testing_allocator_data +}; +CxAllocator cxTestingAllocator = &cx_testing_allocator; + +void cxTestingAllocatorReset(void) { + memset(&cx_testing_allocator_data, 0, sizeof(cx_testing_allocator_s)); +} + +int cxTestingAllocatorVerify(void) { + return cx_testing_allocator_data.live == 0 + && cx_testing_allocator_data.alloc_failed == 0 && cx_testing_allocator_data.free_failed == 0 + && cx_testing_allocator_data.alloc_total == cx_testing_allocator_data.free_total; +} diff -r 9aa38cd4c992 -r ec92b4ed23aa test/util_allocator.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/test/util_allocator.h Sun Sep 26 14:45:51 2021 +0200 @@ -0,0 +1,90 @@ +/* + * 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 + */ +int cxTestingAllocatorVerify(void); + +#ifdef __cplusplus +}; /* extern "C" */ +#endif + +#endif /* UCX_UTIL_ALLOCATOR_H */