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

annotate VMS.h @ 243:227cd4d33d94

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