promise.h

   1 /** @file promise.h
   2  *
   3  *  @brief Promise class --- tracks future obligations for execution
   4  *  related to weakly ordered writes.
   5  */
   6
   7 #ifndef __PROMISE_H__
   8 #define __PROMISE_H__
   9
  10 #include <inttypes.h>
  11
  12 #include "modeltypes.h"
  13 #include "mymemory.h"
  14 #include "stl-model.h"
  15
  16 class ModelAction;
  17 class ModelExecution;
  18
  19 struct future_value {
  20         uint64_t value;
  21         modelclock_t expiration;
  22         thread_id_t tid;
  23 };
  24
  25 class Promise {
  26  public:
  27         Promise(const ModelExecution *execution, ModelAction *read, struct future_value fv);
  28         bool add_reader(ModelAction *reader);
  29         ModelAction * get_reader(unsigned int i) const;
  30         unsigned int get_num_readers() const { return readers.size(); }
  31         bool eliminate_thread(thread_id_t tid);
  32         void add_thread(thread_id_t tid);
  33         bool thread_is_available(thread_id_t tid) const;
  34         bool has_failed() const;
  35         void set_write(const ModelAction *act) { write = act; }
  36         const ModelAction * get_write() const { return write; }
  37         int get_num_available_threads() const { return num_available_threads; }
  38         bool is_compatible(const ModelAction *act) const;
  39         bool is_compatible_exclusive(const ModelAction *act) const;
  40         bool same_value(const ModelAction *write) const;
  41         bool same_location(const ModelAction *act) const;
  42
  43         modelclock_t get_expiration() const { return fv.expiration; }
  44         uint64_t get_value() const { return fv.value; }
  45         struct future_value get_fv() const { return fv; }
  46
  47         int get_index() const;
  48
  49         void print() const;
  50
  51         bool equals(const Promise *x) const { return this == x; }
  52         bool equals(const ModelAction *x) const { return false; }
  53
  54         SNAPSHOTALLOC
  55  private:
  56         /** @brief The execution which created this Promise */
  57         const ModelExecution *execution;
  58
  59         /** @brief Thread ID(s) for thread(s) that potentially can satisfy this
  60          *  promise */
  61         SnapVector<bool> available_thread;
  62
  63         int num_available_threads;
  64
  65         const future_value fv;
  66
  67         /** @brief The action(s) which read the promised future value */
  68         SnapVector<ModelAction *> readers;
  69
  70         const ModelAction *write;
  71 };
  72
  73 #endif