summaryrefslogtreecommitdiffstats
path: root/libdimension/error.c
blob: 974503a216e890fbb3c92af0ea531d60882ffee0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*************************************************************************
 * Copyright (C) 2009-2010 Tavian Barnes <tavianator@gmail.com>          *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library is free software; you can redistribute it and/  *
 * or modify it under the terms of the GNU Lesser General Public License *
 * as published by the Free Software Foundation; either version 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library is distributed in the hope that it will be      *
 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty   *
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

/**
 * @file
 * Error handling.
 */

#include "dimension-impl.h"
#include <pthread.h>
#include <stdio.h>     /* For fprintf() */
#include <stdlib.h>    /* For exit() */

/** The default fatal error handler. */
static void dmnsn_default_fatal_error_fn(void);

/** The current fatal error handler. */
static dmnsn_fatal_error_fn *dmnsn_fatal = &dmnsn_default_fatal_error_fn;
/** Mutex which protects \c dmnsn_fatal. */
static pthread_mutex_t dmnsn_fatal_mutex = PTHREAD_MUTEX_INITIALIZER;

/** The current resilience. */
static dmnsn_severity dmnsn_resilience = DMNSN_SEVERITY_MEDIUM;
/** Mutex which protexts \c dmnsn_resilience. */
static pthread_mutex_t dmnsn_resilience_mutex = PTHREAD_MUTEX_INITIALIZER;

/* Called by dmnsn_error macro (don't call directly). */
void
dmnsn_report_error(dmnsn_severity severity,
                   const char *func, const char *file, unsigned int line,
                   const char *str)
{
  if (severity >= dmnsn_get_resilience()) {
    /* An error more severe than our resilience happened, bail out */
    fprintf(stderr, "Dimension ERROR: %s, %s:%u: %s\n",
            func, file, line, str);
    dmnsn_fatal_error_fn *fatal = dmnsn_get_fatal_error_fn();
    (*fatal)();
    exit(EXIT_FAILURE); /* Failsafe in case *dmnsn_fatal doesn't exit */
  } else {
    /* A trivial error happened, warn and continue */
    fprintf(stderr, "Dimension WARNING: %s, %s:%u: %s\n",
            func, file, line, str);
  }
}

/* Return the current resilience, thread-safely. */
dmnsn_severity
dmnsn_get_resilience(void)
{
  dmnsn_severity resilience;
  if (pthread_mutex_lock(&dmnsn_resilience_mutex) != 0) {
    /* Couldn't lock the mutex, so warn and continue. */
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't lock resilience mutex.");
  }
  resilience = dmnsn_resilience; /* Copy the static variable to a local */
  if (pthread_mutex_unlock(&dmnsn_resilience_mutex) != 0) {
    /* Couldn't unlock the mutex, so warn and continue.  If the mutex was locked
       earlier, the next dmnsn_get/set_resilience is likely to hang. */
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't unlock resilience mutex.");
  }
  return resilience;
}

/* Set the resilience, thread-safely */
void
dmnsn_set_resilience(dmnsn_severity resilience)
{
  if (resilience < DMNSN_SEVERITY_LOW || resilience > DMNSN_SEVERITY_HIGH) {
    /* Tried to set an illegal resilience, bail out */
    fprintf(stderr, "Dimension ERROR: %s, line %u: %s\n", DMNSN_FUNC, __LINE__,
            "Resilience has wrong value.");
    dmnsn_fatal_error_fn *fatal = dmnsn_get_fatal_error_fn();
    (*fatal)();
    exit(EXIT_FAILURE);
  }

  if (pthread_mutex_lock(&dmnsn_resilience_mutex) != 0) {
    /* Couldn't lock the mutex, so warn and continue. */
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't lock resilience mutex.");
  }
  dmnsn_resilience = resilience;
  if (pthread_mutex_unlock(&dmnsn_resilience_mutex) != 0) {
    /* Couldn't unlock the mutex, so warn and continue.  If the mutex was locked
       earlier, the next dmnsn_get/set_resilience is likely to hang. */
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't unlock resilience mutex.");
  }
}

dmnsn_fatal_error_fn *
dmnsn_get_fatal_error_fn(void)
{
  dmnsn_fatal_error_fn *fatal;
  if (pthread_mutex_lock(&dmnsn_fatal_mutex) != 0) {
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't lock fatal error handler mutex.");
  }
  fatal = dmnsn_fatal;
  if (pthread_mutex_unlock(&dmnsn_fatal_mutex) != 0) {
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't unlock fatal error handler mutex.");
  }
  return fatal;
}

void
dmnsn_set_fatal_error_fn(dmnsn_fatal_error_fn *fatal)
{
  if (pthread_mutex_lock(&dmnsn_fatal_mutex) != 0) {
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't lock fatal error handler mutex.");
  }
  dmnsn_fatal = fatal;
  if (pthread_mutex_unlock(&dmnsn_fatal_mutex) != 0) {
    fprintf(stderr, "Dimension WARNING: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Couldn't unlock fatal error handler mutex.");
  }
}

static void
dmnsn_default_fatal_error_fn(void)
{
  /* Prevent infinite recursion if the fatal error function itself calls
     dmnsn_error() */
  static __thread bool thread_exiting = false;

  dmnsn_backtrace(stderr);

  if (thread_exiting) {
    fprintf(stderr, "Dimension ERROR: %s, line %u: %s\n",
            DMNSN_FUNC, __LINE__,
            "Error raised while in error handler, aborting.");
    abort();
  } else if (dmnsn_is_main_thread()) {
    thread_exiting = true;
    exit(EXIT_FAILURE);
  } else {
    thread_exiting = true;
    pthread_exit(NULL);
  }
}