2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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.
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.
20 #include "kernel/yosys.h"
29 enum State
: unsigned char {
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)
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
49 enum ConstFlags
: unsigned char {
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
67 struct SigSpecIterator
;
68 struct SigSpecConstIterator
;
75 typedef std::pair
<SigSpec
, SigSpec
> SigSig
;
79 // the global id string cache
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; }
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_
;
92 static inline int get_reference(int idx
)
94 global_refcount_storage_
.at(idx
)++;
98 static inline int get_reference(const char *p
)
100 log_assert(destruct_guard
.ok
);
103 log_assert(p
[1] != 0);
104 log_assert(p
[0] == '$' || p
[0] == '\\');
107 auto it
= global_id_index_
.find((char*)p
);
108 if (it
!= global_id_index_
.end()) {
109 global_refcount_storage_
.at(it
->second
)++;
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);
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
)++;
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_
);
133 log("#X# New IdString '%s' with index %d.\n", p
, idx
);
134 log_backtrace("-X- ", yosys_xtrace
-1);
140 static inline void put_reference(int idx
)
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
)
147 log_assert(global_refcount_storage_
.at(idx
) > 0);
149 if (--global_refcount_storage_
.at(idx
) != 0)
153 log("#X# Removed IdString '%s' with index %d.\n", global_id_storage_
.at(idx
), idx
);
154 log_backtrace("-X- ", yosys_xtrace
-1);
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
);
163 // the actual IdString object is just is a single int
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_
); }
173 void operator=(const IdString
&rhs
) {
174 put_reference(index_
);
175 index_
= get_reference(rhs
.index_
);
178 void operator=(const char *rhs
) {
183 void operator=(const std::string
&rhs
) {
188 const char *c_str() const {
189 return global_id_storage_
.at(index_
);
192 std::string
str() const {
193 return std::string(global_id_storage_
.at(index_
));
196 bool operator<(const IdString
&rhs
) const {
197 return index_
< rhs
.index_
;
200 bool operator==(const IdString
&rhs
) const { return index_
== rhs
.index_
; }
201 bool operator!=(const IdString
&rhs
) const { return index_
!= rhs
.index_
; }
203 // The methods below are just convenience functions for better compatibility with std::string.
205 bool operator==(const std::string
&rhs
) const { return str() == rhs
; }
206 bool operator!=(const std::string
&rhs
) const { return str() != rhs
; }
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; }
211 char operator[](size_t i
) const {
212 const char *p
= c_str();
213 for (; i
!= 0; i
--, p
++)
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
);
222 return std::string(c_str() + pos
, len
);
225 size_t size() const {
230 return c_str()[0] == 0;
237 unsigned int hash() const {
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.
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
);
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.
254 template<typename T
, typename
... Args
>
255 bool in(T first
, Args
... rest
) const {
256 return in(first
) || in(rest
...);
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; }
265 static inline std::string
escape_id(std::string str
) {
266 if (str
.size() > 0 && str
[0] != '\\' && str
[0] != '$')
271 static inline std::string
unescape_id(std::string str
) {
276 if (str
[1] == '$' || str
[1] == '\\')
278 if (str
[1] >= '0' && str
[1] <= '9')
280 return str
.substr(1);
283 static inline std::string
unescape_id(RTLIL::IdString str
) {
284 return unescape_id(str
.str());
287 static inline const char *id2cstr(const RTLIL::IdString
&str
) {
291 template <typename T
> struct sort_by_name_id
{
292 bool operator()(T
*a
, T
*b
) const {
293 return a
->name
< b
->name
;
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;
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;
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
);
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
);
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
);
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
);
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
);
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
);
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
);
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.
359 typename dict
<RTLIL::IdString
, T
>::iterator it
;
360 dict
<RTLIL::IdString
, T
> *list_p
;
363 ObjIterator() : list_p(nullptr), refcount_p(nullptr) {
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;
371 it
= list_p
->begin();
376 ObjIterator(const RTLIL::ObjIterator
<T
> &other
) {
378 list_p
= other
.list_p
;
379 refcount_p
= other
.refcount_p
;
384 ObjIterator
&operator=(const RTLIL::ObjIterator
<T
> &other
) {
388 list_p
= other
.list_p
;
389 refcount_p
= other
.refcount_p
;
400 inline T
operator*() const {
401 log_assert(list_p
!= nullptr);
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
;
411 inline void operator++() {
412 log_assert(list_p
!= nullptr);
413 if (++it
== list_p
->end()) {
416 refcount_p
= nullptr;
424 dict
<RTLIL::IdString
, T
> *list_p
;
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
>(); }
431 size_t size() const {
432 return list_p
->size();
435 operator pool
<T
>() const {
437 for (auto &it
: *list_p
)
438 result
.insert(it
.second
);
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
);
450 pool
<T
> to_pool() const { return *this; }
451 std::vector
<T
> to_vector() const { return *this; }
458 std::vector
<RTLIL::State
> bits
;
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
);
467 bool operator <(const RTLIL::Const
&other
) const;
468 bool operator ==(const RTLIL::Const
&other
) const;
469 bool operator !=(const RTLIL::Const
&other
) const;
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
);
476 std::string
decode_string() const;
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
); }
482 bool is_fully_zero() const;
483 bool is_fully_def() const;
484 bool is_fully_undef() const;
486 inline RTLIL::Const
extract(int offset
, int len
= 1, RTLIL::State padding
= RTLIL::State::S0
) const {
488 ret
.bits
.reserve(len
);
489 for (int i
= offset
; i
< offset
+ len
; i
++)
490 ret
.bits
.push_back(i
< GetSize(bits
) ? bits
[i
] : padding
);
494 inline unsigned int hash() const {
495 unsigned int h
= mkhash_init
;
502 struct RTLIL::AttrObject
504 dict
<RTLIL::IdString
, RTLIL::Const
> attributes
;
506 void set_bool_attribute(RTLIL::IdString id
);
507 bool get_bool_attribute(RTLIL::IdString id
) const;
509 void set_strpool_attribute(RTLIL::IdString id
, const pool
<string
> &data
);
510 void add_strpool_attribute(RTLIL::IdString id
, const pool
<string
> &data
);
511 pool
<string
> get_strpool_attribute(RTLIL::IdString id
) const;
513 void set_src_attribute(const std::string
&src
);
514 std::string
get_src_attribute() const;
517 struct RTLIL::SigChunk
520 std::vector
<RTLIL::State
> data
; // only used if wire == NULL, LSB at index 0
524 SigChunk(const RTLIL::Const
&value
);
525 SigChunk(RTLIL::Wire
*wire
);
526 SigChunk(RTLIL::Wire
*wire
, int offset
, int width
= 1);
527 SigChunk(const std::string
&str
);
528 SigChunk(int val
, int width
= 32);
529 SigChunk(RTLIL::State bit
, int width
= 1);
530 SigChunk(RTLIL::SigBit bit
);
532 RTLIL::SigChunk
extract(int offset
, int length
) const;
534 bool operator <(const RTLIL::SigChunk
&other
) const;
535 bool operator ==(const RTLIL::SigChunk
&other
) const;
536 bool operator !=(const RTLIL::SigChunk
&other
) const;
543 RTLIL::State data
; // used if wire == NULL
544 int offset
; // used if wire != NULL
548 SigBit(RTLIL::State bit
);
550 SigBit(RTLIL::Wire
*wire
);
551 SigBit(RTLIL::Wire
*wire
, int offset
);
552 SigBit(const RTLIL::SigChunk
&chunk
);
553 SigBit(const RTLIL::SigChunk
&chunk
, int index
);
554 SigBit(const RTLIL::SigSpec
&sig
);
556 bool operator <(const RTLIL::SigBit
&other
) const;
557 bool operator ==(const RTLIL::SigBit
&other
) const;
558 bool operator !=(const RTLIL::SigBit
&other
) const;
559 unsigned int hash() const;
562 struct RTLIL::SigSpecIterator
: public std::iterator
<std::input_iterator_tag
, RTLIL::SigSpec
>
564 RTLIL::SigSpec
*sig_p
;
567 inline RTLIL::SigBit
&operator*() const;
568 inline bool operator!=(const RTLIL::SigSpecIterator
&other
) const { return index
!= other
.index
; }
569 inline bool operator==(const RTLIL::SigSpecIterator
&other
) const { return index
== other
.index
; }
570 inline void operator++() { index
++; }
573 struct RTLIL::SigSpecConstIterator
: public std::iterator
<std::input_iterator_tag
, RTLIL::SigSpec
>
575 const RTLIL::SigSpec
*sig_p
;
578 inline const RTLIL::SigBit
&operator*() const;
579 inline bool operator!=(const RTLIL::SigSpecConstIterator
&other
) const { return index
!= other
.index
; }
580 inline bool operator==(const RTLIL::SigSpecIterator
&other
) const { return index
== other
.index
; }
581 inline void operator++() { index
++; }
584 struct RTLIL::SigSpec
589 std::vector
<RTLIL::SigChunk
> chunks_
; // LSB at index 0
590 std::vector
<RTLIL::SigBit
> bits_
; // LSB at index 0
594 void updhash() const;
596 inline bool packed() const {
597 return bits_
.empty();
600 inline void inline_unpack() const {
601 if (!chunks_
.empty())
607 SigSpec(const RTLIL::SigSpec
&other
);
608 SigSpec(std::initializer_list
<RTLIL::SigSpec
> parts
);
609 const RTLIL::SigSpec
&operator=(const RTLIL::SigSpec
&other
);
611 SigSpec(const RTLIL::Const
&value
);
612 SigSpec(const RTLIL::SigChunk
&chunk
);
613 SigSpec(RTLIL::Wire
*wire
);
614 SigSpec(RTLIL::Wire
*wire
, int offset
, int width
= 1);
615 SigSpec(const std::string
&str
);
616 SigSpec(int val
, int width
= 32);
617 SigSpec(RTLIL::State bit
, int width
= 1);
618 SigSpec(RTLIL::SigBit bit
, int width
= 1);
619 SigSpec(std::vector
<RTLIL::SigChunk
> chunks
);
620 SigSpec(std::vector
<RTLIL::SigBit
> bits
);
621 SigSpec(pool
<RTLIL::SigBit
> bits
);
622 SigSpec(std::set
<RTLIL::SigBit
> bits
);
625 SigSpec(RTLIL::SigSpec
&&other
) {
626 width_
= other
.width_
;
628 chunks_
= std::move(other
.chunks_
);
629 bits_
= std::move(other
.bits_
);
632 const RTLIL::SigSpec
&operator=(RTLIL::SigSpec
&&other
) {
633 width_
= other
.width_
;
635 chunks_
= std::move(other
.chunks_
);
636 bits_
= std::move(other
.bits_
);
640 size_t get_hash() const {
645 inline const std::vector
<RTLIL::SigChunk
> &chunks() const { pack(); return chunks_
; }
646 inline const std::vector
<RTLIL::SigBit
> &bits() const { inline_unpack(); return bits_
; }
648 inline int size() const { return width_
; }
649 inline bool empty() const { return width_
== 0; }
651 inline RTLIL::SigBit
&operator[](int index
) { inline_unpack(); return bits_
.at(index
); }
652 inline const RTLIL::SigBit
&operator[](int index
) const { inline_unpack(); return bits_
.at(index
); }
654 inline RTLIL::SigSpecIterator
begin() { RTLIL::SigSpecIterator it
; it
.sig_p
= this; it
.index
= 0; return it
; }
655 inline RTLIL::SigSpecIterator
end() { RTLIL::SigSpecIterator it
; it
.sig_p
= this; it
.index
= width_
; return it
; }
657 inline RTLIL::SigSpecConstIterator
begin() const { RTLIL::SigSpecConstIterator it
; it
.sig_p
= this; it
.index
= 0; return it
; }
658 inline RTLIL::SigSpecConstIterator
end() const { RTLIL::SigSpecConstIterator it
; it
.sig_p
= this; it
.index
= width_
; return it
; }
661 void sort_and_unify();
663 void replace(const RTLIL::SigSpec
&pattern
, const RTLIL::SigSpec
&with
);
664 void replace(const RTLIL::SigSpec
&pattern
, const RTLIL::SigSpec
&with
, RTLIL::SigSpec
*other
) const;
666 void replace(const dict
<RTLIL::SigBit
, RTLIL::SigBit
> &rules
);
667 void replace(const dict
<RTLIL::SigBit
, RTLIL::SigBit
> &rules
, RTLIL::SigSpec
*other
) const;
669 void replace(const std::map
<RTLIL::SigBit
, RTLIL::SigBit
> &rules
);
670 void replace(const std::map
<RTLIL::SigBit
, RTLIL::SigBit
> &rules
, RTLIL::SigSpec
*other
) const;
672 void replace(int offset
, const RTLIL::SigSpec
&with
);
674 void remove(const RTLIL::SigSpec
&pattern
);
675 void remove(const RTLIL::SigSpec
&pattern
, RTLIL::SigSpec
*other
) const;
676 void remove2(const RTLIL::SigSpec
&pattern
, RTLIL::SigSpec
*other
);
678 void remove(const pool
<RTLIL::SigBit
> &pattern
);
679 void remove(const pool
<RTLIL::SigBit
> &pattern
, RTLIL::SigSpec
*other
) const;
680 void remove2(const pool
<RTLIL::SigBit
> &pattern
, RTLIL::SigSpec
*other
);
681 void remove2(const std::set
<RTLIL::SigBit
> &pattern
, RTLIL::SigSpec
*other
);
683 void remove(int offset
, int length
= 1);
686 RTLIL::SigSpec
extract(const RTLIL::SigSpec
&pattern
, const RTLIL::SigSpec
*other
= NULL
) const;
687 RTLIL::SigSpec
extract(const pool
<RTLIL::SigBit
> &pattern
, const RTLIL::SigSpec
*other
= NULL
) const;
688 RTLIL::SigSpec
extract(int offset
, int length
= 1) const;
690 void append(const RTLIL::SigSpec
&signal
);
691 void append_bit(const RTLIL::SigBit
&bit
);
693 void extend_u0(int width
, bool is_signed
= false);
695 RTLIL::SigSpec
repeat(int num
) const;
697 bool operator <(const RTLIL::SigSpec
&other
) const;
698 bool operator ==(const RTLIL::SigSpec
&other
) const;
699 inline bool operator !=(const RTLIL::SigSpec
&other
) const { return !(*this == other
); }
701 bool is_wire() const;
702 bool is_chunk() const;
703 inline bool is_bit() const { return width_
== 1; }
705 bool is_fully_const() const;
706 bool is_fully_zero() const;
707 bool is_fully_def() const;
708 bool is_fully_undef() const;
709 bool has_const() const;
710 bool has_marked_bits() const;
712 bool as_bool() const;
713 int as_int(bool is_signed
= false) const;
714 std::string
as_string() const;
715 RTLIL::Const
as_const() const;
716 RTLIL::Wire
*as_wire() const;
717 RTLIL::SigChunk
as_chunk() const;
718 RTLIL::SigBit
as_bit() const;
720 bool match(std::string pattern
) const;
722 std::set
<RTLIL::SigBit
> to_sigbit_set() const;
723 pool
<RTLIL::SigBit
> to_sigbit_pool() const;
724 std::vector
<RTLIL::SigBit
> to_sigbit_vector() const;
725 std::map
<RTLIL::SigBit
, RTLIL::SigBit
> to_sigbit_map(const RTLIL::SigSpec
&other
) const;
726 dict
<RTLIL::SigBit
, RTLIL::SigBit
> to_sigbit_dict(const RTLIL::SigSpec
&other
) const;
728 static bool parse(RTLIL::SigSpec
&sig
, RTLIL::Module
*module
, std::string str
);
729 static bool parse_sel(RTLIL::SigSpec
&sig
, RTLIL::Design
*design
, RTLIL::Module
*module
, std::string str
);
730 static bool parse_rhs(const RTLIL::SigSpec
&lhs
, RTLIL::SigSpec
&sig
, RTLIL::Module
*module
, std::string str
);
732 operator std::vector
<RTLIL::SigChunk
>() const { return chunks(); }
733 operator std::vector
<RTLIL::SigBit
>() const { return bits(); }
735 unsigned int hash() const { if (!hash_
) updhash(); return hash_
; };
740 void check() const { }
744 struct RTLIL::Selection
747 pool
<RTLIL::IdString
> selected_modules
;
748 dict
<RTLIL::IdString
, pool
<RTLIL::IdString
>> selected_members
;
750 Selection(bool full
= true) : full_selection(full
) { }
752 bool selected_module(RTLIL::IdString mod_name
) const;
753 bool selected_whole_module(RTLIL::IdString mod_name
) const;
754 bool selected_member(RTLIL::IdString mod_name
, RTLIL::IdString memb_name
) const;
755 void optimize(RTLIL::Design
*design
);
757 template<typename T1
> void select(T1
*module
) {
758 if (!full_selection
&& selected_modules
.count(module
->name
) == 0) {
759 selected_modules
.insert(module
->name
);
760 selected_members
.erase(module
->name
);
764 template<typename T1
, typename T2
> void select(T1
*module
, T2
*member
) {
765 if (!full_selection
&& selected_modules
.count(module
->name
) == 0)
766 selected_members
[module
->name
].insert(member
->name
);
770 return !full_selection
&& selected_modules
.empty() && selected_members
.empty();
774 struct RTLIL::Monitor
776 unsigned int hashidx_
;
777 unsigned int hash() const { return hashidx_
; }
780 static unsigned int hashidx_count
= 123456789;
781 hashidx_count
= mkhash_xorshift(hashidx_count
);
782 hashidx_
= hashidx_count
;
785 virtual ~Monitor() { }
786 virtual void notify_module_add(RTLIL::Module
*) { }
787 virtual void notify_module_del(RTLIL::Module
*) { }
788 virtual void notify_connect(RTLIL::Cell
*, const RTLIL::IdString
&, const RTLIL::SigSpec
&, RTLIL::SigSpec
&) { }
789 virtual void notify_connect(RTLIL::Module
*, const RTLIL::SigSig
&) { }
790 virtual void notify_connect(RTLIL::Module
*, const std::vector
<RTLIL::SigSig
>&) { }
791 virtual void notify_blackout(RTLIL::Module
*) { }
796 unsigned int hashidx_
;
797 unsigned int hash() const { return hashidx_
; }
799 pool
<RTLIL::Monitor
*> monitors
;
800 dict
<std::string
, std::string
> scratchpad
;
802 int refcount_modules_
;
803 dict
<RTLIL::IdString
, RTLIL::Module
*> modules_
;
804 std::vector
<AST::AstNode
*> verilog_packages
, verilog_globals
;
805 dict
<std::string
, std::pair
<std::string
, bool>> verilog_defines
;
807 std::vector
<RTLIL::Selection
> selection_stack
;
808 dict
<RTLIL::IdString
, RTLIL::Selection
> selection_vars
;
809 std::string selected_active_module
;
814 RTLIL::ObjRange
<RTLIL::Module
*> modules();
815 RTLIL::Module
*module(RTLIL::IdString name
);
816 RTLIL::Module
*top_module();
818 bool has(RTLIL::IdString id
) const {
819 return modules_
.count(id
) != 0;
822 void add(RTLIL::Module
*module
);
823 RTLIL::Module
*addModule(RTLIL::IdString name
);
824 void remove(RTLIL::Module
*module
);
825 void rename(RTLIL::Module
*module
, RTLIL::IdString new_name
);
827 void scratchpad_unset(std::string varname
);
829 void scratchpad_set_int(std::string varname
, int value
);
830 void scratchpad_set_bool(std::string varname
, bool value
);
831 void scratchpad_set_string(std::string varname
, std::string value
);
833 int scratchpad_get_int(std::string varname
, int default_value
= 0) const;
834 bool scratchpad_get_bool(std::string varname
, bool default_value
= false) const;
835 std::string
scratchpad_get_string(std::string varname
, std::string default_value
= std::string()) const;
841 bool selected_module(RTLIL::IdString mod_name
) const;
842 bool selected_whole_module(RTLIL::IdString mod_name
) const;
843 bool selected_member(RTLIL::IdString mod_name
, RTLIL::IdString memb_name
) const;
845 bool selected_module(RTLIL::Module
*mod
) const;
846 bool selected_whole_module(RTLIL::Module
*mod
) const;
848 RTLIL::Selection
&selection() {
849 return selection_stack
.back();
852 const RTLIL::Selection
&selection() const {
853 return selection_stack
.back();
856 bool full_selection() const {
857 return selection_stack
.back().full_selection
;
860 template<typename T1
> bool selected(T1
*module
) const {
861 return selected_module(module
->name
);
864 template<typename T1
, typename T2
> bool selected(T1
*module
, T2
*member
) const {
865 return selected_member(module
->name
, member
->name
);
868 template<typename T1
, typename T2
> void select(T1
*module
, T2
*member
) {
869 if (selection_stack
.size() > 0) {
870 RTLIL::Selection
&sel
= selection_stack
.back();
871 sel
.select(module
, member
);
875 std::vector
<RTLIL::Module
*> selected_modules() const;
876 std::vector
<RTLIL::Module
*> selected_whole_modules() const;
877 std::vector
<RTLIL::Module
*> selected_whole_modules_warn() const;
880 struct RTLIL::Module
: public RTLIL::AttrObject
882 unsigned int hashidx_
;
883 unsigned int hash() const { return hashidx_
; }
886 void add(RTLIL::Wire
*wire
);
887 void add(RTLIL::Cell
*cell
);
890 RTLIL::Design
*design
;
891 pool
<RTLIL::Monitor
*> monitors
;
896 dict
<RTLIL::IdString
, RTLIL::Wire
*> wires_
;
897 dict
<RTLIL::IdString
, RTLIL::Cell
*> cells_
;
898 std::vector
<RTLIL::SigSig
> connections_
;
900 RTLIL::IdString name
;
901 pool
<RTLIL::IdString
> avail_parameters
;
902 dict
<RTLIL::IdString
, RTLIL::Memory
*> memories
;
903 dict
<RTLIL::IdString
, RTLIL::Process
*> processes
;
907 virtual RTLIL::IdString
derive(RTLIL::Design
*design
, dict
<RTLIL::IdString
, RTLIL::Const
> parameters
);
908 virtual size_t count_id(RTLIL::IdString id
);
911 virtual void check();
912 virtual void optimize();
914 void connect(const RTLIL::SigSig
&conn
);
915 void connect(const RTLIL::SigSpec
&lhs
, const RTLIL::SigSpec
&rhs
);
916 void new_connections(const std::vector
<RTLIL::SigSig
> &new_conn
);
917 const std::vector
<RTLIL::SigSig
> &connections() const;
919 std::vector
<RTLIL::IdString
> ports
;
922 template<typename T
> void rewrite_sigspecs(T
&functor
);
923 void cloneInto(RTLIL::Module
*new_mod
) const;
924 virtual RTLIL::Module
*clone() const;
926 bool has_memories() const;
927 bool has_processes() const;
929 bool has_memories_warn() const;
930 bool has_processes_warn() const;
932 std::vector
<RTLIL::Wire
*> selected_wires() const;
933 std::vector
<RTLIL::Cell
*> selected_cells() const;
935 template<typename T
> bool selected(T
*member
) const {
936 return design
->selected_member(name
, member
->name
);
939 RTLIL::Wire
* wire(RTLIL::IdString id
) { return wires_
.count(id
) ? wires_
.at(id
) : nullptr; }
940 RTLIL::Cell
* cell(RTLIL::IdString id
) { return cells_
.count(id
) ? cells_
.at(id
) : nullptr; }
942 RTLIL::ObjRange
<RTLIL::Wire
*> wires() { return RTLIL::ObjRange
<RTLIL::Wire
*>(&wires_
, &refcount_wires_
); }
943 RTLIL::ObjRange
<RTLIL::Cell
*> cells() { return RTLIL::ObjRange
<RTLIL::Cell
*>(&cells_
, &refcount_cells_
); }
945 // Removing wires is expensive. If you have to remove wires, remove them all at once.
946 void remove(const pool
<RTLIL::Wire
*> &wires
);
947 void remove(RTLIL::Cell
*cell
);
949 void rename(RTLIL::Wire
*wire
, RTLIL::IdString new_name
);
950 void rename(RTLIL::Cell
*cell
, RTLIL::IdString new_name
);
951 void rename(RTLIL::IdString old_name
, RTLIL::IdString new_name
);
953 void swap_names(RTLIL::Wire
*w1
, RTLIL::Wire
*w2
);
954 void swap_names(RTLIL::Cell
*c1
, RTLIL::Cell
*c2
);
956 RTLIL::IdString
uniquify(RTLIL::IdString name
);
957 RTLIL::IdString
uniquify(RTLIL::IdString name
, int &index
);
959 RTLIL::Wire
*addWire(RTLIL::IdString name
, int width
= 1);
960 RTLIL::Wire
*addWire(RTLIL::IdString name
, const RTLIL::Wire
*other
);
962 RTLIL::Cell
*addCell(RTLIL::IdString name
, RTLIL::IdString type
);
963 RTLIL::Cell
*addCell(RTLIL::IdString name
, const RTLIL::Cell
*other
);
965 // The add* methods create a cell and return the created cell. All signals must exist in advance.
967 RTLIL::Cell
* addNot (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
968 RTLIL::Cell
* addPos (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
969 RTLIL::Cell
* addNeg (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
971 RTLIL::Cell
* addAnd (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
972 RTLIL::Cell
* addOr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
973 RTLIL::Cell
* addXor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
974 RTLIL::Cell
* addXnor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
976 RTLIL::Cell
* addReduceAnd (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
977 RTLIL::Cell
* addReduceOr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
978 RTLIL::Cell
* addReduceXor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
979 RTLIL::Cell
* addReduceXnor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
980 RTLIL::Cell
* addReduceBool (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
982 RTLIL::Cell
* addShl (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
983 RTLIL::Cell
* addShr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
984 RTLIL::Cell
* addSshl (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
985 RTLIL::Cell
* addSshr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
986 RTLIL::Cell
* addShift (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
987 RTLIL::Cell
* addShiftx (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
989 RTLIL::Cell
* addLt (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
990 RTLIL::Cell
* addLe (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
991 RTLIL::Cell
* addEq (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
992 RTLIL::Cell
* addNe (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
993 RTLIL::Cell
* addEqx (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
994 RTLIL::Cell
* addNex (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
995 RTLIL::Cell
* addGe (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
996 RTLIL::Cell
* addGt (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
998 RTLIL::Cell
* addAdd (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
999 RTLIL::Cell
* addSub (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1000 RTLIL::Cell
* addMul (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1001 RTLIL::Cell
* addDiv (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1002 RTLIL::Cell
* addMod (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1003 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);
1005 RTLIL::Cell
* addLogicNot (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1006 RTLIL::Cell
* addLogicAnd (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1007 RTLIL::Cell
* addLogicOr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
, bool is_signed
= false);
1009 RTLIL::Cell
* addMux (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_s
, RTLIL::SigSpec sig_y
);
1010 RTLIL::Cell
* addPmux (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_s
, RTLIL::SigSpec sig_y
);
1012 RTLIL::Cell
* addSlice (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, RTLIL::Const offset
);
1013 RTLIL::Cell
* addConcat (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
);
1014 RTLIL::Cell
* addLut (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_y
, RTLIL::Const lut
);
1015 RTLIL::Cell
* addTribuf (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_en
, RTLIL::SigSpec sig_y
);
1016 RTLIL::Cell
* addAssert (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_en
);
1017 RTLIL::Cell
* addAssume (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_en
);
1018 RTLIL::Cell
* addLive (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_en
);
1019 RTLIL::Cell
* addFair (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_en
);
1020 RTLIL::Cell
* addCover (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_en
);
1021 RTLIL::Cell
* addEquiv (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_y
);
1023 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);
1024 RTLIL::Cell
* addFf (RTLIL::IdString name
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
);
1025 RTLIL::Cell
* addDff (RTLIL::IdString name
, RTLIL::SigSpec sig_clk
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool clk_polarity
= true);
1026 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);
1027 RTLIL::Cell
* addDffsr (RTLIL::IdString name
, RTLIL::SigSpec sig_clk
, RTLIL::SigSpec sig_set
, RTLIL::SigSpec sig_clr
,
1028 RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool clk_polarity
= true, bool set_polarity
= true, bool clr_polarity
= true);
1029 RTLIL::Cell
* addAdff (RTLIL::IdString name
, RTLIL::SigSpec sig_clk
, RTLIL::SigSpec sig_arst
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
,
1030 RTLIL::Const arst_value
, bool clk_polarity
= true, bool arst_polarity
= true);
1031 RTLIL::Cell
* addDlatch (RTLIL::IdString name
, RTLIL::SigSpec sig_en
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool en_polarity
= true);
1032 RTLIL::Cell
* addDlatchsr (RTLIL::IdString name
, RTLIL::SigSpec sig_en
, RTLIL::SigSpec sig_set
, RTLIL::SigSpec sig_clr
,
1033 RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool en_polarity
= true, bool set_polarity
= true, bool clr_polarity
= true);
1035 RTLIL::Cell
* addBufGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_y
);
1036 RTLIL::Cell
* addNotGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_y
);
1037 RTLIL::Cell
* addAndGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1038 RTLIL::Cell
* addNandGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1039 RTLIL::Cell
* addOrGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1040 RTLIL::Cell
* addNorGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1041 RTLIL::Cell
* addXorGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1042 RTLIL::Cell
* addXnorGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1043 RTLIL::Cell
* addAndnotGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1044 RTLIL::Cell
* addOrnotGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_y
);
1045 RTLIL::Cell
* addMuxGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_s
, RTLIL::SigBit sig_y
);
1046 RTLIL::Cell
* addAoi3Gate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_c
, RTLIL::SigBit sig_y
);
1047 RTLIL::Cell
* addOai3Gate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_c
, RTLIL::SigBit sig_y
);
1048 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
);
1049 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
);
1051 RTLIL::Cell
* addFfGate (RTLIL::IdString name
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
);
1052 RTLIL::Cell
* addDffGate (RTLIL::IdString name
, RTLIL::SigSpec sig_clk
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool clk_polarity
= true);
1053 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);
1054 RTLIL::Cell
* addDffsrGate (RTLIL::IdString name
, RTLIL::SigSpec sig_clk
, RTLIL::SigSpec sig_set
, RTLIL::SigSpec sig_clr
,
1055 RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool clk_polarity
= true, bool set_polarity
= true, bool clr_polarity
= true);
1056 RTLIL::Cell
* addAdffGate (RTLIL::IdString name
, RTLIL::SigSpec sig_clk
, RTLIL::SigSpec sig_arst
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
,
1057 bool arst_value
= false, bool clk_polarity
= true, bool arst_polarity
= true);
1058 RTLIL::Cell
* addDlatchGate (RTLIL::IdString name
, RTLIL::SigSpec sig_en
, RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool en_polarity
= true);
1059 RTLIL::Cell
* addDlatchsrGate (RTLIL::IdString name
, RTLIL::SigSpec sig_en
, RTLIL::SigSpec sig_set
, RTLIL::SigSpec sig_clr
,
1060 RTLIL::SigSpec sig_d
, RTLIL::SigSpec sig_q
, bool en_polarity
= true, bool set_polarity
= true, bool clr_polarity
= true);
1062 // The methods without the add* prefix create a cell and an output signal. They return the newly created output signal.
1064 RTLIL::SigSpec
Not (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1065 RTLIL::SigSpec
Pos (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1066 RTLIL::SigSpec
Bu0 (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1067 RTLIL::SigSpec
Neg (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1069 RTLIL::SigSpec
And (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1070 RTLIL::SigSpec
Or (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1071 RTLIL::SigSpec
Xor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1072 RTLIL::SigSpec
Xnor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1074 RTLIL::SigSpec
ReduceAnd (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1075 RTLIL::SigSpec
ReduceOr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1076 RTLIL::SigSpec
ReduceXor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1077 RTLIL::SigSpec
ReduceXnor (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1078 RTLIL::SigSpec
ReduceBool (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1080 RTLIL::SigSpec
Shl (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1081 RTLIL::SigSpec
Shr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1082 RTLIL::SigSpec
Sshl (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1083 RTLIL::SigSpec
Sshr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1084 RTLIL::SigSpec
Shift (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1085 RTLIL::SigSpec
Shiftx (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1087 RTLIL::SigSpec
Lt (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1088 RTLIL::SigSpec
Le (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1089 RTLIL::SigSpec
Eq (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1090 RTLIL::SigSpec
Ne (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1091 RTLIL::SigSpec
Eqx (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1092 RTLIL::SigSpec
Nex (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1093 RTLIL::SigSpec
Ge (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1094 RTLIL::SigSpec
Gt (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1096 RTLIL::SigSpec
Add (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1097 RTLIL::SigSpec
Sub (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1098 RTLIL::SigSpec
Mul (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1099 RTLIL::SigSpec
Div (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1100 RTLIL::SigSpec
Mod (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1101 RTLIL::SigSpec
Pow (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool a_signed
= false, bool b_signed
= false);
1103 RTLIL::SigSpec
LogicNot (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, bool is_signed
= false);
1104 RTLIL::SigSpec
LogicAnd (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1105 RTLIL::SigSpec
LogicOr (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, bool is_signed
= false);
1107 RTLIL::SigSpec
Mux (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_s
);
1108 RTLIL::SigSpec
Pmux (RTLIL::IdString name
, RTLIL::SigSpec sig_a
, RTLIL::SigSpec sig_b
, RTLIL::SigSpec sig_s
);
1110 RTLIL::SigBit
BufGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
);
1111 RTLIL::SigBit
NotGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
);
1112 RTLIL::SigBit
AndGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1113 RTLIL::SigBit
NandGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1114 RTLIL::SigBit
OrGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1115 RTLIL::SigBit
NorGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1116 RTLIL::SigBit
XorGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1117 RTLIL::SigBit
XnorGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1118 RTLIL::SigBit
AndnotGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1119 RTLIL::SigBit
OrnotGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
);
1120 RTLIL::SigBit
MuxGate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_s
);
1121 RTLIL::SigBit
Aoi3Gate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_c
);
1122 RTLIL::SigBit
Oai3Gate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_c
);
1123 RTLIL::SigBit
Aoi4Gate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_c
, RTLIL::SigBit sig_d
);
1124 RTLIL::SigBit
Oai4Gate (RTLIL::IdString name
, RTLIL::SigBit sig_a
, RTLIL::SigBit sig_b
, RTLIL::SigBit sig_c
, RTLIL::SigBit sig_d
);
1126 RTLIL::SigSpec
Anyconst (RTLIL::IdString name
, int width
= 1);
1127 RTLIL::SigSpec
Anyseq (RTLIL::IdString name
, int width
= 1);
1128 RTLIL::SigSpec
Initstate (RTLIL::IdString name
);
1131 struct RTLIL::Wire
: public RTLIL::AttrObject
1133 unsigned int hashidx_
;
1134 unsigned int hash() const { return hashidx_
; }
1137 // use module->addWire() and module->remove() to create or destroy wires
1138 friend struct RTLIL::Module
;
1143 // do not simply copy wires
1144 Wire(RTLIL::Wire
&other
) = delete;
1145 void operator=(RTLIL::Wire
&other
) = delete;
1147 RTLIL::Module
*module
;
1148 RTLIL::IdString name
;
1149 int width
, start_offset
, port_id
;
1150 bool port_input
, port_output
, upto
;
1153 struct RTLIL::Memory
: public RTLIL::AttrObject
1155 unsigned int hashidx_
;
1156 unsigned int hash() const { return hashidx_
; }
1160 RTLIL::IdString name
;
1161 int width
, start_offset
, size
;
1164 struct RTLIL::Cell
: public RTLIL::AttrObject
1166 unsigned int hashidx_
;
1167 unsigned int hash() const { return hashidx_
; }
1170 // use module->addCell() and module->remove() to create or destroy cells
1171 friend struct RTLIL::Module
;
1175 // do not simply copy cells
1176 Cell(RTLIL::Cell
&other
) = delete;
1177 void operator=(RTLIL::Cell
&other
) = delete;
1179 RTLIL::Module
*module
;
1180 RTLIL::IdString name
;
1181 RTLIL::IdString type
;
1182 dict
<RTLIL::IdString
, RTLIL::SigSpec
> connections_
;
1183 dict
<RTLIL::IdString
, RTLIL::Const
> parameters
;
1185 // access cell ports
1186 bool hasPort(RTLIL::IdString portname
) const;
1187 void unsetPort(RTLIL::IdString portname
);
1188 void setPort(RTLIL::IdString portname
, RTLIL::SigSpec signal
);
1189 const RTLIL::SigSpec
&getPort(RTLIL::IdString portname
) const;
1190 const dict
<RTLIL::IdString
, RTLIL::SigSpec
> &connections() const;
1192 // information about cell ports
1194 bool input(RTLIL::IdString portname
) const;
1195 bool output(RTLIL::IdString portname
) const;
1197 // access cell parameters
1198 bool hasParam(RTLIL::IdString paramname
) const;
1199 void unsetParam(RTLIL::IdString paramname
);
1200 void setParam(RTLIL::IdString paramname
, RTLIL::Const value
);
1201 const RTLIL::Const
&getParam(RTLIL::IdString paramname
) const;
1205 void fixup_parameters(bool set_a_signed
= false, bool set_b_signed
= false);
1207 bool has_keep_attr() const {
1208 return get_bool_attribute("\\keep") || (module
&& module
->design
&& module
->design
->module(type
) &&
1209 module
->design
->module(type
)->get_bool_attribute("\\keep"));
1212 template<typename T
> void rewrite_sigspecs(T
&functor
);
1215 struct RTLIL::CaseRule
1217 std::vector
<RTLIL::SigSpec
> compare
;
1218 std::vector
<RTLIL::SigSig
> actions
;
1219 std::vector
<RTLIL::SwitchRule
*> switches
;
1224 template<typename T
> void rewrite_sigspecs(T
&functor
);
1225 RTLIL::CaseRule
*clone() const;
1228 struct RTLIL::SwitchRule
: public RTLIL::AttrObject
1230 RTLIL::SigSpec signal
;
1231 std::vector
<RTLIL::CaseRule
*> cases
;
1235 template<typename T
> void rewrite_sigspecs(T
&functor
);
1236 RTLIL::SwitchRule
*clone() const;
1239 struct RTLIL::SyncRule
1241 RTLIL::SyncType type
;
1242 RTLIL::SigSpec signal
;
1243 std::vector
<RTLIL::SigSig
> actions
;
1245 template<typename T
> void rewrite_sigspecs(T
&functor
);
1246 RTLIL::SyncRule
*clone() const;
1249 struct RTLIL::Process
: public RTLIL::AttrObject
1251 RTLIL::IdString name
;
1252 RTLIL::CaseRule root_case
;
1253 std::vector
<RTLIL::SyncRule
*> syncs
;
1257 template<typename T
> void rewrite_sigspecs(T
&functor
);
1258 RTLIL::Process
*clone() const;
1262 inline RTLIL::SigBit::SigBit() : wire(NULL
), data(RTLIL::State::S0
) { }
1263 inline RTLIL::SigBit::SigBit(RTLIL::State bit
) : wire(NULL
), data(bit
) { }
1264 inline RTLIL::SigBit::SigBit(bool bit
) : wire(NULL
), data(bit
? RTLIL::S1
: RTLIL::S0
) { }
1265 inline RTLIL::SigBit::SigBit(RTLIL::Wire
*wire
) : wire(wire
), offset(0) { log_assert(wire
&& wire
->width
== 1); }
1266 inline RTLIL::SigBit::SigBit(RTLIL::Wire
*wire
, int offset
) : wire(wire
), offset(offset
) { log_assert(wire
!= nullptr); }
1267 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]; }
1268 inline RTLIL::SigBit::SigBit(const RTLIL::SigChunk
&chunk
, int index
) : wire(chunk
.wire
) { if (wire
) offset
= chunk
.offset
+ index
; else data
= chunk
.data
[index
]; }
1270 inline bool RTLIL::SigBit::operator<(const RTLIL::SigBit
&other
) const {
1271 if (wire
== other
.wire
)
1272 return wire
? (offset
< other
.offset
) : (data
< other
.data
);
1273 if (wire
!= nullptr && other
.wire
!= nullptr)
1274 return wire
->name
< other
.wire
->name
;
1275 return wire
< other
.wire
;
1278 inline bool RTLIL::SigBit::operator==(const RTLIL::SigBit
&other
) const {
1279 return (wire
== other
.wire
) && (wire
? (offset
== other
.offset
) : (data
== other
.data
));
1282 inline bool RTLIL::SigBit::operator!=(const RTLIL::SigBit
&other
) const {
1283 return (wire
!= other
.wire
) || (wire
? (offset
!= other
.offset
) : (data
!= other
.data
));
1286 inline unsigned int RTLIL::SigBit::hash() const {
1288 return mkhash_add(wire
->name
.hash(), offset
);
1292 inline RTLIL::SigBit
&RTLIL::SigSpecIterator::operator*() const {
1293 return (*sig_p
)[index
];
1296 inline const RTLIL::SigBit
&RTLIL::SigSpecConstIterator::operator*() const {
1297 return (*sig_p
)[index
];
1300 inline RTLIL::SigBit::SigBit(const RTLIL::SigSpec
&sig
) {
1301 log_assert(sig
.size() == 1 && sig
.chunks().size() == 1);
1302 *this = SigBit(sig
.chunks().front());
1305 template<typename T
>
1306 void RTLIL::Module::rewrite_sigspecs(T
&functor
)
1308 for (auto &it
: cells_
)
1309 it
.second
->rewrite_sigspecs(functor
);
1310 for (auto &it
: processes
)
1311 it
.second
->rewrite_sigspecs(functor
);
1312 for (auto &it
: connections_
) {
1318 template<typename T
>
1319 void RTLIL::Cell::rewrite_sigspecs(T
&functor
) {
1320 for (auto &it
: connections_
)
1324 template<typename T
>
1325 void RTLIL::CaseRule::rewrite_sigspecs(T
&functor
) {
1326 for (auto &it
: compare
)
1328 for (auto &it
: actions
) {
1332 for (auto it
: switches
)
1333 it
->rewrite_sigspecs(functor
);
1336 template<typename T
>
1337 void RTLIL::SwitchRule::rewrite_sigspecs(T
&functor
)
1340 for (auto it
: cases
)
1341 it
->rewrite_sigspecs(functor
);
1344 template<typename T
>
1345 void RTLIL::SyncRule::rewrite_sigspecs(T
&functor
)
1348 for (auto &it
: actions
) {
1354 template<typename T
>
1355 void RTLIL::Process::rewrite_sigspecs(T
&functor
)
1357 root_case
.rewrite_sigspecs(functor
);
1358 for (auto it
: syncs
)
1359 it
->rewrite_sigspecs(functor
);