Flecs v3.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
os_api.h
Go to the documentation of this file.
1
13#ifndef FLECS_OS_API_H
14#define FLECS_OS_API_H
15
24#include <stdarg.h>
25#include <errno.h>
26
27#if defined(ECS_TARGET_WINDOWS)
28#include <malloc.h>
29#elif defined(ECS_TARGET_FREEBSD)
30#include <stdlib.h>
31#else
32#include <alloca.h>
33#endif
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39typedef struct ecs_time_t {
40 uint32_t sec;
41 uint32_t nanosec;
43
44/* Allocation counters */
45extern int64_t ecs_os_api_malloc_count;
46extern int64_t ecs_os_api_realloc_count;
47extern int64_t ecs_os_api_calloc_count;
48extern int64_t ecs_os_api_free_count;
49
50/* Use handle types that _at least_ can store pointers */
51typedef uintptr_t ecs_os_thread_t;
52typedef uintptr_t ecs_os_cond_t;
53typedef uintptr_t ecs_os_mutex_t;
54typedef uintptr_t ecs_os_dl_t;
55typedef uintptr_t ecs_os_sock_t;
56
57/* 64 bit thread id */
58typedef uint64_t ecs_os_thread_id_t;
59
60/* Generic function pointer type */
61typedef void (*ecs_os_proc_t)(void);
62
63/* OS API init */
64typedef
65void (*ecs_os_api_init_t)(void);
66
67/* OS API deinit */
68typedef
69void (*ecs_os_api_fini_t)(void);
70
71/* Memory management */
72typedef
73void* (*ecs_os_api_malloc_t)(
74 ecs_size_t size);
75
76typedef
77void (*ecs_os_api_free_t)(
78 void *ptr);
79
80typedef
81void* (*ecs_os_api_realloc_t)(
82 void *ptr,
83 ecs_size_t size);
84
85typedef
86void* (*ecs_os_api_calloc_t)(
87 ecs_size_t size);
88
89typedef
90char* (*ecs_os_api_strdup_t)(
91 const char *str);
92
93/* Threads */
94typedef
95void* (*ecs_os_thread_callback_t)(
96 void*);
97
98typedef
99ecs_os_thread_t (*ecs_os_api_thread_new_t)(
100 ecs_os_thread_callback_t callback,
101 void *param);
102
103typedef
104void* (*ecs_os_api_thread_join_t)(
105 ecs_os_thread_t thread);
106
107typedef
108ecs_os_thread_id_t (*ecs_os_api_thread_self_t)(void);
109
110/* Atomic increment / decrement */
111typedef
112int32_t (*ecs_os_api_ainc_t)(
113 int32_t *value);
114
115typedef
116int64_t (*ecs_os_api_lainc_t)(
117 int64_t *value);
118
119/* Mutex */
120typedef
121ecs_os_mutex_t (*ecs_os_api_mutex_new_t)(
122 void);
123
124typedef
125void (*ecs_os_api_mutex_lock_t)(
126 ecs_os_mutex_t mutex);
127
128typedef
129void (*ecs_os_api_mutex_unlock_t)(
130 ecs_os_mutex_t mutex);
131
132typedef
133void (*ecs_os_api_mutex_free_t)(
134 ecs_os_mutex_t mutex);
135
136/* Condition variable */
137typedef
138ecs_os_cond_t (*ecs_os_api_cond_new_t)(
139 void);
140
141typedef
142void (*ecs_os_api_cond_free_t)(
143 ecs_os_cond_t cond);
144
145typedef
146void (*ecs_os_api_cond_signal_t)(
147 ecs_os_cond_t cond);
148
149typedef
150void (*ecs_os_api_cond_broadcast_t)(
151 ecs_os_cond_t cond);
152
153typedef
154void (*ecs_os_api_cond_wait_t)(
155 ecs_os_cond_t cond,
156 ecs_os_mutex_t mutex);
157
158typedef
159void (*ecs_os_api_sleep_t)(
160 int32_t sec,
161 int32_t nanosec);
162
163typedef
164void (*ecs_os_api_enable_high_timer_resolution_t)(
165 bool enable);
166
167typedef
168void (*ecs_os_api_get_time_t)(
169 ecs_time_t *time_out);
170
171typedef
172uint64_t (*ecs_os_api_now_t)(void);
173
174/* Logging */
175typedef
176void (*ecs_os_api_log_t)(
177 int32_t level, /* Logging level */
178 const char *file, /* File where message was logged */
179 int32_t line, /* Line it was logged */
180 const char *msg);
181
182/* Application termination */
183typedef
184void (*ecs_os_api_abort_t)(
185 void);
186
187/* Dynamic libraries */
188typedef
189ecs_os_dl_t (*ecs_os_api_dlopen_t)(
190 const char *libname);
191
192typedef
193ecs_os_proc_t (*ecs_os_api_dlproc_t)(
194 ecs_os_dl_t lib,
195 const char *procname);
196
197typedef
198void (*ecs_os_api_dlclose_t)(
199 ecs_os_dl_t lib);
200
201typedef
202char* (*ecs_os_api_module_to_path_t)(
203 const char *module_id);
204
205/* Prefix members of struct with 'ecs_' as some system headers may define
206 * macros for functions like "strdup", "log" or "_free" */
207
208typedef struct ecs_os_api_t {
209 /* API init / deinit */
210 ecs_os_api_init_t init_;
211 ecs_os_api_fini_t fini_;
212
213 /* Memory management */
214 ecs_os_api_malloc_t malloc_;
215 ecs_os_api_realloc_t realloc_;
216 ecs_os_api_calloc_t calloc_;
217 ecs_os_api_free_t free_;
218
219 /* Strings */
220 ecs_os_api_strdup_t strdup_;
221
222 /* Threads */
223 ecs_os_api_thread_new_t thread_new_;
224 ecs_os_api_thread_join_t thread_join_;
225 ecs_os_api_thread_self_t thread_self_;
226
227 /* Atomic incremenet / decrement */
228 ecs_os_api_ainc_t ainc_;
229 ecs_os_api_ainc_t adec_;
230 ecs_os_api_lainc_t lainc_;
231 ecs_os_api_lainc_t ladec_;
232
233 /* Mutex */
234 ecs_os_api_mutex_new_t mutex_new_;
235 ecs_os_api_mutex_free_t mutex_free_;
236 ecs_os_api_mutex_lock_t mutex_lock_;
237 ecs_os_api_mutex_lock_t mutex_unlock_;
238
239 /* Condition variable */
240 ecs_os_api_cond_new_t cond_new_;
241 ecs_os_api_cond_free_t cond_free_;
242 ecs_os_api_cond_signal_t cond_signal_;
243 ecs_os_api_cond_broadcast_t cond_broadcast_;
244 ecs_os_api_cond_wait_t cond_wait_;
245
246 /* Time */
247 ecs_os_api_sleep_t sleep_;
248 ecs_os_api_now_t now_;
249 ecs_os_api_get_time_t get_time_;
250
251 /* Logging */
252 ecs_os_api_log_t log_; /* Logging function. The level should be interpreted as: */
253 /* >0: Debug tracing. Only enabled in debug builds. */
254 /* 0: Tracing. Enabled in debug/release builds. */
255 /* -2: Warning. An issue occurred, but operation was successful. */
256 /* -3: Error. An issue occurred, and operation was unsuccessful. */
257 /* -4: Fatal. An issue occurred, and application must quit. */
258
259 /* Application termination */
260 ecs_os_api_abort_t abort_;
261
262 /* Dynamic library loading */
263 ecs_os_api_dlopen_t dlopen_;
264 ecs_os_api_dlproc_t dlproc_;
265 ecs_os_api_dlclose_t dlclose_;
266
267 /* Overridable function that translates from a logical module id to a
268 * shared library filename */
269 ecs_os_api_module_to_path_t module_to_dl_;
270
271 /* Overridable function that translates from a logical module id to a
272 * path that contains module-specif resources or assets */
273 ecs_os_api_module_to_path_t module_to_etc_;
274
275 /* Trace level */
276 int32_t log_level_;
277
278 /* Trace indentation */
279 int32_t log_indent_;
280
281 /* Last error code */
282 int32_t log_last_error_;
283
284 /* Last recorded timestamp */
285 int64_t log_last_timestamp_;
286
287 /* OS API flags */
288 ecs_flags32_t flags_;
290
291FLECS_API
292extern ecs_os_api_t ecs_os_api;
293
294FLECS_API
295void ecs_os_init(void);
296
297FLECS_API
298void ecs_os_fini(void);
299
300FLECS_API
301void ecs_os_set_api(
302 ecs_os_api_t *os_api);
303
304FLECS_API
305ecs_os_api_t ecs_os_get_api(void);
306
307FLECS_API
308void ecs_os_set_api_defaults(void);
309
310/* Memory management */
311#ifndef ecs_os_malloc
312#define ecs_os_malloc(size) ecs_os_api.malloc_(size)
313#endif
314#ifndef ecs_os_free
315#define ecs_os_free(ptr) ecs_os_api.free_(ptr)
316#endif
317#ifndef ecs_os_realloc
318#define ecs_os_realloc(ptr, size) ecs_os_api.realloc_(ptr, size)
319#endif
320#ifndef ecs_os_calloc
321#define ecs_os_calloc(size) ecs_os_api.calloc_(size)
322#endif
323#if defined(ECS_TARGET_WINDOWS)
324#define ecs_os_alloca(size) _alloca((size_t)(size))
325#else
326#define ecs_os_alloca(size) alloca((size_t)(size))
327#endif
328
329#define ecs_os_malloc_t(T) ECS_CAST(T*, ecs_os_malloc(ECS_SIZEOF(T)))
330#define ecs_os_malloc_n(T, count) ECS_CAST(T*, ecs_os_malloc(ECS_SIZEOF(T) * (count)))
331#define ecs_os_calloc_t(T) ECS_CAST(T*, ecs_os_calloc(ECS_SIZEOF(T)))
332#define ecs_os_calloc_n(T, count) ECS_CAST(T*, ecs_os_calloc(ECS_SIZEOF(T) * (count)))
333
334#define ecs_os_realloc_t(ptr, T) ECS_CAST(T*, ecs_os_realloc([ptr, ECS_SIZEOF(T)))
335#define ecs_os_realloc_n(ptr, T, count) ECS_CAST(T*, ecs_os_realloc(ptr, ECS_SIZEOF(T) * (count)))
336#define ecs_os_alloca_t(T) ECS_CAST(T*, ecs_os_alloca(ECS_SIZEOF(T)))
337#define ecs_os_alloca_n(T, count) ECS_CAST(T*, ecs_os_alloca(ECS_SIZEOF(T) * (count)))
338
339/* Strings */
340#ifndef ecs_os_strdup
341#define ecs_os_strdup(str) ecs_os_api.strdup_(str)
342#endif
343
344#ifdef __cplusplus
345#define ecs_os_strlen(str) static_cast<ecs_size_t>(strlen(str))
346#define ecs_os_strncmp(str1, str2, num) strncmp(str1, str2, static_cast<size_t>(num))
347#define ecs_os_memcmp(ptr1, ptr2, num) memcmp(ptr1, ptr2, static_cast<size_t>(num))
348#define ecs_os_memcpy(ptr1, ptr2, num) memcpy(ptr1, ptr2, static_cast<size_t>(num))
349#define ecs_os_memset(ptr, value, num) memset(ptr, value, static_cast<size_t>(num))
350#define ecs_os_memmove(dst, src, size) memmove(dst, src, static_cast<size_t>(size))
351#else
352#define ecs_os_strlen(str) (ecs_size_t)strlen(str)
353#define ecs_os_strncmp(str1, str2, num) strncmp(str1, str2, (size_t)(num))
354#define ecs_os_memcmp(ptr1, ptr2, num) memcmp(ptr1, ptr2, (size_t)(num))
355#define ecs_os_memcpy(ptr1, ptr2, num) memcpy(ptr1, ptr2, (size_t)(num))
356#define ecs_os_memset(ptr, value, num) memset(ptr, value, (size_t)(num))
357#define ecs_os_memmove(dst, src, size) memmove(dst, src, (size_t)(size))
358#endif
359
360#define ecs_os_memcpy_t(ptr1, ptr2, T) ecs_os_memcpy(ptr1, ptr2, ECS_SIZEOF(T))
361#define ecs_os_memcpy_n(ptr1, ptr2, T, count) ecs_os_memcpy(ptr1, ptr2, ECS_SIZEOF(T) * count)
362#define ecs_os_memcmp_t(ptr1, ptr2, T) ecs_os_memcmp(ptr1, ptr2, ECS_SIZEOF(T))
363
364#define ecs_os_strcmp(str1, str2) strcmp(str1, str2)
365#define ecs_os_memset_t(ptr, value, T) ecs_os_memset(ptr, value, ECS_SIZEOF(T))
366#define ecs_os_memset_n(ptr, value, T, count) ecs_os_memset(ptr, value, ECS_SIZEOF(T) * count)
367#define ecs_os_zeromem(ptr) ecs_os_memset(ptr, 0, ECS_SIZEOF(*ptr))
368
369#define ecs_os_memdup_t(ptr, T) ecs_os_memdup(ptr, ECS_SIZEOF(T))
370#define ecs_os_memdup_n(ptr, T, count) ecs_os_memdup(ptr, ECS_SIZEOF(T) * count)
371
372#define ecs_offset(ptr, T, index)\
373 ECS_CAST(T*, ECS_OFFSET(ptr, ECS_SIZEOF(T) * index))
374
375#if defined(ECS_TARGET_MSVC)
376#define ecs_os_strcat(str1, str2) strcat_s(str1, INT_MAX, str2)
377#define ecs_os_sprintf(ptr, ...) sprintf_s(ptr, INT_MAX, __VA_ARGS__)
378#define ecs_os_vsprintf(ptr, fmt, args) vsprintf_s(ptr, INT_MAX, fmt, args)
379#define ecs_os_strcpy(str1, str2) strcpy_s(str1, INT_MAX, str2)
380#ifdef __cplusplus
381#define ecs_os_strncpy(str1, str2, num) strncpy_s(str1, INT_MAX, str2, static_cast<size_t>(num))
382#else
383#define ecs_os_strncpy(str1, str2, num) strncpy_s(str1, INT_MAX, str2, (size_t)(num))
384#endif
385#else
386#define ecs_os_strcat(str1, str2) strcat(str1, str2)
387#define ecs_os_sprintf(ptr, ...) sprintf(ptr, __VA_ARGS__)
388#define ecs_os_vsprintf(ptr, fmt, args) vsprintf(ptr, fmt, args)
389#define ecs_os_strcpy(str1, str2) strcpy(str1, str2)
390#ifdef __cplusplus
391#define ecs_os_strncpy(str1, str2, num) strncpy(str1, str2, static_cast<size_t>(num))
392#else
393#define ecs_os_strncpy(str1, str2, num) strncpy(str1, str2, (size_t)(num))
394#endif
395#endif
396
397/* Files */
398#if defined(ECS_TARGET_MSVC)
399#define ecs_os_fopen(result, file, mode) fopen_s(result, file, mode)
400#else
401#define ecs_os_fopen(result, file, mode) (*(result)) = fopen(file, mode)
402#endif
403
404/* Threads */
405#define ecs_os_thread_new(callback, param) ecs_os_api.thread_new_(callback, param)
406#define ecs_os_thread_join(thread) ecs_os_api.thread_join_(thread)
407#define ecs_os_thread_self() ecs_os_api.thread_self_()
408
409/* Atomic increment / decrement */
410#define ecs_os_ainc(value) ecs_os_api.ainc_(value)
411#define ecs_os_adec(value) ecs_os_api.adec_(value)
412#define ecs_os_lainc(value) ecs_os_api.lainc_(value)
413#define ecs_os_ladec(value) ecs_os_api.ladec_(value)
414
415/* Mutex */
416#define ecs_os_mutex_new() ecs_os_api.mutex_new_()
417#define ecs_os_mutex_free(mutex) ecs_os_api.mutex_free_(mutex)
418#define ecs_os_mutex_lock(mutex) ecs_os_api.mutex_lock_(mutex)
419#define ecs_os_mutex_unlock(mutex) ecs_os_api.mutex_unlock_(mutex)
420
421/* Condition variable */
422#define ecs_os_cond_new() ecs_os_api.cond_new_()
423#define ecs_os_cond_free(cond) ecs_os_api.cond_free_(cond)
424#define ecs_os_cond_signal(cond) ecs_os_api.cond_signal_(cond)
425#define ecs_os_cond_broadcast(cond) ecs_os_api.cond_broadcast_(cond)
426#define ecs_os_cond_wait(cond, mutex) ecs_os_api.cond_wait_(cond, mutex)
427
428/* Time */
429#define ecs_os_sleep(sec, nanosec) ecs_os_api.sleep_(sec, nanosec)
430#define ecs_os_now() ecs_os_api.now_()
431#define ecs_os_get_time(time_out) ecs_os_api.get_time_(time_out)
432
433/* Logging */
434FLECS_API
435void ecs_os_dbg(const char *file, int32_t line, const char *msg);
436
437FLECS_API
438void ecs_os_trace(const char *file, int32_t line, const char *msg);
439
440FLECS_API
441void ecs_os_warn(const char *file, int32_t line, const char *msg);
442
443FLECS_API
444void ecs_os_err(const char *file, int32_t line, const char *msg);
445
446FLECS_API
447void ecs_os_fatal(const char *file, int32_t line, const char *msg);
448
449FLECS_API
450const char* ecs_os_strerror(int err);
451
452FLECS_API
453void ecs_os_strset(char **str, const char *value);
454
455#ifdef FLECS_ACCURATE_COUNTERS
456#define ecs_os_inc(v) (ecs_os_ainc(v))
457#define ecs_os_linc(v) (ecs_os_lainc(v))
458#define ecs_os_dec(v) (ecs_os_adec(v))
459#define ecs_os_ldec(v) (ecs_os_ladec(v))
460#else
461#define ecs_os_inc(v) (++(*v))
462#define ecs_os_linc(v) (++(*v))
463#define ecs_os_dec(v) (--(*v))
464#define ecs_os_ldec(v) (--(*v))
465#endif
466
467/* Application termination */
468#define ecs_os_abort() ecs_os_api.abort_()
469
470/* Dynamic libraries */
471#define ecs_os_dlopen(libname) ecs_os_api.dlopen_(libname)
472#define ecs_os_dlproc(lib, procname) ecs_os_api.dlproc_(lib, procname)
473#define ecs_os_dlclose(lib) ecs_os_api.dlclose_(lib)
474
475/* Module id translation */
476#define ecs_os_module_to_dl(lib) ecs_os_api.module_to_dl_(lib)
477#define ecs_os_module_to_etc(lib) ecs_os_api.module_to_etc_(lib)
478
479/* Sleep with floating point time */
480FLECS_API
481void ecs_sleepf(
482 double t);
483
484/* Measure time since provided timestamp */
485FLECS_API
486double ecs_time_measure(
488
489/* Calculate difference between two timestamps */
490FLECS_API
491ecs_time_t ecs_time_sub(
492 ecs_time_t t1,
493 ecs_time_t t2);
494
495/* Convert time value to a double */
496FLECS_API
497double ecs_time_to_double(
498 ecs_time_t t);
499
500FLECS_API
501void* ecs_os_memdup(
502 const void *src,
503 ecs_size_t size);
504
506FLECS_API
508
510FLECS_API
512
514FLECS_API
516
518FLECS_API
520
522FLECS_API
523bool ecs_os_has_dl(void);
524
526FLECS_API
528
529#ifdef __cplusplus
530}
531#endif
532
535#endif
FLECS_API bool ecs_os_has_time(void)
Are time functions available?
FLECS_API bool ecs_os_has_dl(void)
Are dynamic library functions available?
FLECS_API bool ecs_os_has_logging(void)
Are logging functions available?
FLECS_API bool ecs_os_has_modules(void)
Are module path functions available?
FLECS_API bool ecs_os_has_threading(void)
Are threading functions available?
FLECS_API bool ecs_os_has_heap(void)
Are heap functions available?
void start()
Start timer.