source: src/libcfa/concurrency/preemption.c @ b2b44d8

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since b2b44d8 was b2b44d8, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

some arm cleanup

  • Property mode set to 100644
File size: 12.0 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 : Tue Jan 23 17:59:30 2018
13// Update Count     : 7
14//
15
16#include "preemption.h"
17
18#define ftype `ftype`
19extern "C" {
20#include <errno.h>
21#include <stdio.h>
22#include <string.h>
23#include <unistd.h>
24}
25#undef ftype
26
27#include "bits/signal.h"
28
29//TODO move to defaults
30#define __CFA_DEFAULT_PREEMPTION__ 10000
31
32//TODO move to defaults
33__attribute__((weak)) unsigned int default_preemption() {
34        return __CFA_DEFAULT_PREEMPTION__;
35}
36
37// FwdDeclarations : timeout handlers
38static void preempt( processor   * this );
39static void timeout( thread_desc * this );
40
41// FwdDeclarations : Signal handlers
42void sigHandler_ctxSwitch( __CFA_SIGPARMS__ );
43void sigHandler_segv     ( __CFA_SIGPARMS__ );
44void sigHandler_abort    ( __CFA_SIGPARMS__ );
45
46// FwdDeclarations : alarm thread main
47void * alarm_loop( __attribute__((unused)) void * args );
48
49// Machine specific register name
50#if   defined(__x86_64__)
51#define CFA_REG_IP gregs[REG_RIP]
52#elif defined(__i386__)
53#define CFA_REG_IP gregs[REG_EIP]
54#elif defined(__ARM_ARCH__)
55#define CFA_REG_IP arm_pc
56#endif
57
58KERNEL_STORAGE(event_kernel_t, event_kernel);         // private storage for event kernel
59event_kernel_t * event_kernel;                        // kernel public handle to even kernel
60static pthread_t alarm_thread;                        // pthread handle to alarm thread
61
62void ?{}(event_kernel_t & this) with( this ) {
63        alarms{};
64        lock{};
65}
66
67//=============================================================================================
68// Kernel Preemption logic
69//=============================================================================================
70
71// Get next expired node
72static inline alarm_node_t * get_expired( alarm_list_t * alarms, __cfa_time_t currtime ) {
73        if( !alarms->head ) return NULL;                          // If no alarms return null
74        if( alarms->head->alarm >= currtime ) return NULL;        // If alarms head not expired return null
75        return pop(alarms);                                       // Otherwise just pop head
76}
77
78// Tick one frame of the Discrete Event Simulation for alarms
79void tick_preemption() {
80        alarm_node_t * node = NULL;                     // Used in the while loop but cannot be declared in the while condition
81        alarm_list_t * alarms = &event_kernel->alarms;  // Local copy for ease of reading
82        __cfa_time_t currtime = __kernel_get_time();    // Check current time once so we everything "happens at once"
83
84        //Loop throught every thing expired
85        while( node = get_expired( alarms, currtime ) ) {
86
87                // Check if this is a kernel
88                if( node->kernel_alarm ) {
89                        preempt( node->proc );
90                }
91                else {
92                        timeout( node->thrd );
93                }
94
95                // Check if this is a periodic alarm
96                __cfa_time_t period = node->period;
97                if( period > 0 ) {
98                        node->alarm = currtime + period;    // Alarm is periodic, add currtime to it (used cached current time)
99                        insert( alarms, node );             // Reinsert the node for the next time it triggers
100                }
101                else {
102                        node->set = false;                  // Node is one-shot, just mark it as not pending
103                }
104        }
105
106        // If there are still alarms pending, reset the timer
107        if( alarms->head ) { __kernel_set_timer( alarms->head->alarm - currtime ); }
108}
109
110// Update the preemption of a processor and notify interested parties
111void update_preemption( processor * this, __cfa_time_t duration ) {
112        alarm_node_t * alarm = this->preemption_alarm;
113
114        // Alarms need to be enabled
115        if ( duration > 0 && !alarm->set ) {
116                alarm->alarm = __kernel_get_time() + duration;
117                alarm->period = duration;
118                register_self( alarm );
119        }
120        // Zero duraction but alarm is set
121        else if ( duration == 0 && alarm->set ) {
122                unregister_self( alarm );
123                alarm->alarm = 0;
124                alarm->period = 0;
125        }
126        // If alarm is different from previous, change it
127        else if ( duration > 0 && alarm->period != duration ) {
128                unregister_self( alarm );
129                alarm->alarm = __kernel_get_time() + duration;
130                alarm->period = duration;
131                register_self( alarm );
132        }
133}
134
135//=============================================================================================
136// Kernel Signal Tools
137//=============================================================================================
138
139__cfaabi_dbg_debug_do( static thread_local void * last_interrupt = 0; )
140
141extern "C" {
142        // Disable interrupts by incrementing the counter
143        void disable_interrupts() {
144                __attribute__((unused)) unsigned short new_val = __atomic_add_fetch_2( &disable_preempt_count, 1, __ATOMIC_SEQ_CST );
145                verify( new_val < 65_000u );              // If this triggers someone is disabling interrupts without enabling them
146        }
147
148        // Enable interrupts by decrementing the counter
149        // If counter reaches 0, execute any pending CtxSwitch
150        void enable_interrupts( __cfaabi_dbg_ctx_param ) {
151                processor   * proc = this_processor;      // Cache the processor now since interrupts can start happening after the atomic add
152                thread_desc * thrd = this_thread;         // Cache the thread now since interrupts can start happening after the atomic add
153
154                unsigned short prev = __atomic_fetch_add_2( &disable_preempt_count, -1, __ATOMIC_SEQ_CST );
155                verify( prev != 0u );                     // If this triggers someone is enabled already enabled interruptsverify( prev != 0u );
156
157                // Check if we need to prempt the thread because an interrupt was missed
158                if( prev == 1 && proc->pending_preemption ) {
159                        proc->pending_preemption = false;
160                        BlockInternal( thrd );
161                }
162
163                // For debugging purposes : keep track of the last person to enable the interrupts
164                __cfaabi_dbg_debug_do( proc->last_enable = caller; )
165        }
166
167        // Disable interrupts by incrementint the counter
168        // Don't execute any pending CtxSwitch even if counter reaches 0
169        void enable_interrupts_noPoll() {
170                __attribute__((unused)) unsigned short prev = __atomic_fetch_add_2( &disable_preempt_count, -1, __ATOMIC_SEQ_CST );
171                verifyf( prev != 0u, "Incremented from %u\n", prev );                     // If this triggers someone is enabled already enabled interrupts
172        }
173}
174
175// sigprocmask wrapper : unblock a single signal
176static inline void signal_unblock( int sig ) {
177        sigset_t mask;
178        sigemptyset( &mask );
179        sigaddset( &mask, sig );
180
181        if ( pthread_sigmask( SIG_UNBLOCK, &mask, NULL ) == -1 ) {
182            abortf( "internal error, pthread_sigmask" );
183        }
184}
185
186// sigprocmask wrapper : block a single signal
187static inline void signal_block( int sig ) {
188        sigset_t mask;
189        sigemptyset( &mask );
190        sigaddset( &mask, sig );
191
192        if ( pthread_sigmask( SIG_BLOCK, &mask, NULL ) == -1 ) {
193            abortf( "internal error, pthread_sigmask" );
194        }
195}
196
197// kill wrapper : signal a processor
198static void preempt( processor * this ) {
199        pthread_kill( this->kernel_thread, SIGUSR1 );
200}
201
202// reserved for future use
203static void timeout( thread_desc * this ) {
204        //TODO : implement waking threads
205}
206
207
208// Check if a CtxSwitch signal handler shoud defer
209// If true  : preemption is safe
210// If false : preemption is unsafe and marked as pending
211static inline bool preemption_ready() {
212        bool ready = disable_preempt_count == 0 && !preemption_in_progress; // Check if preemption is safe
213        this_processor->pending_preemption = !ready;                        // Adjust the pending flag accordingly
214        return ready;
215}
216
217//=============================================================================================
218// Kernel Signal Startup/Shutdown logic
219//=============================================================================================
220
221// Startup routine to activate preemption
222// Called from kernel_startup
223void kernel_start_preemption() {
224        __cfaabi_dbg_print_safe("Kernel : Starting preemption\n");
225
226        // Start with preemption disabled until ready
227        disable_preempt_count = 1;
228
229        // Initialize the event kernel
230        event_kernel = (event_kernel_t *)&storage_event_kernel;
231        (*event_kernel){};
232
233        // Setup proper signal handlers
234        __kernel_sigaction( SIGUSR1, sigHandler_ctxSwitch, SA_SIGINFO | SA_RESTART );         // CtxSwitch handler
235
236        signal_block( SIGALRM );
237
238        pthread_create( &alarm_thread, NULL, alarm_loop, NULL );
239}
240
241// Shutdown routine to deactivate preemption
242// Called from kernel_shutdown
243void kernel_stop_preemption() {
244        __cfaabi_dbg_print_safe("Kernel : Preemption stopping\n");
245
246        // Block all signals since we are already shutting down
247        sigset_t mask;
248        sigfillset( &mask );
249        sigprocmask( SIG_BLOCK, &mask, NULL );
250
251        // Notify the alarm thread of the shutdown
252        sigval val = { 1 };
253        pthread_sigqueue( alarm_thread, SIGALRM, val );
254
255        // Wait for the preemption thread to finish
256        pthread_join( alarm_thread, NULL );
257
258        // Preemption is now fully stopped
259
260        __cfaabi_dbg_print_safe("Kernel : Preemption stopped\n");
261}
262
263// Raii ctor/dtor for the preemption_scope
264// Used by thread to control when they want to receive preemption signals
265void ?{}( preemption_scope & this, processor * proc ) {
266        (this.alarm){ proc, zero_time, zero_time };
267        this.proc = proc;
268        this.proc->preemption_alarm = &this.alarm;
269
270        update_preemption( this.proc, from_us(this.proc->cltr->preemption) );
271}
272
273void ^?{}( preemption_scope & this ) {
274        disable_interrupts();
275
276        update_preemption( this.proc, zero_time );
277}
278
279//=============================================================================================
280// Kernel Signal Handlers
281//=============================================================================================
282
283// Context switch signal handler
284// Receives SIGUSR1 signal and causes the current thread to yield
285void sigHandler_ctxSwitch( __CFA_SIGPARMS__ ) {
286        __cfaabi_dbg_debug_do( last_interrupt = (void *)(cxt->uc_mcontext.CFA_REG_IP); )
287
288        // Check if it is safe to preempt here
289        if( !preemption_ready() ) { return; }
290
291        __cfaabi_dbg_print_buffer_decl(" KERNEL: preempting core %p (%p).\n", this_processor, this_thread);
292
293        preemption_in_progress = true;                      // Sync flag : prevent recursive calls to the signal handler
294        signal_unblock( SIGUSR1 );                          // We are about to CtxSwitch out of the signal handler, let other handlers in
295        preemption_in_progress = false;                     // Clear the in progress flag
296
297        // Preemption can occur here
298
299        BlockInternal( (thread_desc*)this_thread );         // Do the actual CtxSwitch
300}
301
302// Main of the alarm thread
303// Waits on SIGALRM and send SIGUSR1 to whom ever needs it
304void * alarm_loop( __attribute__((unused)) void * args ) {
305        // Block sigalrms to control when they arrive
306        sigset_t mask;
307        sigemptyset( &mask );
308        sigaddset( &mask, SIGALRM );
309
310        if ( pthread_sigmask( SIG_BLOCK, &mask, NULL ) == -1 ) {
311            abortf( "internal error, pthread_sigmask" );
312        }
313
314        // Main loop
315        while( true ) {
316                // Wait for a sigalrm
317                siginfo_t info;
318                int sig = sigwaitinfo( &mask, &info );
319
320                if( sig < 0 ) {
321                        //Error!
322                        int err = errno;
323                        switch( err ) {
324                                case EAGAIN :
325                                case EINTR :
326                                        continue;
327                        case EINVAL :
328                                        abortf("Timeout was invalid.");
329                                default:
330                                        abortf("Unhandled error %d", err);
331                        }
332                }
333
334                // If another signal arrived something went wrong
335                assertf(sig == SIGALRM, "Kernel Internal Error, sigwait: Unexpected signal %d (%d : %d)\n", sig, info.si_code, info.si_value.sival_int);
336
337                // __cfaabi_dbg_print_safe("Kernel : Caught alarm from %d with %d\n", info.si_code, info.si_value.sival_int );
338                // Switch on the code (a.k.a. the sender) to
339                switch( info.si_code )
340                {
341                // Timers can apparently be marked as sent for the kernel
342                // In either case, tick preemption
343                case SI_TIMER:
344                case SI_KERNEL:
345                        // __cfaabi_dbg_print_safe("Kernel : Preemption thread tick\n");
346                        lock( event_kernel->lock __cfaabi_dbg_ctx2 );
347                        tick_preemption();
348                        unlock( event_kernel->lock );
349                        break;
350                // Signal was not sent by the kernel but by an other thread
351                case SI_QUEUE:
352                        // For now, other thread only signal the alarm thread to shut it down
353                        // If this needs to change use info.si_value and handle the case here
354                        goto EXIT;
355                }
356        }
357
358EXIT:
359        __cfaabi_dbg_print_safe("Kernel : Preemption thread stopping\n");
360        return NULL;
361}
362
363// Local Variables: //
364// mode: c //
365// tab-width: 4 //
366// End: //
Note: See TracBrowser for help on using the repository browser.