kernel/mem: Recognize some deprecated memory port configs.
[yosys.git] / kernel / sigtools.h
index e93780b49e3ab337b0fdc7d128ba0759bd5b3ebd..c631fa481dad7363f0b75d3b0cb62707880364db 100644 (file)
@@ -2,11 +2,11 @@
  *  yosys -- Yosys Open SYnthesis Suite
  *
  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
- *  
+ *
  *  Permission to use, copy, modify, and/or distribute this software for any
  *  purpose with or without fee is hereby granted, provided that the above
  *  copyright notice and this permission notice appear in all copies.
- *  
+ *
  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 #ifndef SIGTOOLS_H
 #define SIGTOOLS_H
 
-#include "kernel/rtlil.h"
-#include "kernel/log.h"
-#include <assert.h>
-#include <set>
+#include "kernel/yosys.h"
+
+YOSYS_NAMESPACE_BEGIN
 
 struct SigPool
 {
-       typedef std::pair<RTLIL::Wire*,int> bitDef_t;
-       std::set<bitDef_t> bits;
+       struct bitDef_t : public std::pair<RTLIL::Wire*, int> {
+               bitDef_t() : std::pair<RTLIL::Wire*, int>(NULL, 0) { }
+               bitDef_t(const RTLIL::SigBit &bit) : std::pair<RTLIL::Wire*, int>(bit.wire, bit.offset) { }
+               unsigned int hash() const { return first->name.hash() + second; }
+       };
+
+       pool<bitDef_t> bits;
 
        void clear()
        {
                bits.clear();
        }
 
-       void add(RTLIL::SigSpec sig)
+       void add(const RTLIL::SigSpec &sig)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits.insert(bit);
-               }
+               for (auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits.insert(bit);
        }
 
        void add(const SigPool &other)
@@ -53,16 +52,11 @@ struct SigPool
                        bits.insert(bit);
        }
 
-       void del(RTLIL::SigSpec sig)
+       void del(const RTLIL::SigSpec &sig)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits.erase(bit);
-               }
+               for (auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits.erase(bit);
        }
 
        void del(const SigPool &other)
@@ -71,216 +65,173 @@ struct SigPool
                        bits.erase(bit);
        }
 
-       void expand(RTLIL::SigSpec from, RTLIL::SigSpec to)
+       void expand(const RTLIL::SigSpec &from, const RTLIL::SigSpec &to)
        {
-               from.expand();
-               to.expand();
-               assert(from.chunks().size() == to.chunks().size());
-               for (size_t i = 0; i < from.chunks().size(); i++) {
-                       bitDef_t bit_from(from.chunks()[i].wire, from.chunks()[i].offset);
-                       bitDef_t bit_to(to.chunks()[i].wire, to.chunks()[i].offset);
-                       if (bit_from.first == NULL || bit_to.first == NULL)
-                               continue;
-                       if (bits.count(bit_from) > 0)
+               log_assert(GetSize(from) == GetSize(to));
+               for (int i = 0; i < GetSize(from); i++) {
+                       bitDef_t bit_from(from[i]), bit_to(to[i]);
+                       if (bit_from.first != NULL && bit_to.first != NULL && bits.count(bit_from) > 0)
                                bits.insert(bit_to);
                }
        }
 
-       RTLIL::SigSpec extract(RTLIL::SigSpec sig)
+       RTLIL::SigSpec extract(const RTLIL::SigSpec &sig) const
        {
                RTLIL::SigSpec result;
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       bitDef_t bit(c.wire, c.offset);
-                       if (bits.count(bit) > 0)
-                               result.append(c);
-               }
+               for (auto &bit : sig)
+                       if (bit.wire != NULL && bits.count(bit))
+                               result.append(bit);
                return result;
        }
 
-       RTLIL::SigSpec remove(RTLIL::SigSpec sig)
+       RTLIL::SigSpec remove(const RTLIL::SigSpec &sig) const
        {
                RTLIL::SigSpec result;
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       bitDef_t bit(c.wire, c.offset);
-                       if (bits.count(bit) == 0)
-                               result.append(c);
-               }
+               for (auto &bit : sig)
+                       if (bit.wire != NULL && bits.count(bit) == 0)
+                               result.append(bit);
                return result;
        }
 
