annotate libcore/core/panic.c @ 229:e71039d820a7

doc: improve documentation
author David Demelier <markand@malikania.fr>
date Thu, 19 Nov 2020 16:46:26 +0100
parents aab824406d3d
children 76afe639fd72
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * panic.c -- unrecoverable error handling
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <assert.h>
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
20 #include <stdio.h>
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
21 #include <stdlib.h>
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include "error.h"
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include "panic.h"
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
229
e71039d820a7 doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 168
diff changeset
26 static void
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
27 terminate(void)
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
28 {
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
29 fprintf(stderr, "abort: %s\n", error());
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
30 abort();
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
31 exit(1);
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
32 }
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
34 void (*panic_handler)(void) = terminate;
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
35
229
e71039d820a7 doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 168
diff changeset
36 void
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
37 panicf(const char *fmt, ...)
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 {
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 assert(fmt);
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 va_list ap;
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
43 /*
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
44 * Store the error before calling panic because va_end would not be
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
45 * called.
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
46 */
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 va_start(ap, fmt);
168
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 162
diff changeset
48 verrorf(fmt, ap);
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 va_end(ap);
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
50
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
51 panic();
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 }
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
229
e71039d820a7 doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 168
diff changeset
54 void
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
55 vpanicf(const char *fmt, va_list ap)
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 {
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 assert(fmt);
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 assert(panic_handler);
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
168
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 162
diff changeset
60 verrorf(fmt, ap);
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
61 panic();
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
62 }
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
63
229
e71039d820a7 doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 168
diff changeset
64 void
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
65 panic(void)
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
66 {
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
67 assert(panic_handler);
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
68
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 panic_handler();
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
70
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
71 /*
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
72 * This should not happen, if it does it means the user did not fully
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
73 * satisfied the constraint of panic_handler.
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
74 */
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
75 fprintf(stderr, "abort: panic handler returned");
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
76 exit(1);
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 }