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

5
Last change on this file since de9b7d7 was de9b7d7, checked in by Sebastian Huber <sebastian.huber@…>, on 06/01/18 at 05:04:45

Add RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE

An invalid heap usage such as a double free is usually a fatal error
since this indicates a use after free. Replace the use of printk() in
free() with a fatal error.

Update #3437.

  • Property mode set to 100644
File size: 7.6 KB
Line 
1/**
2 *  @file  rtems/score/interr.h
3 *
4 *  @brief Constants and Prototypes Related to the Internal Error Handler
5 *
6 *  This include file contains constants and prototypes related
7 *  to the Internal Error Handler.
8 */
9
10/*
11 *  COPYRIGHT (c) 1989-2009.
12 *  On-Line Applications Research Corporation (OAR).
13 *
14 *  The license and distribution terms for this file may be
15 *  found in the file LICENSE in this distribution or at
16 *  http://www.rtems.org/license/LICENSE.
17 */
18
19#ifndef _RTEMS_SCORE_INTERR_H
20#define _RTEMS_SCORE_INTERR_H
21
22#include <stdbool.h>
23#include <stdint.h>
24
25#include <rtems/system.h>
26
27/**
28 *  @defgroup ScoreIntErr Internal Error Handler
29 *
30 *  @ingroup Score
31 *
32 *  This handler encapsulates functionality which provides the foundation
33 *  Semaphore services used in all of the APIs supported by RTEMS.
34 */
35/**@{*/
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/**
42 *  @brief This type lists the possible sources from which an error
43 *  can be reported.
44 */
45typedef enum {
46  /**
47   * @brief Errors of the core system.
48   *
49   * @see Internal_errors_Core_list.
50   */
51  INTERNAL_ERROR_CORE = 0,
52
53  /**
54   * @brief Errors of the RTEMS API.
55   */
56  INTERNAL_ERROR_RTEMS_API = 1,
57
58  /**
59   * @brief Errors of the POSIX API.
60   */
61  INTERNAL_ERROR_POSIX_API = 2,
62
63  /**
64   * @brief Fatal source for the block device cache.
65   *
66   * @see rtems_bdbuf_fatal_code.
67   */
68  RTEMS_FATAL_SOURCE_BDBUF = 3,
69
70  /**
71   * @brief Fatal source for application specific errors.
72   *
73   * The fatal code is application specific.
74   */
75  RTEMS_FATAL_SOURCE_APPLICATION = 4,
76
77  /**
78   * @brief Fatal source of exit().
79   *
80   * The fatal code is the exit() status code.
81   */
82  RTEMS_FATAL_SOURCE_EXIT = 5,
83
84  /**
85   * @brief Fatal source for BSP errors.
86   *
87   * The fatal codes are defined in <bsp/fatal.h>.  Examples are interrupt and
88   * exception initialization.
89   *
90   * @see bsp_fatal_code and bsp_fatal().
91   */
92  RTEMS_FATAL_SOURCE_BSP = 6,
93
94  /**
95   * @brief Fatal source of assert().
96   *
97   * The fatal code is the pointer value of the assert context.
98   *
99   * @see rtems_assert_context.
100   */
101  RTEMS_FATAL_SOURCE_ASSERT = 7,
102
103  /**
104   * @brief Fatal source of the stack checker.
105   *
106   * The fatal code is the object name of the executing task.
107   */
108  RTEMS_FATAL_SOURCE_STACK_CHECKER = 8,
109
110  /**
111   * @brief Fatal source of the exceptions.
112   *
113   * The fatal code is the pointer value of the exception frame pointer.
114   *
115   * @see rtems_exception_frame and rtems_exception_frame_print().
116   */
117  RTEMS_FATAL_SOURCE_EXCEPTION = 9,
118
119  /**
120   * @brief Fatal source of SMP domain.
121   *
122   * @see SMP_Fatal_code.
123   */
124  RTEMS_FATAL_SOURCE_SMP = 10,
125
126  /**
127   * @brief Fatal source of rtems_panic().
128   *
129   * @see rtem
130   */
131  RTEMS_FATAL_SOURCE_PANIC = 11,
132
133  /**
134   * @brief Fatal source for invalid C program heap frees via free().
135   *
136   * The fatal code is the bad pointer.
137   */
138  RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE = 12,
139
140  /**
141   * @brief The last available fatal source.
142   *
143   * This enum value ensures that the enum type needs at least 32-bits for
144   * architectures with short enums.
145   */
146  RTEMS_FATAL_SOURCE_LAST = 0xffffffff
147} Internal_errors_Source;
148
149/**
150 * @brief A list of errors which are generated internally by the executive
151 * core.
152 *
153 * Do not re-use numbers of obsolete error codes.  Uncomment no longer used
154 * error codes.
155 */
156typedef enum {
157  /* INTERNAL_ERROR_NO_CONFIGURATION_TABLE = 0, */
158  /* INTERNAL_ERROR_NO_CPU_TABLE = 1, */
159  INTERNAL_ERROR_TOO_LITTLE_WORKSPACE = 2,
160  INTERNAL_ERROR_WORKSPACE_ALLOCATION = 3,
161  INTERNAL_ERROR_INTERRUPT_STACK_TOO_SMALL = 4,
162  INTERNAL_ERROR_THREAD_EXITTED = 5,
163  INTERNAL_ERROR_INCONSISTENT_MP_INFORMATION = 6,
164  INTERNAL_ERROR_INVALID_NODE = 7,
165  INTERNAL_ERROR_NO_MPCI = 8,
166  INTERNAL_ERROR_BAD_PACKET = 9,
167  INTERNAL_ERROR_OUT_OF_PACKETS = 10,
168  INTERNAL_ERROR_OUT_OF_GLOBAL_OBJECTS = 11,
169  INTERNAL_ERROR_OUT_OF_PROXIES = 12,
170  INTERNAL_ERROR_INVALID_GLOBAL_ID = 13,
171  INTERNAL_ERROR_BAD_STACK_HOOK = 14,
172  /* INTERNAL_ERROR_BAD_ATTRIBUTES = 15, */
173  /* INTERNAL_ERROR_IMPLEMENTATION_KEY_CREATE_INCONSISTENCY = 16, */
174  /* INTERNAL_ERROR_IMPLEMENTATION_BLOCKING_OPERATION_CANCEL = 17, */
175  /* INTERNAL_ERROR_THREAD_QUEUE_ENQUEUE_FROM_BAD_STATE = 18, */
176  INTERNAL_ERROR_UNLIMITED_AND_MAXIMUM_IS_0 = 19,
177  /* INTERNAL_ERROR_SHUTDOWN_WHEN_NOT_UP = 20, */
178  INTERNAL_ERROR_GXX_KEY_ADD_FAILED = 21,
179  INTERNAL_ERROR_GXX_MUTEX_INIT_FAILED = 22,
180  INTERNAL_ERROR_NO_MEMORY_FOR_HEAP = 23,
181  INTERNAL_ERROR_CPU_ISR_INSTALL_VECTOR = 24,
182  INTERNAL_ERROR_RESOURCE_IN_USE = 25,
183  INTERNAL_ERROR_RTEMS_INIT_TASK_ENTRY_IS_NULL = 26,
184  /* INTERNAL_ERROR_POSIX_INIT_THREAD_ENTRY_IS_NULL = 27, */
185  INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK = 28,
186  INTERNAL_ERROR_THREAD_QUEUE_ENQUEUE_STICKY_FROM_BAD_STATE = 29,
187  INTERNAL_ERROR_BAD_THREAD_DISPATCH_DISABLE_LEVEL = 30,
188  INTERNAL_ERROR_BAD_THREAD_DISPATCH_ENVIRONMENT = 31,
189  INTERNAL_ERROR_RTEMS_INIT_TASK_CREATE_FAILED = 32,
190  INTERNAL_ERROR_POSIX_INIT_THREAD_CREATE_FAILED = 33,
191  INTERNAL_ERROR_LIBIO_USER_ENV_KEY_CREATE_FAILED = 34,
192  /* INTERNAL_ERROR_LIBIO_SEM_CREATE_FAILED = 35, */
193  INTERNAL_ERROR_LIBIO_STDOUT_FD_OPEN_FAILED = 36,
194  INTERNAL_ERROR_LIBIO_STDERR_FD_OPEN_FAILED = 37,
195  INTERNAL_ERROR_ILLEGAL_USE_OF_FLOATING_POINT_UNIT = 38,
196  INTERNAL_ERROR_ARC4RANDOM_GETENTROPY_FAIL = 39
197} Internal_errors_Core_list;
198
199typedef CPU_Uint32ptr Internal_errors_t;
200
201/**
202 *  This type holds the fatal error information.
203 */
204typedef struct {
205  /** This is the source of the error. */
206  Internal_errors_Source  the_source;
207  /** This is the error code. */
208  Internal_errors_t       the_error;
209} Internal_errors_Information;
210
211/**
212 *  When a fatal error occurs, the error information is stored here.
213 */
214extern Internal_errors_Information _Internal_errors_What_happened;
215
216/**
217 * @brief Initiates system termination.
218 *
219 * This routine is invoked when the application or the executive itself
220 * determines that a fatal error has occurred or a final system state is
221 * reached (for example after exit()).
222 *
223 * The first action of this function is to call the fatal handler of the user
224 * extensions.  For the initial extensions the following conditions are
225 * required
226 * - a valid stack pointer and enough stack space,
227 * - a valid code memory, and
228 * - valid read-only data.
229 *
230 * For the initial extensions the read-write data (including BSS segment) is
231 * not required on single processor configurations.  On SMP configurations
232 * however the read-write data must be initialized since this function must
233 * determine the state of the other processors and request them to shut-down if
234 * necessary.
235 *
236 * Non-initial extensions require in addition valid read-write data.  The BSP
237 * may install an initial extension that performs a system reset.  In this case
238 * the non-initial extensions will be not called.
239 *
240 * Once all fatal handler executed the error information will be stored to
241 * _Internal_errors_What_happened and the system state is set to
242 * SYSTEM_STATE_TERMINATED.
243 *
244 * The final step is to call the CPU specific _CPU_Fatal_halt().
245 *
246 * @param[in] the_source The fatal source indicating the subsystem the fatal
247 * condition originated in.
248 * @param[in] the_error The fatal error code.  This value must be interpreted
249 * with respect to the source.
250 *
251 * @see rtems_fatal() and _Internal_error().
252 */
253void _Terminate(
254  Internal_errors_Source  the_source,
255  Internal_errors_t       the_error
256) RTEMS_NO_RETURN;
257
258/**
259 * @brief Terminates the system with an INTERNAL_ERROR_CORE fatal source and
260 * the specified core error code.
261 *
262 * @param[in] core_error The core error code.
263 *
264 * @see _Terminate().
265 */
266void _Internal_error( Internal_errors_Core_list core_error ) RTEMS_NO_RETURN;
267
268#ifdef __cplusplus
269}
270#endif
271
272/**@}*/
273
274#endif
275/* end of include file */
Note: See TracBrowser for help on using the repository browser.