edits
[cdsspec-compiler.git] / notes / definition.cc
index 457b6094cfbe5ce6c16d8adb6db729944c9759b4..0c5b7965174727e5414f005c0421f33188937e35 100644 (file)
@@ -6,6 +6,8 @@
 #include <algorithm>
 #include <set>
 
+#include <functional>
+
 #include <stdarg.h>
 
 using namespace std;
@@ -14,8 +16,8 @@ typedef struct MethodCall {
        string interfaceName; // The interface label name
        void *value; // The pointer that points to the struct that have the return
                                 // value and the arguments
-       void *localState; // The pointer that points to the struct that represents
-                                         // the (local) state
+       void *state; // The pointer that points to the struct that represents
+                                         // the state
        set<MethodCall*> *prev; // Method calls that are hb right before me
        set<MethodCall*> *next; // Method calls that are hb right after me
        set<MethodCall*> *concurrent; // Method calls that are concurrent with me
@@ -30,21 +32,16 @@ typedef set<int> IntSet;
 
 /********** More general specification-related types and operations **********/
 
-#define NewSet new set<Method>
+#define NewMethodSet new set<Method>
 
 #define CAT(a, b) CAT_HELPER(a, b) /* Concatenate two symbols for macros! */
 #define CAT_HELPER(a, b) a ## b
 #define X(name) CAT(__##name, __LINE__) /* unique variable */
 
 /**
-       The set here is a vector<MethodCall*>* type, or the MethodSet type. And the
-       item would become the MethodCall* type, or the Method type
+       This is a generic ForEach primitive for all the containers that support
+       using iterator to iterate.
 */
-#define ForEach1(item, set) \
-       int X(i) = 0; \
-       for (Method item = (set)->size() > 0 ? (*(set))[0] : NULL; \
-               X(i) < (set)->size(); X(i)++, item = X(i) < (set)->size() ? (*(set))[X(i)] : NULL)
-
 #define ForEach(item, container) \
        auto X(_container) = (container); \
        auto X(iter) = X(_container)->begin(); \
@@ -52,24 +49,111 @@ typedef set<int> IntSet;
                X(_container)->end()) ? *X(iter) : 0)
 
 /**
-       The subset operation is only for the MethodCall set
+       This is a common macro that is used as a constant for the name of specific
+       variables. We basically have two usage scenario:
+       1. In Subset operation, we allow users to specify a condition to extract a
+       subset. In that condition expression, we provide NAME, RET(type), ARG(type,
+       field) and STATE(field) to access each item's (method call) information.
+       2. In general specification (in pre- & post- conditions and side effects),
+       we would automatically generate an assignment that assign the current
+       MethodCall* pointer to a variable namedd _M. With this, when we access the
+       state of the current method, we use STATE(field) (this is a reference
+       for read/write).
 */
-
+#define ITEM _M
 #define _M ME
 
 #define NAME Name(_M)
 
-#define LOCAL(field) Local(_M, field)
+#define STATE(field) State(_M, field)
 
 #define VALUE(type, field) Value(_M, type, field)
+#define RET(type) VALUE(type, RET)
+#define ARG(type, arg) VALUE(type, arg)
 
+/*
 #define Subset(s, subset, condition) \
        MethodSet original = s; \
-       MethodSet subset = NewSet; \
+       MethodSet subset = NewMethodSet; \
        ForEach (_M, original) { \
                if ((condition)) \
                        subset->insert(_M); \
        } \
+*/
+
+
+/**
+       This operation is specifically for Method set. For example, when we want to
+       construct an integer set from the state field "x" (which is an
+       integer) of the previous set of method calls (PREV), and the new set goes to
+       "readSet", we would call "MakeSet(int, PREV, readSet, STATE(x));". Then users
+       can use the "readSet" as an integer set (set<int>)
+*/
+#define MakeSet(type, oldset, newset, field) \
+       auto newset = new set<type>; \
+       ForEach (_M, oldset) \
+               newset->insert(field); \
+
+/**
+       We provide a more general subset operation that takes a plain boolean
+       expression on each item (access by the name "ITEM") of the set, and put it
+       into a new set if the boolean expression (Guard) on that item holds. This is
+       used as the second arguments of the Subset operation. An example to extract
+       a subset of positive elements on an IntSet "s" would be "Subset(s,
+       GeneralGuard(int, ITEM > 0))"
+*/
+#define GeneralGuard(type, expression)  std::function<bool(type)> ( \
+       [](type ITEM) -> bool { return (expression);}) \
+
+/**
+       This is a more specific guard designed for the Method (MethodCall*). It
+       basically wrap around the GeneralGuard with the type Method. An example to
+       extract the subset of method calls in the PREV set whose state "x" is
+       equal to "val" would be "Subset(PREV, Guard(STATE(x) == val))"
+*/
+#define Guard(expression) GeneralGuard(Method, expression)
+
+/**
+       A general subset operation that takes a condition and returns all the item
+       for which the boolean guard holds.
+*/
+template <class T>
+inline set<T>* Subset(set<T> *original, std::function<bool(T)> condition) {
+       set<T> *res = new set<T>;
+       ForEach (_M, original) {
+               if (condition(_M))
+                       res->insert(_M);
+       }
+       return res;
+}
+
+/**
+       A general sublist operation that takes a condition and returns all the item
+       for which the boolean guard holds in the same order as in the old list.
+*/
+template <class T>
+inline list<T>* Sublist(list<T> *original, std::function<bool(T)> condition) {
+       list<T> *res = new list<T>;
+       ForEach (_M, original) {
+               if (condition(_M))
+                       res->push_back(_M);
+       }
+       return res;
+}
+
+/**
+       A general subvector operation that takes a condition and returns all the item
+       for which the boolean guard holds in the same order as in the old vector.
+*/
+template <class T>
+inline vector<T>* Subvector(vector<T> *original, std::function<bool(T)> condition) {
+       vector<T> *res = new vector<T>;
+       ForEach (_M, original) {
+               if (condition(_M))
+                       res->push_back(_M);
+       }
+       return res;
+}
 
 /** General for set, list & vector */
 #define Size(container) ((container)->size())
