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

annotate VMS.h @ 233:a0ac58d8201c

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