source: libcfa/src/concurrency/preemption.cfa @ c1ee231

arm-ehjacob/cs343-translationnew-astnew-ast-unique-expr
Last change on this file since c1ee231 was c1ee231, checked in by Peter A. Buhr <pabuhr@…>, 20 months ago

remove extern "C" from include files protected in CFA stdhdr directory

  • Property mode set to 100644
File size: 16.8 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// signal.c --
8//
9// Author           : Thierry Delisle
10// Created On       : Mon Jun 5 14:20:42 2017
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Wed Jun 17 11:36:25 2020
13// Update Count     : 46
14//
15
16#define __cforall_thread__
17
18#include "preemption.hfa"
19#include <assert.h>
20
21#include <errno.h>
22#include <stdio.h>
23#include <string.h>
24#include <unistd.h>
25#include <limits.h>                                                                             // PTHREAD_STACK_MIN
26
27#include "bits/signal.hfa"
28
29#if !defined(__CFA_DEFAULT_PREEMPTION__)
30#define __CFA_DEFAULT_PREEMPTION__ 10`ms
31#endif
32
33Duration default_preemption() __attribute__((weak)) {
34        return __CFA_DEFAULT_PREEMPTION__;
35}
36
37// FwdDeclarations : timeout handlers
38static void preempt( processor   * this );
39static void timeout( $thread * this );
40
41// FwdDeclarations : Signal handlers
42static void sigHandler_ctxSwitch( __CFA_SIGPARMS__ );
43static void sigHandler_alarm    ( __CFA_SIGPARMS__ );
44static void sigHandler_segv     ( __CFA_SIGPARMS__ );
45static void sigHandler_ill      ( __CFA_SIGPARMS__ );
46static void sigHandler_fpe      ( __CFA_SIGPARMS__ );
47static void sigHandler_abort    ( __CFA_SIGPARMS__ );
48
49// FwdDeclarations : alarm thread main
50static void * alarm_loop( __attribute__((unused)) void * args );
51
52// Machine specific register name
53#if   defined( __i386 )
54#define CFA_REG_IP gregs[REG_EIP]
55#elif defined( __x86_64 )
56#define CFA_REG_IP gregs[REG_RIP]
57#elif defined( __ARM_ARCH )
58#define CFA_REG_IP arm_pc
59#else
60#error unknown hardware architecture
61#endif
62
63KERNEL_STORAGE(event_kernel_t, event_kernel);         // private storage for event kernel
64event_kernel_t * event_kernel;                        // kernel public handle to even kernel
65static pthread_t alarm_thread;                        // pthread handle to alarm thread
66static void * alarm_stack;                                                        // pthread stack for alarm thread
67
68static void ?{}(event_kernel_t & this) with( this ) {
69        alarms{};
70        lock{};
71}
72
73enum {
74        PREEMPT_NORMAL    = 0,
75        PREEMPT_TERMINATE = 1,
76};
77
78//=============================================================================================
79// Kernel Preemption logic
80//=============================================================================================
81
82// Get next expired node
83static inline alarm_node_t * get_expired( alarm_list_t * alarms, Time currtime ) {
84        if( ! & (*alarms)`first ) return 0p;                                            // If no alarms return null
85        if( (*alarms)`first.alarm >= currtime ) return 0p;      // If alarms head not expired return null
86        return pop(alarms);                                                                     // Otherwise just pop head
87}
88
89// Tick one frame of the Discrete Event Simulation for alarms
90static void tick_preemption() {
91        alarm_node_t * node = 0p;                                                       // Used in the while loop but cannot be declared in the while condition
92        alarm_list_t * alarms = &event_kernel->alarms;          // Local copy for ease of reading
93        Time currtime = __kernel_get_time();                            // Check current time once so everything "happens at once"
94
95        //Loop throught every thing expired
96        while( node = get_expired( alarms, currtime ) ) {
97                // __cfaabi_dbg_print_buffer_decl( " KERNEL: preemption tick.\n" );
98                Duration period = node->period;
99                if( period == 0) {
100                        node->set = false;                  // Node is one-shot, just mark it as not pending
101                }
102
103                // Check if this is a kernel
104                if( node->kernel_alarm ) {
105                        preempt( node->proc );
106                }
107                else {
108                        timeout( node->thrd );
109                }
110
111                // Check if this is a periodic alarm
112                if( period > 0 ) {
113                        // __cfaabi_dbg_print_buffer_local( " KERNEL: alarm period is %lu.\n", period.tv );
114                        node->alarm = currtime + period;    // Alarm is periodic, add currtime to it (used cached current time)
115                        insert( alarms, node );             // Reinsert the node for the next time it triggers
116                }
117        }
118
119        // If there are still alarms pending, reset the timer
120        if( & (*alarms)`first ) {
121                __cfaabi_dbg_print_buffer_decl( " KERNEL: @%ju(%ju) resetting alarm to %ju.\n", currtime.tv, __kernel_get_time().tv, (alarms->head->alarm - currtime).tv);
122                Duration delta = (*alarms)`first.alarm - currtime;
123                Duration capped = max(delta, 50`us);
124                // itimerval tim  = { caped };
125                // __cfaabi_dbg_print_buffer_local( "    Values are %lu, %lu, %lu %lu.\n", delta.tv, caped.tv, tim.it_value.tv_sec, tim.it_value.tv_usec);
126
127                __kernel_set_timer( capped );
128        }
129}
130
131// Update the preemption of a processor and notify interested parties
132void update_preemption( processor * this, Duration duration ) {
133        alarm_node_t * alarm = this->preemption_alarm;
134
135        // Alarms need to be enabled
136        if ( duration > 0 && ! alarm->set ) {
137                alarm->alarm = __kernel_get_time() + duration;
138                alarm->period = duration;
139                register_self( alarm );
140        }
141        // Zero duration but alarm is set
142        else if ( duration == 0 && alarm->set ) {
143                unregister_self( alarm );
144                alarm->alarm = 0;
145                alarm->period = 0;
146        }
147        // If alarm is different from previous, change it
148        else if ( duration > 0 && alarm->period != duration ) {
149                unregister_self( alarm );
150                alarm->alarm = __kernel_get_time() + duration;
151                alarm->period = duration;
152                register_self( alarm );
153        }
154}
155
156//=============================================================================================
157// Kernel Signal Tools
158//=============================================================================================
159
160__cfaabi_dbg_debug_do( static thread_local void * last_interrupt = 0; )
161
162extern "C" {
163        // Disable interrupts by incrementing the counter
164        void disable_interrupts() {
165                with( kernelTLS.preemption_state ) {
166                        #if GCC_VERSION > 50000
167                        static_assert(__atomic_always_lock_free(sizeof(enabled), &enabled), "Must be lock-free");
168                        #endif
169
170                        // Set enabled flag to false
171                        // should be atomic to avoid preemption in the middle of the operation.
172                        // use memory order RELAXED since there is no inter-thread on this variable requirements
173                        __atomic_store_n(&enabled, false, __ATOMIC_RELAXED);
174
175                        // Signal the compiler that a fence is needed but only for signal handlers
176                        __atomic_signal_fence(__ATOMIC_ACQUIRE);
177
178                        __attribute__((unused)) unsigned short new_val = disable_count + 1;
179                        disable_count = new_val;
180                        verify( new_val < 65_000u );              // If this triggers someone is disabling interrupts without enabling them
181                }
182        }
183
184        // Enable interrupts by decrementing the counter
185        // If counter reaches 0, execute any pending __cfactx_switch
186        void enable_interrupts( __cfaabi_dbg_ctx_param ) {
187                processor   * proc = kernelTLS.this_processor; // Cache the processor now since interrupts can start happening after the atomic store
188
189                with( kernelTLS.preemption_state ){
190                        unsigned short prev = disable_count;
191                        disable_count -= 1;
192                        verify( prev != 0u );                     // If this triggers someone is enabled already enabled interruptsverify( prev != 0u );
193
194                        // Check if we need to prempt the thread because an interrupt was missed
195                        if( prev == 1 ) {
196                                #if GCC_VERSION > 50000
197                                static_assert(__atomic_always_lock_free(sizeof(enabled), &enabled), "Must be lock-free");
198                                #endif
199
200                                // Set enabled flag to true
201                                // should be atomic to avoid preemption in the middle of the operation.
202                                // use memory order RELAXED since there is no inter-thread on this variable requirements
203                                __atomic_store_n(&enabled, true, __ATOMIC_RELAXED);
204
205                                // Signal the compiler that a fence is needed but only for signal handlers
206                                __atomic_signal_fence(__ATOMIC_RELEASE);
207                                if( proc->pending_preemption ) {
208                                        proc->pending_preemption = false;
209                                        force_yield( __POLL_PREEMPTION );
210                                }
211                        }
212                }
213
214                // For debugging purposes : keep track of the last person to enable the interrupts
215                __cfaabi_dbg_debug_do( proc->last_enable = caller; )
216        }
217
218        // Disable interrupts by incrementint the counter
219        // Don't execute any pending __cfactx_switch even if counter reaches 0
220        void enable_interrupts_noPoll() {
221                unsigned short prev = kernelTLS.preemption_state.disable_count;
222                kernelTLS.preemption_state.disable_count -= 1;
223                verifyf( prev != 0u, "Incremented from %u\n", prev );                     // If this triggers someone is enabled already enabled interrupts
224                if( prev == 1 ) {
225                        #if GCC_VERSION > 50000
226                        static_assert(__atomic_always_lock_free(sizeof(kernelTLS.preemption_state.enabled), &kernelTLS.preemption_state.enabled), "Must be lock-free");
227                        #endif
228                        // Set enabled flag to true
229                        // should be atomic to avoid preemption in the middle of the operation.
230                        // use memory order RELAXED since there is no inter-thread on this variable requirements
231                        __atomic_store_n(&kernelTLS.preemption_state.enabled, true, __ATOMIC_RELAXED);
232
233                        // Signal the compiler that a fence is needed but only for signal handlers
234                        __atomic_signal_fence(__ATOMIC_RELEASE);
235                }
236        }
237}
238
239// sigprocmask wrapper : unblock a single signal
240static inline void signal_unblock( int sig ) {
241        sigset_t mask;
242        sigemptyset( &mask );
243        sigaddset( &mask, sig );
244
245        if ( pthread_sigmask( SIG_UNBLOCK, &mask, 0p ) == -1 ) {
246            abort( "internal error, pthread_sigmask" );
247        }
248}
249
250// sigprocmask wrapper : block a single signal
251static inline void signal_block( int sig ) {
252        sigset_t mask;
253        sigemptyset( &mask );
254        sigaddset( &mask, sig );
255
256        if ( pthread_sigmask( SIG_BLOCK, &mask, 0p ) == -1 ) {
257                abort( "internal error, pthread_sigmask" );
258        }
259}
260
261// kill wrapper : signal a processor
262static void preempt( processor * this ) {
263        sigval_t value = { PREEMPT_NORMAL };
264        pthread_sigqueue( this->kernel_thread, SIGUSR1, value );
265}
266
267// reserved for future use
268static void timeout( $thread * this ) {
269        __unpark( this __cfaabi_dbg_ctx2 );
270}
271
272// KERNEL ONLY
273// Check if a __cfactx_switch signal handler shoud defer
274// If true  : preemption is safe
275// If false : preemption is unsafe and marked as pending
276static inline bool preemption_ready() {
277        // Check if preemption is safe
278        bool ready = kernelTLS.preemption_state.enabled && ! kernelTLS.preemption_state.in_progress;
279
280        // Adjust the pending flag accordingly
281        kernelTLS.this_processor->pending_preemption = !ready;
282        return ready;
283}
284
285//=============================================================================================
286// Kernel Signal Startup/Shutdown logic
287//=============================================================================================
288
289// Startup routine to activate preemption
290// Called from kernel_startup
291void kernel_start_preemption() {
292        __cfaabi_dbg_print_safe( "Kernel : Starting preemption\n" );
293
294        // Start with preemption disabled until ready
295        kernelTLS.preemption_state.enabled = false;
296        kernelTLS.preemption_state.disable_count = 1;
297
298        // Initialize the event kernel
299        event_kernel = (event_kernel_t *)&storage_event_kernel;
300        (*event_kernel){};
301
302        // Setup proper signal handlers
303        __cfaabi_sigaction( SIGUSR1, sigHandler_ctxSwitch, SA_SIGINFO | SA_RESTART ); // __cfactx_switch handler
304        __cfaabi_sigaction( SIGALRM, sigHandler_alarm    , SA_SIGINFO | SA_RESTART ); // debug handler
305
306        signal_block( SIGALRM );
307
308        alarm_stack = __create_pthread( &alarm_thread, alarm_loop, 0p );
309}
310
311// Shutdown routine to deactivate preemption
312// Called from kernel_shutdown
313void kernel_stop_preemption() {
314        __cfaabi_dbg_print_safe( "Kernel : Preemption stopping\n" );
315
316        // Block all signals since we are already shutting down
317        sigset_t mask;
318        sigfillset( &mask );
319        sigprocmask( SIG_BLOCK, &mask, 0p );
320
321        // Notify the alarm thread of the shutdown
322        sigval val = { 1 };
323        pthread_sigqueue( alarm_thread, SIGALRM, val );
324
325        // Wait for the preemption thread to finish
326
327        pthread_join( alarm_thread, 0p );
328        free( alarm_stack );
329
330        // Preemption is now fully stopped
331
332        __cfaabi_dbg_print_safe( "Kernel : Preemption stopped\n" );
333}
334
335// Raii ctor/dtor for the preemption_scope
336// Used by thread to control when they want to receive preemption signals
337void ?{}( preemption_scope & this, processor * proc ) {
338        (this.alarm){ proc, (Time){ 0 }, 0`s };
339        this.proc = proc;
340        this.proc->preemption_alarm = &this.alarm;
341
342        update_preemption( this.proc, this.proc->cltr->preemption_rate );
343}
344
345void ^?{}( preemption_scope & this ) {
346        disable_interrupts();
347
348        update_preemption( this.proc, 0`s );
349}
350
351//=============================================================================================
352// Kernel Signal Handlers
353//=============================================================================================
354
355// Context switch signal handler
356// Receives SIGUSR1 signal and causes the current thread to yield
357static void sigHandler_ctxSwitch( __CFA_SIGPARMS__ ) {
358        __cfaabi_dbg_debug_do( last_interrupt = (void *)(cxt->uc_mcontext.CFA_REG_IP); )
359
360        // SKULLDUGGERY: if a thread creates a processor and the immediately deletes it,
361        // the interrupt that is supposed to force the kernel thread to preempt might arrive
362        // before the kernel thread has even started running. When that happens an iterrupt
363        // we a null 'this_processor' will be caught, just ignore it.
364        if(! kernelTLS.this_processor ) return;
365
366        choose(sfp->si_value.sival_int) {
367                case PREEMPT_NORMAL   : ;// Normal case, nothing to do here
368                case PREEMPT_TERMINATE: verify( __atomic_load_n( &kernelTLS.this_processor->do_terminate, __ATOMIC_SEQ_CST ) );
369                default:
370                        abort( "internal error, signal value is %d", sfp->si_value.sival_int );
371        }
372
373        // Check if it is safe to preempt here
374        if( !preemption_ready() ) { return; }
375
376        __cfaabi_dbg_print_buffer_decl( " KERNEL: preempting core %p (%p @ %p).\n", kernelTLS.this_processor, kernelTLS.this_thread, (void *)(cxt->uc_mcontext.CFA_REG_IP) );
377
378        // Sync flag : prevent recursive calls to the signal handler
379        kernelTLS.preemption_state.in_progress = true;
380
381        // Clear sighandler mask before context switching.
382        #if GCC_VERSION > 50000
383        static_assert( sizeof( sigset_t ) == sizeof( cxt->uc_sigmask ), "Expected cxt->uc_sigmask to be of sigset_t" );
384        #endif
385        if ( pthread_sigmask( SIG_SETMASK, (sigset_t *)&(cxt->uc_sigmask), 0p ) == -1 ) {
386                abort( "internal error, sigprocmask" );
387        }
388
389        // TODO: this should go in finish action
390        // Clear the in progress flag
391        kernelTLS.preemption_state.in_progress = false;
392
393        // Preemption can occur here
394
395        force_yield( __ALARM_PREEMPTION ); // Do the actual __cfactx_switch
396}
397
398static void sigHandler_alarm( __CFA_SIGPARMS__ ) {
399        abort("SIGALRM should never reach the signal handler");
400}
401
402// Main of the alarm thread
403// Waits on SIGALRM and send SIGUSR1 to whom ever needs it
404static void * alarm_loop( __attribute__((unused)) void * args ) {
405        // Block sigalrms to control when they arrive
406        sigset_t mask;
407        sigfillset(&mask);
408        if ( pthread_sigmask( SIG_BLOCK, &mask, 0p ) == -1 ) {
409            abort( "internal error, pthread_sigmask" );
410        }
411
412        sigemptyset( &mask );
413        sigaddset( &mask, SIGALRM );
414
415        // Main loop
416        while( true ) {
417                // Wait for a sigalrm
418                siginfo_t info;
419                int sig = sigwaitinfo( &mask, &info );
420
421                if( sig < 0 ) {
422                        //Error!
423                        int err = errno;
424                        switch( err ) {
425                                case EAGAIN :
426                                case EINTR :
427                                        {__cfaabi_dbg_print_buffer_decl( " KERNEL: Spurious wakeup %d.\n", err );}
428                                        continue;
429                                case EINVAL :
430                                        abort( "Timeout was invalid." );
431                                default:
432                                        abort( "Unhandled error %d", err);
433                        }
434                }
435
436                // If another signal arrived something went wrong
437                assertf(sig == SIGALRM, "Kernel Internal Error, sigwait: Unexpected signal %d (%d : %d)\n", sig, info.si_code, info.si_value.sival_int);
438
439                // __cfaabi_dbg_print_safe( "Kernel : Caught alarm from %d with %d\n", info.si_code, info.si_value.sival_int );
440                // Switch on the code (a.k.a. the sender) to
441                switch( info.si_code )
442                {
443                // Timers can apparently be marked as sent for the kernel
444                // In either case, tick preemption
445                case SI_TIMER:
446                case SI_KERNEL:
447                        // __cfaabi_dbg_print_safe( "Kernel : Preemption thread tick\n" );
448                        lock( event_kernel->lock __cfaabi_dbg_ctx2 );
449                        tick_preemption();
450                        unlock( event_kernel->lock );
451                        break;
452                // Signal was not sent by the kernel but by an other thread
453                case SI_QUEUE:
454                        // For now, other thread only signal the alarm thread to shut it down
455                        // If this needs to change use info.si_value and handle the case here
456                        goto EXIT;
457                }
458        }
459
460EXIT:
461        __cfaabi_dbg_print_safe( "Kernel : Preemption thread stopping\n" );
462        return 0p;
463}
464
465//=============================================================================================
466// Kernel Signal Debug
467//=============================================================================================
468
469void __cfaabi_check_preemption() {
470        bool ready = kernelTLS.preemption_state.enabled;
471        if(!ready) { abort("Preemption should be ready"); }
472
473        sigset_t oldset;
474        int ret;
475        ret = pthread_sigmask(0, 0p, &oldset);
476        if(ret != 0) { abort("ERROR sigprocmask returned %d", ret); }
477
478        ret = sigismember(&oldset, SIGUSR1);
479        if(ret <  0) { abort("ERROR sigismember returned %d", ret); }
480        if(ret == 1) { abort("ERROR SIGUSR1 is disabled"); }
481
482        ret = sigismember(&oldset, SIGALRM);
483        if(ret <  0) { abort("ERROR sigismember returned %d", ret); }
484        if(ret == 0) { abort("ERROR SIGALRM is enabled"); }
485
486        ret = sigismember(&oldset, SIGTERM);
487        if(ret <  0) { abort("ERROR sigismember returned %d", ret); }
488        if(ret == 1) { abort("ERROR SIGTERM is disabled"); }
489}
490
491#ifdef __CFA_WITH_VERIFY__
492bool __cfaabi_dbg_in_kernel() {
493        return !kernelTLS.preemption_state.enabled;
494}
495#endif
496
497// Local Variables: //
498// mode: c //
499// tab-width: 4 //
500// End: //
Note: See TracBrowser for help on using the repository browser.