fatal.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

/*
 * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * 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.
 */

/*
 * Do not manually edit this file.  It is part of the RTEMS quality process
 * and was automatically generated.
 *
 * If you find something that needs to be fixed or worded better please
 * post a report to an RTEMS mailing list or raise a bug report:
 *
 * https://docs.rtems.org/branches/master/user/support/bugs.html
 *
 * For information on updating and regenerating please refer to:
 *
 * https://docs.rtems.org/branches/master/eng/req/howto.html
 */

/* Generated from spec:/rtems/fatal/if/header */

#ifndef _RTEMS_FATAL_H
#define _RTEMS_FATAL_H

#include <stdint.h>
#include <rtems/extension.h>
#include <rtems/score/basedefs.h>
#include <rtems/score/cpu.h>
#include <rtems/score/interr.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/rtems/fatal/if/group */

/* Generated from spec:/rtems/fatal/if/exception-frame */

typedef CPU_Exception_frame rtems_exception_frame;

/* Generated from spec:/rtems/fatal/if/assert-context */

typedef struct {
  const char *file;

  int line;

  const char *function;

  const char *failed_expression;
} rtems_assert_context;

/* Generated from spec:/rtems/fatal/if/error-occurred */

RTEMS_NO_RETURN void rtems_fatal_error_occurred( uint32_t the_error );

/* Generated from spec:/rtems/fatal/if/exception-frame-print */

static inline void rtems_exception_frame_print(
  const rtems_exception_frame *frame
)
{
  _CPU_Exception_frame_print( frame );
}

/* Generated from spec:/rtems/fatal/if/fatal */

static inline RTEMS_NO_RETURN void rtems_fatal(
  rtems_fatal_source fatal_source,
  rtems_fatal_code   error_code
)
{
  _Terminate( fatal_source, error_code );
}

/* Generated from spec:/rtems/fatal/if/internal-error-text */

const char *rtems_internal_error_text( rtems_fatal_code error );

/* Generated from spec:/rtems/fatal/if/panic */

RTEMS_NO_RETURN RTEMS_PRINTFLIKE( 1, 2 ) void rtems_panic(
  const char *fmt,
  ...
);

/* Generated from spec:/rtems/fatal/if/source-text */

const char *rtems_fatal_source_text( rtems_fatal_source source );

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_FATAL_H */