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 /***********************************************************
   9  *       Macros
  10  **********************************************************/
  11 #define GET_NTUPLES(x)  ((int *)(x))
  12 #define GET_PTR_OID(x)  ((unsigned int *)(x + sizeof(int)))
  13 #define GET_PTR_EOFF(x,n) ((short *)(x + sizeof(int) + (n*sizeof(unsigned int))))
  14 #define GET_PTR_ARRYFLD(x,n) ((short *)(x + sizeof(int) + (n*sizeof(unsigned int)) + (n*sizeof(short))))
  15 /*****************************************
  16  *  Coordinator Messages
  17  ***************************************/
  18 #define READ_REQUEST            1
  19 #define READ_MULT_REQUEST       2
  20 #define MOVE_REQUEST            3
  21 #define MOVE_MULT_REQUEST       4
  22 #define TRANS_REQUEST           5
  23 #define TRANS_ABORT             6
  24 #define TRANS_COMMIT            7
  25 #define TRANS_PREFETCH          8
  26 #define TRANS_ABORT_BUT_RETRY_COMMIT_WITH_RELOCATING    9
  27
  28 /*********************************
  29  * Participant Messages
  30  *******************************/
  31 #define OBJECT_FOUND                    10
  32 #define OBJECT_NOT_FOUND                11
  33 #define OBJECTS_FOUND                   12
  34 #define OBJECTS_NOT_FOUND               13
  35 #define TRANS_AGREE                     17
  36 #define TRANS_DISAGREE                  18
  37 #define TRANS_AGREE_BUT_MISSING_OBJECTS 19
  38 #define TRANS_SOFT_ABORT                20
  39 #define TRANS_SUCESSFUL                 21
  40 #define TRANS_PREFETCH_RESPONSE         22
  41 #define START_REMOTE_THREAD             23
  42 #define THREAD_NOTIFY_REQUEST           24
  43 #define THREAD_NOTIFY_RESPONSE          25
  44 #define TRANS_UNSUCESSFUL               26
  45 #define CLOSE_CONNECTION                27
  46
  47 //Max number of objects
  48 #define MAX_OBJECTS  20
  49 //Max remote-machine connections
  50 #define NUM_MACHINES 2
  51 #define LOADFACTOR 0.5
  52 #define DEFAULT_OBJ_STORE_SIZE 1048510 //1MB
  53 //Transaction id per machine
  54 #define TID_LEN 20
  55 #define LISTEN_PORT 2156
  56
  57
  58 #include <stdlib.h>
  59 #include <stdio.h>
  60 #include <string.h>
  61 #include <pthread.h>
  62 #include "clookup.h"
  63 #include "queue.h"
  64 #include "mcpileq.h"
  65 #include "threadnotify.h"
  66 #include <sys/types.h>
  67 #include <sys/socket.h>
  68 #include <netdb.h>
  69 #include <netinet/in.h>
  70 #include <sys/types.h>
  71 #include <unistd.h>
  72 #include <errno.h>
  73 #include <time.h>
  74 #include "sockpool.h"
  75 #include "prelookup.h"
  76
  77 //bit designations for status field of objheader
  78 #define DIRTY 0x01
  79 #define NEW   0x02
  80 #define LOCK  0x04
  81 #define LOCAL  0x08
  82
  83 #ifdef COMPILER
  84
  85 #include "structdefs.h"
  86
  87 typedef struct objheader {
  88         threadlist_t *notifylist;
  89         unsigned short version;
  90         unsigned short rcount;
  91 } objheader_t;
  92
  93 #define OID(x)\
  94     (*((unsigned int *)&((struct ___Object___ *)((unsigned int) x + sizeof(objheader_t)))->___nextobject___))
  95
  96 #define COMPOID(x)\
  97     (*((unsigned int *)&((struct ___Object___ *) x)->___nextobject___))
  98
  99 #define STATUS(x)\
 100          *((unsigned int *) &(((struct ___Object___ *)((unsigned int) x + sizeof(objheader_t)))->___localcopy___))
 101
 102 #define STATUSPTR(x)\
 103          ((unsigned int *) &(((struct ___Object___ *)((unsigned int) x + sizeof(objheader_t)))->___localcopy___))
 104
 105 #define TYPE(x)\
 106         ((struct ___Object___ *)((unsigned int) x + sizeof(objheader_t)))->type
 107
 108 #define GETSIZE(size, x) {\
 109   int type=TYPE(x);\
 110   if (type<NUMCLASSES) {\
 111     size=classsize[type];\
 112   } else {\
 113     size=classsize[type]*((struct ArrayObject *)&((objheader_t *)x)[1])->___length___+sizeof(struct ArrayObject);\
 114   }\
 115 }
 116
 117 #else
 118
 119 typedef struct objheader {
 120         threadlist_t *notifylist;
 121         unsigned int oid;
 122         unsigned short type;
 123         unsigned short version;
 124         unsigned short rcount;
 125         char status;
 126 } objheader_t;
 127
 128 #define OID(x) x->oid
 129 #define TYPE(x) x->type
 130 #define STATUS(x) x->status
 131 #define STATUSPTR(x) &x->status
 132 #define GETSIZE(size, x) size=classsize[TYPE(x)]
 133 #endif
 134
 135
 136 typedef struct objstr {
 137         unsigned int size; //this many bytes are allocated after this header
 138         void *top;
 139         struct objstr *next;
 140 } objstr_t;
 141
 142 typedef struct oidmidpair {
 143     unsigned int oid;
 144     unsigned int mid;
 145 } oidmidpair_t;
 146
 147 typedef struct transrecord {
 148   objstr_t *cache;
 149   chashtable_t *lookupTable;
 150 #ifdef COMPILER
 151   struct ___Object___ * revertlist;
 152 #endif
 153 } transrecord_t;
 154
 155 // Structure is a shared structure that keeps track of responses from the participants
 156 typedef struct thread_response {
 157   char rcv_status;
 158 } thread_response_t;
 159
 160 // Structure that holds  fixed data to be sent along with TRANS_REQUEST
 161 typedef struct fixed_data {
 162   char control;                 /* control message */
 163   char trans_id[TID_LEN];       /* transaction id */
 164   int mcount;                   /* participant count */
 165   unsigned int numread;         /* no of objects read */
 166   unsigned int nummod;                  /* no of objects modified */
 167   unsigned int numcreated;              /* no of objects created */
 168   int sum_bytes;                /* total bytes of modified objects in a transaction */
 169 } fixed_data_t;
 170
 171 /* Structure that holds trans request information for each participant */
 172 typedef struct trans_req_data {
 173   fixed_data_t f;               /* Holds first few fixed bytes of data sent during TRANS_REQUEST protcol*/
 174   unsigned int *listmid;        /* Pointer to array holding list of participants */
 175   char *objread;                /* Pointer to array holding oid and version number of objects that are only read */
 176   unsigned int *oidmod;         /* Pointer to array holding oids of objects that are modified */
 177   unsigned int *oidcreated;     /* Pointer to array holding oids of objects that are newly created */
 178 } trans_req_data_t;
 179
 180 /* Structure that holds information of objects that are not found in the participant
 181  * and objs locked within a transaction during commit process */
 182 typedef struct trans_commit_data{
 183   unsigned int *objlocked;      /* Pointer to array holding oids of objects locked inside a transaction */
 184   unsigned int *objnotfound;    /* Pointer to array holding oids of objects not found on the participant machine */
 185   void *modptr;                 /* Pointer to the address in the mainobject store of the participant that holds all modified objects */
 186   int numlocked;                /* no of objects locked */
 187   int numnotfound;              /* no of objects not found */
 188 } trans_commit_data_t;
 189
 190
 191 #define PRINT_TID(PTR) printf("DEBUG -> %x %d\n", PTR->mid, PTR->thread_id);
 192 /* Structure for passing multiple arguments to a thread
 193  * spawned to process each transaction on a machine */
 194 typedef struct thread_data_array {
 195   int thread_id;
 196   int mid;
 197   trans_req_data_t *buffer;     /* Holds trans request information sent to participants */
 198   thread_response_t *recvmsg;   /* Shared datastructure to keep track of the participants response to a trans request */
 199   pthread_cond_t *threshold;    /* Condition var to waking up a thread */
 200   pthread_mutex_t *lock;        /* Lock for counting participants response */
 201   int *count;                   /* Variable to count responses from all participants to the TRANS_REQUEST protocol */
 202   char *replyctrl;              /* Shared ctrl message that stores the reply to be sent to participants, filled by decideResponse() */
 203   char *replyretry;             /* Shared variable that keep track if coordinator needs retry */
 204   transrecord_t *rec;           /* To send modified objects */
 205 } thread_data_array_t;
 206
 207
 208 //Structure for passing arguments to the local m/c thread
 209 typedef struct local_thread_data_array {
 210         thread_data_array_t *tdata;     /* Holds all the arguments send to a thread that is spawned when transaction commits */
 211         trans_commit_data_t *transinfo; /* Holds information of objects locked and not found in the participant */
 212 } local_thread_data_array_t;
 213
 214 //Structure to store mid and socketid information
 215 typedef struct midSocketInfo {
 216         unsigned int mid;               /* To communicate with mid use sockid in this data structure*/
 217         int sockid;
 218 } midSocketInfo_t;
 219
 220 /* Initialize main object store and lookup tables, start server thread. */
 221 int dstmInit(void);
 222 void send_data(int fd, void *buf, int buflen);
 223 void recv_data(int fd, void *buf, int buflen);
 224 int recv_data_errorcode(int fd, void *buf, int buflen);
 225
 226 /* Prototypes for object header */
 227 unsigned int getNewOID(void);
 228 /* end object header */
 229
 230 /* Prototypes for object store */
 231 objstr_t *objstrCreate(unsigned int size); //size in bytes
 232 void objstrDelete(objstr_t *store); //traverse and free entire list
 233 void *objstrAlloc(objstr_t *store, unsigned int size); //size in bytes
 234 void clearObjStore(); // TODO:currently only clears the prefetch cache object store
 235 /* end object store */
 236
 237 /* Prototypes for server portion */
 238 void *dstmListen(void *);
 239 int startlistening();
 240 void *dstmAccept(void *);
 241 int readClientReq(trans_commit_data_t *, int);
 242 int processClientReq(fixed_data_t *, trans_commit_data_t *,unsigned int *, char *, void *, unsigned int *, int);
 243 char handleTransReq(fixed_data_t *, trans_commit_data_t *, unsigned int *, char *, void *, int);
 244 char decideCtrlMessage(fixed_data_t *, trans_commit_data_t *, int *, int *, int *, int *, int *, void *, unsigned int *, unsigned int *, int);
 245 int transCommitProcess(void *, unsigned int *, unsigned int *, int, int, int);
 246 void processReqNotify(unsigned int numoid, unsigned int *oid, unsigned short *version, unsigned int mid, unsigned int threadid);
 247 /* end server portion */
 248
 249 /* Prototypes for transactions */
 250 /* Function called at beginning. Passes in the first parameter. */
 251 /* Returns 1 if this thread should run the main process */
 252
 253 int dstmStartup(const char *);
 254 void transInit();
 255 int processConfigFile();
 256 void addHost(unsigned int);
 257 void mapObjMethod(unsigned short);
 258
 259 void randomdelay();
 260 transrecord_t *transStart();
 261 objheader_t *transRead(transrecord_t *, unsigned int);
 262 objheader_t *transCreateObj(transrecord_t *, unsigned int); //returns oid header
 263 int transCommit(transrecord_t *record); //return 0 if successful
 264 void *transRequest(void *);     //the C routine that the thread will execute when TRANS_REQUEST begins
 265 void decideResponse(thread_data_array_t *);// Coordinator decides what response to send to the participant
 266 char sendResponse(thread_data_array_t *, int); //Sends control message back to Participants
 267 void *getRemoteObj(transrecord_t *, unsigned int, unsigned int);// returns object header from main object store after object is copied into it from remote machine
 268 void *handleLocalReq(void *);//handles Local requests
 269 int transComProcess(local_thread_data_array_t *);
 270 int transAbortProcess(local_thread_data_array_t *);
 271 void transAbort(transrecord_t *trans);
 272 void sendPrefetchResponse(int sd, char *control, char *sendbuffer, int *size);
 273 void prefetch(int, unsigned int *, unsigned short *, short*);
 274 void *transPrefetch(void *);
 275 void *mcqProcess(void *);
 276 prefetchpile_t *foundLocal(char *);// returns node with prefetch elements(oids, offsets)
 277 int lookupObject(unsigned int * oid, short offset);
 278 int transPrefetchProcess(transrecord_t *, int **, short);
 279 void sendPrefetchReq(prefetchpile_t*, int);
 280 int getPrefetchResponse(int);
 281 unsigned short getObjType(unsigned int oid);
 282 int startRemoteThread(unsigned int oid, unsigned int mid);
 283 /* Sends notification request for thread join, if sucessful returns 0 else returns -1 */
 284 int reqNotify(unsigned int *oidarry, unsigned short *versionarry, unsigned int numoid);
 285 void threadNotify(unsigned int oid, unsigned short version, unsigned int tid);
 286 int notifyAll(threadlist_t **head, unsigned int oid, unsigned int version);
 287
 288 /* end transactions */
 289 #endif