Error.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2021, Texas Instruments Incorporated - http://www.ti.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
/*
 * ======== Error.h ========
 */

#ifndef ti_sysbios_runtime_Error__include
#define ti_sysbios_runtime_Error__include

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

/* @cond NODOC */
/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>

#define ti_sysbios_runtime_Error_long_names
#include "Error_defs.h"
/* @endcond */

#ifdef __cplusplus
extern "C" {
#endif

typedef struct Error_Block {
    const char * id;
    intptr_t a0;
    intptr_t a1;
} Error_Block;

typedef void (*Error_HookFxn)(Error_Block *eb);

/* @cond NODOC */
extern Error_Block Error_ignore;

#define Error_UNWIND 0
#define Error_TERMINATE 1
#define Error_SPIN 2
/* @endcond */

#define Error_E_memory "out of memory: heap=0x%x, size=%u"

#define Error_E_generic "error %s"

#define Error_IGNORE (&Error_ignore)

#define Error_ABORT NULL

extern bool Error_check(Error_Block *eb);

extern void Error_init(Error_Block *eb);

extern void Error_print(Error_Block *eb);

/* @cond NODOC */

extern void Error_raiseX(Error_Block *eb, int prefix, const char * id, intptr_t a0, intptr_t a1);

#if Error_retainStrings_D
#define Error_PLACE_STR_IN_SECTION(name, str) static const char name[] = (str);
#else
#if defined(__IAR_SYSTEMS_ICC__)
#define Error_PLACE_STR_IN_SECTION(name, str) \
    __root static const char name[] @ ".error_str" = str;
#elif defined(__TI_COMPILER_VERSION__) || (defined(__clang__) && defined(__ti_version__)) || defined(__GNUC__)
#define Error_PLACE_STR_IN_SECTION(name, str) \
    static const char name[] __attribute__((used,section(".error_str"))) = str;
#else
#error Incompatible compiler: Error/Assert is currently supported by the following \
compilers: TI ARM Compiler, TI CLANG Compiler, GCC, IAR. Please migrate to a \
a supported compiler.
#endif
#endif

#define Error_STR_NX(l) #l
#define Error_STR(l) Error_STR_NX(l)

#if Error_addFileLine_D
#define Error_raise(eb, id, a0, a1)  do { \
    Error_PLACE_STR_IN_SECTION(err, id " (" __FILE__ ":" Error_STR(__LINE__) ")"); \
    Error_raiseX((eb), 0, err, (intptr_t)(a0), (intptr_t)(a1)); } while (0);
#else
#define Error_raise(eb, id, a0, a1) do { \
    Error_PLACE_STR_IN_SECTION(err, id); \
    Error_raiseX((eb), 0, err, (intptr_t)(a0), (intptr_t)(a1)); } while (0);
#endif

#define Error_assert(id, a0, a1) do { \
    Error_PLACE_STR_IN_SECTION(err, id); \
    Error_raiseX(NULL, 1, err, (intptr_t)(a0), (intptr_t)(a1)); } while (0);

/* @endcond */

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_runtime_Error__include */

/* @cond NODOC */
#undef ti_sysbios_runtime_Error_long_names
#include "Error_defs.h"
/* @endcond */