source: libcfa/src/concurrency/kernel_private.hfa@ 986cb99

//
// Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
//
// The contents of this file are covered under the licence agreement in the
// file "LICENCE" distributed with Cforall.
//
// kernel_private.hfa --
//
// Author           : Thierry Delisle
// Created On       : Mon Feb 13 12:27:26 2017
// Last Modified By : Peter A. Buhr
// Last Modified On : Wed Aug 12 08:21:33 2020
// Update Count     : 9
//

#pragma once

#include "kernel.hfa"
#include "thread.hfa"

#include "alarm.hfa"
#include "stats.hfa"

//-----------------------------------------------------------------------------
// Scheduler

struct __attribute__((aligned(128))) __scheduler_lock_id_t;

extern "C" {
        void disable_interrupts() OPTIONAL_THREAD;
        void enable_interrupts_noPoll();
        void enable_interrupts( __cfaabi_dbg_ctx_param );
}

void __schedule_thread( $thread * )
#if defined(NDEBUG) || (!defined(__CFA_DEBUG__) && !defined(__CFA_VERIFY__))
        __attribute__((nonnull (1)))
#endif
;

extern bool __preemption_enabled();

//release/wake-up the following resources
void __thread_finish( $thread * thrd );

//-----------------------------------------------------------------------------
// Processor
void main(processorCtx_t *);

void * __create_pthread( pthread_t *, void * (*)(void *), void * );
void __destroy_pthread( pthread_t pthread, void * stack, void ** retval );



extern cluster * mainCluster;

//-----------------------------------------------------------------------------
// Threads
extern "C" {
      void __cfactx_invoke_thread(void (*main)(void *), void * this);
}

__cfaabi_dbg_debug_do(
        extern void __cfaabi_dbg_thread_register  ( $thread * thrd );
        extern void __cfaabi_dbg_thread_unregister( $thread * thrd );
)

#define TICKET_BLOCKED (-1) // thread is blocked
#define TICKET_RUNNING ( 0) // thread is running
#define TICKET_UNBLOCK ( 1) // thread should ignore next block

//-----------------------------------------------------------------------------
// Utils
void doregister( struct cluster * cltr, struct $thread & thrd );
void unregister( struct cluster * cltr, struct $thread & thrd );

//-----------------------------------------------------------------------------
// I/O
$io_arbiter * create(void);
void destroy($io_arbiter *);

//=======================================================================
// Cluster lock API
//=======================================================================
// Lock-Free registering/unregistering of threads
// Register a processor to a given cluster and get its unique id in return
void register_proc_id( struct __processor_id_t * );

// Unregister a processor from a given cluster using its id, getting back the original pointer
void unregister_proc_id( struct __processor_id_t * proc );

//=======================================================================
// Reader-writer lock implementation
// Concurrent with doregister/unregister,
//    i.e., threads can be added at any point during or between the entry/exit

//-----------------------------------------------------------------------
// simple spinlock underlying the RWLock
// Blocking acquire
static inline void __atomic_acquire(volatile bool * ll) {
        while( __builtin_expect(__atomic_exchange_n(ll, (bool)true, __ATOMIC_SEQ_CST), false) ) {
                while(__atomic_load_n(ll, (int)__ATOMIC_RELAXED))
                        Pause();
        }
        /* paranoid */ verify(*ll);
}

// Non-Blocking acquire
static inline bool __atomic_try_acquire(volatile bool * ll) {
        return !__atomic_exchange_n(ll, (bool)true, __ATOMIC_SEQ_CST);
}

// Release
static inline void __atomic_unlock(volatile bool * ll) {
        /* paranoid */ verify(*ll);
        __atomic_store_n(ll, (bool)false, __ATOMIC_RELEASE);
}

// Cells use by the reader writer lock
// while not generic it only relies on a opaque pointer
struct __attribute__((aligned(128))) __scheduler_lock_id_t {
        // Spin lock used as the underlying lock
        volatile bool lock;

        // Handle pointing to the proc owning this cell
        // Used for allocating cells and debugging
        __processor_id_t * volatile handle;

        #ifdef __CFA_WITH_VERIFY__
                // Debug, check if this is owned for reading
                bool owned;
        #endif
};

static_assert( sizeof(struct __scheduler_lock_id_t) <= __alignof(struct __scheduler_lock_id_t));

//-----------------------------------------------------------------------
// Reader-Writer lock protecting the ready-queues
// while this lock is mostly generic some aspects
// have been hard-coded to for the ready-queue for
// simplicity and performance
struct __scheduler_RWLock_t {
        // total cachelines allocated
        unsigned int max;

        // cachelines currently in use
        volatile unsigned int alloc;

        // cachelines ready to itereate over
        // (!= to alloc when thread is in second half of doregister)
        volatile unsigned int ready;

        // writer lock
        volatile bool lock;

        // data pointer
        __scheduler_lock_id_t * data;
};

void  ?{}(__scheduler_RWLock_t & this);
void ^?{}(__scheduler_RWLock_t & this);

extern __scheduler_RWLock_t * __scheduler_lock;

