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

4.11
Last change on this file since a12f7e9 was a12f7e9, checked in by Sebastian Huber <sebastian.huber@…>, on Nov 14, 2012 at 2:10:46 PM

score: Add RTEMS_FATAL_SOURCE_STACK_CHECKER

  • Property mode set to 100644
File size: 4.7 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 Fatal source of the stack checker.
95   *
96   * The fatal code is the object name of the executing task.
97   */
98  RTEMS_FATAL_SOURCE_STACK_CHECKER,
99
100  /**
101   * @brief The last available fatal source.
102   *
103   * This enum value ensures that the enum type needs at least 32-bits for
104   * architectures with short enums.
105   */
106  RTEMS_FATAL_SOURCE_LAST = 0xffffffff
107} Internal_errors_Source;
108
109/**
110 *  A list of errors which are generated internally by the executive core.
111 */
112typedef enum {
113  INTERNAL_ERROR_NO_CONFIGURATION_TABLE,
114  INTERNAL_ERROR_NO_CPU_TABLE,
115  INTERNAL_ERROR_TOO_LITTLE_WORKSPACE,
116  INTERNAL_ERROR_WORKSPACE_ALLOCATION,
117  INTERNAL_ERROR_INTERRUPT_STACK_TOO_SMALL,
118  INTERNAL_ERROR_THREAD_EXITTED,
119  INTERNAL_ERROR_INCONSISTENT_MP_INFORMATION,
120  INTERNAL_ERROR_INVALID_NODE,
121  INTERNAL_ERROR_NO_MPCI,
122  INTERNAL_ERROR_BAD_PACKET,
123  INTERNAL_ERROR_OUT_OF_PACKETS,
124  INTERNAL_ERROR_OUT_OF_GLOBAL_OBJECTS,
125  INTERNAL_ERROR_OUT_OF_PROXIES,
126  INTERNAL_ERROR_INVALID_GLOBAL_ID,
127  INTERNAL_ERROR_BAD_STACK_HOOK,
128  INTERNAL_ERROR_BAD_ATTRIBUTES,
129  INTERNAL_ERROR_IMPLEMENTATION_KEY_CREATE_INCONSISTENCY,
130  INTERNAL_ERROR_IMPLEMENTATION_BLOCKING_OPERATION_CANCEL,
131  INTERNAL_ERROR_MUTEX_OBTAIN_FROM_BAD_STATE,
132  INTERNAL_ERROR_UNLIMITED_AND_MAXIMUM_IS_0,
133  INTERNAL_ERROR_SHUTDOWN_WHEN_NOT_UP,
134  INTERNAL_ERROR_GXX_KEY_ADD_FAILED,
135  INTERNAL_ERROR_GXX_MUTEX_INIT_FAILED,
136  INTERNAL_ERROR_NO_MEMORY_FOR_HEAP,
137  INTERNAL_ERROR_CPU_ISR_INSTALL_VECTOR
138} Internal_errors_Core_list;
139
140typedef uint32_t Internal_errors_t;
141
142/**
143 *  This type holds the fatal error information.
144 */
145typedef struct {
146  /** This is the source of the error. */
147  Internal_errors_Source  the_source;
148  /** This indicates if the error is internal of external. */
149  bool                    is_internal;
150  /** This is the error code. */
151  Internal_errors_t       the_error;
152
153  /**
154   * @brief The internal error nest level.
155   *
156   * This helps to detect recursive calls to _Internal_error_Occurred().
157   */
158  uint32_t                nest_level;
159} Internal_errors_Information;
160
161/**
162 *  When a fatal error occurs, the error information is stored here.
163 */
164extern Internal_errors_Information _Internal_errors_What_happened;
165
166/**
167 * @brief An internal or fatal error occurred.
168 *
169 * This routine is invoked when the application or the executive itself
170 * determines that a fatal error has occurred.
171 *
172 * This function can be called in every system state provided the following
173 * conditions are true
174 * - the stack pointer is valid,
175 * - the code memory is valid,
176 * - the read-only data is valid, and
177 * - the read-write data is accessible.
178 */
179void _Internal_error_Occurred(
180  Internal_errors_Source  the_source,
181  bool                    is_internal,
182  Internal_errors_t       the_error
183) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
184
185#ifdef __cplusplus
186}
187#endif
188
189/**@}*/
190
191#endif
192/* end of include file */
Note: See TracBrowser for help on using the repository browser.