source: rtems/cpukit/score/include/rtems/score/interr.h @ a0c7aa55

4.11
Last change on this file since a0c7aa55 was a0c7aa55, checked in by Sebastian Huber <sebastian.huber@…>, on Nov 14, 2012 at 1:54:09 PM

score: Add RTEMS_FATAL_SOURCE_ASSERT

  • Property mode set to 100644
File size: 4.6 KB
Line 
1/**
2 *  @file  rtems/score/interr.h
3 *
4 *  This include file contains constants and prototypes related
5 *  to the Internal Error Handler.
6 */
7
8/*
9 *  COPYRIGHT (c) 1989-2009.
10 *  On-Line Applications Research Corporation (OAR).
11 *
12 *  The license and distribution terms for this file may be
13 *  found in the file LICENSE in this distribution or at
14 *  http://www.rtems.com/license/LICENSE.
15 */
16
17#ifndef _RTEMS_SCORE_INTERR_H
18#define _RTEMS_SCORE_INTERR_H
19
20#include <stdbool.h>
21#include <stdint.h>
22
23#include <rtems/system.h>
24
25/**
26 *  @defgroup ScoreIntErr Internal Error Handler
27 *
28 *  @ingroup Score
29 *
30 *  This handler encapsulates functionality which provides the foundation
31 *  Semaphore services used in all of the APIs supported by RTEMS.
32 */
33/**@{*/
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39/**
40 *  @brief This type lists the possible sources from which an error
41 *  can be reported.
42 */
43typedef enum {
44  INTERNAL_ERROR_CORE,
45  INTERNAL_ERROR_RTEMS_API,
46  INTERNAL_ERROR_POSIX_API,
47
48  /**
49   * @brief Fatal source for the block device cache.
50   *
51   * @see rtems_bdbuf_fatal_code.
52   */
53  RTEMS_FATAL_SOURCE_BDBUF,
54
55  /**
56   * @brief Fatal source for application specific errors.
57   *
58   * The fatal code is application specific.
59   */
60  RTEMS_FATAL_SOURCE_APPLICATION,
61
62  /**
63   * @brief Fatal source of exit().
64   *
65   * The fatal code is the exit() status code.
66   */
67  RTEMS_FATAL_SOURCE_EXIT,
68
69  /**
70   * @brief Fatal source for generic BSP errors.
71   *
72   * The fatal codes are defined in <bsp/bootcard.h>.  Examples are interrupt
73   * and exception initialization.
74   *
75   * @see bsp_generic_fatal_code.
76   */
77  RTEMS_FATAL_SOURCE_BSP_GENERIC,
78
79  /**
80   * @brief Fatal source for BSP specific errors.
81   *
82   * The fatal code is BSP specific.
83   */
84  RTEMS_FATAL_SOURCE_BSP_SPECIFIC,
85
86  /**
87   * @brief Fatal source of assert().
88   *
89   * The fatal code is the pointer value of the function string.
90   */
91  RTEMS_FATAL_SOURCE_ASSERT,
92
93  /**
94   * @brief The last available fatal source.
95   *
96   * This enum value ensures that the enum type needs at least 32-bits for
97   * architectures with short enums.
98   */
99  RTEMS_FATAL_SOURCE_LAST = 0xffffffff
100} Internal_errors_Source;
101
102/**
103 *  A list of errors which are generated internally by the executive core.
104 */
105typedef enum {
106  INTERNAL_ERROR_NO_CONFIGURATION_TABLE,
107  INTERNAL_ERROR_NO_CPU_TABLE,
108  INTERNAL_ERROR_TOO_LITTLE_WORKSPACE,
109  INTERNAL_ERROR_WORKSPACE_ALLOCATION,
110  INTERNAL_ERROR_INTERRUPT_STACK_TOO_SMALL,
111  INTERNAL_ERROR_THREAD_EXITTED,
112  INTERNAL_ERROR_INCONSISTENT_MP_INFORMATION,
113  INTERNAL_ERROR_INVALID_NODE,
114  INTERNAL_ERROR_NO_MPCI,
115  INTERNAL_ERROR_BAD_PACKET,
116  INTERNAL_ERROR_OUT_OF_PACKETS,
117  INTERNAL_ERROR_OUT_OF_GLOBAL_OBJECTS,
118  INTERNAL_ERROR_OUT_OF_PROXIES,
119  INTERNAL_ERROR_INVALID_GLOBAL_ID,
120  INTERNAL_ERROR_BAD_STACK_HOOK,
121  INTERNAL_ERROR_BAD_ATTRIBUTES,
122  INTERNAL_ERROR_IMPLEMENTATION_KEY_CREATE_INCONSISTENCY,
123  INTERNAL_ERROR_IMPLEMENTATION_BLOCKING_OPERATION_CANCEL,
124  INTERNAL_ERROR_MUTEX_OBTAIN_FROM_BAD_STATE,
125  INTERNAL_ERROR_UNLIMITED_AND_MAXIMUM_IS_0,
126  INTERNAL_ERROR_SHUTDOWN_WHEN_NOT_UP,
127  INTERNAL_ERROR_GXX_KEY_ADD_FAILED,
128  INTERNAL_ERROR_GXX_MUTEX_INIT_FAILED,
129  INTERNAL_ERROR_NO_MEMORY_FOR_HEAP,
130  INTERNAL_ERROR_CPU_ISR_INSTALL_VECTOR
131} Internal_errors_Core_list;
132
133typedef uint32_t Internal_errors_t;
134
135/**
136 *  This type holds the fatal error information.
137 */
138typedef struct {
139  /** This is the source of the error. */
140  Internal_errors_Source  the_source;
141  /** This indicates if the error is internal of external. */
142  bool                    is_internal;
143  /** This is the error code. */
144  Internal_errors_t       the_error;
145
146  /**
147   * @brief The internal error nest level.
148   *
149   * This helps to detect recursive calls to _Internal_error_Occurred().
150   */
151  uint32_t                nest_level;
152} Internal_errors_Information;
153
154/**
155 *  When a fatal error occurs, the error information is stored here.
156 */
157extern Internal_errors_Information _Internal_errors_What_happened;
158
159/**
160 * @brief An internal or fatal error occurred.
161 *
162 * This routine is invoked when the application or the executive itself
163 * determines that a fatal error has occurred.
164 *
165 * This function can be called in every system state provided the following
166 * conditions are true
167 * - the stack pointer is valid,
168 * - the code memory is valid,
169 * - the read-only data is valid, and
170 * - the read-write data is accessible.
171 */
172void _Internal_error_Occurred(
173  Internal_errors_Source  the_source,
174  bool                    is_internal,
175  Internal_errors_t       the_error
176) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
177
178#ifdef __cplusplus
179}
180#endif
181
182/**@}*/
183
184#endif
185/* end of include file */
Note: See TracBrowser for help on using the repository browser.