annotate MasterLoop.c @ 169:d1dd9e6ee72c

VMS preprocessor definitions moved to VMS_defs.h and changes to measurement
author Merten Sach <msach@mailbox.tu-berlin.de>
date Fri, 16 Dec 2011 20:00:21 +0100
parents fe5ec83f1baf
children c3f458403cd6
rev   line source
Me@0 1 /*
Me@38 2 * Copyright 2010 OpenSourceStewardshipFoundation
Me@43 3 *
Me@0 4 * Licensed under BSD
Me@0 5 */
Me@0 6
Me@0 7
Me@0 8
Me@0 9 #include <stdio.h>
Me@9 10 #include <stddef.h>
Me@0 11
Me@0 12 #include "VMS.h"
msach@77 13 #include "ProcrContext.h"
Me@0 14
Me@0 15
Me@55 16 //===========================================================================
Me@55 17 void inline
Me@55 18 stealWorkInto( SchedSlot *currSlot, VMSQueueStruc *readyToAnimateQ,
msach@169 19 VirtProcr *masterVP );
Me@55 20
Me@55 21 //===========================================================================
Me@55 22
Me@55 23
Me@0 24
Me@0 25 /*This code is animated by the virtual Master processor.
Me@0 26 *
Me@11 27 *Polls each sched slot exactly once, hands any requests made by a newly
Me@11 28 * done slave to the "request handler" plug-in function
Me@0 29 *
Me@11 30 *Any slots that need a virt procr assigned are given to the "schedule"
Me@11 31 * plug-in function, which tries to assign a virt procr (slave) to it.
Me@0 32 *
Me@11 33 *When all slots needing a processor have been given to the schedule plug-in,
Me@11 34 * a fraction of the procrs successfully scheduled are put into the
Me@11 35 * work queue, then a continuation of this function is put in, then the rest
Me@11 36 * of the virt procrs that were successfully scheduled.
Me@0 37 *
Me@11 38 *The first thing the continuation does is busy-wait until the previous
Me@11 39 * animation completes. This is because an (unlikely) continuation may
Me@11 40 * sneak through queue before previous continuation is done putting second
Me@11 41 * part of scheduled slaves in, which is the only race condition.
Me@0 42 *
Me@0 43 */
Me@0 44
Me@4 45 /*May 29, 2010 -- birth a Master during init so that first core loop to
Me@11 46 * start running gets it and does all the stuff for a newly born --
Me@11 47 * from then on, will be doing continuation, but do suspension self
Me@4 48 * directly at end of master loop
Me@4 49 *So VMS__init just births the master virtual processor same way it births
Me@4 50 * all the others -- then does any extra setup needed and puts it into the
Me@4 51 * work queue.
Me@4 52 *However means have to make masterEnv a global static volatile the same way
Me@31 53 * did with readyToAnimateQ in core loop. -- for performance, put the
Me@11 54 * jump to the core loop directly in here, and have it directly jump back.
Me@31 55 *
Me@31 56 *
Me@31 57 *Aug 18, 2010 -- Going to a separate MasterVP for each core, to see if this
Me@31 58 * avoids the suspected bug in the system stack that causes bizarre faults
Me@31 59 * at random places in the system code.
Me@31 60 *
Me@31 61 *So, this function is coupled to each of the MasterVPs, -- meaning this
Me@31 62 * function can't rely on a particular stack and frame -- each MasterVP that
Me@31 63 * animates this function has a different one.
Me@31 64 *
Me@31 65 *At this point, the masterLoop does not write itself into the queue anymore,
Me@31 66 * instead, the coreLoop acquires the masterLock when it has nothing to
Me@31 67 * animate, and then animates its own masterLoop. However, still try to put
Me@31 68 * several AppVPs into the queue to amortize the startup cost of switching
Me@31 69 * to the MasterVP. Note, don't have to worry about latency of requests much
Me@31 70 * because most requests generate work for same core -- only latency issue
Me@31 71 * is case when other cores starved and one core's requests generate work
Me@31 72 * for them -- so keep max in queue to 3 or 4..
Me@4 73 */
Me@31 74 void masterLoop( void *initData, VirtProcr *animatingPr )
Me@21 75 {
Me@55 76 int32 slotIdx, numSlotsFilled;
Me@21 77 VirtProcr *schedVirtPr;
Me@31 78 SchedSlot *currSlot, **schedSlots;
Me@0 79 MasterEnv *masterEnv;
Me@31 80 VMSQueueStruc *readyToAnimateQ;
Me@4 81
Me@0 82 SlaveScheduler slaveScheduler;
Me@0 83 RequestHandler requestHandler;
Me@31 84 void *semanticEnv;
Me@0 85
Me@55 86 int32 thisCoresIdx;
msach@169 87 VirtProcr *masterVP;
msach@169 88 volatile VirtProcr *volatilemasterVP;
Me@31 89
msach@169 90 volatilemasterVP = animatingPr;
msach@169 91 masterVP = (VirtProcr*)volatilemasterVP; //used to force re-define after jmp
msach@169 92
msach@169 93 //====================== Measurement =====================
msach@169 94 TSCountLowHigh endMaster;
msach@169 95 uint64 numCycles;
msach@169 96 //==========================================================
Me@31 97
msach@71 98 //masterLoopStartPt:
msach@169 99 while(1){ //switch to core_loop and back to here is at end of loop
msach@71 100
msach@169 101 //============================= MEASUREMENT STUFF =======================
msach@169 102 #ifdef MEAS__TIME_MASTER
msach@169 103 //Total Master time includes one coreloop time -- just assume the core
msach@169 104 // loop time is same for Master as for AppVPs, even though it may be
msach@169 105 // smaller due to higher predictability of the fixed jmp.
msach@169 106 saveLowTimeStampCountInto( masterVP->startMasterTSCLow );
msach@169 107 #endif
msach@169 108 //=======================================================================
Me@0 109
msach@69 110 masterEnv = (MasterEnv*)_VMSMasterEnv;
Me@4 111
Me@55 112 //GCC may optimize so doesn't always re-define from frame-storage
msach@169 113 masterVP = (VirtProcr*)volatilemasterVP; //just to make sure after jmp
msach@169 114 thisCoresIdx = masterVP->coreAnimatedBy;
Me@31 115 readyToAnimateQ = masterEnv->readyToAnimateQs[thisCoresIdx];
Me@31 116 schedSlots = masterEnv->allSchedSlots[thisCoresIdx];
Me@4 117
Me@0 118 requestHandler = masterEnv->requestHandler;
Me@0 119 slaveScheduler = masterEnv->slaveScheduler;
Me@21 120 semanticEnv = masterEnv->semanticEnv;
Me@0 121
Me@0 122
Me@31 123 //Poll each slot's Done flag
Me@55 124 numSlotsFilled = 0;
msach@169 125 Meas_startMasterLoop
Me@26 126 for( slotIdx = 0; slotIdx < NUM_SCHED_SLOTS; slotIdx++)
Me@0 127 {
Me@4 128 currSlot = schedSlots[ slotIdx ];
Me@0 129
Me@4 130 if( currSlot->workIsDone )
Me@0 131 {
Me@4 132 currSlot->workIsDone = FALSE;
Me@4 133 currSlot->needsProcrAssigned = TRUE;
Me@0 134
Me@0 135 //process requests from slave to master
msach@169 136 Meas_startReqHdlr
Me@21 137 (*requestHandler)( currSlot->procrAssignedToSlot, semanticEnv );
msach@169 138 Meas_endReqHdlr
Me@0 139 }
Me@4 140 if( currSlot->needsProcrAssigned )
Me@4 141 { //give slot a new virt procr
Me@21 142 schedVirtPr =
Me@31 143 (*slaveScheduler)( semanticEnv, thisCoresIdx );
Me@0 144
Me@21 145 if( schedVirtPr != NULL )
Me@21 146 { currSlot->procrAssignedToSlot = schedVirtPr;
Me@26 147 schedVirtPr->schedSlot = currSlot;
Me@26 148 currSlot->needsProcrAssigned = FALSE;
Me@55 149 numSlotsFilled += 1;
Me@55 150
Me@55 151 writeVMSQ( schedVirtPr, readyToAnimateQ );
Me@0 152 }
Me@0 153 }
Me@0 154 }
msach@169 155 Meas_endMasterLoop
Me@55 156
Me@55 157 #ifdef USE_WORK_STEALING
Me@55 158 //If no slots filled, means no more work, look for work to steal.
Me@55 159 if( numSlotsFilled == 0 )
msach@169 160 { gateProtected_stealWorkInto( currSlot, readyToAnimateQ, masterVP );
Me@55 161 }
Me@55 162 #endif
Me@26 163
Me@21 164
Me@38 165
msach@169 166 //=================== Meas =======================
msach@169 167 #ifdef MEAS__TIME_MASTER
msach@169 168 saveLowTimeStampCountInto( masterVP->endMasterTSCLow );
msach@169 169 #endif
msach@169 170 #ifdef MEAS__TIME_2011_SYS
msach@169 171 //Take meas here, to get cycles since entered Master
msach@169 172 saveTSCLowHigh(endMaster);
msach@169 173 numCycles = endMaster.longVal - _VMSMasterEnv->startMaster.longVal;
msach@169 174
msach@169 175 if( numCycles < 200000 ) //sanity check against swap thd out)
msach@169 176 { masterEnv->totalMasterCycles += numCycles;
msach@169 177 masterEnv->numMasterAnimations++;
msach@169 178 }
msach@169 179 #endif
msach@169 180 //==================================================
msach@169 181 masterSwitchToCoreLoop(animatingPr); //"finishes" when switch back to Master
msach@71 182 flushRegisters();
msach@71 183 }//MasterLoop
Me@62 184
Me@0 185 }
Me@0 186
Me@55 187
Me@55 188
Me@55 189 /*This has a race condition -- the coreloops are accessing their own queues
Me@55 190 * at the same time that this work-stealer on a different core is trying to
Me@55 191 */
Me@55 192 void inline
Me@55 193 stealWorkInto( SchedSlot *currSlot, VMSQueueStruc *readyToAnimateQ,
msach@169 194 VirtProcr *masterVP )
Me@55 195 {
Me@55 196 VirtProcr *stolenPr;
Me@55 197 int32 coreIdx, i;
Me@55 198 VMSQueueStruc *currQ;
Me@55 199
Me@55 200 stolenPr = NULL;
msach@169 201 coreIdx = masterVP->coreAnimatedBy;
Me@55 202 for( i = 0; i < NUM_CORES -1; i++ )
Me@55 203 {
Me@55 204 if( coreIdx >= NUM_CORES -1 )
Me@55 205 { coreIdx = 0;
Me@55 206 }
Me@55 207 else
Me@55 208 { coreIdx++;
Me@55 209 }
Me@55 210 currQ = _VMSMasterEnv->readyToAnimateQs[coreIdx];
Me@55 211 if( numInVMSQ( currQ ) > 0 )
Me@55 212 { stolenPr = readVMSQ (currQ );
Me@55 213 break;
Me@55 214 }
Me@55 215 }
Me@55 216
Me@55 217 if( stolenPr != NULL )
Me@55 218 { currSlot->procrAssignedToSlot = stolenPr;
Me@55 219 stolenPr->schedSlot = currSlot;
Me@55 220 currSlot->needsProcrAssigned = FALSE;
Me@55 221
Me@55 222 writeVMSQ( stolenPr, readyToAnimateQ );
Me@55 223 }
Me@55 224 }
Me@55 225
Me@55 226 /*This algorithm makes the common case fast. Make the coreloop passive,
Me@55 227 * and show its progress. Make the stealer control a gate that coreloop
Me@55 228 * has to pass.
Me@55 229 *To avoid interference, only one stealer at a time. Use a global
Me@55 230 * stealer-lock.
Me@55 231 *
Me@55 232 *The pattern is based on a gate -- stealer shuts the gate, then monitors
Me@55 233 * to be sure any already past make it all the way out, before starting.
Me@55 234 *So, have a "progress" measure just before the gate, then have two after it,
Me@55 235 * one is in a "waiting room" outside the gate, the other is at the exit.
Me@55 236 *Then, the stealer first shuts the gate, then checks the progress measure
Me@55 237 * outside it, then looks to see if the progress measure at the exit is the
Me@55 238 * same. If yes, it knows the protected area is empty 'cause no other way
Me@55 239 * to get in and the last to get in also exited.
Me@55 240 *If the progress measure at the exit is not the same, then the stealer goes
Me@55 241 * into a loop checking both the waiting-area and the exit progress-measures
Me@55 242 * until one of them shows the same as the measure outside the gate. Might
Me@55 243 * as well re-read the measure outside the gate each go around, just to be
Me@55 244 * sure. It is guaranteed that one of the two will eventually match the one
Me@55 245 * outside the gate.
Me@55 246 *
Me@55 247 *Here's an informal proof of correctness:
Me@55 248 *The gate can be closed at any point, and have only four cases:
Me@55 249 * 1) coreloop made it past the gate-closing but not yet past the exit
Me@55 250 * 2) coreloop made it past the pre-gate progress update but not yet past
Me@55 251 * the gate,
Me@55 252 * 3) coreloop is right before the pre-gate update
Me@55 253 * 4) coreloop is past the exit and far from the pre-gate update.
Me@55 254 *
Me@55 255 * Covering the cases in reverse order,
Me@55 256 * 4) is not a problem -- stealer will read pre-gate progress, see that it
Me@55 257 * matches exit progress, and the gate is closed, so stealer can proceed.
Me@55 258 * 3) stealer will read pre-gate progress just after coreloop updates it..
Me@55 259 * so stealer goes into a loop until the coreloop causes wait-progress
Me@55 260 * to match pre-gate progress, so then stealer can proceed
Me@55 261 * 2) same as 3..
Me@55 262 * 1) stealer reads pre-gate progress, sees that it's different than exit,
Me@55 263 * so goes into loop until exit matches pre-gate, now it knows coreloop
Me@55 264 * is not in protected and cannot get back in, so can proceed.
Me@55 265 *
Me@55 266 *Implementation for the stealer:
Me@55 267 *
Me@55 268 *First, acquire the stealer lock -- only cores with no work to do will
Me@55 269 * compete to steal, so not a big performance penalty having only one --
Me@55 270 * will rarely have multiple stealers in a system with plenty of work -- and
Me@55 271 * in a system with little work, it doesn't matter.
Me@55 272 *
Me@55 273 *Note, have single-reader, single-writer pattern for all variables used to
Me@55 274 * communicate between stealer and victims
Me@55 275 *
Me@55 276 *So, scan the queues of the core loops, until find non-empty. Each core
Me@55 277 * has its own list that it scans. The list goes in order from closest to
Me@55 278 * furthest core, so it steals first from close cores. Later can add
Me@55 279 * taking info from the app about overlapping footprints, and scan all the
Me@55 280 * others then choose work with the most footprint overlap with the contents
Me@55 281 * of this core's cache.
Me@55 282 *
Me@55 283 *Now, have a victim want to take work from. So, shut the gate in that
Me@55 284 * coreloop, by setting the "gate closed" var on its stack to TRUE.
Me@55 285 *Then, read the core's pre-gate progress and compare to the core's exit
Me@55 286 * progress.
Me@55 287 *If same, can proceed to take work from the coreloop's queue. When done,
Me@55 288 * write FALSE to gate closed var.
Me@55 289 *If different, then enter a loop that reads the pre-gate progress, then
Me@55 290 * compares to exit progress then to wait progress. When one of two
Me@55 291 * matches, proceed. Take work from the coreloop's queue. When done,
Me@55 292 * write FALSE to the gate closed var.
Me@55 293 *
Me@55 294 */
Me@55 295 void inline
Me@55 296 gateProtected_stealWorkInto( SchedSlot *currSlot,
Me@55 297 VMSQueueStruc *myReadyToAnimateQ,
msach@169 298 VirtProcr *masterVP )
Me@55 299 {
Me@55 300 VirtProcr *stolenPr;
Me@55 301 int32 coreIdx, i, haveAVictim, gotLock;
Me@55 302 VMSQueueStruc *victimsQ;
Me@55 303
Me@55 304 volatile GateStruc *vicGate;
Me@55 305 int32 coreMightBeInProtected;
Me@55 306
Me@55 307
Me@55 308
Me@55 309 //see if any other cores have work available to steal
Me@55 310 haveAVictim = FALSE;
msach@169 311 coreIdx = masterVP->coreAnimatedBy;
Me@55 312 for( i = 0; i < NUM_CORES -1; i++ )
Me@55 313 {
Me@55 314 if( coreIdx >= NUM_CORES -1 )
Me@55 315 { coreIdx = 0;
Me@55 316 }
Me@55 317 else
Me@55 318 { coreIdx++;
Me@55 319 }
Me@55 320 victimsQ = _VMSMasterEnv->readyToAnimateQs[coreIdx];
Me@55 321 if( numInVMSQ( victimsQ ) > 0 )
Me@55 322 { haveAVictim = TRUE;
Me@55 323 vicGate = _VMSMasterEnv->workStealingGates[ coreIdx ];
Me@55 324 break;
Me@55 325 }
Me@55 326 }
Me@55 327 if( !haveAVictim ) return; //no work to steal, exit
Me@55 328
Me@55 329 //have a victim core, now get the stealer-lock
Me@55 330 gotLock =__sync_bool_compare_and_swap( &(_VMSMasterEnv->workStealingLock),
Me@55 331 UNLOCKED, LOCKED );
Me@55 332 if( !gotLock ) return; //go back to core loop, which will re-start master
Me@55 333
Me@55 334
Me@55 335 //====== Start Gate-protection =======
Me@55 336 vicGate->gateClosed = TRUE;
Me@55 337 coreMightBeInProtected= vicGate->preGateProgress != vicGate->exitProgress;
Me@55 338 while( coreMightBeInProtected )
Me@55 339 { //wait until sure
Me@55 340 if( vicGate->preGateProgress == vicGate->waitProgress )
Me@55 341 coreMightBeInProtected = FALSE;
Me@55 342 if( vicGate->preGateProgress == vicGate->exitProgress )
Me@55 343 coreMightBeInProtected = FALSE;
Me@55 344 }
Me@55 345
Me@55 346 stolenPr = readVMSQ ( victimsQ );
Me@55 347
Me@55 348 vicGate->gateClosed = FALSE;
Me@55 349 //======= End Gate-protection =======
Me@55 350
Me@55 351
Me@55 352 if( stolenPr != NULL ) //victim could have been in protected and taken
Me@55 353 { currSlot->procrAssignedToSlot = stolenPr;
Me@55 354 stolenPr->schedSlot = currSlot;
Me@55 355 currSlot->needsProcrAssigned = FALSE;
Me@55 356
Me@55 357 writeVMSQ( stolenPr, myReadyToAnimateQ );
Me@55 358 }
Me@55 359
Me@55 360 //unlock the work stealing lock
Me@55 361 _VMSMasterEnv->workStealingLock = UNLOCKED;
Me@55 362 }