Mercurial > cgi-bin > hgwebdir.cgi > VMS > VMS_Implementations > VMS_impls > VMS__MC_shared_impl
view VMS.c @ 69:11bfe9d136ed
removed warnings
| author | Merten Sach <msach@mailbox.tu-berlin.de> |
|---|---|
| date | Wed, 11 May 2011 16:13:24 +0200 |
| parents | 9c3107044f86 |
| children | f9b60012fd74 5ff1631c26ed |
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();
105 //============================= MEASUREMENT STUFF ========================
106 #ifdef MEAS__TIME_MALLOC
107 _VMSMasterEnv->mallocTimeHist = makeFixedBinHistExt( 50, 0, 100,
108 "malloc time hist");
109 _VMSMasterEnv->freeTimeHist = makeFixedBinHistExt( 50, 0, 100,
110 "free time hist");
111 #endif
112 #ifdef MEAS__TIME_PLUGIN
113 _VMSMasterEnv->reqHdlrLowTimeHist = makeFixedBinHistExt( 50, 0, 10,
114 "plugin low time hist");
115 _VMSMasterEnv->reqHdlrHighTimeHist = makeFixedBinHistExt( 50, 0, 100,
116 "plugin high time hist");
117 #endif
118 //========================================================================
120 //===================== Only VMS__malloc after this ====================
121 masterEnv = (MasterEnv*)_VMSMasterEnv;
123 //Make a readyToAnimateQ for each core loop
124 readyToAnimateQs = VMS__malloc( NUM_CORES * sizeof(VMSQueueStruc *) );
125 masterVPs = VMS__malloc( NUM_CORES * sizeof(VirtProcr *) );
127 //One array for each core, 3 in array, core's masterVP scheds all
128 allSchedSlots = VMS__malloc( NUM_CORES * sizeof(SchedSlot *) );
130 _VMSMasterEnv->numProcrsCreated = 0; //used by create procr
131 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
132 {
133 readyToAnimateQs[ coreIdx ] = makeVMSQ();
135 //Q: should give masterVP core-specific info as its init data?
136 masterVPs[ coreIdx ] = VMS__create_procr( &masterLoop, masterEnv );
137 masterVPs[ coreIdx ]->coreAnimatedBy = coreIdx;
138 allSchedSlots[ coreIdx ] = create_sched_slots(); //makes for one core
139 _VMSMasterEnv->numMasterInARow[ coreIdx ] = 0;
140 _VMSMasterEnv->workStealingGates[ coreIdx ] = NULL;
141 }
142 _VMSMasterEnv->readyToAnimateQs = readyToAnimateQs;
143 _VMSMasterEnv->masterVPs = masterVPs;
144 _VMSMasterEnv->masterLock = UNLOCKED;
145 _VMSMasterEnv->allSchedSlots = allSchedSlots;
146 _VMSMasterEnv->workStealingLock = UNLOCKED;
149 //Aug 19, 2010: no longer need to place initial masterVP into queue
150 // because coreLoop now controls -- animates its masterVP when no work
153 //============================= MEASUREMENT STUFF ========================
154 #ifdef STATS__TURN_ON_PROBES
155 _VMSMasterEnv->dynIntervalProbesInfo =
156 makePrivDynArrayOfSize( (void***)&(_VMSMasterEnv->intervalProbes), 200);
158 _VMSMasterEnv->probeNameHashTbl = makeHashTable( 1000, &VMS__free );
160 //put creation time directly into master env, for fast retrieval
161 struct timeval timeStamp;
162 gettimeofday( &(timeStamp), NULL);
163 _VMSMasterEnv->createPtInSecs =
164 timeStamp.tv_sec +(timeStamp.tv_usec/1000000.0);
165 #endif
166 #ifdef MEAS__TIME_MASTER_LOCK
167 _VMSMasterEnv->masterLockLowTimeHist = makeFixedBinHist( 50, 0, 2,
168 "master lock low time hist");
169 _VMSMasterEnv->masterLockHighTimeHist = makeFixedBinHist( 50, 0, 100,
170 "master lock high time hist");
171 #endif
173 MakeTheMeasHists
174 //========================================================================
176 }
178 SchedSlot **
179 create_sched_slots()
180 { SchedSlot **schedSlots;
181 int i;
183 schedSlots = VMS__malloc( NUM_SCHED_SLOTS * sizeof(SchedSlot *) );
185 for( i = 0; i < NUM_SCHED_SLOTS; i++ )
186 {
187 schedSlots[i] = VMS__malloc( sizeof(SchedSlot) );
189 //Set state to mean "handling requests done, slot needs filling"
190 schedSlots[i]->workIsDone = FALSE;
191 schedSlots[i]->needsProcrAssigned = TRUE;
192 }
193 return schedSlots;
194 }
197 void
198 freeSchedSlots( SchedSlot **schedSlots )
199 { int i;
200 for( i = 0; i < NUM_SCHED_SLOTS; i++ )
201 {
202 VMS__free( schedSlots[i] );
203 }
204 VMS__free( schedSlots );
205 }
208 void
209 create_the_coreLoop_OS_threads()
210 {
211 //========================================================================
212 // Create the Threads
213 int coreIdx, retCode;
215 //Need the threads to be created suspended, and wait for a signal
216 // before proceeding -- gives time after creating to initialize other
217 // stuff before the coreLoops set off.
218 _VMSMasterEnv->setupComplete = 0;
220 //Make the threads that animate the core loops
221 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
222 { coreLoopThdParams[coreIdx] = VMS__malloc( sizeof(ThdParams) );
223 coreLoopThdParams[coreIdx]->coreNum = coreIdx;
225 retCode =
226 pthread_create( &(coreLoopThdHandles[coreIdx]),
227 thdAttrs,
228 &coreLoop,
229 (void *)(coreLoopThdParams[coreIdx]) );
230 if(retCode){printf("ERROR creating thread: %d\n", retCode); exit(1);}
231 }
232 }
234 /*Semantic layer calls this when it want the system to start running..
235 *
236 *This starts the core loops running then waits for them to exit.
237 */
238 void
239 VMS__start_the_work_then_wait_until_done()
240 { int coreIdx;
241 //Start the core loops running
243 //tell the core loop threads that setup is complete
244 //get lock, to lock out any threads still starting up -- they'll see
245 // that setupComplete is true before entering while loop, and so never
246 // wait on the condition
247 pthread_mutex_lock( &suspendLock );
248 _VMSMasterEnv->setupComplete = 1;
249 pthread_mutex_unlock( &suspendLock );
250 pthread_cond_broadcast( &suspend_cond );
253 //wait for all to complete
254 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
255 {
256 pthread_join( coreLoopThdHandles[coreIdx], NULL );
257 }
259 //NOTE: do not clean up VMS env here -- semantic layer has to have
260 // a chance to clean up its environment first, then do a call to free
261 // the Master env and rest of VMS locations
262 }
264 /*Only difference between version with an OS thread pinned to each core and
265 * the sequential version of VMS is VMS__init_Seq, this, and coreLoop_Seq.
266 */
267 void
268 VMS__start_the_work_then_wait_until_done_Seq()
269 {
270 //Instead of un-suspending threads, just call the one and only
271 // core loop (sequential version), in the main thread.
272 coreLoop_Seq( NULL );
274 }
278 /*Create stack, then create __cdecl structure on it and put initialData and
279 * pointer to the new structure instance into the parameter positions on
280 * the stack
281 *Then put function pointer into nextInstrPt -- the stack is setup in std
282 * call structure, so jumping to function ptr is same as a GCC generated
283 * function call
284 *No need to save registers on old stack frame, because there's no old
285 * animator state to return to --
286 *
287 */
288 inline VirtProcr *
289 create_procr_helper( VirtProcr *newPr, VirtProcrFnPtr fnPtr,
290 void *initialData, char *stackLocs )
291 {
292 char *stackPtr;
294 newPr->startOfStack = stackLocs;
295 newPr->procrID = _VMSMasterEnv->numProcrsCreated++;
296 newPr->nextInstrPt = fnPtr;
297 newPr->initialData = initialData;
298 newPr->requests = NULL;
299 newPr->schedSlot = NULL;
301 //fnPtr takes two params -- void *initData & void *animProcr
302 //alloc stack locations, make stackPtr be the highest addr minus room
303 // for 2 params + return addr. Return addr (NULL) is in loc pointed to
304 // by stackPtr, initData at stackPtr + 4 bytes, animatingPr just above
305 stackPtr = ( (char *)stackLocs + VIRT_PROCR_STACK_SIZE - 0x10 );
307 //setup __cdecl on stack -- coreloop will switch to stackPtr before jmp
308 *( (int *)stackPtr + 2 ) = (int) newPr; //rightmost param -- 32bit pointer
309 *( (int *)stackPtr + 1 ) = (int) initialData; //next param to left
310 newPr->stackPtr = stackPtr; //core loop will switch to this, then
311 newPr->framePtr = stackPtr; //suspend loop will save new stack & frame ptr
313 //============================= MEASUREMENT STUFF ========================
314 #ifdef STATS__TURN_ON_PROBES
315 struct timeval timeStamp;
316 gettimeofday( &(timeStamp), NULL);
317 newPr->createPtInSecs = timeStamp.tv_sec +(timeStamp.tv_usec/1000000.0) -
318 _VMSMasterEnv->createPtInSecs;
319 #endif
320 //========================================================================
322 return newPr;
323 }
325 inline VirtProcr *
326 VMS__create_procr( VirtProcrFnPtr fnPtr, void *initialData )
327 { VirtProcr *newPr;
328 char *stackLocs;
330 newPr = VMS__malloc( sizeof(VirtProcr) );
331 stackLocs = VMS__malloc( VIRT_PROCR_STACK_SIZE );
332 if( stackLocs == 0 )
333 { perror("VMS__malloc stack"); exit(1); }
335 return create_procr_helper( newPr, fnPtr, initialData, stackLocs );
336 }
338 /* "ext" designates that it's for use outside the VMS system -- should only
339 * be called from main thread or other thread -- never from code animated by
340 * a VMS virtual processor.
341 */
342 inline VirtProcr *
343 VMS_ext__create_procr( VirtProcrFnPtr fnPtr, void *initialData )
344 { VirtProcr *newPr;
345 char *stackLocs;
347 newPr = malloc( sizeof(VirtProcr) );
348 stackLocs = malloc( VIRT_PROCR_STACK_SIZE );
349 if( stackLocs == 0 )
350 { perror("malloc stack"); exit(1); }
352 return create_procr_helper( newPr, fnPtr, initialData, stackLocs );
353 }
356 /*Anticipating multi-tasking
357 */
358 void *
359 VMS__give_sem_env_for( VirtProcr *animPr )
360 {
361 return _VMSMasterEnv->semanticEnv;
362 }
363 //===========================================================================
364 /*there is a label inside this function -- save the addr of this label in
365 * the callingPr struc, as the pick-up point from which to start the next
366 * work-unit for that procr. If turns out have to save registers, then
367 * save them in the procr struc too. Then do assembly jump to the CoreLoop's
368 * "done with work-unit" label. The procr struc is in the request in the
369 * slave that animated the just-ended work-unit, so all the state is saved
370 * there, and will get passed along, inside the request handler, to the
371 * next work-unit for that procr.
372 */
373 void
374 VMS__suspend_procr( VirtProcr *animatingPr )
375 {
377 //The request to master will cause this suspended virt procr to get
378 // scheduled again at some future point -- to resume, core loop jumps
379 // to the resume point (below), which causes restore of saved regs and
380 // "return" from this call.
381 animatingPr->nextInstrPt = &&ResumePt;
383 //return ownership of the virt procr and sched slot to Master virt pr
384 animatingPr->schedSlot->workIsDone = TRUE;
386 //=========================== Measurement stuff ========================
387 #ifdef MEAS__TIME_STAMP_SUSP
388 //record time stamp: compare to time-stamp recorded below
389 saveLowTimeStampCountInto( animatingPr->preSuspTSCLow );
390 #endif
391 //=======================================================================
393 /* VirtProcr offsets:
394 * 0xc stackPtr
395 * 0x10 framePtr
396 * 0x14 nextInstrPt
397 * 0x1c coreLoopFramePtr
398 * 0x20 coreLoopStackPtr
399 *
400 * _VMSMasterEnv offsets:
401 * 0x24 coreLoopStartPt
402 * 0x28 coreLoopEndPt
403 * 0x30 masterLock
404 */
405 // SwitchToCoreLoop( animatingPr )
406 asm volatile("movl %0, %%ebx; \
407 movl %1, %%ecx; \
408 movl %%esp, 0x0c(%%ecx); \
409 movl %%ebp, 0x10(%%ecx); \
410 movl 0x24(%%ebx), %%eax; \
411 movl 0x20(%%ecx), %%esp; \
412 movl 0x1c(%%ecx), %%ebp; \
413 jmp %%eax" \
414 /* outputs */ : \
415 /* inputs */ : "g"(_VMSMasterEnv), "g"(animatingPr) \
416 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi", "%esi" \
417 );
419 // asm volatile("mov %0,%%ebx; \
420 mov %%ebx, %%eax; \
421 add $0xc, %%eax; \
422 movl %%esp, (%%eax); \
423 mov %%ebx, %%eax; \
424 add $0x10, %%eax; \
425 movl %%ebp, (%%eax); \
426 movl %1, %%eax; \
427 movl %2, %%esp; \
428 movl %3, %%ebp; \
429 jmp %%eax" \
430 /* outputs */ : \
431 /* inputs */ : "g"(animatingPr), "g" (jmpPt), "g" (coreLoopStackPtr), \
432 "g" (coreLoopFramePtr) \
433 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi", "%esi" \
434 );
436 //=======================================================================
437 ResumePt:
438 #ifdef MEAS__TIME_STAMP_SUSP
439 //NOTE: only take low part of count -- do sanity check when take diff
440 saveLowTimeStampCountInto( animatingPr->postSuspTSCLow );
441 #endif
443 return;
444 }
448 /*For this implementation of VMS, it may not make much sense to have the
449 * system of requests for creating a new processor done this way.. but over
450 * the scope of single-master, multi-master, mult-tasking, OS-implementing,
451 * distributed-memory, and so on, this gives VMS implementation a chance to
452 * do stuff before suspend, in the AppVP, and in the Master before the plugin
453 * is called, as well as in the lang-lib before this is called, and in the
454 * plugin. So, this gives both VMS and language implementations a chance to
455 * intercept at various points and do order-dependent stuff.
456 *Having a standard VMSNewPrReqData struc allows the language to create and
457 * free the struc, while VMS knows how to get the newPr if it wants it, and
458 * it lets the lang have lang-specific data related to creation transported
459 * to the plugin.
460 */
461 void
462 VMS__send_create_procr_req( void *semReqData, VirtProcr *reqstingPr )
463 { VMSReqst req;
465 req.reqType = createReq;
466 req.semReqData = semReqData;
467 req.nextReqst = reqstingPr->requests;
468 reqstingPr->requests = &req;
470 VMS__suspend_procr( reqstingPr );
471 }
474 /*
475 *This adds a request to dissipate, then suspends the processor so that the
476 * request handler will receive the request. The request handler is what
477 * does the work of freeing memory and removing the processor from the
478 * semantic environment's data structures.
479 *The request handler also is what figures out when to shutdown the VMS
480 * system -- which causes all the core loop threads to die, and returns from
481 * the call that started up VMS to perform the work.
482 *
483 *This form is a bit misleading to understand if one is trying to figure out
484 * how VMS works -- it looks like a normal function call, but inside it
485 * sends a request to the request handler and suspends the processor, which
486 * jumps out of the VMS__dissipate_procr function, and out of all nestings
487 * above it, transferring the work of dissipating to the request handler,
488 * which then does the actual work -- causing the processor that animated
489 * the call of this function to disappear and the "hanging" state of this
490 * function to just poof into thin air -- the virtual processor's trace
491 * never returns from this call, but instead the virtual processor's trace
492 * gets suspended in this call and all the virt processor's state disap-
493 * pears -- making that suspend the last thing in the virt procr's trace.
494 */
495 void
496 VMS__send_dissipate_req( VirtProcr *procrToDissipate )
497 { VMSReqst req;
499 req.reqType = dissipate;
500 req.nextReqst = procrToDissipate->requests;
501 procrToDissipate->requests = &req;
503 VMS__suspend_procr( procrToDissipate );
504 }
507 /* "ext" designates that it's for use outside the VMS system -- should only
508 * be called from main thread or other thread -- never from code animated by
509 * a VMS virtual processor.
510 *
511 *Use this version to dissipate VPs created outside the VMS system.
512 */
513 void
514 VMS_ext__dissipate_procr( VirtProcr *procrToDissipate )
515 {
516 //NOTE: initialData was given to the processor, so should either have
517 // been alloc'd with VMS__malloc, or freed by the level above animPr.
518 //So, all that's left to free here is the stack and the VirtProcr struc
519 // itself
520 //Note, should not stack-allocate initial data -- no guarantee, in
521 // general that creating processor will outlive ones it creates.
522 free( procrToDissipate->startOfStack );
523 free( procrToDissipate );
524 }
528 /*This call's name indicates that request is malloc'd -- so req handler
529 * has to free any extra requests tacked on before a send, using this.
530 *
531 * This inserts the semantic-layer's request data into standard VMS carrier
532 * request data-struct that is mallocd. The sem request doesn't need to
533 * be malloc'd if this is called inside the same call chain before the
534 * send of the last request is called.
535 *
536 *The request handler has to call VMS__free_VMSReq for any of these
537 */
538 inline void
539 VMS__add_sem_request_in_mallocd_VMSReqst( void *semReqData,
540 VirtProcr *callingPr )
541 { VMSReqst *req;
543 req = VMS__malloc( sizeof(VMSReqst) );
544 req->reqType = semantic;
545 req->semReqData = semReqData;
546 req->nextReqst = callingPr->requests;
547 callingPr->requests = req;
548 }
550 /*This inserts the semantic-layer's request data into standard VMS carrier
551 * request data-struct is allocated on stack of this call & ptr to it sent
552 * to plugin
553 *Then it does suspend, to cause request to be sent.
554 */
555 inline void
556 VMS__send_sem_request( void *semReqData, VirtProcr *callingPr )
557 { VMSReqst req;
559 req.reqType = semantic;
560 req.semReqData = semReqData;
561 req.nextReqst = callingPr->requests;
562 callingPr->requests = &req;
564 VMS__suspend_procr( callingPr );
565 }
568 inline void
569 VMS__send_VMSSem_request( void *semReqData, VirtProcr *callingPr )
570 { VMSReqst req;
572 req.reqType = VMSSemantic;
573 req.semReqData = semReqData;
574 req.nextReqst = callingPr->requests; //gab any other preceeding
575 callingPr->requests = &req;
577 VMS__suspend_procr( callingPr );
578 }
581 /*
582 */
583 VMSReqst *
584 VMS__take_next_request_out_of( VirtProcr *procrWithReq )
585 { VMSReqst *req;
587 req = procrWithReq->requests;
588 if( req == NULL ) return NULL;
590 procrWithReq->requests = procrWithReq->requests->nextReqst;
591 return req;
592 }
595 inline void *
596 VMS__take_sem_reqst_from( VMSReqst *req )
597 {
598 return req->semReqData;
599 }
603 /* This is for OS requests and VMS infrastructure requests, such as to create
604 * a probe -- a probe is inside the heart of VMS-core, it's not part of any
605 * language -- but it's also a semantic thing that's triggered from and used
606 * in the application.. so it crosses abstractions.. so, need some special
607 * pattern here for handling such requests.
608 * Doing this just like it were a second language sharing VMS-core.
609 *
610 * This is called from the language's request handler when it sees a request
611 * of type VMSSemReq
612 *
613 * TODO: Later change this, to give probes their own separate plugin & have
614 * VMS-core steer the request to appropriate plugin
615 * Do the same for OS calls -- look later at it..
616 */
617 void inline
618 VMS__handle_VMSSemReq( VMSReqst *req, VirtProcr *requestingPr, void *semEnv,
619 ResumePrFnPtr resumePrFnPtr )
620 { VMSSemReq *semReq;
621 IntervalProbe *newProbe;
622 int32 nameLen;
624 semReq = req->semReqData;
626 newProbe = VMS__malloc( sizeof(IntervalProbe) );
627 newProbe->nameStr = VMS__strDup( semReq->nameStr );
628 newProbe->hist = NULL;
629 newProbe->schedChoiceWasRecorded = FALSE;
631 //This runs in masterVP, so no race-condition worries
632 newProbe->probeID =
633 addToDynArray( newProbe, _VMSMasterEnv->dynIntervalProbesInfo );
635 requestingPr->dataRetFromReq = newProbe;
637 (*resumePrFnPtr)( requestingPr, semEnv );
638 }
642 /*This must be called by the request handler plugin -- it cannot be called
643 * from the semantic library "dissipate processor" function -- instead, the
644 * semantic layer has to generate a request, and the plug-in calls this
645 * function.
646 *The reason is that this frees the virtual processor's stack -- which is
647 * still in use inside semantic library calls!
648 *
649 *This frees or recycles all the state owned by and comprising the VMS
650 * portion of the animating virtual procr. The request handler must first
651 * free any semantic data created for the processor that didn't use the
652 * VMS_malloc mechanism. Then it calls this, which first asks the malloc
653 * system to disown any state that did use VMS_malloc, and then frees the
654 * statck and the processor-struct itself.
655 *If the dissipated processor is the sole (remaining) owner of VMS__malloc'd
656 * state, then that state gets freed (or sent to recycling) as a side-effect
657 * of dis-owning it.
658 */
659 void
660 VMS__dissipate_procr( VirtProcr *animatingPr )
661 {
662 //dis-own all locations owned by this processor, causing to be freed
663 // any locations that it is (was) sole owner of
664 //TODO: implement VMS__malloc system, including "give up ownership"
667 //NOTE: initialData was given to the processor, so should either have
668 // been alloc'd with VMS__malloc, or freed by the level above animPr.
669 //So, all that's left to free here is the stack and the VirtProcr struc
670 // itself
671 //Note, should not stack-allocate initial data -- no guarantee, in
672 // general that creating processor will outlive ones it creates.
673 VMS__free( animatingPr->startOfStack );
674 VMS__free( animatingPr );
675 }
678 //TODO: look at architecting cleanest separation between request handler
679 // and master loop, for dissipate, create, shutdown, and other non-semantic
680 // requests. Issue is chain: one removes requests from AppVP, one dispatches
681 // on type of request, and one handles each type.. but some types require
682 // action from both request handler and master loop -- maybe just give the
683 // request handler calls like: VMS__handle_X_request_type
686 /*This is called by the semantic layer's request handler when it decides its
687 * time to shut down the VMS system. Calling this causes the core loop OS
688 * threads to exit, which unblocks the entry-point function that started up
689 * VMS, and allows it to grab the result and return to the original single-
690 * threaded application.
691 *
692 *The _VMSMasterEnv is needed by this shut down function, so the create-seed-
693 * and-wait function has to free a bunch of stuff after it detects the
694 * threads have all died: the masterEnv, the thread-related locations,
695 * masterVP any AppVPs that might still be allocated and sitting in the
696 * semantic environment, or have been orphaned in the _VMSWorkQ.
697 *
698 *NOTE: the semantic plug-in is expected to use VMS__malloc to get all the
699 * locations it needs, and give ownership to masterVP. Then, they will be
700 * automatically freed.
701 *
702 *In here,create one core-loop shut-down processor for each core loop and put
703 * them all directly into the readyToAnimateQ.
704 *Note, this function can ONLY be called after the semantic environment no
705 * longer cares if AppVPs get animated after the point this is called. In
706 * other words, this can be used as an abort, or else it should only be
707 * called when all AppVPs have finished dissipate requests -- only at that
708 * point is it sure that all results have completed.
709 */
710 void
711 VMS__shutdown()
712 { int coreIdx;
713 VirtProcr *shutDownPr;
715 //create the shutdown processors, one for each core loop -- put them
716 // directly into the Q -- each core will die when gets one
717 for( coreIdx=0; coreIdx < NUM_CORES; coreIdx++ )
718 { //Note, this is running in the master
719 shutDownPr = VMS__create_procr( &endOSThreadFn, NULL );
720 writeVMSQ( shutDownPr, _VMSMasterEnv->readyToAnimateQs[coreIdx] );
721 }
723 }
726 /*Am trying to be cute, avoiding IF statement in coreLoop that checks for
727 * a special shutdown procr. Ended up with extra-complex shutdown sequence.
728 *This function has the sole purpose of setting the stack and framePtr
729 * to the coreLoop's stack and framePtr.. it does that then jumps to the
730 * core loop's shutdown point -- might be able to just call Pthread_exit
731 * from here, but am going back to the pthread's stack and setting everything
732 * up just as if it never jumped out, before calling pthread_exit.
733 *The end-point of core loop will free the stack and so forth of the
734 * processor that animates this function, (this fn is transfering the
735 * animator of the AppVP that is in turn animating this function over
736 * to core loop function -- note that this slices out a level of virtual
737 * processors).
738 */
739 void
740 endOSThreadFn( void *initData, VirtProcr *animatingPr )
741 { void *jmpPt, *coreLoopStackPtr, *coreLoopFramePtr;
743 jmpPt = _VMSMasterEnv->coreLoopEndPt;
744 coreLoopStackPtr = animatingPr->coreLoopStackPtr;
745 coreLoopFramePtr = animatingPr->coreLoopFramePtr;
748 asm volatile("movl %0, %%eax; \
749 movl %1, %%esp; \
750 movl %2, %%ebp; \
751 jmp %%eax " \
752 /* outputs */ : \
753 /* inputs */ : "m" (jmpPt), "m"(coreLoopStackPtr), "m"(coreLoopFramePtr)\
754 /* clobber */ : "memory", "%eax", "%ebx", "%ecx", "%edx", "%edi","%esi" \
755 );
756 }
759 /*This is called from the startup & shutdown
760 */
761 void
762 VMS__cleanup_at_end_of_shutdown()
763 {
764 VMSQueueStruc **readyToAnimateQs;
765 int coreIdx;
766 VirtProcr **masterVPs;
767 SchedSlot ***allSchedSlots; //ptr to array of ptrs
769 //Before getting rid of everything, print out any measurements made
770 forAllInDynArrayDo( _VMSMasterEnv->measHistsInfo, (DynArrayFnPtr)&printHist );
771 //forAllInDynArrayDo( _VMSMasterEnv->measHistsInfo, &freeHistExt );
772 #ifdef MEAS__TIME_PLUGIN
773 printHist( _VMSMasterEnv->reqHdlrLowTimeHist );
774 printHist( _VMSMasterEnv->reqHdlrHighTimeHist );
775 freeHistExt( _VMSMasterEnv->reqHdlrLowTimeHist );
776 freeHistExt( _VMSMasterEnv->reqHdlrHighTimeHist );
777 #endif
778 #ifdef MEAS__TIME_MALLOC
779 printHist( _VMSMasterEnv->mallocTimeHist );
780 printHist( _VMSMasterEnv->freeTimeHist );
781 freeHistExt( _VMSMasterEnv->mallocTimeHist );
782 freeHistExt( _VMSMasterEnv->freeTimeHist );
783 #endif
784 #ifdef MEAS__TIME_MASTER_LOCK
785 printHist( _VMSMasterEnv->masterLockLowTimeHist );
786 printHist( _VMSMasterEnv->masterLockHighTimeHist );
787 #endif
788 #ifdef MEAS__TIME_MASTER
789 printHist( _VMSMasterEnv->pluginTimeHist );
790 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
791 {
792 freeVMSQ( readyToAnimateQs[ coreIdx ] );
793 //master VPs were created external to VMS, so use external free
794 VMS__dissipate_procr( masterVPs[ coreIdx ] );
796 freeSchedSlots( allSchedSlots[ coreIdx ] );
797 }
798 #endif
799 #ifdef MEAS__TIME_STAMP_SUSP
800 printHist( _VMSMasterEnv->pluginTimeHist );
801 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
802 {
803 freeVMSQ( readyToAnimateQs[ coreIdx ] );
804 //master VPs were created external to VMS, so use external free
805 VMS__dissipate_procr( masterVPs[ coreIdx ] );
807 freeSchedSlots( allSchedSlots[ coreIdx ] );
808 }
809 #endif
811 //All the environment data has been allocated with VMS__malloc, so just
812 // free its internal big-chunk and all inside it disappear.
813 /*
814 readyToAnimateQs = _VMSMasterEnv->readyToAnimateQs;
815 masterVPs = _VMSMasterEnv->masterVPs;
816 allSchedSlots = _VMSMasterEnv->allSchedSlots;
818 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
819 {
820 freeVMSQ( readyToAnimateQs[ coreIdx ] );
821 //master VPs were created external to VMS, so use external free
822 VMS__dissipate_procr( masterVPs[ coreIdx ] );
824 freeSchedSlots( allSchedSlots[ coreIdx ] );
825 }
827 VMS__free( _VMSMasterEnv->readyToAnimateQs );
828 VMS__free( _VMSMasterEnv->masterVPs );
829 VMS__free( _VMSMasterEnv->allSchedSlots );
831 //============================= MEASUREMENT STUFF ========================
832 #ifdef STATS__TURN_ON_PROBES
833 freeDynArrayDeep( _VMSMasterEnv->dynIntervalProbesInfo, &VMS__free_probe);
834 #endif
835 //========================================================================
836 */
837 //These are the only two that use system free
838 VMS_ext__free_free_list( _VMSMasterEnv->freeListHead );
839 free( (void *)_VMSMasterEnv );
840 }
843 //================================
846 /*Later, improve this -- for now, just exits the application after printing
847 * the error message.
848 */
849 void
850 VMS__throw_exception( char *msgStr, VirtProcr *reqstPr, VMSExcp *excpData )
851 {
852 printf("%s",msgStr);
853 fflush(stdin);
854 exit(1);
855 }