source: libcfa/src/interpose.cfa@ 3b402339

ADT arm-eh ast-experimental enum forall-pointer-decay jacob/cs343-translation new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since 3b402339 was 92bfda0, checked in by Thierry Delisle <tdelisle@…>, 5 years ago

Revisited abort again to be more streamlined and simple.
  • Property mode set to 100644
File size: 11.5 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// interpose.c --
8//
9// Author : Thierry Delisle
10// Created On : Wed Mar 29 16:10:31 2017
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Fri Mar 13 17:35:37 2020
13// Update Count : 178
14//
15
16#include <stdarg.h> // va_start, va_end
17#include <stdio.h>
18#include <string.h> // strlen
19#include <unistd.h> // _exit, getpid
20#define __USE_GNU
21#include <signal.h>
22#undef __USE_GNU
23extern "C" {
24#include <dlfcn.h> // dlopen, dlsym
25#include <execinfo.h> // backtrace, messages
26}
27
28#include "bits/debug.hfa"
29#include "bits/defs.hfa"
30#include "bits/signal.hfa" // sigHandler_?
31#include "startup.hfa" // STARTUP_PRIORITY_CORE
32#include <assert.h>
33
34//=============================================================================================
35// Interposing helpers
36//=============================================================================================
37
38void preload_libgcc(void) {
39 dlopen( "libgcc_s.so.1", RTLD_NOW );
40 if ( const char * error = dlerror() ) abort( "interpose_symbol : internal error pre-loading libgcc, %s\n", error );
41}
42
43typedef void (* generic_fptr_t)(void);
44generic_fptr_t interpose_symbol( const char symbol[], const char version[] ) {
45 const char * error;
46
47 static void * library;
48 if ( ! library ) {
49 #if defined( RTLD_NEXT )
50 library = RTLD_NEXT;
51 #else
52 // missing RTLD_NEXT => must hard-code library name, assuming libstdc++
53 library = dlopen( "libc.so.6", RTLD_LAZY );
54 error = dlerror();
55 if ( error ) {
56 abort( "interpose_symbol : failed to open libc, %s\n", error );
57 }
58 #endif
59 } // if
60
61 union { generic_fptr_t fptr; void * ptr; } originalFunc;
62
63 #if defined( _GNU_SOURCE )
64 if ( version ) {
65 originalFunc.ptr = dlvsym( library, symbol, version );
66 } else {
67 originalFunc.ptr = dlsym( library, symbol );
68 }
69 #else
70 originalFunc.ptr = dlsym( library, symbol );
71 #endif // _GNU_SOURCE
72
73 error = dlerror();
74 if ( error ) abort( "interpose_symbol : internal error, %s\n", error );
75
76 return originalFunc.fptr;
77}
78
79#define INTERPOSE_LIBC( x, ver ) __cabi_libc.x = (typeof(__cabi_libc.x))interpose_symbol( #x, ver )
80
81//=============================================================================================
82// Interposition Startup logic
83//=============================================================================================
84
85void sigHandler_segv( __CFA_SIGPARMS__ );
86void sigHandler_ill ( __CFA_SIGPARMS__ );
87void sigHandler_fpe ( __CFA_SIGPARMS__ );
88void sigHandler_abrt( __CFA_SIGPARMS__ );
89void sigHandler_term( __CFA_SIGPARMS__ );
90
91struct {
92 void (* exit)( int ) __attribute__(( __noreturn__ ));
93 void (* abort)( void ) __attribute__(( __noreturn__ ));
94} __cabi_libc;
95
96extern "C" {
97 void __cfaabi_interpose_startup(void) __attribute__(( constructor( STARTUP_PRIORITY_CORE ) ));
98 void __cfaabi_interpose_startup( void ) {
99 const char *version = 0p;
100
101 preload_libgcc();
102
103#pragma GCC diagnostic push
104#pragma GCC diagnostic ignored "-Wdiscarded-qualifiers"
105 INTERPOSE_LIBC( abort, version );
106 INTERPOSE_LIBC( exit , version );
107#pragma GCC diagnostic pop
108
109 // As a precaution (and necessity), errors that result in termination are delivered on a separate stack because
110 // task stacks might be very small (4K) and the signal delivery corrupts memory to the point that a clean
111 // shutdown is impossible. Also, when a stack overflow encounters the non-accessible sentinel page (debug only)
112 // and generates a segment fault, the signal cannot be delivered on the sentinel page. Finally, calls to abort
113 // print a stack trace that uses substantial stack space.
114
115 #define MINSTKSZ SIGSTKSZ * 8
116 static char stack[MINSTKSZ] __attribute__(( aligned (16) ));
117 static stack_t ss;
118
119 ss.ss_sp = stack;
120 ss.ss_size = MINSTKSZ;
121 ss.ss_flags = 0;
122 if ( sigaltstack( &ss, 0p ) == -1 ) {
123 abort( "__cfaabi_interpose_startup : internal error, sigaltstack error(%d) %s.", errno, strerror( errno ) );
124 } // if
125
126 // Failure handler
127 // internal errors
128 __cfaabi_sigaction( SIGSEGV, sigHandler_segv, SA_SIGINFO | SA_ONSTACK ); // Invalid memory reference (default: Core)
129 __cfaabi_sigaction( SIGBUS , sigHandler_segv, SA_SIGINFO | SA_ONSTACK ); // Bus error, bad memory access (default: Core)
130 __cfaabi_sigaction( SIGILL , sigHandler_ill , SA_SIGINFO | SA_ONSTACK ); // Illegal Instruction (default: Core)
131 __cfaabi_sigaction( SIGFPE , sigHandler_fpe , SA_SIGINFO | SA_ONSTACK ); // Floating-point exception (default: Core)
132
133 // handlers to outside errors
134 // reset in-case they insist and send it over and over
135 __cfaabi_sigaction( SIGTERM, sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Termination signal (default: Term)
136 __cfaabi_sigaction( SIGINT , sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Interrupt from keyboard (default: Term)
137 __cfaabi_sigaction( SIGHUP , sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Hangup detected on controlling terminal or death of controlling process (default: Term)
138 __cfaabi_sigaction( SIGQUIT, sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Quit from keyboard (default: Core)
139 __cfaabi_sigaction( SIGABRT, sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Abort signal from abort(3) (default: Core)
140 }
141}
142
143//=============================================================================================
144// Terminating Signals logic
145//=============================================================================================
146
147// Forward declare abort after the __typeof__ call to avoid ambiguities
148void exit( int status, const char fmt[], ... ) __attribute__(( format(printf, 2, 3), __nothrow__, __leaf__, __noreturn__ ));
149void abort( const char fmt[], ... ) __attribute__(( format(printf, 1, 2), __nothrow__, __leaf__, __noreturn__ ));
150void abort( bool signalAbort, const char fmt[], ... ) __attribute__(( format(printf, 2, 3), __nothrow__, __leaf__, __noreturn__ ));
151void __abort( bool signalAbort, const char fmt[], va_list args ) __attribute__(( __nothrow__, __leaf__, __noreturn__ ));
152
153extern "C" {
154 void abort( void ) __attribute__(( __nothrow__, __leaf__, __noreturn__ )) {
155 abort( false, "%s", "" );
156 }
157
158 void __cabi_abort( const char fmt[], ... ) __attribute__(( format(printf, 1, 2), __nothrow__, __leaf__, __noreturn__ )) {
159 va_list argp;
160 va_start( argp, fmt );
161 __abort( false, fmt, argp );
162 va_end( argp );
163 }
164
165 void exit( int status ) __attribute__(( __nothrow__, __leaf__, __noreturn__ )) {
166 __cabi_libc.exit( status );
167 }
168}
169
170// See concurrency/kernel.cfa and concurrency/preemption.cfa for strong definition used in multi-processor mode.
171void __kernel_abort_lock( void ) __attribute__(( __nothrow__, __leaf__, __weak__ )) {}
172void __kernel_abort_msg( char buffer[], int size ) __attribute__(( __nothrow__, __leaf__, __weak__ )) {}
173int __kernel_abort_lastframe( void ) __attribute__(( __nothrow__, __leaf__, __weak__ )) { return 4; }
174
175enum { abort_text_size = 1024 };
176static char abort_text[ abort_text_size ];
177
178static void __cfaabi_backtrace( int start ) {
179 enum { Frames = 50, }; // maximum number of stack frames
180 int last = __kernel_abort_lastframe(); // skip last N stack frames
181
182 void * array[Frames];
183 size_t size = backtrace( array, Frames );
184 char ** messages = backtrace_symbols( array, size ); // does not demangle names
185
186 *index( messages[0], '(' ) = '\0'; // find executable name
187 __cfaabi_bits_print_nolock( STDERR_FILENO, "Stack back trace for: %s\n", messages[0]);
188
189 for ( unsigned int i = start; i < size - last && messages != 0p; i += 1 ) {
190 char * name = 0p, * offset_begin = 0p, * offset_end = 0p;
191
192 for ( char * p = messages[i]; *p; p += 1 ) { // find parantheses and +offset
193 //__cfaabi_bits_print_nolock( "X %s\n", p);
194 if ( *p == '(' ) {
195 name = p;
196 } else if ( *p == '+' ) {
197 offset_begin = p;
198 } else if ( *p == ')' ) {
199 offset_end = p;
200 break;
201 }
202 }
203
204 // if line contains symbol, print it
205 int frameNo = i - start;
206 if ( name && offset_begin && offset_end && name < offset_begin ) {
207 *name++ = '\0'; // delimit strings
208 *offset_begin++ = '\0';
209 *offset_end++ = '\0';
210
211 __cfaabi_bits_print_nolock( STDERR_FILENO, "(%i) %s : %s + %s %s\n", frameNo, messages[i], name, offset_begin, offset_end);
212 } else { // otherwise, print the whole line
213 __cfaabi_bits_print_nolock( STDERR_FILENO, "(%i) %s\n", frameNo, messages[i] );
214 }
215 }
216 free( messages );
217}
218
219void exit( int status, const char fmt[], ... ) {
220 va_list args;
221 va_start( args, fmt );
222 vfprintf( stderr, fmt, args );
223 va_end( args );
224 __cabi_libc.exit( status );
225}
226
227static volatile bool __abort_first = 0;
228
229// Cannot forward va_list.
230void __abort( bool signalAbort, const char fmt[], va_list args ) {
231 // Multiple threads can come here from multiple paths
232 // To make sure this is safe any concurrent/subsequent call to abort is redirected to libc-abort
233 bool first = ! __atomic_test_and_set( &__abort_first, __ATOMIC_SEQ_CST);
234
235 // Prevent preemption from kicking-in and messing with the abort
236 __kernel_abort_lock();
237
238 // first to abort ?
239 if ( !first ) {
240 // We aren't the first to abort just let C handle it
241 signal( SIGABRT, SIG_DFL ); // restore default in case we came here through the function.
242 __cabi_libc.abort();
243 }
244
245 int len = snprintf( abort_text, abort_text_size, "Cforall Runtime error (UNIX pid:%ld) ", (long int)getpid() ); // use UNIX pid (versus getPid)
246 __cfaabi_bits_write( STDERR_FILENO, abort_text, len );
247
248 // print the cause of the error
249 assert( fmt );
250 len = vsnprintf( abort_text, abort_text_size, fmt, args );
251 __cfaabi_bits_write( STDERR_FILENO, abort_text, len );
252
253 // add optional newline if missing at the end of the format text
254 if ( fmt[strlen( fmt ) - 1] != '\n' ) {
255 __cfaabi_bits_write( STDERR_FILENO, "\n", 1 );
256 } // if
257
258 // Give the kernel the chance to add some data in here
259 __kernel_abort_msg( abort_text, abort_text_size );
260
261 // print stack trace in handler
262 __cfaabi_backtrace( signalAbort ? 4 : 2 );
263
264 // Finally call abort
265 __cabi_libc.abort();
266
267}
268
269void abort( const char fmt[], ... ) {
270 va_list args;
271 va_start( args, fmt );
272 __abort( false, fmt, args );
273 // CONTROL NEVER REACHES HERE!
274 va_end( args );
275}
276
277void abort( bool signalAbort, const char fmt[], ... ) {
278 va_list args;
279 va_start( args, fmt );
280 __abort( signalAbort, fmt, args );
281 // CONTROL NEVER REACHES HERE!
282 va_end( args );
283}
284
285void sigHandler_segv( __CFA_SIGPARMS__ ) {
286 if ( sfp->si_addr == 0p ) {
287 abort( true, "Null pointer (0p) dereference.\n" );
288 } else {
289 abort( true, "%s at memory location %p.\n"
290 "Possible cause is reading outside the address space or writing to a protected area within the address space with an invalid pointer or subscript.\n",
291 (sig == SIGSEGV ? "Segment fault" : "Bus error"), sfp->si_addr );
292 }
293}
294
295void sigHandler_ill( __CFA_SIGPARMS__ ) {
296 abort( true, "Executing illegal instruction at location %p.\n"
297 "Possible cause is stack corruption.\n",
298 sfp->si_addr );
299}
300
301void sigHandler_fpe( __CFA_SIGPARMS__ ) {
302 const char * msg;
303
304 choose( sfp->si_code ) {
305 case FPE_INTDIV, FPE_FLTDIV: msg = "divide by zero";
306 case FPE_FLTOVF: msg = "overflow";
307 case FPE_FLTUND: msg = "underflow";
308 case FPE_FLTRES: msg = "inexact result";
309 case FPE_FLTINV: msg = "invalid operation";
310 default: msg = "unknown";
311 } // choose
312 abort( true, "Computation error %s at location %p.\n", msg, sfp->si_addr );
313}
314
315void sigHandler_term( __CFA_SIGPARMS__ ) {
316 abort( true, "Application interrupted by signal: %s.\n", strsignal( sig ) );
317}
318
319// Local Variables: //
320// mode: c //
321// tab-width: 4 //
322// End: //
Note: See TracBrowser for help on using the repository browser.