annotate VSs.h @ 10:b13fbd445e0a

Compiles and some bugs corrected.. still does double free of taskStub
author Sean Halle <seanhalle@yahoo.com>
date Fri, 17 Aug 2012 17:12:50 -0700
parents 832bc715fbf2
children f56e3beac86b
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;
seanhalle@3 65 }
seanhalle@3 66 VSsPointerEntry;
seanhalle@3 67
seanhalle@6 68 typedef struct
seanhalle@3 69 {
seanhalle@2 70 void **args; //ctld args must come first, as ptrs
seanhalle@2 71 VSsTaskType *taskType;
seanhalle@4 72 int32 *taskID;
seanhalle@2 73 int32 numBlockingProp;
seanhalle@10 74 SlaveVP *slaveAssignedTo; //only valid before end task (thread)
seanhalle@3 75 VSsPointerEntry **ptrEntries;
seanhalle@10 76
seanhalle@8 77 void* parentTasksStub;
seanhalle@8 78 int32 numLiveChildTasks;
seanhalle@8 79 int32 numLiveChildThreads;
seanhalle@8 80 bool32 isWaitingForChildTasksToEnd;
seanhalle@8 81 bool32 isWaitingForChildThreadsToEnd;
seanhalle@8 82 bool32 isEnded;
seanhalle@2 83 }
seanhalle@6 84 VSsTaskStub;
nengel@5 85
seanhalle@2 86
seanhalle@2 87 typedef struct
seanhalle@2 88 {
seanhalle@2 89 VSsTaskStub *taskStub;
seanhalle@2 90 int32 argNum;
seanhalle@2 91 int32 isReader;
seanhalle@2 92 }
seanhalle@2 93 VSsTaskStubCarrier;
seanhalle@2 94
seanhalle@2 95
seanhalle@2 96 typedef struct
seanhalle@2 97 {
seanhalle@2 98 int32 type;
seanhalle@2 99 VSsTaskStub *taskStub;
seanhalle@2 100 }
seanhalle@2 101 VSsWaiterCarrier;
seanhalle@1 102
seanhalle@0 103 /*Semantic layer-specific data sent inside a request from lib called in app
seanhalle@0 104 * to request handler called in AnimationMaster
seanhalle@0 105 */
seanhalle@0 106
seanhalle@0 107 typedef struct
seanhalle@0 108 {
seanhalle@0 109 SlaveVP *VPCurrentlyExecuting;
seanhalle@0 110 PrivQueueStruc *waitingVPQ;
seanhalle@0 111 }
seanhalle@2 112 VSsTrans;
seanhalle@0 113
seanhalle@0 114 /*WARNING: assembly hard-codes position of endInstrAddr as first field
seanhalle@0 115 */
seanhalle@0 116 typedef struct
seanhalle@0 117 {
seanhalle@0 118 void *endInstrAddr;
seanhalle@0 119 int32 hasBeenStarted;
seanhalle@0 120 int32 hasFinished;
seanhalle@0 121 PrivQueueStruc *waitQ;
seanhalle@0 122 }
seanhalle@2 123 VSsSingleton;
seanhalle@0 124
seanhalle@2 125 enum VSsReqType
seanhalle@0 126 {
seanhalle@2 127 submit_task = 1,
seanhalle@2 128 end_task,
seanhalle@2 129 create_slave,
seanhalle@2 130 create_slave_w_aff,
seanhalle@2 131 dissipate_slave,
seanhalle@2 132 //===============================
seanhalle@4 133 send_type_to,
seanhalle@4 134 receive_type_to,
seanhalle@4 135 send_from_to,
seanhalle@4 136 receive_from_to,
seanhalle@4 137 //===============================
nengel@5 138 taskwait,
seanhalle@0 139 malloc_req,
seanhalle@0 140 free_req,
seanhalle@0 141 singleton_fn_start,
seanhalle@0 142 singleton_fn_end,
seanhalle@0 143 singleton_data_start,
seanhalle@0 144 singleton_data_end,
seanhalle@0 145 atomic,
seanhalle@0 146 trans_start,
seanhalle@0 147 trans_end
seanhalle@0 148 };
seanhalle@0 149
seanhalle@2 150 struct _VSsSemReq
seanhalle@2 151 { enum VSsReqType reqType;
seanhalle@2 152 SlaveVP *callingSlv;
seanhalle@2 153 VSsTaskType *taskType;
seanhalle@2 154 void *args;
seanhalle@2 155 VSsTaskStub *taskStub;
seanhalle@2 156
seanhalle@4 157 SlaveVP *senderSlv;
seanhalle@4 158 SlaveVP *receiverSlv;
seanhalle@4 159 int32 *senderID;
seanhalle@4 160 int32 *receiverID;
seanhalle@4 161 int32 msgType;
seanhalle@4 162 void *msg;
seanhalle@4 163 VSsSemReq *nextReqInHashEntry;
seanhalle@4 164 int32 *taskID;
seanhalle@4 165
seanhalle@2 166 TopLevelFnPtr fnPtr;
seanhalle@0 167 void *initData;
seanhalle@0 168 int32 coreToAssignOnto;
seanhalle@0 169
seanhalle@0 170 int32 sizeToMalloc;
seanhalle@0 171 void *ptrToFree;
seanhalle@0 172
seanhalle@0 173 int32 singletonID;
seanhalle@2 174 VSsSingleton **singletonPtrAddr;
seanhalle@0 175
seanhalle@0 176 PtrToAtomicFn fnToExecInMaster;
seanhalle@0 177 void *dataForFn;
seanhalle@0 178
seanhalle@0 179 int32 transID;
seanhalle@0 180 }
seanhalle@2 181 /* VSsSemReq */;
seanhalle@0 182
seanhalle@0 183
seanhalle@0 184 typedef struct
seanhalle@0 185 {
seanhalle@9 186 PrivQueueStruc *slavesReadyToResumeQ; //Shared (slaves not pinned)
seanhalle@9 187 PrivQueueStruc *freeExtraTaskSlvQ; //Shared
seanhalle@9 188 PrivQueueStruc *taskReadyQ; //Shared (tasks not pinned)
seanhalle@10 189 SlaveVP *slotTaskSlvs[NUM_CORES][NUM_ANIM_SLOTS];
seanhalle@2 190 HashTable *argPtrHashTbl;
seanhalle@4 191 HashTable *commHashTbl;
seanhalle@8 192 int32 numLiveExtraTaskSlvs;
seanhalle@8 193 int32 numLiveThreadSlvs;
seanhalle@3 194 int32 nextCoreToGetNewSlv;
seanhalle@0 195 int32 primitiveStartTime;
seanhalle@0 196
seanhalle@0 197 //fix limit on num with dynArray
seanhalle@2 198 VSsSingleton fnSingletons[NUM_STRUCS_IN_SEM_ENV];
seanhalle@2 199 VSsTrans transactionStrucs[NUM_STRUCS_IN_SEM_ENV];
seanhalle@3 200
seanhalle@3 201 bool32 *coreIsDone;
seanhalle@3 202 int32 numCoresDone;
seanhalle@0 203
seanhalle@0 204 #ifdef HOLISTIC__TURN_ON_OBSERVE_UCC
seanhalle@0 205 ListOfArrays* unitList;
seanhalle@0 206 ListOfArrays* ctlDependenciesList;
seanhalle@0 207 ListOfArrays* commDependenciesList;
seanhalle@0 208 NtoN** ntonGroups;
seanhalle@0 209 PrivDynArrayInfo* ntonGroupsInfo;
seanhalle@0 210 ListOfArrays* dynDependenciesList;
seanhalle@0 211 Unit last_in_slot[NUM_CORES * NUM_ANIM_SLOTS];
seanhalle@0 212 ListOfArrays* hwArcs;
seanhalle@0 213 #endif
seanhalle@0 214
seanhalle@0 215 #ifdef HOLISTIC__TURN_ON_PERF_COUNTERS
seanhalle@0 216 ListOfArrays* counterList[NUM_CORES];
seanhalle@0 217 #endif
seanhalle@3 218 SlaveVP* idleSlv[NUM_CORES][NUM_ANIM_SLOTS];
seanhalle@0 219 int shutdownInitiated;
seanhalle@0 220 }
seanhalle@2 221 VSsSemEnv;
seanhalle@0 222
seanhalle@0 223
seanhalle@0 224 typedef struct _TransListElem TransListElem;
seanhalle@0 225 struct _TransListElem
seanhalle@0 226 {
seanhalle@0 227 int32 transID;
seanhalle@0 228 TransListElem *nextTrans;
seanhalle@0 229 };
seanhalle@0 230 //TransListElem
seanhalle@0 231
seanhalle@8 232 enum VSsSlvType
seanhalle@10 233 { ExtraTaskSlv = 1,
seanhalle@10 234 SlotTaskSlv,
seanhalle@10 235 ThreadSlv
seanhalle@8 236 };
nengel@5 237
seanhalle@0 238 typedef struct
seanhalle@0 239 {
seanhalle@0 240 int32 highestTransEntered;
seanhalle@0 241 TransListElem *lastTransEntered;
seanhalle@2 242 bool32 needsTaskAssigned;
seanhalle@2 243 VSsTaskStub *taskStub;
seanhalle@9 244 enum VSsSlvType slaveType;
seanhalle@0 245 }
seanhalle@2 246 VSsSemData;
seanhalle@0 247
seanhalle@0 248 //===========================================================================
seanhalle@0 249
seanhalle@0 250 void
seanhalle@2 251 VSs__create_seed_slave_and_do_work( TopLevelFnPtr fn, void *initData );
seanhalle@0 252
seanhalle@0 253 int32
seanhalle@2 254 VSs__giveMinWorkUnitCycles( float32 percentOverhead );
seanhalle@0 255
seanhalle@0 256 void
seanhalle@2 257 VSs__start_primitive();
seanhalle@0 258
seanhalle@0 259 int32
seanhalle@2 260 VSs__end_primitive_and_give_cycles();
seanhalle@0 261
seanhalle@0 262 int32
seanhalle@2 263 VSs__giveIdealNumWorkUnits();
seanhalle@0 264
seanhalle@0 265 int32
seanhalle@2 266 VSs__give_number_of_cores_to_schedule_onto();
seanhalle@0 267
seanhalle@0 268 //=======================
seanhalle@0 269
seanhalle@0 270 void
seanhalle@2 271 VSs__init();
seanhalle@0 272
seanhalle@0 273 void
seanhalle@2 274 VSs__cleanup_after_shutdown();
seanhalle@0 275
seanhalle@0 276 //=======================
seanhalle@0 277
seanhalle@4 278 SlaveVP *
seanhalle@7 279 VSs__create_thread( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 280 SlaveVP *creatingThd );
seanhalle@0 281
seanhalle@0 282 void
seanhalle@7 283 VSs__end_thread( SlaveVP *thdToEnd );
seanhalle@0 284
seanhalle@0 285 //=======================
seanhalle@2 286
seanhalle@2 287 #define VSs__malloc( numBytes, callingSlave ) VMS_App__malloc( numBytes, callingSlave)
seanhalle@2 288
seanhalle@2 289 #define VSs__free(ptrToFree, callingSlave ) VMS_App__free( ptrToFree, callingSlave )
seanhalle@2 290
seanhalle@2 291
seanhalle@2 292 //=======================
seanhalle@4 293 void
seanhalle@3 294 VSs__submit_task( VSsTaskType *taskType, void *args, SlaveVP *animSlv);
seanhalle@2 295
seanhalle@4 296 inline int32 *
seanhalle@4 297 VSs__create_taskID_of_size( int32 numInts, SlaveVP *animSlv );
seanhalle@4 298
seanhalle@4 299 void
seanhalle@4 300 VSs__submit_task_with_ID( VSsTaskType *taskType, void *args, int32 *taskID,
seanhalle@4 301 SlaveVP *animSlv);
seanhalle@0 302
seanhalle@0 303 void
seanhalle@2 304 VSs__end_task( SlaveVP *animSlv );
seanhalle@0 305
seanhalle@4 306 //=========================
nengel@5 307 void
nengel@5 308 VSs__taskwait(SlaveVP *animSlv);
nengel@5 309
seanhalle@4 310
seanhalle@4 311 inline int32 *
seanhalle@4 312 VSs__give_self_taskID( SlaveVP *animSlv );
seanhalle@4 313
seanhalle@4 314 void
seanhalle@4 315 VSs__send_of_type_to( void *msg, const int32 type, int32 *receiverID,
seanhalle@4 316 SlaveVP *senderSlv );
seanhalle@4 317
seanhalle@4 318 void
seanhalle@4 319 VSs__send_from_to( void *msg, int32 *senderID, int32 *receiverID, SlaveVP *senderSlv );
seanhalle@4 320
seanhalle@4 321 void *
seanhalle@4 322 VSs__receive_type_to( const int32 type, int32* receiverID, SlaveVP *receiverSlv );
seanhalle@4 323
seanhalle@4 324 void *
seanhalle@4 325 VSs__receive_from_to( int32 *senderID, int32 *receiverID, SlaveVP *receiverSlv );
seanhalle@0 326
seanhalle@0 327 //======================= Concurrency Stuff ======================
seanhalle@0 328 void
seanhalle@2 329 VSs__start_fn_singleton( int32 singletonID, SlaveVP *animSlv );
seanhalle@0 330
seanhalle@0 331 void
seanhalle@2 332 VSs__end_fn_singleton( int32 singletonID, SlaveVP *animSlv );
seanhalle@0 333
seanhalle@0 334 void
seanhalle@2 335 VSs__start_data_singleton( VSsSingleton **singeltonAddr, SlaveVP *animSlv );
seanhalle@0 336
seanhalle@0 337 void
seanhalle@2 338 VSs__end_data_singleton( VSsSingleton **singletonAddr, SlaveVP *animSlv );
seanhalle@0 339
seanhalle@0 340 void
seanhalle@2 341 VSs__animate_short_fn_in_isolation( PtrToAtomicFn ptrToFnToExecInMaster,
seanhalle@0 342 void *data, SlaveVP *animSlv );
seanhalle@0 343
seanhalle@0 344 void
seanhalle@2 345 VSs__start_transaction( int32 transactionID, SlaveVP *animSlv );
seanhalle@0 346
seanhalle@0 347 void
seanhalle@2 348 VSs__end_transaction( int32 transactionID, SlaveVP *animSlv );
seanhalle@0 349
seanhalle@0 350
seanhalle@0 351 //========================= Internal use only =============================
seanhalle@0 352 void
seanhalle@3 353 VSs__Request_Handler( SlaveVP *requestingSlv, void *_semEnv );
seanhalle@0 354
seanhalle@0 355 SlaveVP *
seanhalle@2 356 VSs__assign_slaveVP_to_slot( void *_semEnv, AnimSlot *slot );
seanhalle@0 357
seanhalle@0 358 SlaveVP*
seanhalle@2 359 VSs__create_slave_helper( TopLevelFnPtr fnPtr, void *initData,
seanhalle@2 360 VSsSemEnv *semEnv, int32 coreToAssignOnto );
seanhalle@0 361
seanhalle@7 362 VSsTaskStub *
seanhalle@8 363 create_thread_task_stub( void *initData );
seanhalle@7 364
seanhalle@7 365
seanhalle@7 366 SlaveVP *
seanhalle@7 367 VSs__create_slave_with( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 368 SlaveVP *creatingSlv );
seanhalle@7 369
seanhalle@7 370 SlaveVP *
seanhalle@7 371 VSs__create_slave_with_affinity( TopLevelFnPtr fnPtr, void *initData,
seanhalle@7 372 SlaveVP *creatingSlv, int32 coreToAssignOnto);
seanhalle@7 373
seanhalle@9 374 void
seanhalle@9 375 idle_fn(void* data, SlaveVP *animatingSlv);
seanhalle@7 376
seanhalle@0 377 //===================== Measurement of Lang Overheads =====================
seanhalle@3 378 #include "Measurement/VSs_Measurement.h"
seanhalle@0 379
seanhalle@0 380 //===========================================================================
seanhalle@2 381 #endif /* _VSs_H */
seanhalle@0 382