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