summaryrefslogtreecommitdiff
path: root/cesar/lib/src/dbg.c
blob: 49c3d134ddf9da708e9661d900a0be4fa471a866 (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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/* Cesar project {{{
 *
 * Copyright (C) 2007 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    lib/src/dbg.c
 * \brief   Debug functions.
 * \ingroup lib
 */
#include "common/std.h"

#include "hal/arch/arch.h"
#include "hal/arch/io.h"
#include "hal/gpio/gpio.h"

#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>

#include "build_info.h"

/** Fatal error callbacks. */
dbg_fatal_callback_t dbg_fatal_cb[4];

/** Fatal error dump callbacks. */
dbg_fatal_dump_callback_t dbg_fatal_dump_cb[4];

/** Dump callback. */
dbg_dump_callback_t dbg_dump_cb;

/** Dump callback user parameter. */
void *dbg_dump_cb_user;

/** Maximum size of fatal error text. */
#define DBG_FATAL_TEXT_SIZE 1024

/** Version string. */
#define DBG_VERSION \
    "project: " BUILD_INFO_PROJECT "\n" \
    "version: " BUILD_INFO_VERSION "\n"

ARCH_STACK_DECLARE (dbg_stack);

#if DEBUG

# if CONFIG_DEBUG_FATAL_CATCH
int dbg_fatal_try_level_;
char dbg_fatal_text_[DBG_FATAL_TEXT_SIZE];
# endif

void
dbg_assert_fail (const char *assertion, const char *file, uint line,
                 const char *function)
{
    dbg_fatal (DBG_ASSERT_FMT_ "%s", file, line, function,
               assertion);
}

void
dbg_assert_fail_desc (const dbg_assert_desc_t *assert_desc)
{
    dbg_fatal (DBG_ASSERT_FMT_ "%s", assert_desc->file, assert_desc->line,
               assert_desc->function, assert_desc->assertion);
}

void
dbg_assert_fail_terse (const char *message)
{
    dbg_fatal ("%s", message);
}

void
dbg_assert_print_fail (const char *fmt, ...)
{
    va_list ap;
    va_start (ap, fmt);
    dbg_vfatal (fmt, ap);
    va_end (ap);
}

#endif /* DEBUG */

#if !DEBUG

void
dbg_fatal_blind (void)
{
    dbg_fatal ("fatal error");
}

#endif /* !DEBUG */

/**
 * Like vsnprintf, but terminate the string gracefully if there is not enough
 * space.
 * \param  buffer  place to write characters
 * \param  size  memory available, including the terminating zero
 * \param  fmt  printf like format
 * \param  ap  argument pointer
 * \return  number of produced characters
 */
static int
dbg_vsnprintf (char *buffer, uint size, const char *fmt, va_list ap)
{
    uint r;
    r = vsnprintf (buffer, size, fmt, ap);
    if (r < size)
        return r;
    else
    {
        buffer[size - 4] = '.';
        buffer[size - 3] = '.';
        buffer[size - 2] = '.';
        buffer[size - 1] = '\0';
        return size - 1;
    }
}

void
dbg_fatal (const char *fmt, ...)
{
    va_list ap;
    va_start (ap, fmt);
    dbg_vfatal (fmt, ap);
    va_end (ap);
}

/**
 * Default dump callback, dump on stderr.
 * \param  user  ignored user parameter
 * \param  text  text to dump
 * \param  text_size  size of text or 0 for end of dump
 * \return  size of dumped text
 */
static int
dbg_default_dump_cb (void *user, const char *text, uint text_size)
{
    dbg_assert ((text && text_size) || text_size == 0);
    arch_io_write (text, text_size);
    return text_size;
}

static void
dbg_vfatal_internal (const char *fmt, va_list ap)
{
    static bool in_fatal = false;
    uint i;
    /* Stop system. */
    arch_stop ();
    /* Signal on GPIOs. */
    GPIO_SETUP (FATAL, GPIO_DIRECTION_OUT);
    GPIO_SET (FATAL, 0);
    GPIO_SETUP (FATAL_BLINK, GPIO_DIRECTION_OUT);
    GPIO_SET (FATAL_BLINK, 0);
    /* Call fatal callback. */
    for (i = 0; i < COUNT (dbg_fatal_cb); i++)
        if (dbg_fatal_cb[i])
            dbg_fatal_cb[i] ();
#ifdef __sparc__
    /* Amuse the user. */
    static const char sparc_sprite[] =
        "    \\|/ ____ \\|/\n"
        "    \"@'/ ,. \\`@\"\n"
        "    /_| \\__/ |_\\\n"
        "       \\__U_/\n";
    dbg_default_dump_cb (NULL, sparc_sprite, strlen (sparc_sprite));
#endif
    /* Get dump callback. */
    dbg_dump_callback_t cb = dbg_dump_cb ? dbg_dump_cb : dbg_default_dump_cb;
    /* Complain for bad treatments. */
    char fatal_text[DBG_FATAL_TEXT_SIZE];
    uint fatal_text_len;
    fatal_text_len = dbg_vsnprintf (fatal_text, sizeof (fatal_text), fmt, ap);
    if (cb != dbg_default_dump_cb)
    {
        /* Always output on stderr. */
        dbg_default_dump_cb (NULL, fatal_text, fatal_text_len);
        dbg_default_dump_cb (NULL, "\n", 1);
    }
    cb (dbg_dump_cb_user, fatal_text, fatal_text_len);
    cb (dbg_dump_cb_user, "\n", 1);
    /* Dump version. */
    cb (dbg_dump_cb_user, DBG_VERSION, strlen (DBG_VERSION));
    /* Call fatal callbacks. */
    if (!in_fatal)
    {
        in_fatal = true;
        bool cb_called = false;
        for (i = 0; i < COUNT (dbg_fatal_dump_cb); i++)
            if (dbg_fatal_dump_cb[i])
            {
                dbg_fatal_dump_cb[i] (cb, dbg_dump_cb_user);
                cb_called = true;
            }
        if (cb_called)
        {
            cb (dbg_dump_cb_user, ">", 1);
            cb (dbg_dump_cb_user, fatal_text, fatal_text_len);
            cb (dbg_dump_cb_user, "\n", 1);
        }
        in_fatal = false;
    }
    /* Signal end of dump. */
    cb (dbg_dump_cb_user, NULL, 0);
    /* Signal on blinking GPIO. */
#if CONFIG_GPIO_FATAL_BLINK
    while (1)
    {
        /* No system available anymore, we are on our own. */
        uint i;
        volatile uint dummy;
        for (i = 0; i < CONFIG_GPIO_FATAL_BLINK_DELAY; i++)
            dummy = 0;
        GPIO_TOGGLE (FATAL_BLINK);
    }
#endif
}

void
dbg_vfatal (const char *fmt, va_list ap)
{
#if DEBUG && CONFIG_DEBUG_FATAL_CATCH
    if (dbg_fatal_try_level_)
    {
        dbg_vsnprintf (dbg_fatal_text_, sizeof (dbg_fatal_text_), fmt, ap);
        try_throw (TRY_CODE_FATAL);
    }
    else
#endif
    {
        arch_stack_call (dbg_stack, dbg_vfatal_internal, fmt, ap);
        arch_abort ();
    }
}

void
dbg_register_dump_callback (dbg_dump_callback_t callback, void *user)
{
    dbg_assert (callback);
    dbg_assert (!dbg_dump_cb || dbg_dump_cb == callback);
    dbg_dump_cb = callback;
    dbg_dump_cb_user = user;
}

void
dbg_register_fatal_callback (uint priority, dbg_fatal_callback_t callback)
{
    dbg_assert (callback);
    dbg_assert (priority < COUNT (dbg_fatal_cb) && !dbg_fatal_cb[priority]);
    dbg_fatal_cb[priority] = callback;
}

void
dbg_register_fatal_dump_callback (uint priority,
                                  dbg_fatal_dump_callback_t callback)
{
    dbg_assert (callback);
    dbg_assert (priority < COUNT (dbg_fatal_dump_cb)
                && !dbg_fatal_dump_cb[priority]);
    dbg_fatal_dump_cb[priority] = callback;
}

int
dbg_dump_printf (dbg_dump_callback_t dump_cb, void *dump_cb_user,
                 const char *fmt, ...)
{
    va_list ap;
    char text[1024];
    uint text_len;
    /* Format string. */
    va_start (ap, fmt);
    text_len = dbg_vsnprintf (text, sizeof (text), fmt, ap);
    va_end (ap);
    /* Output to debug dump. */
    return dump_cb (dump_cb_user, text, text_len);
}