omError.c
Go to the documentation of this file.
1 /*******************************************************************
2  * File: omError.c
3  * Purpose: implementation of Error handling routines
4  * Author: obachman (Olaf Bachmann)
5  * Created: 11/99
6  *******************************************************************/
7 
8 #include <stdarg.h>
9 #include "omalloc.h"
10 
13 
15 {
17  char* s_error;
18  char* string;
19 };
20 
21 /* strings describing omErrors */
22 static const struct omErrorString_s om_ErrorStrings[] =
23 {
24  {omError_NoError, "omError_NoError", "no error"},
25  {omError_Unknown, "omError_Unknown", "unknown error" },
26  {omError_MemoryCorrupted, "omError_MemoryCorrupted", "memory corrupted"},
27  {omError_InternalBug, "omError_InternalBug", "internal omalloc bug"},
28  {omError_NullAddr, "omError_NullAddr", "addr is NULL"},
29  {omError_InvalidRangeAddr, "omError_InvalidRangeAddr", "addr not in valid range"},
30  {omError_FalseAddr, "omError_FalseAddr", "addr not as returned by omalloc"},
31  {omError_FalseAddrOrMemoryCorrupted, "omError_FalseAddrOrMemoryCorrupted", "addr not as returned by omalloc or memory corrupted", },
32  {omError_WrongSize, "omError_WrongSize", "wrong size specification of addr"},
33  {omError_FreedAddr, "omError_FreedAddr", "addr had previosuly been freed"},
34  {omError_FreedAddrOrMemoryCorrupted, "omError_FreedAddrOrMemoryCorrupted", "addr had previosuly been freed or memory corrupted"},
35  {omError_WrongBin, "omError_WrongBin", "addr is not from given Bin"},
36  {omError_UnknownBin, "omError_UnknownBin", "given Bin is unknown"},
37  {omError_NotBinAddr, "omError_NotBinAddr", "addr is not a BinAddr"},
38  {omError_UnalignedAddr, "omError_UnalignedAddr", "addr is unaligned"},
39  {omError_NullSizeAlloc, "omError_NullSizeAlloc", "alloc of size 0"},
40  {omError_ListCycleError, "omError_ListCycleError", "list has cycles"},
41  {omError_SortedListError, "omError_SortedListError", "sorted list is unsorted"},
42  {omError_KeptAddrListCorrupted, "omError_KeptAddrListCorrupted", "list of kept addresses are corrupted"},
43  {omError_FrontPattern, "omError_FrontPattern", "written to front of addr"},
44  {omError_BackPattern, "omError_BackPattern", "written after end of addr"},
45  {omError_FreePattern, "omError_FreePattern", "written into freed memory"},
46  {omError_NotString, "omError_NotString", "string not null terminated"},
47  {omError_StickyBin, "omError_StickyBin", "wrong handling of sticky bins"},
48 
49  {omError_MaxError, NULL} /* this needs to be the last entry */
50 };
51 
53 {
54  int i = 0;
55  while (! (om_ErrorStrings[i].string == NULL && om_ErrorStrings[i].error == omError_MaxError))
56  {
57  if (om_ErrorStrings[i].error == error) return om_ErrorStrings[i].string;
58  i++;
59  }
60  return "undocumented error";
61 }
62 
64 {
65  int i = 0;
66  while (! (om_ErrorStrings[i].string == NULL && om_ErrorStrings[i].error == omError_MaxError))
67  {
68  if (om_ErrorStrings[i].error == error) return om_ErrorStrings[i].s_error;
69  i++;
70  }
71  return "omError_UnKnown";
72 }
73 
74 #ifndef OM_NDEBUG
76 #endif
77 
78 omError_t omReportError(omError_t error, omError_t report_error, OM_FLR_DECL,
79  const char* fmt, ...)
80 {
81  int max_check, max_track;
82 
83  if (report_error == omError_MaxError) return error;
84  /* reset MaxTrack and MaxCheck to prevent infinite loop, in case
85  printf allocates memory */
86  max_check = om_Opts.MaxCheck;
87  max_track = om_Opts.MaxTrack;
88  om_Opts.MaxCheck = 0;
89  om_Opts.MaxTrack = 0;
90 
92  om_ErrorStatus = (report_error == omError_NoError ? error : report_error);
93 
94  if (om_Opts.HowToReportErrors && om_ErrorStatus != omError_NoError)
95  {
96  /* to avoid spurious error msg in 64 bit mode*/
97  if (om_ErrorStatus == omError_StickyBin) return error;
98  fprintf(stderr, "***%s: %s", omError2Serror(om_ErrorStatus), omError2String(om_ErrorStatus));
99 
100 #ifdef OM_INTERNAL_DEBUG
101  if (om_ErrorStatus != error)
102  fprintf(stderr, "\n___%s: %s", omError2Serror(error), omError2String(error));
103 #endif
104 
105  if (om_Opts.HowToReportErrors > 2 && fmt != NULL && *fmt != '\0')
106  {
107  va_list ap;
108  va_start(ap, fmt);
109  fputs( ": ",stderr);
110  vfprintf(stderr, fmt, ap);
111  va_end(ap);
112  }
113 
114  if (om_Opts.HowToReportErrors > 1)
115  {
116 #ifndef OM_NDEBUG
117  fputs("\n occurred at: ",stderr);
118  if (! _omPrintCurrentBackTrace(stderr, OM_FLR_VAL))
119  fputs(" ??",stderr);
120 #endif
121  }
122  fputc('\n',stderr);
123  fflush(stderr);
124  }
125  if (om_CallErrorHook)
126  om_Opts.ErrorHook();
127 
128  om_Opts.MaxCheck = max_check;
129  om_Opts.MaxTrack = max_track;
130  return error;
131 }
132 
133 
134 /* this is a dummy function and used as default for om_Opts.ErrorHook */
135 extern void omErrorBreak()
136 {}
enum omError_e omError_t
Definition: omError.h:44
omError_t omReportError(omError_t error, omError_t report_error, OM_FLR_DECL, const char *fmt,...)
Definition: omError.c:78
const char * omError2String(omError_t error)
Definition: omError.c:52
Definition: ap.h:39
int _omPrintCurrentBackTrace(FILE *fd, OM_FLR_DECL)
Definition: omRet2Info.c:270
char * s_error
Definition: omError.c:17
omError_t om_InternalErrorStatus
Definition: omError.c:12
omError_t error
Definition: omError.c:16
omOpts_t om_Opts
Definition: omOpts.c:11
static const struct omErrorString_s om_ErrorStrings[]
Definition: omError.c:22
omError_t om_ErrorStatus
Definition: omError.c:11
const char * omError2Serror(omError_t error)
Definition: omError.c:63
int i
Definition: cfEzgcd.cc:125
#define NULL
Definition: omList.c:10
int om_CallErrorHook
Definition: omError.c:75
char * string
Definition: omError.c:18
void omErrorBreak()
Definition: omError.c:135