*
* Compiler-specific definitions. Currently, only GCC and clang are supported.
*
- * The author dedicates this file to the public domain.
- * You can do whatever you want with this file.
+ * Copyright 2022 Eric Biggers
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef _WIMLIB_COMPILER_H
# define WIMLIBAPI __attribute__((visibility("default")))
#endif
-/* Declare that the annotated function should be inlined. Currently, we force
- * the compiler to honor this because we use 'inline' in highly tuned code, e.g.
- * compression codecs. */
-#define inline inline __attribute__((always_inline))
+/* Declare that the annotated function should always be inlined. This might be
+ * desirable in highly tuned code, e.g. compression codecs. */
+#define forceinline inline __attribute__((always_inline))
/* Declare that the annotated function should *not* be inlined. */
#define noinline __attribute__((noinline))
# define _cold_attribute
#endif
-/* Hint that the annotated function is malloc-like: any non-null pointer it
- * returns will not alias any pointer previously in use by the program. */
-#define _malloc_attribute __attribute__((malloc))
-
/* Hint that the annotated function takes a printf()-like format string and
* arguments. This is currently disabled on Windows because MinGW does not
* support this attribute on functions taking wide-character strings. */
* the case if the function contains only static assertions. */
#define _unused_attribute __attribute__((unused))
-/* Endianness definitions. Either CPU_IS_BIG_ENDIAN or CPU_IS_LITTLE_ENDIAN is
- * set to 1. The other is set to 0. Note that newer gcc supports
+/* Endianness definitions. Either CPU_IS_BIG_ENDIAN() or CPU_IS_LITTLE_ENDIAN()
+ * evaluates to 1. The other evaluates to 0. Note that newer gcc supports
* __BYTE_ORDER__ for easily determining the endianness; older gcc doesn't. In
* the latter case we fall back to a configure-time check. */
#ifdef __BYTE_ORDER__
-# define CPU_IS_BIG_ENDIAN (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
+# define CPU_IS_BIG_ENDIAN() (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
#elif defined(HAVE_CONFIG_H)
# include "config.h"
# ifdef WORDS_BIGENDIAN
-# define CPU_IS_BIG_ENDIAN 1
+# define CPU_IS_BIG_ENDIAN() 1
# else
-# define CPU_IS_BIG_ENDIAN 0
+# define CPU_IS_BIG_ENDIAN() 0
# endif
#endif
-#define CPU_IS_LITTLE_ENDIAN (!CPU_IS_BIG_ENDIAN)
+#define CPU_IS_LITTLE_ENDIAN() (!CPU_IS_BIG_ENDIAN())
/* UNALIGNED_ACCESS_IS_FAST should be defined to 1 if unaligned memory accesses
* can be performed efficiently on the target platform. */
# define min(a, b) ({ typeof(a) _a = (a); typeof(b) _b = (b); \
(_a < _b) ? _a : _b; })
#endif
+#define MIN(a, b) min((a), (b))
/* Get the maximum of two variables, without multiple evaluation. */
#ifndef max
# define max(a, b) ({ typeof(a) _a = (a); typeof(b) _b = (b); \
(_a > _b) ? _a : _b; })
#endif
+#define MAX(a, b) max((a), (b))
/* Swap the values of two variables, without multiple evaluation. */
#ifndef swap
# define swap(a, b) ({ typeof(a) _a = (a); (a) = (b); (b) = _a; })
#endif
+#define SWAP(a, b) swap((a), (b))
/* (Optional) Efficiently swap the bytes of a 16-bit integer. */
#if GCC_PREREQ(4, 8) || __has_builtin(__builtin_bswap16)
#endif
/* (Optional) Find Last Set bit and Find First Set bit macros. */
-#define compiler_fls32(n) (31 - __builtin_clz(n))
-#define compiler_fls64(n) (63 - __builtin_clzll(n))
-#define compiler_ffs32(n) __builtin_ctz(n)
-#define compiler_ffs64(n) __builtin_ctzll(n)
+#define compiler_bsr32(n) (31 - __builtin_clz(n))
+#define compiler_bsr64(n) (63 - __builtin_clzll(n))
+#define compiler_bsf32(n) __builtin_ctz(n)
+#define compiler_bsf64(n) __builtin_ctzll(n)
/* Optional definitions for checking with 'sparse'. */
#ifdef __CHECKER__
#endif
/* STATIC_ASSERT() - verify the truth of an expression at compilation time. */
-#if __STDC_VERSION__ >= 201112L
+#ifdef __CHECKER__
+# define STATIC_ASSERT(expr)
+#elif __STDC_VERSION__ >= 201112L
# define STATIC_ASSERT(expr) _Static_assert((expr), "")
#else
# define STATIC_ASSERT(expr) ((void)sizeof(char[1 - 2 * !(expr)]))
#endif
+/* STATIC_ASSERT_ZERO() - verify the truth of an expression at compilation time
+ * and also produce a result of value '0' to be used in constant expressions */
+#define STATIC_ASSERT_ZERO(expr) ((int)sizeof(char[-!(expr)]))
+
#define CONCAT_IMPL(s1, s2) s1##s2
/* CONCAT() - concatenate two tokens at preprocessing time. */
git://wimlib.net / wimlib / blobdiff