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