From d57d21e566264172fb7b04d11ce58f4b9a4e1a86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Povi=C5=A1er?= Date: Thu, 5 Dec 2024 18:15:56 +0100 Subject: [PATCH 1/4] wrapcell: Optionally track unused outputs --- passes/cmds/wrapcell.cc | 182 ++++++++++++++++++++++++++++++++------ tests/various/wrapcell.ys | 30 +++++++ 2 files changed, 186 insertions(+), 26 deletions(-) diff --git a/passes/cmds/wrapcell.cc b/passes/cmds/wrapcell.cc index 812de9ebb08..6d8e87b4370 100644 --- a/passes/cmds/wrapcell.cc +++ b/passes/cmds/wrapcell.cc @@ -18,12 +18,37 @@ */ #include "kernel/yosys.h" #include "kernel/celltypes.h" +#include "kernel/sigtools.h" #include "backends/rtlil/rtlil_backend.h" USING_YOSYS_NAMESPACE PRIVATE_NAMESPACE_BEGIN -std::optional format(std::string fmt, const dict ¶meters) +bool has_fmt_field(std::string fmt, std::string field_name) +{ + auto it = fmt.begin(); + while (it != fmt.end()) { + if (*it == '{') { + it++; + auto beg = it; + while (it != fmt.end() && *it != '}') it++; + if (it == fmt.end()) + return false; + + if (std::string(beg, it) == field_name) + return true; + } + it++; + } + return false; +} + +struct ContextData { + std::string unused_outputs; +}; + +std::optional format(std::string fmt, const dict ¶meters, + ContextData &context) { std::stringstream result; @@ -38,13 +63,19 @@ std::optional format(std::string fmt, const dict & return {}; } - auto id = RTLIL::escape_id(std::string(beg, it)); - if (!parameters.count(id)) { - log("Parameter %s referenced in format string '%s' not found\n", log_id(id), fmt.c_str()); - return {}; - } + std::string param_name = {beg, it}; - RTLIL_BACKEND::dump_const(result, parameters.at(id)); + if (param_name == "%unused") { + result << context.unused_outputs; + } else { + auto id = RTLIL::escape_id(std::string(beg, it)); + if (!parameters.count(id)) { + log("Parameter %s referenced in format string '%s' not found\n", log_id(id), fmt.c_str()); + return {}; + } + + RTLIL_BACKEND::dump_const(result, parameters.at(id)); + } } else { result << *it; } @@ -54,6 +85,44 @@ std::optional format(std::string fmt, const dict & return {result.str()}; } +struct Chunk { + IdString port; + int base, len; + + Chunk(IdString id, int base, int len) + : port(id), base(base), len(len) {} + + IdString format(Cell *cell) + { + if (len == cell->getPort(port).size()) + return port; + else if (len == 1) + return stringf("%s[%d]", port.c_str(), base); + else + return stringf("%s[%d:%d]", port.c_str(), base + len - 1, base); + } + + SigSpec sample(Cell *cell) + { + return cell->getPort(port).extract(base, len); + } +}; + +std::vector collect_chunks(std::vector> bits) +{ + std::vector ret; + std::sort(bits.begin(), bits.end()); + for (auto it = bits.begin(); it != bits.end();) { + auto sep = it + 1; + for (; sep != bits.end() && + sep->first == it->first && + sep->second == (sep - 1)->second + 1; sep++); + ret.emplace_back(it->first, it->second, sep - it); + it = sep; + } + return ret; +} + struct WrapcellPass : Pass { WrapcellPass() : Pass("wrapcell", "wrap individual cells into new modules") {} @@ -68,6 +137,10 @@ struct WrapcellPass : Pass { log("parameter values as specified in curly brackets. If the named module already\n"); log("exists, it is reused.\n"); log("\n"); + log("If the template contains the special string '{%unused}', the command tracks\n"); + log("unused output ports -- specialized wrapper modules will be generated per every\n"); + log("set of unused ports as appearing on a selected cell.\n"); + log("\n"); log(" -setattr \n"); log(" set the given boolean attribute on each created wrapper module\n"); log("\n"); @@ -114,35 +187,80 @@ struct WrapcellPass : Pass { CellTypes ct; ct.setup(); + bool tracking_unused = has_fmt_field(name_fmt, "%unused"); + for (auto module : d->selected_modules()) { + SigPool unused; + + for (auto wire : module->wires()) + if (wire->has_attribute(ID::unused_bits)) { + std::string str = wire->get_string_attribute(ID::unused_bits); + for (auto it = str.begin(); it != str.end();) { + auto sep = it; + for (; sep != str.end() && *sep != ' '; sep++); + unused.add(SigBit(wire, std::stoi(std::string(it, sep)))); + for (it = sep; it != str.end() && *it == ' '; it++); + } + } + for (auto cell : module->selected_cells()) { - std::optional unescaped_name = format(name_fmt, cell->parameters); + Module *subm; + Cell *subcell; + + if (!ct.cell_known(cell->type)) + log_error("Non-internal cell type '%s' on cell '%s' in module '%s' unsupported\n", + log_id(cell->type), log_id(cell), log_id(module)); + + std::vector> unused_outputs, used_outputs; + for (auto conn : cell->connections()) { + if (ct.cell_output(cell->type, conn.first)) + for (int i = 0; i < conn.second.size(); i++) { + if (tracking_unused && unused.check(conn.second[i])) + unused_outputs.emplace_back(conn.first, i); + else + used_outputs.emplace_back(conn.first, i); + } + } + + ContextData context; + if (!unused_outputs.empty()) { + context.unused_outputs += "_unused"; + for (auto chunk : collect_chunks(unused_outputs)) + context.unused_outputs += "_" + RTLIL::unescape_id(chunk.format(cell)); + } + + std::optional unescaped_name = format(name_fmt, cell->parameters, context); if (!unescaped_name) log_error("Formatting error when processing cell '%s' in module '%s'\n", log_id(cell), log_id(module)); IdString name = RTLIL::escape_id(unescaped_name.value()); + if (d->module(name)) + goto replace_cell; - if (d->module(name)) { - cell->type = name; - cell->parameters.clear(); - continue; + subm = d->addModule(name); + subcell = subm->addCell("$1", cell->type); + for (auto conn : cell->connections()) { + if (ct.cell_output(cell->type, conn.first)) { + subcell->setPort(conn.first, SigSpec(RTLIL::Sm, conn.second.size())); + } else { + Wire *w = subm->addWire(conn.first, conn.second.size()); + w->port_input = true; + subcell->setPort(conn.first, w); + } } - if (!ct.cell_known(cell->type)) - log_error("Non-internal cell type '%s' on cell '%s' in module '%s' unsupported\n", - log_id(cell->type), log_id(cell), log_id(module)); + for (auto chunk : collect_chunks(used_outputs)) { + Wire *w = subm->addWire(chunk.format(cell), chunk.len); + w->port_output = true; + subcell->connections_[chunk.port].replace(chunk.base, w); + } - Module *subm = d->addModule(name); - Cell *subcell = subm->addCell("$1", cell->type); - for (auto conn : cell->connections()) { - Wire *w = subm->addWire(conn.first, conn.second.size()); - if (ct.cell_output(cell->type, w->name)) - w->port_output = true; - else - w->port_input = true; - subcell->setPort(conn.first, w); + for (auto chunk : collect_chunks(unused_outputs)) { + Wire *w = subm->addWire(chunk.format(cell), chunk.len); + subcell->connections_[chunk.port].replace(chunk.base, w); } + subcell->parameters = cell->parameters; subm->fixup_ports(); @@ -150,7 +268,7 @@ struct WrapcellPass : Pass { if (rule.value_fmt.empty()) { subm->set_bool_attribute(rule.name); } else { - std::optional value = format(rule.value_fmt, cell->parameters); + std::optional value = format(rule.value_fmt, cell->parameters, context); if (!value) log_error("Formatting error when processing cell '%s' in module '%s'\n", @@ -160,8 +278,20 @@ struct WrapcellPass : Pass { } } - cell->type = name; + replace_cell: cell->parameters.clear(); + + dict new_connections; + + for (auto conn : cell->connections()) + if (!ct.cell_output(cell->type, conn.first)) + new_connections[conn.first] = conn.second; + + for (auto chunk : collect_chunks(used_outputs)) + new_connections[chunk.format(cell)] = chunk.sample(cell); + + cell->type = name; + cell->connections_ = new_connections; } } } diff --git a/tests/various/wrapcell.ys b/tests/various/wrapcell.ys index 1c8f62ec7ad..6e0a457ca52 100644 --- a/tests/various/wrapcell.ys +++ b/tests/various/wrapcell.ys @@ -23,3 +23,33 @@ select -assert-count 1 top/t:OR_3_4_4 select -assert-none top/t:OR_2_3_3 top/t:OR_3_4_4 %% top/t:* %D select -assert-mod-count 2 OR_2_3_3 OR_3_4_4 select -assert-mod-count 2 A:bar=w3 A:bar=w4 + +design -reset +read_verilog < Date: Mon, 9 Dec 2024 15:39:28 +0100 Subject: [PATCH 2/4] wrapcell: Fix help --- passes/cmds/wrapcell.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/passes/cmds/wrapcell.cc b/passes/cmds/wrapcell.cc index 6d8e87b4370..420b4ecb513 100644 --- a/passes/cmds/wrapcell.cc +++ b/passes/cmds/wrapcell.cc @@ -137,9 +137,9 @@ struct WrapcellPass : Pass { log("parameter values as specified in curly brackets. If the named module already\n"); log("exists, it is reused.\n"); log("\n"); - log("If the template contains the special string '{%unused}', the command tracks\n"); + log("If the template contains the special string '{%%unused}', the command tracks\n"); log("unused output ports -- specialized wrapper modules will be generated per every\n"); - log("set of unused ports as appearing on a selected cell.\n"); + log("distinct set of unused port bits as appearing on any selected cell.\n"); log("\n"); log(" -setattr \n"); log(" set the given boolean attribute on each created wrapper module\n"); From 3cd01a57cde40a4d69c374495dbd81fab4f3acc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Povi=C5=A1er?= Date: Tue, 10 Dec 2024 15:12:42 +0100 Subject: [PATCH 3/4] wrapcell: Add comments, const qualifier --- passes/cmds/wrapcell.cc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/passes/cmds/wrapcell.cc b/passes/cmds/wrapcell.cc index 420b4ecb513..0c15848e429 100644 --- a/passes/cmds/wrapcell.cc +++ b/passes/cmds/wrapcell.cc @@ -48,7 +48,7 @@ struct ContextData { }; std::optional format(std::string fmt, const dict ¶meters, - ContextData &context) + const ContextData &context) { std::stringstream result; @@ -108,6 +108,7 @@ struct Chunk { } }; +// Joins contiguous runs of bits into a 'Chunk' std::vector collect_chunks(std::vector> bits) { std::vector ret; @@ -242,6 +243,7 @@ struct WrapcellPass : Pass { subcell = subm->addCell("$1", cell->type); for (auto conn : cell->connections()) { if (ct.cell_output(cell->type, conn.first)) { + // Insert marker bits as placehodlers which need to be replaced subcell->setPort(conn.first, SigSpec(RTLIL::Sm, conn.second.size())); } else { Wire *w = subm->addWire(conn.first, conn.second.size()); From 48c8d70a45d2a914b909ac301fdcd6ecdd61aed3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Povi=C5=A1er?= Date: Tue, 10 Dec 2024 15:13:10 +0100 Subject: [PATCH 4/4] wrapcell: Test `check -assert` post wrapping --- tests/various/wrapcell.ys | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/various/wrapcell.ys b/tests/various/wrapcell.ys index 6e0a457ca52..18325f573f9 100644 --- a/tests/various/wrapcell.ys +++ b/tests/various/wrapcell.ys @@ -18,6 +18,7 @@ EOF wreduce wrapcell -setattr foo -formatattr bar w{Y_WIDTH} -name OR_{A_WIDTH}_{B_WIDTH}_{Y_WIDTH} +check -assert select -assert-count 2 top/t:OR_2_3_3 select -assert-count 1 top/t:OR_3_4_4 select -assert-none top/t:OR_2_3_3 top/t:OR_3_4_4 %% top/t:* %D @@ -47,6 +48,7 @@ EOF opt_clean wreduce wrapcell -setattr foo -formatattr bar w{Y_WIDTH} -name OR_{A_WIDTH}_{B_WIDTH}_{Y_WIDTH}{%unused} +check -assert select -assert-count 1 top/t:OR_2_3_3 select -assert-count 1 top/t:OR_2_3_3_unused_Y[1] select -assert-count 1 top/t:OR_3_4_4