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

annotate VMS.h @ 223:b0b93147adfb

find changesets by author, revision, files, or words in the commit message
More rearrangement -- have "Services_Offered_by_VMS" directory now, w/Debug etc
author Some Random Person <seanhalle@yahoo.com>
date Tue, 13 Mar 2012 18:28:04 -0700
parents c88ce1db91ef
children 309559064073
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@208 32 typedef unsigned long long TSCount;
seanhalle@208 33 typedef union
seanhalle@208 34 { uint32 lowHigh[2];
seanhalle@208 35 uint64 longVal;
seanhalle@208 36 }
seanhalle@208 37 TSCountLowHigh;
seanhalle@208 38
seanhalle@208 39 typedef struct _SchedSlot SchedSlot;
seanhalle@208 40 typedef struct _VMSReqst VMSReqst;
seanhalle@208 41 typedef struct _SlaveVP SlaveVP;
seanhalle@208 42 typedef struct _MasterVP MasterVP;
seanhalle@208 43 typedef struct _IntervalProbe IntervalProbe;
seanhalle@208 44 typedef struct _GateStruc GateStruc;
seanhalle@208 45
seanhalle@208 46
seanhalle@223 47 typedef SlaveVP *(*SlaveAssigner) ( void *, int, SchedSlot *); //semEnv, coreIdx, slot for HW info
seanhalle@223 48 typedef void (*RequestHandler) ( SlaveVP *, void * ); //prWReqst, semEnv
seanhalle@223 49 typedef void (*TopLevelFnPtr) ( void *, SlaveVP * ); //initData, animSlv
seanhalle@223 50 typedef void TopLevelFn ( void *, SlaveVP * ); //initData, animSlv
seanhalle@223 51 typedef void (*ResumeSlvFnPtr) ( SlaveVP *, void * );
seanhalle@209 52
seanhalle@209 53 //============================ HW Dependent Fns ================================
seanhalle@209 54
seanhalle@216 55 #include "Hardware_Dependent/VMS__HW_measurement.h"
seanhalle@216 56 #include "Hardware_Dependent/VMS__primitives.h"
seanhalle@208 57
seanhalle@208 58 //============================= Statistics ==================================
seanhalle@208 59
seanhalle@208 60 inline TSCount getTSCount();
seanhalle@208 61
seanhalle@208 62 //============= Request Related ===========
seanhalle@208 63 //
seanhalle@208 64
seanhalle@208 65 enum VMSReqstType //avoid starting enums at 0, for debug reasons
seanhalle@208 66 {
seanhalle@208 67 semantic = 1,
seanhalle@208 68 createReq,
seanhalle@208 69 dissipate,
seanhalle@208 70 VMSSemantic //goes with VMSSemReqst below
seanhalle@208 71 };
seanhalle@208 72
seanhalle@208 73 struct _VMSReqst
seanhalle@208 74 {
seanhalle@208 75 enum VMSReqstType reqType;//used for dissipate and in future for IO requests
seanhalle@208 76 void *semReqData;
seanhalle@208 77
seanhalle@208 78 VMSReqst *nextReqst;
seanhalle@208 79 };
seanhalle@208 80 //VMSReqst
seanhalle@208 81
seanhalle@208 82 enum VMSSemReqstType //These are equivalent to semantic requests, but for
seanhalle@208 83 { // VMS's services available directly to app, like OS
seanhalle@208 84 createProbe = 1, // and probe services -- like a VMS-wide built-in lang
seanhalle@208 85 openFile,
seanhalle@208 86 otherIO
seanhalle@208 87 };
seanhalle@208 88
seanhalle@208 89 typedef struct
seanhalle@208 90 { enum VMSSemReqstType reqType;
seanhalle@209 91 SlaveVP *requestingSlv;
seanhalle@208 92 char *nameStr; //for create probe
seanhalle@208 93 }
seanhalle@208 94 VMSSemReq;
seanhalle@208 95
seanhalle@208 96
seanhalle@208 97 //==================== Core data structures ===================
seanhalle@208 98
seanhalle@208 99 struct _SchedSlot
seanhalle@208 100 {
seanhalle@223 101 int slotIdx; //needed by Holistic Model's data gathering
seanhalle@208 102 int workIsDone;
seanhalle@209 103 int needsSlaveAssigned;
seanhalle@223 104 SlaveVP *slaveAssignedToSlot;
seanhalle@208 105 };
seanhalle@208 106 //SchedSlot
seanhalle@208 107
seanhalle@209 108 /*WARNING: re-arranging this data structure could cause Slv switching
seanhalle@208 109 * assembly code to fail -- hard-codes offsets of fields
seanhalle@208 110 */
seanhalle@208 111 struct _SlaveVP
seanhalle@215 112 { int slaveID; //each slave given a unique ID
seanhalle@208 113 int coreAnimatedBy;
seanhalle@208 114 void *startOfStack;
seanhalle@208 115 void *stackPtr;
seanhalle@208 116 void *framePtr;
seanhalle@208 117 void *resumeInstrPtr;
seanhalle@208 118
seanhalle@216 119 void *coreCtlrStartPt; //allows proto-runtime to be linked later
seanhalle@216 120 void *coreCtlrFramePtr; //restore before jmp back to core controller
seanhalle@216 121 void *coreCtlrStackPtr; //restore before jmp back to core controller
seanhalle@208 122
seanhalle@208 123 SchedSlot *schedSlot;
seanhalle@208 124 VMSReqst *requests;
seanhalle@208 125
seanhalle@210 126 void *semanticData; //this is live for the life of Slv
seanhalle@210 127 void *dataRetFromReq;//Used to return vals from plugin to Wrapper Lib
seanhalle@208 128
seanhalle@208 129 //=========== MEASUREMENT STUFF ==========
seanhalle@209 130 MEAS__Insert_Meas_Fields_into_Slave;
seanhalle@208 131 //========================================
seanhalle@208 132
seanhalle@208 133 float64 createPtInSecs; //have space but don't use on some configs
seanhalle@208 134 };
seanhalle@208 135 //SlaveVP
seanhalle@208 136
seanhalle@208 137
seanhalle@209 138 /*WARNING: re-arranging this data structure could cause Slv-switching
seanhalle@208 139 * assembly code to fail -- hard-codes offsets of fields
seanhalle@208 140 * (because -O3 messes with things otherwise)
seanhalle@208 141 */
seanhalle@208 142 typedef struct
seanhalle@208 143 {
seanhalle@223 144 SlaveAssigner slaveAssigner;
seanhalle@208 145 RequestHandler requestHandler;
seanhalle@208 146
seanhalle@208 147 SchedSlot ***allSchedSlots;
seanhalle@210 148 VMSQueueStruc **readyToAnimateQs;
seanhalle@210 149 SlaveVP **masterVPs;
seanhalle@208 150
seanhalle@208 151 void *semanticEnv;
seanhalle@208 152 void *OSEventStruc; //for future, when add I/O to BLIS
seanhalle@223 153 MallocArrays *freeLists;
seanhalle@208 154 int32 amtOfOutstandingMem; //total currently allocated
seanhalle@208 155
seanhalle@216 156 void *coreCtlrReturnPt;//addr to jump to to re-enter coreCtlr
seanhalle@208 157
seanhalle@208 158 int32 setupComplete;
seanhalle@209 159 int32 masterLock __align_to_cacheline__;
seanhalle@208 160 GateStruc *workStealingGates[ NUM_CORES ]; //concurrent work-steal
seanhalle@208 161 int32 workStealingLock;
seanhalle@208 162
seanhalle@209 163 int32 numSlavesCreated; //gives ordering to processor creation
seanhalle@209 164 int32 numSlavesAlive; //used to detect when to shutdown
seanhalle@208 165
seanhalle@208 166 //=========== MEASUREMENT STUFF =============
seanhalle@208 167 IntervalProbe **intervalProbes;
seanhalle@208 168 PrivDynArrayInfo *dynIntervalProbesInfo;
seanhalle@208 169 HashTable *probeNameHashTbl;
seanhalle@208 170 int32 masterCreateProbeID;
seanhalle@208 171 float64 createPtInSecs;
seanhalle@208 172 Histogram **measHists;
seanhalle@208 173 PrivDynArrayInfo *measHistsInfo;
seanhalle@209 174 MEAS__Insert_Susp_Meas_Fields_into_MasterEnv;
seanhalle@209 175 MEAS__Insert_Master_Meas_Fields_into_MasterEnv;
seanhalle@209 176 MEAS__Insert_Master_Lock_Meas_Fields_into_MasterEnv;
seanhalle@209 177 MEAS__Insert_Malloc_Meas_Fields_into_MasterEnv;
seanhalle@209 178 MEAS__Insert_Plugin_Meas_Fields_into_MasterEnv;
seanhalle@209 179 MEAS__Insert_System_Meas_Fields_into_MasterEnv;
seanhalle@208 180 //==========================================
seanhalle@208 181 }
seanhalle@208 182 MasterEnv;
seanhalle@208 183
seanhalle@208 184 //========================= Extra Stuff Data Strucs =======================
seanhalle@208 185 typedef struct
seanhalle@208 186 {
seanhalle@208 187
seanhalle@208 188 }
seanhalle@208 189 VMSExcp;
seanhalle@208 190
seanhalle@208 191 struct _GateStruc
seanhalle@208 192 {
seanhalle@208 193 int32 gateClosed;
seanhalle@208 194 int32 preGateProgress;
seanhalle@208 195 int32 waitProgress;
seanhalle@208 196 int32 exitProgress;
seanhalle@208 197 };
seanhalle@208 198 //GateStruc
seanhalle@208 199
seanhalle@208 200 //======================= OS Thread related ===============================
seanhalle@208 201
seanhalle@216 202 void * coreController( void *paramsIn ); //standard PThreads fn prototype
seanhalle@216 203 void * coreCtlr_Seq( void *paramsIn ); //standard PThreads fn prototype
seanhalle@222 204 void schedulingMaster( void *initData, SlaveVP *masterVP );
seanhalle@208 205
seanhalle@208 206
seanhalle@208 207 typedef struct
seanhalle@208 208 {
seanhalle@208 209 void *endThdPt;
seanhalle@208 210 unsigned int coreNum;
seanhalle@208 211 }
seanhalle@208 212 ThdParams;
seanhalle@208 213
seanhalle@209 214 //============================= Global Vars ================================
seanhalle@209 215
seanhalle@215 216 volatile MasterEnv *_VMSMasterEnv __align_to_cacheline__;
seanhalle@215 217
seanhalle@222 218 pthread_t coreCtlrThdHandles[ NUM_CORES ]; //pthread's virt-procr state
seanhalle@216 219 ThdParams *coreCtlrThdParams [ NUM_CORES ];
seanhalle@222 220
seanhalle@222 221 pthread_mutex_t suspendLock;
seanhalle@222 222 pthread_cond_t suspendCond;
seanhalle@208 223
seanhalle@208 224 //========================= Function Prototypes ===========================
seanhalle@208 225
seanhalle@209 226 /* MEANING OF WL PI SS int
seanhalle@209 227 * These indicate which places the function is safe to use. They stand for:
seanhalle@209 228 * WL: Wrapper Library
seanhalle@209 229 * PI: Plugin
seanhalle@209 230 * SS: Startup and Shutdown
seanhalle@209 231 * int: internal to the VMS implementation
seanhalle@209 232 */
seanhalle@208 233
seanhalle@208 234 //========== Setup and shutdown ==========
seanhalle@208 235 void
seanhalle@209 236 VMS_SS__init();
seanhalle@208 237
seanhalle@208 238 void
seanhalle@209 239 VMS_SS__start_the_work_then_wait_until_done();
seanhalle@208 240
seanhalle@208 241 void
seanhalle@209 242 VMS_SS__shutdown();
seanhalle@208 243
seanhalle@208 244 void
seanhalle@209 245 VMS_SS__cleanup_at_end_of_shutdown();
seanhalle@208 246
seanhalle@208 247
seanhalle@208 248 //============== ===============
seanhalle@208 249
seanhalle@208 250 inline SlaveVP *
seanhalle@209 251 VMS_int__create_slaveVP( TopLevelFnPtr fnPtr, void *dataParam );
seanhalle@209 252 #define VMS_PI__create_slaveVP VMS_int__create_slaveVP
seanhalle@209 253 #define VMS_WL__create_slaveVP VMS_int__create_slaveVP
seanhalle@208 254
seanhalle@210 255 //Use this to create processor inside entry point & other places outside
seanhalle@210 256 // the VMS system boundary (IE, don't animate with a SlaveVP or MasterVP)
seanhalle@210 257 SlaveVP *
seanhalle@210 258 VMS_ext__create_slaveVP( TopLevelFnPtr fnPtr, void *dataParam );
seanhalle@210 259
seanhalle@210 260 inline SlaveVP *
seanhalle@210 261 VMS_int__create_slaveVP_helper( SlaveVP *newSlv, TopLevelFnPtr fnPtr,
seanhalle@210 262 void *dataParam, void *stackLocs );
seanhalle@210 263
seanhalle@208 264 inline void
seanhalle@209 265 VMS_int__point_slaveVP_to_Fn( SlaveVP *slaveVP, TopLevelFnPtr fnPtr,
seanhalle@219 266 void *dataParam);
seanhalle@208 267
seanhalle@208 268 void
seanhalle@210 269 VMS_int__dissipate_slaveVP( SlaveVP *slaveToDissipate );
seanhalle@210 270 #define VMS_PI__dissipate_slaveVP VMS_int__dissipate_slaveVP
seanhalle@210 271 //WL: dissipate a SlaveVP by sending a request
seanhalle@208 272
seanhalle@208 273 void
seanhalle@209 274 VMS_ext__dissipate_slaveVP( SlaveVP *slaveToDissipate );
seanhalle@208 275
seanhalle@208 276 void
seanhalle@209 277 VMS_int__throw_exception( char *msgStr, SlaveVP *reqstSlv, VMSExcp *excpData );
seanhalle@209 278 #define VMS_PI__throw_exception VMS_int__throw_exception
seanhalle@209 279 #define VMS_WL__throw_exception VMS_int__throw_exception
seanhalle@208 280
seanhalle@208 281 void *
seanhalle@209 282 VMS_int__give_sem_env_for( SlaveVP *animSlv );
seanhalle@209 283 #define VMS_PI__give_sem_env_for VMS_int__give_sem_env_for
seanhalle@209 284 #define VMS_SS__give_sem_env_for VMS_int__give_sem_env_for
seanhalle@209 285 //No WL version -- not safe! if use in WL, be sure data rd & wr is stable
seanhalle@208 286
seanhalle@208 287 //============== Request Related ===============
seanhalle@208 288
seanhalle@208 289 void
seanhalle@209 290 VMS_int__suspend_slaveVP_and_send_req( SlaveVP *callingSlv );
seanhalle@208 291
seanhalle@208 292 inline void
seanhalle@209 293 VMS_WL__add_sem_request_in_mallocd_VMSReqst( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 294
seanhalle@208 295 inline void
seanhalle@209 296 VMS_WL__send_sem_request( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 297
seanhalle@208 298 void
seanhalle@209 299 VMS_WL__send_create_slaveVP_req( void *semReqData, SlaveVP *reqstingSlv );
seanhalle@208 300
seanhalle@208 301 void inline
seanhalle@208 302 VMS_WL__send_dissipate_req( SlaveVP *prToDissipate );
seanhalle@208 303
seanhalle@208 304 inline void
seanhalle@209 305 VMS_WL__send_VMSSem_request( void *semReqData, SlaveVP *callingSlv );
seanhalle@208 306
seanhalle@208 307 VMSReqst *
seanhalle@209 308 VMS_PI__take_next_request_out_of( SlaveVP *slaveWithReq );
seanhalle@208 309
seanhalle@208 310 inline void *
seanhalle@208 311 VMS_PI__take_sem_reqst_from( VMSReqst *req );
seanhalle@208 312
seanhalle@208 313 void inline
seanhalle@209 314 VMS_PI__handle_VMSSemReq( VMSReqst *req, SlaveVP *requestingSlv, void *semEnv,
seanhalle@209 315 ResumeSlvFnPtr resumeSlvFnPtr );
seanhalle@208 316
seanhalle@208 317 //======================== MEASUREMENT ======================
seanhalle@208 318 uint64
seanhalle@208 319 VMS_WL__give_num_plugin_cycles();
seanhalle@208 320 uint32
seanhalle@208 321 VMS_WL__give_num_plugin_animations();
seanhalle@208 322
seanhalle@208 323
seanhalle@210 324 //========================= Utilities =======================
seanhalle@210 325 inline char *
seanhalle@210 326 VMS_int__strDup( char *str );
seanhalle@208 327
seanhalle@210 328
seanhalle@210 329 //========================= Probes =======================
seanhalle@223 330 #include "Services_Offered_by_VMS/Measurement_and_Stats/probes.h"
seanhalle@210 331
seanhalle@210 332 //================================================
seanhalle@208 333 #endif /* _VMS_H */
seanhalle@208 334