@@ -123,12 +207,13 @@ inline void Insert(set<T> *s, set<T> *others) {
                s->insert(item);
 }
 
+/*
 inline MethodSet MakeSet(int count, ...) {
        va_list ap;
        MethodSet res;
 
        va_start (ap, count);
-       res = NewSet;
+       res = NewMethodSet;
        for (int i = 0; i < count; i++) {
                Method item = va_arg (ap, Method);
                res->insert(item);
@@ -136,22 +221,29 @@ inline MethodSet MakeSet(int count, ...) {
        va_end (ap);
        return res;
 }
+*/
 
 /********** Method call related operations **********/
 #define Name(method) method->interfaceName
 
-#define Local(method, field) ((StateStruct*) method->localState)->field
+#define State(method, field) ((StateStruct*) method->state)->field
 
 #define Value(method, type, field) ((type*) method->value)->field
+#define Ret(method, type) Value(method, type, RET)
+#define Arg(method, type, arg) Value(method, type, arg)
 
 #define Prev(method) method->prev
-#define PREV ME->prev
+#define PREV _M->prev
 
 #define Next(method) method->next
-#define NEXT ME->next
+#define NEXT _M->next
 
 #define Concurrent(method) method->concurrent
-#define CONCURRENT  ME->concurrent
+#define CONCURRENT  _M->concurrent
+
+
+/***************************************************************************/
+/***************************************************************************/
 
 // This auto-generated struct can have different fields according to the read
 // state declaration. Here it's just a test example
@@ -189,12 +281,12 @@ int main() {
        is2->insert(5);
 
 
-       MethodSet ms = NewSet;
+       MethodSet ms = NewMethodSet;
        Method m = new MethodCall;
        m->interfaceName = "Store";
        StateStruct *ss = new StateStruct;
        ss->x = 1;
-       m->localState = ss;
+       m->state = ss;
        Store *st = new Store;
        st->val = 2;
        m->value = st;
@@ -204,7 +296,7 @@ int main() {
        m->interfaceName= "Store";
        ss = new StateStruct;
        ss->x = 2;
-       m->localState = ss;
+       m->state = ss;
        st = new Store;
        st->val = 0;
        m->value = st;
@@ -214,15 +306,21 @@ int main() {
        m->interfaceName= "Load";
        ss = new StateStruct;
        ss->x = 0;
-       m->localState = ss;
+       m->state = ss;
        Load *ld = new Load;
        ld->RET = 2;
        m->value = ld;
        ms->insert(m);
-       
-       //Subset(ms, sub, NAME == "Store" && VALUE(Store, val) != 0);
-       Subset(ms, sub, NAME == "Store" && VALUE(Store, val) >= 0 && LOCAL(x) == 0);
 
-       cout << "Size=" << Size(sub) << endl;
+       MakeSet(int, ms, newis, STATE(x));
+       cout << "Size=" << Size(newis) << " | val= " << Belong(newis, 2) << endl;
+       ForEach (i, newis) {
+               cout << "elem: " << i << endl;
+       }
+
+
+       //Subset(ms, sub, NAME == "Store" && VALUE(Store, val) != 0);
+       //cout << "Size=" << Size(Subset(ms, Guard(NAME == "Store" && ARG(Store, val)
+               //>= 0 && STATE(x) >= 0 ))) << endl;
        return 0;
 }