-       bool check_any(RTLIL::SigSpec sig)
+       bool check(const RTLIL::SigBit &bit) const
+       {
+               return bit.wire != NULL && bits.count(bit);
+       }
+
+       bool check_any(const RTLIL::SigSpec &sig) const
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       bitDef_t bit(c.wire, c.offset);
-                       if (bits.count(bit) != 0)
+               for (auto &bit : sig)
+                       if (bit.wire != NULL && bits.count(bit))
                                return true;
-               }
                return false;
        }
 
-       bool check_all(RTLIL::SigSpec sig)
+       bool check_all(const RTLIL::SigSpec &sig) const
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       bitDef_t bit(c.wire, c.offset);
-                       if (bits.count(bit) == 0)
+               for (auto &bit : sig)
+                       if (bit.wire != NULL && bits.count(bit) == 0)
                                return false;
-               }
                return true;
        }
 
-       RTLIL::SigSpec export_one()
+       RTLIL::SigSpec export_one() const
        {
-               RTLIL::SigSpec sig;
-               for (auto &bit : bits) {
-                       sig.append(RTLIL::SigSpec(bit.first, 1, bit.second));
-                       break;
-               }
-               return sig;
+               for (auto &bit : bits)
+                       return RTLIL::SigSpec(bit.first, bit.second);
+               return RTLIL::SigSpec();
        }
 
-       RTLIL::SigSpec export_all()
+       RTLIL::SigSpec export_all() const
        {
-               RTLIL::SigSpec sig;
+               pool<RTLIL::SigBit> sig;
                for (auto &bit : bits)
-                       sig.append(RTLIL::SigSpec(bit.first, 1, bit.second));
-               sig.sort_and_unify();
+                       sig.insert(RTLIL::SigBit(bit.first, bit.second));
                return sig;
        }
 
-       size_t size()
+       size_t size() const
        {
                return bits.size();
        }
 };
 
-template <typename T, class Compare = std::less<T>>
+template <typename T, class Compare = void>
 struct SigSet
 {
-       typedef std::pair<RTLIL::Wire*,int> bitDef_t;
-       std::map<bitDef_t, std::set<T, Compare>> bits;
+       static_assert(!std::is_same<Compare,void>::value, "Default value for `Compare' class not found for SigSet<T>. Please specify.");
+
+       struct bitDef_t : public std::pair<RTLIL::Wire*, int> {
+               bitDef_t() : std::pair<RTLIL::Wire*, int>(NULL, 0) { }
+               bitDef_t(const RTLIL::SigBit &bit) : std::pair<RTLIL::Wire*, int>(bit.wire, bit.offset) { }
+               unsigned int hash() const { return first->name.hash() + second; }
+       };
+
+       dict<bitDef_t, std::set<T, Compare>> bits;
 
        void clear()
        {
                bits.clear();
        }
 
-       void insert(RTLIL::SigSpec sig, T data)
+       void insert(const RTLIL::SigSpec &sig, T data)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits[bit].insert(data);
-               }
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits[bit].insert(data);
        }
 
-       void insert(RTLIL::SigSpec sig, const std::set<T> &data)
+       void insert(const RTLIL::SigSpec& sig, const std::set<T> &data)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits[bit].insert(data.begin(), data.end());
-               }
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits[bit].insert(data.begin(), data.end());
        }
 
-       void erase(RTLIL::SigSpec sig)
+       void erase(const RTLIL::SigSpec& sig)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits[bit].clear();
-               }
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits[bit].clear();
        }
 
-       void erase(RTLIL::SigSpec sig, T data)
+       void erase(const RTLIL::SigSpec &sig, T data)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits[bit].erase(data);
-               }
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits[bit].erase(data);
        }
 
-       void erase(RTLIL::SigSpec sig, const std::set<T> &data)
+       void erase(const RTLIL::SigSpec &sig, const std::set<T> &data)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       bits[bit].erase(data.begin(), data.end());
-               }
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL)
+                               bits[bit].erase(data.begin(), data.end());
        }
 
-       void find(RTLIL::SigSpec sig, std::set<T> &result)
+       void find(const RTLIL::SigSpec &sig, std::set<T> &result)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       for (auto &data : bits[bit])
-                               result.insert(data);
-               }
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL) {
+                               auto &data = bits[bit];
+                               result.insert(data.begin(), data.end());
+                       }
        }
 
-       std::set<T> find(RTLIL::SigSpec sig)
+       void find(const RTLIL::SigSpec &sig, pool<T> &result)
+       {
+               for (const auto &bit : sig)
+                       if (bit.wire != NULL) {
+                               auto &data = bits[bit];
+                               result.insert(data.begin(), data.end());
+                       }
+       }
+
+       std::set<T> find(const RTLIL::SigSpec &sig)
        {
                std::set<T> result;
                find(sig, result);
                return result;
        }
 
