Mercurial > cgi-bin > hgwebdir.cgi > VMS > VMS_Implementations > VMS_impls > VMS__MC_shared_impl

annotate VMS.h @ 218:82f7defac851

find changesets by author, revision, files, or words in the commit message
Added backoff to core loop, cleaned up core loop code, cleaned comments
author Some Random Person <seanhalle@yahoo.com>
date Sat, 10 Mar 2012 21:48:53 -0800
parents 10a72bcedbf0
children 8059fb8d5465
rev   line source
seanhalle@208 1 /*
seanhalle@208 2 * Copyright 2009 OpenSourceStewardshipFoundation.org
seanhalle@208 3 * Licensed under GNU General Public License version 2
seanhalle@208 4 *
seanhalle@208 5 * Author: seanhalle@yahoo.com
seanhalle@208 6 *
seanhalle@208 7 */
seanhalle@208 8
seanhalle@208 9 #ifndef _VMS_H
seanhalle@208 10 #define _VMS_H
seanhalle@208 11 #define _GNU_SOURCE
seanhalle@208 12
seanhalle@208 13 #include "VMS_primitive_data_types.h"
seanhalle@215 14 #include "DynArray/DynArray.h"
seanhalle@215 15 #include "Hash_impl/PrivateHash.h"
seanhalle@215 16 #include "Histogram/Histogram.h"
seanhalle@215 17 #include "Queue_impl/PrivateQueue.h"
seanhalle@208 18 #include "vmalloc.h"
seanhalle@208 19
seanhalle@208 20 #include <pthread.h>
seanhalle@208 21 #include <sys/time.h>
seanhalle@208 22
seanhalle@208 23 //================= Defines: included from separate files =================
seanhalle@208 24 //
seanhalle@208 25 // Note: ALL defines are in other files, none are in here
seanhalle@208 26 //
seanhalle@210 27 #include "Defines/VMS_defs__main.h"
seanhalle@208 28
seanhalle@208 29
seanhalle@208 30 //================================ Typedefs =================================
seanhalle@208 31 //
seanhalle@208 32 typedef unsigned long long TSCount;
seanhalle@208 33 typedef union
seanhalle@208 34 { uint32 lowHigh[2];
seanhalle@208 35 uint64 longVal;
seanhalle@208 36 }
seanhalle@208 37 TSCountLowHigh;
seanhalle@208 38
seanhalle@208 39 typedef struct _SchedSlot SchedSlot;
seanhalle@208 40 typedef struct _VMSReqst VMSReqst;
seanhalle@208 41 typedef struct _SlaveVP SlaveVP;
seanhalle@208 42 typedef struct _MasterVP MasterVP;
seanhalle@208 43 typedef struct _IntervalProbe IntervalProbe;
seanhalle@208 44 typedef struct _GateStruc GateStruc;
seanhalle@208 45
seanhalle@208 46
seanhalle@209 47 typedef SlaveVP * (*Sched_Assigner) ( void *, int ); //semEnv, coreIdx
seanhalle@209 48 typedef void (*RequestHandler) ( SlaveVP *, void * ); //prWReqst, semEnv
seanhalle@209 49 typedef void (*TopLevelFnPtr) ( void *, SlaveVP * ); //initData, animSlv
seanhalle@209 50 typedef void TopLevelFn ( void *, SlaveVP * ); //initData, animSlv
seanhalle@209 51 typedef void (*ResumeSlvFnPtr) ( SlaveVP *, void * );
seanhalle@209 52
seanhalle@209 53 //============================ HW Dependent Fns ================================
seanhalle@209 54
seanhalle@216 55 #include "Hardware_Dependent/VMS__HW_measurement.h"
seanhalle@216 56 #include "Hardware_Dependent/VMS__primitives.h"
seanhalle@208 57
seanhalle@208 58 //============================= Statistics ==================================
seanhalle@208 59
seanhalle@208 60 inline TSCount getTSCount();
seanhalle@208 61
seanhalle@208 62 //============= Request Related ===========
seanhalle@208 63 //
seanhalle@208 64
seanhalle@208 65 enum VMSReqstType //avoid starting enums at 0, for debug reasons
seanhalle@208 66 {
seanhalle@208 67 semantic = 1,
seanhalle@208 68 createReq,
seanhalle@208 69 dissipate,
seanhalle@208 70 VMSSemantic //goes with VMSSemReqst below
seanhalle@208 71 };
seanhalle@208 72
seanhalle@208 73 struct _VMSReqst
seanhalle@208 74 {
seanhalle@208 75 enum VMSReqstType reqType;//used for dissipate and in future for IO requests
seanhalle@208 76 void *semReqData;
seanhalle@208 77
seanhalle@208 78 VMSReqst *nextReqst;
seanhalle@208 79 };
seanhalle@208 80 //VMSReqst
seanhalle@208 81
seanhalle@208 82 enum VMSSemReqstType //These are equivalent to semantic requests, but for
seanhalle@208 83 { // VMS's services available directly to app, like OS
seanhalle@208 84 createProbe = 1, // and probe services -- like a VMS-wide built-in lang
seanhalle@208 85 openFile,
seanhalle@208 86 otherIO
seanhalle@208 87 };
seanhalle@208 88
seanhalle@208 89 typedef struct
seanhalle@208 90 { enum VMSSemReqstType reqType;
seanhalle@209 91 SlaveVP *requestingSlv;
seanhalle@208 92 char *nameStr; //for create probe
seanhalle@208 93 }
seanhalle@208 94 VMSSemReq;
seanhalle@208 95
seanhalle@208 96
seanhalle@208 97 //==================== Core data structures ===================
seanhalle@208 98
seanhalle@208 99 struct _SchedSlot
seanhalle@208 100 {
seanhalle@208 101 int workIsDone;
seanhalle@209 102 int needsSlaveAssigned;
seanhalle@209 103 SlaveVP *slaveAssignedToSlot;
seanhalle@208 104 };
seanhalle@208 105 //SchedSlot
seanhalle@208 106
seanhalle@209 107 /*WARNING: re-arranging this data structure could cause Slv switching
seanhalle@208 108 * assembly code to fail -- hard-codes offsets of fields
seanhalle@208 109 */
seanhalle@208 110 struct _SlaveVP
seanhalle@215 111 { int slaveID; //each slave given a unique ID
seanhalle@208 112 int coreAnimatedBy;
seanhalle@208 113 void *startOfStack;
seanhalle@208 114 void *stackPtr;
seanhalle@208 115 void *framePtr;
seanhalle@208 116 void *resumeInstrPtr;
seanhalle@208 117
seanhalle@216 118 void *coreCtlrStartPt; //allows proto-runtime to be linked later
seanhalle@216 119 void *coreCtlrFramePtr; //restore before jmp back to core controller
seanhalle@216 120 void *coreCtlrStackPtr; //restore before jmp back to core controller
seanhalle@208 121
seanhalle@208 122 SchedSlot *schedSlot;
seanhalle@208 123 VMSReqst *requests;
seanhalle@208 124
seanhalle@210 125 void *semanticData; //this is live for the life of Slv
seanhalle@210 126 void *dataRetFromReq;//Used to return vals from plugin to Wrapper Lib
seanhalle@208 127
seanhalle@208 128 //=========== MEASUREMENT STUFF ==========
seanhalle@209 129 MEAS__Insert_Meas_Fields_into_Slave;
seanhalle@208 130 //========================================
seanhalle@208 131
seanhalle@208 132 float64 createPtInSecs; //have space but don't use on some configs
seanhalle@208 133 };
seanhalle@208 134 //SlaveVP
seanhalle@208 135
seanhalle@208 136
seanhalle@209 137 /*WARNING: re-arranging this data structure could cause Slv-switching
seanhalle@208 138 * assembly code to fail -- hard-codes offsets of fields
seanhalle@208 139 * (because -O3 messes with things otherwise)
seanhalle@208 140 */
seanhalle@208 141 typedef struct
seanhalle@208 142 {
seanhalle@209 143 Sched_Assigner slaveAssigner;
seanhalle@208 144 RequestHandler requestHandler;
seanhalle@208 145
seanhalle@208 146 SchedSlot ***allSchedSlots;
seanhalle@210 147 VMSQueueStruc **readyToAnimateQs;
seanhalle@210 148 SlaveVP **masterVPs;
seanhalle@208 149
seanhalle@208 150 void *semanticEnv;
seanhalle@208 151 void *OSEventStruc; //for future, when add I/O to BLIS
seanhalle@209 152 MallocArrays *freeLists;
seanhalle@208 153 int32 amtOfOutstandingMem; //total currently allocated
seanhalle@208 154
seanhalle@216 155 void *coreCtlrReturnPt;//addr to jump to to re-enter coreCtlr
seanhalle@208 156
seanhalle@208 157 int32 setupComplete;
seanhalle@209 158 int32 numMasterInARow[NUM_CORES];//detect back-to-back masterVP
seanhalle@209 159 int32 masterLock __align_to_cacheline__;
seanhalle@208 160 GateStruc *workStealingGates[ NUM_CORES ]; //concurrent work-steal
seanhalle@208 161 int32 workStealingLock;
seanhalle@208 162
seanhalle@209 163 int32 numSlavesCreated; //gives ordering to processor creation
seanhalle@209 164 int32 numSlavesAlive; //used to detect when to shutdown
seanhalle@208 165
seanhalle@208 166 //=========== MEASUREMENT STUFF =============
seanhalle@208 167 IntervalProbe **intervalProbes;
seanhalle@208 168 PrivDynArrayInfo *dynIntervalProbesInfo;
seanhalle@208 169 HashTable *probeNameHashTbl;
seanhalle@208 170 int32 masterCreateProbeID;
seanhalle@208 171 float64 createPtInSecs;
seanhalle@208 172 Histogram **measHists;
seanhalle@208 173 PrivDynArrayInfo *measHistsInfo;
seanhalle@209 174 MEAS__Insert_Susp_Meas_Fields_into_MasterEnv;
seanhalle@209 175 MEAS__Insert_Master_Meas_Fields_into_MasterEnv;
seanhalle@209 176 MEAS__Insert_Master_Lock_Meas_Fields_into_MasterEnv;
seanhalle@209 177 MEAS__Insert_Malloc_Meas_Fields_into_MasterEnv;
seanhalle@209 178 MEAS__Insert_Plugin_Meas_Fields_into_MasterEnv;
seanhalle@209 179 MEAS__Insert_System_Meas_Fields_into_MasterEnv;
seanhalle@208 180 //==========================================
seanhalle@208 181 }
seanhalle@208 182 MasterEnv;
seanhalle@208 183
seanhalle@208 184 //========================= Extra Stuff Data Strucs =======================
seanhalle@208 185 typedef struct
seanhalle@208 186 {
seanhalle@208 187
seanhalle@208 188 }
seanhalle@208 189 VMSExcp;
seanhalle@208 190
seanhalle@208 191 struct _GateStruc
seanhalle@208 192 {
seanhalle@208 193 int32 gateClosed;
seanhalle@208 194 int32 preGateProgress;
seanhalle@208 195 int32 waitProgress;
seanhalle@208 196 int32 exitProgress;
seanhalle@208 197 };
seanhalle@208 198 //GateStruc
seanhalle@208 199
seanhalle@208 200 //======================= OS Thread related ===============================
seanhalle@208 201
seanhalle@216 202 void * coreController( void *paramsIn ); //standard PThreads fn prototype
seanhalle@216 203 void * coreCtlr_Seq( void *paramsIn ); //standard PThreads fn prototype
seanhalle@208 204 void masterLoop( void *initData, SlaveVP *masterVP );
seanhalle@208 205
seanhalle@208 206
seanhalle@208 207 typedef struct
seanhalle@208 208 {
seanhalle@208 209 void *endThdPt;
seanhalle@208 210 unsigned int coreNum;
seanhalle@208 211 }
seanhalle@208 212 ThdParams;
seanhalle@208 213
seanhalle@209 214 //============================= Global Vars ================================
seanhalle@209 215
seanhalle@215 216 volatile MasterEnv *_VMSMasterEnv __align_to_cacheline__;
seanhalle@215 217
seanhalle@216 218 pthread_t coreCtlrThdHandles[ NUM_CORES ]; //pthread's virt-procr state
seanhalle@216 219 ThdParams *coreCtlrThdParams [ NUM_CORES ];
seanhalle@215 220 pthread_mutex_t suspendLock = PTHREAD_MUTEX_INITIALIZER;
seanhalle@215 221 pthread_cond_t suspendCond = PTHREAD_COND_INITIALIZER;
seanhalle@208 222
seanhalle@208 223 //========================= Function Prototypes ===========================
seanhalle@208 224
seanhalle@209 225 /* MEANING OF WL PI SS int
seanhalle@209 226 * These indicate which places the function is safe to use. They stand for:
seanhalle@209 227 * WL: Wrapper Library
seanhalle@209 228 * PI: Plugin
seanhalle@209 229 * SS: Startup and Shutdown
seanhalle@209 230 * int: internal to the VMS implementation
seanhalle@209 231 */
seanhalle@208 232
seanhalle@208 233 //========== Setup and shutdown ==========
seanhalle@208 234 void
seanhalle@209 235 VMS_SS__init();
seanhalle@208 236
seanhalle@209 237 //Fix;
seanhalle@215 238 /*seed-slaveVP creation -- put box around language, have lang register stuff
seanhalle@208 239 with VMS.
seanhalle@208 240 have main program explicitly INIT Lang! -- makes more sense to
seanhalle@208 241 C programmers -- makes it clear that there's a transition.
seanhalle@208 242 (might need to have the pthreads remain waiting for
seanhalle@208 243 cond until work is scheduled)
seanhalle@208 244 Have main do call to tell language to perform work -- like did with DKU
seanhalle@208 245
seanhalle@208 246 Ex: "HWSim__run_a_simulation(netlist, paramBag);"
seanhalle@208 247 "processID = SSR__run_program(seed_fn, seedData); "
seanhalle@208 248 "SSR__Wait_for_program_to_end(processID);"
seanhalle@208 249 "SSR__run_program_and_wait_till_it_ends(seed_fn, seedData);"
seanhalle@208 250
seanhalle@208 251 allows multiple languages to be started, and programs run in several,
seanhalle@208 252 overlapped, or one program to be run that uses multiple langs..?
seanhalle@208 253 So, each program is in separate directory:
seanhalle@208 254 "HWSim_ArchDef__PingPong" "SSR_Program__Blocked_Matrix_Mult"
seanhalle@208 255
seanhalle@208 256 Those programs can talk to each other, via VMS, by handles they each
seanhalle@208 257 return
seanhalle@208 258 "processIDs[0] = SSR__run_program(seed_fn1, seedData1);"
seanhalle@208 259 "processIDs[1] = SSR__run_program(seed_fn2, seedData2);"
seanhalle@208 260 "SSR__link_programs(processIDs, 2);"
seanhalle@208 261 or even
seanhalle@208 262 "processIDs[0] = Vthread__run_program(seed_fn1, seedData1);"
seanhalle@208 263 "processIDs[1] = SSR__run_program(seed_fn2, seedData2);"
seanhalle@208 264 "VMS__link_programs(processIDs, 2);"
seanhalle@208 265 Then, the programs just know they sync with other prog, but use own
seanhalle@208 266 lang's sync constructs -- VMS uses message system to establish tie-pt,
seanhalle@208 267 each lang defines what a tie-point means to it.. (work with the
seanhalle@208 268 diff semantics?)
seanhalle@209 269 */
seanhalle@208 270 void
seanhalle@209 271 VMS_SS__start_the_work_then_wait_until_done();
seanhalle@208 272
seanhalle@208 273 void
seanhalle@209 274 VMS_SS__shutdown();
seanhalle@208 275
seanhalle@208 276 void
seanhalle@209 277 VMS_SS__cleanup_at_end_of_shutdown();
seanhalle@208 278
seanhalle@208 279
seanhalle@208 280 //============== ===============
seanhalle@208 281
seanhalle@208 282 inline SlaveVP *
seanhalle@209 283 VMS_int__create_slaveVP( TopLevelFnPtr fnPtr, void *dataParam );
seanhalle@209 284 #define VMS_PI__create_slaveVP VMS_int__create_slaveVP
seanhalle@209 285 #define VMS_WL__create_slaveVP VMS_int__create_slaveVP
seanhalle@208 286
seanhalle@210 287 //Use this to create processor inside entry point & other places outside
seanhalle@210 288 // the VMS system boundary (IE, don't animate with a SlaveVP or MasterVP)
seanhalle@210 289 SlaveVP *
seanhalle@210 290 VMS_ext__create_slaveVP( TopLevelFnPtr fnPtr, void *dataParam );
seanhalle@210 291
seanhalle@210 292 inline SlaveVP *
seanhalle@210 293 VMS_int__create_slaveVP_helper( SlaveVP *newSlv, TopLevelFnPtr fnPtr,
seanhalle@210 294 void *dataParam, void *stackLocs );
seanhalle@210 295
seanhalle@208 296 inline void
seanhalle@209 297 VMS_int__point_slaveVP_to_Fn( SlaveVP *slaveVP, TopLevelFnPtr fnPtr,
seanhalle@208 298 void *dataParam);
seanhalle@208 299
seanhalle@208 300 void
seanhalle@210 301 VMS_int__dissipate_slaveVP( SlaveVP *slaveToDissipate );
seanhalle@210 302 #define VMS_PI__dissipate_slaveVP VMS_int__dissipate_slaveVP
seanhalle@210 303 //WL: dissipate a SlaveVP by sending a request
seanhalle@208 304
seanhalle@208 305 void
seanhalle@209 306 VMS_ext__dissipate_slaveVP( SlaveVP *slaveToDissipate );
seanhalle@208 307
seanhalle@208 308 void
seanhalle@209 309 VMS_int__throw_exception( char *msgStr, SlaveVP *reqstSlv, VMSExcp *excpData );
seanhalle@209 310 #define VMS_PI__throw_exception VMS_int__throw_exception
seanhalle@209 311 #define VMS_WL__throw_exception VMS_int__throw_exception
seanhalle@208 312
seanhalle@208 313 void *
seanhalle@209 314 VMS_int__give_sem_env_for( SlaveVP *animSlv );
seanhalle@209 315 #define VMS_PI__give_sem_env_for VMS_int__give_sem_env_for
seanhalle@209 316 #define VMS_SS__give_sem_env_for VMS_int__give_sem_env_for
seanhalle@209 317 //No WL version -- not safe! if use in WL, be sure data rd & wr is stable
seanhalle@208 318
seanhalle@208 319 //============== Request Related ===============
seanhalle@208 320
seanhalle@208 321 void
seanhalle@209 322 VMS_int__suspend_slaveVP_and_send_req( SlaveVP *callingSlv );
seanhalle@208 323
seanhalle@208 324 inline void
seanhalle@209 325 VMS_WL__add_sem_request_in_mallocd_VMSReqst( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 326
seanhalle@208 327 inline void
seanhalle@209 328 VMS_WL__send_sem_request( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 329
seanhalle@208 330 void
seanhalle@209 331 VMS_WL__send_create_slaveVP_req( void *semReqData, SlaveVP *reqstingSlv );
seanhalle@208 332
seanhalle@208 333 void inline
seanhalle@208 334 VMS_WL__send_dissipate_req( SlaveVP *prToDissipate );
seanhalle@208 335
seanhalle@208 336 inline void
seanhalle@209 337 VMS_WL__send_VMSSem_request( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 338
seanhalle@208 339 VMSReqst *
seanhalle@209 340 VMS_PI__take_next_request_out_of( SlaveVP *slaveWithReq );
seanhalle@208 341
seanhalle@208 342 inline void *
seanhalle@208 343 VMS_PI__take_sem_reqst_from( VMSReqst *req );
seanhalle@208 344
seanhalle@208 345 void inline
seanhalle@209 346 VMS_PI__handle_VMSSemReq( VMSReqst *req, SlaveVP *requestingSlv, void *semEnv,
seanhalle@209 347 ResumeSlvFnPtr resumeSlvFnPtr );
seanhalle@208 348
seanhalle@208 349 //======================== MEASUREMENT ======================
seanhalle@208 350 uint64
seanhalle@208 351 VMS_WL__give_num_plugin_cycles();
seanhalle@208 352 uint32
seanhalle@208 353 VMS_WL__give_num_plugin_animations();
seanhalle@208 354
seanhalle@208 355
seanhalle@210 356 //========================= Utilities =======================
seanhalle@210 357 inline char *
seanhalle@210 358 VMS_int__strDup( char *str );
seanhalle@208 359
seanhalle@210 360
seanhalle@210 361 //========================= Probes =======================
seanhalle@210 362 #include "Probes/probes.h"
seanhalle@210 363
seanhalle@210 364 //================================================
seanhalle@208 365 #endif /* _VMS_H */
seanhalle@208 366