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"
21 #include "kernel/utils.h"
22 #include "kernel/sigtools.h"
23 #include "libs/sha1/sha1.h"
29 #include "simplemap.h"
30 #include "passes/techmap/techmap.inc"
35 extern void maccmap(RTLIL::Module
*module
, RTLIL::Cell
*cell
, bool unmap
= false);
40 PRIVATE_NAMESPACE_BEGIN
42 void apply_prefix(IdString prefix
, IdString
&id
)
45 id
= stringf("%s.%s", prefix
.c_str(), id
.c_str()+1);
47 id
= stringf("$techmap%s.%s", prefix
.c_str(), id
.c_str());
50 void apply_prefix(IdString prefix
, RTLIL::SigSpec
&sig
, RTLIL::Module
*module
)
52 vector
<SigChunk
> chunks
= sig
;
53 for (auto &chunk
: chunks
)
54 if (chunk
.wire
!= NULL
) {
55 IdString wire_name
= chunk
.wire
->name
;
56 apply_prefix(prefix
, wire_name
);
57 log_assert(module
->wires_
.count(wire_name
) > 0);
58 chunk
.wire
= module
->wires_
[wire_name
];
65 std::map
<RTLIL::IdString
, void(*)(RTLIL::Module
*, RTLIL::Cell
*)> simplemap_mappers
;
66 std::map
<std::pair
<RTLIL::IdString
, std::map
<RTLIL::IdString
, RTLIL::Const
>>, RTLIL::Module
*> techmap_cache
;
67 std::map
<RTLIL::Module
*, bool> techmap_do_cache
;
68 std::set
<RTLIL::Module
*, RTLIL::IdString::compare_ptr_by_name
<RTLIL::Module
>> module_queue
;
69 dict
<Module
*, SigMap
> sigmaps
;
71 pool
<IdString
> flatten_do_list
;
72 pool
<IdString
> flatten_done_list
;
73 pool
<Cell
*> flatten_keep_list
;
75 pool
<string
> log_msg_cache
;
77 struct TechmapWireData
{
82 typedef std::map
<std::string
, std::vector
<TechmapWireData
>> TechmapWires
;
96 recursive_mode
= false;
97 autoproc_mode
= false;
101 std::string
constmap_tpl_name(SigMap
&sigmap
, RTLIL::Module
*tpl
, RTLIL::Cell
*cell
, bool verbose
)
103 std::string constmap_info
;
104 std::map
<RTLIL::SigBit
, std::pair
<RTLIL::IdString
, int>> connbits_map
;
106 for (auto conn
: cell
->connections())
107 for (int i
= 0; i
< GetSize(conn
.second
); i
++) {
108 RTLIL::SigBit bit
= sigmap(conn
.second
[i
]);
109 if (bit
.wire
== nullptr) {
111 log(" Constant input on bit %d of port %s: %s\n", i
, log_id(conn
.first
), log_signal(bit
));
112 constmap_info
+= stringf("|%s %d %d", log_id(conn
.first
), i
, bit
.data
);
113 } else if (connbits_map
.count(bit
)) {
115 log(" Bit %d of port %s and bit %d of port %s are connected.\n", i
, log_id(conn
.first
),
116 connbits_map
.at(bit
).second
, log_id(connbits_map
.at(bit
).first
));
117 constmap_info
+= stringf("|%s %d %s %d", log_id(conn
.first
), i
,
118 log_id(connbits_map
.at(bit
).first
), connbits_map
.at(bit
).second
);
120 connbits_map
[bit
] = std::pair
<RTLIL::IdString
, int>(conn
.first
, i
);
121 constmap_info
+= stringf("|%s %d", log_id(conn
.first
), i
);
125 return stringf("$paramod$constmap:%s%s", sha1(constmap_info
).c_str(), tpl
->name
.c_str());
128 TechmapWires
techmap_find_special_wires(RTLIL::Module
*module
)
135 for (auto &it
: module
->wires_
) {
136 const char *p
= it
.first
.c_str();
140 const char *q
= strrchr(p
+1, '.');
143 if (!strncmp(p
, "_TECHMAP_", 9)) {
144 TechmapWireData record
;
145 record
.wire
= it
.second
;
146 record
.value
= it
.second
;
147 result
[p
].push_back(record
);
148 it
.second
->attributes
[ID::keep
] = RTLIL::Const(1);
149 it
.second
->attributes
[ID::_techmap_special_
] = RTLIL::Const(1);
153 if (!result
.empty()) {
154 SigMap
sigmap(module
);
155 for (auto &it1
: result
)
156 for (auto &it2
: it1
.second
)
157 sigmap
.apply(it2
.value
);
163 void techmap_module_worker(RTLIL::Design
*design
, RTLIL::Module
*module
, RTLIL::Cell
*cell
, RTLIL::Module
*tpl
)
165 if (tpl
->processes
.size() != 0) {
166 log("Technology map yielded processes:");
167 for (auto &it
: tpl
->processes
)
168 log(" %s",RTLIL::id2cstr(it
.first
));
171 Pass::call_on_module(tpl
->design
, tpl
, "proc");
172 log_assert(GetSize(tpl
->processes
) == 0);
174 log_error("Technology map yielded processes -> this is not supported (use -autoproc to run 'proc' automatically).\n");
177 std::string orig_cell_name
;
178 pool
<string
> extra_src_attrs
= cell
->get_strpool_attribute(ID::src
);
180 orig_cell_name
= cell
->name
.str();
182 for (auto &it
: tpl
->cells_
)
183 if (it
.first
== ID::_TECHMAP_REPLACE_
) {
184 module
->rename(cell
, stringf("$techmap%d", autoidx
++) + cell
->name
.str());
189 dict
<IdString
, IdString
> memory_renames
;
191 for (auto &it
: tpl
->memories
) {
192 IdString m_name
= it
.first
;
193 apply_prefix(cell
->name
, m_name
);
194 RTLIL::Memory
*m
= new RTLIL::Memory
;
196 m
->width
= it
.second
->width
;
197 m
->start_offset
= it
.second
->start_offset
;
198 m
->size
= it
.second
->size
;
199 m
->attributes
= it
.second
->attributes
;
200 if (m
->attributes
.count(ID::src
))
201 m
->add_strpool_attribute(ID::src
, extra_src_attrs
);
202 module
->memories
[m
->name
] = m
;
203 memory_renames
[it
.first
] = m
->name
;
204 design
->select(module
, m
);
207 std::map
<RTLIL::IdString
, RTLIL::IdString
> positional_ports
;
208 dict
<Wire
*, IdString
> temp_renamed_wires
;
209 pool
<SigBit
> autopurge_tpl_bits
;
211 for (auto &it
: tpl
->wires_
)
213 if (it
.second
->port_id
> 0)
215 IdString posportname
= stringf("$%d", it
.second
->port_id
);
216 positional_ports
[posportname
] = it
.first
;
218 if (!flatten_mode
&& it
.second
->get_bool_attribute(ID::techmap_autopurge
) &&
219 (!cell
->hasPort(it
.second
->name
) || !GetSize(cell
->getPort(it
.second
->name
))) &&
220 (!cell
->hasPort(posportname
) || !GetSize(cell
->getPort(posportname
))))
222 if (sigmaps
.count(tpl
) == 0)
223 sigmaps
[tpl
].set(tpl
);
225 for (auto bit
: sigmaps
.at(tpl
)(it
.second
))
226 if (bit
.wire
!= nullptr)
227 autopurge_tpl_bits
.insert(bit
);
230 IdString w_name
= it
.second
->name
;
231 apply_prefix(cell
->name
, w_name
);
232 RTLIL::Wire
*w
= module
->wire(w_name
);
234 if (!flatten_mode
|| !w
->get_bool_attribute(ID::hierconn
)) {
235 temp_renamed_wires
[w
] = w
->name
;
236 module
->rename(w
, NEW_ID
);
239 w
->attributes
.erase(ID::hierconn
);
240 if (GetSize(w
) < GetSize(it
.second
)) {
241 log_warning("Widening signal %s.%s to match size of %s.%s (via %s.%s).\n", log_id(module
), log_id(w
),
242 log_id(tpl
), log_id(it
.second
), log_id(module
), log_id(cell
));
243 w
->width
= GetSize(it
.second
);
248 w
= module
->addWire(w_name
, it
.second
);
249 w
->port_input
= false;
250 w
->port_output
= false;
253 w
->attributes
.erase(ID::techmap_autopurge
);
254 if (it
.second
->get_bool_attribute(ID::_techmap_special_
))
255 w
->attributes
.clear();
256 if (w
->attributes
.count(ID::src
))
257 w
->add_strpool_attribute(ID::src
, extra_src_attrs
);
259 design
->select(module
, w
);
261 if (it
.second
->name
.begins_with("\\_TECHMAP_REPLACE_.")) {
262 IdString replace_name
= stringf("%s%s", orig_cell_name
.c_str(), it
.second
->name
.c_str() + strlen("\\_TECHMAP_REPLACE_"));
263 Wire
*replace_w
= module
->addWire(replace_name
, it
.second
);
264 module
->connect(replace_w
, w
);
268 SigMap
tpl_sigmap(tpl
);
269 pool
<SigBit
> tpl_written_bits
;
271 for (auto &it1
: tpl
->cells_
)
272 for (auto &it2
: it1
.second
->connections_
)
273 if (it1
.second
->output(it2
.first
))
274 for (auto bit
: tpl_sigmap(it2
.second
))
275 tpl_written_bits
.insert(bit
);
276 for (auto &it1
: tpl
->connections_
)
277 for (auto bit
: tpl_sigmap(it1
.first
))
278 tpl_written_bits
.insert(bit
);
280 SigMap port_signal_map
;
281 SigSig port_signal_assign
;
283 for (auto &it
: cell
->connections())
285 RTLIL::IdString portname
= it
.first
;
286 if (positional_ports
.count(portname
) > 0)
287 portname
= positional_ports
.at(portname
);
288 if (tpl
->wires_
.count(portname
) == 0 || tpl
->wires_
.at(portname
)->port_id
== 0) {
289 if (portname
.begins_with("$"))
290 log_error("Can't map port `%s' of cell `%s' to template `%s'!\n", portname
.c_str(), cell
->name
.c_str(), tpl
->name
.c_str());
294 if (GetSize(it
.second
) == 0)
297 RTLIL::Wire
*w
= tpl
->wires_
.at(portname
);
298 RTLIL::SigSig c
, extra_connect
;
300 if (w
->port_output
&& !w
->port_input
) {
302 c
.second
= RTLIL::SigSpec(w
);
303 apply_prefix(cell
->name
, c
.second
, module
);
304 extra_connect
.first
= c
.second
;
305 extra_connect
.second
= c
.first
;
306 } else if (!w
->port_output
&& w
->port_input
) {
307 c
.first
= RTLIL::SigSpec(w
);
308 c
.second
= it
.second
;
309 apply_prefix(cell
->name
, c
.first
, module
);
310 extra_connect
.first
= c
.first
;
311 extra_connect
.second
= c
.second
;
313 SigSpec sig_tpl
= w
, sig_tpl_pf
= w
, sig_mod
= it
.second
;
314 apply_prefix(cell
->name
, sig_tpl_pf
, module
);
315 for (int i
= 0; i
< GetSize(sig_tpl
) && i
< GetSize(sig_mod
); i
++) {
316 if (tpl_written_bits
.count(tpl_sigmap(sig_tpl
[i
]))) {
317 c
.first
.append(sig_mod
[i
]);
318 c
.second
.append(sig_tpl_pf
[i
]);
320 c
.first
.append(sig_tpl_pf
[i
]);
321 c
.second
.append(sig_mod
[i
]);
324 extra_connect
.first
= sig_tpl_pf
;
325 extra_connect
.second
= sig_mod
;
328 if (c
.second
.size() > c
.first
.size())
329 c
.second
.remove(c
.first
.size(), c
.second
.size() - c
.first
.size());
331 if (c
.second
.size() < c
.first
.size())
332 c
.second
.append(RTLIL::SigSpec(RTLIL::State::S0
, c
.first
.size() - c
.second
.size()));
334 log_assert(c
.first
.size() == c
.second
.size());
338 // more conservative approach:
339 // connect internal and external wires
341 if (sigmaps
.count(module
) == 0)
342 sigmaps
[module
].set(module
);
344 if (sigmaps
.at(module
)(c
.first
).has_const())
345 log_error("Mismatch in directionality for cell port %s.%s.%s: %s <= %s\n",
346 log_id(module
), log_id(cell
), log_id(it
.first
), log_signal(c
.first
), log_signal(c
.second
));
352 // approach that yields nicer outputs:
353 // replace internal wires that are connected to external wires
355 if (w
->port_output
&& !w
->port_input
) {
356 port_signal_map
.add(c
.second
, c
.first
);
358 if (!w
->port_output
&& w
->port_input
) {
359 port_signal_map
.add(c
.first
, c
.second
);
362 extra_connect
= SigSig();
365 for (auto &attr
: w
->attributes
) {
366 if (attr
.first
== ID::src
)
368 auto lhs
= GetSize(extra_connect
.first
);
369 auto rhs
= GetSize(extra_connect
.second
);
371 extra_connect
.first
.remove(rhs
, lhs
-rhs
);
373 extra_connect
.second
.remove(lhs
, rhs
-lhs
);
374 module
->connect(extra_connect
);
380 for (auto &it
: tpl
->cells_
)
382 IdString c_name
= it
.second
->name
.str();
383 bool techmap_replace_cell
= (!flatten_mode
) && (c_name
== ID::_TECHMAP_REPLACE_
);
385 if (techmap_replace_cell
)
386 c_name
= orig_cell_name
;
387 else if (it
.second
->name
.begins_with("\\_TECHMAP_REPLACE_."))
388 c_name
= stringf("%s%s", orig_cell_name
.c_str(), c_name
.c_str() + strlen("\\_TECHMAP_REPLACE_"));
390 apply_prefix(cell
->name
, c_name
);
392 RTLIL::Cell
*c
= module
->addCell(c_name
, it
.second
);
393 design
->select(module
, c
);
395 if (!flatten_mode
&& c
->type
.begins_with("\\$"))
396 c
->type
= c
->type
.substr(1);
398 vector
<IdString
> autopurge_ports
;
400 for (auto &it2
: c
->connections_
)
402 bool autopurge
= false;
403 if (!autopurge_tpl_bits
.empty()) {
404 autopurge
= GetSize(it2
.second
) != 0;
405 for (auto &bit
: sigmaps
.at(tpl
)(it2
.second
))
406 if (!autopurge_tpl_bits
.count(bit
)) {
413 autopurge_ports
.push_back(it2
.first
);
415 apply_prefix(cell
->name
, it2
.second
, module
);
416 port_signal_map
.apply(it2
.second
);
420 for (auto &it2
: autopurge_ports
)
423 if (c
->type
.in(ID($memrd
), ID($memwr
), ID($meminit
))) {
424 IdString memid
= c
->getParam(ID::MEMID
).decode_string();
425 log_assert(memory_renames
.count(memid
) != 0);
426 c
->setParam(ID::MEMID
, Const(memory_renames
[memid
].str()));
429 if (c
->type
== ID($mem
)) {
430 IdString memid
= c
->getParam(ID::MEMID
).decode_string();
431 apply_prefix(cell
->name
, memid
);
432 c
->setParam(ID::MEMID
, Const(memid
.c_str()));
435 if (c
->attributes
.count(ID::src
))
436 c
->add_strpool_attribute(ID::src
, extra_src_attrs
);
438 if (techmap_replace_cell
)
439 for (auto attr
: cell
->attributes
)
440 if (!c
->attributes
.count(attr
.first
))
441 c
->attributes
[attr
.first
] = attr
.second
;
444 for (auto &it
: tpl
->connections()) {
445 RTLIL::SigSig c
= it
;
446 apply_prefix(cell
->name
.str(), c
.first
, module
);
447 apply_prefix(cell
->name
.str(), c
.second
, module
);
448 port_signal_map
.apply(c
.first
);
449 port_signal_map
.apply(c
.second
);
453 module
->remove(cell
);
455 for (auto &it
: temp_renamed_wires
)
458 IdString name
= it
.second
;
459 IdString altname
= module
->uniquify(name
);
460 Wire
*other_w
= module
->wire(name
);
461 module
->rename(other_w
, altname
);
462 module
->rename(w
, name
);
466 bool techmap_module(RTLIL::Design
*design
, RTLIL::Module
*module
, RTLIL::Design
*map
, std::set
<RTLIL::Cell
*> &handled_cells
,
467 const std::map
<RTLIL::IdString
, std::set
<RTLIL::IdString
, RTLIL::sort_by_id_str
>> &celltypeMap
, bool in_recursion
)
469 std::string mapmsg_prefix
= in_recursion
? "Recursively mapping" : "Mapping";
471 if (!design
->selected(module
) || module
->get_blackbox_attribute(ignore_wb
))
474 bool log_continue
= false;
475 bool did_something
= false;
476 LogMakeDebugHdl mkdebug
;
478 SigMap
sigmap(module
);
480 dict
<SigBit
, State
> init_bits
;
481 pool
<SigBit
> remove_init_bits
;
483 for (auto wire
: module
->wires()) {
484 if (wire
->attributes
.count(ID::init
)) {
485 Const value
= wire
->attributes
.at(ID::init
);
486 for (int i
= 0; i
< min(GetSize(value
), GetSize(wire
)); i
++)
487 if (value
[i
] != State::Sx
)
488 init_bits
[sigmap(SigBit(wire
, i
))] = value
[i
];
492 TopoSort
<RTLIL::Cell
*, RTLIL::IdString::compare_ptr_by_name
<RTLIL::Cell
>> cells
;
493 std::map
<RTLIL::Cell
*, std::set
<RTLIL::SigBit
>> cell_to_inbit
;
494 std::map
<RTLIL::SigBit
, std::set
<RTLIL::Cell
*>> outbit_to_cell
;
496 for (auto cell
: module
->cells())
498 if (!design
->selected(module
, cell
) || handled_cells
.count(cell
) > 0)
501 std::string cell_type
= cell
->type
.str();
502 if (in_recursion
&& cell
->type
.begins_with("\\$"))
503 cell_type
= cell_type
.substr(1);
505 if (celltypeMap
.count(cell_type
) == 0) {
506 if (assert_mode
&& cell_type
.back() != '_')
507 log_error("(ASSERT MODE) No matching template cell for type %s found.\n", log_id(cell_type
));
512 bool keepit
= cell
->get_bool_attribute(ID::keep_hierarchy
);
513 for (auto &tpl_name
: celltypeMap
.at(cell_type
))
514 if (map
->modules_
[tpl_name
]->get_bool_attribute(ID::keep_hierarchy
))
517 if (!flatten_keep_list
[cell
]) {
518 log("Keeping %s.%s (found keep_hierarchy property).\n", log_id(module
), log_id(cell
));
519 flatten_keep_list
.insert(cell
);
521 if (!flatten_done_list
[cell
->type
])
522 flatten_do_list
.insert(cell
->type
);
527 for (auto &conn
: cell
->connections())
529 RTLIL::SigSpec sig
= sigmap(conn
.second
);
532 if (GetSize(sig
) == 0)
535 for (auto &tpl_name
: celltypeMap
.at(cell_type
)) {
536 RTLIL::Module
*tpl
= map
->modules_
[tpl_name
];
537 RTLIL::Wire
*port
= tpl
->wire(conn
.first
);
538 if (port
&& port
->port_input
)
539 cell_to_inbit
[cell
].insert(sig
.begin(), sig
.end());
540 if (port
&& port
->port_output
)
541 for (auto &bit
: sig
)
542 outbit_to_cell
[bit
].insert(cell
);
549 for (auto &it_right
: cell_to_inbit
)
550 for (auto &it_sigbit
: it_right
.second
)
551 for (auto &it_left
: outbit_to_cell
[it_sigbit
])
552 cells
.edge(it_left
, it_right
.first
);
556 for (auto cell
: cells
.sorted
)
558 log_assert(handled_cells
.count(cell
) == 0);
559 log_assert(cell
== module
->cell(cell
->name
));
560 bool mapped_cell
= false;
562 std::string cell_type
= cell
->type
.str();
564 if (in_recursion
&& cell
->type
.begins_with("\\$"))
565 cell_type
= cell_type
.substr(1);
567 for (auto &tpl_name
: celltypeMap
.at(cell_type
))
569 RTLIL::IdString derived_name
= tpl_name
;
570 RTLIL::Module
*tpl
= map
->modules_
[tpl_name
];
571 std::map
<RTLIL::IdString
, RTLIL::Const
> parameters(cell
->parameters
.begin(), cell
->parameters
.end());
573 if (tpl
->get_blackbox_attribute(ignore_wb
))
578 std::string extmapper_name
;
580 if (tpl
->get_bool_attribute(ID::techmap_simplemap
))
581 extmapper_name
= "simplemap";
583 if (tpl
->get_bool_attribute(ID::techmap_maccmap
))
584 extmapper_name
= "maccmap";
586 if (tpl
->attributes
.count(ID::techmap_wrap
))
587 extmapper_name
= "wrap";
589 if (!extmapper_name
.empty())
591 cell
->type
= cell_type
;
593 if ((extern_mode
&& !in_recursion
) || extmapper_name
== "wrap")
595 std::string m_name
= stringf("$extern:%s:%s", extmapper_name
.c_str(), log_id(cell
->type
));
597 for (auto &c
: cell
->parameters
)
598 m_name
+= stringf(":%s=%s", log_id(c
.first
), log_signal(c
.second
));
600 if (extmapper_name
== "wrap")
601 m_name
+= ":" + sha1(tpl
->attributes
.at(ID::techmap_wrap
).decode_string());
603 RTLIL::Design
*extmapper_design
= extern_mode
&& !in_recursion
? design
: tpl
->design
;
604 RTLIL::Module
*extmapper_module
= extmapper_design
->module(m_name
);
606 if (extmapper_module
== nullptr)
608 extmapper_module
= extmapper_design
->addModule(m_name
);
609 RTLIL::Cell
*extmapper_cell
= extmapper_module
->addCell(cell
->type
, cell
);
611 extmapper_cell
->set_src_attribute(cell
->get_src_attribute());
613 int port_counter
= 1;
614 for (auto &c
: extmapper_cell
->connections_
) {
615 RTLIL::Wire
*w
= extmapper_module
->addWire(c
.first
, GetSize(c
.second
));
616 if (w
->name
.in(ID::Y
, ID::Q
))
617 w
->port_output
= true;
619 w
->port_input
= true;
620 w
->port_id
= port_counter
++;
624 extmapper_module
->fixup_ports();
625 extmapper_module
->check();
627 if (extmapper_name
== "simplemap") {
628 log("Creating %s with simplemap.\n", log_id(extmapper_module
));
629 if (simplemap_mappers
.count(extmapper_cell
->type
) == 0)
630 log_error("No simplemap mapper for cell type %s found!\n", log_id(extmapper_cell
->type
));
631 simplemap_mappers
.at(extmapper_cell
->type
)(extmapper_module
, extmapper_cell
);
632 extmapper_module
->remove(extmapper_cell
);
635 if (extmapper_name
== "maccmap") {
636 log("Creating %s with maccmap.\n", log_id(extmapper_module
));
637 if (extmapper_cell
->type
!= ID($macc
))
638 log_error("The maccmap mapper can only map $macc (not %s) cells!\n", log_id(extmapper_cell
->type
));
639 maccmap(extmapper_module
, extmapper_cell
);
640 extmapper_module
->remove(extmapper_cell
);
643 if (extmapper_name
== "wrap") {
644 std::string cmd_string
= tpl
->attributes
.at(ID::techmap_wrap
).decode_string();
645 log("Running \"%s\" on wrapper %s.\n", cmd_string
.c_str(), log_id(extmapper_module
));
647 Pass::call_on_module(extmapper_design
, extmapper_module
, cmd_string
);
652 cell
->type
= extmapper_module
->name
;
653 cell
->parameters
.clear();
655 if (!extern_mode
|| in_recursion
) {
656 tpl
= extmapper_module
;
657 goto use_wrapper_tpl
;
660 auto msg
= stringf("Using extmapper %s for cells of type %s.", log_id(extmapper_module
), log_id(cell
->type
));
661 if (!log_msg_cache
.count(msg
)) {
662 log_msg_cache
.insert(msg
);
663 log("%s\n", msg
.c_str());
665 log_debug("%s %s.%s (%s) to %s.\n", mapmsg_prefix
.c_str(), log_id(module
), log_id(cell
), log_id(cell
->type
), log_id(extmapper_module
));
669 auto msg
= stringf("Using extmapper %s for cells of type %s.", extmapper_name
.c_str(), log_id(cell
->type
));
670 if (!log_msg_cache
.count(msg
)) {
671 log_msg_cache
.insert(msg
);
672 log("%s\n", msg
.c_str());
674 log_debug("%s %s.%s (%s) with %s.\n", mapmsg_prefix
.c_str(), log_id(module
), log_id(cell
), log_id(cell
->type
), extmapper_name
.c_str());
676 if (extmapper_name
== "simplemap") {
677 if (simplemap_mappers
.count(cell
->type
) == 0)
678 log_error("No simplemap mapper for cell type %s found!\n", RTLIL::id2cstr(cell
->type
));
679 simplemap_mappers
.at(cell
->type
)(module
, cell
);
682 if (extmapper_name
== "maccmap") {
683 if (cell
->type
!= ID($macc
))
684 log_error("The maccmap mapper can only map $macc (not %s) cells!\n", log_id(cell
->type
));
685 maccmap(module
, cell
);
688 module
->remove(cell
);
692 did_something
= true;
697 for (auto conn
: cell
->connections()) {
698 if (conn
.first
.begins_with("$"))
700 if (tpl
->wires_
.count(conn
.first
) > 0 && tpl
->wires_
.at(conn
.first
)->port_id
> 0)
702 if (!conn
.second
.is_fully_const() || parameters
.count(conn
.first
) > 0 || tpl
->avail_parameters
.count(conn
.first
) == 0)
704 parameters
[conn
.first
] = conn
.second
.as_const();
712 if (tpl
->avail_parameters
.count(ID::_TECHMAP_CELLTYPE_
) != 0)
713 parameters
[ID::_TECHMAP_CELLTYPE_
] = RTLIL::unescape_id(cell
->type
);
715 for (auto conn
: cell
->connections()) {
716 if (tpl
->avail_parameters
.count(stringf("\\_TECHMAP_CONSTMSK_%s_", RTLIL::id2cstr(conn
.first
))) != 0) {
717 std::vector
<RTLIL::SigBit
> v
= sigmap(conn
.second
).to_sigbit_vector();
719 bit
= RTLIL::SigBit(bit
.wire
== NULL
? RTLIL::State::S1
: RTLIL::State::S0
);
720 parameters
[stringf("\\_TECHMAP_CONSTMSK_%s_", RTLIL::id2cstr(conn
.first
))] = RTLIL::SigSpec(v
).as_const();
722 if (tpl
->avail_parameters
.count(stringf("\\_TECHMAP_CONSTVAL_%s_", RTLIL::id2cstr(conn
.first
))) != 0) {
723 std::vector
<RTLIL::SigBit
> v
= sigmap(conn
.second
).to_sigbit_vector();
725 if (bit
.wire
!= NULL
)
726 bit
= RTLIL::SigBit(RTLIL::State::Sx
);
727 parameters
[stringf("\\_TECHMAP_CONSTVAL_%s_", RTLIL::id2cstr(conn
.first
))] = RTLIL::SigSpec(v
).as_const();
729 if (tpl
->avail_parameters
.count(stringf("\\_TECHMAP_WIREINIT_%s_", RTLIL::id2cstr(conn
.first
))) != 0) {
730 auto sig
= sigmap(conn
.second
);
731 RTLIL::Const
value(State::Sx
, sig
.size());
732 for (int i
= 0; i
< sig
.size(); i
++) {
733 auto it
= init_bits
.find(sig
[i
]);
734 if (it
!= init_bits
.end()) {
735 value
[i
] = it
->second
;
738 parameters
[stringf("\\_TECHMAP_WIREINIT_%s_", RTLIL::id2cstr(conn
.first
))] = value
;
742 int unique_bit_id_counter
= 0;
743 std::map
<RTLIL::SigBit
, int> unique_bit_id
;
744 unique_bit_id
[RTLIL::State::S0
] = unique_bit_id_counter
++;
745 unique_bit_id
[RTLIL::State::S1
] = unique_bit_id_counter
++;
746 unique_bit_id
[RTLIL::State::Sx
] = unique_bit_id_counter
++;
747 unique_bit_id
[RTLIL::State::Sz
] = unique_bit_id_counter
++;
749 for (auto conn
: cell
->connections())
750 if (tpl
->avail_parameters
.count(stringf("\\_TECHMAP_CONNMAP_%s_", RTLIL::id2cstr(conn
.first
))) != 0) {
751 for (auto &bit
: sigmap(conn
.second
).to_sigbit_vector())
752 if (unique_bit_id
.count(bit
) == 0)
753 unique_bit_id
[bit
] = unique_bit_id_counter
++;
756 // Find highest bit set
758 for (int i
= 0; i
< 32; i
++)
759 if (((unique_bit_id_counter
-1) & (1 << i
)) != 0)
761 // Increment index by one to get number of bits
763 if (tpl
->avail_parameters
.count(ID::_TECHMAP_BITS_CONNMAP_
))
764 parameters
[ID::_TECHMAP_BITS_CONNMAP_
] = bits
;
766 for (auto conn
: cell
->connections())
767 if (tpl
->avail_parameters
.count(stringf("\\_TECHMAP_CONNMAP_%s_", RTLIL::id2cstr(conn
.first
))) != 0) {
769 for (auto &bit
: sigmap(conn
.second
).to_sigbit_vector()) {
770 RTLIL::Const
chunk(unique_bit_id
.at(bit
), bits
);
771 value
.bits
.insert(value
.bits
.end(), chunk
.bits
.begin(), chunk
.bits
.end());
773 parameters
[stringf("\\_TECHMAP_CONNMAP_%s_", RTLIL::id2cstr(conn
.first
))] = value
;
779 // do not register techmap_wrap modules with techmap_cache
781 std::pair
<RTLIL::IdString
, std::map
<RTLIL::IdString
, RTLIL::Const
>> key(tpl_name
, parameters
);
782 if (techmap_cache
.count(key
) > 0) {
783 tpl
= techmap_cache
[key
];
785 if (parameters
.size() != 0) {
787 derived_name
= tpl
->derive(map
, dict
<RTLIL::IdString
, RTLIL::Const
>(parameters
.begin(), parameters
.end()));
788 tpl
= map
->module(derived_name
);
791 techmap_cache
[key
] = tpl
;
796 techmap_do_cache
[tpl
] = true;
798 RTLIL::Module
*constmapped_tpl
= map
->module(constmap_tpl_name(sigmap
, tpl
, cell
, false));
799 if (constmapped_tpl
!= nullptr)
800 tpl
= constmapped_tpl
;
803 if (techmap_do_cache
.count(tpl
) == 0)
805 bool keep_running
= true;
806 techmap_do_cache
[tpl
] = true;
808 std::set
<std::string
> techmap_wire_names
;
812 TechmapWires twd
= techmap_find_special_wires(tpl
);
813 keep_running
= false;
816 techmap_wire_names
.insert(it
.first
);
818 for (auto &it
: twd
["_TECHMAP_FAIL_"]) {
819 RTLIL::SigSpec value
= it
.value
;
820 if (value
.is_fully_const() && value
.as_bool()) {
821 log("Not using module `%s' from techmap as it contains a %s marker wire with non-zero value %s.\n",
822 derived_name
.c_str(), RTLIL::id2cstr(it
.wire
->name
), log_signal(value
));
823 techmap_do_cache
[tpl
] = false;
827 if (!techmap_do_cache
[tpl
])
832 if (it
.first
.compare(0, 12, "_TECHMAP_DO_") != 0 || it
.second
.empty())
835 auto &data
= it
.second
.front();
837 if (!data
.value
.is_fully_const())
838 log_error("Techmap yielded config wire %s with non-const value %s.\n", RTLIL::id2cstr(data
.wire
->name
), log_signal(data
.value
));
840 techmap_wire_names
.erase(it
.first
);
842 const char *p
= data
.wire
->name
.c_str();
843 const char *q
= strrchr(p
+1, '.');
846 std::string cmd_string
= data
.value
.as_const().decode_string();
848 restart_eval_cmd_string
:
849 if (cmd_string
.rfind("CONSTMAP; ", 0) == 0)
851 cmd_string
= cmd_string
.substr(strlen("CONSTMAP; "));
853 log("Analyzing pattern of constant bits for this cell:\n");
854 RTLIL::IdString new_tpl_name
= constmap_tpl_name(sigmap
, tpl
, cell
, true);
855 log("Creating constmapped module `%s'.\n", log_id(new_tpl_name
));
856 log_assert(map
->module(new_tpl_name
) == nullptr);
858 RTLIL::Module
*new_tpl
= map
->addModule(new_tpl_name
);
859 tpl
->cloneInto(new_tpl
);
861 techmap_do_cache
.erase(tpl
);
862 techmap_do_cache
[new_tpl
] = true;
865 std::map
<RTLIL::SigBit
, RTLIL::SigBit
> port_new2old_map
;
866 std::map
<RTLIL::SigBit
, RTLIL::SigBit
> port_connmap
;
867 std::map
<RTLIL::SigBit
, RTLIL::SigBit
> cellbits_to_tplbits
;
869 for (auto wire
: tpl
->wires().to_vector())
871 if (!wire
->port_input
|| wire
->port_output
)
874 RTLIL::IdString port_name
= wire
->name
;
875 tpl
->rename(wire
, NEW_ID
);
877 RTLIL::Wire
*new_wire
= tpl
->addWire(port_name
, wire
);
878 wire
->port_input
= false;
881 for (int i
= 0; i
< wire
->width
; i
++) {
882 port_new2old_map
[RTLIL::SigBit(new_wire
, i
)] = RTLIL::SigBit(wire
, i
);
883 port_connmap
[RTLIL::SigBit(wire
, i
)] = RTLIL::SigBit(new_wire
, i
);
887 for (auto conn
: cell
->connections())
888 for (int i
= 0; i
< GetSize(conn
.second
); i
++)
890 RTLIL::SigBit bit
= sigmap(conn
.second
[i
]);
891 RTLIL::SigBit
tplbit(tpl
->wire(conn
.first
), i
);
893 if (bit
.wire
== nullptr)
895 RTLIL::SigBit oldbit
= port_new2old_map
.at(tplbit
);
896 port_connmap
.at(oldbit
) = bit
;
898 else if (cellbits_to_tplbits
.count(bit
))
900 RTLIL::SigBit oldbit
= port_new2old_map
.at(tplbit
);
901 port_connmap
.at(oldbit
) = cellbits_to_tplbits
[bit
];
904 cellbits_to_tplbits
[bit
] = tplbit
;
907 RTLIL::SigSig port_conn
;
908 for (auto &it
: port_connmap
) {
909 port_conn
.first
.append(it
.first
);
910 port_conn
.second
.append(it
.second
);
912 tpl
->connect(port_conn
);
915 goto restart_eval_cmd_string
;
918 if (cmd_string
.rfind("RECURSION; ", 0) == 0)
920 cmd_string
= cmd_string
.substr(strlen("RECURSION; "));
921 while (techmap_module(map
, tpl
, map
, handled_cells
, celltypeMap
, true)) { }
922 goto restart_eval_cmd_string
;
925 Pass::call_on_module(map
, tpl
, cmd_string
);
927 log_assert(!strncmp(q
, "_TECHMAP_DO_", 12));
928 std::string new_name
= data
.wire
->name
.substr(0, q
-p
) + "_TECHMAP_DONE_" + data
.wire
->name
.substr(q
-p
+12);
929 while (tpl
->wires_
.count(new_name
))
931 tpl
->rename(data
.wire
->name
, new_name
);
938 TechmapWires twd
= techmap_find_special_wires(tpl
);
939 for (auto &it
: twd
) {
940 if (it
.first
!= "_TECHMAP_FAIL_" && (it
.first
.substr(0, 20) != "_TECHMAP_REMOVEINIT_" || it
.first
[it
.first
.size()-1] != '_') && it
.first
.substr(0, 12) != "_TECHMAP_DO_" && it
.first
.substr(0, 14) != "_TECHMAP_DONE_")
941 log_error("Techmap yielded unknown config wire %s.\n", it
.first
.c_str());
942 if (techmap_do_cache
[tpl
])
943 for (auto &it2
: it
.second
)
944 if (!it2
.value
.is_fully_const())
945 log_error("Techmap yielded config wire %s with non-const value %s.\n", RTLIL::id2cstr(it2
.wire
->name
), log_signal(it2
.value
));
946 techmap_wire_names
.erase(it
.first
);
949 for (auto &it
: techmap_wire_names
)
950 log_error("Techmap special wire %s disappeared. This is considered a fatal error.\n", RTLIL::id2cstr(it
));
952 if (recursive_mode
) {
954 log_header(design
, "Continuing TECHMAP pass.\n");
955 log_continue
= false;
958 while (techmap_module(map
, tpl
, map
, handled_cells
, celltypeMap
, true)) { }
962 if (techmap_do_cache
.at(tpl
) == false)
966 log_header(design
, "Continuing TECHMAP pass.\n");
967 log_continue
= false;
971 TechmapWires twd
= techmap_find_special_wires(tpl
);
972 for (auto &it
: twd
) {
973 if (it
.first
.substr(0, 20) == "_TECHMAP_REMOVEINIT_") {
974 for (auto &it2
: it
.second
) {
975 auto val
= it2
.value
.as_const();
976 auto wirename
= RTLIL::escape_id(it
.first
.substr(20, it
.first
.size() - 20 - 1));
977 auto it
= cell
->connections().find(wirename
);
978 if (it
!= cell
->connections().end()) {
979 auto sig
= sigmap(it
->second
);
980 for (int i
= 0; i
< sig
.size(); i
++)
981 if (val
[i
] == State::S1
)
982 remove_init_bits
.insert(sig
[i
]);
988 if (extern_mode
&& !in_recursion
)
990 std::string m_name
= stringf("$extern:%s", log_id(tpl
));
992 if (!design
->module(m_name
))
994 RTLIL::Module
*m
= design
->addModule(m_name
);
997 for (auto cell
: m
->cells()) {
998 if (cell
->type
.begins_with("\\$"))
999 cell
->type
= cell
->type
.substr(1);
1002 module_queue
.insert(m
);
1005 log_debug("%s %s.%s to imported %s.\n", mapmsg_prefix
.c_str(), log_id(module
), log_id(cell
), log_id(m_name
));
1006 cell
->type
= m_name
;
1007 cell
->parameters
.clear();
1011 auto msg
= stringf("Using template %s for cells of type %s.", log_id(tpl
), log_id(cell
->type
));
1012 if (!log_msg_cache
.count(msg
)) {
1013 log_msg_cache
.insert(msg
);
1014 log("%s\n", msg
.c_str());
1016 log_debug("%s %s.%s (%s) using %s.\n", mapmsg_prefix
.c_str(), log_id(module
), log_id(cell
), log_id(cell
->type
), log_id(tpl
));
1017 techmap_module_worker(design
, module
, cell
, tpl
);
1020 did_something
= true;
1025 if (assert_mode
&& !mapped_cell
)
1026 log_error("(ASSERT MODE) Failed to map cell %s.%s (%s).\n", log_id(module
), log_id(cell
), log_id(cell
->type
));
1028 handled_cells
.insert(cell
);
1031 if (!remove_init_bits
.empty()) {
1032 for (auto wire
: module
->wires())
1033 if (wire
->attributes
.count(ID::init
)) {
1034 Const
&value
= wire
->attributes
.at(ID::init
);
1035 bool do_cleanup
= true;
1036 for (int i
= 0; i
< min(GetSize(value
), GetSize(wire
)); i
++) {
1037 SigBit bit
= sigmap(SigBit(wire
, i
));
1038 if (remove_init_bits
.count(bit
))
1039 value
[i
] = State::Sx
;
1040 else if (value
[i
] != State::Sx
)
1044 log("Removing init attribute from wire %s.%s.\n", log_id(module
), log_id(wire
));
1045 wire
->attributes
.erase(ID::init
);
1051 log_header(design
, "Continuing TECHMAP pass.\n");
1052 log_continue
= false;
1056 return did_something
;
1060 struct TechmapPass
: public Pass
{
1061 TechmapPass() : Pass("techmap", "generic technology mapper") { }
1062 void help() YS_OVERRIDE
1064 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
1066 log(" techmap [-map filename] [selection]\n");
1068 log("This pass implements a very simple technology mapper that replaces cells in\n");
1069 log("the design with implementations given in form of a Verilog or ilang source\n");
1072 log(" -map filename\n");
1073 log(" the library of cell implementations to be used.\n");
1074 log(" without this parameter a builtin library is used that\n");
1075 log(" transforms the internal RTL cells to the internal gate\n");
1078 log(" -map %%<design-name>\n");
1079 log(" like -map above, but with an in-memory design instead of a file.\n");
1082 log(" load the cell implementations as separate modules into the design\n");
1083 log(" instead of inlining them.\n");
1085 log(" -max_iter <number>\n");
1086 log(" only run the specified number of iterations on each module.\n");
1087 log(" default: unlimited\n");
1089 log(" -recursive\n");
1090 log(" instead of the iterative breadth-first algorithm use a recursive\n");
1091 log(" depth-first algorithm. both methods should yield equivalent results,\n");
1092 log(" but may differ in performance.\n");
1094 log(" -autoproc\n");
1095 log(" Automatically call \"proc\" on implementations that contain processes.\n");
1098 log(" Ignore the 'whitebox' attribute on cell implementations.\n");
1101 log(" this option will cause techmap to exit with an error if it can't map\n");
1102 log(" a selected cell. only cell types that end on an underscore are accepted\n");
1103 log(" as final cell types by this mode.\n");
1105 log(" -D <define>, -I <incdir>\n");
1106 log(" this options are passed as-is to the Verilog frontend for loading the\n");
1107 log(" map file. Note that the Verilog frontend is also called with the\n");
1108 log(" '-nooverwrite' option set.\n");
1110 log("When a module in the map file has the 'techmap_celltype' attribute set, it will\n");
1111 log("match cells with a type that match the text value of this attribute. Otherwise\n");
1112 log("the module name will be used to match the cell.\n");
1114 log("When a module in the map file has the 'techmap_simplemap' attribute set, techmap\n");
1115 log("will use 'simplemap' (see 'help simplemap') to map cells matching the module.\n");
1117 log("When a module in the map file has the 'techmap_maccmap' attribute set, techmap\n");
1118 log("will use 'maccmap' (see 'help maccmap') to map cells matching the module.\n");
1120 log("When a module in the map file has the 'techmap_wrap' attribute set, techmap\n");
1121 log("will create a wrapper for the cell and then run the command string that the\n");
1122 log("attribute is set to on the wrapper module.\n");
1124 log("When a port on a module in the map file has the 'techmap_autopurge' attribute\n");
1125 log("set, and that port is not connected in the instantiation that is mapped, then\n");
1126 log("then a cell port connected only to such wires will be omitted in the mapped\n");
1127 log("version of the circuit.\n");
1129 log("All wires in the modules from the map file matching the pattern _TECHMAP_*\n");
1130 log("or *._TECHMAP_* are special wires that are used to pass instructions from\n");
1131 log("the mapping module to the techmap command. At the moment the following special\n");
1132 log("wires are supported:\n");
1134 log(" _TECHMAP_FAIL_\n");
1135 log(" When this wire is set to a non-zero constant value, techmap will not\n");
1136 log(" use this module and instead try the next module with a matching\n");
1137 log(" 'techmap_celltype' attribute.\n");
1139 log(" When such a wire exists but does not have a constant value after all\n");
1140 log(" _TECHMAP_DO_* commands have been executed, an error is generated.\n");
1142 log(" _TECHMAP_DO_*\n");
1143 log(" This wires are evaluated in alphabetical order. The constant text value\n");
1144 log(" of this wire is a yosys command (or sequence of commands) that is run\n");
1145 log(" by techmap on the module. A common use case is to run 'proc' on modules\n");
1146 log(" that are written using always-statements.\n");
1148 log(" When such a wire has a non-constant value at the time it is to be\n");
1149 log(" evaluated, an error is produced. That means it is possible for such a\n");
1150 log(" wire to start out as non-constant and evaluate to a constant value\n");
1151 log(" during processing of other _TECHMAP_DO_* commands.\n");
1153 log(" A _TECHMAP_DO_* command may start with the special token 'CONSTMAP; '.\n");
1154 log(" in this case techmap will create a copy for each distinct configuration\n");
1155 log(" of constant inputs and shorted inputs at this point and import the\n");
1156 log(" constant and connected bits into the map module. All further commands\n");
1157 log(" are executed in this copy. This is a very convenient way of creating\n");
1158 log(" optimized specializations of techmap modules without using the special\n");
1159 log(" parameters described below.\n");
1161 log(" A _TECHMAP_DO_* command may start with the special token 'RECURSION; '.\n");
1162 log(" then techmap will recursively replace the cells in the module with their\n");
1163 log(" implementation. This is not affected by the -max_iter option.\n");
1165 log(" It is possible to combine both prefixes to 'RECURSION; CONSTMAP; '.\n");
1167 log(" _TECHMAP_REMOVEINIT_<port-name>_\n");
1168 log(" When this wire is set to a constant value, the init attribute of the wire(s)\n");
1169 log(" connected to this port will be consumed. This wire must have the same\n");
1170 log(" width as the given port, and for every bit that is set to 1 in the value,\n");
1171 log(" the corresponding init attribute bit will be changed to 1'bx. If all\n");
1172 log(" bits of an init attribute are left as x, it will be removed.\n");
1174 log("In addition to this special wires, techmap also supports special parameters in\n");
1175 log("modules in the map file:\n");
1177 log(" _TECHMAP_CELLTYPE_\n");
1178 log(" When a parameter with this name exists, it will be set to the type name\n");
1179 log(" of the cell that matches the module.\n");
1181 log(" _TECHMAP_CONSTMSK_<port-name>_\n");
1182 log(" _TECHMAP_CONSTVAL_<port-name>_\n");
1183 log(" When this pair of parameters is available in a module for a port, then\n");
1184 log(" former has a 1-bit for each constant input bit and the latter has the\n");
1185 log(" value for this bit. The unused bits of the latter are set to undef (x).\n");
1187 log(" _TECHMAP_WIREINIT_<port-name>_\n");
1188 log(" When a parameter with this name exists, it will be set to the initial\n");
1189 log(" value of the wire(s) connected to the given port, as specified by the init\n");
1190 log(" attribute. If the attribute doesn't exist, x will be filled for the\n");
1191 log(" missing bits. To remove the init attribute bits used, use the\n");
1192 log(" _TECHMAP_REMOVEINIT_*_ wires.\n");
1194 log(" _TECHMAP_BITS_CONNMAP_\n");
1195 log(" _TECHMAP_CONNMAP_<port-name>_\n");
1196 log(" For an N-bit port, the _TECHMAP_CONNMAP_<port-name>_ parameter, if it\n");
1197 log(" exists, will be set to an N*_TECHMAP_BITS_CONNMAP_ bit vector containing\n");
1198 log(" N words (of _TECHMAP_BITS_CONNMAP_ bits each) that assign each single\n");
1199 log(" bit driver a unique id. The values 0-3 are reserved for 0, 1, x, and z.\n");
1200 log(" This can be used to detect shorted inputs.\n");
1202 log("When a module in the map file has a parameter where the according cell in the\n");
1203 log("design has a port, the module from the map file is only used if the port in\n");
1204 log("the design is connected to a constant value. The parameter is then set to the\n");
1205 log("constant value.\n");
1207 log("A cell with the name _TECHMAP_REPLACE_ in the map file will inherit the name\n");
1208 log("and attributes of the cell that is being replaced.\n");
1209 log("A cell with a name of the form `_TECHMAP_REPLACE_.<suffix>` in the map file will\n");
1210 log("be named thus but with the `_TECHMAP_REPLACE_' prefix substituted with the name\n");
1211 log("of the cell being replaced.\n");
1212 log("Similarly, a wire named in the form `_TECHMAP_REPLACE_.<suffix>` will cause a\n");
1213 log("new wire alias to be created and named as above but with the `_TECHMAP_REPLACE_'\n");
1214 log("prefix also substituted.\n");
1216 log("See 'help extract' for a pass that does the opposite thing.\n");
1218 log("See 'help flatten' for a pass that does flatten the design (which is\n");
1219 log("essentially techmap but using the design itself as map library).\n");
1222 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
1224 log_header(design
, "Executing TECHMAP pass (map to technology primitives).\n");
1227 TechmapWorker worker
;
1228 simplemap_get_mappers(worker
.simplemap_mappers
);
1230 std::vector
<std::string
> map_files
;
1231 std::string verilog_frontend
= "verilog -nooverwrite -noblackbox";
1235 for (argidx
= 1; argidx
< args
.size(); argidx
++) {
1236 if (args
[argidx
] == "-map" && argidx
+1 < args
.size()) {
1237 map_files
.push_back(args
[++argidx
]);
1240 if (args
[argidx
] == "-max_iter" && argidx
+1 < args
.size()) {
1241 max_iter
= atoi(args
[++argidx
].c_str());
1244 if (args
[argidx
] == "-D" && argidx
+1 < args
.size()) {
1245 verilog_frontend
+= " -D " + args
[++argidx
];
1248 if (args
[argidx
] == "-I" && argidx
+1 < args
.size()) {
1249 verilog_frontend
+= " -I " + args
[++argidx
];
1252 if (args
[argidx
] == "-assert") {
1253 worker
.assert_mode
= true;
1256 if (args
[argidx
] == "-extern") {
1257 worker
.extern_mode
= true;
1260 if (args
[argidx
] == "-recursive") {
1261 worker
.recursive_mode
= true;
1264 if (args
[argidx
] == "-autoproc") {
1265 worker
.autoproc_mode
= true;
1268 if (args
[argidx
] == "-wb") {
1269 worker
.ignore_wb
= true;
1274 extra_args(args
, argidx
, design
);
1276 RTLIL::Design
*map
= new RTLIL::Design
;
1277 if (map_files
.empty()) {
1278 std::istringstream
f(stdcells_code
);
1279 Frontend::frontend_call(map
, &f
, "<techmap.v>", verilog_frontend
);
1281 for (auto &fn
: map_files
)
1282 if (fn
.compare(0, 1, "%") == 0) {
1283 if (!saved_designs
.count(fn
.substr(1))) {
1285 log_cmd_error("Can't open saved design `%s'.\n", fn
.c_str()+1);
1287 for (auto mod
: saved_designs
.at(fn
.substr(1))->modules())
1288 if (!map
->has(mod
->name
))
1289 map
->add(mod
->clone());
1292 rewrite_filename(fn
);
1294 yosys_input_files
.insert(fn
);
1296 log_cmd_error("Can't open map file `%s'\n", fn
.c_str());
1297 Frontend::frontend_call(map
, &f
, fn
, (fn
.size() > 3 && fn
.compare(fn
.size()-3, std::string::npos
, ".il") == 0 ? "ilang" : verilog_frontend
));
1301 log_header(design
, "Continuing TECHMAP pass.\n");
1303 std::map
<RTLIL::IdString
, std::set
<RTLIL::IdString
, RTLIL::sort_by_id_str
>> celltypeMap
;
1304 for (auto &it
: map
->modules_
) {
1305 if (it
.second
->attributes
.count(ID::techmap_celltype
) && !it
.second
->attributes
.at(ID::techmap_celltype
).bits
.empty()) {
1306 char *p
= strdup(it
.second
->attributes
.at(ID::techmap_celltype
).decode_string().c_str());
1307 for (char *q
= strtok(p
, " \t\r\n"); q
; q
= strtok(NULL
, " \t\r\n"))
1308 celltypeMap
[RTLIL::escape_id(q
)].insert(it
.first
);
1311 string module_name
= it
.first
.str();
1312 if (it
.first
.begins_with("\\$"))
1313 module_name
= module_name
.substr(1);
1314 celltypeMap
[module_name
].insert(it
.first
);
1318 for (auto module
: design
->modules())
1319 worker
.module_queue
.insert(module
);
1321 while (!worker
.module_queue
.empty())
1323 RTLIL::Module
*module
= *worker
.module_queue
.begin();
1324 worker
.module_queue
.erase(module
);
1326 int module_max_iter
= max_iter
;
1327 bool did_something
= true;
1328 std::set
<RTLIL::Cell
*> handled_cells
;
1329 while (did_something
) {
1330 did_something
= false;
1331 if (worker
.techmap_module(design
, module
, map
, handled_cells
, celltypeMap
, false))
1332 did_something
= true;
1335 if (module_max_iter
> 0 && --module_max_iter
== 0)
1340 log("No more expansions possible.\n");
1347 struct FlattenPass
: public Pass
{
1348 FlattenPass() : Pass("flatten", "flatten design") { }
1349 void help() YS_OVERRIDE
1351 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
1353 log(" flatten [options] [selection]\n");
1355 log("This pass flattens the design by replacing cells by their implementation. This\n");
1356 log("pass is very similar to the 'techmap' pass. The only difference is that this\n");
1357 log("pass is using the current design as mapping library.\n");
1359 log("Cells and/or modules with the 'keep_hierarchy' attribute set will not be\n");
1360 log("flattened by this command.\n");
1363 log(" Ignore the 'whitebox' attribute on cell implementations.\n");
1366 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
1368 log_header(design
, "Executing FLATTEN pass (flatten design).\n");
1371 TechmapWorker worker
;
1372 worker
.flatten_mode
= true;
1375 for (argidx
= 1; argidx
< args
.size(); argidx
++) {
1376 if (args
[argidx
] == "-wb") {
1377 worker
.ignore_wb
= true;
1382 extra_args(args
, argidx
, design
);
1385 std::map
<RTLIL::IdString
, std::set
<RTLIL::IdString
, RTLIL::sort_by_id_str
>> celltypeMap
;
1386 for (auto module
: design
->modules())
1387 celltypeMap
[module
->name
].insert(module
->name
);
1389 RTLIL::Module
*top_mod
= NULL
;
1390 if (design
->full_selection())
1391 for (auto mod
: design
->modules())
1392 if (mod
->get_bool_attribute(ID::top
))
1395 std::set
<RTLIL::Cell
*> handled_cells
;
1396 if (top_mod
!= NULL
) {
1397 worker
.flatten_do_list
.insert(top_mod
->name
);
1398 while (!worker
.flatten_do_list
.empty()) {
1399 auto mod
= design
->module(*worker
.flatten_do_list
.begin());
1400 while (worker
.techmap_module(design
, mod
, design
, handled_cells
, celltypeMap
, false)) { }
1401 worker
.flatten_done_list
.insert(mod
->name
);
1402 worker
.flatten_do_list
.erase(mod
->name
);
1405 for (auto mod
: vector
<Module
*>(design
->modules())) {
1406 while (worker
.techmap_module(design
, mod
, design
, handled_cells
, celltypeMap
, false)) { }
1411 log("No more expansions possible.\n");
1413 if (top_mod
!= NULL
)
1415 pool
<RTLIL::IdString
> used_modules
, new_used_modules
;
1416 new_used_modules
.insert(top_mod
->name
);
1417 while (!new_used_modules
.empty()) {
1418 pool
<RTLIL::IdString
> queue
;
1419 queue
.swap(new_used_modules
);
1420 for (auto modname
: queue
)
1421 used_modules
.insert(modname
);
1422 for (auto modname
: queue
)
1423 for (auto cell
: design
->module(modname
)->cells())
1424 if (design
->module(cell
->type
) && !used_modules
[cell
->type
])
1425 new_used_modules
.insert(cell
->type
);
1428 dict
<RTLIL::IdString
, RTLIL::Module
*> new_modules
;
1429 for (auto mod
: vector
<Module
*>(design
->modules()))
1430 if (used_modules
[mod
->name
] || mod
->get_blackbox_attribute(worker
.ignore_wb
)) {
1431 new_modules
[mod
->name
] = mod
;
1433 log("Deleting now unused module %s.\n", log_id(mod
));
1436 design
->modules_
.swap(new_modules
);
1443 PRIVATE_NAMESPACE_END