svf-lib 1.0.1375 → 1.0.1376

package/SVF-osx/svf/include/include/AbstractExecution/IntervalExeState.h

@@ -0,0 +1,425 @@
+//===- IntervalExeState.h ----Interval Domain-------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013-2022>  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+/*
+ * IntervalExeState.h
+ *
+ *  Created on: Jul 9, 2022
+ *      Author: Xiao Cheng, Jiawei Wang
+ *
+ */
+
+#ifndef Z3_EXAMPLE_INTERVAL_DOMAIN_H
+#define Z3_EXAMPLE_INTERVAL_DOMAIN_H
+
+#include "AbstractExecution/ExeState.h"
+#include "AbstractExecution/IntervalValue.h"
+#include "Util/Z3Expr.h"
+
+#include <iomanip>
+
+namespace SVF
+{
+
+class IntervalExeState : public ExeState
+{
+    friend class SVFIR2ItvExeState;
+
+public:
+    typedef Map<u32_t, IntervalValue> VarToValMap;
+
+    typedef VarToValMap LocToValMap;
+
+    static IntervalExeState globalES;
+
+protected:
+    /// key: nodeID value: Domain Value
+    VarToValMap _varToItvVal;
+    /// key: nodeID value: Domain Value
+    LocToValMap _locToItvVal;
+
+
+public:
+    /// default constructor, default pc is true
+    IntervalExeState() : ExeState(ExeState::IntervalK) {}
+
+    /// set path constraints, val2val and loc2val map
+    IntervalExeState(VarToValMap &_varToValMap, LocToValMap &_locToValMap) : ExeState(ExeState::IntervalK),
+        _varToItvVal(_varToValMap),
+        _locToItvVal(_locToValMap) {}
+
+    /// copy constructor
+    IntervalExeState(const IntervalExeState &rhs) : ExeState(rhs), _varToItvVal(rhs.getVarToVal()),
+        _locToItvVal(rhs.getLocToVal())
+    {
+
+    }
+
+    /// check two interval exe state are equal or not. _varToItvVal and _locToItvVal map should be equivalent
+    IntervalExeState &operator=(const IntervalExeState &rhs)
+    {
+        if (rhs != *this)
+        {
+            _varToItvVal = rhs._varToItvVal;
+            _locToItvVal = rhs._locToItvVal;
+            ExeState::operator=(rhs);
+        }
+        return *this;
+    }
+
+    /// move constructor
+    IntervalExeState(IntervalExeState &&rhs) : ExeState(std::move(rhs)),
+        _varToItvVal(std::move(rhs._varToItvVal)),
+        _locToItvVal(std::move(rhs._locToItvVal))
+    {
+
+    }
+
+    /// operator= move constructor
+    IntervalExeState &operator=(IntervalExeState &&rhs)
+    {
+        if (&rhs != this)
+        {
+            _varToItvVal = std::move(rhs._varToItvVal);
+            _locToItvVal = std::move(rhs._locToItvVal);
+            ExeState::operator=(std::move(rhs));
+        }
+        return *this;
+    }
+
+    /// Set all value bottom
+    IntervalExeState bottom()
+    {
+        IntervalExeState inv = *this;
+        for (auto &item: inv._varToItvVal)
+        {
+            item.second.set_to_bottom();
+        }
+        return inv;
+    }
+
+    /// Set all value top
+    IntervalExeState top()
+    {
+        IntervalExeState inv = *this;
+        for (auto &item: inv._varToItvVal)
+        {
+            item.second.set_to_top();
+        }
+        return inv;
+    }
+
+    /// Copy some values and return a new IntervalExeState
+    IntervalExeState sliceState(Set<u32_t> &sl)
+    {
+        IntervalExeState inv;
+        for (u32_t id: sl)
+        {
+            inv._varToItvVal[id] = _varToItvVal[id];
+        }
+        return inv;
+    }
+
+    VAddrs &getVAddrs(u32_t id) override
+    {
+        auto it = globalES._varToVAddrs.find(id);
+        if (it != globalES._varToVAddrs.end())
+            return it->second;
+        else
+            return _varToVAddrs[id];
+    }
+
+    inline bool inVarToIValTable(u32_t id) const
+    {
+        return _varToItvVal.find(id) != _varToItvVal.end() ||
+               globalES._varToItvVal.find(id) != globalES._varToItvVal.end();
+    }
+
+    inline bool inVarToAddrsTable(u32_t id) const override
+    {
+        return _varToVAddrs.find(id) != _varToVAddrs.end() ||
+               globalES._varToVAddrs.find(id) != globalES._varToVAddrs.end();
+    }
+
+    inline bool inLocToIValTable(u32_t id) const
+    {
+        return _locToItvVal.find(id) != _locToItvVal.end() ||
+               globalES._locToItvVal.find(id) != globalES._locToItvVal.end();
+    }
+
+    inline bool inLocalLocToIValTable(u32_t id) const
+    {
+        return _locToItvVal.find(id) != _locToItvVal.end();
+    }
+
+    inline bool inLocToAddrsTable(u32_t id) const override
+    {
+        return _locToVAddrs.find(id) != _locToVAddrs.end() ||
+               globalES._locToVAddrs.find(id) != globalES._locToVAddrs.end();
+    }
+
+    inline bool inLocalLocToAddrsTable(u32_t id) const
+    {
+        return _locToVAddrs.find(id) != _locToVAddrs.end();
+    }
+
+    bool equals(const IntervalExeState &other) const;
+
+    virtual ~IntervalExeState() = default;
+
+
+    /// get var2val map
+    const VarToValMap &getVarToVal() const
+    {
+        return _varToItvVal;
+    }
+
+    /// get loc2val map
+    const LocToValMap &getLocToVal() const
+    {
+        return _locToItvVal;
+    }
+
+    ///  [], call getValueExpr()
+    inline IntervalValue &operator[](u32_t varId)
+    {
+        auto it = globalES._varToItvVal.find(varId);
+        if (it != globalES._varToItvVal.end())
+        {
+            return it->second;
+        }
+        else
+        {
+            return _varToItvVal[varId];
+        }
+    }
+
+    /// domain widen with other, important! other widen this.
+    void widenWith(const IntervalExeState &other);
+
+    /// domain join with other, important! other widen this.
+    void joinWith(const IntervalExeState &other);
+
+    /// domain narrow with other, important! other widen this.
+    void narrowWith(const IntervalExeState &other);
+
+    /// domain meet with other, important! other widen this.
+    void meetWith(const IntervalExeState &other);
+
+    /// domain meet with other varToValMap
+    void meetWith(VarToValMap *other);
+
+
+    /// Return int value from an expression if it is a numeral, otherwise return an approximate value
+    inline s32_t Interval2NumValue(const IntervalValue &e) const
+    {
+        //TODO: return concrete value;
+        return (s32_t) e.lb().getNumeral();
+    }
+
+    ///TODO: Create new inteval value
+    IntervalValue createIntervalValue(double lb, double ub, NodeID id)
+    {
+        _varToItvVal[id] = IntervalValue(lb, ub);
+        return _varToItvVal[id];
+    }
+
+    /// Return true if map has bottom value
+    inline bool has_bottom()
+    {
+        for (auto it = _varToItvVal.begin(); it != _varToItvVal.end(); ++it)
+        {
+            if (it->second.isBottom())
+            {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    u32_t hash() const override;
+
+public:
+    inline void store(u32_t addr, const IntervalValue &val)
+    {
+        assert(isVirtualMemAddress(addr) && "not virtual address?");
+        if (isNullPtr(addr)) return;
+        u32_t objId = getInternalID(addr);
+        _locToItvVal[objId] = val;
+    }
+
+    inline IntervalValue &load(u32_t addr)
+    {
+        assert(isVirtualMemAddress(addr) && "not virtual address?");
+        u32_t objId = getInternalID(addr);
+        auto it = _locToItvVal.find(objId);
+        if(it != _locToItvVal.end())
+            return it->second;
+        else
+        {
+            auto globIt = globalES._locToItvVal.find(objId);
+            if(globIt != globalES._locToItvVal.end())
+                return globIt->second;
+            else
+                return _locToItvVal[objId];
+        }
+    }
+
+    inline VAddrs &loadVAddrs(u32_t addr) override
+    {
+        assert(isVirtualMemAddress(addr) && "not virtual address?");
+        u32_t objId = getInternalID(addr);
+        auto it = _locToVAddrs.find(objId);
+        if(it != _locToVAddrs.end())
+            return it->second;
+        else
+        {
+            auto globIt = globalES._locToVAddrs.find(objId);
+            if(globIt != globalES._locToVAddrs.end())
+                return globIt->second;
+            else
+                return _locToVAddrs[objId];
+        }
+    }
+
+    inline IntervalValue& getLocToItv(u32_t id)
+    {
+        auto it = _locToItvVal.find(id);
+        if(it != _locToItvVal.end())
+            return it->second;
+        else
+        {
+            auto globIt = globalES._locToItvVal.find(id);
+            if(globIt != globalES._locToItvVal.end())
+                return globIt->second;
+            else
+                return _locToItvVal[id];
+        }
+    }
+
+    inline VAddrs& getLocVAddrs(u32_t id)
+    {
+        auto it = _locToVAddrs.find(id);
+        if(it != _locToVAddrs.end())
+            return it->second;
+        else
+        {
+            auto globIt = globalES._locToVAddrs.find(id);
+            if(globIt != globalES._locToVAddrs.end())
+                return globIt->second;
+            else
+                return _locToVAddrs[id];
+        }
+    }
+
+    /// Print values of all expressions
+    void printExprValues(std::ostream &oss) const override;
+
+    std::string toString() const override
+    {
+        return "";
+    }
+
+    static bool eqVarToValMap(const VarToValMap &lhs, const VarToValMap &rhs)
+    {
+        if (lhs.size() != rhs.size()) return false;
+        for (const auto &item: lhs)
+        {
+            auto it = rhs.find(item.first);
+            if (it == rhs.end())
+                return false;
+            if (!item.second.equals(it->second))
+            {
+                return false;
+            }
+        }
+        return true;
+    }
+
+
+    static bool lessThanVarToValMap(const VarToValMap &lhs, const VarToValMap &rhs)
+    {
+        if (lhs.size() != rhs.size()) return lhs.size() < rhs.size();
+        for (const auto &item: lhs)
+        {
+            auto it = rhs.find(item.first);
+            // lhs > rhs if SVFVar not exists in rhs
+            if (it == rhs.end())
+                return false;
+            // judge from expr id
+            if (!item.second.equals(it->second))
+            {
+                return !item.second.geq(it->second);
+            }
+        }
+        return false;
+    }
+
+    bool operator==(const IntervalExeState &rhs) const
+    {
+        return ExeState::operator==(rhs) && eqVarToValMap(_varToItvVal, rhs.getVarToVal()) &&
+               eqVarToValMap(_locToItvVal, rhs.getLocToVal());
+    }
+
+    bool operator!=(const IntervalExeState &rhs) const
+    {
+        return !(*this == rhs);
+    }
+
+    bool operator<(const IntervalExeState &rhs) const
+    {
+        // judge from path constraint
+        return (lessThanVarToValMap(_varToItvVal, rhs.getVarToVal()) ||
+                lessThanVarToValMap(_locToItvVal, rhs.getLocToVal()));
+    }
+
+
+    bool operator>=(const IntervalExeState &rhs) const
+    {
+        return !(*this < rhs);
+    }
+
+    void clear()
+    {
+        _locToItvVal.clear();
+        _varToItvVal.clear();
+        _locToVAddrs.clear();
+        _varToVAddrs.clear();
+    }
+
+
+private:
+    void printTable(const VarToValMap &table, std::ostream &oss) const;
+
+    void printTable(const VarToVAddrs &table, std::ostream &oss) const;
+};
+}
+
+template<>
+struct std::hash<SVF::IntervalExeState>
+{
+    size_t operator()(const SVF::IntervalExeState &exeState) const
+    {
+        return exeState.hash();
+    }
+};
+
+#endif //Z3_EXAMPLE_INTERVAL_DOMAIN_H