kernel/rtlil.h

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
   5  *
   6  *  Permission to use, copy, modify, and/or distribute this software for any
   7  *  purpose with or without fee is hereby granted, provided that the above
   8  *  copyright notice and this permission notice appear in all copies.
   9  *
  10  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  *
  18  */
  19
  20 #include "kernel/yosys.h"
  21
  22 #ifndef RTLIL_H
  23 #define RTLIL_H
  24
  25 YOSYS_NAMESPACE_BEGIN
  26
  27 namespace RTLIL
  28 {
  29         enum State : unsigned char {
  30                 S0 = 0,
  31                 S1 = 1,
  32                 Sx = 2, // undefined value or conflict
  33                 Sz = 3, // high-impedance / not-connected
  34                 Sa = 4, // don't care (used only in cases)
  35                 Sm = 5  // marker (used internally by some passes)
  36         };
  37
  38         enum SyncType : unsigned char {
  39                 ST0 = 0, // level sensitive: 0
  40                 ST1 = 1, // level sensitive: 1
  41                 STp = 2, // edge sensitive: posedge
  42                 STn = 3, // edge sensitive: negedge
  43                 STe = 4, // edge sensitive: both edges
  44                 STa = 5, // always active
  45                 STg = 6, // global clock
  46                 STi = 7  // init
  47         };
  48
  49         enum ConstFlags : unsigned char {
  50                 CONST_FLAG_NONE   = 0,
  51                 CONST_FLAG_STRING = 1,
  52                 CONST_FLAG_SIGNED = 2,  // only used for parameters
  53                 CONST_FLAG_REAL   = 4   // unused -- to be used for parameters
  54         };
  55
  56         struct Const;
  57         struct AttrObject;
  58         struct Selection;
  59         struct Monitor;
  60         struct Design;
  61         struct Module;
  62         struct Wire;
  63         struct Memory;
  64         struct Cell;
  65         struct SigChunk;
  66         struct SigBit;
  67         struct SigSpecIterator;
  68         struct SigSpecConstIterator;
  69         struct SigSpec;
  70         struct CaseRule;
  71         struct SwitchRule;
  72         struct SyncRule;
  73         struct Process;
  74
  75         typedef std::pair<SigSpec, SigSpec> SigSig;
  76
  77         struct IdString
  78         {
  79                 // the global id string cache
  80
  81                 static struct destruct_guard_t {
  82                         bool ok; // POD, will be initialized to zero
  83                         destruct_guard_t() { ok = true; }
  84                         ~destruct_guard_t() { ok = false; }
  85                 } destruct_guard;
  86
  87                 static std::vector<int> global_refcount_storage_;
  88                 static std::vector<char*> global_id_storage_;
  89                 static dict<char*, int, hash_cstr_ops> global_id_index_;
  90                 static std::vector<int> global_free_idx_list_;
  91
  92                 static inline int get_reference(int idx)
  93                 {
  94                         global_refcount_storage_.at(idx)++;
  95                         return idx;
  96                 }
  97
  98                 static inline int get_reference(const char *p)
  99                 {
 100                         log_assert(destruct_guard.ok);
 101
 102                         if (p[0]) {
 103                                 log_assert(p[1] != 0);
 104                                 log_assert(p[0] == '$' || p[0] == '\\');
 105                         }
 106
 107                         auto it = global_id_index_.find((char*)p);
 108                         if (it != global_id_index_.end()) {
 109                                 global_refcount_storage_.at(it->second)++;
 110                                 return it->second;
 111                         }
 112
 113                         if (global_free_idx_list_.empty()) {
 114                                 log_assert(global_id_storage_.size() < 0x40000000);
 115                                 global_free_idx_list_.push_back(global_id_storage_.size());
 116                                 global_id_storage_.push_back(nullptr);
 117                                 global_refcount_storage_.push_back(0);
 118                         }
 119
 120                         int idx = global_free_idx_list_.back();
 121                         global_free_idx_list_.pop_back();
 122                         global_id_storage_.at(idx) = strdup(p);
 123                         global_id_index_[global_id_storage_.at(idx)] = idx;
 124                         global_refcount_storage_.at(idx)++;
 125
 126                         // Avoid Create->Delete->Create pattern
 127                         static IdString last_created_id;
 128                         put_reference(last_created_id.index_);
 129                         last_created_id.index_ = idx;
 130                         get_reference(last_created_id.index_);
 131
 132                         if (yosys_xtrace) {
 133                                 log("#X# New IdString '%s' with index %d.\n", p, idx);
 134                                 log_backtrace("-X- ", yosys_xtrace-1);
 135                         }
 136
 137                         return idx;
 138                 }
 139
 140                 static inline void put_reference(int idx)
 141                 {
 142                         // put_reference() may be called from destructors after the destructor of
 143                         // global_refcount_storage_ has been run. in this case we simply do nothing.
 144                         if (!destruct_guard.ok)
 145                                 return;
 146
 147                         log_assert(global_refcount_storage_.at(idx) > 0);
 148
 149                         if (--global_refcount_storage_.at(idx) != 0)
 150                                 return;
 151
 152                         if (yosys_xtrace) {
 153                                 log("#X# Removed IdString '%s' with index %d.\n", global_id_storage_.at(idx), idx);
 154                                 log_backtrace("-X- ", yosys_xtrace-1);
 155                         }
 156
 157                         global_id_index_.erase(global_id_storage_.at(idx));
 158                         free(global_id_storage_.at(idx));
 159                         global_id_storage_.at(idx) = nullptr;
 160                         global_free_idx_list_.push_back(idx);
 161                 }
 162
 163                 // the actual IdString object is just is a single int
 164
 165                 int index_;
 166
 167                 IdString() : index_(get_reference("")) { }
 168                 IdString(const char *str) : index_(get_reference(str)) { }
 169                 IdString(const IdString &str) : index_(get_reference(str.index_)) { }
 170                 IdString(const std::string &str) : index_(get_reference(str.c_str())) { }
 171                 ~IdString() { put_reference(index_); }
 172
 173                 void operator=(const IdString &rhs) {
 174                         put_reference(index_);
 175                         index_ = get_reference(rhs.index_);
 176                 }
 177
 178                 void operator=(const char *rhs) {
 179                         IdString id(rhs);
 180                         *this = id;
 181                 }
 182
 183                 void operator=(const std::string &rhs) {
 184                         IdString id(rhs);
 185                         *this = id;
 186                 }
 187
 188                 const char *c_str() const {
 189                         return global_id_storage_.at(index_);
 190                 }
 191
 192                 std::string str() const {
 193                         return std::string(global_id_storage_.at(index_));
 194                 }
 195
 196                 bool operator<(const IdString &rhs) const {
 197                         return index_ < rhs.index_;
 198                 }
 199
 200                 bool operator==(const IdString &rhs) const { return index_ == rhs.index_; }
 201                 bool operator!=(const IdString &rhs) const { return index_ != rhs.index_; }
 202
 203                 // The methods below are just convenience functions for better compatibility with std::string.
 204
 205                 bool operator==(const std::string &rhs) const { return str() == rhs; }
 206                 bool operator!=(const std::string &rhs) const { return str() != rhs; }
 207
 208                 bool operator==(const char *rhs) const { return strcmp(c_str(), rhs) == 0; }
 209                 bool operator!=(const char *rhs) const { return strcmp(c_str(), rhs) != 0; }
 210
 211                 char operator[](size_t i) const {
 212                         const char *p = c_str();
 213                         for (; i != 0; i--, p++)
 214                                 log_assert(*p != 0);
 215                         return *p;
 216                 }
 217
 218                 std::string substr(size_t pos = 0, size_t len = std::string::npos) const {
 219                         if (len == std::string::npos || len >= strlen(c_str() + pos))
 220                                 return std::string(c_str() + pos);
 221                         else
 222                                 return std::string(c_str() + pos, len);
 223                 }
 224
 225                 size_t size() const {
 226                         return str().size();
 227                 }
 228
 229                 bool empty() const {
 230                         return c_str()[0] == 0;
 231                 }
 232
 233                 void clear() {
 234                         *this = IdString();
 235                 }
 236
 237                 unsigned int hash() const {
 238                         return index_;
 239                 }
 240
 241                 // The following is a helper key_compare class. Instead of for example std::set<Cell*>
 242                 // use std::set<Cell*, IdString::compare_ptr_by_name<Cell>> if the order of cells in the
 243                 // set has an influence on the algorithm.
 244
 245                 template<typename T> struct compare_ptr_by_name {
 246                         bool operator()(const T *a, const T *b) const {
 247                                 return (a == nullptr || b == nullptr) ? (a < b) : (a->name < b->name);
 248                         }
 249                 };
 250
 251                 // often one needs to check if a given IdString is part of a list (for example a list
 252                 // of cell types). the following functions helps with that.
 253
 254                 template<typename T, typename... Args>
 255                 bool in(T first, Args... rest) const {
 256                         return in(first) || in(rest...);
 257                 }
 258
 259                 bool in(IdString rhs) const { return *this == rhs; }
 260                 bool in(const char *rhs) const { return *this == rhs; }
 261                 bool in(const std::string &rhs) const { return *this == rhs; }
 262                 bool in(const pool<IdString> &rhs) const { return rhs.count(*this) != 0; }
 263         };
 264
 265         static inline std::string escape_id(std::string str) {
 266                 if (str.size() > 0 && str[0] != '\\' && str[0] != '$')
 267                         return "\\" + str;
 268                 return str;
 269         }
 270
 271         static inline std::string unescape_id(std::string str) {
 272                 if (str.size() < 2)
 273                         return str;
 274                 if (str[0] != '\\')
 275                         return str;
 276                 if (str[1] == '$' || str[1] == '\\')
 277                         return str;
 278                 if (str[1] >= '0' && str[1] <= '9')
 279                         return str;
 280                 return str.substr(1);
 281         }
 282
 283         static inline std::string unescape_id(RTLIL::IdString str) {
 284                 return unescape_id(str.str());
 285         }
 286
 287         static inline const char *id2cstr(const RTLIL::IdString &str) {
 288                 return log_id(str);
 289         }
 290
 291         template <typename T> struct sort_by_name_id {
 292                 bool operator()(T *a, T *b) const {
 293                         return a->name < b->name;
 294                 }
 295         };
 296
 297         template <typename T> struct sort_by_name_str {
 298                 bool operator()(T *a, T *b) const {
 299                         return strcmp(a->name.c_str(), b->name.c_str()) < 0;
 300                 }
 301         };
 302
 303         struct sort_by_id_str {
 304                 bool operator()(RTLIL::IdString a, RTLIL::IdString b) const {
 305                         return strcmp(a.c_str(), b.c_str()) < 0;
 306                 }
 307         };
 308
 309         // see calc.cc for the implementation of this functions
 310         RTLIL::Const const_not         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 311         RTLIL::Const const_and         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 312         RTLIL::Const const_or          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 313         RTLIL::Const const_xor         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 314         RTLIL::Const const_xnor        (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 315
 316         RTLIL::Const const_reduce_and  (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 317         RTLIL::Const const_reduce_or   (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 318         RTLIL::Const const_reduce_xor  (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 319         RTLIL::Const const_reduce_xnor (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 320         RTLIL::Const const_reduce_bool (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 321
 322         RTLIL::Const const_logic_not   (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 323         RTLIL::Const const_logic_and   (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 324         RTLIL::Const const_logic_or    (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 325
 326         RTLIL::Const const_shl         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 327         RTLIL::Const const_shr         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 328         RTLIL::Const const_sshl        (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 329         RTLIL::Const const_sshr        (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 330         RTLIL::Const const_shift       (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 331         RTLIL::Const const_shiftx      (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 332
 333         RTLIL::Const const_lt          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 334         RTLIL::Const const_le          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 335         RTLIL::Const const_eq          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 336         RTLIL::Const const_ne          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 337         RTLIL::Const const_eqx         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 338         RTLIL::Const const_nex         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 339         RTLIL::Const const_ge          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 340         RTLIL::Const const_gt          (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 341
 342         RTLIL::Const const_add         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 343         RTLIL::Const const_sub         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 344         RTLIL::Const const_mul         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 345         RTLIL::Const const_div         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 346         RTLIL::Const const_mod         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 347         RTLIL::Const const_pow         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 348
 349         RTLIL::Const const_pos         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 350         RTLIL::Const const_neg         (const RTLIL::Const &arg1, const RTLIL::Const &arg2, bool signed1, bool signed2, int result_len);
 351
 352
 353         // This iterator-range-pair is used for Design::modules(), Module::wires() and Module::cells().
 354         // It maintains a reference counter that is used to make sure that the container is not modified while being iterated over.
 355
 356         template<typename T>
 357         struct ObjIterator
 358         {
 359                 typename dict<RTLIL::IdString, T>::iterator it;
 360                 dict<RTLIL::IdString, T> *list_p;
 361                 int *refcount_p;
 362
 363                 ObjIterator() : list_p(nullptr), refcount_p(nullptr) {
 364                 }
 365
 366                 ObjIterator(decltype(list_p) list_p, int *refcount_p) : list_p(list_p), refcount_p(refcount_p) {
 367                         if (list_p->empty()) {
 368                                 this->list_p = nullptr;
 369                                 this->refcount_p = nullptr;
 370                         } else {
 371                                 it = list_p->begin();
 372                                 (*refcount_p)++;
 373                         }
 374                 }
 375
 376                 ObjIterator(const RTLIL::ObjIterator<T> &other) {
 377                         it = other.it;
 378                         list_p = other.list_p;
 379                         refcount_p = other.refcount_p;
 380                         if (refcount_p)
 381                                 (*refcount_p)++;
 382                 }
 383
 384                 ObjIterator &operator=(const RTLIL::ObjIterator<T> &other) {
 385                         if (refcount_p)
 386                                 (*refcount_p)--;
 387                         it = other.it;
 388                         list_p = other.list_p;
 389                         refcount_p = other.refcount_p;
 390                         if (refcount_p)
 391                                 (*refcount_p)++;
 392                         return *this;
 393                 }
 394
 395                 ~ObjIterator() {
 396                         if (refcount_p)
 397                                 (*refcount_p)--;
 398                 }
 399
 400                 inline T operator*() const {
 401                         log_assert(list_p != nullptr);
 402                         return it->second;
 403                 }
 404
 405                 inline bool operator!=(const RTLIL::ObjIterator<T> &other) const {
 406                         if (list_p == nullptr || other.list_p == nullptr)
 407                                 return list_p != other.list_p;
 408                         return it != other.it;
 409                 }
 410
 411                 inline void operator++() {
 412                         log_assert(list_p != nullptr);
 413                         if (++it == list_p->end()) {
 414                                 (*refcount_p)--;
 415                                 list_p = nullptr;
 416                                 refcount_p = nullptr;
 417                         }
 418                 }
 419         };
 420
 421         template<typename T>
 422         struct ObjRange
 423         {
 424                 dict<RTLIL::IdString, T> *list_p;
 425                 int *refcount_p;
 426
 427                 ObjRange(decltype(list_p) list_p, int *refcount_p) : list_p(list_p), refcount_p(refcount_p) { }
 428                 RTLIL::ObjIterator<T> begin() { return RTLIL::ObjIterator<T>(list_p, refcount_p); }
 429                 RTLIL::ObjIterator<T> end() { return RTLIL::ObjIterator<T>(); }
 430
 431                 size_t size() const {
 432                         return list_p->size();
 433                 }
 434
 435                 operator pool<T>() const {
 436                         pool<T> result;
 437                         for (auto &it : *list_p)
 438                                 result.insert(it.second);
 439                         return result;
 440                 }
 441
 442                 operator std::vector<T>() const {
 443                         std::vector<T> result;
 444                         result.reserve(list_p->size());
 445                         for (auto &it : *list_p)
 446                                 result.push_back(it.second);
 447                         return result;
 448                 }
 449
 450                 pool<T> to_pool() const { return *this; }
 451                 std::vector<T> to_vector() const { return *this; }
 452         };
 453 };
 454
 455 struct RTLIL::Const
 456 {
 457         int flags;
 458         std::vector<RTLIL::State> bits;
 459
 460         Const();
 461         Const(std::string str);
 462         Const(int val, int width = 32);
 463         Const(RTLIL::State bit, int width = 1);
 464         Const(const std::vector<RTLIL::State> &bits) : bits(bits) { flags = CONST_FLAG_NONE; }
 465         Const(const std::vector<bool> &bits);
 466
 467         bool operator <(const RTLIL::Const &other) const;
 468         bool operator ==(const RTLIL::Const &other) const;
 469         bool operator !=(const RTLIL::Const &other) const;
 470
 471         bool as_bool() const;
 472         int as_int(bool is_signed = false) const;
 473         std::string as_string() const;
 474         static Const from_string(std::string str);
 475
 476         std::string decode_string() const;
 477
 478         inline int size() const { return bits.size(); }
 479         inline RTLIL::State &operator[](int index) { return bits.at(index); }
 480         inline const RTLIL::State &operator[](int index) const { return bits.at(index); }
 481
 482         inline RTLIL::Const extract(int offset, int len = 1, RTLIL::State padding = RTLIL::State::S0) const {
 483                 RTLIL::Const ret;
 484                 ret.bits.reserve(len);
 485                 for (int i = offset; i < offset + len; i++)
 486                         ret.bits.push_back(i < GetSize(bits) ? bits[i] : padding);
 487                 return ret;
 488         }
 489
 490         inline unsigned int hash() const {
 491                 unsigned int h = mkhash_init;
 492                 for (auto b : bits)
 493                         mkhash(h, b);
 494                 return h;
 495         }
 496 };
 497
 498 struct RTLIL::AttrObject
 499 {
 500         dict<RTLIL::IdString, RTLIL::Const> attributes;
 501
 502         void set_bool_attribute(RTLIL::IdString id);
 503         bool get_bool_attribute(RTLIL::IdString id) const;
 504         void set_strpool_attribute(RTLIL::IdString id, const pool<string> &data);
 505         void add_strpool_attribute(RTLIL::IdString id, const pool<string> &data);
 506         pool<string> get_strpool_attribute(RTLIL::IdString id) const;
 507 };
 508
 509 struct RTLIL::SigChunk
 510 {
 511         RTLIL::Wire *wire;
 512         std::vector<RTLIL::State> data; // only used if wire == NULL, LSB at index 0
 513         int width, offset;
 514
 515         SigChunk();
 516         SigChunk(const RTLIL::Const &value);
 517         SigChunk(RTLIL::Wire *wire);
 518         SigChunk(RTLIL::Wire *wire, int offset, int width = 1);
 519         SigChunk(const std::string &str);
 520         SigChunk(int val, int width = 32);
 521         SigChunk(RTLIL::State bit, int width = 1);
 522         SigChunk(RTLIL::SigBit bit);
 523
 524         RTLIL::SigChunk extract(int offset, int length) const;
 525
 526         bool operator <(const RTLIL::SigChunk &other) const;
 527         bool operator ==(const RTLIL::SigChunk &other) const;
 528         bool operator !=(const RTLIL::SigChunk &other) const;
 529 };
 530
 531 struct RTLIL::SigBit
 532 {
 533         RTLIL::Wire *wire;
 534         union {
 535                 RTLIL::State data; // used if wire == NULL
 536                 int offset;        // used if wire != NULL
 537         };
 538
 539         SigBit();
 540         SigBit(RTLIL::State bit);
 541         SigBit(bool bit);
 542         SigBit(RTLIL::Wire *wire);
 543         SigBit(RTLIL::Wire *wire, int offset);
 544         SigBit(const RTLIL::SigChunk &chunk);
 545         SigBit(const RTLIL::SigChunk &chunk, int index);
 546         SigBit(const RTLIL::SigSpec &sig);
 547
 548         bool operator <(const RTLIL::SigBit &other) const;
 549         bool operator ==(const RTLIL::SigBit &other) const;
 550         bool operator !=(const RTLIL::SigBit &other) const;
 551         unsigned int hash() const;
 552 };
 553
 554 struct RTLIL::SigSpecIterator : public std::iterator<std::input_iterator_tag, RTLIL::SigSpec>
 555 {
 556         RTLIL::SigSpec *sig_p;
 557         int index;
 558
 559         inline RTLIL::SigBit &operator*() const;
 560         inline bool operator!=(const RTLIL::SigSpecIterator &other) const { return index != other.index; }
 561         inline bool operator==(const RTLIL::SigSpecIterator &other) const { return index == other.index; }
 562         inline void operator++() { index++; }
 563 };
 564
 565 struct RTLIL::SigSpecConstIterator : public std::iterator<std::input_iterator_tag, RTLIL::SigSpec>
 566 {
 567         const RTLIL::SigSpec *sig_p;
 568         int index;
 569
 570         inline const RTLIL::SigBit &operator*() const;
 571         inline bool operator!=(const RTLIL::SigSpecConstIterator &other) const { return index != other.index; }
 572         inline bool operator==(const RTLIL::SigSpecIterator &other) const { return index == other.index; }
 573         inline void operator++() { index++; }
 574 };
 575
 576 struct RTLIL::SigSpec
 577 {
 578 private:
 579         int width_;
 580         unsigned long hash_;
 581         std::vector<RTLIL::SigChunk> chunks_; // LSB at index 0
 582         std::vector<RTLIL::SigBit> bits_; // LSB at index 0
 583
 584         void pack() const;
 585         void unpack() const;
 586         void updhash() const;
 587
 588         inline bool packed() const {
 589                 return bits_.empty();
 590         }
 591
 592         inline void inline_unpack() const {
 593                 if (!chunks_.empty())
 594                         unpack();
 595         }
 596
 597 public:
 598         SigSpec();
 599         SigSpec(const RTLIL::SigSpec &other);
 600         SigSpec(std::initializer_list<RTLIL::SigSpec> parts);
 601         const RTLIL::SigSpec &operator=(const RTLIL::SigSpec &other);
 602
 603         SigSpec(const RTLIL::Const &value);
 604         SigSpec(const RTLIL::SigChunk &chunk);
 605         SigSpec(RTLIL::Wire *wire);
 606         SigSpec(RTLIL::Wire *wire, int offset, int width = 1);
 607         SigSpec(const std::string &str);
 608         SigSpec(int val, int width = 32);
 609         SigSpec(RTLIL::State bit, int width = 1);
 610         SigSpec(RTLIL::SigBit bit, int width = 1);
 611         SigSpec(std::vector<RTLIL::SigChunk> chunks);
 612         SigSpec(std::vector<RTLIL::SigBit> bits);
 613         SigSpec(pool<RTLIL::SigBit> bits);
 614         SigSpec(std::set<RTLIL::SigBit> bits);
 615         SigSpec(bool bit);
 616
 617         SigSpec(RTLIL::SigSpec &&other) {
 618                 width_ = other.width_;
 619                 hash_ = other.hash_;
 620                 chunks_ = std::move(other.chunks_);
 621                 bits_ = std::move(other.bits_);
 622         }
 623
 624         const RTLIL::SigSpec &operator=(RTLIL::SigSpec &&other) {
 625                 width_ = other.width_;
 626                 hash_ = other.hash_;
 627                 chunks_ = std::move(other.chunks_);
 628                 bits_ = std::move(other.bits_);
 629                 return *this;
 630         }
 631
 632         size_t get_hash() const {
 633                 if (!hash_) hash();
 634                 return hash_;
 635         }
 636
 637         inline const std::vector<RTLIL::SigChunk> &chunks() const { pack(); return chunks_; }
 638         inline const std::vector<RTLIL::SigBit> &bits() const { inline_unpack(); return bits_; }
 639
 640         inline int size() const { return width_; }
 641         inline bool empty() const { return width_ == 0; }
 642
 643         inline RTLIL::SigBit &operator[](int index) { inline_unpack(); return bits_.at(index); }
 644         inline const RTLIL::SigBit &operator[](int index) const { inline_unpack(); return bits_.at(index); }
 645
 646         inline RTLIL::SigSpecIterator begin() { RTLIL::SigSpecIterator it; it.sig_p = this; it.index = 0; return it; }
 647         inline RTLIL::SigSpecIterator end() { RTLIL::SigSpecIterator it; it.sig_p = this; it.index = width_; return it; }
 648
 649         inline RTLIL::SigSpecConstIterator begin() const { RTLIL::SigSpecConstIterator it; it.sig_p = this; it.index = 0; return it; }
 650         inline RTLIL::SigSpecConstIterator end() const { RTLIL::SigSpecConstIterator it; it.sig_p = this; it.index = width_; return it; }
 651
 652         void sort();
 653         void sort_and_unify();
 654
 655         void replace(const RTLIL::SigSpec &pattern, const RTLIL::SigSpec &with);
 656         void replace(const RTLIL::SigSpec &pattern, const RTLIL::SigSpec &with, RTLIL::SigSpec *other) const;
 657
 658         void replace(const dict<RTLIL::SigBit, RTLIL::SigBit> &rules);
 659         void replace(const dict<RTLIL::SigBit, RTLIL::SigBit> &rules, RTLIL::SigSpec *other) const;
 660
 661         void replace(const std::map<RTLIL::SigBit, RTLIL::SigBit> &rules);
 662         void replace(const std::map<RTLIL::SigBit, RTLIL::SigBit> &rules, RTLIL::SigSpec *other) const;
 663
 664         void replace(int offset, const RTLIL::SigSpec &with);
 665
 666         void remove(const RTLIL::SigSpec &pattern);
 667         void remove(const RTLIL::SigSpec &pattern, RTLIL::SigSpec *other) const;
 668         void remove2(const RTLIL::SigSpec &pattern, RTLIL::SigSpec *other);
 669
 670         void remove(const pool<RTLIL::SigBit> &pattern);
 671         void remove(const pool<RTLIL::SigBit> &pattern, RTLIL::SigSpec *other) const;
 672         void remove2(const pool<RTLIL::SigBit> &pattern, RTLIL::SigSpec *other);
 673         void remove2(const std::set<RTLIL::SigBit> &pattern, RTLIL::SigSpec *other);
 674
 675         void remove(int offset, int length = 1);
 676         void remove_const();
 677
 678         RTLIL::SigSpec extract(const RTLIL::SigSpec &pattern, const RTLIL::SigSpec *other = NULL) const;
 679         RTLIL::SigSpec extract(const pool<RTLIL::SigBit> &pattern, const RTLIL::SigSpec *other = NULL) const;
 680         RTLIL::SigSpec extract(int offset, int length = 1) const;
 681
 682         void append(const RTLIL::SigSpec &signal);
 683         void append_bit(const RTLIL::SigBit &bit);
 684
 685         void extend_u0(int width, bool is_signed = false);
 686
 687         RTLIL::SigSpec repeat(int num) const;
 688
 689         bool operator <(const RTLIL::SigSpec &other) const;
 690         bool operator ==(const RTLIL::SigSpec &other) const;
 691         inline bool operator !=(const RTLIL::SigSpec &other) const { return !(*this == other); }
 692
 693         bool is_wire() const;
 694         bool is_chunk() const;
 695         inline bool is_bit() const { return width_ == 1; }
 696
 697         bool is_fully_const() const;
 698         bool is_fully_zero() const;
 699         bool is_fully_def() const;
 700         bool is_fully_undef() const;
 701         bool has_const() const;
 702         bool has_marked_bits() const;
 703
 704         bool as_bool() const;
 705         int as_int(bool is_signed = false) const;
 706         std::string as_string() const;
 707         RTLIL::Const as_const() const;
 708         RTLIL::Wire *as_wire() const;
 709         RTLIL::SigChunk as_chunk() const;
 710         RTLIL::SigBit as_bit() const;
 711
 712         bool match(std::string pattern) const;
 713
 714         std::set<RTLIL::SigBit> to_sigbit_set() const;
 715         pool<RTLIL::SigBit> to_sigbit_pool() const;
 716         std::vector<RTLIL::SigBit> to_sigbit_vector() const;
 717         std::map<RTLIL::SigBit, RTLIL::SigBit> to_sigbit_map(const RTLIL::SigSpec &other) const;
 718         dict<RTLIL::SigBit, RTLIL::SigBit> to_sigbit_dict(const RTLIL::SigSpec &other) const;
 719
 720         static bool parse(RTLIL::SigSpec &sig, RTLIL::Module *module, std::string str);
 721         static bool parse_sel(RTLIL::SigSpec &sig, RTLIL::Design *design, RTLIL::Module *module, std::string str);
 722         static bool parse_rhs(const RTLIL::SigSpec &lhs, RTLIL::SigSpec &sig, RTLIL::Module *module, std::string str);
 723
 724         operator std::vector<RTLIL::SigChunk>() const { return chunks(); }
 725         operator std::vector<RTLIL::SigBit>() const { return bits(); }
 726
 727         unsigned int hash() const { if (!hash_) updhash(); return hash_; };
 728
 729 #ifndef NDEBUG
 730         void check() const;
 731 #else
 732         void check() const { }
 733 #endif
 734 };
 735
 736 struct RTLIL::Selection
 737 {
 738         bool full_selection;
 739         pool<RTLIL::IdString> selected_modules;
 740         dict<RTLIL::IdString, pool<RTLIL::IdString>> selected_members;
 741
 742         Selection(bool full = true) : full_selection(full) { }
 743
 744         bool selected_module(RTLIL::IdString mod_name) const;
 745         bool selected_whole_module(RTLIL::IdString mod_name) const;
 746         bool selected_member(RTLIL::IdString mod_name, RTLIL::IdString memb_name) const;
 747         void optimize(RTLIL::Design *design);
 748
 749         template<typename T1> void select(T1 *module) {
 750                 if (!full_selection && selected_modules.count(module->name) == 0) {
 751                         selected_modules.insert(module->name);
 752                         selected_members.erase(module->name);
 753                 }
 754         }
 755
 756         template<typename T1, typename T2> void select(T1 *module, T2 *member) {
 757                 if (!full_selection && selected_modules.count(module->name) == 0)
 758                         selected_members[module->name].insert(member->name);
 759         }
 760
 761         bool empty() const {
 762                 return !full_selection && selected_modules.empty() && selected_members.empty();
 763         }
 764 };
 765
 766 struct RTLIL::Monitor
 767 {
 768         unsigned int hashidx_;
 769         unsigned int hash() const { return hashidx_; }
 770
 771         Monitor() {
 772                 static unsigned int hashidx_count = 123456789;
 773                 hashidx_count = mkhash_xorshift(hashidx_count);
 774                 hashidx_ = hashidx_count;
 775         }
 776
 777         virtual ~Monitor() { }
 778         virtual void notify_module_add(RTLIL::Module*) { }
 779         virtual void notify_module_del(RTLIL::Module*) { }
 780         virtual void notify_connect(RTLIL::Cell*, const RTLIL::IdString&, const RTLIL::SigSpec&, RTLIL::SigSpec&) { }
 781         virtual void notify_connect(RTLIL::Module*, const RTLIL::SigSig&) { }
 782         virtual void notify_connect(RTLIL::Module*, const std::vector<RTLIL::SigSig>&) { }
 783         virtual void notify_blackout(RTLIL::Module*) { }
 784 };
 785
 786 struct RTLIL::Design
 787 {
 788         unsigned int hashidx_;
 789         unsigned int hash() const { return hashidx_; }
 790
 791         pool<RTLIL::Monitor*> monitors;
 792         dict<std::string, std::string> scratchpad;
 793
 794         int refcount_modules_;
 795         dict<RTLIL::IdString, RTLIL::Module*> modules_;
 796         std::vector<AST::AstNode*> verilog_packages, verilog_globals;
 797         dict<std::string, std::pair<std::string, bool>> verilog_defines;
 798
 799         std::vector<RTLIL::Selection> selection_stack;
 800         dict<RTLIL::IdString, RTLIL::Selection> selection_vars;
 801         std::string selected_active_module;
 802
 803         Design();
 804         ~Design();
 805
 806         RTLIL::ObjRange<RTLIL::Module*> modules();
 807         RTLIL::Module *module(RTLIL::IdString name);
 808         RTLIL::Module *top_module();
 809
 810         bool has(RTLIL::IdString id) const {
 811                 return modules_.count(id) != 0;
 812         }
 813
 814         void add(RTLIL::Module *module);
 815         RTLIL::Module *addModule(RTLIL::IdString name);
 816         void remove(RTLIL::Module *module);
 817         void rename(RTLIL::Module *module, RTLIL::IdString new_name);
 818
 819         void scratchpad_unset(std::string varname);
 820
 821         void scratchpad_set_int(std::string varname, int value);
 822         void scratchpad_set_bool(std::string varname, bool value);
 823         void scratchpad_set_string(std::string varname, std::string value);
 824
 825         int scratchpad_get_int(std::string varname, int default_value = 0) const;
 826         bool scratchpad_get_bool(std::string varname, bool default_value = false) const;
 827         std::string scratchpad_get_string(std::string varname, std::string default_value = std::string()) const;
 828
 829         void sort();
 830         void check();
 831         void optimize();
 832
 833         bool selected_module(RTLIL::IdString mod_name) const;
 834         bool selected_whole_module(RTLIL::IdString mod_name) const;
 835         bool selected_member(RTLIL::IdString mod_name, RTLIL::IdString memb_name) const;
 836
 837         bool selected_module(RTLIL::Module *mod) const;
 838         bool selected_whole_module(RTLIL::Module *mod) const;
 839
 840         RTLIL::Selection &selection() {
 841                 return selection_stack.back();
 842         }
 843
 844         const RTLIL::Selection &selection() const {
 845                 return selection_stack.back();
 846         }
 847
 848         bool full_selection() const {
 849                 return selection_stack.back().full_selection;
 850         }
 851
 852         template<typename T1> bool selected(T1 *module) const {
 853                 return selected_module(module->name);
 854         }
 855
 856         template<typename T1, typename T2> bool selected(T1 *module, T2 *member) const {
 857                 return selected_member(module->name, member->name);
 858         }
 859
 860         template<typename T1, typename T2> void select(T1 *module, T2 *member) {
 861                 if (selection_stack.size() > 0) {
 862                         RTLIL::Selection &sel = selection_stack.back();
 863                         sel.select(module, member);
 864                 }
 865         }
 866
 867         std::vector<RTLIL::Module*> selected_modules() const;
 868         std::vector<RTLIL::Module*> selected_whole_modules() const;
 869         std::vector<RTLIL::Module*> selected_whole_modules_warn() const;
 870 };
 871
 872 struct RTLIL::Module : public RTLIL::AttrObject
 873 {
 874         unsigned int hashidx_;
 875         unsigned int hash() const { return hashidx_; }
 876
 877 protected:
 878         void add(RTLIL::Wire *wire);
 879         void add(RTLIL::Cell *cell);
 880
 881 public:
 882         RTLIL::Design *design;
 883         pool<RTLIL::Monitor*> monitors;
 884
 885         int refcount_wires_;
 886         int refcount_cells_;
 887
 888         dict<RTLIL::IdString, RTLIL::Wire*> wires_;
 889         dict<RTLIL::IdString, RTLIL::Cell*> cells_;
 890         std::vector<RTLIL::SigSig> connections_;
 891
 892         RTLIL::IdString name;
 893         pool<RTLIL::IdString> avail_parameters;
 894         dict<RTLIL::IdString, RTLIL::Memory*> memories;
 895         dict<RTLIL::IdString, RTLIL::Process*> processes;
 896
 897         Module();
 898         virtual ~Module();
 899         virtual RTLIL::IdString derive(RTLIL::Design *design, dict<RTLIL::IdString, RTLIL::Const> parameters);
 900         virtual size_t count_id(RTLIL::IdString id);
 901
 902         virtual void sort();
 903         virtual void check();
 904         virtual void optimize();
 905
 906         void connect(const RTLIL::SigSig &conn);
 907         void connect(const RTLIL::SigSpec &lhs, const RTLIL::SigSpec &rhs);
 908         void new_connections(const std::vector<RTLIL::SigSig> &new_conn);
 909         const std::vector<RTLIL::SigSig> &connections() const;
 910
 911         std::vector<RTLIL::IdString> ports;
 912         void fixup_ports();
 913
 914         template<typename T> void rewrite_sigspecs(T functor);
 915         void cloneInto(RTLIL::Module *new_mod) const;
 916         virtual RTLIL::Module *clone() const;
 917
 918         bool has_memories() const;
 919         bool has_processes() const;
 920
 921         bool has_memories_warn() const;
 922         bool has_processes_warn() const;
 923
 924         std::vector<RTLIL::Wire*> selected_wires() const;
 925         std::vector<RTLIL::Cell*> selected_cells() const;
 926
 927         template<typename T> bool selected(T *member) const {
 928                 return design->selected_member(name, member->name);
 929         }
 930
 931         RTLIL::Wire* wire(RTLIL::IdString id) { return wires_.count(id) ? wires_.at(id) : nullptr; }
 932         RTLIL::Cell* cell(RTLIL::IdString id) { return cells_.count(id) ? cells_.at(id) : nullptr; }
 933
 934         RTLIL::ObjRange<RTLIL::Wire*> wires() { return RTLIL::ObjRange<RTLIL::Wire*>(&wires_, &refcount_wires_); }
 935         RTLIL::ObjRange<RTLIL::Cell*> cells() { return RTLIL::ObjRange<RTLIL::Cell*>(&cells_, &refcount_cells_); }
 936
 937         // Removing wires is expensive. If you have to remove wires, remove them all at once.
 938         void remove(const pool<RTLIL::Wire*> &wires);
 939         void remove(RTLIL::Cell *cell);
 940
 941         void rename(RTLIL::Wire *wire, RTLIL::IdString new_name);
 942         void rename(RTLIL::Cell *cell, RTLIL::IdString new_name);
 943         void rename(RTLIL::IdString old_name, RTLIL::IdString new_name);
 944
 945         void swap_names(RTLIL::Wire *w1, RTLIL::Wire *w2);
 946         void swap_names(RTLIL::Cell *c1, RTLIL::Cell *c2);
 947
 948         RTLIL::IdString uniquify(RTLIL::IdString name);
 949         RTLIL::IdString uniquify(RTLIL::IdString name, int &index);
 950
 951         RTLIL::Wire *addWire(RTLIL::IdString name, int width = 1);
 952         RTLIL::Wire *addWire(RTLIL::IdString name, const RTLIL::Wire *other);
 953
 954         RTLIL::Cell *addCell(RTLIL::IdString name, RTLIL::IdString type);
 955         RTLIL::Cell *addCell(RTLIL::IdString name, const RTLIL::Cell *other);
 956
 957         // The add* methods create a cell and return the created cell. All signals must exist in advance.
 958
 959         RTLIL::Cell* addNot (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 960         RTLIL::Cell* addPos (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 961         RTLIL::Cell* addNeg (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 962
 963         RTLIL::Cell* addAnd  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 964         RTLIL::Cell* addOr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 965         RTLIL::Cell* addXor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 966         RTLIL::Cell* addXnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 967
 968         RTLIL::Cell* addReduceAnd  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 969         RTLIL::Cell* addReduceOr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 970         RTLIL::Cell* addReduceXor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 971         RTLIL::Cell* addReduceXnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 972         RTLIL::Cell* addReduceBool (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 973
 974         RTLIL::Cell* addShl    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 975         RTLIL::Cell* addShr    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 976         RTLIL::Cell* addSshl   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 977         RTLIL::Cell* addSshr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 978         RTLIL::Cell* addShift  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 979         RTLIL::Cell* addShiftx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 980
 981         RTLIL::Cell* addLt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 982         RTLIL::Cell* addLe  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 983         RTLIL::Cell* addEq  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 984         RTLIL::Cell* addNe  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 985         RTLIL::Cell* addEqx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 986         RTLIL::Cell* addNex (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 987         RTLIL::Cell* addGe  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 988         RTLIL::Cell* addGt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 989
 990         RTLIL::Cell* addAdd (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 991         RTLIL::Cell* addSub (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 992         RTLIL::Cell* addMul (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 993         RTLIL::Cell* addDiv (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 994         RTLIL::Cell* addMod (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 995         RTLIL::Cell* addPow (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool a_signed = false, bool b_signed = false);
 996
 997         RTLIL::Cell* addLogicNot (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false);
 998         RTLIL::Cell* addLogicAnd (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
 999         RTLIL::Cell* addLogicOr  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false);
1000
1001         RTLIL::Cell* addMux  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s, RTLIL::SigSpec sig_y);
1002         RTLIL::Cell* addPmux (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s, RTLIL::SigSpec sig_y);
1003
1004         RTLIL::Cell* addSlice  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, RTLIL::Const offset);
1005         RTLIL::Cell* addConcat (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y);
1006         RTLIL::Cell* addLut    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, RTLIL::Const lut);
1007         RTLIL::Cell* addTribuf (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_y);
1008         RTLIL::Cell* addAssert (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en);
1009         RTLIL::Cell* addAssume (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en);
1010         RTLIL::Cell* addLive   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en);
1011         RTLIL::Cell* addFair   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en);
1012         RTLIL::Cell* addCover  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en);
1013         RTLIL::Cell* addEquiv  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y);
1014
1015         RTLIL::Cell* addSr    (RTLIL::IdString name, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr, RTLIL::SigSpec sig_q, bool set_polarity = true, bool clr_polarity = true);
1016         RTLIL::Cell* addFf    (RTLIL::IdString name, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q);
1017         RTLIL::Cell* addDff   (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_d,   RTLIL::SigSpec sig_q, bool clk_polarity = true);
1018         RTLIL::Cell* addDffe  (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_en,  RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, bool en_polarity = true);
1019         RTLIL::Cell* addDffsr (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1020                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, bool set_polarity = true, bool clr_polarity = true);
1021         RTLIL::Cell* addAdff (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_arst, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q,
1022                         RTLIL::Const arst_value, bool clk_polarity = true, bool arst_polarity = true);
1023         RTLIL::Cell* addDlatch (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true);
1024         RTLIL::Cell* addDlatchsr (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1025                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true, bool set_polarity = true, bool clr_polarity = true);
1026
1027         RTLIL::Cell* addBufGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_y);
1028         RTLIL::Cell* addNotGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_y);
1029         RTLIL::Cell* addAndGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1030         RTLIL::Cell* addNandGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1031         RTLIL::Cell* addOrGate     (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1032         RTLIL::Cell* addNorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1033         RTLIL::Cell* addXorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1034         RTLIL::Cell* addXnorGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1035         RTLIL::Cell* addAndnotGate (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1036         RTLIL::Cell* addOrnotGate  (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y);
1037         RTLIL::Cell* addMuxGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_s, RTLIL::SigBit sig_y);
1038         RTLIL::Cell* addAoi3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_y);
1039         RTLIL::Cell* addOai3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_y);
1040         RTLIL::Cell* addAoi4Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_d, RTLIL::SigBit sig_y);
1041         RTLIL::Cell* addOai4Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_d, RTLIL::SigBit sig_y);
1042
1043         RTLIL::Cell* addFfGate     (RTLIL::IdString name, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q);
1044         RTLIL::Cell* addDffGate    (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true);
1045         RTLIL::Cell* addDffeGate   (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, bool en_polarity = true);
1046         RTLIL::Cell* addDffsrGate  (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1047                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, bool set_polarity = true, bool clr_polarity = true);
1048         RTLIL::Cell* addAdffGate   (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_arst, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q,
1049                         bool arst_value = false, bool clk_polarity = true, bool arst_polarity = true);
1050         RTLIL::Cell* addDlatchGate (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true);
1051         RTLIL::Cell* addDlatchsrGate  (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1052                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true, bool set_polarity = true, bool clr_polarity = true);
1053
1054         // The methods without the add* prefix create a cell and an output signal. They return the newly created output signal.
1055
1056         RTLIL::SigSpec Not (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1057         RTLIL::SigSpec Pos (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1058         RTLIL::SigSpec Bu0 (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1059         RTLIL::SigSpec Neg (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1060
1061         RTLIL::SigSpec And  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1062         RTLIL::SigSpec Or   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1063         RTLIL::SigSpec Xor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1064         RTLIL::SigSpec Xnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1065
1066         RTLIL::SigSpec ReduceAnd  (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1067         RTLIL::SigSpec ReduceOr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1068         RTLIL::SigSpec ReduceXor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1069         RTLIL::SigSpec ReduceXnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1070         RTLIL::SigSpec ReduceBool (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1071
1072         RTLIL::SigSpec Shl    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1073         RTLIL::SigSpec Shr    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1074         RTLIL::SigSpec Sshl   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1075         RTLIL::SigSpec Sshr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1076         RTLIL::SigSpec Shift  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1077         RTLIL::SigSpec Shiftx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1078
1079         RTLIL::SigSpec Lt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1080         RTLIL::SigSpec Le  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1081         RTLIL::SigSpec Eq  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1082         RTLIL::SigSpec Ne  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1083         RTLIL::SigSpec Eqx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1084         RTLIL::SigSpec Nex (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1085         RTLIL::SigSpec Ge  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1086         RTLIL::SigSpec Gt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1087
1088         RTLIL::SigSpec Add (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1089         RTLIL::SigSpec Sub (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1090         RTLIL::SigSpec Mul (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1091         RTLIL::SigSpec Div (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1092         RTLIL::SigSpec Mod (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1093         RTLIL::SigSpec Pow (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool a_signed = false, bool b_signed = false);
1094
1095         RTLIL::SigSpec LogicNot (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false);
1096         RTLIL::SigSpec LogicAnd (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1097         RTLIL::SigSpec LogicOr  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false);
1098
1099         RTLIL::SigSpec Mux      (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s);
1100         RTLIL::SigSpec Pmux     (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s);
1101
1102         RTLIL::SigBit BufGate    (RTLIL::IdString name, RTLIL::SigBit sig_a);
1103         RTLIL::SigBit NotGate    (RTLIL::IdString name, RTLIL::SigBit sig_a);
1104         RTLIL::SigBit AndGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1105         RTLIL::SigBit NandGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1106         RTLIL::SigBit OrGate     (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1107         RTLIL::SigBit NorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1108         RTLIL::SigBit XorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1109         RTLIL::SigBit XnorGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1110         RTLIL::SigBit AndnotGate (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1111         RTLIL::SigBit OrnotGate  (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b);
1112         RTLIL::SigBit MuxGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_s);
1113         RTLIL::SigBit Aoi3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c);
1114         RTLIL::SigBit Oai3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c);
1115         RTLIL::SigBit Aoi4Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_d);
1116         RTLIL::SigBit Oai4Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_d);
1117
1118         RTLIL::SigSpec Anyconst  (RTLIL::IdString name, int width = 1);
1119         RTLIL::SigSpec Anyseq    (RTLIL::IdString name, int width = 1);
1120         RTLIL::SigSpec Initstate (RTLIL::IdString name);
1121 };
1122
1123 struct RTLIL::Wire : public RTLIL::AttrObject
1124 {
1125         unsigned int hashidx_;
1126         unsigned int hash() const { return hashidx_; }
1127
1128 protected:
1129         // use module->addWire() and module->remove() to create or destroy wires
1130         friend struct RTLIL::Module;
1131         Wire();
1132         ~Wire() { };
1133
1134 public:
1135         // do not simply copy wires
1136         Wire(RTLIL::Wire &other) = delete;
1137         void operator=(RTLIL::Wire &other) = delete;
1138
1139         RTLIL::Module *module;
1140         RTLIL::IdString name;
1141         int width, start_offset, port_id;
1142         bool port_input, port_output, upto;
1143 };
1144
1145 struct RTLIL::Memory : public RTLIL::AttrObject
1146 {
1147         unsigned int hashidx_;
1148         unsigned int hash() const { return hashidx_; }
1149
1150         Memory();
1151
1152         RTLIL::IdString name;
1153         int width, start_offset, size;
1154 };
1155
1156 struct RTLIL::Cell : public RTLIL::AttrObject
1157 {
1158         unsigned int hashidx_;
1159         unsigned int hash() const { return hashidx_; }
1160
1161 protected:
1162         // use module->addCell() and module->remove() to create or destroy cells
1163         friend struct RTLIL::Module;
1164         Cell();
1165
1166 public:
1167         // do not simply copy cells
1168         Cell(RTLIL::Cell &other) = delete;
1169         void operator=(RTLIL::Cell &other) = delete;
1170
1171         RTLIL::Module *module;
1172         RTLIL::IdString name;
1173         RTLIL::IdString type;
1174         dict<RTLIL::IdString, RTLIL::SigSpec> connections_;
1175         dict<RTLIL::IdString, RTLIL::Const> parameters;
1176
1177         // access cell ports
1178         bool hasPort(RTLIL::IdString portname) const;
1179         void unsetPort(RTLIL::IdString portname);
1180         void setPort(RTLIL::IdString portname, RTLIL::SigSpec signal);
1181         const RTLIL::SigSpec &getPort(RTLIL::IdString portname) const;
1182         const dict<RTLIL::IdString, RTLIL::SigSpec> &connections() const;
1183
1184         // information about cell ports
1185         bool known() const;
1186         bool input(RTLIL::IdString portname) const;
1187         bool output(RTLIL::IdString portname) const;
1188
1189         // access cell parameters
1190         bool hasParam(RTLIL::IdString paramname) const;
1191         void unsetParam(RTLIL::IdString paramname);
1192         void setParam(RTLIL::IdString paramname, RTLIL::Const value);
1193         const RTLIL::Const &getParam(RTLIL::IdString paramname) const;
1194
1195         void sort();
1196         void check();
1197         void fixup_parameters(bool set_a_signed = false, bool set_b_signed = false);
1198
1199         bool has_keep_attr() const {
1200                 return get_bool_attribute("\\keep") || (module && module->design && module->design->module(type) &&
1201                                 module->design->module(type)->get_bool_attribute("\\keep"));
1202         }
1203
1204         template<typename T> void rewrite_sigspecs(T functor);
1205 };
1206
1207 struct RTLIL::CaseRule
1208 {
1209         std::vector<RTLIL::SigSpec> compare;
1210         std::vector<RTLIL::SigSig> actions;
1211         std::vector<RTLIL::SwitchRule*> switches;
1212
1213         ~CaseRule();
1214         void optimize();
1215
1216         template<typename T> void rewrite_sigspecs(T functor);
1217         RTLIL::CaseRule *clone() const;
1218 };
1219
1220 struct RTLIL::SwitchRule : public RTLIL::AttrObject
1221 {
1222         RTLIL::SigSpec signal;
1223         std::vector<RTLIL::CaseRule*> cases;
1224
1225         ~SwitchRule();
1226
1227         template<typename T> void rewrite_sigspecs(T functor);
1228         RTLIL::SwitchRule *clone() const;
1229 };
1230
1231 struct RTLIL::SyncRule
1232 {
1233         RTLIL::SyncType type;
1234         RTLIL::SigSpec signal;
1235         std::vector<RTLIL::SigSig> actions;
1236
1237         template<typename T> void rewrite_sigspecs(T functor);
1238         RTLIL::SyncRule *clone() const;
1239 };
1240
1241 struct RTLIL::Process : public RTLIL::AttrObject
1242 {
1243         RTLIL::IdString name;
1244         RTLIL::CaseRule root_case;
1245         std::vector<RTLIL::SyncRule*> syncs;
1246
1247         ~Process();
1248
1249         template<typename T> void rewrite_sigspecs(T functor);
1250         RTLIL::Process *clone() const;
1251 };
1252
1253
1254 inline RTLIL::SigBit::SigBit() : wire(NULL), data(RTLIL::State::S0) { }
1255 inline RTLIL::SigBit::SigBit(RTLIL::State bit) : wire(NULL), data(bit) { }
1256 inline RTLIL::SigBit::SigBit(bool bit) : wire(NULL), data(bit ? RTLIL::S1 : RTLIL::S0) { }
1257 inline RTLIL::SigBit::SigBit(RTLIL::Wire *wire) : wire(wire), offset(0) { log_assert(wire && wire->width == 1); }
1258 inline RTLIL::SigBit::SigBit(RTLIL::Wire *wire, int offset) : wire(wire), offset(offset) { log_assert(wire != nullptr); }
1259 inline RTLIL::SigBit::SigBit(const RTLIL::SigChunk &chunk) : wire(chunk.wire) { log_assert(chunk.width == 1); if (wire) offset = chunk.offset; else data = chunk.data[0]; }
1260 inline RTLIL::SigBit::SigBit(const RTLIL::SigChunk &chunk, int index) : wire(chunk.wire) { if (wire) offset = chunk.offset + index; else data = chunk.data[index]; }
1261
1262 inline bool RTLIL::SigBit::operator<(const RTLIL::SigBit &other) const {
1263         if (wire == other.wire)
1264                 return wire ? (offset < other.offset) : (data < other.data);
1265         if (wire != nullptr && other.wire != nullptr)
1266                 return wire->name < other.wire->name;
1267         return wire < other.wire;
1268 }
1269
1270 inline bool RTLIL::SigBit::operator==(const RTLIL::SigBit &other) const {
1271         return (wire == other.wire) && (wire ? (offset == other.offset) : (data == other.data));
1272 }
1273
1274 inline bool RTLIL::SigBit::operator!=(const RTLIL::SigBit &other) const {
1275         return (wire != other.wire) || (wire ? (offset != other.offset) : (data != other.data));
1276 }
1277
1278 inline unsigned int RTLIL::SigBit::hash() const {
1279         if (wire)
1280                 return mkhash_add(wire->name.hash(), offset);
1281         return data;
1282 }
1283
1284 inline RTLIL::SigBit &RTLIL::SigSpecIterator::operator*() const {
1285         return (*sig_p)[index];
1286 }
1287
1288 inline const RTLIL::SigBit &RTLIL::SigSpecConstIterator::operator*() const {
1289         return (*sig_p)[index];
1290 }
1291
1292 inline RTLIL::SigBit::SigBit(const RTLIL::SigSpec &sig) {
1293         log_assert(sig.size() == 1 && sig.chunks().size() == 1);
1294         *this = SigBit(sig.chunks().front());
1295 }
1296
1297 template<typename T>
1298 void RTLIL::Module::rewrite_sigspecs(T functor)
1299 {
1300         for (auto &it : cells_)
1301                 it.second->rewrite_sigspecs(functor);
1302         for (auto &it : processes)
1303                 it.second->rewrite_sigspecs(functor);
1304         for (auto &it : connections_) {
1305                 functor(it.first);
1306                 functor(it.second);
1307         }
1308 }
1309
1310 template<typename T>
1311 void RTLIL::Cell::rewrite_sigspecs(T functor) {
1312         for (auto &it : connections_)
1313                 functor(it.second);
1314 }
1315
1316 template<typename T>
1317 void RTLIL::CaseRule::rewrite_sigspecs(T functor) {
1318         for (auto &it : compare)
1319                 functor(it);
1320         for (auto &it : actions) {
1321                 functor(it.first);
1322                 functor(it.second);
1323         }
1324         for (auto it : switches)
1325                 it->rewrite_sigspecs(functor);
1326 }
1327
1328 template<typename T>
1329 void RTLIL::SwitchRule::rewrite_sigspecs(T functor)
1330 {
1331         functor(signal);
1332         for (auto it : cases)
1333                 it->rewrite_sigspecs(functor);
1334 }
1335
1336 template<typename T>
1337 void RTLIL::SyncRule::rewrite_sigspecs(T functor)
1338 {
1339         functor(signal);
1340         for (auto &it : actions) {
1341                 functor(it.first);
1342                 functor(it.second);
1343         }
1344 }
1345
1346 template<typename T>
1347 void RTLIL::Process::rewrite_sigspecs(T functor)
1348 {
1349         root_case.rewrite_sigspecs(functor);
1350         for (auto it : syncs)
1351                 it->rewrite_sigspecs(functor);
1352 }
1353
1354 YOSYS_NAMESPACE_END
1355
1356 #endif