[75f3522] | 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 | // |
---|
[73abe95] | 7 | // kernel_private.hfa -- |
---|
[75f3522] | 8 | // |
---|
| 9 | // Author : Thierry Delisle |
---|
| 10 | // Created On : Mon Feb 13 12:27:26 2017 |
---|
[6b0b624] | 11 | // Last Modified By : Peter A. Buhr |
---|
[1805b1b] | 12 | // Last Modified On : Sat Nov 30 19:25:02 2019 |
---|
| 13 | // Update Count : 8 |
---|
[75f3522] | 14 | // |
---|
| 15 | |
---|
[6b0b624] | 16 | #pragma once |
---|
[75f3522] | 17 | |
---|
[58b6d1b] | 18 | #include "kernel.hfa" |
---|
| 19 | #include "thread.hfa" |
---|
[75f3522] | 20 | |
---|
[73abe95] | 21 | #include "alarm.hfa" |
---|
[8834751] | 22 | #include "stats.hfa" |
---|
[fa21ac9] | 23 | |
---|
[75f3522] | 24 | //----------------------------------------------------------------------------- |
---|
| 25 | // Scheduler |
---|
[1c273d0] | 26 | |
---|
[37ba662] | 27 | struct __attribute__((aligned(128))) __scheduler_lock_id_t; |
---|
[9b1dcc2] | 28 | |
---|
[1c273d0] | 29 | extern "C" { |
---|
[2026bb6] | 30 | void disable_interrupts() OPTIONAL_THREAD; |
---|
[969b3fe] | 31 | void enable_interrupts_noPoll(); |
---|
[36982fc] | 32 | void enable_interrupts( __cfaabi_dbg_ctx_param ); |
---|
[1c273d0] | 33 | } |
---|
| 34 | |
---|
[efc171d1] | 35 | void __schedule_thread( struct __processor_id_t *, $thread * ) |
---|
| 36 | #if defined(NDEBUG) || (!defined(__CFA_DEBUG__) && !defined(__CFA_VERIFY__)) |
---|
| 37 | __attribute__((nonnull (2))) |
---|
| 38 | #endif |
---|
| 39 | ; |
---|
[75f3522] | 40 | |
---|
[e60e0dc] | 41 | //Block current thread and release/wake-up the following resources |
---|
[b0c7419] | 42 | void __leave_thread() __attribute__((noreturn)); |
---|
[db6f06a] | 43 | |
---|
[75f3522] | 44 | //----------------------------------------------------------------------------- |
---|
| 45 | // Processor |
---|
| 46 | void main(processorCtx_t *); |
---|
[85b1deb] | 47 | |
---|
[8c50aed] | 48 | void * __create_pthread( pthread_t *, void * (*)(void *), void * ); |
---|
[1805b1b] | 49 | |
---|
[85b1deb] | 50 | |
---|
[75f3522] | 51 | |
---|
[6502a2b] | 52 | extern cluster * mainCluster; |
---|
| 53 | |
---|
[75f3522] | 54 | //----------------------------------------------------------------------------- |
---|
| 55 | // Threads |
---|
| 56 | extern "C" { |
---|
[c7a900a] | 57 | void __cfactx_invoke_thread(void (*main)(void *), void * this); |
---|
[75f3522] | 58 | } |
---|
| 59 | |
---|
[f7d6bb0] | 60 | __cfaabi_dbg_debug_do( |
---|
[ac2b598] | 61 | extern void __cfaabi_dbg_thread_register ( $thread * thrd ); |
---|
| 62 | extern void __cfaabi_dbg_thread_unregister( $thread * thrd ); |
---|
[f7d6bb0] | 63 | ) |
---|
| 64 | |
---|
[2d8f7b0] | 65 | // KERNEL ONLY unpark with out disabling interrupts |
---|
[9b1dcc2] | 66 | void __unpark( struct __processor_id_t *, $thread * thrd __cfaabi_dbg_ctx_param2 ); |
---|
[2d8f7b0] | 67 | |
---|
[f00b26d4] | 68 | static inline bool __post(single_sem & this, struct __processor_id_t * id) { |
---|
| 69 | for() { |
---|
| 70 | struct $thread * expected = this.ptr; |
---|
| 71 | if(expected == 1p) return false; |
---|
| 72 | if(expected == 0p) { |
---|
| 73 | if(__atomic_compare_exchange_n(&this.ptr, &expected, 1p, false, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST)) { |
---|
| 74 | return false; |
---|
| 75 | } |
---|
| 76 | } |
---|
| 77 | else { |
---|
| 78 | if(__atomic_compare_exchange_n(&this.ptr, &expected, 0p, false, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST)) { |
---|
| 79 | __unpark( id, expected __cfaabi_dbg_ctx2 ); |
---|
| 80 | return true; |
---|
| 81 | } |
---|
| 82 | } |
---|
| 83 | } |
---|
| 84 | } |
---|
[92976d9] | 85 | |
---|
[969b3fe] | 86 | //----------------------------------------------------------------------------- |
---|
| 87 | // Utils |
---|
[ac2b598] | 88 | void doregister( struct cluster * cltr, struct $thread & thrd ); |
---|
| 89 | void unregister( struct cluster * cltr, struct $thread & thrd ); |
---|
[de94a60] | 90 | |
---|
[f00b26d4] | 91 | //----------------------------------------------------------------------------- |
---|
| 92 | // I/O |
---|
| 93 | void ^?{}(io_context & this, bool ); |
---|
| 94 | |
---|
[7768b8d] | 95 | //======================================================================= |
---|
| 96 | // Cluster lock API |
---|
| 97 | //======================================================================= |
---|
[b388ee81] | 98 | // Cells use by the reader writer lock |
---|
| 99 | // while not generic it only relies on a opaque pointer |
---|
[37ba662] | 100 | struct __attribute__((aligned(128))) __scheduler_lock_id_t { |
---|
[64a7146] | 101 | // Spin lock used as the underlying lock |
---|
[7768b8d] | 102 | volatile bool lock; |
---|
[64a7146] | 103 | |
---|
| 104 | // Handle pointing to the proc owning this cell |
---|
| 105 | // Used for allocating cells and debugging |
---|
| 106 | __processor_id_t * volatile handle; |
---|
| 107 | |
---|
| 108 | #ifdef __CFA_WITH_VERIFY__ |
---|
| 109 | // Debug, check if this is owned for reading |
---|
| 110 | bool owned; |
---|
| 111 | #endif |
---|
[7768b8d] | 112 | }; |
---|
| 113 | |
---|
[64a7146] | 114 | static_assert( sizeof(struct __scheduler_lock_id_t) <= __alignof(struct __scheduler_lock_id_t)); |
---|
| 115 | |
---|
[7768b8d] | 116 | // Lock-Free registering/unregistering of threads |
---|
| 117 | // Register a processor to a given cluster and get its unique id in return |
---|
[9b1dcc2] | 118 | unsigned doregister( struct __processor_id_t * proc ); |
---|
[7768b8d] | 119 | |
---|
| 120 | // Unregister a processor from a given cluster using its id, getting back the original pointer |
---|
[9b1dcc2] | 121 | void unregister( struct __processor_id_t * proc ); |
---|
[7768b8d] | 122 | |
---|
| 123 | //======================================================================= |
---|
| 124 | // Reader-writer lock implementation |
---|
| 125 | // Concurrent with doregister/unregister, |
---|
| 126 | // i.e., threads can be added at any point during or between the entry/exit |
---|
[dca5802] | 127 | |
---|
| 128 | //----------------------------------------------------------------------- |
---|
| 129 | // simple spinlock underlying the RWLock |
---|
| 130 | // Blocking acquire |
---|
[7768b8d] | 131 | static inline void __atomic_acquire(volatile bool * ll) { |
---|
| 132 | while( __builtin_expect(__atomic_exchange_n(ll, (bool)true, __ATOMIC_SEQ_CST), false) ) { |
---|
| 133 | while(__atomic_load_n(ll, (int)__ATOMIC_RELAXED)) |
---|
| 134 | asm volatile("pause"); |
---|
| 135 | } |
---|
| 136 | /* paranoid */ verify(*ll); |
---|
| 137 | } |
---|
| 138 | |
---|
[dca5802] | 139 | // Non-Blocking acquire |
---|
[7768b8d] | 140 | static inline bool __atomic_try_acquire(volatile bool * ll) { |
---|
[b798713] | 141 | return !__atomic_exchange_n(ll, (bool)true, __ATOMIC_SEQ_CST); |
---|
[7768b8d] | 142 | } |
---|
| 143 | |
---|
[dca5802] | 144 | // Release |
---|
[7768b8d] | 145 | static inline void __atomic_unlock(volatile bool * ll) { |
---|
| 146 | /* paranoid */ verify(*ll); |
---|
| 147 | __atomic_store_n(ll, (bool)false, __ATOMIC_RELEASE); |
---|
| 148 | } |
---|
| 149 | |
---|
[b388ee81] | 150 | //----------------------------------------------------------------------- |
---|
| 151 | // Reader-Writer lock protecting the ready-queues |
---|
| 152 | // while this lock is mostly generic some aspects |
---|
| 153 | // have been hard-coded to for the ready-queue for |
---|
| 154 | // simplicity and performance |
---|
| 155 | struct __scheduler_RWLock_t { |
---|
| 156 | // total cachelines allocated |
---|
| 157 | unsigned int max; |
---|
| 158 | |
---|
| 159 | // cachelines currently in use |
---|
| 160 | volatile unsigned int alloc; |
---|
| 161 | |
---|
| 162 | // cachelines ready to itereate over |
---|
| 163 | // (!= to alloc when thread is in second half of doregister) |
---|
| 164 | volatile unsigned int ready; |
---|
| 165 | |
---|
| 166 | // writer lock |
---|
| 167 | volatile bool lock; |
---|
| 168 | |
---|
| 169 | // data pointer |
---|
[9b1dcc2] | 170 | __scheduler_lock_id_t * data; |
---|
[b388ee81] | 171 | }; |
---|
| 172 | |
---|
| 173 | void ?{}(__scheduler_RWLock_t & this); |
---|
| 174 | void ^?{}(__scheduler_RWLock_t & this); |
---|
| 175 | |
---|
| 176 | extern __scheduler_RWLock_t * __scheduler_lock; |
---|
| 177 | |
---|
[7768b8d] | 178 | //----------------------------------------------------------------------- |
---|
| 179 | // Reader side : acquire when using the ready queue to schedule but not |
---|
| 180 | // creating/destroying queues |
---|
[9b1dcc2] | 181 | static inline void ready_schedule_lock( struct __processor_id_t * proc) with(*__scheduler_lock) { |
---|
[7768b8d] | 182 | unsigned iproc = proc->id; |
---|
| 183 | /*paranoid*/ verify(data[iproc].handle == proc); |
---|
| 184 | /*paranoid*/ verify(iproc < ready); |
---|
| 185 | |
---|
| 186 | // Step 1 : make sure no writer are in the middle of the critical section |
---|
| 187 | while(__atomic_load_n(&lock, (int)__ATOMIC_RELAXED)) |
---|
| 188 | asm volatile("pause"); |
---|
| 189 | |
---|
| 190 | // Fence needed because we don't want to start trying to acquire the lock |
---|
| 191 | // before we read a false. |
---|
| 192 | // Not needed on x86 |
---|
| 193 | // std::atomic_thread_fence(std::memory_order_seq_cst); |
---|
| 194 | |
---|
| 195 | // Step 2 : acquire our local lock |
---|
| 196 | __atomic_acquire( &data[iproc].lock ); |
---|
| 197 | /*paranoid*/ verify(data[iproc].lock); |
---|
[64a7146] | 198 | |
---|
| 199 | #ifdef __CFA_WITH_VERIFY__ |
---|
| 200 | // Debug, check if this is owned for reading |
---|
| 201 | data[iproc].owned = true; |
---|
| 202 | #endif |
---|
[7768b8d] | 203 | } |
---|
| 204 | |
---|
[9b1dcc2] | 205 | static inline void ready_schedule_unlock( struct __processor_id_t * proc) with(*__scheduler_lock) { |
---|
[7768b8d] | 206 | unsigned iproc = proc->id; |
---|
| 207 | /*paranoid*/ verify(data[iproc].handle == proc); |
---|
| 208 | /*paranoid*/ verify(iproc < ready); |
---|
| 209 | /*paranoid*/ verify(data[iproc].lock); |
---|
[64a7146] | 210 | /*paranoid*/ verify(data[iproc].owned); |
---|
| 211 | #ifdef __CFA_WITH_VERIFY__ |
---|
| 212 | // Debug, check if this is owned for reading |
---|
| 213 | data[iproc].owned = false; |
---|
| 214 | #endif |
---|
[dca5802] | 215 | __atomic_unlock(&data[iproc].lock); |
---|
[7768b8d] | 216 | } |
---|
| 217 | |
---|
[64a7146] | 218 | #ifdef __CFA_WITH_VERIFY__ |
---|
| 219 | static inline bool ready_schedule_islocked( struct __processor_id_t * proc) { |
---|
| 220 | return __scheduler_lock->data[proc->id].owned; |
---|
| 221 | } |
---|
| 222 | |
---|
| 223 | static inline bool ready_mutate_islocked() { |
---|
| 224 | return __scheduler_lock->lock; |
---|
| 225 | } |
---|
| 226 | #endif |
---|
| 227 | |
---|
[7768b8d] | 228 | //----------------------------------------------------------------------- |
---|
| 229 | // Writer side : acquire when changing the ready queue, e.g. adding more |
---|
| 230 | // queues or removing them. |
---|
[b388ee81] | 231 | uint_fast32_t ready_mutate_lock( void ); |
---|
[7768b8d] | 232 | |
---|
[b388ee81] | 233 | void ready_mutate_unlock( uint_fast32_t /* value returned by lock */ ); |
---|
[7768b8d] | 234 | |
---|
[b798713] | 235 | //======================================================================= |
---|
| 236 | // Ready-Queue API |
---|
[64a7146] | 237 | //----------------------------------------------------------------------- |
---|
| 238 | // pop thread from the ready queue of a cluster |
---|
| 239 | // returns 0p if empty |
---|
| 240 | __attribute__((hot)) bool query(struct cluster * cltr); |
---|
| 241 | |
---|
[dca5802] | 242 | //----------------------------------------------------------------------- |
---|
| 243 | // push thread onto a ready queue for a cluster |
---|
| 244 | // returns true if the list was previously empty, false otherwise |
---|
[504a7dc] | 245 | __attribute__((hot)) bool push(struct cluster * cltr, struct $thread * thrd); |
---|
[dca5802] | 246 | |
---|
| 247 | //----------------------------------------------------------------------- |
---|
| 248 | // pop thread from the ready queue of a cluster |
---|
| 249 | // returns 0p if empty |
---|
[504a7dc] | 250 | __attribute__((hot)) struct $thread * pop(struct cluster * cltr); |
---|
[dca5802] | 251 | |
---|
[13c5e19] | 252 | //----------------------------------------------------------------------- |
---|
| 253 | // remove thread from the ready queue of a cluster |
---|
| 254 | // returns bool if it wasn't found |
---|
| 255 | bool remove_head(struct cluster * cltr, struct $thread * thrd); |
---|
| 256 | |
---|
[dca5802] | 257 | //----------------------------------------------------------------------- |
---|
| 258 | // Increase the width of the ready queue (number of lanes) by 4 |
---|
[320ec6fc] | 259 | void ready_queue_grow (struct cluster * cltr, int target); |
---|
[dca5802] | 260 | |
---|
| 261 | //----------------------------------------------------------------------- |
---|
| 262 | // Decrease the width of the ready queue (number of lanes) by 4 |
---|
[320ec6fc] | 263 | void ready_queue_shrink(struct cluster * cltr, int target); |
---|
[b798713] | 264 | |
---|
[de94a60] | 265 | |
---|
[75f3522] | 266 | // Local Variables: // |
---|
| 267 | // mode: c // |
---|
| 268 | // tab-width: 4 // |
---|
[4aa2fb2] | 269 | // End: // |
---|