annotate VSs.h @ 12:f56e3beac86b

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