#include "kernel/unstable/patch.h" #include "kernel/celltypes.h" #include "kernel/log.h" #include "kernel/rtlil.h" YOSYS_NAMESPACE_BEGIN using namespace RTLIL; template class CellAdderMixin; Cell* Patch::addCell(IdString name, IdString type) { cells_.push_back(std::make_unique(Cell::ConstructToken{})); Cell* cell = cells_.back().get(); cell->name = name; cell->type = type; cell->module = nullptr; return cell; } Wire* Patch::addWire(IdString name, int width) { wires_.push_back(std::make_unique(Wire::ConstructToken{})); Wire* wire = wires_.back().get(); wire->name = name; wire->width = width; wire->module = nullptr; return wire; } // TODO code golf RTLIL::Wire *RTLIL::Patch::addWire(RTLIL::IdString name, const RTLIL::Wire *other) { RTLIL::Wire *wire = addWire(std::move(name)); wire->width = other->width; wire->start_offset = other->start_offset; wire->port_id = other->port_id; wire->port_input = other->port_input; wire->port_output = other->port_output; wire->upto = other->upto; wire->is_signed = other->is_signed; wire->attributes = other->attributes; return wire; } struct SrcCollector { pool to_do; pool done; pool src; void collect_src(Cell* old_cell) { if (done.count(old_cell)) return; done.insert(old_cell); log_debug("collect %s\n", old_cell->name); src.insert(old_cell->get_src_attribute()); std::vector input_cells = {}; for (auto [port_name, sig] : old_cell->connections()) { auto dir = old_cell->port_dir(port_name); log_assert(dir != PD_UNKNOWN); if (dir == PD_INPUT || dir == PD_INOUT) { if (sig.size() && sig.is_wire()) { Wire* in_wire = sig.as_wire(); if (!in_wire->module) input_cells.push_back(in_wire->driverCell()); // if (!leaves.count(in_wire)) } } } for (auto input : input_cells) collect_src(input); } void collect_src(SigSpec old_sig) { log_debug("collect %s\n", log_signal(old_sig)); for (auto bit : old_sig) { if (bit.is_wire() && bit.wire->module) { log_assert(bit.wire->driverCell_); to_do.insert(bit.wire->driverCell_); } } for (auto cell : to_do) collect_src(cell); } }; void Patch::gc(Cell* old_cell, bool track) { log_debug("gc %s\n", old_cell->name); if (old_cell->type.in(ID($input_port), ID($output_port), ID($public))) return; pool inputs; for (auto [port_name, sig] : old_cell->connections()) { auto dir = old_cell->port_dir(port_name); // Unknown port direction (e.g. user module instance whose interface // isn't registered): can't decide input vs output, so don't gc it. // TODO: should be log_assert once PD_UNKNOWN is fixed at the source // (see claude-notes.md). if (dir == PD_UNKNOWN) return; // TODO only running GC through whole connections? log_debug("\tport %s\n", port_name); if (sig.size() && sig.is_wire()) { if (dir == PD_OUTPUT || dir == PD_INOUT) { for (auto bit : sig) { // Reject GC if used if (!mod->fanout(bit).empty()) { log_debug("\treject fanout\n"); return; } else log_debug("\tok\n"); } } if (dir == PD_INPUT || dir == PD_INOUT) { Wire* in_wire = sig.as_wire(); log_assert(in_wire); log_debug("\twire %s\n", in_wire->name); if (in_wire->known_driver() && !leaves.count(in_wire)) inputs.insert(in_wire->driverCell()); } } } log_debug("\tremove %s\n", old_cell->name); // Only track recursively-removed cells. The top-level patched cell is the // caller's current iteration variable and won't be re-encountered. if (track && removed_cells) removed_cells->insert(old_cell); old_cell->module->remove(old_cell); for (auto input : inputs) gc(input, /*track=*/true); } Wire* Patch::commit_wire(std::unique_ptr wire) { Wire* raw = wire.release(); mod->wires_[raw->name] = raw; raw->module = mod; return raw; } Cell* Patch::commit_cell(std::unique_ptr cell) { Cell* raw = cell.release(); mod->cells_[raw->name] = raw; raw->module = mod; raw->initIndex(); return raw; } void Patch::patch(Cell* old_cell, IdString old_port, SigSpec new_sig) { patch(old_cell, {{old_port, new_sig}}); } void Patch::patch(Cell* old_cell, const std::vector> &port_replacements) { std::vector old_sigs; for (auto &[port, new_sig] : port_replacements) { SigSpec old_sig = old_cell->getPort(port); log_assert(old_sig.size() == new_sig.size()); log_debug("patching %s %s which is %s with %s:\n", old_cell->name, port, log_signal(old_sig), log_signal(new_sig)); old_sigs.push_back(old_sig); } SrcCollector collector; for (auto &old_sig : old_sigs) collector.collect_src(old_sig); std::string src_str = AttrObject::strpool_attribute_to_str(collector.src); // Record leaves (existing wires consumed as inputs by the new cells) so // gc() stops at them. Detected via bit.wire->module being non-null: // uncommitted wires belong to no module yet. for (auto& cell : cells_) { for (auto& [port_name, sig] : cell->connections()) { auto dir = cell->port_dir(port_name); if (dir == PD_INPUT || dir == PD_INOUT) { for (auto bit : sig) { if (bit.is_wire() && bit.wire->module) leaves.insert(bit.wire); } } } } // Commit new cells/wires first so new_sig becomes a driven signal in the // signorm index before we merge. for (auto& cell: cells_) { cell->set_src_attribute(src_str); cell->fixup_parameters(); commit_cell(std::move(cell)); } for (auto& wire: wires_) commit_wire(std::move(wire)); // Now drop old_cell's drivers so old_sigs are undriven, then merge each // into its new_sig. connect_incremental updates sigmap and re-normalizes // fanout consumers in place — no full sigNormalize needed. for (auto &[port, new_sig] : port_replacements) old_cell->setPort(port, SigSpec()); for (size_t i = 0; i < port_replacements.size(); i++) { auto &[port, new_sig] = port_replacements[i]; if (map) map->add(old_sigs[i], new_sig); mod->connect_incremental(old_sigs[i], new_sig); } gc(old_cell); cells_.clear(); wires_.clear(); leaves.clear(); } YOSYS_NAMESPACE_END