annotate VMS.h @ 60:7b799a46cc87

Added compiler switch to turn on and off debug-only probes, deleted time-junk
author Me
date Mon, 08 Nov 2010 03:57:46 -0800
parents 407f8ede98b4
children 984f7d78bfdf dd3e60aeae26
rev   line source
Me@42 1 /*
Me@42 2 * Copyright 2009 OpenSourceStewardshipFoundation.org
Me@42 3 * Licensed under GNU General Public License version 2
Me@42 4 *
Me@42 5 * Author: seanhalle@yahoo.com
Me@42 6 *
Me@42 7 */
Me@42 8
Me@42 9 #ifndef _VMS_H
Me@42 10 #define _VMS_H
Me@42 11 #define __USE_GNU
Me@42 12
Me@42 13 #include "VMS_primitive_data_types.h"
Me@55 14 #include "Queue_impl/PrivateQueue.h"
Me@42 15 #include "Histogram/Histogram.h"
Me@50 16 #include "DynArray/DynArray.h"
Me@50 17 #include "Hash_impl/PrivateHash.h"
Me@50 18 #include "vmalloc.h"
Me@50 19
Me@42 20 #include <pthread.h>
Me@50 21 #include <sys/time.h>
Me@42 22
Me@50 23
Me@50 24 //=============================== Debug ===================================
Me@55 25 //
Me@45 26 //When SEQUENTIAL is defined, VMS does sequential exe in the main thread
Me@42 27 // It still does co-routines and all the mechanisms are the same, it just
Me@42 28 // has only a single thread and animates VPs one at a time
Me@45 29 //#define SEQUENTIAL
Me@42 30
Me@55 31 //#define USE_WORK_STEALING
Me@55 32
Me@52 33 //turns on the probe-instrumentation in the application -- when not
Me@52 34 // defined, the calls to the probe functions turn into comments
Me@52 35 #define STATS__ENABLE_PROBES
Me@60 36 //#define TURN_ON_DEBUG_PROBES
Me@52 37
Me@55 38 //These defines turn types of bug messages on and off
Me@55 39 // be sure debug messages are un-commented (next block of defines)
Me@60 40 #define dbgProbes FALSE /* for issues inside probes themselves*/
Me@60 41 #define dbgAppFlow FALSE /* Top level flow of application code -- general*/
Me@60 42 #define dbgB2BMaster FALSE /* in coreloop, back to back master VPs*/
Me@60 43 #define dbgRqstHdlr FALSE /* in request handler code*/
Me@52 44
Me@55 45 //Comment or un- the substitute half to turn on/off types of debug message
Me@55 46 #define DEBUG( bool, msg) \
Me@60 47 // if( bool){ printf(msg); fflush(stdin);}
Me@55 48 #define DEBUG1( bool, msg, param) \
Me@60 49 // if(bool){printf(msg, param); fflush(stdin);}
Me@55 50 #define DEBUG2( bool, msg, p1, p2) \
Me@60 51 // if(bool) {printf(msg, p1, p2); fflush(stdin);}
Me@45 52
Me@55 53 #define ERROR(msg) printf(msg); fflush(stdin);
Me@55 54 #define ERROR1(msg, param) printf(msg, param); fflush(stdin);
Me@55 55 #define ERROR2(msg, p1, p2) printf(msg, p1, p2); fflush(stdin);
Me@50 56
Me@50 57 //=========================== STATS =======================
Me@50 58
Me@45 59 //when MEAS__TIME_STAMP_SUSP is defined, causes code to be inserted and
Me@42 60 // compiled-in that saves the low part of the time stamp count just before
Me@42 61 // suspending a processor and just after resuming that processor. It is
Me@42 62 // saved into a field added to VirtProcr. Have to sanity-check for
Me@42 63 // rollover of low portion into high portion.
Me@42 64 #define MEAS__TIME_STAMP_SUSP
Me@42 65 #define MEAS__TIME_MASTER
Me@42 66 #define MEAS__NUM_TIMES_TO_RUN 100000
Me@42 67
Me@55 68 //For code that calculates normalization-offset between TSC counts of
Me@55 69 // different cores.
Me@45 70 #define NUM_TSC_ROUND_TRIPS 10
Me@45 71
Me@50 72
Me@50 73 //========================= Hardware related Constants =====================
Me@42 74 //This value is the number of hardware threads in the shared memory
Me@42 75 // machine
Me@42 76 #define NUM_CORES 4
Me@42 77
Me@55 78 // tradeoff amortizing master fixed overhead vs imbalance potential
Me@55 79 // when work-stealing, can make bigger, at risk of losing cache affinity
Me@55 80 #define NUM_SCHED_SLOTS 5
Me@42 81
Me@45 82 #define MIN_WORK_UNIT_CYCLES 20000
Me@45 83
Me@53 84 #define MASTERLOCK_RETRIES 10000
Me@42 85
Me@54 86 // stack size in virtual processors created
Me@54 87 #define VIRT_PROCR_STACK_SIZE 0x4000 /* 16K */
Me@42 88
Me@54 89 // memory for VMS__malloc
Me@54 90 #define MALLOC_ADDITIONAL_MEM_FROM_OS_SIZE 0x10000000 /* 256M */
Me@42 91
Me@50 92
Me@50 93 //==============================
Me@42 94
Me@42 95 #define SUCCESS 0
Me@42 96
Me@55 97 #define writeVMSQ writePrivQ
Me@55 98 #define readVMSQ readPrivQ
Me@55 99 #define makeVMSQ makePrivQ
Me@55 100 #define numInVMSQ numInPrivQ
Me@55 101 #define VMSQueueStruc PrivQueueStruc
Me@42 102
Me@42 103
Me@50 104
Me@50 105 //===========================================================================
Me@50 106 typedef unsigned long long TSCount;
Me@50 107
Me@50 108 typedef struct _SchedSlot SchedSlot;
Me@50 109 typedef struct _VMSReqst VMSReqst;
Me@50 110 typedef struct _VirtProcr VirtProcr;
Me@50 111 typedef struct _IntervalProbe IntervalProbe;
Me@55 112 typedef struct _GateStruc GateStruc;
Me@55 113
Me@42 114
Me@42 115 typedef VirtProcr * (*SlaveScheduler) ( void *, int ); //semEnv, coreIdx
Me@42 116 typedef void (*RequestHandler) ( VirtProcr *, void * ); //prWReqst, semEnv
Me@42 117 typedef void (*VirtProcrFnPtr) ( void *, VirtProcr * ); //initData, animPr
Me@42 118 typedef void VirtProcrFn ( void *, VirtProcr * ); //initData, animPr
Me@50 119 typedef void (*ResumePrFnPtr) ( VirtProcr *, void * );
Me@50 120
Me@50 121
Me@50 122 //============= Requests ===========
Me@50 123 //
Me@50 124
Me@50 125 enum VMSReqstType //avoid starting enums at 0, for debug reasons
Me@50 126 {
Me@50 127 semantic = 1,
Me@50 128 createReq,
Me@50 129 dissipate,
Me@50 130 VMSSemantic //goes with VMSSemReqst below
Me@50 131 };
Me@50 132
Me@50 133 struct _VMSReqst
Me@50 134 {
Me@50 135 enum VMSReqstType reqType;//used for dissipate and in future for IO requests
Me@50 136 void *semReqData;
Me@50 137
Me@50 138 VMSReqst *nextReqst;
Me@50 139 };
Me@50 140 //VMSReqst
Me@50 141
Me@50 142 enum VMSSemReqstType //These are equivalent to semantic requests, but for
Me@50 143 { // VMS's services available directly to app, like OS
Me@50 144 createProbe = 1, // and probe services -- like a VMS-wide built-in lang
Me@50 145 openFile,
Me@50 146 otherIO
Me@50 147 };
Me@42 148
Me@42 149 typedef struct
Me@50 150 { enum VMSSemReqstType reqType;
Me@50 151 VirtProcr *requestingPr;
Me@50 152 char *nameStr; //for create probe
Me@42 153 }
Me@50 154 VMSSemReq;
Me@42 155
Me@42 156
Me@50 157 //==================== Core data structures ===================
Me@50 158
Me@42 159 struct _SchedSlot
Me@42 160 {
Me@42 161 int workIsDone;
Me@42 162 int needsProcrAssigned;
Me@42 163 VirtProcr *procrAssignedToSlot;
Me@42 164 };
Me@42 165 //SchedSlot
Me@42 166
Me@42 167 struct _VirtProcr
Me@42 168 { int procrID; //for debugging -- count up each time create
Me@42 169 int coreAnimatedBy;
Me@42 170 void *startOfStack;
Me@42 171 void *stackPtr;
Me@42 172 void *framePtr;
Me@42 173 void *nextInstrPt;
Me@42 174
Me@42 175 void *coreLoopStartPt; //allows proto-runtime to be linked later
Me@42 176 void *coreLoopFramePtr; //restore before jmp back to core loop
Me@42 177 void *coreLoopStackPtr; //restore before jmp back to core loop
Me@42 178
Me@42 179 void *initialData;
Me@42 180
Me@42 181 SchedSlot *schedSlot;
Me@42 182 VMSReqst *requests;
Me@42 183
Me@50 184 void *semanticData; //this lives here for the life of VP
Me@53 185 void *dataRetFromReq;//values returned from plugin to VP go here
Me@42 186
Me@50 187 //=========== MEASUREMENT STUFF ==========
Me@42 188 #ifdef MEAS__TIME_STAMP_SUSP
Me@42 189 unsigned int preSuspTSCLow;
Me@42 190 unsigned int postSuspTSCLow;
Me@42 191 #endif
Me@42 192 #ifdef MEAS__TIME_MASTER
Me@42 193 unsigned int startMasterTSCLow;
Me@42 194 unsigned int endMasterTSCLow;
Me@42 195 #endif
Me@50 196
Me@50 197 float64 createPtInSecs; //have space but don't use on some configs
Me@42 198 };
Me@42 199 //VirtProcr
Me@42 200
Me@42 201
Me@42 202 typedef struct
Me@42 203 {
Me@42 204 SlaveScheduler slaveScheduler;
Me@42 205 RequestHandler requestHandler;
Me@42 206
Me@42 207 SchedSlot ***allSchedSlots;
Me@55 208 VMSQueueStruc **readyToAnimateQs;
Me@42 209 VirtProcr **masterVPs;
Me@42 210
Me@42 211 void *semanticEnv;
Me@42 212 void *OSEventStruc; //for future, when add I/O to BLIS
Me@50 213 MallocProlog *freeListHead;
Me@50 214 int32 amtOfOutstandingMem; //total currently allocated
Me@42 215
Me@42 216 void *coreLoopStartPt;//addr to jump to to re-enter coreLoop
Me@42 217 void *coreLoopEndPt; //addr to jump to to shut down a coreLoop
Me@42 218
Me@50 219 int32 setupComplete;
Me@50 220 int32 masterLock;
Me@42 221
Me@50 222 int32 numMasterInARow[NUM_CORES];//detect back-to-back masterVP
Me@59 223 GateStruc *workStealingGates[ NUM_CORES ]; //concurrent work-steal
Me@55 224 int32 workStealingLock;
Me@55 225
Me@50 226 int32 numProcrsCreated; //gives ordering to processor creation
Me@50 227
Me@50 228 //=========== MEASUREMENT STUFF =============
Me@50 229 IntervalProbe **intervalProbes;
Me@53 230 PrivDynArrayInfo *dynIntervalProbesInfo;
Me@50 231 HashTable *probeNameHashTbl;
Me@50 232 int32 masterCreateProbeID;
Me@50 233 float64 createPtInSecs;
Me@42 234 }
Me@42 235 MasterEnv;
Me@42 236
Me@55 237 //========================= Extra Stuff Data Strucs =======================
Me@54 238 typedef struct
Me@54 239 {
Me@42 240
Me@54 241 }
Me@54 242 VMSExcp;
Me@50 243
Me@55 244 struct _GateStruc
Me@55 245 {
Me@55 246 int32 gateClosed;
Me@55 247 int32 preGateProgress;
Me@55 248 int32 waitProgress;
Me@55 249 int32 exitProgress;
Me@55 250 };
Me@55 251 //GateStruc
Me@50 252
Me@50 253 //======================= OS Thread related ===============================
Me@42 254
Me@42 255 void * coreLoop( void *paramsIn ); //standard PThreads fn prototype
Me@42 256 void * coreLoop_Seq( void *paramsIn ); //standard PThreads fn prototype
Me@42 257 void masterLoop( void *initData, VirtProcr *masterPr );
Me@42 258
Me@42 259
Me@50 260 typedef struct
Me@50 261 {
Me@50 262 void *endThdPt;
Me@50 263 unsigned int coreNum;
Me@50 264 }
Me@50 265 ThdParams;
Me@42 266
Me@42 267 pthread_t coreLoopThdHandles[ NUM_CORES ]; //pthread's virt-procr state
Me@42 268 ThdParams *coreLoopThdParams [ NUM_CORES ];
Me@42 269 pthread_mutex_t suspendLock;
Me@42 270 pthread_cond_t suspend_cond;
Me@42 271
Me@50 272
Me@50 273
Me@50 274 //===================== Global Vars ===================
Me@50 275
Me@42 276 volatile MasterEnv *_VMSMasterEnv;
Me@42 277
Me@50 278
Me@50 279
Me@50 280
Me@50 281 //=========================== Function Prototypes =========================
Me@50 282
Me@53 283
Me@53 284 //========== Setup and shutdown ==========
Me@42 285 void
Me@42 286 VMS__init();
Me@42 287
Me@42 288 void
Me@42 289 VMS__init_Seq();
Me@42 290
Me@42 291 void
Me@42 292 VMS__start_the_work_then_wait_until_done();
Me@42 293
Me@42 294 void
Me@42 295 VMS__start_the_work_then_wait_until_done_Seq();
Me@42 296
Me@42 297 VirtProcr *
Me@42 298 VMS__create_procr( VirtProcrFnPtr fnPtr, void *initialData );
Me@42 299
Me@53 300 void
Me@53 301 VMS__dissipate_procr( VirtProcr *procrToDissipate );
Me@53 302
Me@50 303 //Use this to create processor inside entry point & other places outside
Me@50 304 // the VMS system boundary (IE, not run in slave nor Master)
Me@50 305 VirtProcr *
Me@50 306 VMS_ext__create_procr( VirtProcrFnPtr fnPtr, void *initialData );
Me@50 307
Me@53 308 void
Me@53 309 VMS_ext__dissipate_procr( VirtProcr *procrToDissipate );
Me@42 310
Me@50 311 void
Me@54 312 VMS__throw_exception( char *msgStr, VirtProcr *reqstPr, VMSExcp *excpData );
Me@54 313
Me@54 314 void
Me@53 315 VMS__shutdown();
Me@53 316
Me@53 317 void
Me@53 318 VMS__cleanup_at_end_of_shutdown();
Me@50 319
Me@50 320
Me@50 321 //============== Request Related ===============
Me@50 322
Me@50 323 void
Me@50 324 VMS__suspend_procr( VirtProcr *callingPr );
Me@50 325
Me@42 326 inline void
Me@53 327 VMS__add_sem_request_in_mallocd_VMSReqst( void *semReqData, VirtProcr *callingPr );
Me@53 328
Me@53 329 inline void
Me@53 330 VMS__send_sem_request( void *semReqData, VirtProcr *callingPr );
Me@42 331
Me@42 332 void
Me@50 333 VMS__send_create_procr_req( void *semReqData, VirtProcr *reqstingPr );
Me@42 334
Me@53 335 void inline
Me@53 336 VMS__send_dissipate_req( VirtProcr *prToDissipate );
Me@53 337
Me@52 338 inline void
Me@52 339 VMS__send_VMSSem_request( void *semReqData, VirtProcr *callingPr );
Me@52 340
Me@42 341 VMSReqst *
Me@50 342 VMS__take_next_request_out_of( VirtProcr *procrWithReq );
Me@42 343
Me@42 344 inline void *
Me@42 345 VMS__take_sem_reqst_from( VMSReqst *req );
Me@42 346
Me@53 347 //======================== STATS ======================
Me@42 348
Me@53 349 //===== RDTSC wrapper =====
Me@42 350
Me@42 351 #define saveTimeStampCountInto(low, high) \
Me@42 352 asm volatile("RDTSC; \
Me@42 353 movl %%eax, %0; \
Me@42 354 movl %%edx, %1;" \
Me@42 355 /* outputs */ : "=m" (low), "=m" (high)\
Me@42 356 /* inputs */ : \
Me@42 357 /* clobber */ : "%eax", "%edx" \
Me@42 358 );
Me@42 359
Me@42 360 #define saveLowTimeStampCountInto(low) \
Me@42 361 asm volatile("RDTSC; \
Me@42 362 movl %%eax, %0;" \
Me@42 363 /* outputs */ : "=m" (low) \
Me@42 364 /* inputs */ : \
Me@42 365 /* clobber */ : "%eax", "%edx" \
Me@42 366 );
Me@53 367 //=====
Me@42 368
Me@55 369 #include "SwitchAnimators.h"
Me@50 370 #include "probes.h"
Me@42 371
Me@42 372 #endif /* _VMS_H */
Me@42 373