kernel/rtlil.h

   1 /* -*- c++ -*-
   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         bool is_fully_zero() const;
 483         bool is_fully_ones() const;
 484         bool is_fully_def() const;
 485         bool is_fully_undef() const;
 486
 487         inline RTLIL::Const extract(int offset, int len = 1, RTLIL::State padding = RTLIL::State::S0) const {
 488                 RTLIL::Const ret;
 489                 ret.bits.reserve(len);
 490                 for (int i = offset; i < offset + len; i++)
 491                         ret.bits.push_back(i < GetSize(bits) ? bits[i] : padding);
 492                 return ret;
 493         }
 494
 495         inline unsigned int hash() const {
 496                 unsigned int h = mkhash_init;
 497                 for (auto b : bits)
 498                         mkhash(h, b);
 499                 return h;
 500         }
 501 };
 502
 503 struct RTLIL::AttrObject
 504 {
 505         dict<RTLIL::IdString, RTLIL::Const> attributes;
 506
 507         void set_bool_attribute(RTLIL::IdString id);
 508         bool get_bool_attribute(RTLIL::IdString id) const;
 509
 510         void set_strpool_attribute(RTLIL::IdString id, const pool<string> &data);
 511         void add_strpool_attribute(RTLIL::IdString id, const pool<string> &data);
 512         pool<string> get_strpool_attribute(RTLIL::IdString id) const;
 513
 514         void set_src_attribute(const std::string &src);
 515         std::string get_src_attribute() const;
 516 };
 517
 518 struct RTLIL::SigChunk
 519 {
 520         RTLIL::Wire *wire;
 521         std::vector<RTLIL::State> data; // only used if wire == NULL, LSB at index 0
 522         int width, offset;
 523
 524         SigChunk();
 525         SigChunk(const RTLIL::Const &value);
 526         SigChunk(RTLIL::Wire *wire);
 527         SigChunk(RTLIL::Wire *wire, int offset, int width = 1);
 528         SigChunk(const std::string &str);
 529         SigChunk(int val, int width = 32);
 530         SigChunk(RTLIL::State bit, int width = 1);
 531         SigChunk(RTLIL::SigBit bit);
 532
 533         RTLIL::SigChunk extract(int offset, int length) const;
 534
 535         bool operator <(const RTLIL::SigChunk &other) const;
 536         bool operator ==(const RTLIL::SigChunk &other) const;
 537         bool operator !=(const RTLIL::SigChunk &other) const;
 538 };
 539
 540 struct RTLIL::SigBit
 541 {
 542         RTLIL::Wire *wire;
 543         union {
 544                 RTLIL::State data; // used if wire == NULL
 545                 int offset;        // used if wire != NULL
 546         };
 547
 548         SigBit();
 549         SigBit(RTLIL::State bit);
 550         SigBit(bool bit);
 551         SigBit(RTLIL::Wire *wire);
 552         SigBit(RTLIL::Wire *wire, int offset);
 553         SigBit(const RTLIL::SigChunk &chunk);
 554         SigBit(const RTLIL::SigChunk &chunk, int index);
 555         SigBit(const RTLIL::SigSpec &sig);
 556
 557         bool operator <(const RTLIL::SigBit &other) const;
 558         bool operator ==(const RTLIL::SigBit &other) const;
 559         bool operator !=(const RTLIL::SigBit &other) const;
 560         unsigned int hash() const;
 561 };
 562
 563 struct RTLIL::SigSpecIterator : public std::iterator<std::input_iterator_tag, RTLIL::SigSpec>
 564 {
 565         RTLIL::SigSpec *sig_p;
 566         int index;
 567
 568         inline RTLIL::SigBit &operator*() const;
 569         inline bool operator!=(const RTLIL::SigSpecIterator &other) const { return index != other.index; }
 570         inline bool operator==(const RTLIL::SigSpecIterator &other) const { return index == other.index; }
 571         inline void operator++() { index++; }
 572 };
 573
 574 struct RTLIL::SigSpecConstIterator : public std::iterator<std::input_iterator_tag, RTLIL::SigSpec>
 575 {
 576         const RTLIL::SigSpec *sig_p;
 577         int index;
 578
 579         inline const RTLIL::SigBit &operator*() const;
 580         inline bool operator!=(const RTLIL::SigSpecConstIterator &other) const { return index != other.index; }
 581         inline bool operator==(const RTLIL::SigSpecIterator &other) const { return index == other.index; }
 582         inline void operator++() { index++; }
 583 };
 584
 585 struct RTLIL::SigSpec
 586 {
 587 private:
 588         int width_;
 589         unsigned long hash_;
 590         std::vector<RTLIL::SigChunk> chunks_; // LSB at index 0
 591         std::vector<RTLIL::SigBit> bits_; // LSB at index 0
 592
 593         void pack() const;
 594         void unpack() const;
 595         void updhash() const;
 596
 597         inline bool packed() const {
 598                 return bits_.empty();
 599         }
 600
 601         inline void inline_unpack() const {
 602                 if (!chunks_.empty())
 603                         unpack();
 604         }
 605
 606 public:
 607         SigSpec();
 608         SigSpec(const RTLIL::SigSpec &other);
 609         SigSpec(std::initializer_list<RTLIL::SigSpec> parts);
 610         const RTLIL::SigSpec &operator=(const RTLIL::SigSpec &other);
 611
 612         SigSpec(const RTLIL::Const &value);
 613         SigSpec(const RTLIL::SigChunk &chunk);
 614         SigSpec(RTLIL::Wire *wire);
 615         SigSpec(RTLIL::Wire *wire, int offset, int width = 1);
 616         SigSpec(const std::string &str);
 617         SigSpec(int val, int width = 32);
 618         SigSpec(RTLIL::State bit, int width = 1);
 619         SigSpec(RTLIL::SigBit bit, int width = 1);
 620         SigSpec(std::vector<RTLIL::SigChunk> chunks);
 621         SigSpec(std::vector<RTLIL::SigBit> bits);
 622         SigSpec(pool<RTLIL::SigBit> bits);
 623         SigSpec(std::set<RTLIL::SigBit> bits);
 624         SigSpec(bool bit);
 625
 626         SigSpec(RTLIL::SigSpec &&other) {
 627                 width_ = other.width_;
 628                 hash_ = other.hash_;
 629                 chunks_ = std::move(other.chunks_);
 630                 bits_ = std::move(other.bits_);
 631         }
 632
 633         const RTLIL::SigSpec &operator=(RTLIL::SigSpec &&other) {
 634                 width_ = other.width_;
 635                 hash_ = other.hash_;
 636                 chunks_ = std::move(other.chunks_);
 637                 bits_ = std::move(other.bits_);
 638                 return *this;
 639         }
 640
 641         size_t get_hash() const {
 642                 if (!hash_) hash();
 643                 return hash_;
 644         }
 645
 646         inline const std::vector<RTLIL::SigChunk> &chunks() const { pack(); return chunks_; }
 647         inline const std::vector<RTLIL::SigBit> &bits() const { inline_unpack(); return bits_; }
 648
 649         inline int size() const { return width_; }
 650         inline bool empty() const { return width_ == 0; }
 651
 652         inline RTLIL::SigBit &operator[](int index) { inline_unpack(); return bits_.at(index); }
 653         inline const RTLIL::SigBit &operator[](int index) const { inline_unpack(); return bits_.at(index); }
 654
 655         inline RTLIL::SigSpecIterator begin() { RTLIL::SigSpecIterator it; it.sig_p = this; it.index = 0; return it; }
 656         inline RTLIL::SigSpecIterator end() { RTLIL::SigSpecIterator it; it.sig_p = this; it.index = width_; return it; }
 657
 658         inline RTLIL::SigSpecConstIterator begin() const { RTLIL::SigSpecConstIterator it; it.sig_p = this; it.index = 0; return it; }
 659         inline RTLIL::SigSpecConstIterator end() const { RTLIL::SigSpecConstIterator it; it.sig_p = this; it.index = width_; return it; }
 660
 661         void sort();
 662         void sort_and_unify();
 663
 664         void replace(const RTLIL::SigSpec &pattern, const RTLIL::SigSpec &with);
 665         void replace(const RTLIL::SigSpec &pattern, const RTLIL::SigSpec &with, RTLIL::SigSpec *other) const;
 666
 667         void replace(const dict<RTLIL::SigBit, RTLIL::SigBit> &rules);
 668         void replace(const dict<RTLIL::SigBit, RTLIL::SigBit> &rules, RTLIL::SigSpec *other) const;
 669
 670         void replace(const std::map<RTLIL::SigBit, RTLIL::SigBit> &rules);
 671         void replace(const std::map<RTLIL::SigBit, RTLIL::SigBit> &rules, RTLIL::SigSpec *other) const;
 672
 673         void replace(int offset, const RTLIL::SigSpec &with);
 674
 675         void remove(const RTLIL::SigSpec &pattern);
 676         void remove(const RTLIL::SigSpec &pattern, RTLIL::SigSpec *other) const;
 677         void remove2(const RTLIL::SigSpec &pattern, RTLIL::SigSpec *other);
 678
 679         void remove(const pool<RTLIL::SigBit> &pattern);
 680         void remove(const pool<RTLIL::SigBit> &pattern, RTLIL::SigSpec *other) const;
 681         void remove2(const pool<RTLIL::SigBit> &pattern, RTLIL::SigSpec *other);
 682         void remove2(const std::set<RTLIL::SigBit> &pattern, RTLIL::SigSpec *other);
 683
 684         void remove(int offset, int length = 1);
 685         void remove_const();
 686
 687         RTLIL::SigSpec extract(const RTLIL::SigSpec &pattern, const RTLIL::SigSpec *other = NULL) const;
 688         RTLIL::SigSpec extract(const pool<RTLIL::SigBit> &pattern, const RTLIL::SigSpec *other = NULL) const;
 689         RTLIL::SigSpec extract(int offset, int length = 1) const;
 690
 691         void append(const RTLIL::SigSpec &signal);
 692         void append_bit(const RTLIL::SigBit &bit);
 693
 694         void extend_u0(int width, bool is_signed = false);
 695
 696         RTLIL::SigSpec repeat(int num) const;
 697
 698         bool operator <(const RTLIL::SigSpec &other) const;
 699         bool operator ==(const RTLIL::SigSpec &other) const;
 700         inline bool operator !=(const RTLIL::SigSpec &other) const { return !(*this == other); }
 701
 702         bool is_wire() const;
 703         bool is_chunk() const;
 704         inline bool is_bit() const { return width_ == 1; }
 705
 706         bool is_fully_const() const;
 707         bool is_fully_zero() const;
 708         bool is_fully_ones() const;
 709         bool is_fully_def() const;
 710         bool is_fully_undef() const;
 711         bool has_const() const;
 712         bool has_marked_bits() const;
 713
 714         bool as_bool() const;
 715         int as_int(bool is_signed = false) const;
 716         std::string as_string() const;
 717         RTLIL::Const as_const() const;
 718         RTLIL::Wire *as_wire() const;
 719         RTLIL::SigChunk as_chunk() const;
 720         RTLIL::SigBit as_bit() const;
 721
 722         bool match(std::string pattern) const;
 723
 724         std::set<RTLIL::SigBit> to_sigbit_set() const;
 725         pool<RTLIL::SigBit> to_sigbit_pool() const;
 726         std::vector<RTLIL::SigBit> to_sigbit_vector() const;
 727         std::map<RTLIL::SigBit, RTLIL::SigBit> to_sigbit_map(const RTLIL::SigSpec &other) const;
 728         dict<RTLIL::SigBit, RTLIL::SigBit> to_sigbit_dict(const RTLIL::SigSpec &other) const;
 729
 730         static bool parse(RTLIL::SigSpec &sig, RTLIL::Module *module, std::string str);
 731         static bool parse_sel(RTLIL::SigSpec &sig, RTLIL::Design *design, RTLIL::Module *module, std::string str);
 732         static bool parse_rhs(const RTLIL::SigSpec &lhs, RTLIL::SigSpec &sig, RTLIL::Module *module, std::string str);
 733
 734         operator std::vector<RTLIL::SigChunk>() const { return chunks(); }
 735         operator std::vector<RTLIL::SigBit>() const { return bits(); }
 736
 737         unsigned int hash() const { if (!hash_) updhash(); return hash_; };
 738
 739 #ifndef NDEBUG
 740         void check() const;
 741 #else
 742         void check() const { }
 743 #endif
 744 };
 745
 746 struct RTLIL::Selection
 747 {
 748         bool full_selection;
 749         pool<RTLIL::IdString> selected_modules;
 750         dict<RTLIL::IdString, pool<RTLIL::IdString>> selected_members;
 751
 752         Selection(bool full = true) : full_selection(full) { }
 753
 754         bool selected_module(RTLIL::IdString mod_name) const;
 755         bool selected_whole_module(RTLIL::IdString mod_name) const;
 756         bool selected_member(RTLIL::IdString mod_name, RTLIL::IdString memb_name) const;
 757         void optimize(RTLIL::Design *design);
 758
 759         template<typename T1> void select(T1 *module) {
 760                 if (!full_selection && selected_modules.count(module->name) == 0) {
 761                         selected_modules.insert(module->name);
 762                         selected_members.erase(module->name);
 763                 }
 764         }
 765
 766         template<typename T1, typename T2> void select(T1 *module, T2 *member) {
 767                 if (!full_selection && selected_modules.count(module->name) == 0)
 768                         selected_members[module->name].insert(member->name);
 769         }
 770
 771         bool empty() const {
 772                 return !full_selection && selected_modules.empty() && selected_members.empty();
 773         }
 774 };
 775
 776 struct RTLIL::Monitor
 777 {
 778         unsigned int hashidx_;
 779         unsigned int hash() const { return hashidx_; }
 780
 781         Monitor() {
 782                 static unsigned int hashidx_count = 123456789;
 783                 hashidx_count = mkhash_xorshift(hashidx_count);
 784                 hashidx_ = hashidx_count;
 785         }
 786
 787         virtual ~Monitor() { }
 788         virtual void notify_module_add(RTLIL::Module*) { }
 789         virtual void notify_module_del(RTLIL::Module*) { }
 790         virtual void notify_connect(RTLIL::Cell*, const RTLIL::IdString&, const RTLIL::SigSpec&, RTLIL::SigSpec&) { }
 791         virtual void notify_connect(RTLIL::Module*, const RTLIL::SigSig&) { }
 792         virtual void notify_connect(RTLIL::Module*, const std::vector<RTLIL::SigSig>&) { }
 793         virtual void notify_blackout(RTLIL::Module*) { }
 794 };
 795
 796 struct RTLIL::Design
 797 {
 798         unsigned int hashidx_;
 799         unsigned int hash() const { return hashidx_; }
 800
 801         pool<RTLIL::Monitor*> monitors;
 802         dict<std::string, std::string> scratchpad;
 803
 804         int refcount_modules_;
 805         dict<RTLIL::IdString, RTLIL::Module*> modules_;
 806         std::vector<AST::AstNode*> verilog_packages, verilog_globals;
 807         dict<std::string, std::pair<std::string, bool>> verilog_defines;
 808
 809         std::vector<RTLIL::Selection> selection_stack;
 810         dict<RTLIL::IdString, RTLIL::Selection> selection_vars;
 811         std::string selected_active_module;
 812
 813         Design();
 814         ~Design();
 815
 816         RTLIL::ObjRange<RTLIL::Module*> modules();
 817         RTLIL::Module *module(RTLIL::IdString name);
 818         RTLIL::Module *top_module();
 819
 820         bool has(RTLIL::IdString id) const {
 821                 return modules_.count(id) != 0;
 822         }
 823
 824         void add(RTLIL::Module *module);
 825         RTLIL::Module *addModule(RTLIL::IdString name);
 826         void remove(RTLIL::Module *module);
 827         void rename(RTLIL::Module *module, RTLIL::IdString new_name);
 828
 829         void scratchpad_unset(std::string varname);
 830
 831         void scratchpad_set_int(std::string varname, int value);
 832         void scratchpad_set_bool(std::string varname, bool value);
 833         void scratchpad_set_string(std::string varname, std::string value);
 834
 835         int scratchpad_get_int(std::string varname, int default_value = 0) const;
 836         bool scratchpad_get_bool(std::string varname, bool default_value = false) const;
 837         std::string scratchpad_get_string(std::string varname, std::string default_value = std::string()) const;
 838
 839         void sort();
 840         void check();
 841         void optimize();
 842
 843         bool selected_module(RTLIL::IdString mod_name) const;
 844         bool selected_whole_module(RTLIL::IdString mod_name) const;
 845         bool selected_member(RTLIL::IdString mod_name, RTLIL::IdString memb_name) const;
 846
 847         bool selected_module(RTLIL::Module *mod) const;
 848         bool selected_whole_module(RTLIL::Module *mod) const;
 849
 850         RTLIL::Selection &selection() {
 851                 return selection_stack.back();
 852         }
 853
 854         const RTLIL::Selection &selection() const {
 855                 return selection_stack.back();
 856         }
 857
 858         bool full_selection() const {
 859                 return selection_stack.back().full_selection;
 860         }
 861
 862         template<typename T1> bool selected(T1 *module) const {
 863                 return selected_module(module->name);
 864         }
 865
 866         template<typename T1, typename T2> bool selected(T1 *module, T2 *member) const {
 867                 return selected_member(module->name, member->name);
 868         }
 869
 870         template<typename T1, typename T2> void select(T1 *module, T2 *member) {
 871                 if (selection_stack.size() > 0) {
 872                         RTLIL::Selection &sel = selection_stack.back();
 873                         sel.select(module, member);
 874                 }
 875         }
 876
 877         std::vector<RTLIL::Module*> selected_modules() const;
 878         std::vector<RTLIL::Module*> selected_whole_modules() const;
 879         std::vector<RTLIL::Module*> selected_whole_modules_warn() const;
 880 };
 881
 882 struct RTLIL::Module : public RTLIL::AttrObject
 883 {
 884         unsigned int hashidx_;
 885         unsigned int hash() const { return hashidx_; }
 886
 887 protected:
 888         void add(RTLIL::Wire *wire);
 889         void add(RTLIL::Cell *cell);
 890
 891 public:
 892         RTLIL::Design *design;
 893         pool<RTLIL::Monitor*> monitors;
 894
 895         int refcount_wires_;
 896         int refcount_cells_;
 897
 898         dict<RTLIL::IdString, RTLIL::Wire*> wires_;
 899         dict<RTLIL::IdString, RTLIL::Cell*> cells_;
 900         std::vector<RTLIL::SigSig> connections_;
 901
 902         RTLIL::IdString name;
 903         pool<RTLIL::IdString> avail_parameters;
 904         dict<RTLIL::IdString, RTLIL::Memory*> memories;
 905         dict<RTLIL::IdString, RTLIL::Process*> processes;
 906
 907         Module();
 908         virtual ~Module();
 909         virtual RTLIL::IdString derive(RTLIL::Design *design, dict<RTLIL::IdString, RTLIL::Const> parameters, bool mayfail = false);
 910         virtual RTLIL::IdString derive(RTLIL::Design *design, dict<RTLIL::IdString, RTLIL::Const> parameters, dict<RTLIL::IdString, RTLIL::Module*> interfaces, dict<RTLIL::IdString, RTLIL::IdString> modports, bool mayfail = false);
 911         virtual size_t count_id(RTLIL::IdString id);
 912         virtual void reprocess_module(RTLIL::Design *design, dict<RTLIL::IdString, RTLIL::Module *> local_interfaces);
 913
 914         virtual void sort();
 915         virtual void check();
 916         virtual void optimize();
 917
 918         void connect(const RTLIL::SigSig &conn);
 919         void connect(const RTLIL::SigSpec &lhs, const RTLIL::SigSpec &rhs);
 920         void new_connections(const std::vector<RTLIL::SigSig> &new_conn);
 921         const std::vector<RTLIL::SigSig> &connections() const;
 922
 923         std::vector<RTLIL::IdString> ports;
 924         void fixup_ports();
 925
 926         template<typename T> void rewrite_sigspecs(T &functor);
 927         void cloneInto(RTLIL::Module *new_mod) const;
 928         virtual RTLIL::Module *clone() const;
 929
 930         bool has_memories() const;
 931         bool has_processes() const;
 932
 933         bool has_memories_warn() const;
 934         bool has_processes_warn() const;
 935
 936         std::vector<RTLIL::Wire*> selected_wires() const;
 937         std::vector<RTLIL::Cell*> selected_cells() const;
 938
 939         template<typename T> bool selected(T *member) const {
 940                 return design->selected_member(name, member->name);
 941         }
 942
 943         RTLIL::Wire* wire(RTLIL::IdString id) { return wires_.count(id) ? wires_.at(id) : nullptr; }
 944         RTLIL::Cell* cell(RTLIL::IdString id) { return cells_.count(id) ? cells_.at(id) : nullptr; }
 945
 946         RTLIL::ObjRange<RTLIL::Wire*> wires() { return RTLIL::ObjRange<RTLIL::Wire*>(&wires_, &refcount_wires_); }
 947         RTLIL::ObjRange<RTLIL::Cell*> cells() { return RTLIL::ObjRange<RTLIL::Cell*>(&cells_, &refcount_cells_); }
 948
 949         // Removing wires is expensive. If you have to remove wires, remove them all at once.
 950         void remove(const pool<RTLIL::Wire*> &wires);
 951         void remove(RTLIL::Cell *cell);
 952
 953         void rename(RTLIL::Wire *wire, RTLIL::IdString new_name);
 954         void rename(RTLIL::Cell *cell, RTLIL::IdString new_name);
 955         void rename(RTLIL::IdString old_name, RTLIL::IdString new_name);
 956
 957         void swap_names(RTLIL::Wire *w1, RTLIL::Wire *w2);
 958         void swap_names(RTLIL::Cell *c1, RTLIL::Cell *c2);
 959
 960         RTLIL::IdString uniquify(RTLIL::IdString name);
 961         RTLIL::IdString uniquify(RTLIL::IdString name, int &index);
 962
 963         RTLIL::Wire *addWire(RTLIL::IdString name, int width = 1);
 964         RTLIL::Wire *addWire(RTLIL::IdString name, const RTLIL::Wire *other);
 965
 966         RTLIL::Cell *addCell(RTLIL::IdString name, RTLIL::IdString type);
 967         RTLIL::Cell *addCell(RTLIL::IdString name, const RTLIL::Cell *other);
 968
 969         // The add* methods create a cell and return the created cell. All signals must exist in advance.
 970
 971         RTLIL::Cell* addNot (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 972         RTLIL::Cell* addPos (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 973         RTLIL::Cell* addNeg (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 974
 975         RTLIL::Cell* addAnd  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 976         RTLIL::Cell* addOr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 977         RTLIL::Cell* addXor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 978         RTLIL::Cell* addXnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 979
 980         RTLIL::Cell* addReduceAnd  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 981         RTLIL::Cell* addReduceOr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 982         RTLIL::Cell* addReduceXor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 983         RTLIL::Cell* addReduceXnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 984         RTLIL::Cell* addReduceBool (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 985
 986         RTLIL::Cell* addShl    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 987         RTLIL::Cell* addShr    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 988         RTLIL::Cell* addSshl   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 989         RTLIL::Cell* addSshr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 990         RTLIL::Cell* addShift  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 991         RTLIL::Cell* addShiftx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 992
 993         RTLIL::Cell* addLt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 994         RTLIL::Cell* addLe  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 995         RTLIL::Cell* addEq  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 996         RTLIL::Cell* addNe  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 997         RTLIL::Cell* addEqx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 998         RTLIL::Cell* addNex (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
 999         RTLIL::Cell* addGe  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1000         RTLIL::Cell* addGt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1001
1002         RTLIL::Cell* addAdd (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1003         RTLIL::Cell* addSub (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1004         RTLIL::Cell* addMul (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1005         RTLIL::Cell* addDiv (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1006         RTLIL::Cell* addMod (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1007         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, const std::string &src = "");
1008
1009         RTLIL::Cell* addLogicNot (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1010         RTLIL::Cell* addLogicAnd (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1011         RTLIL::Cell* addLogicOr  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, bool is_signed = false, const std::string &src = "");
1012
1013         RTLIL::Cell* addMux  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s, RTLIL::SigSpec sig_y, const std::string &src = "");
1014         RTLIL::Cell* addPmux (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s, RTLIL::SigSpec sig_y, const std::string &src = "");
1015
1016         RTLIL::Cell* addSlice  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, RTLIL::Const offset, const std::string &src = "");
1017         RTLIL::Cell* addConcat (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, const std::string &src = "");
1018         RTLIL::Cell* addLut    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_y, RTLIL::Const lut, const std::string &src = "");
1019         RTLIL::Cell* addTribuf (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_y, const std::string &src = "");
1020         RTLIL::Cell* addAssert (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, const std::string &src = "");
1021         RTLIL::Cell* addAssume (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, const std::string &src = "");
1022         RTLIL::Cell* addLive   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, const std::string &src = "");
1023         RTLIL::Cell* addFair   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, const std::string &src = "");
1024         RTLIL::Cell* addCover  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_en, const std::string &src = "");
1025         RTLIL::Cell* addEquiv  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_y, const std::string &src = "");
1026
1027         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, const std::string &src = "");
1028         RTLIL::Cell* addFf    (RTLIL::IdString name, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, const std::string &src = "");
1029         RTLIL::Cell* addDff   (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_d,   RTLIL::SigSpec sig_q, bool clk_polarity = true, const std::string &src = "");
1030         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, const std::string &src = "");
1031         RTLIL::Cell* addDffsr (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1032                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, bool set_polarity = true, bool clr_polarity = true, const std::string &src = "");
1033         RTLIL::Cell* addAdff (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_arst, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q,
1034                         RTLIL::Const arst_value, bool clk_polarity = true, bool arst_polarity = true, const std::string &src = "");
1035         RTLIL::Cell* addDlatch (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true, const std::string &src = "");
1036         RTLIL::Cell* addDlatchsr (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1037                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true, bool set_polarity = true, bool clr_polarity = true, const std::string &src = "");
1038
1039         RTLIL::Cell* addBufGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_y, const std::string &src = "");
1040         RTLIL::Cell* addNotGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_y, const std::string &src = "");
1041         RTLIL::Cell* addAndGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1042         RTLIL::Cell* addNandGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1043         RTLIL::Cell* addOrGate     (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1044         RTLIL::Cell* addNorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1045         RTLIL::Cell* addXorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1046         RTLIL::Cell* addXnorGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1047         RTLIL::Cell* addAndnotGate (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1048         RTLIL::Cell* addOrnotGate  (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_y, const std::string &src = "");
1049         RTLIL::Cell* addMuxGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_s, RTLIL::SigBit sig_y, const std::string &src = "");
1050         RTLIL::Cell* addAoi3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_y, const std::string &src = "");
1051         RTLIL::Cell* addOai3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_y, const std::string &src = "");
1052         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, const std::string &src = "");
1053         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, const std::string &src = "");
1054
1055         RTLIL::Cell* addFfGate     (RTLIL::IdString name, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, const std::string &src = "");
1056         RTLIL::Cell* addDffGate    (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, const std::string &src = "");
1057         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, const std::string &src = "");
1058         RTLIL::Cell* addDffsrGate  (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1059                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool clk_polarity = true, bool set_polarity = true, bool clr_polarity = true, const std::string &src = "");
1060         RTLIL::Cell* addAdffGate   (RTLIL::IdString name, RTLIL::SigSpec sig_clk, RTLIL::SigSpec sig_arst, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q,
1061                         bool arst_value = false, bool clk_polarity = true, bool arst_polarity = true, const std::string &src = "");
1062         RTLIL::Cell* addDlatchGate (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true, const std::string &src = "");
1063         RTLIL::Cell* addDlatchsrGate  (RTLIL::IdString name, RTLIL::SigSpec sig_en, RTLIL::SigSpec sig_set, RTLIL::SigSpec sig_clr,
1064                         RTLIL::SigSpec sig_d, RTLIL::SigSpec sig_q, bool en_polarity = true, bool set_polarity = true, bool clr_polarity = true, const std::string &src = "");
1065
1066         // The methods without the add* prefix create a cell and an output signal. They return the newly created output signal.
1067
1068         RTLIL::SigSpec Not (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1069         RTLIL::SigSpec Pos (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1070         RTLIL::SigSpec Bu0 (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1071         RTLIL::SigSpec Neg (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1072
1073         RTLIL::SigSpec And  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1074         RTLIL::SigSpec Or   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1075         RTLIL::SigSpec Xor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1076         RTLIL::SigSpec Xnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1077
1078         RTLIL::SigSpec ReduceAnd  (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1079         RTLIL::SigSpec ReduceOr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1080         RTLIL::SigSpec ReduceXor  (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1081         RTLIL::SigSpec ReduceXnor (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1082         RTLIL::SigSpec ReduceBool (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1083
1084         RTLIL::SigSpec Shl    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1085         RTLIL::SigSpec Shr    (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1086         RTLIL::SigSpec Sshl   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1087         RTLIL::SigSpec Sshr   (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1088         RTLIL::SigSpec Shift  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1089         RTLIL::SigSpec Shiftx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1090
1091         RTLIL::SigSpec Lt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1092         RTLIL::SigSpec Le  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1093         RTLIL::SigSpec Eq  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1094         RTLIL::SigSpec Ne  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1095         RTLIL::SigSpec Eqx (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1096         RTLIL::SigSpec Nex (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1097         RTLIL::SigSpec Ge  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1098         RTLIL::SigSpec Gt  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1099
1100         RTLIL::SigSpec Add (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1101         RTLIL::SigSpec Sub (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1102         RTLIL::SigSpec Mul (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1103         RTLIL::SigSpec Div (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1104         RTLIL::SigSpec Mod (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1105         RTLIL::SigSpec Pow (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool a_signed = false, bool b_signed = false, const std::string &src = "");
1106
1107         RTLIL::SigSpec LogicNot (RTLIL::IdString name, RTLIL::SigSpec sig_a, bool is_signed = false, const std::string &src = "");
1108         RTLIL::SigSpec LogicAnd (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1109         RTLIL::SigSpec LogicOr  (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, bool is_signed = false, const std::string &src = "");
1110
1111         RTLIL::SigSpec Mux      (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s, const std::string &src = "");
1112         RTLIL::SigSpec Pmux     (RTLIL::IdString name, RTLIL::SigSpec sig_a, RTLIL::SigSpec sig_b, RTLIL::SigSpec sig_s, const std::string &src = "");
1113
1114         RTLIL::SigBit BufGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, const std::string &src = "");
1115         RTLIL::SigBit NotGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, const std::string &src = "");
1116         RTLIL::SigBit AndGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1117         RTLIL::SigBit NandGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1118         RTLIL::SigBit OrGate     (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1119         RTLIL::SigBit NorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1120         RTLIL::SigBit XorGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1121         RTLIL::SigBit XnorGate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1122         RTLIL::SigBit AndnotGate (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1123         RTLIL::SigBit OrnotGate  (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, const std::string &src = "");
1124         RTLIL::SigBit MuxGate    (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_s, const std::string &src = "");
1125         RTLIL::SigBit Aoi3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, const std::string &src = "");
1126         RTLIL::SigBit Oai3Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, const std::string &src = "");
1127         RTLIL::SigBit Aoi4Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_d, const std::string &src = "");
1128         RTLIL::SigBit Oai4Gate   (RTLIL::IdString name, RTLIL::SigBit sig_a, RTLIL::SigBit sig_b, RTLIL::SigBit sig_c, RTLIL::SigBit sig_d, const std::string &src = "");
1129
1130         RTLIL::SigSpec Anyconst  (RTLIL::IdString name, int width = 1, const std::string &src = "");
1131         RTLIL::SigSpec Anyseq    (RTLIL::IdString name, int width = 1, const std::string &src = "");
1132         RTLIL::SigSpec Allconst  (RTLIL::IdString name, int width = 1, const std::string &src = "");
1133         RTLIL::SigSpec Allseq    (RTLIL::IdString name, int width = 1, const std::string &src = "");
1134         RTLIL::SigSpec Initstate (RTLIL::IdString name, const std::string &src = "");
1135 };
1136
1137 struct RTLIL::Wire : public RTLIL::AttrObject
1138 {
1139         unsigned int hashidx_;
1140         unsigned int hash() const { return hashidx_; }
1141
1142 protected:
1143         // use module->addWire() and module->remove() to create or destroy wires
1144         friend struct RTLIL::Module;
1145         Wire();
1146         ~Wire() { };
1147
1148 public:
1149         // do not simply copy wires
1150         Wire(RTLIL::Wire &other) = delete;
1151         void operator=(RTLIL::Wire &other) = delete;
1152
1153         RTLIL::Module *module;
1154         RTLIL::IdString name;
1155         int width, start_offset, port_id;
1156         bool port_input, port_output, upto;
1157 };
1158
1159 struct RTLIL::Memory : public RTLIL::AttrObject
1160 {
1161         unsigned int hashidx_;
1162         unsigned int hash() const { return hashidx_; }
1163
1164         Memory();
1165
1166         RTLIL::IdString name;
1167         int width, start_offset, size;
1168 };
1169
1170 struct RTLIL::Cell : public RTLIL::AttrObject
1171 {
1172         unsigned int hashidx_;
1173         unsigned int hash() const { return hashidx_; }
1174
1175 protected:
1176         // use module->addCell() and module->remove() to create or destroy cells
1177         friend struct RTLIL::Module;
1178         Cell();
1179
1180 public:
1181         // do not simply copy cells
1182         Cell(RTLIL::Cell &other) = delete;
1183         void operator=(RTLIL::Cell &other) = delete;
1184
1185         RTLIL::Module *module;
1186         RTLIL::IdString name;
1187         RTLIL::IdString type;
1188         dict<RTLIL::IdString, RTLIL::SigSpec> connections_;
1189         dict<RTLIL::IdString, RTLIL::Const> parameters;
1190
1191         // access cell ports
1192         bool hasPort(RTLIL::IdString portname) const;
1193         void unsetPort(RTLIL::IdString portname);
1194         void setPort(RTLIL::IdString portname, RTLIL::SigSpec signal);
1195         const RTLIL::SigSpec &getPort(RTLIL::IdString portname) const;
1196         const dict<RTLIL::IdString, RTLIL::SigSpec> &connections() const;
1197
1198         // information about cell ports
1199         bool known() const;
1200         bool input(RTLIL::IdString portname) const;
1201         bool output(RTLIL::IdString portname) const;
1202
1203         // access cell parameters
1204         bool hasParam(RTLIL::IdString paramname) const;
1205         void unsetParam(RTLIL::IdString paramname);
1206         void setParam(RTLIL::IdString paramname, RTLIL::Const value);
1207         const RTLIL::Const &getParam(RTLIL::IdString paramname) const;
1208
1209         void sort();
1210         void check();
1211         void fixup_parameters(bool set_a_signed = false, bool set_b_signed = false);
1212
1213         bool has_keep_attr() const {
1214                 return get_bool_attribute("\\keep") || (module && module->design && module->design->module(type) &&
1215                                 module->design->module(type)->get_bool_attribute("\\keep"));
1216         }
1217
1218         template<typename T> void rewrite_sigspecs(T &functor);
1219 };
1220
1221 struct RTLIL::CaseRule
1222 {
1223         std::vector<RTLIL::SigSpec> compare;
1224         std::vector<RTLIL::SigSig> actions;
1225         std::vector<RTLIL::SwitchRule*> switches;
1226
1227         ~CaseRule();
1228         void optimize();
1229
1230         bool empty() const;
1231
1232         template<typename T> void rewrite_sigspecs(T &functor);
1233         RTLIL::CaseRule *clone() const;
1234 };
1235
1236 struct RTLIL::SwitchRule : public RTLIL::AttrObject
1237 {
1238         RTLIL::SigSpec signal;
1239         std::vector<RTLIL::CaseRule*> cases;
1240
1241         ~SwitchRule();
1242
1243         bool empty() const;
1244
1245         template<typename T> void rewrite_sigspecs(T &functor);
1246         RTLIL::SwitchRule *clone() const;
1247 };
1248
1249 struct RTLIL::SyncRule
1250 {
1251         RTLIL::SyncType type;
1252         RTLIL::SigSpec signal;
1253         std::vector<RTLIL::SigSig> actions;
1254
1255         template<typename T> void rewrite_sigspecs(T &functor);
1256         RTLIL::SyncRule *clone() const;
1257 };
1258
1259 struct RTLIL::Process : public RTLIL::AttrObject
1260 {
1261         RTLIL::IdString name;
1262         RTLIL::CaseRule root_case;
1263         std::vector<RTLIL::SyncRule*> syncs;
1264
1265         ~Process();
1266
1267         template<typename T> void rewrite_sigspecs(T &functor);
1268         RTLIL::Process *clone() const;
1269 };
1270
1271
1272 inline RTLIL::SigBit::SigBit() : wire(NULL), data(RTLIL::State::S0) { }
1273 inline RTLIL::SigBit::SigBit(RTLIL::State bit) : wire(NULL), data(bit) { }
1274 inline RTLIL::SigBit::SigBit(bool bit) : wire(NULL), data(bit ? RTLIL::S1 : RTLIL::S0) { }
1275 inline RTLIL::SigBit::SigBit(RTLIL::Wire *wire) : wire(wire), offset(0) { log_assert(wire && wire->width == 1); }
1276 inline RTLIL::SigBit::SigBit(RTLIL::Wire *wire, int offset) : wire(wire), offset(offset) { log_assert(wire != nullptr); }
1277 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]; }
1278 inline RTLIL::SigBit::SigBit(const RTLIL::SigChunk &chunk, int index) : wire(chunk.wire) { if (wire) offset = chunk.offset + index; else data = chunk.data[index]; }
1279
1280 inline bool RTLIL::SigBit::operator<(const RTLIL::SigBit &other) const {
1281         if (wire == other.wire)
1282                 return wire ? (offset < other.offset) : (data < other.data);
1283         if (wire != nullptr && other.wire != nullptr)
1284                 return wire->name < other.wire->name;
1285         return wire < other.wire;
1286 }
1287
1288 inline bool RTLIL::SigBit::operator==(const RTLIL::SigBit &other) const {
1289         return (wire == other.wire) && (wire ? (offset == other.offset) : (data == other.data));
1290 }
1291
1292 inline bool RTLIL::SigBit::operator!=(const RTLIL::SigBit &other) const {
1293         return (wire != other.wire) || (wire ? (offset != other.offset) : (data != other.data));
1294 }
1295
1296 inline unsigned int RTLIL::SigBit::hash() const {
1297         if (wire)
1298                 return mkhash_add(wire->name.hash(), offset);
1299         return data;
1300 }
1301
1302 inline RTLIL::SigBit &RTLIL::SigSpecIterator::operator*() const {
1303         return (*sig_p)[index];
1304 }
1305
1306 inline const RTLIL::SigBit &RTLIL::SigSpecConstIterator::operator*() const {
1307         return (*sig_p)[index];
1308 }
1309
1310 inline RTLIL::SigBit::SigBit(const RTLIL::SigSpec &sig) {
1311         log_assert(sig.size() == 1 && sig.chunks().size() == 1);
1312         *this = SigBit(sig.chunks().front());
1313 }
1314
1315 template<typename T>
1316 void RTLIL::Module::rewrite_sigspecs(T &functor)
1317 {
1318         for (auto &it : cells_)
1319                 it.second->rewrite_sigspecs(functor);
1320         for (auto &it : processes)
1321                 it.second->rewrite_sigspecs(functor);
1322         for (auto &it : connections_) {
1323                 functor(it.first);
1324                 functor(it.second);
1325         }
1326 }
1327
1328 template<typename T>
1329 void RTLIL::Cell::rewrite_sigspecs(T &functor) {
1330         for (auto &it : connections_)
1331                 functor(it.second);
1332 }
1333
1334 template<typename T>
1335 void RTLIL::CaseRule::rewrite_sigspecs(T &functor) {
1336         for (auto &it : compare)
1337                 functor(it);
1338         for (auto &it : actions) {
1339                 functor(it.first);
1340                 functor(it.second);
1341         }
1342         for (auto it : switches)
1343                 it->rewrite_sigspecs(functor);
1344 }
1345
1346 template<typename T>
1347 void RTLIL::SwitchRule::rewrite_sigspecs(T &functor)
1348 {
1349         functor(signal);
1350         for (auto it : cases)
1351                 it->rewrite_sigspecs(functor);
1352 }
1353
1354 template<typename T>
1355 void RTLIL::SyncRule::rewrite_sigspecs(T &functor)
1356 {
1357         functor(signal);
1358         for (auto &it : actions) {
1359                 functor(it.first);
1360                 functor(it.second);
1361         }
1362 }
1363
1364 template<typename T>
1365 void RTLIL::Process::rewrite_sigspecs(T &functor)
1366 {
1367         root_case.rewrite_sigspecs(functor);
1368         for (auto it : syncs)
1369                 it->rewrite_sigspecs(functor);
1370 }
1371
1372 YOSYS_NAMESPACE_END
1373
1374 #endif