//-----------------------------------------------------------------------
// Reader side : acquire when using the ready queue to schedule but not
//  creating/destroying queues
static inline void ready_schedule_lock(void) with(*__scheduler_lock) {
        /* paranoid */ verify( ! __preemption_enabled() );
        /* paranoid */ verify( kernelTLS().this_proc_id );

        unsigned iproc = kernelTLS().this_proc_id->id;
        /*paranoid*/ verify(data[iproc].handle == kernelTLS().this_proc_id);
        /*paranoid*/ verify(iproc < ready);

        // Step 1 : make sure no writer are in the middle of the critical section
        while(__atomic_load_n(&lock, (int)__ATOMIC_RELAXED))
                Pause();

        // Fence needed because we don't want to start trying to acquire the lock
        // before we read a false.
        // Not needed on x86
        // std::atomic_thread_fence(std::memory_order_seq_cst);

        // Step 2 : acquire our local lock
        __atomic_acquire( &data[iproc].lock );
        /*paranoid*/ verify(data[iproc].lock);

        #ifdef __CFA_WITH_VERIFY__
                // Debug, check if this is owned for reading
                data[iproc].owned = true;
        #endif
}

static inline void ready_schedule_unlock(void) with(*__scheduler_lock) {
        /* paranoid */ verify( ! __preemption_enabled() );
        /* paranoid */ verify( kernelTLS().this_proc_id );

        unsigned iproc = kernelTLS().this_proc_id->id;
        /*paranoid*/ verify(data[iproc].handle == kernelTLS().this_proc_id);
        /*paranoid*/ verify(iproc < ready);
        /*paranoid*/ verify(data[iproc].lock);
        /*paranoid*/ verify(data[iproc].owned);
        #ifdef __CFA_WITH_VERIFY__
                // Debug, check if this is owned for reading
                data[iproc].owned = false;
        #endif
        __atomic_unlock(&data[iproc].lock);
}

#ifdef __CFA_WITH_VERIFY__
        static inline bool ready_schedule_islocked(void) {
                /* paranoid */ verify( ! __preemption_enabled() );
                /*paranoid*/ verify( kernelTLS().this_proc_id );
                __processor_id_t * proc = kernelTLS().this_proc_id;
                return __scheduler_lock->data[proc->id].owned;
        }

        static inline bool ready_mutate_islocked() {
                return __scheduler_lock->lock;
        }
#endif

//-----------------------------------------------------------------------
// Writer side : acquire when changing the ready queue, e.g. adding more
//  queues or removing them.
uint_fast32_t ready_mutate_lock( void );

void ready_mutate_unlock( uint_fast32_t /* value returned by lock */ );

//-----------------------------------------------------------------------
// Lock-Free registering/unregistering of threads
// Register a processor to a given cluster and get its unique id in return
// For convenience, also acquires the lock
static inline uint_fast32_t ready_mutate_register( struct __processor_id_t * proc ) {
        register_proc_id( proc );
        return ready_mutate_lock();
}

// Unregister a processor from a given cluster using its id, getting back the original pointer
// assumes the lock is acquired
static inline void ready_mutate_unregister( struct __processor_id_t * proc, uint_fast32_t last_s ) {
        ready_mutate_unlock( last_s );
        unregister_proc_id( proc );
}

//-----------------------------------------------------------------------
// Cluster idle lock/unlock
static inline void lock(__cluster_proc_list & this) {
        /* paranoid */ verify( ! __preemption_enabled() );

        // Start by locking the global RWlock so that we know no-one is
        // adding/removing processors while we mess with the idle lock
        ready_schedule_lock();

        // Simple counting lock, acquired, acquired by incrementing the counter
        // to an odd number
        for() {
                uint64_t l = this.lock;
                if(
                        (0 == (l % 2))
                        && __atomic_compare_exchange_n(&this.lock, &l, l + 1, false, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST)
                ) return;
                Pause();
        }

        /* paranoid */ verify( ! __preemption_enabled() );
}

static inline void unlock(__cluster_proc_list & this) {
        /* paranoid */ verify( ! __preemption_enabled() );

        /* paranoid */ verify( 1 == (this.lock % 2) );
        // Simple couting lock, release by incrementing to an even number
        __atomic_fetch_add( &this.lock, 1, __ATOMIC_SEQ_CST );

        // Release the global lock, which we acquired when locking
        ready_schedule_unlock();

        /* paranoid */ verify( ! __preemption_enabled() );
}

//=======================================================================
// Ready-Queue API
//-----------------------------------------------------------------------
// push thread onto a ready queue for a cluster
// returns true if the list was previously empty, false otherwise
__attribute__((hot)) void push(struct cluster * cltr, struct $thread * thrd);

//-----------------------------------------------------------------------
// pop thread from the ready queue of a cluster
// returns 0p if empty
// May return 0p spuriously
__attribute__((hot)) struct $thread * pop_fast(struct cluster * cltr);

//-----------------------------------------------------------------------
// pop thread from the ready queue of a cluster
// returns 0p if empty
// guaranteed to find any threads added before this call
__attribute__((hot)) struct $thread * pop_slow(struct cluster * cltr);

//-----------------------------------------------------------------------
// Increase the width of the ready queue (number of lanes) by 4
void ready_queue_grow  (struct cluster * cltr);

//-----------------------------------------------------------------------
// Decrease the width of the ready queue (number of lanes) by 4
void ready_queue_shrink(struct cluster * cltr);


// Local Variables: //
// mode: c //
// tab-width: 4 //
// End: //