annotate VMS.c @ 62:dd3e60aeae26

Middle of fixing for -O3.. works -O0 still -- hard-code field offsets in assbly
author Me
date Fri, 12 Nov 2010 07:36:01 -0800
parents 26d53313a8f2
children a6c442d52590 5cb919ac890f
rev   line source
Me@0 1 /*
Me@38 2 * Copyright 2010 OpenSourceStewardshipFoundation
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@50 9 #include <string.h>
Me@0 10 #include <malloc.h>
Me@50 11 #include <sys/time.h>
Me@0 12
Me@0 13 #include "VMS.h"
Me@0 14 #include "Queue_impl/BlockingQueue.h"
Me@38 15 #include "Histogram/Histogram.h"
Me@0 16
Me@0 17
Me@26 18 #define thdAttrs NULL
Me@26 19
Me@22 20 //===========================================================================
Me@22 21 void
Me@22 22 shutdownFn( void *dummy, VirtProcr *dummy2 );
Me@22 23
Me@31 24 SchedSlot **
Me@31 25 create_sched_slots();
Me@22 26
Me@28 27 void
Me@28 28 create_masterEnv();
Me@28 29
Me@28 30 void
Me@28 31 create_the_coreLoop_OS_threads();
Me@28 32
Me@50 33 MallocProlog *
Me@50 34 create_free_list();
Me@50 35
Me@53 36 void
Me@53 37 endOSThreadFn( void *initData, VirtProcr *animatingPr );
Me@50 38
Me@26 39 pthread_mutex_t suspendLock = PTHREAD_MUTEX_INITIALIZER;
Me@26 40 pthread_cond_t suspend_cond = PTHREAD_COND_INITIALIZER;
Me@26 41
Me@22 42 //===========================================================================
Me@22 43
Me@0 44 /*Setup has two phases:
Me@0 45 * 1) Semantic layer first calls init_VMS, which creates masterEnv, and puts
Me@8 46 * the master virt procr into the work-queue, ready for first "call"
Me@8 47 * 2) Semantic layer then does its own init, which creates the seed virt
Me@8 48 * procr inside the semantic layer, ready to schedule it when
Me@0 49 * asked by the first run of the masterLoop.
Me@0 50 *
Me@0 51 *This part is bit weird because VMS really wants to be "always there", and
Me@0 52 * have applications attach and detach.. for now, this VMS is part of
Me@0 53 * the app, so the VMS system starts up as part of running the app.
Me@0 54 *
Me@8 55 *The semantic layer is isolated from the VMS internals by making the
Me@8 56 * semantic layer do setup to a state that it's ready with its
Me@8 57 * initial virt procrs, ready to schedule them to slots when the masterLoop
Me@0 58 * asks. Without this pattern, the semantic layer's setup would
Me@8 59 * have to modify slots directly to assign the initial virt-procrs, and put
Me@31 60 * them into the readyToAnimateQ itself, breaking the isolation completely.
Me@0 61 *
Me@0 62 *
Me@8 63 *The semantic layer creates the initial virt procr(s), and adds its
Me@8 64 * own environment to masterEnv, and fills in the pointers to
Me@0 65 * the requestHandler and slaveScheduler plug-in functions
Me@8 66 */
Me@8 67
Me@8 68 /*This allocates VMS data structures, populates the master VMSProc,
Me@0 69 * and master environment, and returns the master environment to the semantic
Me@0 70 * layer.
Me@0 71 */
Me@8 72 void
Me@8 73 VMS__init()
Me@28 74 {
Me@28 75 create_masterEnv();
Me@28 76 create_the_coreLoop_OS_threads();
Me@28 77 }
Me@28 78
Me@28 79 /*To initialize the sequential version, just don't create the threads
Me@28 80 */
Me@28 81 void
Me@28 82 VMS__init_Seq()
Me@28 83 {
Me@28 84 create_masterEnv();
Me@28 85 }
Me@28 86
Me@28 87 void
Me@28 88 create_masterEnv()
Me@31 89 { MasterEnv *masterEnv;
Me@55 90 VMSQueueStruc **readyToAnimateQs;
Me@31 91 int coreIdx;
Me@31 92 VirtProcr **masterVPs;
Me@31 93 SchedSlot ***allSchedSlots; //ptr to array of ptrs
Me@53 94
Me@53 95
Me@31 96 //Make the master env, which holds everything else
Me@1 97 _VMSMasterEnv = malloc( sizeof(MasterEnv) );
Me@53 98
Me@53 99 //Very first thing put into the master env is the free-list, seeded
Me@53 100 // with a massive initial chunk of memory.
Me@53 101 //After this, all other mallocs are VMS__malloc.
Me@53 102 _VMSMasterEnv->freeListHead = VMS_ext__create_free_list();
Me@53 103
Me@53 104 //===================== Only VMS__malloc after this ====================
Me@1 105 masterEnv = _VMSMasterEnv;
Me@31 106
Me@31 107 //Make a readyToAnimateQ for each core loop
Me@55 108 readyToAnimateQs = VMS__malloc( NUM_CORES * sizeof(VMSQueueStruc *) );
Me@53 109 masterVPs = VMS__malloc( NUM_CORES * sizeof(VirtProcr *) );
Me@0 110
Me@31 111 //One array for each core, 3 in array, core's masterVP scheds all
Me@53 112 allSchedSlots = VMS__malloc( NUM_CORES * sizeof(SchedSlot *) );
Me@0 113
Me@53 114 _VMSMasterEnv->numProcrsCreated = 0; //used by create procr
Me@31 115 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
Me@53 116 {
Me@55 117 readyToAnimateQs[ coreIdx ] = makeVMSQ();
Me@31 118
Me@50 119 //Q: should give masterVP core-specific info as its init data?
Me@53 120 masterVPs[ coreIdx ] = VMS__create_procr( &masterLoop, masterEnv );
Me@31 121 masterVPs[ coreIdx ]->coreAnimatedBy = coreIdx;
Me@31 122 allSchedSlots[ coreIdx ] = create_sched_slots(); //makes for one core
Me@53 123 _VMSMasterEnv->numMasterInARow[ coreIdx ] = 0;
Me@55 124 _VMSMasterEnv->workStealingGates[ coreIdx ] = NULL;
Me@31 125 }
Me@31 126 _VMSMasterEnv->readyToAnimateQs = readyToAnimateQs;
Me@31 127 _VMSMasterEnv->masterVPs = masterVPs;
Me@50 128 _VMSMasterEnv->masterLock = UNLOCKED;
Me@31 129 _VMSMasterEnv->allSchedSlots = allSchedSlots;
Me@55 130 _VMSMasterEnv->workStealingLock = UNLOCKED;
Me@28 131
Me@12 132
Me@31 133 //Aug 19, 2010: no longer need to place initial masterVP into queue
Me@31 134 // because coreLoop now controls -- animates its masterVP when no work
Me@31 135
Me@30 136
Me@50 137 //============================= MEASUREMENT STUFF ========================
Me@50 138 #ifdef STATS__TURN_ON_PROBES
Me@50 139 _VMSMasterEnv->dynIntervalProbesInfo =
Me@53 140 makePrivDynArrayOfSize( &(_VMSMasterEnv->intervalProbes), 200);
Me@30 141
Me@53 142 _VMSMasterEnv->probeNameHashTbl = makeHashTable( 1000, &VMS__free );
Me@53 143
Me@53 144 //put creation time directly into master env, for fast retrieval
Me@50 145 struct timeval timeStamp;
Me@50 146 gettimeofday( &(timeStamp), NULL);
Me@50 147 _VMSMasterEnv->createPtInSecs =
Me@50 148 timeStamp.tv_sec +(timeStamp.tv_usec/1000000.0);
Me@50 149 #endif
Me@50 150 //========================================================================
Me@38 151
Me@0 152 }
Me@0 153
Me@31 154 SchedSlot **
Me@31 155 create_sched_slots()
Me@31 156 { SchedSlot **schedSlots;
Me@0 157 int i;
Me@0 158
Me@53 159 schedSlots = VMS__malloc( NUM_SCHED_SLOTS * sizeof(SchedSlot *) );
Me@8 160
Me@1 161 for( i = 0; i < NUM_SCHED_SLOTS; i++ )
Me@0 162 {
Me@53 163 schedSlots[i] = VMS__malloc( sizeof(SchedSlot) );
Me@8 164
Me@1 165 //Set state to mean "handling requests done, slot needs filling"
Me@8 166 schedSlots[i]->workIsDone = FALSE;
Me@8 167 schedSlots[i]->needsProcrAssigned = TRUE;
Me@0 168 }
Me@31 169 return schedSlots;
Me@31 170 }
Me@31 171
Me@31 172
Me@31 173 void
Me@31 174 freeSchedSlots( SchedSlot **schedSlots )
Me@31 175 { int i;
Me@31 176 for( i = 0; i < NUM_SCHED_SLOTS; i++ )
Me@31 177 {
Me@53 178 VMS__free( schedSlots[i] );
Me@31 179 }
Me@53 180 VMS__free( schedSlots );
Me@0 181 }
Me@0 182
Me@8 183
Me@28 184 void
Me@28 185 create_the_coreLoop_OS_threads()
Me@28 186 {
Me@28 187 //========================================================================
Me@28 188 // Create the Threads
Me@28 189 int coreIdx, retCode;
Me@28 190
Me@28 191 //Need the threads to be created suspended, and wait for a signal
Me@28 192 // before proceeding -- gives time after creating to initialize other
Me@28 193 // stuff before the coreLoops set off.
Me@28 194 _VMSMasterEnv->setupComplete = 0;
Me@28 195
Me@28 196 //Make the threads that animate the core loops
Me@28 197 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
Me@53 198 { coreLoopThdParams[coreIdx] = VMS__malloc( sizeof(ThdParams) );
Me@28 199 coreLoopThdParams[coreIdx]->coreNum = coreIdx;
Me@28 200
Me@28 201 retCode =
Me@28 202 pthread_create( &(coreLoopThdHandles[coreIdx]),
Me@28 203 thdAttrs,
Me@28 204 &coreLoop,
Me@28 205 (void *)(coreLoopThdParams[coreIdx]) );
Me@50 206 if(retCode){printf("ERROR creating thread: %d\n", retCode); exit(1);}
Me@28 207 }
Me@28 208 }
Me@28 209
Me@0 210 /*Semantic layer calls this when it want the system to start running..
Me@0 211 *
Me@24 212 *This starts the core loops running then waits for them to exit.
Me@0 213 */
Me@12 214 void
Me@24 215 VMS__start_the_work_then_wait_until_done()
Me@12 216 { int coreIdx;
Me@24 217 //Start the core loops running
Me@25 218
Me@25 219 //tell the core loop threads that setup is complete
Me@25 220 //get lock, to lock out any threads still starting up -- they'll see
Me@25 221 // that setupComplete is true before entering while loop, and so never
Me@25 222 // wait on the condition
Me@26 223 pthread_mutex_lock( &suspendLock );
Me@25 224 _VMSMasterEnv->setupComplete = 1;
Me@26 225 pthread_mutex_unlock( &suspendLock );
Me@26 226 pthread_cond_broadcast( &suspend_cond );
Me@25 227
Me@25 228
Me@24 229 //wait for all to complete
Me@8 230 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
Me@8 231 {
Me@25 232 pthread_join( coreLoopThdHandles[coreIdx], NULL );
Me@24 233 }
Me@25 234
Me@24 235 //NOTE: do not clean up VMS env here -- semantic layer has to have
Me@24 236 // a chance to clean up its environment first, then do a call to free
Me@24 237 // the Master env and rest of VMS locations
Me@8 238 }
Me@0 239
Me@28 240 /*Only difference between version with an OS thread pinned to each core and
Me@28 241 * the sequential version of VMS is VMS__init_Seq, this, and coreLoop_Seq.
Me@28 242 */
Me@28 243 void
Me@28 244 VMS__start_the_work_then_wait_until_done_Seq()
Me@28 245 {
Me@28 246 //Instead of un-suspending threads, just call the one and only
Me@28 247 // core loop (sequential version), in the main thread.
Me@28 248 coreLoop_Seq( NULL );
Me@28 249
Me@28 250 }
Me@28 251
Me@0 252
Me@0 253
Me@8 254 /*Create stack, then create __cdecl structure on it and put initialData and
Me@8 255 * pointer to the new structure instance into the parameter positions on
Me@8 256 * the stack
Me@8 257 *Then put function pointer into nextInstrPt -- the stack is setup in std
Me@8 258 * call structure, so jumping to function ptr is same as a GCC generated
Me@8 259 * function call
Me@8 260 *No need to save registers on old stack frame, because there's no old
Me@8 261 * animator state to return to --
Me@8 262 *
Me@8 263 */
Me@50 264 inline VirtProcr *
Me@50 265 create_procr_helper( VirtProcr *newPr, VirtProcrFnPtr fnPtr,
Me@50 266 void *initialData, char *stackLocs )
Me@50 267 {
Me@50 268 char *stackPtr;
Me@8 269
Me@53 270 newPr->startOfStack = stackLocs;
Me@53 271 newPr->procrID = _VMSMasterEnv->numProcrsCreated++;
Me@53 272 newPr->nextInstrPt = fnPtr;
Me@53 273 newPr->initialData = initialData;
Me@53 274 newPr->requests = NULL;
Me@53 275 newPr->schedSlot = NULL;
Me@8 276
Me@14 277 //fnPtr takes two params -- void *initData & void *animProcr
Me@8 278 //alloc stack locations, make stackPtr be the highest addr minus room
Me@14 279 // for 2 params + return addr. Return addr (NULL) is in loc pointed to
Me@14 280 // by stackPtr, initData at stackPtr + 4 bytes, animatingPr just above
Me@22 281 stackPtr = ( (char *)stackLocs + VIRT_PROCR_STACK_SIZE - 0x10 );
Me@50 282
Me@8 283 //setup __cdecl on stack -- coreloop will switch to stackPtr before jmp
Me@22 284 *( (int *)stackPtr + 2 ) = (int) newPr; //rightmost param -- 32bit pointer
Me@14 285 *( (int *)stackPtr + 1 ) = (int) initialData; //next param to left
Me@8 286 newPr->stackPtr = stackPtr; //core loop will switch to this, then
Me@8 287 newPr->framePtr = stackPtr; //suspend loop will save new stack & frame ptr
Me@8 288
Me@50 289 //============================= MEASUREMENT STUFF ========================
Me@50 290 #ifdef STATS__TURN_ON_PROBES
Me@50 291 struct timeval timeStamp;
Me@50 292 gettimeofday( &(timeStamp), NULL);
Me@54 293 newPr->createPtInSecs = timeStamp.tv_sec +(timeStamp.tv_usec/1000000.0) -
Me@54 294 _VMSMasterEnv->createPtInSecs;
Me@50 295 #endif
Me@50 296 //========================================================================
Me@50 297
Me@8 298 return newPr;
Me@8 299 }
Me@8 300
Me@50 301 inline VirtProcr *
Me@50 302 VMS__create_procr( VirtProcrFnPtr fnPtr, void *initialData )
Me@50 303 { VirtProcr *newPr;
Me@50 304 char *stackLocs;
Me@50 305
Me@50 306 newPr = VMS__malloc( sizeof(VirtProcr) );
Me@50 307 stackLocs = VMS__malloc( VIRT_PROCR_STACK_SIZE );
Me@50 308 if( stackLocs == 0 )
Me@50 309 { perror("VMS__malloc stack"); exit(1); }
Me@50 310
Me@50 311 return create_procr_helper( newPr, fnPtr, initialData, stackLocs );
Me@50 312 }
Me@50 313
Me@50 314 /* "ext" designates that it's for use outside the VMS system -- should only
Me@50 315 * be called from main thread or other thread -- never from code animated by
Me@50 316 * a VMS virtual processor.
Me@50 317 */
Me@50 318 inline VirtProcr *
Me@50 319 VMS_ext__create_procr( VirtProcrFnPtr fnPtr, void *initialData )
Me@50 320 { VirtProcr *newPr;
Me@50 321 char *stackLocs;
Me@50 322
Me@50 323 newPr = malloc( sizeof(VirtProcr) );
Me@50 324 stackLocs = malloc( VIRT_PROCR_STACK_SIZE );
Me@50 325 if( stackLocs == 0 )
Me@50 326 { perror("malloc stack"); exit(1); }
Me@50 327
Me@50 328 return create_procr_helper( newPr, fnPtr, initialData, stackLocs );
Me@50 329 }
Me@50 330
Me@8 331
Me@26 332 /*there is a label inside this function -- save the addr of this label in
Me@0 333 * the callingPr struc, as the pick-up point from which to start the next
Me@0 334 * work-unit for that procr. If turns out have to save registers, then
Me@0 335 * save them in the procr struc too. Then do assembly jump to the CoreLoop's
Me@0 336 * "done with work-unit" label. The procr struc is in the request in the
Me@0 337 * slave that animated the just-ended work-unit, so all the state is saved
Me@0 338 * there, and will get passed along, inside the request handler, to the
Me@0 339 * next work-unit for that procr.
Me@0 340 */
Me@8 341 void
Me@38 342 VMS__suspend_procr( VirtProcr *animatingPr )
Me@55 343 {
Me@0 344
Me@14 345 //The request to master will cause this suspended virt procr to get
Me@14 346 // scheduled again at some future point -- to resume, core loop jumps
Me@14 347 // to the resume point (below), which causes restore of saved regs and
Me@14 348 // "return" from this call.
Me@38 349 animatingPr->nextInstrPt = &&ResumePt;
Me@1 350
Me@1 351 //return ownership of the virt procr and sched slot to Master virt pr
Me@38 352 animatingPr->schedSlot->workIsDone = TRUE;
Me@1 353
Me@41 354 //=========================== Measurement stuff ========================
Me@38 355 #ifdef MEAS__TIME_STAMP_SUSP
Me@41 356 //record time stamp: compare to time-stamp recorded below
Me@38 357 saveLowTimeStampCountInto( animatingPr->preSuspTSCLow );
Me@38 358 #endif
Me@41 359 //=======================================================================
Me@38 360
Me@62 361 /* VirtProcr offsets:
Me@62 362 * 0xc stackPtr
Me@62 363 * 0x10 framePtr
Me@62 364 * 0x14 nextInstrPt
Me@62 365 * 0x1c coreLoopFramePtr
Me@62 366 * 0x20 coreLoopStackPtr
Me@62 367 *
Me@62 368 * _VMSMasterEnv offsets:
Me@62 369 * 0x24 coreLoopStartPt
Me@62 370 * 0x28 coreLoopEndPt
Me@62 371 * 0x30 masterLock
Me@62 372 */
Me@62 373 // SwitchToCoreLoop( animatingPr )
Me@62 374 asm volatile("movl %0, %%ebx; \
Me@62 375 movl %1, %%ecx; \
Me@62 376 movl %%esp, 0x0c(%%ecx); \
Me@62 377 movl %%ebp, 0x10(%%ecx); \
Me@62 378 movl 0x24(%%ebx), %%eax; \
Me@62 379 movl 0x20(%%ecx), %%esp; \
Me@62 380 movl 0x1c(%%ecx), %%ebp; \
Me@62 381 jmp %%eax" \
Me@62 382 /* outputs */ : \
Me@62 383 /* inputs */ : "g"(_VMSMasterEnv), "g"(animatingPr) \
Me@62 384 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi", "%esi" \
Me@62 385 );
Me@1 386
Me@62 387 // asm volatile("mov %0,%%ebx; \
Me@62 388 mov %%ebx, %%eax; \
Me@62 389 add $0xc, %%eax; \
Me@62 390 movl %%esp, (%%eax); \
Me@62 391 mov %%ebx, %%eax; \
Me@62 392 add $0x10, %%eax; \
Me@62 393 movl %%ebp, (%%eax); \
Me@62 394 movl %1, %%eax; \
Me@62 395 movl %2, %%esp; \
Me@62 396 movl %3, %%ebp; \
Me@62 397 jmp %%eax" \
Me@62 398 /* outputs */ : \
Me@62 399 /* inputs */ : "g"(animatingPr), "g" (jmpPt), "g" (coreLoopStackPtr), \
Me@62 400 "g" (coreLoopFramePtr) \
Me@62 401 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi", "%esi" \
Me@62 402 );
Me@55 403
Me@55 404 //=======================================================================
Me@1 405 ResumePt:
Me@38 406 #ifdef MEAS__TIME_STAMP_SUSP
Me@41 407 //NOTE: only take low part of count -- do sanity check when take diff
Me@38 408 saveLowTimeStampCountInto( animatingPr->postSuspTSCLow );
Me@38 409 #endif
Me@38 410
Me@0 411 return;
Me@0 412 }
Me@0 413
Me@22 414
Me@22 415
Me@50 416 /*For this implementation of VMS, it may not make much sense to have the
Me@50 417 * system of requests for creating a new processor done this way.. but over
Me@50 418 * the scope of single-master, multi-master, mult-tasking, OS-implementing,
Me@50 419 * distributed-memory, and so on, this gives VMS implementation a chance to
Me@50 420 * do stuff before suspend, in the AppVP, and in the Master before the plugin
Me@50 421 * is called, as well as in the lang-lib before this is called, and in the
Me@50 422 * plugin. So, this gives both VMS and language implementations a chance to
Me@50 423 * intercept at various points and do order-dependent stuff.
Me@50 424 *Having a standard VMSNewPrReqData struc allows the language to create and
Me@50 425 * free the struc, while VMS knows how to get the newPr if it wants it, and
Me@50 426 * it lets the lang have lang-specific data related to creation transported
Me@50 427 * to the plugin.
Me@50 428 */
Me@50 429 void
Me@50 430 VMS__send_create_procr_req( void *semReqData, VirtProcr *reqstingPr )
Me@50 431 { VMSReqst req;
Me@50 432
Me@50 433 req.reqType = createReq;
Me@50 434 req.semReqData = semReqData;
Me@50 435 req.nextReqst = reqstingPr->requests;
Me@50 436 reqstingPr->requests = &req;
Me@50 437
Me@50 438 VMS__suspend_procr( reqstingPr );
Me@50 439 }
Me@50 440
Me@22 441
Me@38 442 /*
Me@22 443 *This adds a request to dissipate, then suspends the processor so that the
Me@22 444 * request handler will receive the request. The request handler is what
Me@22 445 * does the work of freeing memory and removing the processor from the
Me@22 446 * semantic environment's data structures.
Me@22 447 *The request handler also is what figures out when to shutdown the VMS
Me@22 448 * system -- which causes all the core loop threads to die, and returns from
Me@22 449 * the call that started up VMS to perform the work.
Me@22 450 *
Me@22 451 *This form is a bit misleading to understand if one is trying to figure out
Me@22 452 * how VMS works -- it looks like a normal function call, but inside it
Me@22 453 * sends a request to the request handler and suspends the processor, which
Me@22 454 * jumps out of the VMS__dissipate_procr function, and out of all nestings
Me@22 455 * above it, transferring the work of dissipating to the request handler,
Me@22 456 * which then does the actual work -- causing the processor that animated
Me@22 457 * the call of this function to disappear and the "hanging" state of this
Me@22 458 * function to just poof into thin air -- the virtual processor's trace
Me@22 459 * never returns from this call, but instead the virtual processor's trace
Me@22 460 * gets suspended in this call and all the virt processor's state disap-
Me@22 461 * pears -- making that suspend the last thing in the virt procr's trace.
Me@8 462 */
Me@8 463 void
Me@53 464 VMS__send_dissipate_req( VirtProcr *procrToDissipate )
Me@50 465 { VMSReqst req;
Me@22 466
Me@50 467 req.reqType = dissipate;
Me@50 468 req.nextReqst = procrToDissipate->requests;
Me@50 469 procrToDissipate->requests = &req;
Me@50 470
Me@22 471 VMS__suspend_procr( procrToDissipate );
Me@50 472 }
Me@50 473
Me@50 474
Me@50 475 /* "ext" designates that it's for use outside the VMS system -- should only
Me@50 476 * be called from main thread or other thread -- never from code animated by
Me@50 477 * a VMS virtual processor.
Me@50 478 *
Me@50 479 *Use this version to dissipate VPs created outside the VMS system.
Me@50 480 */
Me@50 481 void
Me@50 482 VMS_ext__dissipate_procr( VirtProcr *procrToDissipate )
Me@50 483 {
Me@50 484 //NOTE: initialData was given to the processor, so should either have
Me@50 485 // been alloc'd with VMS__malloc, or freed by the level above animPr.
Me@50 486 //So, all that's left to free here is the stack and the VirtProcr struc
Me@50 487 // itself
Me@50 488 //Note, should not stack-allocate initial data -- no guarantee, in
Me@50 489 // general that creating processor will outlive ones it creates.
Me@50 490 free( procrToDissipate->startOfStack );
Me@50 491 free( procrToDissipate );
Me@50 492 }
Me@50 493
Me@22 494
Me@22 495
Me@53 496 /*This call's name indicates that request is malloc'd -- so req handler
Me@53 497 * has to free any extra requests tacked on before a send, using this.
Me@53 498 *
Me@53 499 * This inserts the semantic-layer's request data into standard VMS carrier
Me@53 500 * request data-struct that is mallocd. The sem request doesn't need to
Me@53 501 * be malloc'd if this is called inside the same call chain before the
Me@53 502 * send of the last request is called.
Me@53 503 *
Me@53 504 *The request handler has to call VMS__free_VMSReq for any of these
Me@22 505 */
Me@22 506 inline void
Me@53 507 VMS__add_sem_request_in_mallocd_VMSReqst( void *semReqData,
Me@53 508 VirtProcr *callingPr )
Me@53 509 { VMSReqst *req;
Me@22 510
Me@53 511 req = VMS__malloc( sizeof(VMSReqst) );
Me@53 512 req->reqType = semantic;
Me@53 513 req->semReqData = semReqData;
Me@53 514 req->nextReqst = callingPr->requests;
Me@53 515 callingPr->requests = req;
Me@22 516 }
Me@22 517
Me@50 518 /*This inserts the semantic-layer's request data into standard VMS carrier
Me@50 519 * request data-struct is allocated on stack of this call & ptr to it sent
Me@50 520 * to plugin
Me@50 521 *Then it does suspend, to cause request to be sent.
Me@50 522 */
Me@50 523 inline void
Me@50 524 VMS__send_sem_request( void *semReqData, VirtProcr *callingPr )
Me@50 525 { VMSReqst req;
Me@22 526
Me@50 527 req.reqType = semantic;
Me@50 528 req.semReqData = semReqData;
Me@50 529 req.nextReqst = callingPr->requests;
Me@50 530 callingPr->requests = &req;
Me@50 531
Me@50 532 VMS__suspend_procr( callingPr );
Me@50 533 }
Me@50 534
Me@50 535
Me@50 536 inline void
Me@50 537 VMS__send_VMSSem_request( void *semReqData, VirtProcr *callingPr )
Me@50 538 { VMSReqst req;
Me@50 539
Me@50 540 req.reqType = VMSSemantic;
Me@50 541 req.semReqData = semReqData;
Me@50 542 req.nextReqst = callingPr->requests; //gab any other preceeding
Me@50 543 callingPr->requests = &req;
Me@50 544
Me@50 545 VMS__suspend_procr( callingPr );
Me@50 546 }
Me@50 547
Me@50 548
Me@50 549 /*
Me@38 550 */
Me@24 551 VMSReqst *
Me@50 552 VMS__take_next_request_out_of( VirtProcr *procrWithReq )
Me@31 553 { VMSReqst *req;
Me@31 554
Me@31 555 req = procrWithReq->requests;
Me@38 556 if( req == NULL ) return NULL;
Me@31 557
Me@31 558 procrWithReq->requests = procrWithReq->requests->nextReqst;
Me@50 559 return req;
Me@24 560 }
Me@22 561
Me@24 562
Me@24 563 inline void *
Me@24 564 VMS__take_sem_reqst_from( VMSReqst *req )
Me@24 565 {
Me@24 566 return req->semReqData;
Me@24 567 }
Me@24 568
Me@24 569
Me@24 570
Me@50 571 /* This is for OS requests and VMS infrastructure requests, such as to create
Me@50 572 * a probe -- a probe is inside the heart of VMS-core, it's not part of any
Me@50 573 * language -- but it's also a semantic thing that's triggered from and used
Me@50 574 * in the application.. so it crosses abstractions.. so, need some special
Me@50 575 * pattern here for handling such requests.
Me@52 576 * Doing this just like it were a second language sharing VMS-core.
Me@52 577 *
Me@50 578 * This is called from the language's request handler when it sees a request
Me@50 579 * of type VMSSemReq
Me@52 580 *
Me@52 581 * TODO: Later change this, to give probes their own separate plugin & have
Me@52 582 * VMS-core steer the request to appropriate plugin
Me@52 583 * Do the same for OS calls -- look later at it..
Me@50 584 */
Me@50 585 void inline
Me@50 586 VMS__handle_VMSSemReq( VMSReqst *req, VirtProcr *requestingPr, void *semEnv,
Me@50 587 ResumePrFnPtr resumePrFnPtr )
Me@50 588 { VMSSemReq *semReq;
Me@50 589 IntervalProbe *newProbe;
Me@50 590 int32 nameLen;
Me@24 591
Me@50 592 semReq = req->semReqData;
Me@24 593
Me@50 594 newProbe = VMS__malloc( sizeof(IntervalProbe) );
Me@50 595 nameLen = strlen( semReq->nameStr );
Me@50 596 newProbe->nameStr = VMS__malloc( nameLen );
Me@50 597 memcpy( newProbe->nameStr, semReq->nameStr, nameLen );
Me@50 598 newProbe->hist = NULL;
Me@50 599 newProbe->schedChoiceWasRecorded = FALSE;
Me@53 600
Me@53 601 //This runs in masterVP, so no race-condition worries
Me@50 602 newProbe->probeID =
Me@50 603 addToDynArray( newProbe, _VMSMasterEnv->dynIntervalProbesInfo );
Me@50 604
Me@53 605 requestingPr->dataRetFromReq = newProbe;
Me@50 606
Me@50 607 (*resumePrFnPtr)( requestingPr, semEnv );
Me@22 608 }
Me@22 609
Me@22 610
Me@22 611
Me@24 612 /*This must be called by the request handler plugin -- it cannot be called
Me@24 613 * from the semantic library "dissipate processor" function -- instead, the
Me@50 614 * semantic layer has to generate a request, and the plug-in calls this
Me@24 615 * function.
Me@24 616 *The reason is that this frees the virtual processor's stack -- which is
Me@24 617 * still in use inside semantic library calls!
Me@24 618 *
Me@24 619 *This frees or recycles all the state owned by and comprising the VMS
Me@24 620 * portion of the animating virtual procr. The request handler must first
Me@24 621 * free any semantic data created for the processor that didn't use the
Me@24 622 * VMS_malloc mechanism. Then it calls this, which first asks the malloc
Me@24 623 * system to disown any state that did use VMS_malloc, and then frees the
Me@24 624 * statck and the processor-struct itself.
Me@24 625 *If the dissipated processor is the sole (remaining) owner of VMS__malloc'd
Me@24 626 * state, then that state gets freed (or sent to recycling) as a side-effect
Me@24 627 * of dis-owning it.
Me@24 628 */
Me@24 629 void
Me@53 630 VMS__dissipate_procr( VirtProcr *animatingPr )
Me@24 631 {
Me@24 632 //dis-own all locations owned by this processor, causing to be freed
Me@24 633 // any locations that it is (was) sole owner of
Me@29 634 //TODO: implement VMS__malloc system, including "give up ownership"
Me@24 635
Me@24 636
Me@24 637 //NOTE: initialData was given to the processor, so should either have
Me@24 638 // been alloc'd with VMS__malloc, or freed by the level above animPr.
Me@24 639 //So, all that's left to free here is the stack and the VirtProcr struc
Me@24 640 // itself
Me@50 641 //Note, should not stack-allocate initial data -- no guarantee, in
Me@50 642 // general that creating processor will outlive ones it creates.
Me@50 643 VMS__free( animatingPr->startOfStack );
Me@50 644 VMS__free( animatingPr );
Me@24 645 }
Me@24 646
Me@24 647
Me@53 648 //TODO: look at architecting cleanest separation between request handler
Me@29 649 // and master loop, for dissipate, create, shutdown, and other non-semantic
Me@29 650 // requests. Issue is chain: one removes requests from AppVP, one dispatches
Me@29 651 // on type of request, and one handles each type.. but some types require
Me@29 652 // action from both request handler and master loop -- maybe just give the
Me@29 653 // request handler calls like: VMS__handle_X_request_type
Me@24 654
Me@29 655
Me@29 656 /*This is called by the semantic layer's request handler when it decides its
Me@29 657 * time to shut down the VMS system. Calling this causes the core loop OS
Me@29 658 * threads to exit, which unblocks the entry-point function that started up
Me@29 659 * VMS, and allows it to grab the result and return to the original single-
Me@29 660 * threaded application.
Me@22 661 *
Me@29 662 *The _VMSMasterEnv is needed by this shut down function, so the create-seed-
Me@29 663 * and-wait function has to free a bunch of stuff after it detects the
Me@29 664 * threads have all died: the masterEnv, the thread-related locations,
Me@29 665 * masterVP any AppVPs that might still be allocated and sitting in the
Me@29 666 * semantic environment, or have been orphaned in the _VMSWorkQ.
Me@29 667 *
Me@53 668 *NOTE: the semantic plug-in is expected to use VMS__malloc to get all the
Me@29 669 * locations it needs, and give ownership to masterVP. Then, they will be
Me@53 670 * automatically freed.
Me@22 671 *
Me@29 672 *In here,create one core-loop shut-down processor for each core loop and put
Me@31 673 * them all directly into the readyToAnimateQ.
Me@29 674 *Note, this function can ONLY be called after the semantic environment no
Me@29 675 * longer cares if AppVPs get animated after the point this is called. In
Me@29 676 * other words, this can be used as an abort, or else it should only be
Me@29 677 * called when all AppVPs have finished dissipate requests -- only at that
Me@29 678 * point is it sure that all results have completed.
Me@22 679 */
Me@22 680 void
Me@53 681 VMS__shutdown()
Me@8 682 { int coreIdx;
Me@14 683 VirtProcr *shutDownPr;
Me@22 684
Me@29 685 //create the shutdown processors, one for each core loop -- put them
Me@31 686 // directly into the Q -- each core will die when gets one
Me@8 687 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
Me@50 688 { //Note, this is running in the master
Me@29 689 shutDownPr = VMS__create_procr( &endOSThreadFn, NULL );
Me@55 690 writeVMSQ( shutDownPr, _VMSMasterEnv->readyToAnimateQs[coreIdx] );
Me@8 691 }
Me@22 692
Me@12 693 }
Me@12 694
Me@12 695
Me@29 696 /*Am trying to be cute, avoiding IF statement in coreLoop that checks for
Me@29 697 * a special shutdown procr. Ended up with extra-complex shutdown sequence.
Me@29 698 *This function has the sole purpose of setting the stack and framePtr
Me@29 699 * to the coreLoop's stack and framePtr.. it does that then jumps to the
Me@29 700 * core loop's shutdown point -- might be able to just call Pthread_exit
Me@30 701 * from here, but am going back to the pthread's stack and setting everything
Me@29 702 * up just as if it never jumped out, before calling pthread_exit.
Me@29 703 *The end-point of core loop will free the stack and so forth of the
Me@29 704 * processor that animates this function, (this fn is transfering the
Me@29 705 * animator of the AppVP that is in turn animating this function over
Me@29 706 * to core loop function -- note that this slices out a level of virtual
Me@29 707 * processors).
Me@29 708 */
Me@29 709 void
Me@29 710 endOSThreadFn( void *initData, VirtProcr *animatingPr )
Me@29 711 { void *jmpPt, *coreLoopStackPtr, *coreLoopFramePtr;
Me@29 712
Me@29 713 jmpPt = _VMSMasterEnv->coreLoopEndPt;
Me@29 714 coreLoopStackPtr = animatingPr->coreLoopStackPtr;
Me@29 715 coreLoopFramePtr = animatingPr->coreLoopFramePtr;
Me@29 716
Me@29 717
Me@29 718 asm volatile("movl %0, %%eax; \
Me@29 719 movl %1, %%esp; \
Me@29 720 movl %2, %%ebp; \
Me@29 721 jmp %%eax " \
Me@29 722 /* outputs */ : \
Me@29 723 /* inputs */ : "m" (jmpPt), "m"(coreLoopStackPtr), "m"(coreLoopFramePtr)\
Me@29 724 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi","%esi" \
Me@29 725 );
Me@29 726 }
Me@29 727
Me@29 728
Me@53 729 /*This is called from the startup & shutdown
Me@24 730 */
Me@24 731 void
Me@53 732 VMS__cleanup_at_end_of_shutdown()
Me@31 733 {
Me@55 734 VMSQueueStruc **readyToAnimateQs;
Me@31 735 int coreIdx;
Me@31 736 VirtProcr **masterVPs;
Me@31 737 SchedSlot ***allSchedSlots; //ptr to array of ptrs
Me@31 738
Me@53 739 //All the environment data has been allocated with VMS__malloc, so just
Me@53 740 // free its internal big-chunk and all inside it disappear.
Me@53 741 /*
Me@31 742 readyToAnimateQs = _VMSMasterEnv->readyToAnimateQs;
Me@31 743 masterVPs = _VMSMasterEnv->masterVPs;
Me@31 744 allSchedSlots = _VMSMasterEnv->allSchedSlots;
Me@31 745
Me@31 746 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
Me@24 747 {
Me@55 748 freeVMSQ( readyToAnimateQs[ coreIdx ] );
Me@50 749 //master VPs were created external to VMS, so use external free
Me@53 750 VMS__dissipate_procr( masterVPs[ coreIdx ] );
Me@31 751
Me@31 752 freeSchedSlots( allSchedSlots[ coreIdx ] );
Me@24 753 }
Me@31 754
Me@53 755 VMS__free( _VMSMasterEnv->readyToAnimateQs );
Me@53 756 VMS__free( _VMSMasterEnv->masterVPs );
Me@53 757 VMS__free( _VMSMasterEnv->allSchedSlots );
Me@50 758
Me@50 759 //============================= MEASUREMENT STUFF ========================
Me@50 760 #ifdef STATS__TURN_ON_PROBES
Me@53 761 freeDynArrayDeep( _VMSMasterEnv->dynIntervalProbesInfo, &VMS__free_probe);
Me@50 762 #endif
Me@50 763 //========================================================================
Me@53 764 */
Me@53 765 //These are the only two that use system free
Me@53 766 VMS_ext__free_free_list( _VMSMasterEnv->freeListHead );
Me@53 767 free( (void *)_VMSMasterEnv );
Me@24 768 }
Me@24 769
Me@54 770
Me@54 771 //================================
Me@54 772
Me@54 773
Me@54 774 /*Later, improve this -- for now, just exits the application after printing
Me@54 775 * the error message.
Me@54 776 */
Me@54 777 void
Me@54 778 VMS__throw_exception( char *msgStr, VirtProcr *reqstPr, VMSExcp *excpData )
Me@54 779 {
Me@54 780 printf(msgStr);
Me@54 781 fflush(stdin);
Me@54 782 exit(1);
Me@54 783 }
Me@54 784
Me@54 785
Me@54 786