annotate VSs.h @ 2:f2ed1c379fe7

code nearly complete.. about to begin debugging
author Sean Halle <seanhalle@yahoo.com>
date Wed, 30 May 2012 15:02:38 -0700
parents 5ed4d833506e
children 468b8638ff92
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@0 15 #include "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@1 32 typedef void (*VSsTaskFnPtr ) ( void * ); //executed atomically in master
seanhalle@2 33 typedef void (*PtrToAtomicFn ) ( void * ); //executed atomically in master
seanhalle@0 34 //===========================================================================
seanhalle@0 35
seanhalle@2 36 #define IN 1
seanhalle@2 37 #define OUT 2
seanhalle@2 38 #define INOUT 3
seanhalle@2 39
seanhalle@2 40 #define READER 1
seanhalle@2 41 #define WRITER 2
seanhalle@1 42
seanhalle@1 43 typedef struct
seanhalle@1 44 {
seanhalle@1 45 VSsTaskFnPtr fn;
seanhalle@2 46 int32 numTotalArgs;//the number of inputs to function
seanhalle@2 47 int32 numCtldArgs;//how many of args have dependencies
seanhalle@2 48 int32 *argTypes; //says reader, writer, or non-ctld
seanhalle@2 49 int32 *argSizes; //for detecting overlap
seanhalle@2 50 int32 sizeOfArgs; //for memcpy of args struct
seanhalle@1 51 }
seanhalle@1 52 VSsTaskType;
seanhalle@1 53
seanhalle@1 54
seanhalle@2 55 typedef struct
seanhalle@2 56 {
seanhalle@2 57 void **args; //ctld args must come first, as ptrs
seanhalle@2 58 VSsTaskType *taskType;
seanhalle@2 59 int32 numBlockingProp;
seanhalle@2 60 SlaveVP *slaveAssignedTo;
seanhalle@2 61 }
seanhalle@2 62 VSsTaskStub;
seanhalle@2 63
seanhalle@2 64 typedef struct
seanhalle@2 65 {
seanhalle@2 66 VSsTaskStub *taskStub;
seanhalle@2 67 int32 argNum;
seanhalle@2 68 int32 isReader;
seanhalle@2 69 }
seanhalle@2 70 VSsTaskStubCarrier;
seanhalle@2 71
seanhalle@2 72 typedef struct
seanhalle@2 73 {
seanhalle@2 74 bool32 hasEnabledNonFinishedWriter;
seanhalle@2 75 int32 numEnabledNonDoneReaders;
seanhalle@2 76 PrivQStruct *waitersQ;
seanhalle@2 77 }
seanhalle@2 78 VSsPointerEntry;
seanhalle@2 79
seanhalle@2 80
seanhalle@2 81 typedef struct
seanhalle@2 82 {
seanhalle@2 83 int32 type;
seanhalle@2 84 VSsTaskStub *taskStub;
seanhalle@2 85 }
seanhalle@2 86 VSsWaiterCarrier;
seanhalle@1 87
seanhalle@0 88 /*Semantic layer-specific data sent inside a request from lib called in app
seanhalle@0 89 * to request handler called in AnimationMaster
seanhalle@0 90 */
seanhalle@0 91
seanhalle@0 92 typedef struct
seanhalle@0 93 {
seanhalle@0 94 SlaveVP *VPCurrentlyExecuting;
seanhalle@0 95 PrivQueueStruc *waitingVPQ;
seanhalle@0 96 }
seanhalle@2 97 VSsTrans;
seanhalle@0 98
seanhalle@0 99 /*WARNING: assembly hard-codes position of endInstrAddr as first field
seanhalle@0 100 */
seanhalle@0 101 typedef struct
seanhalle@0 102 {
seanhalle@0 103 void *endInstrAddr;
seanhalle@0 104 int32 hasBeenStarted;
seanhalle@0 105 int32 hasFinished;
seanhalle@0 106 PrivQueueStruc *waitQ;
seanhalle@0 107 }
seanhalle@2 108 VSsSingleton;
seanhalle@0 109
seanhalle@2 110 enum VSsReqType
seanhalle@0 111 {
seanhalle@2 112 submit_task = 1,
seanhalle@2 113 end_task,
seanhalle@2 114 create_slave,
seanhalle@2 115 create_slave_w_aff,
seanhalle@2 116 dissipate_slave,
seanhalle@2 117 //===============================
seanhalle@0 118 malloc_req,
seanhalle@0 119 free_req,
seanhalle@0 120 singleton_fn_start,
seanhalle@0 121 singleton_fn_end,
seanhalle@0 122 singleton_data_start,
seanhalle@0 123 singleton_data_end,
seanhalle@0 124 atomic,
seanhalle@0 125 trans_start,
seanhalle@0 126 trans_end
seanhalle@0 127 };
seanhalle@0 128
seanhalle@2 129 struct _VSsSemReq
seanhalle@2 130 { enum VSsReqType reqType;
seanhalle@2 131 SlaveVP *callingSlv;
seanhalle@2 132 VSsTaskType *taskType;
seanhalle@2 133 void *args;
seanhalle@2 134 VSsTaskStub *taskStub;
seanhalle@2 135
seanhalle@2 136 TopLevelFnPtr fnPtr;
seanhalle@0 137 void *initData;
seanhalle@0 138 int32 coreToAssignOnto;
seanhalle@0 139
seanhalle@0 140 int32 sizeToMalloc;
seanhalle@0 141 void *ptrToFree;
seanhalle@0 142
seanhalle@0 143 int32 singletonID;
seanhalle@2 144 VSsSingleton **singletonPtrAddr;
seanhalle@0 145
seanhalle@0 146 PtrToAtomicFn fnToExecInMaster;
seanhalle@0 147 void *dataForFn;
seanhalle@0 148
seanhalle@0 149 int32 transID;
seanhalle@0 150 }
seanhalle@2 151 /* VSsSemReq */;
seanhalle@0 152
seanhalle@0 153
seanhalle@0 154 typedef struct
seanhalle@0 155 {
seanhalle@0 156 PrivQueueStruc **readyVPQs;
seanhalle@2 157 PrivQueueStruc *taskReadyQ; //Q: shared or local?
seanhalle@2 158 HashTable *argPtrHashTbl;
seanhalle@0 159 int32 numSlaveVP;
seanhalle@0 160 int32 nextCoreToGetNewPr;
seanhalle@0 161 int32 primitiveStartTime;
seanhalle@0 162
seanhalle@0 163 //fix limit on num with dynArray
seanhalle@2 164 VSsSingleton fnSingletons[NUM_STRUCS_IN_SEM_ENV];
seanhalle@2 165 VSsTrans transactionStrucs[NUM_STRUCS_IN_SEM_ENV];
seanhalle@0 166
seanhalle@0 167 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
seanhalle@0 168 ListOfArrays* unitList;
seanhalle@0 169 ListOfArrays* ctlDependenciesList;
seanhalle@0 170 ListOfArrays* commDependenciesList;
seanhalle@0 171 NtoN** ntonGroups;
seanhalle@0 172 PrivDynArrayInfo* ntonGroupsInfo;
seanhalle@0 173 ListOfArrays* dynDependenciesList;
seanhalle@0 174 Unit last_in_slot[NUM_CORES * NUM_ANIM_SLOTS];
seanhalle@0 175 ListOfArrays* hwArcs;
seanhalle@0 176 #endif
seanhalle@0 177
seanhalle@0 178 #ifdef HOLISTIC__TURN_ON_PERF_COUNTERS
seanhalle@0 179 ListOfArrays* counterList[NUM_CORES];
seanhalle@0 180 #endif
seanhalle@0 181 SlaveVP* idlePr[NUM_CORES][NUM_ANIM_SLOTS];
seanhalle@0 182 int shutdownInitiated;
seanhalle@0 183 }
seanhalle@2 184 VSsSemEnv;
seanhalle@0 185
seanhalle@0 186
seanhalle@0 187 typedef struct _TransListElem TransListElem;
seanhalle@0 188 struct _TransListElem
seanhalle@0 189 {
seanhalle@0 190 int32 transID;
seanhalle@0 191 TransListElem *nextTrans;
seanhalle@0 192 };
seanhalle@0 193 //TransListElem
seanhalle@0 194
seanhalle@0 195 typedef struct
seanhalle@0 196 {
seanhalle@0 197 int32 highestTransEntered;
seanhalle@0 198 TransListElem *lastTransEntered;
seanhalle@2 199 bool32 needsTaskAssigned;
seanhalle@2 200 VSsTaskStub *taskStub;
seanhalle@0 201 }
seanhalle@2 202 VSsSemData;
seanhalle@0 203
seanhalle@0 204 //===========================================================================
seanhalle@0 205
seanhalle@0 206 void
seanhalle@2 207 VSs__create_seed_slave_and_do_work( TopLevelFnPtr fn, void *initData );
seanhalle@0 208
seanhalle@0 209 int32
seanhalle@2 210 VSs__giveMinWorkUnitCycles( float32 percentOverhead );
seanhalle@0 211
seanhalle@0 212 void
seanhalle@2 213 VSs__start_primitive();
seanhalle@0 214
seanhalle@0 215 int32
seanhalle@2 216 VSs__end_primitive_and_give_cycles();
seanhalle@0 217
seanhalle@0 218 int32
seanhalle@2 219 VSs__giveIdealNumWorkUnits();
seanhalle@0 220
seanhalle@0 221 int32
seanhalle@2 222 VSs__give_number_of_cores_to_schedule_onto();
seanhalle@0 223
seanhalle@0 224 //=======================
seanhalle@0 225
seanhalle@0 226 void
seanhalle@2 227 VSs__init();
seanhalle@0 228
seanhalle@0 229 void
seanhalle@2 230 VSs__cleanup_after_shutdown();
seanhalle@0 231
seanhalle@0 232 //=======================
seanhalle@0 233
seanhalle@0 234 SlaveVP *
seanhalle@2 235 VSs__create_slave_with( TopLevelFnPtr fnPtr, void *initData,
seanhalle@0 236 SlaveVP *creatingSlv );
seanhalle@0 237
seanhalle@0 238 SlaveVP *
seanhalle@2 239 VSs__create_slave_with_affinity( TopLevelFnPtr fnPtr, void *initData,
seanhalle@0 240 SlaveVP *creatingPr, int32 coreToAssignOnto);
seanhalle@0 241
seanhalle@0 242 void
seanhalle@2 243 VSs__dissipate_slave( SlaveVP *slaveToDissipate );
seanhalle@0 244
seanhalle@0 245 //=======================
seanhalle@2 246
seanhalle@2 247 #define VSs__malloc( numBytes, callingSlave ) VMS_App__malloc( numBytes, callingSlave)
seanhalle@2 248
seanhalle@2 249 #define VSs__free(ptrToFree, callingSlave ) VMS_App__free( ptrToFree, callingSlave )
seanhalle@2 250
seanhalle@2 251
seanhalle@2 252 //=======================
seanhalle@2 253 int32
seanhalle@2 254 VSs__submit_task( VSsTaskType *taskType, void **args, SlaveVP *animSlv);
seanhalle@2 255
seanhalle@0 256
seanhalle@0 257 void
seanhalle@2 258 VSs__end_task( SlaveVP *animSlv );
seanhalle@0 259
seanhalle@0 260
seanhalle@0 261 //======================= Concurrency Stuff ======================
seanhalle@0 262 void
seanhalle@2 263 VSs__start_fn_singleton( int32 singletonID, SlaveVP *animSlv );
seanhalle@0 264
seanhalle@0 265 void
seanhalle@2 266 VSs__end_fn_singleton( int32 singletonID, SlaveVP *animSlv );
seanhalle@0 267
seanhalle@0 268 void
seanhalle@2 269 VSs__start_data_singleton( VSsSingleton **singeltonAddr, SlaveVP *animSlv );
seanhalle@0 270
seanhalle@0 271 void
seanhalle@2 272 VSs__end_data_singleton( VSsSingleton **singletonAddr, SlaveVP *animSlv );
seanhalle@0 273
seanhalle@0 274 void
seanhalle@2 275 VSs__animate_short_fn_in_isolation( PtrToAtomicFn ptrToFnToExecInMaster,
seanhalle@0 276 void *data, SlaveVP *animSlv );
seanhalle@0 277
seanhalle@0 278 void
seanhalle@2 279 VSs__start_transaction( int32 transactionID, SlaveVP *animSlv );
seanhalle@0 280
seanhalle@0 281 void
seanhalle@2 282 VSs__end_transaction( int32 transactionID, SlaveVP *animSlv );
seanhalle@0 283
seanhalle@0 284
seanhalle@0 285 //========================= Internal use only =============================
seanhalle@0 286 void
seanhalle@2 287 VSs__Request_Handler( SlaveVP *requestingPr, void *_semEnv );
seanhalle@0 288
seanhalle@0 289 SlaveVP *
seanhalle@2 290 VSs__assign_slaveVP_to_slot( void *_semEnv, AnimSlot *slot );
seanhalle@0 291
seanhalle@0 292 SlaveVP*
seanhalle@2 293 VSs__create_slave_helper( TopLevelFnPtr fnPtr, void *initData,
seanhalle@2 294 VSsSemEnv *semEnv, int32 coreToAssignOnto );
seanhalle@0 295
seanhalle@0 296 //===================== Measurement of Lang Overheads =====================
seanhalle@2 297 #include "VSs_Measurement.h"
seanhalle@0 298
seanhalle@0 299 //===========================================================================
seanhalle@2 300 #endif /* _VSs_H */
seanhalle@0 301