annotate VSs.c @ 7:3999b8429ddd

Not working -- check point to share changes with Nina
author Sean Halle <seanhalle@yahoo.com>
date Wed, 01 Aug 2012 03:16:27 -0700
parents 1780f6b00e3d
children eb3d77ca9f59
rev   line source
seanhalle@0 1 /*
seanhalle@0 2 * Copyright 2010 OpenSourceCodeStewardshipFoundation
seanhalle@0 3 *
seanhalle@0 4 * Licensed under BSD
seanhalle@0 5 */
seanhalle@0 6
seanhalle@0 7 #include <stdio.h>
seanhalle@0 8 #include <stdlib.h>
seanhalle@0 9 #include <malloc.h>
seanhalle@0 10
seanhalle@0 11 #include "Queue_impl/PrivateQueue.h"
seanhalle@0 12 #include "Hash_impl/PrivateHash.h"
seanhalle@0 13
seanhalle@2 14 #include "VSs.h"
seanhalle@3 15 #include "Measurement/VSs_Counter_Recording.h"
seanhalle@0 16
seanhalle@0 17 //==========================================================================
seanhalle@0 18
seanhalle@0 19 void
seanhalle@2 20 VSs__init();
seanhalle@0 21
seanhalle@0 22 void
seanhalle@2 23 VSs__init_Helper();
seanhalle@0 24 //==========================================================================
seanhalle@0 25
seanhalle@0 26
seanhalle@0 27
seanhalle@0 28 //===========================================================================
seanhalle@0 29
seanhalle@0 30
seanhalle@0 31 /*These are the library functions *called in the application*
seanhalle@0 32 *
seanhalle@0 33 *There's a pattern for the outside sequential code to interact with the
seanhalle@0 34 * VMS_HW code.
seanhalle@2 35 *The VMS_HW system is inside a boundary.. every VSs system is in its
seanhalle@0 36 * own directory that contains the functions for each of the processor types.
seanhalle@0 37 * One of the processor types is the "seed" processor that starts the
seanhalle@0 38 * cascade of creating all the processors that do the work.
seanhalle@0 39 *So, in the directory is a file called "EntryPoint.c" that contains the
seanhalle@0 40 * function, named appropriately to the work performed, that the outside
seanhalle@0 41 * sequential code calls. This function follows a pattern:
seanhalle@2 42 *1) it calls VSs__init()
seanhalle@0 43 *2) it creates the initial data for the seed processor, which is passed
seanhalle@0 44 * in to the function
seanhalle@2 45 *3) it creates the seed VSs processor, with the data to start it with.
seanhalle@2 46 *4) it calls startVSsThenWaitUntilWorkDone
seanhalle@0 47 *5) it gets the returnValue from the transfer struc and returns that
seanhalle@0 48 * from the function
seanhalle@0 49 *
seanhalle@2 50 *For now, a new VSs system has to be created via VSs__init every
seanhalle@0 51 * time an entry point function is called -- later, might add letting the
seanhalle@2 52 * VSs system be created once, and let all the entry points just reuse
seanhalle@0 53 * it -- want to be as simple as possible now, and see by using what makes
seanhalle@0 54 * sense for later..
seanhalle@0 55 */
seanhalle@0 56
seanhalle@0 57
seanhalle@0 58
seanhalle@0 59 //===========================================================================
seanhalle@0 60
seanhalle@0 61 /*This is the "border crossing" function -- the thing that crosses from the
seanhalle@0 62 * outside world, into the VMS_HW world. It initializes and starts up the
seanhalle@0 63 * VMS system, then creates one processor from the specified function and
seanhalle@0 64 * puts it into the readyQ. From that point, that one function is resp.
seanhalle@0 65 * for creating all the other processors, that then create others, and so
seanhalle@0 66 * forth.
seanhalle@0 67 *When all the processors, including the seed, have dissipated, then this
seanhalle@0 68 * function returns. The results will have been written by side-effect via
seanhalle@0 69 * pointers read from, or written into initData.
seanhalle@0 70 *
seanhalle@0 71 *NOTE: no Threads should exist in the outside program that might touch
seanhalle@0 72 * any of the data reachable from initData passed in to here
seanhalle@0 73 */
seanhalle@0 74 void
seanhalle@2 75 VSs__create_seed_slave_and_do_work( TopLevelFnPtr fnPtr, void *initData )
seanhalle@6 76 { VSsSemEnv *semEnv;
seanhalle@6 77 SlaveVP *seedSlv;
seanhalle@6 78 VSsSemData *semData;
seanhalle@6 79 VSsTaskStub *explPrTaskStub;
seanhalle@0 80
seanhalle@2 81 VSs__init(); //normal multi-thd
seanhalle@0 82
seanhalle@0 83 semEnv = _VMSMasterEnv->semanticEnv;
seanhalle@0 84
seanhalle@2 85 //VSs starts with one processor, which is put into initial environ,
seanhalle@0 86 // and which then calls create() to create more, thereby expanding work
seanhalle@3 87 seedSlv = VSs__create_slave_helper( fnPtr, initData,
seanhalle@6 88 semEnv, semEnv->nextCoreToGetNewSlv++ );
seanhalle@3 89
seanhalle@6 90 //seed slave is an explicit processor, so make one of the special
seanhalle@6 91 // task stubs for explicit processors, and attach it to the slave
seanhalle@6 92 explPrTaskStub = create_expl_proc_task_stub( initData );
seanhalle@6 93
seanhalle@6 94 semData = (VSsSemData *)seedSlv->semanticData;
seanhalle@6 95 //seedVP already has a permanent task
seanhalle@6 96 semData->needsTaskAssigned = FALSE;
seanhalle@6 97 semData->taskStub = explPrTaskStub;
seanhalle@0 98
seanhalle@6 99 resume_slaveVP( seedSlv, semEnv ); //returns right away, just queues Slv
seanhalle@0 100
seanhalle@0 101 VMS_SS__start_the_work_then_wait_until_done(); //normal multi-thd
seanhalle@0 102
seanhalle@2 103 VSs__cleanup_after_shutdown();
seanhalle@0 104 }
seanhalle@0 105
seanhalle@0 106
seanhalle@0 107 int32
seanhalle@2 108 VSs__giveMinWorkUnitCycles( float32 percentOverhead )
seanhalle@0 109 {
seanhalle@0 110 return MIN_WORK_UNIT_CYCLES;
seanhalle@0 111 }
seanhalle@0 112
seanhalle@0 113 int32
seanhalle@2 114 VSs__giveIdealNumWorkUnits()
seanhalle@0 115 {
seanhalle@0 116 return NUM_ANIM_SLOTS * NUM_CORES;
seanhalle@0 117 }
seanhalle@0 118
seanhalle@0 119 int32
seanhalle@2 120 VSs__give_number_of_cores_to_schedule_onto()
seanhalle@0 121 {
seanhalle@0 122 return NUM_CORES;
seanhalle@0 123 }
seanhalle@0 124
seanhalle@0 125 /*For now, use TSC -- later, make these two macros with assembly that first
seanhalle@0 126 * saves jump point, and second jumps back several times to get reliable time
seanhalle@0 127 */
seanhalle@0 128 void
seanhalle@2 129 VSs__start_primitive()
seanhalle@2 130 { saveLowTimeStampCountInto( ((VSsSemEnv *)(_VMSMasterEnv->semanticEnv))->
seanhalle@0 131 primitiveStartTime );
seanhalle@0 132 }
seanhalle@0 133
seanhalle@0 134 /*Just quick and dirty for now -- make reliable later
seanhalle@0 135 * will want this to jump back several times -- to be sure cache is warm
seanhalle@0 136 * because don't want comm time included in calc-time measurement -- and
seanhalle@0 137 * also to throw out any "weird" values due to OS interrupt or TSC rollover
seanhalle@0 138 */
seanhalle@0 139 int32
seanhalle@2 140 VSs__end_primitive_and_give_cycles()
seanhalle@0 141 { int32 endTime, startTime;
seanhalle@0 142 //TODO: fix by repeating time-measurement
seanhalle@0 143 saveLowTimeStampCountInto( endTime );
seanhalle@2 144 startTime =((VSsSemEnv*)(_VMSMasterEnv->semanticEnv))->primitiveStartTime;
seanhalle@0 145 return (endTime - startTime);
seanhalle@0 146 }
seanhalle@0 147
seanhalle@0 148 //===========================================================================
seanhalle@0 149
seanhalle@2 150 /*Initializes all the data-structures for a VSs system -- but doesn't
seanhalle@0 151 * start it running yet!
seanhalle@0 152 *
seanhalle@0 153 *This runs in the main thread -- before VMS starts up
seanhalle@0 154 *
seanhalle@0 155 *This sets up the semantic layer over the VMS system
seanhalle@0 156 *
seanhalle@0 157 *First, calls VMS_Setup, then creates own environment, making it ready
seanhalle@0 158 * for creating the seed processor and then starting the work.
seanhalle@0 159 */
seanhalle@0 160 void
seanhalle@2 161 VSs__init()
seanhalle@0 162 {
seanhalle@0 163 VMS_SS__init();
seanhalle@0 164 //masterEnv, a global var, now is partially set up by init_VMS
seanhalle@0 165 // after this, have VMS_int__malloc and VMS_int__free available
seanhalle@0 166
seanhalle@2 167 VSs__init_Helper();
seanhalle@0 168 }
seanhalle@0 169
seanhalle@0 170
seanhalle@0 171 void idle_fn(void* data, SlaveVP *animatingSlv){
seanhalle@0 172 while(1){
seanhalle@0 173 VMS_int__suspend_slaveVP_and_send_req(animatingSlv);
seanhalle@0 174 }
seanhalle@0 175 }
seanhalle@0 176
seanhalle@0 177 void
seanhalle@2 178 VSs__init_Helper()
seanhalle@2 179 { VSsSemEnv *semanticEnv;
seanhalle@6 180 int32 i, coreNum, slotNum;
seanhalle@0 181
seanhalle@0 182 //Hook up the semantic layer's plug-ins to the Master virt procr
seanhalle@2 183 _VMSMasterEnv->requestHandler = &VSs__Request_Handler;
seanhalle@2 184 _VMSMasterEnv->slaveAssigner = &VSs__assign_slaveVP_to_slot;
seanhalle@0 185 #ifdef HOLISTIC__TURN_ON_PERF_COUNTERS
seanhalle@2 186 _VMSMasterEnv->counterHandler = &VSs__counter_handler;
seanhalle@0 187 #endif
seanhalle@0 188
seanhalle@0 189 //create the semantic layer's environment (all its data) and add to
seanhalle@0 190 // the master environment
seanhalle@2 191 semanticEnv = VMS_int__malloc( sizeof( VSsSemEnv ) );
seanhalle@0 192 _VMSMasterEnv->semanticEnv = semanticEnv;
seanhalle@0 193
seanhalle@0 194 #ifdef HOLISTIC__TURN_ON_PERF_COUNTERS
seanhalle@2 195 VSs__init_counter_data_structs();
seanhalle@0 196 #endif
seanhalle@3 197
seanhalle@0 198 semanticEnv->shutdownInitiated = FALSE;
seanhalle@3 199 semanticEnv->coreIsDone = VMS_int__malloc( NUM_CORES * sizeof( bool32 ) );
seanhalle@6 200 //For each animation slot, there is an idle slave, and an initial
seanhalle@6 201 // slave assigned as the current-task-slave. Create them here.
seanhalle@6 202 SlaveVP *idleSlv, *currTaskSlv;
seanhalle@6 203 for( coreNum = 0; coreNum < NUM_CORES; coreNum++ )
seanhalle@6 204 { semanticEnv->coreIsDone[coreNum] = FALSE; //use during shutdown
seanhalle@6 205
seanhalle@6 206 for( slotNum = 0; slotNum < NUM_ANIM_SLOTS; ++slotNum )
seanhalle@6 207 { idleSlv = VMS_int__create_slaveVP(&idle_fn,NULL);
seanhalle@6 208 idleSlv->coreAnimatedBy = coreNum;
seanhalle@6 209 idleSlv->animSlotAssignedTo = slotNum;
seanhalle@6 210 semanticEnv->idleSlv[coreNum][slotNum] = idleSlv;
seanhalle@6 211
seanhalle@6 212 currTaskSlv = VMS_int__create_slaveVP( &idle_fn, NULL );
seanhalle@6 213 currTaskSlv->coreAnimatedBy = coreNum;
seanhalle@6 214 currTaskSlv->animSlotAssignedTo = slotNum;
seanhalle@6 215 semanticEnv->currTaskSlvs[coreNum][slotNum] = currTaskSlv;
seanhalle@0 216 }
seanhalle@3 217 }
seanhalle@0 218
seanhalle@6 219 //create the ready queues, hash tables used for matching and so forth
seanhalle@6 220 semanticEnv->slavesReadyToResumeQ = makeVMSQ();
seanhalle@6 221 semanticEnv->extraTaskSlvQ = makeVMSQ();
seanhalle@6 222 semanticEnv->taskReadyQ = makeVMSQ();
seanhalle@0 223
seanhalle@3 224 semanticEnv->argPtrHashTbl = makeHashTable32( 16, &VMS_int__free );
seanhalle@4 225 semanticEnv->commHashTbl = makeHashTable32( 16, &VMS_int__free );
seanhalle@6 226
seanhalle@6 227 semanticEnv->nextCoreToGetNewSlv = 0;
seanhalle@6 228
seanhalle@0 229
seanhalle@0 230 //TODO: bug -- turn these arrays into dyn arrays to eliminate limit
seanhalle@0 231 //semanticEnv->singletonHasBeenExecutedFlags = makeDynArrayInfo( );
seanhalle@0 232 //semanticEnv->transactionStrucs = makeDynArrayInfo( );
seanhalle@0 233 for( i = 0; i < NUM_STRUCS_IN_SEM_ENV; i++ )
seanhalle@0 234 {
seanhalle@0 235 semanticEnv->fnSingletons[i].endInstrAddr = NULL;
seanhalle@0 236 semanticEnv->fnSingletons[i].hasBeenStarted = FALSE;
seanhalle@0 237 semanticEnv->fnSingletons[i].hasFinished = FALSE;
seanhalle@0 238 semanticEnv->fnSingletons[i].waitQ = makeVMSQ();
seanhalle@0 239 semanticEnv->transactionStrucs[i].waitingVPQ = makeVMSQ();
seanhalle@0 240 }
seanhalle@6 241
seanhalle@6 242 semanticEnv->numAdditionalSlvs = 0; //must be last
seanhalle@6 243
seanhalle@6 244 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
seanhalle@6 245 semanticEnv->unitList = makeListOfArrays(sizeof(Unit),128);
seanhalle@6 246 semanticEnv->ctlDependenciesList = makeListOfArrays(sizeof(Dependency),128);
seanhalle@6 247 semanticEnv->commDependenciesList = makeListOfArrays(sizeof(Dependency),128);
seanhalle@6 248 semanticEnv->dynDependenciesList = makeListOfArrays(sizeof(Dependency),128);
seanhalle@6 249 semanticEnv->ntonGroupsInfo = makePrivDynArrayOfSize((void***)&(semanticEnv->ntonGroups),8);
seanhalle@6 250
seanhalle@6 251 semanticEnv->hwArcs = makeListOfArrays(sizeof(Dependency),128);
seanhalle@6 252 memset(semanticEnv->last_in_slot,0,sizeof(NUM_CORES * NUM_ANIM_SLOTS * sizeof(Unit)));
seanhalle@6 253 #endif
seanhalle@0 254 }
seanhalle@0 255
seanhalle@0 256
seanhalle@2 257 /*Frees any memory allocated by VSs__init() then calls VMS_int__shutdown
seanhalle@0 258 */
seanhalle@0 259 void
seanhalle@2 260 VSs__cleanup_after_shutdown()
seanhalle@2 261 { VSsSemEnv *semanticEnv;
seanhalle@0 262
seanhalle@0 263 semanticEnv = _VMSMasterEnv->semanticEnv;
seanhalle@0 264
seanhalle@0 265 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
seanhalle@0 266 //UCC
seanhalle@0 267 FILE* output;
seanhalle@0 268 int n;
seanhalle@0 269 char filename[255];
seanhalle@0 270 for(n=0;n<255;n++)
seanhalle@0 271 {
seanhalle@0 272 sprintf(filename, "./counters/UCC.%d",n);
seanhalle@0 273 output = fopen(filename,"r");
seanhalle@0 274 if(output)
seanhalle@0 275 {
seanhalle@0 276 fclose(output);
seanhalle@0 277 }else{
seanhalle@0 278 break;
seanhalle@0 279 }
seanhalle@0 280 }
seanhalle@0 281 if(n<255){
seanhalle@0 282 printf("Saving UCC to File: %s ...\n", filename);
seanhalle@0 283 output = fopen(filename,"w+");
seanhalle@0 284 if(output!=NULL){
seanhalle@0 285 set_dependency_file(output);
seanhalle@0 286 //fprintf(output,"digraph Dependencies {\n");
seanhalle@0 287 //set_dot_file(output);
seanhalle@0 288 //FIXME: first line still depends on counters being enabled, replace w/ unit struct!
seanhalle@0 289 //forAllInDynArrayDo(_VMSMasterEnv->counter_history_array_info, &print_dot_node_info );
seanhalle@0 290 forAllInListOfArraysDo(semanticEnv->unitList, &print_unit_to_file);
seanhalle@0 291 forAllInListOfArraysDo( semanticEnv->commDependenciesList, &print_comm_dependency_to_file );
seanhalle@0 292 forAllInListOfArraysDo( semanticEnv->ctlDependenciesList, &print_ctl_dependency_to_file );
seanhalle@0 293 forAllInDynArrayDo(semanticEnv->ntonGroupsInfo,&print_nton_to_file);
seanhalle@0 294 //fprintf(output,"}\n");
seanhalle@0 295 fflush(output);
seanhalle@0 296
seanhalle@0 297 } else
seanhalle@0 298 printf("Opening UCC file failed. Please check that folder \"counters\" exists in run directory and has write permission.\n");
seanhalle@0 299 } else {
seanhalle@0 300 printf("Could not open UCC file, please clean \"counters\" folder. (Must contain less than 255 files.)\n");
seanhalle@0 301 }
seanhalle@0 302 //Loop Graph
seanhalle@0 303 for(n=0;n<255;n++)
seanhalle@0 304 {
seanhalle@0 305 sprintf(filename, "./counters/LoopGraph.%d",n);
seanhalle@0 306 output = fopen(filename,"r");
seanhalle@0 307 if(output)
seanhalle@0 308 {
seanhalle@0 309 fclose(output);
seanhalle@0 310 }else{
seanhalle@0 311 break;
seanhalle@0 312 }
seanhalle@0 313 }
seanhalle@0 314 if(n<255){
seanhalle@0 315 printf("Saving LoopGraph to File: %s ...\n", filename);
seanhalle@0 316 output = fopen(filename,"w+");
seanhalle@0 317 if(output!=NULL){
seanhalle@0 318 set_dependency_file(output);
seanhalle@0 319 //fprintf(output,"digraph Dependencies {\n");
seanhalle@0 320 //set_dot_file(output);
seanhalle@0 321 //FIXME: first line still depends on counters being enabled, replace w/ unit struct!
seanhalle@0 322 //forAllInDynArrayDo(_VMSMasterEnv->counter_history_array_info, &print_dot_node_info );
seanhalle@0 323 forAllInListOfArraysDo( semanticEnv->unitList, &print_unit_to_file );
seanhalle@0 324 forAllInListOfArraysDo( semanticEnv->commDependenciesList, &print_comm_dependency_to_file );
seanhalle@0 325 forAllInListOfArraysDo( semanticEnv->ctlDependenciesList, &print_ctl_dependency_to_file );
seanhalle@0 326 forAllInListOfArraysDo( semanticEnv->dynDependenciesList, &print_dyn_dependency_to_file );
seanhalle@0 327 forAllInListOfArraysDo( semanticEnv->hwArcs, &print_hw_dependency_to_file );
seanhalle@0 328 //fprintf(output,"}\n");
seanhalle@0 329 fflush(output);
seanhalle@0 330
seanhalle@0 331 } else
seanhalle@0 332 printf("Opening LoopGraph file failed. Please check that folder \"counters\" exists in run directory and has write permission.\n");
seanhalle@0 333 } else {
seanhalle@0 334 printf("Could not open LoopGraph file, please clean \"counters\" folder. (Must contain less than 255 files.)\n");
seanhalle@0 335 }
seanhalle@0 336
seanhalle@0 337
seanhalle@0 338 freeListOfArrays(semanticEnv->unitList);
seanhalle@0 339 freeListOfArrays(semanticEnv->commDependenciesList);
seanhalle@0 340 freeListOfArrays(semanticEnv->ctlDependenciesList);
seanhalle@0 341 freeListOfArrays(semanticEnv->dynDependenciesList);
seanhalle@0 342
seanhalle@0 343 #endif
seanhalle@0 344 #ifdef HOLISTIC__TURN_ON_PERF_COUNTERS
seanhalle@0 345 for(n=0;n<255;n++)
seanhalle@0 346 {
seanhalle@0 347 sprintf(filename, "./counters/Counters.%d.csv",n);
seanhalle@0 348 output = fopen(filename,"r");
seanhalle@0 349 if(output)
seanhalle@0 350 {
seanhalle@0 351 fclose(output);
seanhalle@0 352 }else{
seanhalle@0 353 break;
seanhalle@0 354 }
seanhalle@0 355 }
seanhalle@0 356 if(n<255){
seanhalle@0 357 printf("Saving Counter measurements to File: %s ...\n", filename);
seanhalle@0 358 output = fopen(filename,"w+");
seanhalle@0 359 if(output!=NULL){
seanhalle@0 360 set_counter_file(output);
seanhalle@0 361 int i;
seanhalle@0 362 for(i=0;i<NUM_CORES;i++){
seanhalle@0 363 forAllInListOfArraysDo( semanticEnv->counterList[i], &print_counter_events_to_file );
seanhalle@0 364 fflush(output);
seanhalle@0 365 }
seanhalle@0 366
seanhalle@0 367 } else
seanhalle@0 368 printf("Opening UCC file failed. Please check that folder \"counters\" exists in run directory and has write permission.\n");
seanhalle@0 369 } else {
seanhalle@0 370 printf("Could not open UCC file, please clean \"counters\" folder. (Must contain less than 255 files.)\n");
seanhalle@0 371 }
seanhalle@0 372
seanhalle@0 373 #endif
seanhalle@0 374 /* It's all allocated inside VMS's big chunk -- that's about to be freed, so
seanhalle@0 375 * nothing to do here
seanhalle@0 376
seanhalle@0 377
seanhalle@0 378 for( coreIdx = 0; coreIdx < NUM_CORES; coreIdx++ )
seanhalle@0 379 {
seanhalle@0 380 VMS_int__free( semanticEnv->readyVPQs[coreIdx]->startOfData );
seanhalle@0 381 VMS_int__free( semanticEnv->readyVPQs[coreIdx] );
seanhalle@0 382 }
seanhalle@0 383 VMS_int__free( semanticEnv->readyVPQs );
seanhalle@0 384
seanhalle@0 385 freeHashTable( semanticEnv->commHashTbl );
seanhalle@0 386 VMS_int__free( _VMSMasterEnv->semanticEnv );
seanhalle@0 387 */
seanhalle@0 388 VMS_SS__cleanup_at_end_of_shutdown();
seanhalle@0 389 }
seanhalle@0 390
seanhalle@0 391
seanhalle@0 392 //===========================================================================
seanhalle@0 393
seanhalle@2 394 SlaveVP *
seanhalle@7 395 VSs__create_thread( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 396 SlaveVP *creatingThd )
seanhalle@2 397 { VSsSemReq reqData;
seanhalle@0 398
seanhalle@0 399 //the semantic request data is on the stack and disappears when this
seanhalle@0 400 // call returns -- it's guaranteed to remain in the VP's stack for as
seanhalle@0 401 // long as the VP is suspended.
seanhalle@0 402 reqData.reqType = 0; //know type because in a VMS create req
seanhalle@0 403 reqData.fnPtr = fnPtr;
seanhalle@0 404 reqData.initData = initData;
seanhalle@7 405 reqData.callingSlv = creatingThd;
seanhalle@0 406
seanhalle@7 407 VMS_WL__send_create_slaveVP_req( &reqData, creatingThd );
seanhalle@0 408
seanhalle@7 409 return creatingThd->dataRetFromReq;
seanhalle@0 410 }
seanhalle@0 411
seanhalle@7 412 /*This is always the last thing done in the code animated by a thread.
seanhalle@7 413 * Normally, this would be the last line of the thread's top level function.
seanhalle@7 414 * But, if the thread exits from any point, it has to do so by calling
seanhalle@7 415 * this.
seanhalle@7 416 *
seanhalle@7 417 *This must update the count of active sub-tasks (sub-threads) of parents,
seanhalle@7 418 * and the semantic data and task stub must stay
seanhalle@7 419 */
seanhalle@2 420 void
seanhalle@7 421 VSs__end_thread( SlaveVP *thdToEnd )
seanhalle@0 422 {
seanhalle@7 423 //check whether all sub-tasks have ended.. if not, don't free the
seanhalle@7 424 // semantic data nor task stub of this thread.
seanhalle@7 425 check_sub_tasks();
seanhalle@7 426
seanhalle@7 427 //Update the count of live sub-tasks in parent. If parent was a
seanhalle@7 428 // thread and has already ended, then if this was the last sub-task,
seanhalle@7 429 // free the semantic data and task stub of the parent.
seanhalle@7 430 VMS_WL__send_dissipate_req( thdToEnd );
seanhalle@0 431 }
seanhalle@0 432
seanhalle@0 433
seanhalle@0 434 //===========================================================================
seanhalle@0 435
seanhalle@0 436
seanhalle@4 437 //======================= task submit and end ==============================
seanhalle@4 438 /*
seanhalle@2 439 */
seanhalle@4 440 void
seanhalle@2 441 VSs__submit_task( VSsTaskType *taskType, void *args, SlaveVP *animSlv)
seanhalle@2 442 { VSsSemReq reqData;
seanhalle@0 443
seanhalle@2 444 reqData.reqType = submit_task;
seanhalle@4 445
seanhalle@2 446 reqData.taskType = taskType;
seanhalle@2 447 reqData.args = args;
seanhalle@4 448 reqData.callingSlv = animSlv;
seanhalle@2 449
seanhalle@4 450 reqData.taskID = NULL;
seanhalle@2 451
seanhalle@2 452 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 453 }
seanhalle@0 454
seanhalle@4 455 inline int32 *
seanhalle@4 456 VSs__create_taskID_of_size( int32 numInts, SlaveVP *animSlv )
seanhalle@4 457 { int32 *taskID;
seanhalle@4 458
seanhalle@4 459 taskID = VMS_WL__malloc( sizeof(int32) + numInts * sizeof(int32) );
seanhalle@4 460 taskID[0] = numInts;
seanhalle@4 461 return taskID;
seanhalle@4 462 }
seanhalle@4 463
seanhalle@4 464 void
seanhalle@4 465 VSs__submit_task_with_ID( VSsTaskType *taskType, void *args, int32 *taskID,
seanhalle@4 466 SlaveVP *animSlv)
seanhalle@4 467 { VSsSemReq reqData;
seanhalle@4 468
seanhalle@4 469 reqData.reqType = submit_task;
seanhalle@4 470
seanhalle@4 471 reqData.taskType = taskType;
seanhalle@4 472 reqData.args = args;
seanhalle@4 473 reqData.taskID = taskID;
seanhalle@4 474 reqData.callingSlv = animSlv;
seanhalle@4 475
seanhalle@4 476 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@4 477 }
seanhalle@4 478
seanhalle@4 479
seanhalle@4 480 /*This call is the last to happen in every task. It causes the slave to
seanhalle@2 481 * suspend and get the next task out of the task-queue. Notice there is no
seanhalle@2 482 * assigner here.. only one slave, no slave ReadyQ, and so on..
seanhalle@2 483 *Can either make the assigner take the next task out of the taskQ, or can
seanhalle@2 484 * leave all as it is, and make task-end take the next task.
seanhalle@2 485 *Note: this fits the case in the new VMS for no-context tasks, so will use
seanhalle@2 486 * the built-in taskQ of new VMS, and should be local and much faster.
seanhalle@2 487 *
seanhalle@2 488 *The task-stub is saved in the animSlv, so the request handler will get it
seanhalle@2 489 * from there, along with the task-type which has arg types, and so on..
seanhalle@4 490 *
seanhalle@4 491 * NOTE: if want, don't need to send the animating SlaveVP around..
seanhalle@4 492 * instead, can make a single slave per core, and coreCtrlr looks up the
seanhalle@4 493 * slave from having the core number.
seanhalle@4 494 *
seanhalle@4 495 *But, to stay compatible with all the other VMS languages, leave it in..
seanhalle@0 496 */
seanhalle@0 497 void
seanhalle@2 498 VSs__end_task( SlaveVP *animSlv )
seanhalle@2 499 { VSsSemReq reqData;
seanhalle@0 500
seanhalle@2 501 reqData.reqType = end_task;
seanhalle@2 502 reqData.callingSlv = animSlv;
seanhalle@2 503
seanhalle@2 504 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 505 }
seanhalle@0 506
seanhalle@4 507
nengel@5 508 void
nengel@5 509 VSs__taskwait(SlaveVP *animSlv)
nengel@5 510 {
nengel@5 511 VSsSemReq reqData;
nengel@5 512
nengel@5 513 reqData.reqType = taskwait;
nengel@5 514 reqData.callingSlv = animSlv;
nengel@5 515
nengel@5 516 VMS_WL__send_sem_request( &reqData, animSlv );
nengel@5 517 }
nengel@5 518
nengel@5 519
nengel@5 520
seanhalle@4 521 //========================== send and receive ============================
seanhalle@4 522 //
seanhalle@4 523
seanhalle@4 524 inline int32 *
seanhalle@4 525 VSs__give_self_taskID( SlaveVP *animSlv )
seanhalle@4 526 {
seanhalle@4 527 return ((VSsSemData*)animSlv->semanticData)->taskStub->taskID;
seanhalle@4 528 }
seanhalle@4 529
seanhalle@4 530 //================================ send ===================================
seanhalle@4 531
seanhalle@4 532 void
seanhalle@4 533 VSs__send_of_type_to( void *msg, const int32 type, int32 *receiverID,
seanhalle@4 534 SlaveVP *senderSlv )
seanhalle@4 535 { VSsSemReq reqData;
seanhalle@4 536
seanhalle@4 537 reqData.reqType = send_type_to;
seanhalle@4 538
seanhalle@4 539 reqData.msg = msg;
seanhalle@4 540 reqData.msgType = type;
seanhalle@4 541 reqData.receiverID = receiverID;
seanhalle@4 542 reqData.senderSlv = senderSlv;
seanhalle@4 543
seanhalle@4 544 reqData.nextReqInHashEntry = NULL;
seanhalle@4 545
seanhalle@4 546 VMS_WL__send_sem_request( &reqData, senderSlv );
seanhalle@4 547
seanhalle@4 548 //When come back from suspend, no longer own data reachable from msg
seanhalle@4 549 }
seanhalle@4 550
seanhalle@4 551 void
seanhalle@4 552 VSs__send_from_to( void *msg, int32 *senderID, int32 *receiverID, SlaveVP *senderSlv )
seanhalle@4 553 { VSsSemReq reqData;
seanhalle@4 554
seanhalle@4 555 reqData.reqType = send_from_to;
seanhalle@4 556
seanhalle@4 557 reqData.msg = msg;
seanhalle@4 558 reqData.senderID = senderID;
seanhalle@4 559 reqData.receiverID = receiverID;
seanhalle@4 560 reqData.senderSlv = senderSlv;
seanhalle@4 561
seanhalle@4 562 reqData.nextReqInHashEntry = NULL;
seanhalle@4 563
seanhalle@4 564 VMS_WL__send_sem_request( &reqData, senderSlv );
seanhalle@4 565 }
seanhalle@4 566
seanhalle@4 567
seanhalle@4 568 //================================ receive ================================
seanhalle@4 569
seanhalle@4 570 /*The "type" version of send and receive creates a many-to-one relationship.
seanhalle@4 571 * The sender is anonymous, and many sends can stack up, waiting to be
seanhalle@4 572 * received. The same receiver can also have send from-to's
seanhalle@4 573 * waiting for it, and those will be kept separate from the "type"
seanhalle@4 574 * messages.
seanhalle@4 575 */
seanhalle@4 576 void *
seanhalle@4 577 VSs__receive_type_to( const int32 type, int32* receiverID, SlaveVP *receiverSlv )
seanhalle@4 578 { DEBUG__printf1(dbgRqstHdlr,"WL: receive type to %d",receiverID[1] );
seanhalle@4 579 VSsSemReq reqData;
seanhalle@4 580
seanhalle@4 581 reqData.reqType = receive_type_to;
seanhalle@4 582
seanhalle@4 583 reqData.msgType = type;
seanhalle@4 584 reqData.receiverID = receiverID;
seanhalle@4 585 reqData.receiverSlv = receiverSlv;
seanhalle@4 586
seanhalle@4 587 reqData.nextReqInHashEntry = NULL;
seanhalle@4 588
seanhalle@4 589 VMS_WL__send_sem_request( &reqData, receiverSlv );
seanhalle@4 590
seanhalle@4 591 return receiverSlv->dataRetFromReq;
seanhalle@4 592 }
seanhalle@4 593
seanhalle@4 594
seanhalle@4 595
seanhalle@4 596 /*Call this at the point a receiving task wants in-coming data.
seanhalle@4 597 * Use this from-to form when know senderID -- it makes a direct channel
seanhalle@4 598 * between sender and receiver.
seanhalle@4 599 */
seanhalle@4 600 void *
seanhalle@4 601 VSs__receive_from_to( int32 *senderID, int32 *receiverID, SlaveVP *receiverSlv )
seanhalle@4 602 {
seanhalle@4 603 VSsSemReq reqData;
seanhalle@4 604
seanhalle@4 605 reqData.reqType = receive_from_to;
seanhalle@4 606
seanhalle@4 607 reqData.senderID = senderID;
seanhalle@4 608 reqData.receiverID = receiverID;
seanhalle@4 609 reqData.receiverSlv = receiverSlv;
seanhalle@4 610
seanhalle@4 611 reqData.nextReqInHashEntry = NULL;
seanhalle@4 612 DEBUG__printf2(dbgRqstHdlr,"WL: receive from %d to: %d", reqData.senderID[1], reqData.receiverID[1]);
seanhalle@4 613
seanhalle@4 614 VMS_WL__send_sem_request( &reqData, receiverSlv );
seanhalle@4 615
seanhalle@4 616 return receiverSlv->dataRetFromReq;
seanhalle@4 617 }
seanhalle@4 618
seanhalle@4 619
seanhalle@4 620
seanhalle@4 621
seanhalle@2 622 //==========================================================================
seanhalle@0 623 //
seanhalle@0 624 /*A function singleton is a function whose body executes exactly once, on a
seanhalle@0 625 * single core, no matter how many times the fuction is called and no
seanhalle@0 626 * matter how many cores or the timing of cores calling it.
seanhalle@0 627 *
seanhalle@0 628 *A data singleton is a ticket attached to data. That ticket can be used
seanhalle@0 629 * to get the data through the function exactly once, no matter how many
seanhalle@0 630 * times the data is given to the function, and no matter the timing of
seanhalle@0 631 * trying to get the data through from different cores.
seanhalle@0 632 */
seanhalle@0 633
seanhalle@0 634 /*asm function declarations*/
seanhalle@2 635 void asm_save_ret_to_singleton(VSsSingleton *singletonPtrAddr);
seanhalle@2 636 void asm_write_ret_from_singleton(VSsSingleton *singletonPtrAddr);
seanhalle@0 637
seanhalle@0 638 /*Fn singleton uses ID as index into array of singleton structs held in the
seanhalle@0 639 * semantic environment.
seanhalle@0 640 */
seanhalle@0 641 void
seanhalle@3 642 VSs__start_fn_singleton( int32 singletonID, SlaveVP *animSlv )
seanhalle@0 643 {
seanhalle@2 644 VSsSemReq reqData;
seanhalle@0 645
seanhalle@0 646 //
seanhalle@0 647 reqData.reqType = singleton_fn_start;
seanhalle@0 648 reqData.singletonID = singletonID;
seanhalle@0 649
seanhalle@3 650 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@3 651 if( animSlv->dataRetFromReq ) //will be 0 or addr of label in end singleton
seanhalle@0 652 {
seanhalle@3 653 VSsSemEnv *semEnv = VMS_int__give_sem_env_for( animSlv );
seanhalle@0 654 asm_write_ret_from_singleton(&(semEnv->fnSingletons[ singletonID]));
seanhalle@0 655 }
seanhalle@0 656 }
seanhalle@0 657
seanhalle@0 658 /*Data singleton hands addr of loc holding a pointer to a singleton struct.
seanhalle@0 659 * The start_data_singleton makes the structure and puts its addr into the
seanhalle@0 660 * location.
seanhalle@0 661 */
seanhalle@0 662 void
seanhalle@3 663 VSs__start_data_singleton( VSsSingleton **singletonAddr, SlaveVP *animSlv )
seanhalle@0 664 {
seanhalle@2 665 VSsSemReq reqData;
seanhalle@0 666
seanhalle@0 667 if( *singletonAddr && (*singletonAddr)->hasFinished )
seanhalle@0 668 goto JmpToEndSingleton;
seanhalle@0 669
seanhalle@0 670 reqData.reqType = singleton_data_start;
seanhalle@0 671 reqData.singletonPtrAddr = singletonAddr;
seanhalle@0 672
seanhalle@3 673 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@3 674 if( animSlv->dataRetFromReq ) //either 0 or end singleton's return addr
seanhalle@0 675 { //Assembly code changes the return addr on the stack to the one
seanhalle@0 676 // saved into the singleton by the end-singleton-fn
seanhalle@0 677 //The return addr is at 0x4(%%ebp)
seanhalle@0 678 JmpToEndSingleton:
seanhalle@0 679 asm_write_ret_from_singleton(*singletonAddr);
seanhalle@0 680 }
seanhalle@0 681 //now, simply return
seanhalle@0 682 //will exit either from the start singleton call or the end-singleton call
seanhalle@0 683 }
seanhalle@0 684
seanhalle@0 685 /*Uses ID as index into array of flags. If flag already set, resumes from
seanhalle@0 686 * end-label. Else, sets flag and resumes normally.
seanhalle@0 687 *
seanhalle@0 688 *Note, this call cannot be inlined because the instr addr at the label
seanhalle@0 689 * inside is shared by all invocations of a given singleton ID.
seanhalle@0 690 */
seanhalle@0 691 void
seanhalle@3 692 VSs__end_fn_singleton( int32 singletonID, SlaveVP *animSlv )
seanhalle@0 693 {
seanhalle@2 694 VSsSemReq reqData;
seanhalle@0 695
seanhalle@0 696 //don't need this addr until after at least one singleton has reached
seanhalle@0 697 // this function
seanhalle@3 698 VSsSemEnv *semEnv = VMS_int__give_sem_env_for( animSlv );
seanhalle@0 699 asm_write_ret_from_singleton(&(semEnv->fnSingletons[ singletonID]));
seanhalle@0 700
seanhalle@0 701 reqData.reqType = singleton_fn_end;
seanhalle@0 702 reqData.singletonID = singletonID;
seanhalle@0 703
seanhalle@3 704 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 705
seanhalle@0 706 EndSingletonInstrAddr:
seanhalle@0 707 return;
seanhalle@0 708 }
seanhalle@0 709
seanhalle@0 710 void
seanhalle@3 711 VSs__end_data_singleton( VSsSingleton **singletonPtrAddr, SlaveVP *animSlv )
seanhalle@0 712 {
seanhalle@2 713 VSsSemReq reqData;
seanhalle@0 714
seanhalle@0 715 //don't need this addr until after singleton struct has reached
seanhalle@0 716 // this function for first time
seanhalle@0 717 //do assembly that saves the return addr of this fn call into the
seanhalle@0 718 // data singleton -- that data-singleton can only be given to exactly
seanhalle@0 719 // one instance in the code of this function. However, can use this
seanhalle@0 720 // function in different places for different data-singletons.
seanhalle@0 721 // (*(singletonAddr))->endInstrAddr = &&EndDataSingletonInstrAddr;
seanhalle@0 722
seanhalle@0 723
seanhalle@0 724 asm_save_ret_to_singleton(*singletonPtrAddr);
seanhalle@0 725
seanhalle@0 726 reqData.reqType = singleton_data_end;
seanhalle@0 727 reqData.singletonPtrAddr = singletonPtrAddr;
seanhalle@0 728
seanhalle@3 729 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 730 }
seanhalle@0 731
seanhalle@0 732 /*This executes the function in the masterVP, so it executes in isolation
seanhalle@0 733 * from any other copies -- only one copy of the function can ever execute
seanhalle@0 734 * at a time.
seanhalle@0 735 *
seanhalle@0 736 *It suspends to the master, and the request handler takes the function
seanhalle@0 737 * pointer out of the request and calls it, then resumes the VP.
seanhalle@0 738 *Only very short functions should be called this way -- for longer-running
seanhalle@0 739 * isolation, use transaction-start and transaction-end, which run the code
seanhalle@0 740 * between as work-code.
seanhalle@0 741 */
seanhalle@0 742 void
seanhalle@2 743 VSs__animate_short_fn_in_isolation( PtrToAtomicFn ptrToFnToExecInMaster,
seanhalle@3 744 void *data, SlaveVP *animSlv )
seanhalle@0 745 {
seanhalle@2 746 VSsSemReq reqData;
seanhalle@0 747
seanhalle@0 748 //
seanhalle@0 749 reqData.reqType = atomic;
seanhalle@0 750 reqData.fnToExecInMaster = ptrToFnToExecInMaster;
seanhalle@0 751 reqData.dataForFn = data;
seanhalle@0 752
seanhalle@3 753 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 754 }
seanhalle@0 755
seanhalle@0 756
seanhalle@0 757 /*This suspends to the master.
seanhalle@0 758 *First, it looks at the VP's data, to see the highest transactionID that VP
seanhalle@0 759 * already has entered. If the current ID is not larger, it throws an
seanhalle@0 760 * exception stating a bug in the code. Otherwise it puts the current ID
seanhalle@0 761 * there, and adds the ID to a linked list of IDs entered -- the list is
seanhalle@0 762 * used to check that exits are properly ordered.
seanhalle@0 763 *Next it is uses transactionID as index into an array of transaction
seanhalle@0 764 * structures.
seanhalle@0 765 *If the "VP_currently_executing" field is non-null, then put requesting VP
seanhalle@0 766 * into queue in the struct. (At some point a holder will request
seanhalle@0 767 * end-transaction, which will take this VP from the queue and resume it.)
seanhalle@0 768 *If NULL, then write requesting into the field and resume.
seanhalle@0 769 */
seanhalle@0 770 void
seanhalle@3 771 VSs__start_transaction( int32 transactionID, SlaveVP *animSlv )
seanhalle@0 772 {
seanhalle@2 773 VSsSemReq reqData;
seanhalle@0 774
seanhalle@0 775 //
seanhalle@3 776 reqData.callingSlv = animSlv;
seanhalle@0 777 reqData.reqType = trans_start;
seanhalle@0 778 reqData.transID = transactionID;
seanhalle@0 779
seanhalle@3 780 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 781 }
seanhalle@0 782
seanhalle@0 783 /*This suspends to the master, then uses transactionID as index into an
seanhalle@0 784 * array of transaction structures.
seanhalle@0 785 *It looks at VP_currently_executing to be sure it's same as requesting VP.
seanhalle@0 786 * If different, throws an exception, stating there's a bug in the code.
seanhalle@0 787 *Next it looks at the queue in the structure.
seanhalle@0 788 *If it's empty, it sets VP_currently_executing field to NULL and resumes.
seanhalle@0 789 *If something in, gets it, sets VP_currently_executing to that VP, then
seanhalle@0 790 * resumes both.
seanhalle@0 791 */
seanhalle@0 792 void
seanhalle@3 793 VSs__end_transaction( int32 transactionID, SlaveVP *animSlv )
seanhalle@0 794 {
seanhalle@2 795 VSsSemReq reqData;
seanhalle@0 796
seanhalle@0 797 //
seanhalle@3 798 reqData.callingSlv = animSlv;
seanhalle@0 799 reqData.reqType = trans_end;
seanhalle@0 800 reqData.transID = transactionID;
seanhalle@0 801
seanhalle@3 802 VMS_WL__send_sem_request( &reqData, animSlv );
seanhalle@0 803 }
seanhalle@7 804
seanhalle@7 805 //======================== Internal ==================================
seanhalle@7 806 /*
seanhalle@7 807 */
seanhalle@7 808 SlaveVP *
seanhalle@7 809 VSs__create_slave_with( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 810 SlaveVP *creatingSlv )
seanhalle@7 811 { VSsSemReq reqData;
seanhalle@7 812
seanhalle@7 813 //the semantic request data is on the stack and disappears when this
seanhalle@7 814 // call returns -- it's guaranteed to remain in the VP's stack for as
seanhalle@7 815 // long as the VP is suspended.
seanhalle@7 816 reqData.reqType = 0; //know type because in a VMS create req
seanhalle@7 817 reqData.coreToAssignOnto = -1; //means round-robin assign
seanhalle@7 818 reqData.fnPtr = fnPtr;
seanhalle@7 819 reqData.initData = initData;
seanhalle@7 820 reqData.callingSlv = creatingSlv;
seanhalle@7 821
seanhalle@7 822 VMS_WL__send_create_slaveVP_req( &reqData, creatingSlv );
seanhalle@7 823
seanhalle@7 824 return creatingSlv->dataRetFromReq;
seanhalle@7 825 }
seanhalle@7 826
seanhalle@7 827 SlaveVP *
seanhalle@7 828 VSs__create_slave_with_affinity( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 829 SlaveVP *creatingSlv, int32 coreToAssignOnto )
seanhalle@7 830 { VSsSemReq reqData;
seanhalle@7 831
seanhalle@7 832 //the semantic request data is on the stack and disappears when this
seanhalle@7 833 // call returns -- it's guaranteed to remain in the VP's stack for as
seanhalle@7 834 // long as the VP is suspended.
seanhalle@7 835 reqData.reqType = create_slave_w_aff; //not used, May 2012
seanhalle@7 836 reqData.coreToAssignOnto = coreToAssignOnto;
seanhalle@7 837 reqData.fnPtr = fnPtr;
seanhalle@7 838 reqData.initData = initData;
seanhalle@7 839 reqData.callingSlv = creatingSlv;
seanhalle@7 840
seanhalle@7 841 VMS_WL__send_create_slaveVP_req( &reqData, creatingSlv );
seanhalle@7 842
seanhalle@7 843 return creatingSlv->dataRetFromReq;
seanhalle@7 844 }
seanhalle@7 845