exception.h

Go to the documentation of this file.

/* exception.h - automatically selects the correct exception.h file to include */
 
/*
 * Copyright (c) 2024 Meta Platforms
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_ARCH_EXCEPTION_H_
#define ZEPHYR_INCLUDE_ARCH_EXCEPTION_H_
 
#ifndef _ASMLANGUAGE
 
#include <stdarg.h>
#include <zephyr/toolchain.h>
#include <zephyr/sys/printk.h>

static inline __printf_like(1, 2) void arch_exception_dump_arg_check(const char *fmt, ...)
{
        ARG_UNUSED(fmt);
}
 
#if defined(CONFIG_EXCEPTION_DUMP_HOOK)
 
#include <stdbool.h>
#include <stdarg.h>

typedef void (*arch_exception_dump_hook_t)(const char *format, va_list args);

typedef void (*arch_exception_drain_hook_t)(bool flush);
 
extern arch_exception_dump_hook_t arch_exception_dump_hook;
extern arch_exception_drain_hook_t arch_exception_drain_hook;

static inline void arch_exception_set_dump_hook(arch_exception_dump_hook_t dump,
                                                arch_exception_drain_hook_t drain)
{
        arch_exception_dump_hook = dump;
        arch_exception_drain_hook = drain;
}

static inline void arch_exception_call_drain_hook(bool flush)
{
        if (arch_exception_drain_hook) {
                arch_exception_drain_hook(flush);
        }
}

static inline void arch_exception_call_dump_hook(const char *format, ...)
{
        va_list args;
 
        if (arch_exception_dump_hook) {
                va_start(args, format);
                arch_exception_dump_hook(format, args);
                va_end(args);
        }
}
 
#if !defined(CONFIG_EXCEPTION_DUMP)
#define EXCEPTION_DUMP(format, ...)                                                                \
        do {                                                                                       \
                if (0) {                                                                           \
                        arch_exception_dump_arg_check(format, ##__VA_ARGS__);                      \
                }                                                                                  \
        } while (false)
#elif defined(CONFIG_EXCEPTION_DUMP_HOOK_ONLY)
#define EXCEPTION_DUMP(format, ...)                                                                \
        do {                                                                                       \
                printk_panic();                                                                    \
                arch_exception_call_dump_hook(format "\n", ##__VA_ARGS__);                         \
        } while (false)
#elif defined(CONFIG_LOG)
#define EXCEPTION_DUMP(format, ...)                                                                \
        do {                                                                                       \
                printk_panic();                                                                    \
                arch_exception_call_dump_hook(format "\n", ##__VA_ARGS__);                         \
                LOG_ERR(format, ##__VA_ARGS__);                                                    \
        } while (false)
#else
#define EXCEPTION_DUMP(format, ...)                                                                \
        do {                                                                                       \
                printk_panic();                                                                    \
                arch_exception_call_dump_hook(format "\n", ##__VA_ARGS__);                         \
                printk(format "\n", ##__VA_ARGS__);                                                \
        } while (false)
#endif
 
#else
 
#if !defined(CONFIG_EXCEPTION_DUMP)
#define EXCEPTION_DUMP(format, ...)                                                                \
        do {                                                                                       \
                if (0) {                                                                           \
                        arch_exception_dump_arg_check(format, ##__VA_ARGS__);                      \
                }                                                                                  \
        } while (false)
#elif defined(CONFIG_LOG)
#define EXCEPTION_DUMP(...)                                                                        \
        do {                                                                                       \
                printk_panic();                                                                    \
                LOG_ERR(__VA_ARGS__);                                                              \
        } while (false)
#else
#define EXCEPTION_DUMP(format, ...)                                                                \
        do {                                                                                       \
                printk_panic();                                                                    \
                printk(format "\n", ##__VA_ARGS__);                                                \
        } while (false)
#endif
#endif
 
#endif /* _ASMLANGUAGE */
 
#if defined(CONFIG_X86_64)
#include <zephyr/arch/x86/intel64/exception.h>
#elif defined(CONFIG_X86)
#include <zephyr/arch/x86/ia32/exception.h>
#elif defined(CONFIG_ARM64)
#include <zephyr/arch/arm64/exception.h>
#elif defined(CONFIG_ARM)
#include <zephyr/arch/arm/exception.h>
#elif defined(CONFIG_ARC)
#include <zephyr/arch/arc/v2/exception.h>
#elif defined(CONFIG_RISCV)
#include <zephyr/arch/riscv/exception.h>
#elif defined(CONFIG_XTENSA)
#include <zephyr/arch/xtensa/exception.h>
#elif defined(CONFIG_MIPS)
#include <zephyr/arch/mips/exception.h>
#elif defined(CONFIG_OPENRISC)
#include <zephyr/arch/openrisc/exception.h>
#elif defined(CONFIG_ARCH_POSIX)
#include <zephyr/arch/posix/exception.h>
#elif defined(CONFIG_SPARC)
#include <zephyr/arch/sparc/exception.h>
#elif defined(CONFIG_RX)
#include <zephyr/arch/rx/exception.h>
#elif defined(CONFIG_ARCH_IS_SET)
#error "The selected architecture is missing from this dispatch header"
#endif
 
#endif /* ZEPHYR_INCLUDE_ARCH_EXCEPTION_H_ */