annotate VSs.h @ 17:f83fff8bd4b2

finished instrumentation
author Nina Engelhardt <nengel@mailbox.tu-berlin.de>
date Fri, 31 Aug 2012 18:24:03 +0200
parents 1ffd5df22df9
children c9606ea7abc8
rev   line source
seanhalle@0 1 /*
seanhalle@0 2 * Copyright 2009 OpenSourceStewardshipFoundation.org
seanhalle@0 3 * Licensed under GNU General Public License version 2
seanhalle@0 4 *
seanhalle@0 5 * Author: seanhalle@yahoo.com
seanhalle@0 6 *
seanhalle@0 7 */
seanhalle@0 8
seanhalle@2 9 #ifndef _VSs_H
seanhalle@2 10 #define _VSs_H
seanhalle@0 11
seanhalle@0 12 #include "Queue_impl/PrivateQueue.h"
seanhalle@0 13 #include "Hash_impl/PrivateHash.h"
seanhalle@0 14 #include "VMS_impl/VMS.h"
seanhalle@3 15 #include "Measurement/dependency.h"
seanhalle@0 16
seanhalle@0 17
seanhalle@0 18 //===========================================================================
seanhalle@0 19 #define NUM_STRUCS_IN_SEM_ENV 1000
seanhalle@0 20
seanhalle@0 21 //This is hardware dependent -- it's the number of cycles of scheduling
seanhalle@0 22 // overhead -- if a work unit is fewer than this, it is better being
seanhalle@0 23 // combined sequentially with other work
seanhalle@2 24 //This value depends on both VMS overhead and VSs's plugin. At some point
seanhalle@2 25 // it will be derived by perf-counter measurements during init of VSs
seanhalle@0 26 #define MIN_WORK_UNIT_CYCLES 20000
seanhalle@0 27
seanhalle@0 28 //===========================================================================
seanhalle@2 29 /*This header defines everything specific to the VSs semantic plug-in
seanhalle@0 30 */
seanhalle@2 31 typedef struct _VSsSemReq VSsSemReq;
seanhalle@3 32 typedef void (*VSsTaskFnPtr ) ( void *, SlaveVP *);
seanhalle@2 33 typedef void (*PtrToAtomicFn ) ( void * ); //executed atomically in master
seanhalle@0 34 //===========================================================================
seanhalle@0 35
seanhalle@4 36 #define NONCTLD 0
seanhalle@4 37 #define IN 1 /*Trick -- READER same as IN*/
seanhalle@4 38 #define OUT 2 /*Trick -- WRITER same as OUT and INOUT*/
seanhalle@4 39 #define INOUT 2 /*Trick -- WRITER same as OUT and INOUT*/
seanhalle@2 40
seanhalle@4 41 #define READER 1 /*Trick -- READER same as IN*/
seanhalle@4 42 #define WRITER 2 /*Trick -- WRITER same as OUT and INOUT*/
seanhalle@1 43
seanhalle@8 44 #define IS_A_THREAD NULL
seanhalle@8 45 #define IS_ENDED NULL
seanhalle@8 46 #define SEED_SLV NULL
seanhalle@8 47
seanhalle@1 48 typedef struct
seanhalle@1 49 {
seanhalle@1 50 VSsTaskFnPtr fn;
seanhalle@2 51 int32 numTotalArgs;//the number of inputs to function
seanhalle@2 52 int32 numCtldArgs;//how many of args have dependencies
seanhalle@2 53 int32 *argTypes; //says reader, writer, or non-ctld
seanhalle@2 54 int32 *argSizes; //for detecting overlap
seanhalle@2 55 int32 sizeOfArgs; //for memcpy of args struct
seanhalle@1 56 }
seanhalle@1 57 VSsTaskType;
seanhalle@1 58
seanhalle@1 59
seanhalle@2 60 typedef struct
seanhalle@2 61 {
seanhalle@3 62 bool32 hasEnabledNonFinishedWriter;
seanhalle@3 63 int32 numEnabledNonDoneReaders;
seanhalle@3 64 PrivQueueStruc *waitersQ;
nengel@16 65 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
nengel@17 66 Unit lastWriter;
nengel@17 67 ListOfArrays* readersSinceLastWriter;
nengel@16 68 #endif
seanhalle@3 69 }
seanhalle@3 70 VSsPointerEntry;
seanhalle@3 71
seanhalle@6 72 typedef struct
seanhalle@3 73 {
seanhalle@2 74 void **args; //ctld args must come first, as ptrs
seanhalle@2 75 VSsTaskType *taskType;
seanhalle@4 76 int32 *taskID;
seanhalle@2 77 int32 numBlockingProp;
seanhalle@10 78 SlaveVP *slaveAssignedTo; //only valid before end task (thread)
seanhalle@3 79 VSsPointerEntry **ptrEntries;
nengel@11 80 void* parentTaskStub;
seanhalle@8 81 int32 numLiveChildTasks;
seanhalle@8 82 int32 numLiveChildThreads;
seanhalle@8 83 bool32 isWaitingForChildTasksToEnd;
seanhalle@8 84 bool32 isWaitingForChildThreadsToEnd;
seanhalle@8 85 bool32 isEnded;
nengel@17 86 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
nengel@17 87 Unit parentUnit;
nengel@17 88 #endif
seanhalle@2 89 }
seanhalle@6 90 VSsTaskStub;
nengel@5 91
seanhalle@2 92
seanhalle@2 93 typedef struct
seanhalle@2 94 {
seanhalle@2 95 VSsTaskStub *taskStub;
seanhalle@2 96 int32 argNum;
seanhalle@2 97 int32 isReader;
seanhalle@2 98 }
seanhalle@2 99 VSsTaskStubCarrier;
seanhalle@2 100
seanhalle@2 101
seanhalle@0 102 /*Semantic layer-specific data sent inside a request from lib called in app
seanhalle@0 103 * to request handler called in AnimationMaster
seanhalle@0 104 */
seanhalle@0 105
seanhalle@0 106 typedef struct
seanhalle@0 107 {
seanhalle@0 108 SlaveVP *VPCurrentlyExecuting;
seanhalle@0 109 PrivQueueStruc *waitingVPQ;
seanhalle@0 110 }
seanhalle@2 111 VSsTrans;
seanhalle@0 112
seanhalle@0 113 /*WARNING: assembly hard-codes position of endInstrAddr as first field
seanhalle@0 114 */
seanhalle@0 115 typedef struct
seanhalle@0 116 {
seanhalle@0 117 void *endInstrAddr;
seanhalle@0 118 int32 hasBeenStarted;
seanhalle@0 119 int32 hasFinished;
seanhalle@0 120 PrivQueueStruc *waitQ;
nengel@17 121 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
nengel@17 122 Unit executingUnit;
nengel@17 123 #endif
seanhalle@0 124 }
seanhalle@2 125 VSsSingleton;
seanhalle@0 126
seanhalle@2 127 enum VSsReqType
seanhalle@0 128 {
seanhalle@2 129 submit_task = 1,
seanhalle@2 130 end_task,
seanhalle@2 131 create_slave,
seanhalle@2 132 create_slave_w_aff,
seanhalle@2 133 dissipate_slave,
seanhalle@2 134 //===============================
seanhalle@4 135 send_type_to,
seanhalle@4 136 receive_type_to,
seanhalle@4 137 send_from_to,
seanhalle@4 138 receive_from_to,
seanhalle@4 139 //===============================
nengel@5 140 taskwait,
seanhalle@0 141 malloc_req,
seanhalle@0 142 free_req,
seanhalle@0 143 singleton_fn_start,
seanhalle@0 144 singleton_fn_end,
seanhalle@0 145 singleton_data_start,
seanhalle@0 146 singleton_data_end,
seanhalle@0 147 atomic,
seanhalle@0 148 trans_start,
seanhalle@0 149 trans_end
seanhalle@0 150 };
seanhalle@0 151
seanhalle@2 152 struct _VSsSemReq
seanhalle@2 153 { enum VSsReqType reqType;
seanhalle@2 154 SlaveVP *callingSlv;
seanhalle@2 155 VSsTaskType *taskType;
seanhalle@2 156 void *args;
seanhalle@2 157 VSsTaskStub *taskStub;
seanhalle@2 158
seanhalle@4 159 SlaveVP *senderSlv;
seanhalle@4 160 SlaveVP *receiverSlv;
seanhalle@4 161 int32 *senderID;
seanhalle@4 162 int32 *receiverID;
seanhalle@4 163 int32 msgType;
seanhalle@4 164 void *msg;
seanhalle@4 165 VSsSemReq *nextReqInHashEntry;
seanhalle@4 166 int32 *taskID;
seanhalle@4 167
seanhalle@2 168 TopLevelFnPtr fnPtr;
seanhalle@0 169 void *initData;
seanhalle@0 170 int32 coreToAssignOnto;
seanhalle@0 171
seanhalle@0 172 int32 sizeToMalloc;
seanhalle@0 173 void *ptrToFree;
seanhalle@0 174
seanhalle@0 175 int32 singletonID;
seanhalle@2 176 VSsSingleton **singletonPtrAddr;
seanhalle@0 177
seanhalle@0 178 PtrToAtomicFn fnToExecInMaster;
seanhalle@0 179 void *dataForFn;
seanhalle@0 180
seanhalle@0 181 int32 transID;
seanhalle@0 182 }
seanhalle@2 183 /* VSsSemReq */;
seanhalle@0 184
seanhalle@0 185
seanhalle@0 186 typedef struct
seanhalle@0 187 {
seanhalle@9 188 PrivQueueStruc *slavesReadyToResumeQ; //Shared (slaves not pinned)
seanhalle@9 189 PrivQueueStruc *freeExtraTaskSlvQ; //Shared
seanhalle@9 190 PrivQueueStruc *taskReadyQ; //Shared (tasks not pinned)
seanhalle@10 191 SlaveVP *slotTaskSlvs[NUM_CORES][NUM_ANIM_SLOTS];
seanhalle@2 192 HashTable *argPtrHashTbl;
seanhalle@4 193 HashTable *commHashTbl;
seanhalle@8 194 int32 numLiveExtraTaskSlvs;
seanhalle@8 195 int32 numLiveThreadSlvs;
seanhalle@3 196 int32 nextCoreToGetNewSlv;
seanhalle@0 197 int32 primitiveStartTime;
seanhalle@0 198
seanhalle@0 199 //fix limit on num with dynArray
seanhalle@2 200 VSsSingleton fnSingletons[NUM_STRUCS_IN_SEM_ENV];
seanhalle@2 201 VSsTrans transactionStrucs[NUM_STRUCS_IN_SEM_ENV];
seanhalle@3 202
seanhalle@3 203 bool32 *coreIsDone;
seanhalle@3 204 int32 numCoresDone;
seanhalle@0 205
seanhalle@0 206 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
seanhalle@0 207 ListOfArrays* unitList;
seanhalle@0 208 ListOfArrays* ctlDependenciesList;
seanhalle@0 209 ListOfArrays* commDependenciesList;
nengel@16 210 ListOfArrays* dataDependenciesList;
nengel@17 211 ListOfArrays* warDependenciesList;
seanhalle@0 212 NtoN** ntonGroups;
seanhalle@0 213 PrivDynArrayInfo* ntonGroupsInfo;
seanhalle@0 214 ListOfArrays* dynDependenciesList;
nengel@16 215 ListOfArrays* singletonDependenciesList;
seanhalle@0 216 Unit last_in_slot[NUM_CORES * NUM_ANIM_SLOTS];
seanhalle@0 217 ListOfArrays* hwArcs;
seanhalle@0 218 #endif
seanhalle@0 219
seanhalle@0 220 #ifdef HOLISTIC__TURN_ON_PERF_COUNTERS
seanhalle@0 221 ListOfArrays* counterList[NUM_CORES];
seanhalle@0 222 #endif
seanhalle@3 223 SlaveVP* idleSlv[NUM_CORES][NUM_ANIM_SLOTS];
seanhalle@0 224 int shutdownInitiated;
seanhalle@0 225 }
seanhalle@2 226 VSsSemEnv;
seanhalle@0 227
seanhalle@0 228
seanhalle@0 229 typedef struct _TransListElem TransListElem;
seanhalle@0 230 struct _TransListElem
seanhalle@0 231 {
seanhalle@0 232 int32 transID;
seanhalle@0 233 TransListElem *nextTrans;
seanhalle@0 234 };
seanhalle@0 235 //TransListElem
seanhalle@0 236
seanhalle@8 237 enum VSsSlvType
seanhalle@10 238 { ExtraTaskSlv = 1,
seanhalle@10 239 SlotTaskSlv,
seanhalle@10 240 ThreadSlv
seanhalle@8 241 };
nengel@5 242
seanhalle@0 243 typedef struct
seanhalle@0 244 {
seanhalle@14 245 int32 highestTransEntered;
seanhalle@14 246 TransListElem *lastTransEntered;
seanhalle@14 247 bool32 needsTaskAssigned;
seanhalle@14 248 VSsTaskStub *taskStub;
seanhalle@14 249 enum VSsSlvType slaveType;
seanhalle@0 250 }
seanhalle@2 251 VSsSemData;
seanhalle@0 252
seanhalle@0 253 //===========================================================================
seanhalle@0 254
seanhalle@0 255 void
seanhalle@2 256 VSs__create_seed_slave_and_do_work( TopLevelFnPtr fn, void *initData );
seanhalle@0 257
seanhalle@0 258 int32
seanhalle@2 259 VSs__giveMinWorkUnitCycles( float32 percentOverhead );
seanhalle@0 260
seanhalle@0 261 void
seanhalle@2 262 VSs__start_primitive();
seanhalle@0 263
seanhalle@0 264 int32
seanhalle@2 265 VSs__end_primitive_and_give_cycles();
seanhalle@0 266
seanhalle@0 267 int32
seanhalle@2 268 VSs__giveIdealNumWorkUnits();
seanhalle@0 269
seanhalle@0 270 int32
seanhalle@2 271 VSs__give_number_of_cores_to_schedule_onto();
seanhalle@0 272
seanhalle@0 273 //=======================
seanhalle@0 274
seanhalle@0 275 void
seanhalle@2 276 VSs__init();
seanhalle@0 277
seanhalle@0 278 void
seanhalle@2 279 VSs__cleanup_after_shutdown();
seanhalle@0 280
seanhalle@0 281 //=======================
seanhalle@0 282
seanhalle@4 283 SlaveVP *
seanhalle@7 284 VSs__create_thread( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 285 SlaveVP *creatingThd );
seanhalle@0 286
seanhalle@0 287 void
seanhalle@7 288 VSs__end_thread( SlaveVP *thdToEnd );
seanhalle@0 289
seanhalle@0 290 //=======================
seanhalle@2 291
seanhalle@2 292 #define VSs__malloc( numBytes, callingSlave ) VMS_App__malloc( numBytes, callingSlave)
seanhalle@2 293
seanhalle@2 294 #define VSs__free(ptrToFree, callingSlave ) VMS_App__free( ptrToFree, callingSlave )
seanhalle@2 295
seanhalle@2 296
seanhalle@2 297 //=======================
seanhalle@4 298 void
seanhalle@3 299 VSs__submit_task( VSsTaskType *taskType, void *args, SlaveVP *animSlv);
seanhalle@2 300
seanhalle@4 301 inline int32 *
seanhalle@4 302 VSs__create_taskID_of_size( int32 numInts, SlaveVP *animSlv );
seanhalle@4 303
seanhalle@4 304 void
seanhalle@4 305 VSs__submit_task_with_ID( VSsTaskType *taskType, void *args, int32 *taskID,
seanhalle@4 306 SlaveVP *animSlv);
seanhalle@0 307
seanhalle@0 308 void
seanhalle@2 309 VSs__end_task( SlaveVP *animSlv );
seanhalle@0 310
seanhalle@4 311 //=========================
nengel@5 312 void
nengel@5 313 VSs__taskwait(SlaveVP *animSlv);
nengel@5 314
seanhalle@4 315
seanhalle@4 316 inline int32 *
seanhalle@4 317 VSs__give_self_taskID( SlaveVP *animSlv );
seanhalle@4 318
seanhalle@4 319 void
seanhalle@4 320 VSs__send_of_type_to( void *msg, const int32 type, int32 *receiverID,
seanhalle@4 321 SlaveVP *senderSlv );
seanhalle@4 322
seanhalle@4 323 void
seanhalle@4 324 VSs__send_from_to( void *msg, int32 *senderID, int32 *receiverID, SlaveVP *senderSlv );
seanhalle@4 325
seanhalle@4 326 void *
seanhalle@4 327 VSs__receive_type_to( const int32 type, int32* receiverID, SlaveVP *receiverSlv );
seanhalle@4 328
seanhalle@4 329 void *
seanhalle@4 330 VSs__receive_from_to( int32 *senderID, int32 *receiverID, SlaveVP *receiverSlv );
seanhalle@0 331
seanhalle@0 332 //======================= Concurrency Stuff ======================
seanhalle@0 333 void
seanhalle@2 334 VSs__start_fn_singleton( int32 singletonID, SlaveVP *animSlv );
seanhalle@0 335
seanhalle@0 336 void
seanhalle@2 337 VSs__end_fn_singleton( int32 singletonID, SlaveVP *animSlv );
seanhalle@0 338
seanhalle@0 339 void
seanhalle@2 340 VSs__start_data_singleton( VSsSingleton **singeltonAddr, SlaveVP *animSlv );
seanhalle@0 341
seanhalle@0 342 void
seanhalle@2 343 VSs__end_data_singleton( VSsSingleton **singletonAddr, SlaveVP *animSlv );
seanhalle@0 344
seanhalle@0 345 void
seanhalle@2 346 VSs__animate_short_fn_in_isolation( PtrToAtomicFn ptrToFnToExecInMaster,
seanhalle@0 347 void *data, SlaveVP *animSlv );
seanhalle@0 348
seanhalle@0 349 void
seanhalle@2 350 VSs__start_transaction( int32 transactionID, SlaveVP *animSlv );
seanhalle@0 351
seanhalle@0 352 void
seanhalle@2 353 VSs__end_transaction( int32 transactionID, SlaveVP *animSlv );
seanhalle@0 354
seanhalle@0 355
seanhalle@0 356 //========================= Internal use only =============================
seanhalle@0 357 void
seanhalle@3 358 VSs__Request_Handler( SlaveVP *requestingSlv, void *_semEnv );
seanhalle@0 359
seanhalle@0 360 SlaveVP *
seanhalle@2 361 VSs__assign_slaveVP_to_slot( void *_semEnv, AnimSlot *slot );
seanhalle@0 362
seanhalle@0 363 SlaveVP*
seanhalle@2 364 VSs__create_slave_helper( TopLevelFnPtr fnPtr, void *initData,
seanhalle@2 365 VSsSemEnv *semEnv, int32 coreToAssignOnto );
seanhalle@0 366
seanhalle@7 367 VSsTaskStub *
seanhalle@8 368 create_thread_task_stub( void *initData );
seanhalle@7 369
seanhalle@7 370
seanhalle@7 371 SlaveVP *
seanhalle@7 372 VSs__create_slave_with( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 373 SlaveVP *creatingSlv );
seanhalle@7 374
seanhalle@7 375 SlaveVP *
seanhalle@7 376 VSs__create_slave_with_affinity( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 377 SlaveVP *creatingSlv, int32 coreToAssignOnto);
seanhalle@7 378
seanhalle@9 379 void
seanhalle@9 380 idle_fn(void* data, SlaveVP *animatingSlv);
seanhalle@7 381
seanhalle@0 382 //===================== Measurement of Lang Overheads =====================
seanhalle@3 383 #include "Measurement/VSs_Measurement.h"
seanhalle@0 384
seanhalle@0 385 //===========================================================================
seanhalle@2 386 #endif /* _VSs_H */
seanhalle@0 387