Robust/src/Runtime/DSTM/interface/dstm.h

   1 #ifndef _DSTM_H_
   2 #define _DSTM_H_
   3
   4 #ifdef MAC
   5 #define MSG_NOSIGNAL 0
   6 #endif
   7
   8 #define GET_NTUPLES(x)  ((int *)(x + sizeof(prefetchqelem_t)))
   9 #define GET_PTR_OID(x)  ((unsigned int *)(x + sizeof(prefetchqelem_t) + sizeof(int)))
  10 #define GET_PTR_EOFF(x,n) ((short *)(x + sizeof(prefetchqelem_t) + sizeof(int) + (n*sizeof(unsigned int))))
  11 #define GET_PTR_ARRYFLD(x,n) ((short *)(x + sizeof(prefetchqelem_t) + sizeof(int) + (n*sizeof(unsigned int)) + (n*sizeof(short))))
  12
  13
  14 //Coordinator Messages
  15 #define READ_REQUEST            1
  16 #define READ_MULT_REQUEST       2
  17 #define MOVE_REQUEST            3
  18 #define MOVE_MULT_REQUEST       4
  19 #define TRANS_REQUEST           5
  20 #define TRANS_ABORT             6
  21 #define TRANS_COMMIT            7
  22 #define TRANS_PREFETCH          8
  23 #define TRANS_ABORT_BUT_RETRY_COMMIT_WITH_RELOCATING    9
  24
  25 //Participant Messages
  26 #define OBJECT_FOUND                    10
  27 #define OBJECT_NOT_FOUND                11
  28 #define OBJECTS_FOUND                   12
  29 #define OBJECTS_NOT_FOUND               13
  30 #define TRANS_AGREE                     17
  31 #define TRANS_DISAGREE                  18
  32 #define TRANS_AGREE_BUT_MISSING_OBJECTS 19
  33 #define TRANS_SOFT_ABORT                20
  34 #define TRANS_SUCESSFUL                 21
  35 #define TRANS_PREFETCH_RESPONSE         22
  36
  37 //Control bits for status of objects in Machine pile
  38 #define OBJ_LOCKED_BUT_VERSION_MATCH    14
  39 #define OBJ_UNLOCK_BUT_VERSION_MATCH    15
  40 #define VERSION_NO_MATCH                16
  41
  42 //Max number of objects
  43 #define MAX_OBJECTS  20
  44
  45
  46 #include <stdlib.h>
  47 #include <stdio.h>
  48 #include <string.h>
  49 #include <pthread.h>
  50 #include "clookup.h"
  51 #include "queue.h"
  52 #include "mcpileq.h"
  53
  54 #define DEFAULT_OBJ_STORE_SIZE 1048510 //1MB
  55 #define TID_LEN 20
  56 //bit designations for status field of objheader
  57 #define DIRTY 0x01
  58 #define NEW   0x02
  59 #define LOCK  0x04
  60 #define LOCAL  0x08
  61
  62 typedef struct objheader {
  63         unsigned int oid;
  64         unsigned short type;
  65         unsigned short version;
  66         unsigned short rcount;
  67         char status;
  68 } objheader_t;
  69
  70 typedef struct objstr {
  71         unsigned int size; //this many bytes are allocated after this header
  72         void *top;
  73         struct objstr *next;
  74 } objstr_t;
  75
  76 typedef struct transrecord {
  77         objstr_t *cache;
  78         chashtable_t *lookupTable;
  79 } transrecord_t;
  80 // Structure that keeps track of responses from the participants
  81 typedef struct thread_response {
  82         char rcv_status;
  83 }thread_response_t;
  84
  85 // Structure that holds  fixed data sizes to be sent along with TRANS_REQUEST
  86 typedef struct fixed_data {
  87         char control;
  88         char trans_id[TID_LEN];
  89         int mcount;             // Machine count
  90         short numread;          // Number of objects read
  91         short nummod;           // Number of objects modified
  92         int sum_bytes;  // Total bytes modified
  93 }fixed_data_t;
  94
  95 // Structure that holds  variable data sizes per machine participant
  96 typedef struct trans_req_data {
  97         fixed_data_t f;
  98         unsigned int *listmid;
  99         char *objread;
 100         unsigned int *oidmod;
 101 }trans_req_data_t;
 102
 103 // Structure passed to dstmAcceptinfo() on server side to complete TRANS_COMMIT process
 104 typedef struct trans_commit_data{
 105         unsigned int *objmod;
 106         unsigned int *objlocked;
 107         unsigned int *objnotfound;
 108         void *modptr;
 109         int nummod;
 110         int numlocked;
 111         int numnotfound;
 112 }trans_commit_data_t;
 113
 114
 115 #define PRINT_TID(PTR) printf("DEBUG -> %x %d\n", PTR->mid, PTR->thread_id);
 116 //structure for passing multiple arguments to thread
 117 typedef struct thread_data_array {
 118         int thread_id;
 119         int mid;
 120         int pilecount;
 121         trans_req_data_t *buffer;
 122         thread_response_t *recvmsg;//shared datastructure to keep track of the control message receiv
 123         pthread_cond_t *threshold; //threshhold for waking up a thread
 124         pthread_mutex_t *lock;    //lock the count variable
 125         int *count;             //variable to count responses of TRANS_REQUEST protocol from all participants
 126         char *replyctrl;        //shared ctrl message that stores the reply to be sent, filled by decideResp
 127         char *replyretry;       //shared variable to find out if we need retry (TRANS_COMMIT case)
 128         transrecord_t *rec;     // To send modified objects
 129 } thread_data_array_t;
 130
 131
 132 //Structure for passing arguments to the local m/c thread
 133 typedef struct local_thread_data_array {
 134         thread_data_array_t *tdata;
 135         trans_commit_data_t *transinfo; //Required for trans commit process
 136 } local_thread_data_array_t;
 137
 138 // Structure to save information about an oid necesaary for the decideControl()
 139 typedef struct objinfo {
 140         unsigned int oid;
 141         int poss_val; //Status of object(locked but version matches, version mismatch, oid not present in machine etc)
 142 }objinfo_t;
 143
 144 //Structure for members within prefetch tuples
 145 typedef struct member {
 146         short offset;
 147         short index;
 148         struct member *next;
 149 }trans_member_t;
 150
 151 /*
 152 //Structure that holds the compiler generated prefetch data
 153 typedef struct compprefetchdata {
 154 transrecord_t *record;
 155 } compprefetchdata_t;
 156 */
 157
 158 /* Initialize main object store and lookup tables, start server thread. */
 159 int dstmInit(void);
 160
 161 /* Prototypes for object header */
 162 unsigned int getNewOID(void);
 163 unsigned int objSize(objheader_t *object);
 164 /* end object header */
 165
 166 /* Prototypes for object store */
 167 objstr_t *objstrCreate(unsigned int size); //size in bytes
 168 void objstrDelete(objstr_t *store); //traverse and free entire list
 169 void *objstrAlloc(objstr_t *store, unsigned int size); //size in bytes
 170 /* end object store */
 171
 172 /* Prototypes for server portion */
 173 void *dstmListen();
 174 void *dstmAccept(void *);
 175 int readClientReq(trans_commit_data_t *, int);
 176 int processClientReq(fixed_data_t *, trans_commit_data_t *,unsigned int *, char *, void *, int);
 177 char handleTransReq(fixed_data_t *, trans_commit_data_t *, unsigned int *, char *, void *, int);
 178 int decideCtrlMessage(fixed_data_t *, trans_commit_data_t *, int *, int *, int *, int *, int *, void *, unsigned int *, unsigned int *, unsigned int *, int);
 179 int transCommitProcess(trans_commit_data_t *, int);
 180 /* end server portion */
 181
 182 /* Prototypes for transactions */
 183 void randomdelay(void);
 184 transrecord_t *transStart();
 185 objheader_t *transRead(transrecord_t *, unsigned int);
 186 objheader_t *transCreateObj(transrecord_t *, unsigned short); //returns oid
 187 int transCommit(transrecord_t *record); //return 0 if successful
 188 void *transRequest(void *);     //the C routine that the thread will execute when TRANS_REQUEST begins
 189 void *handleLocalReq(void *);   //the C routine that the local m/c thread will execute
 190 int decideResponse(thread_data_array_t *);// Coordinator decides what response to send to the participant
 191 char sendResponse(thread_data_array_t *, int); //Sends control message back to Participants
 192 void *getRemoteObj(transrecord_t *, unsigned int, unsigned int);
 193 int transAbortProcess(void *, unsigned int *, int, int, int);
 194 int transComProcess(trans_commit_data_t *);
 195 void prefetch(int, unsigned int *, short *, short*);
 196 void *transPrefetch(void *);
 197 void *mcqProcess(void *);
 198 void checkPrefetchTuples(prefetchqelem_t *);
 199 prefetchpile_t *foundLocal(prefetchqelem_t *);
 200 prefetchpile_t *makePreGroups(prefetchqelem_t *, int *);
 201 void checkPreCache(prefetchqelem_t *, int *, int, int, unsigned int, int, int, int);
 202 int transPrefetchProcess(transrecord_t *, int **, short);
 203 void sendPrefetchReq(prefetchpile_t*, int);
 204 void getPrefetchResponse(int, int);
 205 /* end transactions */
 206 #endif