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

annotate VMS.h @ 280:67b684afa736

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