koliseo 0.5.7
Loading...
Searching...
No Matches
koliseo.h
Go to the documentation of this file.
1// jgabaut @ github.com/jgabaut
2// SPDX-License-Identifier: GPL-3.0-only
3/*
4 Copyright (C) 2023-2025 jgabaut
5
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, version 3 of the License.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <https://www.gnu.org/licenses/>.
17*/
18
19#ifndef KOLISEO_H_
20
21#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) //We need C11
22#define KLS_ALIGNOF _Alignof
23#elif defined(__cplusplus)
24#define KLS_ALIGNOF alignof
25#else
26#error "This code requires C11 or later.\n _Alignof() is not available"
27#endif // __STDC_VERSION__ && __STDC_VERSION__ >= 201112L //We need C11
28
29#define KOLISEO_H_
30
31#if defined(__cplusplus)
32extern "C" {
33#endif // __cplusplus
34
35#ifndef _WIN32
36#define _POSIX_C_SOURCE 200809L
37#endif
38
39#include <stdio.h>
40#include <stdint.h>
41#include <stddef.h>
42#include <stdlib.h>
43#include <stdarg.h>
44#include <assert.h>
45#include <string.h>
46#include <time.h>
47#include <stdbool.h>
48
49#ifdef KLS_DEBUG_CORE
50#include <time.h>
51
52/*
53#ifndef KOLISEO_HAS_LOCATE
54#define KOLISEO_HAS_LOCATE // Used for enabling caller location arguments for some APIs.
55#endif // KOLISEO_HAS_LOCATE
56*/
57
58#ifdef _WIN32
59#include <profileapi.h> //Used for QueryPerformanceFrequency(), QueryPerformanceCounter()
60#endif
61#endif //KLS_DEBUG_CORE
62
63#ifdef KOLISEO_HAS_LOCATE
64typedef struct Koliseo_Loc {
65 const char* file;
66 const int line;
67 const char* func;
68} Koliseo_Loc;
69
70#define KLS_HERE (Koliseo_Loc){ \
71 .file = __FILE__, \
72 .line = __LINE__, \
73 .func = __func__, \
74}
75
80#define KLS_Loc_Fmt "[%s:%i at %s():] "
81
86#define KLS_Loc_Arg(loc) (loc.file), (loc.line), (loc.func)
87#endif // KOLISEO_HAS_LOCATE
88
89#define KLS_MAJOR 0
90#define KLS_MINOR 5
91#define KLS_PATCH 7
92
93typedef void*(kls_alloc_func)(size_t);
94typedef void(kls_free_func)(void*);
95
96#define STRINGIFY_2(x) #x
97
98#define STRINGIFY(x) STRINGIFY_2(x)
99
100#define KLS_MAX(a, b) ((a) > (b) ? (a) : (b))
101
105static const int KOLISEO_API_VERSION_INT =
106 (KLS_MAJOR * 1000000 + KLS_MINOR * 10000 + KLS_PATCH * 100);
108
112static const char KOLISEO_API_VERSION_STRING[] = "0.5.7";
113
117const char *string_koliseo_version(void);
118
122int int_koliseo_version(void);
123
124#define KLS_DEFAULT_SIZE (16*1024)
125
126#ifndef KLS_DEFAULT_ALIGNMENT
127#define KLS_DEFAULT_ALIGNMENT (2*sizeof(void *))
128#endif
129
130struct Koliseo_Temp; //Forward declaration for Koliseo itself
131struct Koliseo; //Forward declaration for KLS_OOM_Handler
132
133#ifndef KOLISEO_HAS_LOCATE
134typedef void(KLS_OOM_Handler)(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, ptrdiff_t count);
135#else
136typedef void(KLS_OOM_Handler)(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, ptrdiff_t count, Koliseo_Loc loc);
137#endif
138
139#ifndef KOLISEO_HAS_LOCATE
140typedef void(KLS_PTRDIFF_MAX_Handler)(struct Koliseo* kls, ptrdiff_t size, ptrdiff_t count);
141#else
142typedef void(KLS_PTRDIFF_MAX_Handler)(struct Koliseo* kls, ptrdiff_t size, ptrdiff_t count, Koliseo_Loc loc);
143#endif
144
145#ifndef KOLISEO_HAS_LOCATE
146typedef void(KLS_ZEROCOUNT_Handler)(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size);
147#else
148typedef void(KLS_ZEROCOUNT_Handler)(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, Koliseo_Loc loc);
149#endif
150
151#ifndef KOLISEO_HAS_LOCATE
152void KLS_OOM_default_handler__(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, ptrdiff_t count);
153#else
154void KLS_OOM_default_handler_dbg__(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, ptrdiff_t count, Koliseo_Loc loc);
155#endif
156
157#ifndef KOLISEO_HAS_LOCATE
158void KLS_PTRDIFF_MAX_default_handler__(struct Koliseo* kls, ptrdiff_t size, ptrdiff_t count);
159#else
160void KLS_PTRDIFF_MAX_default_handler_dbg__(struct Koliseo* kls, ptrdiff_t size, ptrdiff_t count, Koliseo_Loc loc);
161#endif
162
163#ifndef KOLISEO_HAS_LOCATE
164void KLS_ZEROCOUNT_default_handler__(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size);
165#else
166void KLS_ZEROCOUNT_default_handler_dbg__(struct Koliseo* kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, Koliseo_Loc loc);
167#endif
168
178
179#ifndef KOLISEO_HAS_LOCATE
180#define KLS_DEFAULT_ERR_HANDLERS (KLS_Err_Handlers) { .OOM_handler = &KLS_OOM_default_handler__, .PTRDIFF_MAX_handler = &KLS_PTRDIFF_MAX_default_handler__, .ZEROCOUNT_handler = &KLS_ZEROCOUNT_default_handler__, }
181#else
182#define KLS_DEFAULT_ERR_HANDLERS (KLS_Err_Handlers) { .OOM_handler = &KLS_OOM_default_handler_dbg__, .PTRDIFF_MAX_handler = &KLS_PTRDIFF_MAX_default_handler_dbg__, .ZEROCOUNT_handler = &KLS_ZEROCOUNT_default_handler_dbg__, }
183#endif // KOLISEO_HAS_LOCATE
184
185typedef void(KLS_hook_on_new)(struct Koliseo* kls);
186
187typedef void(KLS_hook_on_free)(struct Koliseo* kls);
188
189typedef void(KLS_hook_on_push)(struct Koliseo* kls, ptrdiff_t padding, const char* caller, void* user);
190
191typedef void(KLS_hook_on_temp_start)(struct Koliseo_Temp* t_kls);
192
193typedef void(KLS_hook_on_temp_free)(struct Koliseo_Temp* t_kls);
194
195typedef void(KLS_hook_on_temp_push)(struct Koliseo_Temp* t_kls, ptrdiff_t padding, const char* caller, void* user);
196
205
213#ifndef KLS_DEFAULT_HOOKS
214#define KLS_DEFAULT_HOOKS &(KLS_Hooks){0}
215#endif // KLS_DEFAULT_HOOKS
216
223#ifndef KLS_DEFAULT_EXTENSION_DATA
224#define KLS_DEFAULT_EXTENSION_DATA NULL
225#endif // KLS_DEFAULT_EXTENSION_DATA
226
241
242KLS_Conf kls_conf_init_handled(int collect_stats, int verbose_lvl, int block_while_has_temp, int allow_zerocount_push, int growable, FILE* log_fp, const char* log_filepath, KLS_Err_Handlers err_handlers);
243
244KLS_Conf kls_conf_init(int collect_stats, int verbose_lvl, int block_while_has_temp, int allow_zerocount_push, int growable, FILE* log_fp, const char* log_filepath);
245
246void kls_dbg_features(void);
247
252typedef struct KLS_Stats {
259#ifdef KLS_DEBUG_CORE
261#endif
263
270
277
282#define KLS_Conf_Fmt "KLS_Conf { collect_stats: %i, verbose_lvl: %i, log_filepath: \"%s\", log_fp: %p, block_while_has_temp: %i, allow_zerocount_push: %i }"
283
288#define KLS_Conf_Arg(conf) (conf.kls_collect_stats),(conf.kls_verbose_lvl),(conf.kls_log_filepath),(void*)(conf.kls_log_fp),(conf.kls_block_while_has_temp),(conf.kls_allow_zerocount_push)
289
294#ifdef KLS_DEBUG_CORE
295#define KLS_Stats_Fmt "KLS_Stats { tot_pushes: %i, tot_pops: %i, tot_temp_pushes: %i, tot_temp_pops: %i, tot_hiccups: %i, worst_push_time: %.7f }"
296#else
297#define KLS_Stats_Fmt "KLS_Stats { tot_pushes: %i, tot_pops: %i, tot_temp_pushes: %i, tot_temp_pops: %i, tot_hiccups: %i }"
298#endif // KLS_DEBUG_CORE
299
304#ifdef KLS_DEBUG_CORE
305#define KLS_Stats_Arg(stats) (stats.tot_pushes),(stats.tot_pops),(stats.tot_temp_pushes),(stats.tot_temp_pops),(stats.tot_hiccups),(stats.worst_pushcall_time)
306#else
307#define KLS_Stats_Arg(stats) (stats.tot_pushes),(stats.tot_pops),(stats.tot_temp_pushes),(stats.tot_temp_pops),(stats.tot_hiccups)
308#endif // KLS_DEBUG_CORE
309
315#ifndef KLS_MAX_EXTENSIONS
316#define KLS_MAX_EXTENSIONS 1
317#endif // KLS_MAX_EXTENSIONS
318
326#ifndef KLS_DEFAULT_EXTENSIONS_LEN
327#define KLS_DEFAULT_EXTENSIONS_LEN 0
328#endif // KLS_MAX_EXTENSIONS
329
353
358#ifndef _WIN32
359#define KLSFmt "KLS {begin: %p, curr: %p, size: %li, offset: %li, has_temp: %i}"
360#else
361#define KLSFmt "KLS {begin: %p, curr: %p, size: %lli, offset: %lli, has_temp: %i}"
362#endif
363
368#define KLS_Arg(kls) (void*)(kls),(void*)((kls)+(kls->offset)),(kls->size),(kls->offset),(kls->has_temp)
369
377typedef struct Koliseo_Temp {
379 ptrdiff_t offset;
380 ptrdiff_t prev_offset;
382
383void kls_log(Koliseo * kls, const char *tag, const char *format, ...);
384ptrdiff_t kls_get_pos(const Koliseo * kls);
385
386#ifndef KOLISEO_HAS_LOCATE
387Koliseo *kls_new_alloc_ext(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
388#else
389Koliseo *kls_new_alloc_ext_dbg(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Hooks* ext_handlers, void** user, size_t ext_len, Koliseo_Loc loc);
390#define kls_new_alloc_ext(size, alloc_func, free_func, ext_handlers, user, ext_len) kls_new_alloc_ext_dbg((size), (alloc_func), (free_func), (ext_handlers), (user), (ext_len), KLS_HERE)
391#endif // KOLISEO_HAS_LOCATE
392
393#ifndef KOLISEO_HAS_LOCATE
394Koliseo *kls_new_alloc(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func);
395#else
396Koliseo *kls_new_alloc_dbg(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, Koliseo_Loc loc);
397#define kls_new_alloc(size, alloc_func, free_func) kls_new_alloc_dbg((size), (alloc_func), (free_func), KLS_HERE)
398#endif // KOLISEO_HAS_LOCATE
399
400#ifndef KLS_DEFAULT_ALLOCF
401#define KLS_DEFAULT_ALLOCF malloc
402#endif
403
404#ifndef KLS_DEFAULT_FREEF
405#define KLS_DEFAULT_FREEF free
406#endif
407
408Koliseo* kls_new(ptrdiff_t size);
409//bool kls_set_conf(Koliseo* kls, KLS_Conf conf);
410Koliseo *kls_new_conf_alloc_ext(ptrdiff_t size, KLS_Conf conf, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
412Koliseo *kls_new_conf_ext(ptrdiff_t size, KLS_Conf conf, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
413Koliseo *kls_new_conf(ptrdiff_t size, KLS_Conf conf);
414
415Koliseo *kls_new_traced_alloc_handled_ext(ptrdiff_t size, const char *output_path, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
416Koliseo *kls_new_traced_alloc_handled(ptrdiff_t size, const char *output_path, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers);
417Koliseo *kls_new_traced_ext(ptrdiff_t size, const char *output_path, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
418Koliseo *kls_new_traced_alloc(ptrdiff_t size, const char *output_path, kls_alloc_func alloc_func, kls_free_func free_func);
419Koliseo *kls_new_traced(ptrdiff_t size, const char* output_path);
420Koliseo *kls_new_traced_handled(ptrdiff_t size, const char* output_path, KLS_Err_Handlers err_handlers);
421
422Koliseo *kls_new_dbg_alloc_handled_ext(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
423Koliseo *kls_new_dbg_alloc_handled(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers);
424Koliseo *kls_new_dbg_ext(ptrdiff_t size, KLS_Hooks* ext_handlers, void** user, size_t ext_len);
425Koliseo *kls_new_dbg_alloc(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func);
426Koliseo *kls_new_dbg(ptrdiff_t size);
427Koliseo *kls_new_dbg_handled(ptrdiff_t size, KLS_Err_Handlers err_handlers);
428
429#ifndef KOLISEO_HAS_LOCATE
430int kls__check_available_failable(Koliseo* kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count, const char* caller_name);
431#else
432int kls__check_available_failable_dbg(Koliseo* kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count, const char* caller_name, Koliseo_Loc loc);
433#endif // KOLISEO_HAS_LOCATE
434
439#ifndef KOLISEO_HAS_LOCATE
440#define kls__check_available(kls, size, align, count) do { \
441 int res = kls__check_available_failable((kls), (size), (align), (count), __func__); \
442 if (res != 0) return NULL; \
443} while(0)
444#else
445#define kls__check_available_dbg(kls, size, align, count, loc) do { \
446 int res = kls__check_available_failable_dbg((kls), (size), (align), (count), __func__, (loc)); \
447 if (res != 0) return NULL; \
448} while(0)
449#endif // KOLISEO_HAS_LOCATE
450
451//void* kls_push(Koliseo* kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count);
452
453#ifndef KOLISEO_HAS_LOCATE
454void *kls_push_zero(Koliseo * kls, ptrdiff_t size, ptrdiff_t align,
455 ptrdiff_t count);
456#else
457void *kls_push_zero_dbg(Koliseo * kls, ptrdiff_t size, ptrdiff_t align,
458 ptrdiff_t count, Koliseo_Loc loc);
459
460#define kls_push_zero(kls, size, align, count) kls_push_zero_dbg((kls), (size), (align), (count), KLS_HERE)
461#endif // KOLISEO_HAS_LOCATE
462
463#ifndef KOLISEO_HAS_LOCATE
464void *kls_push_zero_ext(Koliseo * kls, ptrdiff_t size, ptrdiff_t align,
465 ptrdiff_t count);
466#else
467void *kls_push_zero_ext_dbg(Koliseo * kls, ptrdiff_t size, ptrdiff_t align,
468 ptrdiff_t count, Koliseo_Loc loc);
469#define kls_push_zero_ext(kls, size, align, count) kls_push_zero_ext_dbg((kls), (size), (align), (count), KLS_HERE)
470#endif // KOLISEO_HAS_LOCATE
471
472#ifndef KOLISEO_HAS_LOCATE
473void *kls_repush(Koliseo *kls, void* old, ptrdiff_t size, ptrdiff_t align,
474 ptrdiff_t old_count, ptrdiff_t new_count);
475#else
476void *kls_repush_dbg(Koliseo *kls, void* old, ptrdiff_t size, ptrdiff_t align,
477 ptrdiff_t old_count, ptrdiff_t new_count, Koliseo_Loc loc);
478#define kls_repush(kls, old, size, align, old_count, new_count) kls_repush_dbg((kls), (old), (size), (align), (old_count), (new_count), KLS_HERE)
479#endif // KOLISEO_HAS_LOCATE
480
481#ifndef KOLISEO_HAS_LOCATE
482void *kls_temp_repush(Koliseo_Temp *t_kls, void* old, ptrdiff_t size, ptrdiff_t align,
483 ptrdiff_t old_count, ptrdiff_t new_count);
484#else
485void *kls_temp_repush_dbg(Koliseo_Temp *t_kls, void* old, ptrdiff_t size, ptrdiff_t align,
486 ptrdiff_t old_count, ptrdiff_t new_count, Koliseo_Loc loc);
487#define kls_temp_repush(t_kls, old, size, align, old_count, new_count) kls_temp_repush_dbg((t_kls), (old), (size), (align), (old_count), (new_count), KLS_HERE)
488#endif // KOLISEO_HAS_LOCATE
489
493#define KLS_PUSH_ARR(kls, type, count) (type*)kls_push_zero_ext((kls), sizeof(type), KLS_ALIGNOF(type), (count))
494
498#define KLS_REPUSH(kls, old, type, old_count, new_count) (type*)kls_repush((kls), (old), sizeof(type), KLS_ALIGNOF(type), (old_count), (new_count))
499
503#define KLS_REPUSH_T(t_kls, old, type, old_count, new_count) (type*)kls_temp_repush((t_kls), (old), sizeof(type), KLS_ALIGNOF(type), (old_count), (new_count))
504
509#define KLS_PUSH_STR(kls, cstr) KLS_PUSH_ARR((kls), char, strlen((cstr))+1)
510
514#define KLS_PUSH_ARR_NAMED(kls, type, count, name, desc) KLS_PUSH_ARR((kls),type,(count))
515
519#define KLS_PUSH_STR_NAMED(kls, cstr, name, desc) KLS_PUSH_ARR_NAMED((kls), char, strlen((cstr))+1, (name), (desc))
520
524#define KLS_PUSH_ARR_TYPED(kls, type, count, region_type, name, desc) KLS_PUSH_ARR((kls),type,(count))
525
529#define KLS_PUSH_STR_TYPED(kls, cstr, region_type, name, desc) KLS_PUSH_ARR_TYPED((kls), char, strlen((cstr))+1, (region_type), (name), (desc))
530
534#define KLS_PUSH(kls, type) KLS_PUSH_ARR((kls), type, 1)
535
539#define KLS_PUSH_NAMED(kls, type, name, desc) KLS_PUSH_ARR_NAMED((kls), type, 1, (name), (desc))
540
545#define KLS_PUSH_EX(kls, type, name) KLS_PUSH_NAMED((kls), type, (name), STRINGIFY(type))
546
550#define KLS_PUSH_TYPED(kls, type, region_type, name, desc) KLS_PUSH_ARR_TYPED((kls), type, 1, (region_type), (name), (desc))
551
556#define KLS_PUSH_TYPED_EX(kls, type, region_type, name) KLS_PUSH_TYPED((kls), type, (region_type), (name), STRINGIFY(type))
557
558void kls_clear(Koliseo * kls);
559void kls_free(Koliseo * kls);
560void print_kls_2file(FILE * fp, const Koliseo * kls);
561void print_dbg_kls(const Koliseo * kls);
562void kls_formatSize(ptrdiff_t size, char *outputBuffer, size_t bufferSize);
563
564#ifndef KOLISEO_HAS_LOCATE
566#else
567Koliseo_Temp *kls_temp_start_dbg(Koliseo * kls, Koliseo_Loc loc);
568#define kls_temp_start(kls) kls_temp_start_dbg((kls), KLS_HERE)
569#endif // KOLISEO_HAS_LOCATE
570//bool kls_temp_set_conf(Koliseo_Temp* t_kls, KLS_Temp_Conf conf);
571void kls_temp_end(Koliseo_Temp * tmp_kls);
572
573#ifndef KOLISEO_HAS_LOCATE
574void *kls_temp_push_zero_ext(Koliseo_Temp * t_kls, ptrdiff_t size,
575 ptrdiff_t align, ptrdiff_t count);
576#else
577void *kls_temp_push_zero_ext_dbg(Koliseo_Temp * t_kls, ptrdiff_t size,
578 ptrdiff_t align, ptrdiff_t count, Koliseo_Loc loc);
579#define kls_temp_push_zero_ext(t_kls, size, align, count) kls_temp_push_zero_ext_dbg((t_kls), (size), (align), (count), KLS_HERE)
580#endif // KOLISEO_HAS_LOCATE
581
582void print_temp_kls_2file(FILE * fp, const Koliseo_Temp * t_kls);
583void print_dbg_temp_kls(const Koliseo_Temp * t_kls);
584
588#define KLS_PUSH_ARR_T(kls_temp, type, count) (type*)kls_temp_push_zero_ext((kls_temp), sizeof(type), KLS_ALIGNOF(type), (count))
589
594#define KLS_PUSH_STR_T(kls_temp, cstr) KLS_PUSH_ARR_T((kls_temp), char, strlen((cstr))+1)
595
599#define KLS_PUSH_ARR_T_NAMED(kls_temp, type, count, name, desc) KLS_PUSH_ARR_T((kls_temp),type,(count))
600
604#define KLS_PUSH_STR_T_NAMED(kls_temp, cstr, name, desc) KLS_PUSH_ARR_T_NAMED((kls_temp), char, strlen((cstr))+1, (name), (desc))
605
609#define KLS_PUSH_ARR_T_TYPED(kls_temp, type, count, region_type, name, desc) KLS_PUSH_ARR_T((kls_temp),type,(count))
610
614#define KLS_PUSH_STR_T_TYPED(kls_temp, cstr, region_type, name, desc) KLS_PUSH_ARR_T_TYPED((kls_temp), char, strlen((cstr))+1, (region_type), (name), (desc))
615
619#define KLS_PUSH_T(kls_temp, type) KLS_PUSH_ARR_T((kls_temp), type, 1)
620
624#define KLS_PUSH_T_NAMED(kls_temp, type, name, desc) KLS_PUSH_ARR_T_NAMED((kls_temp), type, 1, (name), (desc))
625
630#define KLS_PUSH_T_EX(kls_temp, type, name) KLS_PUSH_T_NAMED((kls_temp), type, (name), STRINGIFY(type))
631
635#define KLS_PUSH_T_TYPED(kls_temp, type, region_type, name, desc) KLS_PUSH_ARR_T_TYPED((kls_temp), type, 1, (region_type), (name), (desc))
636
641#define KLS_PUSH_T_TYPED_EX(kls_temp, type, region_type, name) KLS_PUSH_T_TYPED((kls_temp), type, (region_type), (name), STRINFIGY(type))
642
643#ifdef KOLISEO_HAS_EXPER
644
645void *kls_pop(Koliseo * kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count);
646void *kls_pop_AR(Koliseo *kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count);
647
652#define KLS_POP_ARR(kls, type, count) (type*)kls_pop_AR((kls), sizeof(type), KLS_ALIGNOF(type), (count))
653
658#define KLS_POP_STR(kls, cstr) KLS_POP_ARR((kls), char, strlen((cstr)))
659
664#define KLS_POP(kls, type) KLS_POP_ARR((kls), type, 1)
665
666void *kls_temp_pop(Koliseo_Temp * t_kls, ptrdiff_t size, ptrdiff_t align,
667 ptrdiff_t count);
668void *kls_temp_pop_AR(Koliseo_Temp *t_kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count);
669
674#define KLS_POP_ARR_T(kls_temp, type, count) (type*)kls_temp_pop_AR((kls_temp), sizeof(type), KLS_ALIGNOF(type), (count))
675
680#define KLS_POP_STR_T(kls_temp, cstr) KLS_POP_ARR_T((kls_temp), char, strlen((cstr)))
681
686#define KLS_POP_T(kls_temp, type) KLS_POP_ARR_T((kls_temp), type, 1)
687
688char* kls_strdup(Koliseo* kls, char* source);
689char** kls_strdup_arr(Koliseo* kls, size_t count, char** source);
690
698#define KLS__STRCPY(dest, source) do {\
699 strcpy((dest), (source));\
700} while (0)
701
702/*
703 * Macro to dupe a C string to a passed Koliseo, returns a pointer to the allocated string.
704 * Unsafe, do not use.
705 * @see kls_strdup()
706 */
707#define KLS_STRDUP(kls, source) kls_strdup((kls), (source))
708
709char* kls_t_strdup(Koliseo_Temp* t_kls, char* source);
710char** kls_t_strdup_arr(Koliseo_Temp* t_kls, size_t count, char** source);
711
712/*
713 * Macro to dupe a C string to a passed Koliseo_Temp, returns a pointer to the allocated string.
714 * Unsafe, do not use.
715 * @see kls_t_strdup()
716 */
717#define KLS_STRDUP_T(t_kls, source) kls_t_strdup((t_kls), (source))
718
719#endif // KOLISEO_HAS_EXPER
720
721#if defined(__cplusplus)
722}
723#endif // __cplusplus
724#endif //KOLISEO_H_
725
KLS_Stats KLS_STATS_DEFAULT
Default KLS_Stats values, used by kls_new().
Definition koliseo.c:41
KLS_Conf KLS_DEFAULT_CONF
Config used by any new Koliseo by default.
Definition koliseo.c:20
void kls_free_func(void *)
Used to select a free function for the arena's backing memory.
Definition koliseo.h:94
Koliseo * kls_new_traced(ptrdiff_t size, const char *output_path)
Takes a ptrdiff_t size and a filepath for the trace output file.
Definition koliseo.c:647
Koliseo * kls_new(ptrdiff_t size)
Takes a ptrdiff_t size.
Definition koliseo.c:455
char * kls_strdup(Koliseo *kls, char *source)
Function to dupe a C string to a Koliseo, and return a pointer to the allocated string.
Definition koliseo.c:2264
void * kls_temp_pop(Koliseo_Temp *t_kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo_Temp, and ptrdiff_t values for size, align and count.
Definition koliseo.c:2175
Koliseo_Temp * kls_temp_start(Koliseo *kls)
Starts a new savestate for the passed Koliseo pointer, by initialising its Koliseo_Temp pointer and r...
Definition koliseo.c:1992
void KLS_hook_on_new(struct Koliseo *kls)
Used to pass an extension handler for kls_new_alloc().
Definition koliseo.h:185
void print_dbg_temp_kls(const Koliseo_Temp *t_kls)
Prints header fields from the passed Koliseo_Temp pointer, to stderr.
Definition koliseo.c:1871
void KLS_OOM_default_handler__(struct Koliseo *kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, ptrdiff_t count)
Used by default when no handler is passed.
Definition koliseo.c:83
void * kls_temp_repush(Koliseo_Temp *t_kls, void *old, ptrdiff_t size, ptrdiff_t align, ptrdiff_t old_count, ptrdiff_t new_count)
Takes a Koliseo_Temp pointer, and a void pointer to the old allocation, ptrdiff_t values for size,...
Definition koliseo.c:1678
Koliseo * kls_new_dbg_alloc(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func)
Takes a ptrdiff_t size, an allocation function pointer and a free function pointer,...
Definition koliseo.c:748
void print_temp_kls_2file(FILE *fp, const Koliseo_Temp *t_kls)
Prints header fields from the passed Koliseo_Temp pointer, to the passed FILE pointer.
Definition koliseo.c:1832
char * kls_t_strdup(Koliseo_Temp *t_kls, char *source)
Function to dupe a C string to a Koliseo_Temp, and return a pointer to the allocated string.
Definition koliseo.c:2293
Koliseo * kls_new_traced_alloc_handled(ptrdiff_t size, const char *output_path, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers)
Takes a ptrdiff_t size, a filepath for the trace output file, an allocation function pointer and a fr...
Definition koliseo.c:594
void KLS_OOM_Handler(struct Koliseo *kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size, ptrdiff_t count)
Used to pass an error handler for Out-Of-Memory error.
Definition koliseo.h:134
void kls_log(Koliseo *kls, const char *tag, const char *format,...)
Logs a message to the log_fp FILE field of the passed Koliseo pointer, if its conf....
Definition koliseo.c:290
Koliseo * kls_new_traced_alloc_handled_ext(ptrdiff_t size, const char *output_path, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size, a filepath for the trace output file, an allocation function pointer and a fr...
Definition koliseo.c:558
void KLS_hook_on_temp_start(struct Koliseo_Temp *t_kls)
Used to pass an extension handler for kls_temp_start().
Definition koliseo.h:191
void kls_temp_end(Koliseo_Temp *tmp_kls)
Ends passed Koliseo_Temp pointer.
Definition koliseo.c:2048
void kls_dbg_features(void)
Prints enabled Koliseo features to stderr.
Definition koliseo.c:226
char ** kls_strdup_arr(Koliseo *kls, size_t count, char **source)
Function to dupe a C string array to a Koliseo, and return a pointer to the allocated array.
Definition koliseo.c:2277
void * kls_temp_push_zero_ext(Koliseo_Temp *t_kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo_Temp, and ptrdiff_t values for size, align and count.
Definition koliseo.c:1458
#define KLS_MAX_EXTENSIONS
Defines how many extensions can be handled at once.
Definition koliseo.h:316
void print_dbg_kls(const Koliseo *kls)
Prints header fields from the passed Koliseo pointer, to stderr.
Definition koliseo.c:1818
const char * string_koliseo_version(void)
Returns current koliseo version as a string.
Definition koliseo.c:59
void * kls_repush(Koliseo *kls, void *old, ptrdiff_t size, ptrdiff_t align, ptrdiff_t old_count, ptrdiff_t new_count)
Takes a Koliseo pointer, and a void pointer to the old allocation, ptrdiff_t values for size,...
Definition koliseo.c:1558
ptrdiff_t kls_get_pos(const Koliseo *kls)
Returns the current offset (position of pointer bumper) for the passed Koliseo.
Definition koliseo.c:279
void * kls_temp_pop_AR(Koliseo_Temp *t_kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo_Temp, and ptrdiff_t values for size, align and count.
Definition koliseo.c:2221
void * kls_pop_AR(Koliseo *kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo pointer, and ptrdiff_t values for size, align and count.
Definition koliseo.c:2138
void KLS_ZEROCOUNT_Handler(struct Koliseo *kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size)
Used to pass an error handler for zero-count push call error.
Definition koliseo.h:146
void kls_free(Koliseo *kls)
Calls kls_clear() on the passed Koliseo pointer and the frees the actual Koliseo.
Definition koliseo.c:1925
KLS_Conf kls_conf_init_handled(int collect_stats, int verbose_lvl, int block_while_has_temp, int allow_zerocount_push, int growable, FILE *log_fp, const char *log_filepath, KLS_Err_Handlers err_handlers)
Used to prepare a KLS_Conf without caring about KOLISEO_HAS_REGIONS.
Definition koliseo.c:169
Koliseo * kls_new_traced_ext(ptrdiff_t size, const char *output_path, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size and a filepath for the trace output file.
Definition koliseo.c:611
#define KLS_MINOR
Represents current minor release.
Definition koliseo.h:90
char ** kls_t_strdup_arr(Koliseo_Temp *t_kls, size_t count, char **source)
Function to dupe a C string array to a Koliseo_Temp, and return a pointer to the allocated array.
Definition koliseo.c:2306
void KLS_ZEROCOUNT_default_handler__(struct Koliseo *kls, ptrdiff_t available, ptrdiff_t padding, ptrdiff_t size)
Used by default when no handler is passed.
Definition koliseo.c:145
Koliseo * kls_new_dbg_alloc_handled(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers)
Takes a ptrdiff_t size, an allocation function pointer and a free function pointer,...
Definition koliseo.c:716
#define KLS_PATCH
Represents current patch release.
Definition koliseo.h:91
void * kls_alloc_func(size_t)
Used to select an allocation function for the arena's backing memory.
Definition koliseo.h:93
void * kls_push_zero(Koliseo *kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo pointer, and ptrdiff_t values for size, align and count.
Definition koliseo.c:1248
Koliseo * kls_new_alloc(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func)
Takes a ptrdiff_t size and a function pointer to the allocation function.
Definition koliseo.c:431
Koliseo * kls_new_dbg(ptrdiff_t size)
Takes a ptrdiff_t size and returns a pointer to the prepared Koliseo.
Definition koliseo.c:763
void KLS_hook_on_free(struct Koliseo *kls)
Used to pass an extension handler for kls_free().
Definition koliseo.h:187
int kls__check_available_failable(Koliseo *kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count, const char *caller_name)
Takes a Koliseo, a ptrdiff_t size, align and count, and a caller name.
Definition koliseo.c:906
Koliseo * kls_new_traced_alloc(ptrdiff_t size, const char *output_path, kls_alloc_func alloc_func, kls_free_func free_func)
Takes a ptrdiff_t size, a filepath for the trace output file, an allocation function pointer and a fr...
Definition koliseo.c:630
void KLS_hook_on_temp_push(struct Koliseo_Temp *t_kls, ptrdiff_t padding, const char *caller, void *user)
Used to pass an extension handler for kls_temp_push().
Definition koliseo.h:195
Koliseo * kls_new_conf_alloc_ext(ptrdiff_t size, KLS_Conf conf, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size, a KLS_Conf to configure the new Koliseo, an allocation function pointer and a...
Definition koliseo.c:476
Koliseo * kls_new_traced_handled(ptrdiff_t size, const char *output_path, KLS_Err_Handlers err_handlers)
Takes a ptrdiff_t size and a filepath for the trace output file.
Definition koliseo.c:664
Koliseo * kls_new_conf_alloc(ptrdiff_t size, KLS_Conf conf, kls_alloc_func alloc_func, kls_free_func kls_free_func)
Takes a ptrdiff_t size, a KLS_Conf to configure the new Koliseo, an allocation function pointer and a...
Definition koliseo.c:505
void * kls_pop(Koliseo *kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo pointer, and ptrdiff_t values for size, align and count.
Definition koliseo.c:2101
void KLS_hook_on_temp_free(struct Koliseo_Temp *t_kls)
Used to pass an extension handler for kls_temp_end().
Definition koliseo.h:193
void KLS_PTRDIFF_MAX_default_handler__(struct Koliseo *kls, ptrdiff_t size, ptrdiff_t count)
Used by default when no handler is passed.
Definition koliseo.c:103
void KLS_hook_on_push(struct Koliseo *kls, ptrdiff_t padding, const char *caller, void *user)
Used to pass an extension handler for kls_push().
Definition koliseo.h:189
KLS_Conf kls_conf_init(int collect_stats, int verbose_lvl, int block_while_has_temp, int allow_zerocount_push, int growable, FILE *log_fp, const char *log_filepath)
Used to prepare a KLS_Conf without caring about KOLISEO_HAS_REGIONS.
Definition koliseo.c:217
Koliseo * kls_new_dbg_ext(ptrdiff_t size, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size.
Definition koliseo.c:731
Koliseo * kls_new_alloc_ext(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size and a function pointer to the allocation function.
Definition koliseo.c:336
void print_kls_2file(FILE *fp, const Koliseo *kls)
Prints header fields from the passed Koliseo pointer, to the passed FILE pointer.
Definition koliseo.c:1787
Koliseo * kls_new_dbg_alloc_handled_ext(ptrdiff_t size, kls_alloc_func alloc_func, kls_free_func free_func, KLS_Err_Handlers err_handlers, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size, an allocation function pointer and a free function pointer,...
Definition koliseo.c:682
Koliseo * kls_new_dbg_handled(ptrdiff_t size, KLS_Err_Handlers err_handlers)
Takes a ptrdiff_t size and returns a pointer to the prepared Koliseo.
Definition koliseo.c:778
void KLS_PTRDIFF_MAX_Handler(struct Koliseo *kls, ptrdiff_t size, ptrdiff_t count)
Used to pass an error handler for count > (PTRDIFF_MAX / size) error.
Definition koliseo.h:140
void kls_clear(Koliseo *kls)
Resets the offset field for the passed Koliseo pointer.
Definition koliseo.c:1905
void * kls_push_zero_ext(Koliseo *kls, ptrdiff_t size, ptrdiff_t align, ptrdiff_t count)
Takes a Koliseo pointer, and ptrdiff_t values for size, align and count.
Definition koliseo.c:1340
void kls_formatSize(ptrdiff_t size, char *outputBuffer, size_t bufferSize)
Converts a ptrdiff_t size to human-readable SI units (modulo 1000).
Definition koliseo.c:1883
#define KLS_MAJOR
Represents current major release.
Definition koliseo.h:89
int int_koliseo_version(void)
Returns current koliseo version as an integer.
Definition koliseo.c:68
Koliseo * kls_new_conf(ptrdiff_t size, KLS_Conf conf)
Takes a ptrdiff_t size and a KLS_Conf to configure the new Koliseo.
Definition koliseo.c:538
Koliseo * kls_new_conf_ext(ptrdiff_t size, KLS_Conf conf, KLS_Hooks *ext_handlers, void **user, size_t ext_len)
Takes a ptrdiff_t size and a KLS_Conf to configure the new Koliseo.
Definition koliseo.c:522
Defines flags for Koliseo.
Definition koliseo.h:231
int kls_growable
If set to 1, make the Koliseo grow when a out of memory for a push call.
Definition koliseo.h:238
int kls_collect_stats
If set to 1, make the Koliseo collect performance stats.
Definition koliseo.h:232
int kls_allow_zerocount_push
If set to 1, make the Koliseo accept push calls with a count of 0.
Definition koliseo.h:237
int kls_block_while_has_temp
If set to 1, make the Koliseo reject push calls while it has an open Koliseo_Temp.
Definition koliseo.h:236
int kls_verbose_lvl
If > 0, makes the Koliseo try to acquire kls_log_fp from kls_log_filepath.
Definition koliseo.h:233
KLS_Err_Handlers err_handlers
Used to pass custom error handlers for push calls.
Definition koliseo.h:239
const char * kls_log_filepath
String representing the path to the Koliseo logfile.
Definition koliseo.h:235
FILE * kls_log_fp
FILE pointer used by the Koliseo to print its kls_log() output.
Definition koliseo.h:234
Defines the handlers used for errors in push calls.
Definition koliseo.h:173
KLS_OOM_Handler * OOM_handler
Pointer to handler for Out-Of-Memory errors in push calls.
Definition koliseo.h:174
KLS_ZEROCOUNT_Handler * ZEROCOUNT_handler
Pointer to handler for zero-count errors in push calls.
Definition koliseo.h:176
KLS_PTRDIFF_MAX_Handler * PTRDIFF_MAX_handler
Pointer to handler for count > (PTRDIFF_MAX / size) errors in push calls.
Definition koliseo.h:175
Definition koliseo.h:197
KLS_hook_on_temp_start * on_temp_start_handler
Used to pass custom start handler for kls_temp_start calls.
Definition koliseo.h:201
KLS_hook_on_free * on_free_handler
Used to pass custom free handler for kls_free calls.
Definition koliseo.h:199
KLS_hook_on_temp_free * on_temp_free_handler
Used to pass custom free handler for kls_temp_end calls.
Definition koliseo.h:202
KLS_hook_on_push * on_push_handler
Used to pass custom push handler for kls_push calls.
Definition koliseo.h:200
KLS_hook_on_new * on_new_handler
Used to pass custom new handler for kls_new_alloc calls.
Definition koliseo.h:198
KLS_hook_on_temp_push * on_temp_push_handler
Used to pass custom push handler for kls_temp_push calls.
Definition koliseo.h:203
Defines a stat struct for Koliseo.
Definition koliseo.h:252
int tot_pops
Total POP calls done.
Definition koliseo.h:255
double worst_pushcall_time
Longest time taken by a PUSH call.
Definition koliseo.h:260
int tot_temp_pushes
Total PUSH_T calls done.
Definition koliseo.h:254
int tot_pushes
Total PUSH calls done.
Definition koliseo.h:253
int tot_hiccups
Total hiccups encountered.
Definition koliseo.h:258
int tot_logcalls
Total kls_log() calls done.
Definition koliseo.h:257
int tot_temp_pops
Total POP_T calls done.
Definition koliseo.h:256
Represents a savestate for a Koliseo.
Definition koliseo.h:377
ptrdiff_t offset
Current position of memory pointer.
Definition koliseo.h:379
ptrdiff_t prev_offset
Previous position of memory pointer.
Definition koliseo.h:380
Koliseo * kls
Reference to the actual Koliseo we're saving.
Definition koliseo.h:378
Represents the initialised arena allocator struct.
Definition koliseo.h:338
ptrdiff_t size
Size of data field.
Definition koliseo.h:340
ptrdiff_t offset
Current position of memory pointer.
Definition koliseo.h:341
ptrdiff_t prev_offset
Previous position of memory pointer.
Definition koliseo.h:342
KLS_Conf conf
Contains flags to change the Koliseo behaviour.
Definition koliseo.h:344
void * extension_data[KLS_MAX_EXTENSIONS]
Points to data for extensions.
Definition koliseo.h:348
struct Koliseo_Temp * t_kls
Points to related active Kolieo_Temp, when has_temp == 1.
Definition koliseo.h:346
char * data
Points to data field.
Definition koliseo.h:339
size_t hooks_len
Length for hooks and extension_data.
Definition koliseo.h:349
struct Koliseo * next
Points to the next Koliseo when conf.kls_growable == 1.
Definition koliseo.h:351
int has_temp
When == 1, a Koliseo_Temp is currently active on this Koliseo.
Definition koliseo.h:343
KLS_Stats stats
Contains stats for Koliseo performance analysis.
Definition koliseo.h:345
KLS_Hooks hooks[KLS_MAX_EXTENSIONS]
Contains handlers for extensions.
Definition koliseo.h:347
kls_free_func * free_func
Points to the free function for the arena's backing memory.
Definition koliseo.h:350