annotate SSR.h @ 28:b37c38418637

changed memory allocation to distributed version
author Merten Sach <msach@mailbox.tu-berlin.de>
date Thu, 22 Sep 2011 12:01:22 +0200
parents a8e41e0bfa61
children 6a367b5d9a2d
rev   line source
Me@6 1 /*
Me@6 2 * Copyright 2009 OpenSourceStewardshipFoundation.org
Me@6 3 * Licensed under GNU General Public License version 2
Me@6 4 *
Me@6 5 * Author: seanhalle@yahoo.com
Me@6 6 *
Me@6 7 */
Me@6 8
Me@6 9 #ifndef _SSR_H
Me@6 10 #define _SSR_H
Me@6 11
Me@6 12 #include "VMS/Queue_impl/PrivateQueue.h"
Me@6 13 #include "VMS/Hash_impl/PrivateHash.h"
Me@6 14 #include "VMS/VMS.h"
Me@6 15
Me@17 16
Me@17 17 //===========================================================================
Me@17 18 #define NUM_STRUCS_IN_SEM_ENV 1000
Me@17 19
Me@17 20 //===========================================================================
Me@6 21 /*This header defines everything specific to the SSR semantic plug-in
Me@6 22 */
Me@6 23 typedef struct _SSRSemReq SSRSemReq;
Me@17 24 typedef void (*PtrToAtomicFn ) ( void * ); //executed atomically in master
Me@17 25 //===========================================================================
Me@6 26
Me@6 27 /*Semantic layer-specific data sent inside a request from lib called in app
Me@6 28 * to request handler called in MasterLoop
Me@6 29 */
Me@21 30
Me@21 31 typedef struct
Me@21 32 {
Me@21 33 VirtProcr *VPCurrentlyExecuting;
Me@21 34 PrivQueueStruc *waitingVPQ;
Me@21 35 }
Me@21 36 SSRTrans;
Me@21 37
msach@24 38 /*WARNING: assembly hard-codes position of endInstrAddr as first field
msach@24 39 */
Me@21 40 typedef struct
Me@21 41 {
Me@22 42 void *endInstrAddr;
Me@21 43 int32 hasBeenStarted;
Me@21 44 int32 hasFinished;
Me@21 45 PrivQueueStruc *waitQ;
Me@21 46 }
Me@21 47 SSRSingleton;
Me@21 48
Me@6 49 enum SSRReqType
Me@6 50 {
Me@6 51 send_type = 1,
Me@6 52 send_from_to,
Me@6 53 receive_any, //order and grouping matter -- send before receive
Me@6 54 receive_type, // and receive_any first of the receives -- Handlers
Me@6 55 receive_from_to,// rely upon this ordering of enum
Me@6 56 transfer_to,
Me@17 57 transfer_out,
Me@17 58 malloc_req,
Me@17 59 free_req,
Me@21 60 singleton_fn_start,
Me@21 61 singleton_fn_end,
Me@21 62 singleton_data_start,
Me@21 63 singleton_data_end,
Me@17 64 atomic,
Me@17 65 trans_start,
Me@17 66 trans_end
Me@6 67 };
Me@6 68
Me@6 69 struct _SSRSemReq
Me@6 70 { enum SSRReqType reqType;
Me@17 71 VirtProcr *sendPr;
Me@17 72 VirtProcr *receivePr;
Me@17 73 int32 msgType;
Me@17 74 void *msg;
Me@6 75 SSRSemReq *nextReqInHashEntry;
Me@17 76
Me@17 77 void *initData;
Me@17 78 VirtProcrFnPtr fnPtr;
Me@17 79 int32 coreToScheduleOnto;
Me@17 80
Me@17 81 int32 sizeToMalloc;
Me@17 82 void *ptrToFree;
Me@17 83
Me@17 84 int32 singletonID;
Me@22 85 SSRSingleton **singletonPtrAddr;
Me@17 86
Me@17 87 PtrToAtomicFn fnToExecInMaster;
Me@17 88 void *dataForFn;
Me@17 89
Me@17 90 int32 transID;
Me@6 91 }
Me@6 92 /* SSRSemReq */;
Me@6 93
Me@17 94
Me@17 95 typedef struct
Me@17 96 {
Me@6 97 PrivQueueStruc **readyVPQs;
Me@14 98 HashTable *commHashTbl;
Me@14 99 int32 numVirtPr;
Me@14 100 int32 nextCoreToGetNewPr;
Me@14 101 int32 primitiveStartTime;
Me@17 102
Me@17 103 //fix limit on num with dynArray
Me@21 104 SSRSingleton fnSingletons[NUM_STRUCS_IN_SEM_ENV];
Me@17 105 SSRTrans transactionStrucs[NUM_STRUCS_IN_SEM_ENV];
Me@6 106 }
Me@6 107 SSRSemEnv;
Me@6 108
Me@6 109
Me@17 110 typedef struct _TransListElem TransListElem;
Me@17 111 struct _TransListElem
Me@17 112 {
Me@17 113 int32 transID;
Me@17 114 TransListElem *nextTrans;
Me@17 115 };
Me@18 116 //TransListElem
Me@18 117
Me@17 118 typedef struct
Me@17 119 {
Me@17 120 int32 highestTransEntered;
Me@17 121 TransListElem *lastTransEntered;
Me@17 122 }
Me@17 123 SSRSemData;
Me@17 124
Me@6 125 //===========================================================================
Me@6 126
Me@6 127 void
Me@6 128 SSR__create_seed_procr_and_do_work( VirtProcrFnPtr fn, void *initData );
Me@6 129
Me@14 130 int32
Me@14 131 SSR__giveMinWorkUnitCycles( float32 percentOverhead );
Me@14 132
Me@20 133 void
Me@14 134 SSR__start_primitive();
Me@14 135
Me@20 136 int32
Me@14 137 SSR__end_primitive_and_give_cycles();
Me@14 138
Me@16 139 int32
Me@16 140 SSR__giveIdealNumWorkUnits();
Me@14 141
Me@17 142 int32
Me@17 143 SSR__give_number_of_cores_to_schedule_onto();
Me@17 144
Me@6 145 //=======================
Me@6 146
Me@6 147 void
Me@6 148 SSR__init();
Me@6 149
Me@6 150 void
Me@6 151 SSR__cleanup_after_shutdown();
Me@6 152
Me@6 153 //=======================
Me@6 154
Me@20 155 VirtProcr *
Me@6 156 SSR__create_procr_with( VirtProcrFnPtr fnPtr, void *initData,
Me@6 157 VirtProcr *creatingPr );
Me@6 158
Me@20 159 VirtProcr *
Me@17 160 SSR__create_procr_with_affinity( VirtProcrFnPtr fnPtr, void *initData,
Me@17 161 VirtProcr *creatingPr, int32 coreToScheduleOnto);
Me@17 162
Me@6 163 void
Me@6 164 SSR__dissipate_procr( VirtProcr *procrToDissipate );
Me@6 165
Me@6 166 //=======================
Me@6 167 void *
Me@17 168 SSR__malloc_to( int numBytes, VirtProcr *ownerPr );
Me@17 169
Me@17 170 void
Me@17 171 SSR__free( void *ptrToFree, VirtProcr *owningPr );
Me@6 172
Me@6 173 void
Me@6 174 SSR__transfer_ownership_of_from_to( void *data, VirtProcr *oldOwnerPr,
Me@6 175 VirtProcr *newOwnerPr );
Me@6 176
Me@6 177 void
Me@6 178 SSR__add_ownership_by_to( VirtProcr *newOwnerPr, void *data );
Me@6 179
Me@6 180 void
Me@6 181 SSR__remove_ownership_by_from( VirtProcr *loserPr, void *dataLosing );
Me@6 182
Me@6 183 void
Me@6 184 SSR__transfer_ownership_to_outside( void *dataToTransferOwnershipOf );
Me@6 185
Me@6 186
Me@6 187
Me@6 188 //=======================
Me@6 189 void
Me@6 190 SSR__send_of_type_to( VirtProcr *sendPr, void *msg, const int type,
Me@6 191 VirtProcr *receivePr);
Me@6 192
Me@6 193 void
Me@6 194 SSR__send_from_to( void *msg, VirtProcr *sendPr, VirtProcr *receivePr);
Me@6 195
Me@6 196 void *
Me@6 197 SSR__receive_type_to( const int type, VirtProcr *receivePr );
Me@6 198
Me@6 199 void *
Me@6 200 SSR__receive_from_to( VirtProcr *sendPr, VirtProcr *receivePr );
Me@6 201
Me@6 202
Me@17 203 //======================= Concurrency Stuff ======================
Me@17 204 void
Me@21 205 SSR__start_fn_singleton( int32 singletonID, VirtProcr *animPr );
Me@21 206
Me@21 207 void
Me@21 208 SSR__end_fn_singleton( int32 singletonID, VirtProcr *animPr );
Me@21 209
Me@21 210 void
Me@21 211 SSR__start_data_singleton( SSRSingleton **singeltonAddr, VirtProcr *animPr );
Me@21 212
Me@21 213 void
Me@21 214 SSR__end_data_singleton( SSRSingleton **singletonAddr, VirtProcr *animPr );
Me@6 215
Me@6 216 void
Me@17 217 SSR__animate_short_fn_in_isolation( PtrToAtomicFn ptrToFnToExecInMaster,
Me@17 218 void *data, VirtProcr *animPr );
Me@17 219
Me@17 220 void
Me@17 221 SSR__start_transaction( int32 transactionID, VirtProcr *animPr );
Me@17 222
Me@17 223 void
Me@17 224 SSR__end_transaction( int32 transactionID, VirtProcr *animPr );
Me@6 225
Me@6 226
Me@6 227 //========================= Internal use only =============================
Me@6 228 void
Me@6 229 SSR__Request_Handler( VirtProcr *requestingPr, void *_semEnv );
Me@6 230
Me@6 231 VirtProcr *
Me@6 232 SSR__schedule_virt_procr( void *_semEnv, int coreNum );
Me@6 233
msach@27 234 VirtProcr*
msach@27 235 SSR__create_procr_helper( VirtProcrFnPtr fnPtr, void *initData,
msach@27 236 SSRSemEnv *semEnv, int32 coreToScheduleOnto );
Me@6 237
Me@6 238 #endif /* _SSR_H */
Me@6 239