src/allocator.c

Wed, 03 Jul 2024 22:07:42 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 03 Jul 2024 22:07:42 +0200
changeset 859
6367456bf2d9
parent 726
44986c0e2b05
permissions
-rw-r--r--

minor doc fixes

391
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 *
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 *
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
27 */
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29 #include "cx/allocator.h"
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30
452
a10c3e127050 add __alloc_size__ attribute
Mike Becker <universe@uap-core.de>
parents: 450
diff changeset
31 __attribute__((__malloc__, __alloc_size__(2)))
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
32 static void *cx_malloc_stdlib(
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
33 __attribute__((__unused__)) void *d,
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
34 size_t n
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
35 ) {
397
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
36 return malloc(n);
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
37 }
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
38
452
a10c3e127050 add __alloc_size__ attribute
Mike Becker <universe@uap-core.de>
parents: 450
diff changeset
39 __attribute__((__warn_unused_result__, __alloc_size__(3)))
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
40 static void *cx_realloc_stdlib(
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
41 __attribute__((__unused__)) void *d,
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
42 void *mem,
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
43 size_t n
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
44 ) {
397
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
45 return realloc(mem, n);
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
46 }
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
47
452
a10c3e127050 add __alloc_size__ attribute
Mike Becker <universe@uap-core.de>
parents: 450
diff changeset
48 __attribute__((__malloc__, __alloc_size__(2, 3)))
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
49 static void *cx_calloc_stdlib(
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
50 __attribute__((__unused__)) void *d,
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
51 size_t nelem,
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
52 size_t n
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
53 ) {
397
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
54 return calloc(nelem, n);
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
55 }
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
56
450
7960298039cf improves usage of attributes
Mike Becker <universe@uap-core.de>
parents: 434
diff changeset
57 __attribute__((__nonnull__))
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
58 static void cx_free_stdlib(
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
59 __attribute__((__unused__)) void *d,
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
60 void *mem
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
61 ) {
397
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
62 free(mem);
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
63 }
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
64
450
7960298039cf improves usage of attributes
Mike Becker <universe@uap-core.de>
parents: 434
diff changeset
65 static cx_allocator_class cx_default_allocator_class = {
396
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
66 cx_malloc_stdlib,
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
67 cx_realloc_stdlib,
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
68 cx_calloc_stdlib,
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
69 cx_free_stdlib
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
70 };
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
71
391
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
72 struct cx_allocator_s cx_default_allocator = {
396
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
73 &cx_default_allocator_class,
391
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
74 NULL
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
75 };
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
76 CxAllocator *cxDefaultAllocator = &cx_default_allocator;
391
f094a53c1178 adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
77
726
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
78
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
79 int cx_reallocate(
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
80 void **mem,
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
81 size_t n
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
82 ) {
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
83 void *nmem = realloc(*mem, n);
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
84 if (nmem == NULL) {
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
85 return 1;
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
86 } else {
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
87 *mem = nmem;
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
88 return 0;
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
89 }
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
90 }
44986c0e2b05 add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents: 650
diff changeset
91
628
1e2be40f0cb5 use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents: 508
diff changeset
92 // IMPLEMENTATION OF HIGH LEVEL API
434
38ee262e8b94 add attributes to allocator functions
Mike Becker <universe@uap-core.de>
parents: 414
diff changeset
93
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
94 void *cxMalloc(
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
95 CxAllocator const *allocator,
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
96 size_t n
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
97 ) {
396
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
98 return allocator->cl->malloc(allocator->data, n);
394
80c31ebd66c1 high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents: 391
diff changeset
99 }
80c31ebd66c1 high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents: 391
diff changeset
100
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
101 void *cxRealloc(
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
102 CxAllocator const *allocator,
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
103 void *mem,
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
104 size_t n
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
105 ) {
396
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
106 return allocator->cl->realloc(allocator->data, mem, n);
394
80c31ebd66c1 high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents: 391
diff changeset
107 }
80c31ebd66c1 high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents: 391
diff changeset
108
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
109 int cxReallocate(
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
110 CxAllocator const *allocator,
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
111 void **mem,
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
112 size_t n
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
113 ) {
450
7960298039cf improves usage of attributes
Mike Becker <universe@uap-core.de>
parents: 434
diff changeset
114 void *nmem = allocator->cl->realloc(allocator->data, *mem, n);
414
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
115 if (nmem == NULL) {
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
116 return 1;
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
117 } else {
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
118 *mem = nmem;
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
119 return 0;
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
120 }
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
121 }
81a4c3a63e65 adds cxReallocate()
Mike Becker <universe@uap-core.de>
parents: 397
diff changeset
122
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
123 void *cxCalloc(
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
124 CxAllocator const *allocator,
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
125 size_t nelem,
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
126 size_t n
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
127 ) {
396
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
128 return allocator->cl->calloc(allocator->data, nelem, n);
394
80c31ebd66c1 high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents: 391
diff changeset
129 }
80c31ebd66c1 high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents: 391
diff changeset
130
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
131 void cxFree(
508
8aea65ae1eaf #168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents: 500
diff changeset
132 CxAllocator const *allocator,
500
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
133 void *mem
eb9e7bd40a8e do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents: 452
diff changeset
134 ) {
396
3539dd99ab92 make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents: 394
diff changeset
135 allocator->cl->free(allocator->data, mem);
397
cfc1193b1e65 removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents: 396
diff changeset
136 }

mercurial