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

annotate VMS.h @ 239:7ed97c961901

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