yac_assert.h

Go to the documentation of this file.

// Copyright (c) 2024 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef YAC_ASSERT_H
#define YAC_ASSERT_H
 
#include <stdio.h>
 
// YAC PUBLIC HEADER START
 
void yac_abort_message(char const*, char const*, int);
 
#define die(msg) \
  yac_abort_message((msg), __FILE__, __LINE__)
 
// if YAC is built for code coverage test
#if defined(YAC_CODE_COVERAGE_TEST)
 
// to avoid reduction of code coverage due to error handling code not being
// executed, redefine respective macros
#define YAC_ASSERT(exp, msg) {(void)(exp);}
#define YAC_ASSERT_FUNC(exp, func, msg) {(void)(exp);(void)(func);}
#define YAC_ASSERT_F(exp, format, ...) {(void)(exp);}
#define YAC_ASSERT_F_FUNC(exp, func, format, ...) {(void)(exp);(void)(func);}
#define YAC_UNREACHABLE_DEFAULT(msg) default: {(void)(msg);}
#define YAC_UNREACHABLE_DEFAULT_F(format, ...) default: {(void)(format);}
#define YAC_UNREACHABLE_DEFAULT_F_FUNC(func, format, ...) \
  default: {(void)(func);(void)(format);}
 
#else // defined(YAC_CODE_COVERAGE_TEST)
 
#define YAC_ASSERT(exp, msg) \
  YAC_ASSERT_F((exp), "%s", (msg))
 
#define YAC_ASSERT_FUNC(exp, func, msg) \
  YAC_ASSERT_F_FUNC((exp), (func), "%s", (msg))
 
#define YAC_ASSERT_F(exp, format, ...) \
  YAC_ASSERT_F_FUNC((exp), __func__, format, ##__VA_ARGS__)
 
#define YAC_ASSERT_F_FUNC(exp, func, format, ...) \
  { \
    if(!((exp))) { \
      char msg_buffer[1024]; \
      int ret = snprintf( \
        msg_buffer, sizeof(msg_buffer), \
        "ERROR(%s): " format, (func), ##__VA_ARGS__); \
      if ((ret >= 0) && ((size_t)ret < sizeof(msg_buffer))) \
        die(msg_buffer); \
      else \
        die("an error occurred, but error message could not be generated"); \
    } \
  }
 
#define YAC_UNREACHABLE_DEFAULT(msg) \
    default: \
      { \
        YAC_UNREACHABLE(msg); \
        __attribute__((fallthrough)); \
      }
 
#define YAC_UNREACHABLE_DEFAULT_F_FUNC(func, format, ...) \
    default: \
      { \
        char msg_buffer[1024]; \
        int ret = snprintf( \
          msg_buffer, sizeof(msg_buffer), \
          "ERROR(%s): " format, (func), ##__VA_ARGS__); \
        if ((ret >= 0) && ((size_t)ret < sizeof(msg_buffer))) \
          die(msg_buffer); \
        else \
          die("an error occurred, but error message could not be generated"); \
        __attribute__((fallthrough)); \
      }
 
#define YAC_UNREACHABLE_DEFAULT_F(format, ...) \
    YAC_UNREACHABLE_DEFAULT_F_FUNC(__func__, format, ##__VA_ARGS__)
 
#endif // defined(YAC_CODE_COVERAGE_TEST)
 
#define YAC_UNREACHABLE(msg) \
  YAC_ASSERT(0, (msg));
 
#define YAC_UNREACHABLE_F(format, ...) \
  YAC_ASSERT_F(0, format, ##__VA_ARGS__)
 
// YAC PUBLIC HEADER STOP
 
#endif // YAC_ASSERT_H