rtems/score/exception.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreException
0007  *
0008  * @brief This header file provides the interfaces for mapping
0009  *   exceptions to signsls.
0010  */
0011
0012 /*
0013  * Copyright (C) 2021 On-Line Applications Research Corporation (OAR)
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_EXCEPTION_H
0038 #define _RTEMS_EXCEPTION_H
0039
0040 #include <rtems/fatal.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif
0045
0046 /**
0047  * @defgroup RTEMSScoreException Exception Mapping Interfaces
0048  *
0049  * @ingroup RTEMSScore
0050  *
0051  * @brief This group contains the interfaces for mapping machine exceptions to
0052  *   signals using the fatal error handler.
0053  */
0054
0055 /**
0056  * @brief Handle an exception frame for the purpose of mapping signals
0057  *
0058  * See CONFIGURE_EXCEPTION_TO_SIGNAL_MAPPING documentation in the
0059  * "RTEMS Classic API Guide".
0060  */
0061 void _Exception_Raise_signal(
0062   Internal_errors_Source source,
0063   bool                   always_set_to_false,
0064   Internal_errors_t      code
0065 );
0066
0067 #ifdef __cplusplus
0068 }
0069 #endif
0070
0071 #endif /* _RTEMS_EXCEPTION_H */