blob: 2c6495d69c85cdef1bc58378b1b60f611abdb543 [file] [log] [blame]
Michal Vasko9e8ac262020-04-07 13:06:45 +02001/**
2 * @file compat.h
3 * @author Michal Vasko <mvasko@cesnet.cz>
4 * @brief compatibility functions header
5 *
Michal Vaskod8a74192023-02-06 15:51:50 +01006 * Copyright (c) 2021 - 2023 CESNET, z.s.p.o.
Michal Vasko9e8ac262020-04-07 13:06:45 +02007 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
15#ifndef _COMPAT_H_
16#define _COMPAT_H_
17
Michal Vasko3341d1d2023-03-24 11:33:09 +010018#define _GNU_SOURCE /* pthread_rwlock_t */
19
Michal Vaskod8a74192023-02-06 15:51:50 +010020#include <alloca.h>
Michal Vasko7a20d2e2021-05-19 16:40:23 +020021#include <limits.h>
22#include <pthread.h>
Michal Vasko9e8ac262020-04-07 13:06:45 +020023#include <stdarg.h>
24#include <stdio.h>
Michal Vasko7a20d2e2021-05-19 16:40:23 +020025#include <sys/types.h>
26#include <time.h>
Michal Vasko9e8ac262020-04-07 13:06:45 +020027
28#ifndef __WORDSIZE
29# if defined __x86_64__ && !defined __ILP32__
30# define __WORDSIZE 64
31# else
32# define __WORDSIZE 32
33# endif
34#endif
35
36#ifndef __INT64_C
37# if __WORDSIZE == 64
Michal Vasko7a20d2e2021-05-19 16:40:23 +020038# define __INT64_C(c) c ## L
Michal Vasko9e8ac262020-04-07 13:06:45 +020039# define __UINT64_C(c) c ## UL
40# else
Michal Vasko7a20d2e2021-05-19 16:40:23 +020041# define __INT64_C(c) c ## LL
Michal Vasko9e8ac262020-04-07 13:06:45 +020042# define __UINT64_C(c) c ## ULL
43# endif
44#endif
45
Michal Vasko7a20d2e2021-05-19 16:40:23 +020046#if (@CMAKE_C_COMPILER_ID@ == GNU) || (@CMAKE_C_COMPILER_ID@ == Clang)
47# define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
48# define _PACKED __attribute__((__packed__))
49#else
50# define UNUSED(x) UNUSED_ ## x
51# define _PACKED
52#endif
53
Michal Vaskod8a74192023-02-06 15:51:50 +010054#define COMPAT_CLOCK_ID @COMPAT_CLOCK_ID@
55#cmakedefine HAVE_PTHREAD_MUTEX_TIMEDLOCK
56#cmakedefine HAVE_PTHREAD_MUTEX_CLOCKLOCK
Michal Vasko62ba1342023-10-17 08:54:26 +020057#cmakedefine HAVE_PTHREAD_RWLOCK_TIMEDRDLOCK
Michal Vaskod8a74192023-02-06 15:51:50 +010058#cmakedefine HAVE_PTHREAD_RWLOCK_CLOCKRDLOCK
Michal Vasko62ba1342023-10-17 08:54:26 +020059#cmakedefine HAVE_PTHREAD_RWLOCK_TIMEDWRLOCK
Michal Vaskod8a74192023-02-06 15:51:50 +010060#cmakedefine HAVE_PTHREAD_RWLOCK_CLOCKWRLOCK
61#cmakedefine HAVE_PTHREAD_COND_CLOCKWAIT
62
Michal Vasko9e8ac262020-04-07 13:06:45 +020063#cmakedefine HAVE_VDPRINTF
64#cmakedefine HAVE_ASPRINTF
65#cmakedefine HAVE_VASPRINTF
Michal Vasko9e8ac262020-04-07 13:06:45 +020066#cmakedefine HAVE_GETLINE
Michal Vasko7a20d2e2021-05-19 16:40:23 +020067#cmakedefine HAVE_STRNDUP
68#cmakedefine HAVE_STRNSTR
69#cmakedefine HAVE_STRDUPA
70#cmakedefine HAVE_STRCHRNUL
Michal Vasko9e8ac262020-04-07 13:06:45 +020071#cmakedefine HAVE_GET_CURRENT_DIR_NAME
72
Michal Vasko7a20d2e2021-05-19 16:40:23 +020073#ifndef bswap64
Michal Vasko9e8ac262020-04-07 13:06:45 +020074#define bswap64(val) \
75 ( (((val) >> 56) & 0x00000000000000FF) | (((val) >> 40) & 0x000000000000FF00) | \
76 (((val) >> 24) & 0x0000000000FF0000) | (((val) >> 8) & 0x00000000FF000000) | \
77 (((val) << 8) & 0x000000FF00000000) | (((val) << 24) & 0x0000FF0000000000) | \
78 (((val) << 40) & 0x00FF000000000000) | (((val) << 56) & 0xFF00000000000000) )
Michal Vasko7a20d2e2021-05-19 16:40:23 +020079#endif
Michal Vasko9e8ac262020-04-07 13:06:45 +020080
81#undef le64toh
82#undef htole64
83
Michal Vasko652eaa62020-04-21 14:11:21 +020084#cmakedefine IS_BIG_ENDIAN
Michal Vasko9e8ac262020-04-07 13:06:45 +020085
Michal Vasko652eaa62020-04-21 14:11:21 +020086#ifdef IS_BIG_ENDIAN
Michal Vasko9e8ac262020-04-07 13:06:45 +020087# define le64toh(x) bswap64(x)
88# define htole64(x) bswap64(x)
Michal Vasko652eaa62020-04-21 14:11:21 +020089#else
90# define le64toh(x) (x)
91# define htole64(x) (x)
Michal Vasko9e8ac262020-04-07 13:06:45 +020092#endif
93
Michal Vasko7a20d2e2021-05-19 16:40:23 +020094#cmakedefine HAVE_STDATOMIC
95
96#ifdef HAVE_STDATOMIC
97# include <stdatomic.h>
98
99# define ATOMIC_T atomic_uint_fast32_t
100# define ATOMIC_T_MAX UINT_FAST32_MAX
Michal Vaskod8a74192023-02-06 15:51:50 +0100101# define ATOMIC64_T atomic_uint_fast64_t
102# define ATOMIC64_T_MAX UINT_FAST64_MAX
103
104# define ATOMIC_PTR_T atomic_uintptr_t
Michal Vasko7a20d2e2021-05-19 16:40:23 +0200105
106# define ATOMIC_STORE_RELAXED(var, x) atomic_store_explicit(&(var), x, memory_order_relaxed)
107# define ATOMIC_LOAD_RELAXED(var) atomic_load_explicit(&(var), memory_order_relaxed)
108# define ATOMIC_INC_RELAXED(var) atomic_fetch_add_explicit(&(var), 1, memory_order_relaxed)
109# define ATOMIC_ADD_RELAXED(var, x) atomic_fetch_add_explicit(&(var), x, memory_order_relaxed)
110# define ATOMIC_DEC_RELAXED(var) atomic_fetch_sub_explicit(&(var), 1, memory_order_relaxed)
111# define ATOMIC_SUB_RELAXED(var, x) atomic_fetch_sub_explicit(&(var), x, memory_order_relaxed)
Michal Vaskod8a74192023-02-06 15:51:50 +0100112# define ATOMIC_COMPARE_EXCHANGE_RELAXED(var, exp, des, result) \
113 result = atomic_compare_exchange_strong_explicit(&(var), &(exp), des, memory_order_relaxed, memory_order_relaxed)
114
115# define ATOMIC_PTR_STORE_RELAXED(var, x) atomic_store_explicit(&(var), (uintptr_t)(x), memory_order_relaxed)
116# define ATOMIC_PTR_LOAD_RELAXED(var) ((void *)atomic_load_explicit(&(var), memory_order_relaxed))
Michal Vasko7a20d2e2021-05-19 16:40:23 +0200117#else
118# include <stdint.h>
119
120# define ATOMIC_T uint32_t
121# define ATOMIC_T_MAX UINT32_MAX
Michal Vaskod8a74192023-02-06 15:51:50 +0100122# define ATOMIC64_T uint64_t
123# define ATOMIC64_T_MAX UINT64_MAX
124
125# define ATOMIC_PTR_T void *
Michal Vasko7a20d2e2021-05-19 16:40:23 +0200126
127# define ATOMIC_STORE_RELAXED(var, x) ((var) = (x))
128# define ATOMIC_LOAD_RELAXED(var) (var)
129# define ATOMIC_INC_RELAXED(var) __sync_fetch_and_add(&(var), 1)
130# define ATOMIC_ADD_RELAXED(var, x) __sync_fetch_and_add(&(var), x)
131# define ATOMIC_DEC_RELAXED(var) __sync_fetch_and_sub(&(var), 1)
132# define ATOMIC_SUB_RELAXED(var, x) __sync_fetch_and_sub(&(var), x)
Michal Vaskod8a74192023-02-06 15:51:50 +0100133# define ATOMIC_COMPARE_EXCHANGE_RELAXED(var, exp, des, result) \
134 { \
135 ATOMIC_T __old = __sync_val_compare_and_swap(&(var), exp, des); \
136 result = ATOMIC_LOAD_RELAXED(__old) == ATOMIC_LOAD_RELAXED(exp) ? 1 : 0; \
137 ATOMIC_STORE_RELAXED(exp, ATOMIC_LOAD_RELAXED(__old)); \
138 }
139
140# define ATOMIC_PTR_STORE_RELAXED(var, x) ((var) = (x))
141# define ATOMIC_PTR_LOAD_RELAXED(var) (var)
142#endif
143
144#ifndef HAVE_PTHREAD_MUTEX_TIMEDLOCK
145int pthread_mutex_timedlock(pthread_mutex_t *mutex, const struct timespec *abstime);
146#endif
147
148#ifndef HAVE_PTHREAD_MUTEX_CLOCKLOCK
149int pthread_mutex_clocklock(pthread_mutex_t *mutex, clockid_t clockid, const struct timespec *abstime);
150#endif
151
152#ifndef HAVE_PTHREAD_RWLOCK_CLOCKRDLOCK
153int pthread_rwlock_clockrdlock(pthread_rwlock_t *rwlock, clockid_t clockid, const struct timespec *abstime);
154#endif
155
156#ifndef HAVE_PTHREAD_RWLOCK_CLOCKWRLOCK
157int pthread_rwlock_clockwrlock(pthread_rwlock_t *rwlock, clockid_t clockid, const struct timespec *abstime);
158#endif
159
160#ifndef HAVE_PTHREAD_COND_CLOCKWAIT
161int pthread_cond_clockwait(pthread_cond_t *cond, pthread_mutex_t *mutex, clockid_t clockid, const struct timespec *abstime);
Michal Vasko7a20d2e2021-05-19 16:40:23 +0200162#endif
Michal Vasko9e8ac262020-04-07 13:06:45 +0200163
164#ifndef HAVE_VDPRINTF
165int vdprintf(int fd, const char *format, va_list ap);
166#endif
167
168#ifndef HAVE_ASPRINTF
169int asprintf(char **strp, const char *fmt, ...);
170#endif
171
172#ifndef HAVE_VASPRINTF
173int vasprintf(char **strp, const char *fmt, va_list ap);
174#endif
175
Michal Vasko9e8ac262020-04-07 13:06:45 +0200176#ifndef HAVE_GETLINE
177ssize_t getline(char **lineptr, size_t *n, FILE *stream);
178#endif
179
Michal Vasko7a20d2e2021-05-19 16:40:23 +0200180#ifndef HAVE_STRNDUP
181char *strndup(const char *s, size_t n);
182#endif
183
184#ifndef HAVE_STRNSTR
185char *strnstr(const char *s, const char *find, size_t slen);
186#endif
187
188#ifndef HAVE_STRDUPA
189#define strdupa(s) ( \
190{ \
191 char *buf; \
192 size_t len = strlen(s); \
193 buf = alloca(len + 1); \
194 buf[len] = '\0'; \
195 (char *)memcpy(buf, s, len); \
196})
197#endif
198
199#ifndef HAVE_STRCHRNUL
200char *strchrnul(const char *s, int c);
201#endif
202
Michal Vasko9e8ac262020-04-07 13:06:45 +0200203#ifndef HAVE_GET_CURRENT_DIR_NAME
204char *get_current_dir_name(void);
205#endif
206
Michal Vasko9e8ac262020-04-07 13:06:45 +0200207#endif /* _COMPAT_H_ */