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

annotate VMS.h @ 255:2341dd049035

find changesets by author, revision, files, or words in the commit message
Updated default branch to working versions of all the sub repos
author Sean Halle <seanhalle@yahoo.com>
date Mon, 10 Sep 2012 01:11:54 -0700
parents f1267bc7b342
children f5b110414453 3740ac9cffee
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@215 13 #include "DynArray/DynArray.h"
seanhalle@215 14 #include "Hash_impl/PrivateHash.h"
seanhalle@215 15 #include "Histogram/Histogram.h"
seanhalle@215 16 #include "Queue_impl/PrivateQueue.h"
seanhalle@243 17
seanhalle@243 18 #include "VMS_primitive_data_types.h"
seanhalle@223 19 #include "Services_Offered_by_VMS/Memory_Handling/vmalloc.h"
seanhalle@208 20
seanhalle@208 21 #include <pthread.h>
seanhalle@208 22 #include <sys/time.h>
seanhalle@208 23
seanhalle@208 24 //================= Defines: included from separate files =================
seanhalle@208 25 //
seanhalle@208 26 // Note: ALL defines are in other files, none are in here
seanhalle@208 27 //
seanhalle@223 28 #include "Defines/VMS_defs.h"
seanhalle@208 29
seanhalle@208 30
seanhalle@208 31 //================================ Typedefs =================================
seanhalle@208 32 //
seanhalle@233 33 typedef unsigned long long TSCount;
seanhalle@208 34
seanhalle@235 35 typedef struct _AnimSlot AnimSlot;
seanhalle@208 36 typedef struct _VMSReqst VMSReqst;
seanhalle@208 37 typedef struct _SlaveVP SlaveVP;
seanhalle@208 38 typedef struct _MasterVP MasterVP;
seanhalle@208 39 typedef struct _IntervalProbe IntervalProbe;
seanhalle@208 40
seanhalle@208 41
seanhalle@235 42 typedef SlaveVP *(*SlaveAssigner) ( void *, AnimSlot*); //semEnv, slot for HW info
seanhalle@223 43 typedef void (*RequestHandler) ( SlaveVP *, void * ); //prWReqst, semEnv
seanhalle@223 44 typedef void (*TopLevelFnPtr) ( void *, SlaveVP * ); //initData, animSlv
seanhalle@223 45 typedef void TopLevelFn ( void *, SlaveVP * ); //initData, animSlv
seanhalle@223 46 typedef void (*ResumeSlvFnPtr) ( SlaveVP *, void * );
nengel@228 47 //=========== MEASUREMENT STUFF ==========
nengel@228 48 MEAS__Insert_Counter_Handler
nengel@228 49 //========================================
seanhalle@209 50
seanhalle@209 51 //============================ HW Dependent Fns ================================
seanhalle@209 52
seanhalle@243 53 #include "HW_Dependent_Primitives/VMS__HW_measurement.h"
seanhalle@243 54 #include "HW_Dependent_Primitives/VMS__primitives.h"
seanhalle@208 55
seanhalle@208 56
seanhalle@208 57 //============= Request Related ===========
seanhalle@208 58 //
seanhalle@208 59
seanhalle@208 60 enum VMSReqstType //avoid starting enums at 0, for debug reasons
seanhalle@208 61 {
seanhalle@208 62 semantic = 1,
seanhalle@208 63 createReq,
seanhalle@208 64 dissipate,
seanhalle@208 65 VMSSemantic //goes with VMSSemReqst below
seanhalle@208 66 };
seanhalle@208 67
seanhalle@208 68 struct _VMSReqst
seanhalle@208 69 {
seanhalle@208 70 enum VMSReqstType reqType;//used for dissipate and in future for IO requests
seanhalle@208 71 void *semReqData;
seanhalle@208 72
seanhalle@208 73 VMSReqst *nextReqst;
seanhalle@208 74 };
seanhalle@208 75 //VMSReqst
seanhalle@208 76
seanhalle@208 77 enum VMSSemReqstType //These are equivalent to semantic requests, but for
seanhalle@208 78 { // VMS's services available directly to app, like OS
seanhalle@245 79 make_probe = 1, // and probe services -- like a VMS-wide built-in lang
seanhalle@245 80 throw_excp,
seanhalle@208 81 openFile,
seanhalle@208 82 otherIO
seanhalle@208 83 };
seanhalle@208 84
seanhalle@208 85 typedef struct
seanhalle@208 86 { enum VMSSemReqstType reqType;
seanhalle@245 87 SlaveVP *requestingSlv;
seanhalle@208 88 char *nameStr; //for create probe
seanhalle@245 89 char *msgStr; //for exception
seanhalle@245 90 void *exceptionData;
seanhalle@208 91 }
seanhalle@208 92 VMSSemReq;
seanhalle@208 93
seanhalle@208 94
seanhalle@208 95 //==================== Core data structures ===================
seanhalle@208 96
seanhalle@231 97 typedef struct
seanhalle@231 98 {
seanhalle@231 99 //for future expansion
seanhalle@231 100 }
seanhalle@231 101 SlotPerfInfo;
seanhalle@231 102
seanhalle@235 103 struct _AnimSlot
seanhalle@208 104 {
seanhalle@230 105 int workIsDone;
seanhalle@230 106 int needsSlaveAssigned;
seanhalle@230 107 SlaveVP *slaveAssignedToSlot;
seanhalle@230 108
seanhalle@230 109 int slotIdx; //needed by Holistic Model's data gathering
seanhalle@237 110 int coreSlotIsOn;
seanhalle@230 111 SlotPerfInfo *perfInfo; //used by assigner to pick best slave for core
seanhalle@208 112 };
seanhalle@235 113 //AnimSlot
seanhalle@208 114
nengel@228 115 enum VPtype {
nengel@228 116 Slave = 1, //default
nengel@228 117 Master,
nengel@239 118 Shutdown,
nengel@239 119 Idle
nengel@228 120 };
nengel@228 121
seanhalle@233 122 /*This structure embodies the state of a slaveVP. It is reused for masterVP
seanhalle@233 123 * and shutdownVPs.
seanhalle@208 124 */
seanhalle@208 125 struct _SlaveVP
seanhalle@233 126 { //The offsets of these fields are hard-coded into assembly
seanhalle@233 127 void *stackPtr; //save the core's stack ptr when suspend
seanhalle@233 128 void *framePtr; //save core's frame ptr when suspend
seanhalle@233 129 void *resumeInstrPtr; //save core's program-counter when suspend
seanhalle@216 130 void *coreCtlrFramePtr; //restore before jmp back to core controller
seanhalle@216 131 void *coreCtlrStackPtr; //restore before jmp back to core controller
seanhalle@233 132
seanhalle@233 133 //============ below this, no fields are used in asm =============
seanhalle@235 134
seanhalle@235 135 int slaveID; //each slave given a globally unique ID
seanhalle@235 136 int coreAnimatedBy;
seanhalle@233 137 void *startOfStack; //used to free, and to point slave to Fn
seanhalle@235 138 enum VPtype typeOfVP; //Slave vs Master vs Shutdown..
seanhalle@235 139 int assignCount; //Each assign is for one work-unit, so IDs it
seanhalle@235 140 //note, a scheduling decision is uniquely identified by the triple:
seanhalle@235 141 // <slaveID, coreAnimatedBy, assignCount> -- used in record & replay
seanhalle@233 142
seanhalle@233 143 //for comm -- between master and coreCtlr & btwn wrapper lib and plugin
seanhalle@235 144 AnimSlot *animSlotAssignedTo;
seanhalle@233 145 VMSReqst *requests; //wrapper lib puts in requests, plugin takes out
seanhalle@233 146 void *dataRetFromReq;//Return vals from plugin to Wrapper Lib
seanhalle@208 147
seanhalle@235 148 //For using Slave as carrier for data
seanhalle@233 149 void *semanticData; //Lang saves lang-specific things in slave here
seanhalle@208 150
seanhalle@235 151 //=========== MEASUREMENT STUFF ==========
seanhalle@235 152 MEAS__Insert_Meas_Fields_into_Slave;
seanhalle@235 153 float64 createPtInSecs; //time VP created, in seconds
seanhalle@235 154 //========================================
seanhalle@208 155 };
seanhalle@208 156 //SlaveVP
seanhalle@208 157
seanhalle@233 158
seanhalle@233 159 /* The one and only global variable, holds many odds and ends
seanhalle@208 160 */
seanhalle@208 161 typedef struct
seanhalle@230 162 { //The offsets of these fields are hard-coded into assembly
seanhalle@243 163 void *coreCtlrReturnPt; //offset to this field used in asm
seanhalle@235 164 int8 falseSharePad1[256 - sizeof(void*)];
seanhalle@243 165 int32 masterLock; //offset to this field used in asm
seanhalle@235 166 int8 falseSharePad2[256 - sizeof(int32)];
seanhalle@233 167 //============ below this, no fields are used in asm =============
seanhalle@230 168
seanhalle@230 169 //Basic VMS infrastructure
seanhalle@230 170 SlaveVP **masterVPs;
seanhalle@235 171 AnimSlot ***allAnimSlots;
seanhalle@230 172
seanhalle@230 173 //plugin related
seanhalle@225 174 SlaveAssigner slaveAssigner;
seanhalle@208 175 RequestHandler requestHandler;
seanhalle@230 176 void *semanticEnv;
seanhalle@208 177
seanhalle@230 178 //Slave creation
seanhalle@230 179 int32 numSlavesCreated; //gives ordering to processor creation
seanhalle@230 180 int32 numSlavesAlive; //used to detect fail-safe shutdown
seanhalle@208 181
seanhalle@230 182 //Initialization related
seanhalle@230 183 int32 setupComplete; //use while starting up coreCtlr
seanhalle@230 184
seanhalle@230 185 //Memory management related
seanhalle@223 186 MallocArrays *freeLists;
seanhalle@230 187 int32 amtOfOutstandingMem;//total currently allocated
seanhalle@245 188
seanhalle@245 189 //Random number seeds -- random nums used in various places
seanhalle@245 190 uint32_t seed1;
seanhalle@245 191 uint32_t seed2;
seanhalle@245 192
seanhalle@208 193 //=========== MEASUREMENT STUFF =============
seanhalle@208 194 IntervalProbe **intervalProbes;
seanhalle@208 195 PrivDynArrayInfo *dynIntervalProbesInfo;
seanhalle@208 196 HashTable *probeNameHashTbl;
seanhalle@208 197 int32 masterCreateProbeID;
seanhalle@230 198 float64 createPtInSecs; //real-clock time VMS initialized
seanhalle@208 199 Histogram **measHists;
seanhalle@208 200 PrivDynArrayInfo *measHistsInfo;
seanhalle@209 201 MEAS__Insert_Susp_Meas_Fields_into_MasterEnv;
seanhalle@209 202 MEAS__Insert_Master_Meas_Fields_into_MasterEnv;
seanhalle@209 203 MEAS__Insert_Master_Lock_Meas_Fields_into_MasterEnv;
seanhalle@209 204 MEAS__Insert_Malloc_Meas_Fields_into_MasterEnv;
seanhalle@209 205 MEAS__Insert_Plugin_Meas_Fields_into_MasterEnv;
seanhalle@209 206 MEAS__Insert_System_Meas_Fields_into_MasterEnv;
nengel@228 207 MEAS__Insert_Counter_Meas_Fields_into_MasterEnv;
seanhalle@208 208 //==========================================
seanhalle@208 209 }
seanhalle@208 210 MasterEnv;
seanhalle@208 211
seanhalle@208 212 //========================= Extra Stuff Data Strucs =======================
seanhalle@208 213 typedef struct
seanhalle@208 214 {
seanhalle@208 215
seanhalle@208 216 }
seanhalle@208 217 VMSExcp;
seanhalle@208 218
seanhalle@208 219 //======================= OS Thread related ===============================
seanhalle@208 220
seanhalle@216 221 void * coreController( void *paramsIn ); //standard PThreads fn prototype
seanhalle@216 222 void * coreCtlr_Seq( void *paramsIn ); //standard PThreads fn prototype
seanhalle@230 223 void animationMaster( void *initData, SlaveVP *masterVP );
seanhalle@208 224
seanhalle@208 225
seanhalle@208 226 typedef struct
seanhalle@208 227 {
seanhalle@208 228 void *endThdPt;
seanhalle@208 229 unsigned int coreNum;
seanhalle@208 230 }
seanhalle@208 231 ThdParams;
seanhalle@208 232
seanhalle@209 233 //============================= Global Vars ================================
seanhalle@209 234
seanhalle@215 235 volatile MasterEnv *_VMSMasterEnv __align_to_cacheline__;
seanhalle@215 236
seanhalle@233 237 //these are global, but only used for startup and shutdown
seanhalle@222 238 pthread_t coreCtlrThdHandles[ NUM_CORES ]; //pthread's virt-procr state
seanhalle@216 239 ThdParams *coreCtlrThdParams [ NUM_CORES ];
seanhalle@222 240
seanhalle@222 241 pthread_mutex_t suspendLock;
seanhalle@222 242 pthread_cond_t suspendCond;
seanhalle@208 243
seanhalle@208 244 //========================= Function Prototypes ===========================
seanhalle@233 245 /* MEANING OF WL PI SS int VMSOS
seanhalle@209 246 * These indicate which places the function is safe to use. They stand for:
seanhalle@233 247 *
seanhalle@233 248 * WL Wrapper Library -- wrapper lib code should only use these
seanhalle@233 249 * PI Plugin -- plugin code should only use these
seanhalle@233 250 * SS Startup and Shutdown -- designates these relate to startup & shutdown
seanhalle@233 251 * int internal to VMS -- should not be used in wrapper lib or plugin
seanhalle@233 252 * VMSOS means "OS functions for applications to use"
seanhalle@233 253 *
seanhalle@233 254 * VMS_int__ functions touch internal VMS data structs and are only safe
seanhalle@233 255 * to be used inside the master lock. However, occasionally, they appear
seanhalle@233 256 * in wrapper-lib or plugin code. In those cases, very careful analysis
seanhalle@233 257 * has been done to be sure no concurrency issues could arise.
seanhalle@233 258 *
seanhalle@233 259 * VMS_WL__ functions are all safe for use outside the master lock.
seanhalle@233 260 *
seanhalle@233 261 * VMSOS are only safe for applications to use -- they're like a second
seanhalle@233 262 * language mixed in -- but they can't be used inside plugin code, and
seanhalle@233 263 * aren't meant for use in wrapper libraries, because they are themselves
seanhalle@233 264 * wrapper-library calls!
seanhalle@209 265 */
seanhalle@233 266 //========== Startup and shutdown ==========
seanhalle@208 267 void
seanhalle@209 268 VMS_SS__init();
seanhalle@208 269
seanhalle@208 270 void
seanhalle@209 271 VMS_SS__start_the_work_then_wait_until_done();
seanhalle@208 272
nengel@228 273 SlaveVP*
nengel@228 274 VMS_SS__create_shutdown_slave();
nengel@228 275
seanhalle@208 276 void
seanhalle@209 277 VMS_SS__shutdown();
seanhalle@208 278
seanhalle@208 279 void
seanhalle@209 280 VMS_SS__cleanup_at_end_of_shutdown();
seanhalle@208 281
seanhalle@208 282
seanhalle@208 283 //============== ===============
seanhalle@208 284
seanhalle@208 285 inline SlaveVP *
seanhalle@209 286 VMS_int__create_slaveVP( TopLevelFnPtr fnPtr, void *dataParam );
seanhalle@209 287 #define VMS_PI__create_slaveVP VMS_int__create_slaveVP
seanhalle@209 288 #define VMS_WL__create_slaveVP VMS_int__create_slaveVP
seanhalle@208 289
seanhalle@210 290 //Use this to create processor inside entry point & other places outside
seanhalle@210 291 // the VMS system boundary (IE, don't animate with a SlaveVP or MasterVP)
seanhalle@210 292 SlaveVP *
seanhalle@210 293 VMS_ext__create_slaveVP( TopLevelFnPtr fnPtr, void *dataParam );
seanhalle@210 294
seanhalle@210 295 inline SlaveVP *
seanhalle@210 296 VMS_int__create_slaveVP_helper( SlaveVP *newSlv, TopLevelFnPtr fnPtr,
seanhalle@210 297 void *dataParam, void *stackLocs );
seanhalle@210 298
seanhalle@208 299 inline void
seanhalle@243 300 VMS_int__reset_slaveVP_to_TopLvlFn( SlaveVP *slaveVP, TopLevelFnPtr fnPtr,
seanhalle@219 301 void *dataParam);
seanhalle@208 302
seanhalle@243 303 inline void
seanhalle@243 304 VMS_int__point_slaveVP_to_OneParamFn( SlaveVP *slaveVP, void *fnPtr,
seanhalle@243 305 void *param);
seanhalle@243 306
seanhalle@243 307 inline void
seanhalle@243 308 VMS_int__point_slaveVP_to_TwoParamFn( SlaveVP *slaveVP, void *fnPtr,
seanhalle@243 309 void *param1, void *param2);
seanhalle@243 310
seanhalle@208 311 void
seanhalle@210 312 VMS_int__dissipate_slaveVP( SlaveVP *slaveToDissipate );
seanhalle@210 313 #define VMS_PI__dissipate_slaveVP VMS_int__dissipate_slaveVP
seanhalle@210 314 //WL: dissipate a SlaveVP by sending a request
seanhalle@208 315
seanhalle@208 316 void
seanhalle@209 317 VMS_ext__dissipate_slaveVP( SlaveVP *slaveToDissipate );
seanhalle@208 318
seanhalle@208 319 void
seanhalle@209 320 VMS_int__throw_exception( char *msgStr, SlaveVP *reqstSlv, VMSExcp *excpData );
seanhalle@245 321 #define VMS_PI__throw_exception VMS_int__throw_exception
seanhalle@245 322 void
seanhalle@245 323 VMS_WL__throw_exception( char *msgStr, SlaveVP *reqstSlv, VMSExcp *excpData );
seanhalle@245 324 #define VMS_App__throw_exception VMS_WL__throw_exception
seanhalle@208 325
seanhalle@208 326 void *
seanhalle@209 327 VMS_int__give_sem_env_for( SlaveVP *animSlv );
seanhalle@209 328 #define VMS_PI__give_sem_env_for VMS_int__give_sem_env_for
seanhalle@209 329 #define VMS_SS__give_sem_env_for VMS_int__give_sem_env_for
seanhalle@209 330 //No WL version -- not safe! if use in WL, be sure data rd & wr is stable
seanhalle@208 331
seanhalle@245 332
seanhalle@245 333 inline void
seanhalle@245 334 VMS_int__get_master_lock();
seanhalle@245 335
seanhalle@245 336 #define VMS_int__release_master_lock() _VMSMasterEnv->masterLock = UNLOCKED
seanhalle@245 337
seanhalle@245 338 inline uint32_t
seanhalle@245 339 VMS_int__randomNumber();
seanhalle@245 340
seanhalle@208 341 //============== Request Related ===============
seanhalle@208 342
seanhalle@208 343 void
seanhalle@209 344 VMS_int__suspend_slaveVP_and_send_req( SlaveVP *callingSlv );
seanhalle@208 345
seanhalle@208 346 inline void
seanhalle@209 347 VMS_WL__add_sem_request_in_mallocd_VMSReqst( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 348
seanhalle@208 349 inline void
seanhalle@209 350 VMS_WL__send_sem_request( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 351
seanhalle@208 352 void
seanhalle@209 353 VMS_WL__send_create_slaveVP_req( void *semReqData, SlaveVP *reqstingSlv );
seanhalle@208 354
seanhalle@208 355 void inline
seanhalle@208 356 VMS_WL__send_dissipate_req( SlaveVP *prToDissipate );
seanhalle@208 357
seanhalle@208 358 inline void
seanhalle@209 359 VMS_WL__send_VMSSem_request( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 360
seanhalle@208 361 VMSReqst *
seanhalle@209 362 VMS_PI__take_next_request_out_of( SlaveVP *slaveWithReq );
seanhalle@246 363 //#define VMS_PI__take_next_request_out_of( slave ) slave->requests
seanhalle@208 364
seanhalle@246 365 //inline void *
seanhalle@246 366 //VMS_PI__take_sem_reqst_from( VMSReqst *req );
seanhalle@246 367 #define VMS_PI__take_sem_reqst_from( req ) req->semReqData
seanhalle@208 368
seanhalle@208 369 void inline
seanhalle@209 370 VMS_PI__handle_VMSSemReq( VMSReqst *req, SlaveVP *requestingSlv, void *semEnv,
seanhalle@209 371 ResumeSlvFnPtr resumeSlvFnPtr );
seanhalle@208 372
seanhalle@208 373 //======================== MEASUREMENT ======================
seanhalle@208 374 uint64
seanhalle@208 375 VMS_WL__give_num_plugin_cycles();
seanhalle@208 376 uint32
seanhalle@208 377 VMS_WL__give_num_plugin_animations();
seanhalle@208 378
seanhalle@208 379
seanhalle@210 380 //========================= Utilities =======================
seanhalle@210 381 inline char *
seanhalle@210 382 VMS_int__strDup( char *str );
seanhalle@208 383
seanhalle@210 384
seanhalle@210 385 //========================= Probes =======================
seanhalle@223 386 #include "Services_Offered_by_VMS/Measurement_and_Stats/probes.h"
seanhalle@210 387
seanhalle@210 388 //================================================
seanhalle@208 389 #endif /* _VMS_H */
seanhalle@208 390