-       bool has(RTLIL::SigSpec sig)
+       bool has(const RTLIL::SigSpec &sig)
        {
-               sig.expand();
-               for (auto &c : sig.chunks()) {
-                       if (c.wire == NULL)
-                               continue;
-                       assert(c.width == 1);
-                       bitDef_t bit(c.wire, c.offset);
-                       if (bits.count(bit))
+               for (auto &bit : sig)
+                       if (bit.wire != NULL && bits.count(bit))
                                return true;
-               }
                return false;
        }
 };
 
+template<typename T>
+class SigSet<T, typename std::enable_if<!std::is_pointer<T>::value>::type> : public SigSet<T, std::less<T>> {};
+template<typename T>
+using sort_by_name_id_guard = typename std::enable_if<std::is_same<T,RTLIL::Cell*>::value>::type;
+template<typename T>
+class SigSet<T, sort_by_name_id_guard<T>> : public SigSet<T, RTLIL::sort_by_name_id<typename std::remove_pointer<T>::type>> {};
+
 struct SigMap
 {
-       typedef std::pair<RTLIL::Wire*,int> bitDef_t;
-
-       struct shared_bit_data_t {
-               RTLIL::SigBit map_to;
-               std::set<bitDef_t> bits;
-       };
-
-       std::map<bitDef_t, shared_bit_data_t*> bits;
+       mfp<SigBit> database;
 
        SigMap(RTLIL::Module *module = NULL)
        {
@@ -288,168 +239,84 @@ struct SigMap
                        set(module);
        }
 
-       SigMap(const SigMap &other)
-       {
-               copy(other);
-       }
-
-       const SigMap &operator=(const SigMap &other)
-       {
-               copy(other);
-               return *this;
-       }
-
-       void copy(const SigMap &other)
-       {
-               clear();
-               for (auto &bit : other.bits) {
-                       bits[bit.first] = new shared_bit_data_t;
-                       bits[bit.first]->map_to = bit.second->map_to;
-                       bits[bit.first]->bits = bit.second->bits;
-               }
-       }
-
        void swap(SigMap &other)
        {
-               bits.swap(other.bits);
-       }
-
-       ~SigMap()
-       {
-               clear();
+               database.swap(other.database);
        }
 
        void clear()
        {
-               std::set<shared_bit_data_t*> all_bd_ptr;
-               for (auto &it : bits)
-                       all_bd_ptr.insert(it.second);
-               for (auto bd_ptr : all_bd_ptr)
-                       delete bd_ptr;
-               bits.clear();
+               database.clear();
        }
 
        void set(RTLIL::Module *module)
        {
-               clear();
-               for (auto &it : module->connections)
-                       add(it.first, it.second);
-       }
+               int bitcount = 0;
+               for (auto &it : module->connections())
+                       bitcount += it.first.size();
 
-       // internal helper function
-       void register_bit(const RTLIL::SigBit &b)
-       {
-               bitDef_t bit(b.wire, b.offset);
-               if (b.wire && bits.count(bit) == 0) {
-                       shared_bit_data_t *bd = new shared_bit_data_t;
-                       bd->map_to = b;
-                       bd->bits.insert(bit);
-                       bits[bit] = bd;
-               }
-       }
+               database.clear();
+               database.reserve(bitcount);
 
-       // internal helper function
-       void unregister_bit(const RTLIL::SigBit &b)
-       {
-               bitDef_t bit(b.wire, b.offset);
-               if (b.wire && bits.count(bit) > 0) {
-                       shared_bit_data_t *bd = bits[bit];
-                       bd->bits.erase(bit);
-                       if (bd->bits.size() == 0)
-                               delete bd;
-                       bits.erase(bit);
-               }
+               for (auto &it : module->connections())
+                       add(it.first, it.second);
        }
 
-       // internal helper function
-       void merge_bit(const RTLIL::SigBit &bit1, const RTLIL::SigBit &bit2)
+       void add(const RTLIL::SigSpec& from, const RTLIL::SigSpec& to)
        {
-               assert(bit1.wire != NULL && bit2.wire != NULL);
+               log_assert(GetSize(from) == GetSize(to));
 
-               bitDef_t b1(bit1.wire, bit1.offset);
-               bitDef_t b2(bit2.wire, bit2.offset);
+               for (int i = 0; i < GetSize(from); i++)
+               {
+                       int bfi = database.lookup(from[i]);
+                       int bti = database.lookup(to[i]);
 
-               shared_bit_data_t *bd1 = bits[b1];
-               shared_bit_data_t *bd2 = bits[b2];
-               assert(bd1 != NULL && bd2 != NULL);
+                       const RTLIL::SigBit &bf = database[bfi];
+                       const RTLIL::SigBit &bt = database[bti];
 
-               if (bd1 == bd2)
-                       return;
+                       if (bf.wire || bt.wire)
+                       {
+                               database.imerge(bfi, bti);
 
-               if (bd1->bits.size() < bd2->bits.size())
-               {
-                       for (auto &bit : bd1->bits)
-                               bits[bit] = bd2;
-                       bd2->bits.insert(bd1->bits.begin(), bd1->bits.end());
-                       delete bd1;
-               }
-               else
-               {
-                       bd1->map_to = bd2->map_to;
-                       for (auto &bit : bd2->bits)
-                               bits[bit] = bd1;
-                       bd1->bits.insert(bd2->bits.begin(), bd2->bits.end());
-                       delete bd2;
+                               if (bf.wire == nullptr)
+                                       database.ipromote(bfi);
+
+                               if (bt.wire == nullptr)
+                                       database.ipromote(bti);
+                       }
                }
        }
 
-       // internal helper function
-       void set_bit(const RTLIL::SigBit &b1, const RTLIL::SigBit &b2)
+       void add(const RTLIL::SigBit &bit)
        {
-               assert(b1.wire != NULL);
-               bitDef_t bit(b1.wire, b1.offset);
-               assert(bits.count(bit) > 0);
-               bits[bit]->map_to = b2;
+               const auto &b = database.find(bit);
+               if (b.wire != nullptr)
+                       database.promote(bit);
        }
 
-       // internal helper function
-       void map_bit(RTLIL::SigBit &b) const
+       void add(const RTLIL::SigSpec &sig)
        {
-               bitDef_t bit(b.wire, b.offset);
-               if (b.wire && bits.count(bit) > 0)
-                       b = bits.at(bit)->map_to;
+               for (const auto &bit : sig)
+                       add(bit);
        }
 
-       void add(RTLIL::SigSpec from, RTLIL::SigSpec to)
-       {
-               assert(SIZE(from) == SIZE(to));
-
-               for (int i = 0; i < SIZE(from); i++)
-               {
-                       RTLIL::SigBit &bf = from[i];
-                       RTLIL::SigBit &bt = to[i];
-
-                       if (bf.wire == NULL)
-                               continue;
-
-                       register_bit(bf);
-                       register_bit(bt);
+       inline void add(Wire *wire) { return add(RTLIL::SigSpec(wire)); }
 
-                       if (bt.wire != NULL)
-                               merge_bit(bf, bt);
-                       else
-                               set_bit(bf, bt);
-               }
-       }
-
-       void add(RTLIL::SigSpec sig)
+       void apply(RTLIL::SigBit &bit) const
        {
-               for (auto &bit : sig) {
-                       register_bit(bit);
-                       set_bit(bit, bit);
-               }
+               bit = database.find(bit);
        }
 
-       void del(RTLIL::SigSpec sig)
+       void apply(RTLIL::SigSpec &sig) const
        {
                for (auto &bit : sig)
-                       unregister_bit(bit);
+                       apply(bit);
        }
 
-       void apply(RTLIL::SigSpec &sig) const
+       RTLIL::SigBit operator()(RTLIL::SigBit bit) const
        {
-               for (auto &bit : sig)
-                       map_bit(bit);
+               apply(bit);
+               return bit;
        }
 
        RTLIL::SigSpec operator()(RTLIL::SigSpec sig) const
@@ -457,6 +324,24 @@ struct SigMap
                apply(sig);
                return sig;
        }
+
+       RTLIL::SigSpec operator()(RTLIL::Wire *wire) const
+       {
+               SigSpec sig(wire);
+               apply(sig);
+               return sig;
+       }
+
+       RTLIL::SigSpec allbits() const
+       {
+               RTLIL::SigSpec sig;
+               for (const auto &bit : database)
+                       if (bit.wire != nullptr)
+                               sig.append(bit);
+               return sig;
+       }
 };
 
+YOSYS_NAMESPACE_END
+
 #endif /* SIGTOOLS_H */