compiler_hints.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014 Freie Universität Berlin
 * SPDX-FileCopyrightText: 2017 HAW-Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <assert.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef NORETURN
#  ifdef __GNUC__
#    define NORETURN __attribute__((noreturn))
#  else
#    define NORETURN
#  endif
#endif

#ifndef NONSTRING
#  if ((__GNUC__ >= 15) || (__clang_major__ >= 21))
#    define NONSTRING __attribute__((nonstring))
#  else
#    define NONSTRING
#  endif
#endif

#ifndef PURE
#  ifdef __GNUC__
#    define PURE __attribute__((pure))
#  else
#    define PURE
#  endif
#endif

#ifndef MAYBE_UNUSED
#  ifdef __GNUC__
#    define MAYBE_UNUSED __attribute__((unused))
#  else
#    define MAYBE_UNUSED
#  endif
#endif

#if defined(__llvm__) || defined(__clang__)
#  define NO_SANITIZE_ARRAY __attribute__((no_sanitize("address")))
#else
#  define NO_SANITIZE_ARRAY
#endif

#if ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 5)) || (__GNUC__ >= 5) || defined(__clang__)
#  define UNREACHABLE() __builtin_unreachable()
#else
#  define UNREACHABLE()  do { /* nothing */ } while (1)
#endif

#define WARN_UNUSED_RESULT __attribute__((warn_unused_result))

#define WITHOUT_PEDANTIC(...) \
    _Pragma("GCC diagnostic push") \
    _Pragma("GCC diagnostic ignored \"-Wpedantic\"") \
    __VA_ARGS__ \
    _Pragma("GCC diagnostic pop")

#define DECLARE_CONSTANT(identifier, const_expr) \
    WITHOUT_PEDANTIC(enum { identifier = const_expr };)
 
#if DOXYGEN
#  define IS_CT_CONSTANT(expr) <IMPLEMENTATION>
#elif defined(__GNUC__)
/* both clang and gcc (which both define __GNUC__) support this */
#  define IS_CT_CONSTANT(expr) __builtin_constant_p(expr)
#else
#  define IS_CT_CONSTANT(expr) 0
#endif

#define likely(x)       __builtin_expect((uintptr_t)(x), 1)

#define unlikely(x)     __builtin_expect((uintptr_t)(x), 0)

#define assume(cond) ((cond) ? (void)0 : (assert(0), UNREACHABLE()))

static inline unsigned may_be_zero(unsigned n)
{
    return n;
}
 
#ifdef __cplusplus
}
#endif