source: libcfa/src/interpose.cfa@ 95dab9e

ADT ast-experimental pthread-emulation stuck-waitfor-destruct
Last change on this file since 95dab9e was 95dab9e, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

Changed real_pthread symbols (now cfaabi_pthread) to be protected in libcfathread
  • Property mode set to 100644
File size: 13.1 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
38static void 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);
44static generic_fptr_t do_interpose_symbol( void * library, const char symbol[], const char version[] ) {
45 const char * error;
46
47 union { generic_fptr_t fptr; void * ptr; } originalFunc;
48
49 #if defined( _GNU_SOURCE )
50 if ( version ) {
51 originalFunc.ptr = dlvsym( library, symbol, version );
52 } else {
53 originalFunc.ptr = dlsym( library, symbol );
54 }
55 #else
56 originalFunc.ptr = dlsym( library, symbol );
57 #endif // _GNU_SOURCE
58
59 error = dlerror();
60 if ( error ) abort( "interpose_symbol : internal error, %s\n", error );
61
62 return originalFunc.fptr;
63}
64
65static generic_fptr_t interpose_symbol( const char symbol[], const char version[] ) {
66 const char * error;
67
68 static void * library;
69 static void * pthread_library;
70 if ( ! library ) {
71 #if defined( RTLD_NEXT )
72 library = RTLD_NEXT;
73 #else
74 // missing RTLD_NEXT => must hard-code library name, assuming libstdc++
75 library = dlopen( "libc.so.6", RTLD_LAZY );
76 error = dlerror();
77 if ( error ) {
78 abort( "interpose_symbol : failed to open libc, %s\n", error );
79 }
80 #endif
81 } // if
82 if ( ! pthread_library ) {
83 #if defined( RTLD_NEXT )
84 pthread_library = RTLD_NEXT;
85 #else
86 // missing RTLD_NEXT => must hard-code library name, assuming libstdc++
87 pthread_library = dlopen( "libpthread.so", RTLD_LAZY );
88 error = dlerror();
89 if ( error ) {
90 abort( "interpose_symbol : failed to open libpthread, %s\n", error );
91 }
92 #endif
93 } // if
94
95 return do_interpose_symbol(library, symbol, version);
96}
97
98#define INTERPOSE_LIBC( x, ver ) __cabi_libc.x = (typeof(__cabi_libc.x))interpose_symbol( #x, ver )
99
100//=============================================================================================
101// Interposition Startup logic
102//=============================================================================================
103
104static void sigHandler_segv( __CFA_SIGPARMS__ );
105static void sigHandler_ill ( __CFA_SIGPARMS__ );
106static void sigHandler_fpe ( __CFA_SIGPARMS__ );
107static void sigHandler_abrt( __CFA_SIGPARMS__ );
108static void sigHandler_term( __CFA_SIGPARMS__ );
109
110static struct {
111 void (* exit)( int ) __attribute__(( __noreturn__ ));
112 void (* abort)( void ) __attribute__(( __noreturn__ ));
113 int (*pthread_create)(pthread_t *_thread, const pthread_attr_t *attr, void *(*start_routine) (void *), void *arg);
114 int (*pthread_join)(pthread_t _thread, void **retval);
115 pthread_t (*pthread_self)(void);
116 int (*pthread_attr_init)(pthread_attr_t *attr);
117 int (*pthread_attr_destroy)(pthread_attr_t *attr);
118 int (*pthread_attr_setstack)( pthread_attr_t *attr, void *stackaddr, size_t stacksize );
119 int (*pthread_attr_getstacksize)( const pthread_attr_t *attr, size_t *stacksize );
120 int (*pthread_sigmask)(int how, const sigset_t *set, sigset_t *oldset);
121 int (*pthread_sigqueue)(pthread_t _thread, int sig, const union sigval value);
122} __cabi_libc;
123
124libcfa_public int cfa_main_returned;
125
126extern "C" {
127 void __cfathreadabi_interpose_startup( generic_fptr_t (*do_interpose_symbol)( void * library, const char symbol[], const char version[] ) ) __attribute__((weak));
128 void __cfaabi_interpose_startup( void ) {
129 const char *version = 0p;
130 cfa_main_returned = 0;
131
132 preload_libgcc();
133
134#pragma GCC diagnostic push
135#pragma GCC diagnostic ignored "-Wdiscarded-qualifiers"
136 INTERPOSE_LIBC( abort, version );
137 INTERPOSE_LIBC( exit , version );
138#pragma GCC diagnostic pop
139
140 if(__cfathreadabi_interpose_startup) __cfathreadabi_interpose_startup( do_interpose_symbol );
141
142 // As a precaution (and necessity), errors that result in termination are delivered on a separate stack because
143 // task stacks might be very small (4K) and the signal delivery corrupts memory to the point that a clean
144 // shutdown is impossible. Also, when a stack overflow encounters the non-accessible sentinel page (debug only)
145 // and generates a segment fault, the signal cannot be delivered on the sentinel page. Finally, calls to abort
146 // print a stack trace that uses substantial stack space.
147
148 #define MINSTKSZ SIGSTKSZ * 8
149 static char stack[MINSTKSZ] __attribute__(( aligned (16) ));
150 static stack_t ss;
151
152 ss.ss_sp = stack;
153 ss.ss_size = MINSTKSZ;
154 ss.ss_flags = 0;
155 if ( sigaltstack( &ss, 0p ) == -1 ) {
156 abort( "__cfaabi_interpose_startup : internal error, sigaltstack error(%d) %s.", errno, strerror( errno ) );
157 } // if
158
159 // Failure handler
160 // internal errors
161 __cfaabi_sigaction( SIGSEGV, sigHandler_segv, SA_SIGINFO | SA_ONSTACK ); // Invalid memory reference (default: Core)
162 __cfaabi_sigaction( SIGBUS , sigHandler_segv, SA_SIGINFO | SA_ONSTACK ); // Bus error, bad memory access (default: Core)
163 __cfaabi_sigaction( SIGILL , sigHandler_ill , SA_SIGINFO | SA_ONSTACK ); // Illegal Instruction (default: Core)
164 __cfaabi_sigaction( SIGFPE , sigHandler_fpe , SA_SIGINFO | SA_ONSTACK ); // Floating-point exception (default: Core)
165
166 // handlers to outside errors
167 // reset in-case they insist and send it over and over
168 __cfaabi_sigaction( SIGTERM, sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Termination signal (default: Term)
169 __cfaabi_sigaction( SIGINT , sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Interrupt from keyboard (default: Term)
170 __cfaabi_sigaction( SIGHUP , sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Hangup detected on controlling terminal or death of controlling process (default: Term)
171 __cfaabi_sigaction( SIGQUIT, sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Quit from keyboard (default: Core)
172 __cfaabi_sigaction( SIGABRT, sigHandler_term, SA_SIGINFO | SA_ONSTACK | SA_RESETHAND ); // Abort signal from abort(3) (default: Core)
173 }
174}
175
176//=============================================================================================
177// Terminating Signals logic
178//=============================================================================================
179
180// Forward declare abort after the __typeof__ call to avoid ambiguities
181libcfa_public void exit( int status, const char fmt[], ... ) __attribute__(( format(printf, 2, 3), __nothrow__, __leaf__, __noreturn__ ));
182libcfa_public void abort( const char fmt[], ... ) __attribute__(( format(printf, 1, 2), __nothrow__, __leaf__, __noreturn__ ));
183libcfa_public void abort( bool signalAbort, const char fmt[], ... ) __attribute__(( format(printf, 2, 3), __nothrow__, __leaf__, __noreturn__ ));
184libcfa_public void __abort( bool signalAbort, const char fmt[], va_list args ) __attribute__(( __nothrow__, __leaf__, __noreturn__ ));
185
186extern "C" {
187 libcfa_public void abort( void ) __attribute__(( __nothrow__, __leaf__, __noreturn__ )) {
188 abort( false, "%s", "" );
189 }
190
191 libcfa_public void __cabi_abort( const char fmt[], ... ) __attribute__(( format(printf, 1, 2), __nothrow__, __leaf__, __noreturn__ )) {
192 va_list argp;
193 va_start( argp, fmt );
194 __abort( false, fmt, argp );
195 va_end( argp );
196 }
197
198 libcfa_public void exit( int status ) __attribute__(( __nothrow__, __leaf__, __noreturn__ )) {
199 __cabi_libc.exit( status );
200 }
201}
202
203// See concurrency/kernel.cfa and concurrency/preemption.cfa for strong definition used in multi-processor mode.
204void __kernel_abort_lock( void ) __attribute__(( __nothrow__, __leaf__, __weak__ )) {}
205void __kernel_abort_msg( char buffer[], int size ) __attribute__(( __nothrow__, __leaf__, __weak__ )) {}
206int __kernel_abort_lastframe( void ) __attribute__(( __nothrow__, __leaf__, __weak__ )) { return 4; }
207
208enum { abort_text_size = 1024 };
209static char abort_text[ abort_text_size ];
210
211static void __cfaabi_backtrace( int start ) {
212 enum { Frames = 50, }; // maximum number of stack frames
213 int last = __kernel_abort_lastframe(); // skip last N stack frames
214
215 void * array[Frames];
216 size_t size = backtrace( array, Frames );
217 char ** messages = backtrace_symbols( array, size ); // does not demangle names
218
219 *index( messages[0], '(' ) = '\0'; // find executable name
220 __cfaabi_bits_print_nolock( STDERR_FILENO, "Stack back trace for: %s\n", messages[0]);
221
222 for ( unsigned int i = start; i < size - last && messages != 0p; i += 1 ) {
223 char * name = 0p, * offset_begin = 0p, * offset_end = 0p;
224
225 for ( char * p = messages[i]; *p; p += 1 ) { // find parantheses and +offset
226 //__cfaabi_bits_print_nolock( "X %s\n", p);
227 if ( *p == '(' ) {
228 name = p;
229 } else if ( *p == '+' ) {
230 offset_begin = p;
231 } else if ( *p == ')' ) {
232 offset_end = p;
233 break;
234 }
235 }
236
237 // if line contains symbol, print it
238 int frameNo = i - start;
239 if ( name && offset_begin && offset_end && name < offset_begin ) {
240 *name++ = '\0'; // delimit strings
241 *offset_begin++ = '\0';
242 *offset_end++ = '\0';
243
244 __cfaabi_bits_print_nolock( STDERR_FILENO, "(%i) %s : %s + %s %s\n", frameNo, messages[i], name, offset_begin, offset_end);
245 } else { // otherwise, print the whole line
246 __cfaabi_bits_print_nolock( STDERR_FILENO, "(%i) %s\n", frameNo, messages[i] );
247 }
248 }
249 free( messages );
250}
251
252void exit( int status, const char fmt[], ... ) {
253 va_list args;
254 va_start( args, fmt );
255 vfprintf( stderr, fmt, args );
256 va_end( args );
257 __cabi_libc.exit( status );
258}
259
260static volatile bool __abort_first = 0;
261
262// Cannot forward va_list.
263void __abort( bool signalAbort, const char fmt[], va_list args ) {
264 // Multiple threads can come here from multiple paths
265 // To make sure this is safe any concurrent/subsequent call to abort is redirected to libc-abort
266 bool first = ! __atomic_test_and_set( &__abort_first, __ATOMIC_SEQ_CST);
267
268 // Prevent preemption from kicking-in and messing with the abort
269 __kernel_abort_lock();
270
271 // first to abort ?
272 if ( !first ) {
273 // We aren't the first to abort just let C handle it
274 signal( SIGABRT, SIG_DFL ); // restore default in case we came here through the function.
275 __cabi_libc.abort();
276 }
277
278 int len = snprintf( abort_text, abort_text_size, "Cforall Runtime error (UNIX pid:%ld) ", (long int)getpid() ); // use UNIX pid (versus getPid)
279 __cfaabi_bits_write( STDERR_FILENO, abort_text, len );
280
281 // print the cause of the error
282 assert( fmt );
283 len = vsnprintf( abort_text, abort_text_size, fmt, args );
284 __cfaabi_bits_write( STDERR_FILENO, abort_text, len );
285
286 // add optional newline if missing at the end of the format text
287 if ( fmt[strlen( fmt ) - 1] != '\n' ) {
288 __cfaabi_bits_write( STDERR_FILENO, "\n", 1 );
289 } // if
290
291 // Give the kernel the chance to add some data in here
292 __kernel_abort_msg( abort_text, abort_text_size );
293
294 // print stack trace in handler
295 __cfaabi_backtrace( signalAbort ? 4 : 2 );
296
297 // Finally call abort
298 __cabi_libc.abort();
299
300}
301
302void abort( const char fmt[], ... ) {
303 va_list args;
304 va_start( args, fmt );
305 __abort( false, fmt, args );
306 // CONTROL NEVER REACHES HERE!
307 va_end( args );
308}
309
310void abort( bool signalAbort, const char fmt[], ... ) {
311 va_list args;
312 va_start( args, fmt );
313 __abort( signalAbort, fmt, args );
314 // CONTROL NEVER REACHES HERE!
315 va_end( args );
316}
317
318void sigHandler_segv( __CFA_SIGPARMS__ ) {
319 if ( sfp->si_addr == 0p ) {
320 abort( true, "Null pointer (0p) dereference.\n" );
321 } else {
322 abort( true, "%s at memory location %p.\n"
323 "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",
324 (sig == SIGSEGV ? "Segment fault" : "Bus error"), sfp->si_addr );
325 }
326}
327
328void sigHandler_ill( __CFA_SIGPARMS__ ) {
329 abort( true, "Executing illegal instruction at location %p.\n"
330 "Possible cause is stack corruption.\n",
331 sfp->si_addr );
332}
333
334void sigHandler_fpe( __CFA_SIGPARMS__ ) {
335 const char * msg;
336
337 choose( sfp->si_code ) {
338 case FPE_INTDIV, FPE_FLTDIV: msg = "divide by zero";
339 case FPE_FLTOVF: msg = "overflow";
340 case FPE_FLTUND: msg = "underflow";
341 case FPE_FLTRES: msg = "inexact result";
342 case FPE_FLTINV: msg = "invalid operation";
343 default: msg = "unknown";
344 } // choose
345 abort( true, "Computation error %s at location %p.\n", msg, sfp->si_addr );
346}
347
348void sigHandler_term( __CFA_SIGPARMS__ ) {
349 abort( true, "Application interrupted by signal: %s.\n", strsignal( sig ) );
350}
351
352// Local Variables: //
353// mode: c //
354// tab-width: 4 //
355// End: //
Note: See TracBrowser for help on using the repository browser.