annotate VMS.c @ 37:d6367cd40e21

Change in a comment from VMSHW to SSR
author Me
date Wed, 01 Sep 2010 09:18:40 -0700
parents 65e5918731b8
children
rev   line source
Me@0 1 /*
Me@0 2 * Copyright 2010 OpenSourceCodeStewardshipFoundation
Me@0 3 *
Me@0 4 * Licensed under BSD
Me@0 5 */
Me@0 6
Me@0 7 #include <stdio.h>
Me@0 8 #include <stdlib.h>
Me@0 9 #include <malloc.h>
Me@0 10
Me@0 11 #include "VMS.h"
Me@0 12 #include "Queue_impl/BlockingQueue.h"
Me@0 13
Me@0 14
Me@26 15 #define thdAttrs NULL
Me@26 16
Me@22 17 //===========================================================================
Me@22 18 void
Me@22 19 shutdownFn( void *dummy, VirtProcr *dummy2 );
Me@22 20
Me@22 21 void
Me@22 22 create_sched_slots( MasterEnv *masterEnv );
Me@22 23
Me@28 24 void
Me@28 25 create_masterEnv();
Me@28 26
Me@28 27 void
Me@28 28 create_the_coreLoop_OS_threads();
Me@28 29
Me@26 30 pthread_mutex_t suspendLock = PTHREAD_MUTEX_INITIALIZER;
Me@26 31 pthread_cond_t suspend_cond = PTHREAD_COND_INITIALIZER;
Me@26 32
Me@22 33 //===========================================================================
Me@22 34
Me@0 35 /*Setup has two phases:
Me@0 36 * 1) Semantic layer first calls init_VMS, which creates masterEnv, and puts
Me@8 37 * the master virt procr into the work-queue, ready for first "call"
Me@8 38 * 2) Semantic layer then does its own init, which creates the seed virt
Me@8 39 * procr inside the semantic layer, ready to schedule it when
Me@0 40 * asked by the first run of the masterLoop.
Me@0 41 *
Me@0 42 *This part is bit weird because VMS really wants to be "always there", and
Me@0 43 * have applications attach and detach.. for now, this VMS is part of
Me@0 44 * the app, so the VMS system starts up as part of running the app.
Me@0 45 *
Me@8 46 *The semantic layer is isolated from the VMS internals by making the
Me@8 47 * semantic layer do setup to a state that it's ready with its
Me@8 48 * initial virt procrs, ready to schedule them to slots when the masterLoop
Me@0 49 * asks. Without this pattern, the semantic layer's setup would
Me@8 50 * have to modify slots directly to assign the initial virt-procrs, and put
Me@0 51 * them into the workQ itself, breaking the isolation completely.
Me@0 52 *
Me@0 53 *
Me@8 54 *The semantic layer creates the initial virt procr(s), and adds its
Me@8 55 * own environment to masterEnv, and fills in the pointers to
Me@0 56 * the requestHandler and slaveScheduler plug-in functions
Me@8 57 */
Me@8 58
Me@8 59 /*This allocates VMS data structures, populates the master VMSProc,
Me@0 60 * and master environment, and returns the master environment to the semantic
Me@0 61 * layer.
Me@0 62 */
Me@8 63 void
Me@8 64 VMS__init()
Me@28 65 {
Me@28 66 create_masterEnv();
Me@28 67 create_the_coreLoop_OS_threads();
Me@28 68 }
Me@28 69
Me@28 70 /*To initialize the sequential version, just don't create the threads
Me@28 71 */
Me@28 72 void
Me@28 73 VMS__init_Seq()
Me@28 74 {
Me@28 75 create_masterEnv();
Me@28 76 }
Me@28 77
Me@28 78 void
Me@28 79 create_masterEnv()
Me@1 80 { MasterEnv *masterEnv;
Me@26 81 VMSQueueStruc *workQ;
Me@1 82
Me@0 83 //Make the central work-queue
Me@26 84 _VMSWorkQ = makeVMSQ();
Me@1 85 workQ = _VMSWorkQ;
Me@0 86
Me@1 87 _VMSMasterEnv = malloc( sizeof(MasterEnv) );
Me@1 88 masterEnv = _VMSMasterEnv;
Me@0 89
Me@8 90 //create the master virtual processor
Me@8 91 masterEnv->masterVirtPr = VMS__create_procr( &masterLoop, masterEnv );
Me@0 92
Me@1 93 create_sched_slots( masterEnv );
Me@0 94
Me@24 95 masterEnv->stillRunning = FALSE;
Me@26 96 masterEnv->numToPrecede = NUM_CORES;
Me@28 97
Me@1 98 //First core loop to start up gets this, which will schedule seed Pr
Me@1 99 //TODO: debug: check address of masterVirtPr
Me@26 100 writeVMSQ( masterEnv->masterVirtPr, workQ );
Me@12 101
Me@28 102 numProcrsCreated = 1; //global counter for debugging
Me@30 103
Me@30 104 //==================== malloc substitute ========================
Me@30 105 //
Me@30 106 //Testing whether malloc is using thread-local storage and therefore
Me@30 107 // causing unreliable behavior.
Me@30 108 //Just allocate a massive chunk of memory and roll own malloc/free and
Me@30 109 // make app use VMS__malloc_to, which will suspend and perform malloc
Me@30 110 // in the master, taking from this massive chunk.
Me@30 111
Me@30 112 // initFreeList();
Me@0 113 }
Me@0 114
Me@30 115 /*
Me@30 116 void
Me@30 117 initMasterMalloc()
Me@30 118 {
Me@30 119 _VMSMasterEnv->mallocChunk = malloc( MASSIVE_MALLOC_SIZE );
Me@30 120
Me@30 121 //The free-list element is the first several locations of an
Me@30 122 // allocated chunk -- the address given to the application is pre-
Me@30 123 // pended with both the ownership structure and the free-list struc.
Me@30 124 //So, write the values of these into the first locations of
Me@30 125 // mallocChunk -- which marks it as free & puts in its size.
Me@30 126 listElem = (FreeListElem *)_VMSMasterEnv->mallocChunk;
Me@30 127 listElem->size = MASSIVE_MALLOC_SIZE - NUM_PREPEND_BYTES
Me@30 128 listElem->next = NULL;
Me@30 129 }
Me@30 130
Me@30 131 void
Me@30 132 dissipateMasterMalloc()
Me@30 133 {
Me@30 134 //Just foo code -- to get going -- doing as if free list were link-list
Me@30 135 currElem = _VMSMasterEnv->freeList;
Me@30 136 while( currElem != NULL )
Me@30 137 {
Me@30 138 nextElem = currElem->next;
Me@30 139 masterFree( currElem );
Me@30 140 currElem = nextElem;
Me@30 141 }
Me@30 142 free( _VMSMasterEnv->freeList );
Me@30 143 }
Me@30 144 */
Me@30 145
Me@0 146 void
Me@1 147 create_sched_slots( MasterEnv *masterEnv )
Me@8 148 { SchedSlot **schedSlots, **filledSlots;
Me@0 149 int i;
Me@0 150
Me@8 151 schedSlots = malloc( NUM_SCHED_SLOTS * sizeof(SchedSlot *) );
Me@8 152 filledSlots = malloc( NUM_SCHED_SLOTS * sizeof(SchedSlot *) );
Me@8 153 masterEnv->schedSlots = schedSlots;
Me@8 154 masterEnv->filledSlots = filledSlots;
Me@8 155
Me@1 156 for( i = 0; i < NUM_SCHED_SLOTS; i++ )
Me@0 157 {
Me@8 158 schedSlots[i] = malloc( sizeof(SchedSlot) );
Me@8 159
Me@1 160 //Set state to mean "handling requests done, slot needs filling"
Me@8 161 schedSlots[i]->workIsDone = FALSE;
Me@8 162 schedSlots[i]->needsProcrAssigned = TRUE;
Me@0 163 }
Me@0 164 }
Me@0 165
Me@8 166
Me@28 167 void
Me@28 168 create_the_coreLoop_OS_threads()
Me@28 169 {
Me@28 170 //========================================================================
Me@28 171 // Create the Threads
Me@28 172 int coreIdx, retCode;
Me@28 173
Me@28 174 //Need the threads to be created suspended, and wait for a signal
Me@28 175 // before proceeding -- gives time after creating to initialize other
Me@28 176 // stuff before the coreLoops set off.
Me@28 177 _VMSMasterEnv->setupComplete = 0;
Me@28 178
Me@28 179 //Make the threads that animate the core loops
Me@28 180 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
Me@28 181 { coreLoopThdParams[coreIdx] = malloc( sizeof(ThdParams) );
Me@28 182 coreLoopThdParams[coreIdx]->coreNum = coreIdx;
Me@28 183
Me@28 184 retCode =
Me@28 185 pthread_create( &(coreLoopThdHandles[coreIdx]),
Me@28 186 thdAttrs,
Me@28 187 &coreLoop,
Me@28 188 (void *)(coreLoopThdParams[coreIdx]) );
Me@28 189 if(retCode){printf("ERROR creating thread: %d\n", retCode); exit(0);}
Me@28 190 }
Me@28 191 }
Me@28 192
Me@0 193 /*Semantic layer calls this when it want the system to start running..
Me@0 194 *
Me@24 195 *This starts the core loops running then waits for them to exit.
Me@0 196 */
Me@12 197 void
Me@24 198 VMS__start_the_work_then_wait_until_done()
Me@12 199 { int coreIdx;
Me@24 200 //Start the core loops running
Me@24 201 //===========================================================================
Me@25 202 TSCount startCount, endCount;
Me@24 203 unsigned long long count = 0, freq = 0;
Me@25 204 double runTime;
Me@0 205
Me@25 206 startCount = getTSCount();
Me@25 207
Me@25 208 //tell the core loop threads that setup is complete
Me@25 209 //get lock, to lock out any threads still starting up -- they'll see
Me@25 210 // that setupComplete is true before entering while loop, and so never
Me@25 211 // wait on the condition
Me@26 212 pthread_mutex_lock( &suspendLock );
Me@25 213 _VMSMasterEnv->setupComplete = 1;
Me@26 214 pthread_mutex_unlock( &suspendLock );
Me@26 215 pthread_cond_broadcast( &suspend_cond );
Me@25 216
Me@25 217
Me@24 218 //wait for all to complete
Me@8 219 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
Me@8 220 {
Me@25 221 pthread_join( coreLoopThdHandles[coreIdx], NULL );
Me@24 222 }
Me@25 223
Me@24 224 //NOTE: do not clean up VMS env here -- semantic layer has to have
Me@24 225 // a chance to clean up its environment first, then do a call to free
Me@24 226 // the Master env and rest of VMS locations
Me@24 227
Me@24 228
Me@25 229 endCount = getTSCount();
Me@25 230 count = endCount - startCount;
Me@24 231
Me@25 232 runTime = (double)count / (double)TSCOUNT_FREQ;
Me@25 233
Me@25 234 printf("\n Time startup to shutdown: %f\n", runTime); fflush( stdin );
Me@8 235 }
Me@0 236
Me@28 237 /*Only difference between version with an OS thread pinned to each core and
Me@28 238 * the sequential version of VMS is VMS__init_Seq, this, and coreLoop_Seq.
Me@28 239 */
Me@28 240 void
Me@28 241 VMS__start_the_work_then_wait_until_done_Seq()
Me@28 242 {
Me@28 243 //Instead of un-suspending threads, just call the one and only
Me@28 244 // core loop (sequential version), in the main thread.
Me@28 245 coreLoop_Seq( NULL );
Me@28 246
Me@28 247 }
Me@28 248
Me@0 249
Me@0 250
Me@8 251 /*Create stack, then create __cdecl structure on it and put initialData and
Me@8 252 * pointer to the new structure instance into the parameter positions on
Me@8 253 * the stack
Me@8 254 *Then put function pointer into nextInstrPt -- the stack is setup in std
Me@8 255 * call structure, so jumping to function ptr is same as a GCC generated
Me@8 256 * function call
Me@8 257 *No need to save registers on old stack frame, because there's no old
Me@8 258 * animator state to return to --
Me@8 259 *
Me@8 260 */
Me@8 261 VirtProcr *
Me@8 262 VMS__create_procr( VirtProcrFnPtr fnPtr, void *initialData )
Me@8 263 { VirtProcr *newPr;
Me@8 264 char *stackLocs, *stackPtr;
Me@8 265
Me@8 266 newPr = malloc( sizeof(VirtProcr) );
Me@12 267 newPr->procrID = numProcrsCreated++;
Me@8 268 newPr->nextInstrPt = fnPtr;
Me@8 269 newPr->initialData = initialData;
Me@32 270 newPr->requests = NULL;
Me@8 271
Me@14 272 //fnPtr takes two params -- void *initData & void *animProcr
Me@8 273 //alloc stack locations, make stackPtr be the highest addr minus room
Me@14 274 // for 2 params + return addr. Return addr (NULL) is in loc pointed to
Me@14 275 // by stackPtr, initData at stackPtr + 4 bytes, animatingPr just above
Me@22 276 stackLocs = malloc( VIRT_PROCR_STACK_SIZE );
Me@32 277 if(stackLocs == 0) {perror("malloc stack"); exit(1);}
Me@22 278 newPr->startOfStack = stackLocs;
Me@22 279 stackPtr = ( (char *)stackLocs + VIRT_PROCR_STACK_SIZE - 0x10 );
Me@8 280 //setup __cdecl on stack -- coreloop will switch to stackPtr before jmp
Me@22 281 *( (int *)stackPtr + 2 ) = (int) newPr; //rightmost param -- 32bit pointer
Me@14 282 *( (int *)stackPtr + 1 ) = (int) initialData; //next param to left
Me@8 283 newPr->stackPtr = stackPtr; //core loop will switch to this, then
Me@8 284 newPr->framePtr = stackPtr; //suspend loop will save new stack & frame ptr
Me@8 285
Me@8 286 return newPr;
Me@8 287 }
Me@8 288
Me@8 289
Me@26 290 /*there is a label inside this function -- save the addr of this label in
Me@0 291 * the callingPr struc, as the pick-up point from which to start the next
Me@0 292 * work-unit for that procr. If turns out have to save registers, then
Me@0 293 * save them in the procr struc too. Then do assembly jump to the CoreLoop's
Me@0 294 * "done with work-unit" label. The procr struc is in the request in the
Me@0 295 * slave that animated the just-ended work-unit, so all the state is saved
Me@0 296 * there, and will get passed along, inside the request handler, to the
Me@0 297 * next work-unit for that procr.
Me@0 298 */
Me@8 299 void
Me@22 300 VMS__suspend_procr( VirtProcr *callingPr )
Me@14 301 { void *jmpPt, *stackPtrAddr, *framePtrAddr, *coreLoopStackPtr;
Me@14 302 void *coreLoopFramePtr;
Me@0 303
Me@14 304 //The request to master will cause this suspended virt procr to get
Me@14 305 // scheduled again at some future point -- to resume, core loop jumps
Me@14 306 // to the resume point (below), which causes restore of saved regs and
Me@14 307 // "return" from this call.
Me@1 308 callingPr->nextInstrPt = &&ResumePt;
Me@1 309
Me@1 310 //return ownership of the virt procr and sched slot to Master virt pr
Me@1 311 callingPr->schedSlot->workIsDone = TRUE;
Me@14 312 // coreIdx = callingPr->coreAnimatedBy;
Me@1 313
Me@18 314 stackPtrAddr = &(callingPr->stackPtr);
Me@18 315 framePtrAddr = &(callingPr->framePtr);
Me@26 316
Me@14 317 jmpPt = callingPr->coreLoopStartPt;
Me@14 318 coreLoopFramePtr = callingPr->coreLoopFramePtr;//need this only
Me@18 319 coreLoopStackPtr = callingPr->coreLoopStackPtr;//shouldn't need -- safety
Me@1 320
Me@26 321 //Eclipse's compilation sequence complains -- so break into two
Me@26 322 // separate in-line assembly pieces
Me@26 323 //Save the virt procr's stack and frame ptrs,
Me@18 324 asm volatile("movl %0, %%eax; \
Me@18 325 movl %%esp, (%%eax); \
Me@18 326 movl %1, %%eax; \
Me@26 327 movl %%ebp, (%%eax) "\
Me@26 328 /* outputs */ : "=g" (stackPtrAddr), "=g" (framePtrAddr) \
Me@26 329 /* inputs */ : \
Me@26 330 /* clobber */ : "%eax" \
Me@26 331 );
Me@26 332
Me@26 333 //restore coreloop's frame ptr, then jump back to "start" of core loop
Me@26 334 //Note, GCC compiles to assembly that saves esp and ebp in the stack
Me@26 335 // frame -- so have to explicitly do assembly that saves to memory
Me@26 336 asm volatile("movl %0, %%eax; \
Me@26 337 movl %1, %%esp; \
Me@26 338 movl %2, %%ebp; \
Me@18 339 jmp %%eax " \
Me@26 340 /* outputs */ : \
Me@26 341 /* inputs */ : "m" (jmpPt), "m"(coreLoopStackPtr), "m"(coreLoopFramePtr)\
Me@18 342 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi","%esi" \
Me@12 343 ); //list everything as clobbered to force GCC to save all
Me@12 344 // live vars that are in regs on stack before this
Me@12 345 // assembly, so that stack pointer is correct, before jmp
Me@1 346
Me@1 347 ResumePt:
Me@0 348 return;
Me@0 349 }
Me@0 350
Me@22 351
Me@22 352
Me@22 353 /*Not sure yet the form going to put "dissipate" in, so this is the third
Me@22 354 * possibility -- the semantic layer can just make a macro that looks like
Me@22 355 * a call to its name, then expands to a call to this.
Me@8 356 *
Me@22 357 *As of June 30, 2010 this looks like the top choice..
Me@8 358 *
Me@22 359 *This adds a request to dissipate, then suspends the processor so that the
Me@22 360 * request handler will receive the request. The request handler is what
Me@22 361 * does the work of freeing memory and removing the processor from the
Me@22 362 * semantic environment's data structures.
Me@22 363 *The request handler also is what figures out when to shutdown the VMS
Me@22 364 * system -- which causes all the core loop threads to die, and returns from
Me@22 365 * the call that started up VMS to perform the work.
Me@22 366 *
Me@22 367 *This form is a bit misleading to understand if one is trying to figure out
Me@22 368 * how VMS works -- it looks like a normal function call, but inside it
Me@22 369 * sends a request to the request handler and suspends the processor, which
Me@22 370 * jumps out of the VMS__dissipate_procr function, and out of all nestings
Me@22 371 * above it, transferring the work of dissipating to the request handler,
Me@22 372 * which then does the actual work -- causing the processor that animated
Me@22 373 * the call of this function to disappear and the "hanging" state of this
Me@22 374 * function to just poof into thin air -- the virtual processor's trace
Me@22 375 * never returns from this call, but instead the virtual processor's trace
Me@22 376 * gets suspended in this call and all the virt processor's state disap-
Me@22 377 * pears -- making that suspend the last thing in the virt procr's trace.
Me@8 378 */
Me@8 379 void
Me@22 380 VMS__dissipate_procr( VirtProcr *procrToDissipate )
Me@22 381 { VMSReqst *req;
Me@22 382
Me@22 383 req = malloc( sizeof(VMSReqst) );
Me@22 384 // req->virtProcrFrom = callingPr;
Me@22 385 req->reqType = dissipate;
Me@22 386 req->nextReqst = procrToDissipate->requests;
Me@22 387 procrToDissipate->requests = req;
Me@22 388
Me@22 389 VMS__suspend_procr( procrToDissipate );
Me@22 390 }
Me@22 391
Me@22 392
Me@22 393 /*This inserts the semantic-layer's request data into standard VMS carrier
Me@22 394 */
Me@22 395 inline void
Me@24 396 VMS__add_sem_request( void *semReqData, VirtProcr *callingPr )
Me@22 397 { VMSReqst *req;
Me@22 398
Me@22 399 req = malloc( sizeof(VMSReqst) );
Me@22 400 // req->virtProcrFrom = callingPr;
Me@22 401 req->reqType = semantic;
Me@22 402 req->semReqData = semReqData;
Me@22 403 req->nextReqst = callingPr->requests;
Me@22 404 callingPr->requests = req;
Me@22 405 }
Me@22 406
Me@22 407
Me@22 408
Me@22 409 //TODO: add a semantic-layer supplied "freer" for the semantic-data portion
Me@22 410 // of a request -- IE call with both a virt procr and a fn-ptr to request
Me@22 411 // freer (or maybe put request freer as a field in virt procr?)
Me@22 412 void
Me@22 413 VMS__remove_and_free_top_request( VirtProcr *procrWithReq )
Me@22 414 { VMSReqst *req;
Me@22 415
Me@22 416 req = procrWithReq->requests;
Me@29 417 if( req == NULL ) return;
Me@22 418 procrWithReq->requests = procrWithReq->requests->nextReqst;
Me@29 419 VMS__free_request( req );
Me@22 420 }
Me@22 421
Me@24 422
Me@24 423 //TODO: add a semantic-layer supplied "freer" for the semantic-data portion
Me@24 424 // of a request -- IE call with both a virt procr and a fn-ptr to request
Me@24 425 // freer (also maybe put sem request freer as a field in virt procr?)
Me@37 426 //SSR relies right now on this only freeing VMS layer of request -- the
Me@26 427 // semantic portion of request is alloc'd and freed by request handler
Me@22 428 void
Me@24 429 VMS__free_request( VMSReqst *req )
Me@24 430 {
Me@24 431 free( req );
Me@24 432 }
Me@24 433
Me@24 434 VMSReqst *
Me@24 435 VMS__take_top_request_from( VirtProcr *procrWithReq )
Me@24 436 { VMSReqst *req;
Me@24 437
Me@24 438 req = procrWithReq->requests;
Me@24 439 if( req == NULL ) return req;
Me@24 440
Me@24 441 procrWithReq->requests = procrWithReq->requests->nextReqst;
Me@24 442 return req;
Me@24 443 }
Me@24 444
Me@32 445 VMSReqst *
Me@32 446 VMS__free_top_and_give_next_request_from( VirtProcr *procrWithReq )
Me@32 447 { VMSReqst *req;
Me@32 448
Me@32 449 req = procrWithReq->requests;
Me@32 450 if( req == NULL ) return req;
Me@32 451
Me@32 452 procrWithReq->requests = procrWithReq->requests->nextReqst;
Me@32 453 VMS__free_request( req );
Me@32 454 return procrWithReq->requests;
Me@32 455 }
Me@32 456
Me@32 457
Me@24 458 inline int
Me@24 459 VMS__isSemanticReqst( VMSReqst *req )
Me@22 460 {
Me@24 461 return ( req->reqType == semantic );
Me@24 462 }
Me@22 463
Me@24 464
Me@24 465 inline void *
Me@24 466 VMS__take_sem_reqst_from( VMSReqst *req )
Me@24 467 {
Me@24 468 return req->semReqData;
Me@24 469 }
Me@24 470
Me@24 471 inline int
Me@24 472 VMS__isDissipateReqst( VMSReqst *req )
Me@24 473 {
Me@24 474 return ( req->reqType == dissipate );
Me@24 475 }
Me@24 476
Me@24 477 inline int
Me@24 478 VMS__isCreateReqst( VMSReqst *req )
Me@24 479 {
Me@24 480 return ( req->reqType == regCreated );
Me@24 481 }
Me@24 482
Me@24 483 void
Me@24 484 VMS__send_register_new_procr_request(VirtProcr *newPr, VirtProcr *reqstingPr)
Me@24 485 { VMSReqst *req;
Me@24 486
Me@24 487 req = malloc( sizeof(VMSReqst) );
Me@24 488 req->reqType = regCreated;
Me@24 489 req->semReqData = newPr;
Me@24 490 req->nextReqst = reqstingPr->requests;
Me@24 491 reqstingPr->requests = req;
Me@24 492
Me@24 493 VMS__suspend_procr( reqstingPr );
Me@22 494 }
Me@22 495
Me@22 496
Me@22 497
Me@24 498 /*This must be called by the request handler plugin -- it cannot be called
Me@24 499 * from the semantic library "dissipate processor" function -- instead, the
Me@24 500 * semantic layer has to generate a request for the plug-in to call this
Me@24 501 * function.
Me@24 502 *The reason is that this frees the virtual processor's stack -- which is
Me@24 503 * still in use inside semantic library calls!
Me@24 504 *
Me@24 505 *This frees or recycles all the state owned by and comprising the VMS
Me@24 506 * portion of the animating virtual procr. The request handler must first
Me@24 507 * free any semantic data created for the processor that didn't use the
Me@24 508 * VMS_malloc mechanism. Then it calls this, which first asks the malloc
Me@24 509 * system to disown any state that did use VMS_malloc, and then frees the
Me@24 510 * statck and the processor-struct itself.
Me@24 511 *If the dissipated processor is the sole (remaining) owner of VMS__malloc'd
Me@24 512 * state, then that state gets freed (or sent to recycling) as a side-effect
Me@24 513 * of dis-owning it.
Me@24 514 */
Me@24 515 void
Me@29 516 VMS__handle_dissipate_reqst( VirtProcr *animatingPr )
Me@24 517 {
Me@24 518 //dis-own all locations owned by this processor, causing to be freed
Me@24 519 // any locations that it is (was) sole owner of
Me@29 520 //TODO: implement VMS__malloc system, including "give up ownership"
Me@24 521
Me@24 522 //The dissipate request might still be attached, so remove and free it
Me@24 523 VMS__remove_and_free_top_request( animatingPr );
Me@24 524
Me@24 525 //NOTE: initialData was given to the processor, so should either have
Me@24 526 // been alloc'd with VMS__malloc, or freed by the level above animPr.
Me@24 527 //So, all that's left to free here is the stack and the VirtProcr struc
Me@24 528 // itself
Me@24 529 free( animatingPr->startOfStack );
Me@24 530 free( animatingPr );
Me@24 531 }
Me@24 532
Me@24 533
Me@29 534 //TODO: re-architect so that have clean separation between request handler
Me@29 535 // and master loop, for dissipate, create, shutdown, and other non-semantic
Me@29 536 // requests. Issue is chain: one removes requests from AppVP, one dispatches
Me@29 537 // on type of request, and one handles each type.. but some types require
Me@29 538 // action from both request handler and master loop -- maybe just give the
Me@29 539 // request handler calls like: VMS__handle_X_request_type
Me@24 540
Me@29 541 void
Me@29 542 endOSThreadFn( void *initData, VirtProcr *animatingPr );
Me@29 543
Me@29 544 /*This is called by the semantic layer's request handler when it decides its
Me@29 545 * time to shut down the VMS system. Calling this causes the core loop OS
Me@29 546 * threads to exit, which unblocks the entry-point function that started up
Me@29 547 * VMS, and allows it to grab the result and return to the original single-
Me@29 548 * threaded application.
Me@22 549 *
Me@29 550 *The _VMSMasterEnv is needed by this shut down function, so the create-seed-
Me@29 551 * and-wait function has to free a bunch of stuff after it detects the
Me@29 552 * threads have all died: the masterEnv, the thread-related locations,
Me@29 553 * masterVP any AppVPs that might still be allocated and sitting in the
Me@29 554 * semantic environment, or have been orphaned in the _VMSWorkQ.
Me@29 555 *
Me@29 556 *NOTE: the semantic plug-in is expected to use VMS__malloc_to to get all the
Me@29 557 * locations it needs, and give ownership to masterVP. Then, they will be
Me@29 558 * automatically freed when the masterVP is dissipated. (This happens after
Me@29 559 * the core loop threads have all exited)
Me@22 560 *
Me@29 561 *In here,create one core-loop shut-down processor for each core loop and put
Me@29 562 * them all directly into the workQ.
Me@29 563 *Note, this function can ONLY be called after the semantic environment no
Me@29 564 * longer cares if AppVPs get animated after the point this is called. In
Me@29 565 * other words, this can be used as an abort, or else it should only be
Me@29 566 * called when all AppVPs have finished dissipate requests -- only at that
Me@29 567 * point is it sure that all results have completed.
Me@22 568 */
Me@22 569 void
Me@29 570 VMS__handle_shutdown_reqst( void *dummy, VirtProcr *animatingPr )
Me@8 571 { int coreIdx;
Me@14 572 VirtProcr *shutDownPr;
Me@26 573 VMSQueueStruc *workQ = _VMSWorkQ;
Me@22 574
Me@29 575 //create the shutdown processors, one for each core loop -- put them
Me@29 576 // directly into _VMSWorkQ -- each core will die when gets one, so
Me@29 577 // the system distributes them evenly itself.
Me@8 578 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
Me@8 579 {
Me@29 580 shutDownPr = VMS__create_procr( &endOSThreadFn, NULL );
Me@26 581 writeVMSQ( shutDownPr, workQ );
Me@8 582 }
Me@22 583
Me@12 584 }
Me@12 585
Me@12 586
Me@29 587 /*Am trying to be cute, avoiding IF statement in coreLoop that checks for
Me@29 588 * a special shutdown procr. Ended up with extra-complex shutdown sequence.
Me@29 589 *This function has the sole purpose of setting the stack and framePtr
Me@29 590 * to the coreLoop's stack and framePtr.. it does that then jumps to the
Me@29 591 * core loop's shutdown point -- might be able to just call Pthread_exit
Me@30 592 * from here, but am going back to the pthread's stack and setting everything
Me@29 593 * up just as if it never jumped out, before calling pthread_exit.
Me@29 594 *The end-point of core loop will free the stack and so forth of the
Me@29 595 * processor that animates this function, (this fn is transfering the
Me@29 596 * animator of the AppVP that is in turn animating this function over
Me@29 597 * to core loop function -- note that this slices out a level of virtual
Me@29 598 * processors).
Me@29 599 */
Me@29 600 void
Me@29 601 endOSThreadFn( void *initData, VirtProcr *animatingPr )
Me@29 602 { void *jmpPt, *coreLoopStackPtr, *coreLoopFramePtr;
Me@29 603
Me@29 604 jmpPt = _VMSMasterEnv->coreLoopEndPt;
Me@29 605 coreLoopStackPtr = animatingPr->coreLoopStackPtr;
Me@29 606 coreLoopFramePtr = animatingPr->coreLoopFramePtr;
Me@29 607
Me@29 608
Me@29 609 asm volatile("movl %0, %%eax; \
Me@29 610 movl %1, %%esp; \
Me@29 611 movl %2, %%ebp; \
Me@29 612 jmp %%eax " \
Me@29 613 /* outputs */ : \
Me@29 614 /* inputs */ : "m" (jmpPt), "m"(coreLoopStackPtr), "m"(coreLoopFramePtr)\
Me@29 615 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi","%esi" \
Me@29 616 );
Me@29 617 }
Me@29 618
Me@29 619
Me@29 620
Me@30 621 /*This is called after the threads have shut down and control as returned
Me@30 622 * to the semantic layer, in the entry point function in the main thread.
Me@30 623 * It has to free anything allocated during VMS_init, and any other alloc'd
Me@24 624 * locations that might be left over.
Me@24 625 */
Me@24 626 void
Me@29 627 VMS__cleanup_after_shutdown()
Me@24 628 { int i;
Me@24 629
Me@24 630 free( _VMSWorkQ );
Me@24 631 free( _VMSMasterEnv->filledSlots );
Me@24 632 for( i = 0; i < NUM_SCHED_SLOTS; i++ )
Me@24 633 {
Me@24 634 free( _VMSMasterEnv->schedSlots[i] );
Me@24 635 }
Me@24 636
Me@24 637 free( _VMSMasterEnv->schedSlots);
Me@29 638 VMS__handle_dissipate_reqst( _VMSMasterEnv->masterVirtPr );
Me@24 639
Me@24 640 free( _VMSMasterEnv );
Me@24 641 }
Me@24 642
Me@24 643
Me@24 644 //===========================================================================
Me@12 645
Me@12 646 inline TSCount getTSCount()
Me@12 647 { unsigned int low, high;
Me@12 648 TSCount out;
Me@12 649
Me@12 650 saveTimeStampCountInto( low, high );
Me@12 651 out = high;
Me@12 652 out = (out << 32) + low;
Me@12 653 return out;
Me@12 654 }
Me@12 655