yosys/passes/silimate/sat_clockgate.cc

914 lines
29 KiB
C++
Raw Normal View History

2026-02-10 23:33:37 +01:00
/*
* yosys -- Yosys Open SYnthesis Suite
*
* Copyright (C) 2024 Silimate Inc.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include "kernel/yosys.h"
#include "kernel/sigtools.h"
#include "kernel/ff.h"
2026-02-11 20:02:15 +01:00
#include "kernel/satgen.h"
2026-02-13 01:12:50 +01:00
#include <queue>
#include <algorithm>
#include <fstream>
#include <random>
2026-02-10 23:33:37 +01:00
USING_YOSYS_NAMESPACE
PRIVATE_NAMESPACE_BEGIN
// Profile all flip-flops and write to file
void profileFlipFlops(Module *module, const std::string &filename, const std::string &label)
{
std::ofstream out(filename, std::ios::app);
out << "\n=== " << label << " ===\n";
out << "Module: " << log_id(module) << "\n\n";
int total_ffs = 0;
int ffs_with_ce = 0;
int ffs_with_arst = 0;
int ffs_with_srst = 0;
int total_bits = 0;
int bits_with_ce = 0;
for (auto cell : module->cells()) {
if (!cell->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_), ID($_DFFE_PP_),
ID($_DFFE_PN_), ID($_DFFE_NP_), ID($_DFFE_NN_)))
continue;
FfData ff(nullptr, cell);
total_ffs++;
total_bits += ff.width;
out << "FF: " << log_id(cell) << "\n";
out << " type: " << log_id(cell->type) << "\n";
out << " width: " << ff.width << "\n";
out << " has_clk: " << (ff.has_clk ? "yes" : "no") << "\n";
out << " has_ce: " << (ff.has_ce ? "yes" : "no");
if (ff.has_ce) {
out << " (sig_ce: " << log_signal(ff.sig_ce) << ", pol: " << (ff.pol_ce ? "active-high" : "active-low") << ")";
ffs_with_ce++;
bits_with_ce += ff.width;
}
out << "\n";
out << " has_arst: " << (ff.has_arst ? "yes" : "no");
if (ff.has_arst) {
out << " (sig_arst: " << log_signal(ff.sig_arst) << ")";
ffs_with_arst++;
}
out << "\n";
out << " has_srst: " << (ff.has_srst ? "yes" : "no");
if (ff.has_srst) {
out << " (sig_srst: " << log_signal(ff.sig_srst) << ")";
ffs_with_srst++;
}
out << "\n";
out << " sig_clk: " << log_signal(ff.sig_clk) << "\n";
out << " sig_d: " << log_signal(ff.sig_d) << "\n";
out << " sig_q: " << log_signal(ff.sig_q) << "\n";
out << "\n";
}
out << "--- Summary ---\n";
out << "Total FFs: " << total_ffs << "\n";
out << "Total bits: " << total_bits << "\n";
out << "FFs with CE: " << ffs_with_ce << " (" << (total_ffs ? 100*ffs_with_ce/total_ffs : 0) << "%)\n";
out << "Bits with CE: " << bits_with_ce << " (" << (total_bits ? 100*bits_with_ce/total_bits : 0) << "%)\n";
out << "FFs with ARST: " << ffs_with_arst << "\n";
out << "FFs with SRST: " << ffs_with_srst << "\n";
out << "\n";
out.close();
}
2026-02-13 01:12:50 +01:00
// Configuration
static const int DEFAULT_MAX_COVER = 100; // Max candidate signals to consider
static const int DEFAULT_MIN_REGS = 10; // Min registers per clock gate
2026-02-13 01:12:50 +01:00
static const int DEFAULT_SIM_ITERATIONS = 10; // Random simulation iterations for pruning
2026-02-11 20:02:15 +01:00
struct SatClockgateWorker
{
Module *module;
SigMap sigmap;
2026-02-13 01:12:50 +01:00
// Configuration
int max_cover;
int min_regs;
int sim_iterations;
2026-02-11 20:02:15 +01:00
// Maps output signal bits to their driver cells
dict<SigBit, Cell*> sig_to_driver;
2026-02-13 01:12:50 +01:00
// Maps cell input pins to their source signals
dict<SigBit, pool<Cell*>> sig_to_sinks;
2026-02-12 21:14:25 +01:00
// SAT solver and generator - created once per module
ezSatPtr ez;
SatGen satgen;
// Simulation infrastructure
std::vector<Cell*> topo_order; // Cells in topological order for simulation
std::mt19937 rng; // Random number generator
2026-02-13 01:12:50 +01:00
// Statistics
int accepted_count = 0;
int rejected_sim_count = 0;
int rejected_sat_count = 0;
SatClockgateWorker(Module *module, int max_cover, int min_regs, int sim_iterations)
: module(module), sigmap(module),
max_cover(max_cover), min_regs(min_regs), sim_iterations(sim_iterations),
ez(), satgen(ez.get(), &sigmap), rng(42)
2026-02-11 20:02:15 +01:00
{
2026-02-13 01:12:50 +01:00
// Build driver and sink maps
2026-02-11 20:02:15 +01:00
for (auto cell : module->cells()) {
for (auto &conn : cell->connections()) {
if (cell->output(conn.first)) {
for (auto bit : sigmap(conn.second))
2026-02-13 01:12:50 +01:00
if (bit.wire)
sig_to_driver[bit] = cell;
}
if (cell->input(conn.first)) {
for (auto bit : sigmap(conn.second))
if (bit.wire)
sig_to_sinks[bit].insert(cell);
2026-02-11 20:02:15 +01:00
}
}
}
2026-02-13 01:12:50 +01:00
2026-02-12 21:14:25 +01:00
// Import all cells once - circuit constraints are permanent
for (auto cell : module->cells())
2026-02-13 01:12:50 +01:00
if (!cell->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_), ID($_DFFE_PP_),
ID($_DFFE_PN_), ID($_DFFE_NP_), ID($_DFFE_NN_)))
satgen.importCell(cell);
// Build topological order for simulation
buildTopoOrder();
}
// Build topological order of combinational cells for simulation
void buildTopoOrder()
{
dict<Cell*, int> cell_deps; // Number of unresolved input dependencies
dict<SigBit, pool<Cell*>> bit_to_cells; // Which cells need this bit
for (auto cell : module->cells()) {
// Skip FFs
if (cell->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_), ID($_DFFE_PP_),
ID($_DFFE_PN_), ID($_DFFE_NP_), ID($_DFFE_NN_)))
continue;
int deps = 0;
for (auto &conn : cell->connections()) {
if (cell->input(conn.first)) {
for (auto bit : sigmap(conn.second)) {
if (bit.wire && sig_to_driver.count(bit)) {
Cell *driver = sig_to_driver[bit];
if (!driver->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_))) {
deps++;
bit_to_cells[bit].insert(cell);
}
}
}
}
}
cell_deps[cell] = deps;
}
// Kahn's algorithm
std::queue<Cell*> ready;
for (auto &[cell, deps] : cell_deps) {
if (deps == 0)
ready.push(cell);
}
while (!ready.empty()) {
Cell *cell = ready.front();
ready.pop();
topo_order.push_back(cell);
// Decrement deps for cells that depend on this cell's outputs
for (auto &conn : cell->connections()) {
if (cell->output(conn.first)) {
for (auto bit : sigmap(conn.second)) {
for (auto sink : bit_to_cells[bit]) {
if (--cell_deps[sink] == 0)
ready.push(sink);
}
}
}
}
}
}
// Evaluate a single cell given current simulation values
void evaluateCell(Cell *cell, dict<SigBit, bool> &sim_values)
{
auto getSigVal = [&](SigSpec sig) -> std::vector<bool> {
std::vector<bool> vals;
for (auto bit : sigmap(sig)) {
if (bit.wire) {
vals.push_back(sim_values.count(bit) ? sim_values[bit] : false);
} else {
vals.push_back(bit.data == State::S1);
}
}
return vals;
};
auto setSigVal = [&](SigSpec sig, const std::vector<bool> &vals) {
int i = 0;
for (auto bit : sigmap(sig)) {
if (bit.wire && i < (int)vals.size())
sim_values[bit] = vals[i];
i++;
}
};
if (cell->type == ID($not) || cell->type == ID($_NOT_)) {
auto a = getSigVal(cell->getPort(ID::A));
std::vector<bool> y(a.size());
for (size_t i = 0; i < a.size(); i++)
y[i] = !a[i];
setSigVal(cell->getPort(ID::Y), y);
}
else if (cell->type == ID($and) || cell->type == ID($_AND_)) {
auto a = getSigVal(cell->getPort(ID::A));
auto b = getSigVal(cell->getPort(ID::B));
std::vector<bool> y(std::max(a.size(), b.size()));
for (size_t i = 0; i < y.size(); i++)
y[i] = (i < a.size() ? a[i] : false) && (i < b.size() ? b[i] : false);
setSigVal(cell->getPort(ID::Y), y);
}
else if (cell->type == ID($or) || cell->type == ID($_OR_)) {
auto a = getSigVal(cell->getPort(ID::A));
auto b = getSigVal(cell->getPort(ID::B));
std::vector<bool> y(std::max(a.size(), b.size()));
for (size_t i = 0; i < y.size(); i++)
y[i] = (i < a.size() ? a[i] : false) || (i < b.size() ? b[i] : false);
setSigVal(cell->getPort(ID::Y), y);
}
else if (cell->type == ID($xor) || cell->type == ID($_XOR_)) {
auto a = getSigVal(cell->getPort(ID::A));
auto b = getSigVal(cell->getPort(ID::B));
std::vector<bool> y(std::max(a.size(), b.size()));
for (size_t i = 0; i < y.size(); i++)
y[i] = (i < a.size() ? a[i] : false) != (i < b.size() ? b[i] : false);
setSigVal(cell->getPort(ID::Y), y);
}
else if (cell->type == ID($mux) || cell->type == ID($_MUX_)) {
auto a = getSigVal(cell->getPort(ID::A));
auto b = getSigVal(cell->getPort(ID::B));
auto s = getSigVal(cell->getPort(ID::S));
bool sel = s.empty() ? false : s[0];
setSigVal(cell->getPort(ID::Y), sel ? b : a);
}
else if (cell->type == ID($reduce_and)) {
auto a = getSigVal(cell->getPort(ID::A));
bool result = true;
for (auto v : a) result = result && v;
setSigVal(cell->getPort(ID::Y), {result});
}
else if (cell->type == ID($reduce_or)) {
auto a = getSigVal(cell->getPort(ID::A));
bool result = false;
for (auto v : a) result = result || v;
setSigVal(cell->getPort(ID::Y), {result});
}
else if (cell->type == ID($eq)) {
auto a = getSigVal(cell->getPort(ID::A));
auto b = getSigVal(cell->getPort(ID::B));
bool result = (a == b);
setSigVal(cell->getPort(ID::Y), {result});
}
else if (cell->type == ID($ne)) {
auto a = getSigVal(cell->getPort(ID::A));
auto b = getSigVal(cell->getPort(ID::B));
bool result = (a != b);
setSigVal(cell->getPort(ID::Y), {result});
}
// Add more cell types as needed - for now, unknown cells just pass through
}
// Run simulation with random inputs, check if gating_active & (D != Q) is ever true
// Returns false if counterexample found (candidate is definitely invalid)
bool simulationTest(const std::vector<SigBit> &conds, SigSpec sig_d, SigSpec sig_q, bool as_enable)
{
for (int iter = 0; iter < sim_iterations; iter++) {
dict<SigBit, bool> sim_values;
// Initialize all input ports and FF outputs with random values
for (auto wire : module->wires()) {
if (wire->port_input) {
for (int i = 0; i < wire->width; i++)
sim_values[SigBit(wire, i)] = (rng() & 1);
}
}
// Also randomize FF Q outputs (they're inputs to combinational logic)
for (auto cell : module->cells()) {
if (cell->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_), ID($_DFFE_PP_),
ID($_DFFE_PN_), ID($_DFFE_NP_), ID($_DFFE_NN_))) {
FfData ff(nullptr, cell);
for (auto bit : sigmap(ff.sig_q))
if (bit.wire)
sim_values[bit] = (rng() & 1);
}
}
// Propagate through combinational logic in topological order
for (auto cell : topo_order)
evaluateCell(cell, sim_values);
// Evaluate gating condition
bool combined_cond;
if (as_enable) {
// OR of conditions
combined_cond = false;
for (auto bit : conds) {
SigBit mapped = sigmap(bit);
if (sim_values.count(mapped) && sim_values[mapped])
combined_cond = true;
}
} else {
// AND of conditions
combined_cond = true;
for (auto bit : conds) {
SigBit mapped = sigmap(bit);
if (!sim_values.count(mapped) || !sim_values[mapped])
combined_cond = false;
}
}
bool gating_active = as_enable ? !combined_cond : combined_cond;
// Check D != Q
bool d_ne_q = false;
for (int i = 0; i < sig_d.size(); i++) {
SigBit d_bit = sigmap(sig_d[i]);
SigBit q_bit = sigmap(sig_q[i]);
bool d_val = sim_values.count(d_bit) ? sim_values[d_bit] : false;
bool q_val = sim_values.count(q_bit) ? sim_values[q_bit] : false;
if (d_val != q_val) {
d_ne_q = true;
break;
}
}
// If gating is active and D != Q, this is a counterexample
if (gating_active && d_ne_q) {
rejected_sim_count++;
return false;
}
}
return true; // No counterexample found
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Get downstream signals from a register (BFS forward through combinational logic)
pool<SigBit> getDownstreamSignals(Cell *reg, int limit)
{
2026-02-13 01:12:50 +01:00
pool<SigBit> visited;
std::queue<SigBit> worklist;
// Start from register output Q
FfData ff(nullptr, reg);
for (auto bit : sigmap(ff.sig_q)) {
if (bit.wire) {
worklist.push(bit);
visited.insert(bit);
}
}
2026-02-13 01:12:50 +01:00
while (!worklist.empty() && (int)visited.size() < limit) {
2026-02-13 01:12:50 +01:00
SigBit bit = worklist.front();
worklist.pop();
// Find cells driven by this signal
for (auto sink_cell : sig_to_sinks[bit]) {
// Skip registers - don't traverse through them
if (sink_cell->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_)))
continue;
// Add outputs of this cell to worklist
for (auto &conn : sink_cell->connections()) {
if (sink_cell->output(conn.first)) {
for (auto out_bit : sigmap(conn.second)) {
if (out_bit.wire && !visited.count(out_bit)) {
visited.insert(out_bit);
worklist.push(out_bit);
}
}
}
}
}
}
return visited;
}
2026-02-13 01:12:50 +01:00
// Get upstream signals feeding into given signals (BFS backward)
pool<SigBit> getUpstreamSignals(const pool<SigBit> &start_signals, int limit)
2026-02-11 20:02:15 +01:00
{
2026-02-13 01:12:50 +01:00
pool<SigBit> visited;
std::queue<SigBit> worklist;
for (auto bit : start_signals) {
worklist.push(bit);
visited.insert(bit);
}
while (!worklist.empty() && (int)visited.size() < limit) {
2026-02-13 01:12:50 +01:00
SigBit bit = worklist.front();
worklist.pop();
// Find driver cell
if (!sig_to_driver.count(bit))
continue;
Cell *driver = sig_to_driver[bit];
// Skip registers
if (driver->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_)))
continue;
// Add inputs of driver to worklist
for (auto &conn : driver->connections()) {
if (driver->input(conn.first)) {
for (auto in_bit : sigmap(conn.second)) {
if (in_bit.wire && !visited.count(in_bit)) {
visited.insert(in_bit);
worklist.push(in_bit);
}
}
2026-02-11 20:02:15 +01:00
}
}
}
2026-02-13 01:12:50 +01:00
return visited;
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Check if a candidate signal is a valid gating condition using SAT
// Safe gating check: sig=1 → D==Q (i.e., (sig ∧ (D≠Q)) is UNSAT)
bool isValidGatingSignal(SigBit candidate, SigSpec sig_d, SigSpec sig_q, bool as_enable)
2026-02-11 20:02:15 +01:00
{
2026-02-13 01:12:50 +01:00
std::vector<int> d_vec = satgen.importSigSpec(sig_d);
std::vector<int> q_vec = satgen.importSigSpec(sig_q);
int cand_var = satgen.importSigSpec(SigSpec(candidate))[0];
// D != Q
int d_ne_q = ez->vec_ne(d_vec, q_vec);
// For clock enable (active high): when enable=0, D must equal Q
// Check: (!enable ∧ (D≠Q)) is UNSAT
// For clock disable (active low): when disable=1, D must equal Q
// Check: (disable ∧ (D≠Q)) is UNSAT
int gating_active = as_enable ? ez->NOT(cand_var) : cand_var;
int query = ez->AND(gating_active, d_ne_q);
std::vector<int> assumptions = {query};
std::vector<int> dummy_exprs;
std::vector<bool> dummy_vals;
return !ez->solve(dummy_exprs, dummy_vals, assumptions);
}
// Binary search to minimize the gating condition set
// Tries to remove half of the signals at a time
void minimizeGatingCondition(
std::vector<SigBit> &good_conds,
std::vector<SigBit>::iterator begin,
std::vector<SigBit>::iterator end,
SigSpec sig_d, SigSpec sig_q, bool as_enable)
{
int half_len = (end - begin) / 2;
if (half_len == 0)
return;
auto mid = begin + half_len;
// Try removing [mid, end) from the condition
std::vector<SigBit> test_conds;
test_conds.insert(test_conds.end(), good_conds.begin(), begin);
test_conds.insert(test_conds.end(), begin, mid);
test_conds.insert(test_conds.end(), end, good_conds.end());
if (!test_conds.empty() && isValidGatingSet(test_conds, sig_d, sig_q, as_enable)) {
// Can remove [mid, end)
good_conds.erase(mid, end);
// Recurse on remaining half
minimizeGatingCondition(good_conds, begin, begin + half_len, sig_d, sig_q, as_enable);
} else {
// Cannot remove all of [mid, end), try to minimize each half
if (end - mid > 1)
minimizeGatingCondition(good_conds, mid, end, sig_d, sig_q, as_enable);
minimizeGatingCondition(good_conds, begin, mid, sig_d, sig_q, as_enable);
}
}
// Check if OR/AND of signals forms a valid gating condition
// Uses simulation first to quickly prune invalid candidates, then SAT to prove
2026-02-13 01:12:50 +01:00
bool isValidGatingSet(const std::vector<SigBit> &conds, SigSpec sig_d, SigSpec sig_q, bool as_enable)
{
if (conds.empty())
2026-02-11 20:02:15 +01:00
return false;
2026-02-13 01:12:50 +01:00
// Quick simulation filter first - catches most invalid candidates fast
if (!simulationTest(conds, sig_d, sig_q, as_enable)) {
log_debug(" Rejected by simulation\n");
return false;
}
// SAT only if simulation passes
2026-02-11 20:02:15 +01:00
std::vector<int> d_vec = satgen.importSigSpec(sig_d);
std::vector<int> q_vec = satgen.importSigSpec(sig_q);
2026-02-13 01:12:50 +01:00
// Build OR (for enable) or AND (for disable) of condition signals
std::vector<int> cond_vars;
for (auto bit : conds)
cond_vars.push_back(satgen.importSigSpec(SigSpec(bit))[0]);
int combined_cond;
if (as_enable) {
// Clock enable: OR of signals (any signal high = enable)
combined_cond = ez->expression(ezSAT::OpOr, cond_vars);
} else {
// Clock disable: AND of signals (all signals high = disable)
combined_cond = ez->expression(ezSAT::OpAnd, cond_vars);
}
2026-02-11 20:02:15 +01:00
int d_ne_q = ez->vec_ne(d_vec, q_vec);
2026-02-13 01:12:50 +01:00
// Safe gating: when gating is active (enable=0 or disable=1), D must equal Q
int gating_active = as_enable ? ez->NOT(combined_cond) : combined_cond;
int query = ez->AND(gating_active, d_ne_q);
2026-02-12 21:14:25 +01:00
std::vector<int> assumptions = {query};
2026-02-13 01:12:50 +01:00
std::vector<int> dummy_exprs;
std::vector<bool> dummy_vals;
2026-02-11 20:02:15 +01:00
bool is_valid = !ez->solve(dummy_exprs, dummy_vals, assumptions);
if (!is_valid)
rejected_sat_count++;
return is_valid;
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Find gating condition for a register
// Returns empty vector if no valid condition found
std::pair<std::vector<SigBit>, bool> findGatingCondition(Cell *reg)
2026-02-11 20:02:15 +01:00
{
2026-02-13 01:12:50 +01:00
FfData ff(nullptr, reg);
// Get candidate signals downstream of this register
pool<SigBit> downstream = getDownstreamSignals(reg, max_cover);
if (downstream.empty()) {
log_debug(" No downstream candidates for %s\n", log_id(reg));
return {{}, false};
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Also include upstream signals that could affect D
pool<SigBit> d_inputs;
for (auto bit : sigmap(ff.sig_d))
if (bit.wire)
d_inputs.insert(bit);
pool<SigBit> upstream = getUpstreamSignals(d_inputs, max_cover);
// Combine and limit candidates
std::vector<SigBit> candidates;
for (auto bit : downstream)
candidates.push_back(bit);
for (auto bit : upstream)
if (!downstream.count(bit))
candidates.push_back(bit);
if ((int)candidates.size() > max_cover)
candidates.resize(max_cover);
log_debug(" Found %zu candidate signals\n", candidates.size());
// Try as clock enable first (more common)
if (isValidGatingSet(candidates, ff.sig_d, ff.sig_q, true)) {
minimizeGatingCondition(candidates, candidates.begin(), candidates.end(),
ff.sig_d, ff.sig_q, true);
if (!candidates.empty()) {
return {candidates, true}; // true = clock enable
}
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Try as clock disable
if (isValidGatingSet(candidates, ff.sig_d, ff.sig_q, false)) {
minimizeGatingCondition(candidates, candidates.begin(), candidates.end(),
ff.sig_d, ff.sig_q, false);
if (!candidates.empty()) {
return {candidates, false}; // false = clock disable
2026-02-11 20:02:15 +01:00
}
}
2026-02-13 01:12:50 +01:00
return {{}, false};
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Insert clock gating logic for a group of registers
void insertClockGate(const std::vector<Cell*> &regs,
const std::vector<SigBit> &gating_conds,
bool as_enable)
2026-02-11 20:02:15 +01:00
{
2026-02-13 01:12:50 +01:00
if (regs.empty() || gating_conds.empty())
2026-02-11 20:02:15 +01:00
return;
2026-02-13 01:12:50 +01:00
log(" Inserting clock gate for %zu registers with %zu condition signals\n",
regs.size(), gating_conds.size());
// Build gating condition: OR for enable, AND for disable
SigBit gating_signal;
if (gating_conds.size() == 1) {
gating_signal = gating_conds[0];
2026-02-11 20:02:15 +01:00
} else {
2026-02-13 01:12:50 +01:00
SigSpec cond_inputs;
for (auto bit : gating_conds)
cond_inputs.append(bit);
Wire *cond_wire = module->addWire(NEW_ID);
if (as_enable)
module->addReduceOr(NEW_ID, cond_inputs, cond_wire);
else
module->addReduceAnd(NEW_ID, cond_inputs, cond_wire);
gating_signal = cond_wire;
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// If disable signal, invert to get enable
if (!as_enable) {
Wire *inv_wire = module->addWire(NEW_ID);
module->addNot(NEW_ID, gating_signal, inv_wire);
gating_signal = inv_wire;
2026-02-11 20:02:15 +01:00
}
2026-02-13 01:12:50 +01:00
// Add CE to each register
for (auto reg : regs) {
FfData ff(nullptr, reg);
if (ff.has_ce) {
// Already has CE, AND with new condition
Wire *combined_ce = module->addWire(NEW_ID);
module->addAnd(NEW_ID, ff.sig_ce, gating_signal, combined_ce);
ff.sig_ce = combined_ce;
} else {
ff.has_ce = true;
ff.sig_ce = gating_signal;
ff.pol_ce = true;
}
2026-02-11 20:02:15 +01:00
ff.emit();
}
}
2026-02-13 01:12:50 +01:00
// Check if register can be added to an existing gate (subset/superset matching)
// Returns true if the existing gate's condition is a valid gating condition for this register
bool canReuseGate(const std::vector<SigBit> &existing_conds, Cell *reg, bool is_enable)
{
FfData ff(nullptr, reg);
return isValidGatingSet(existing_conds, ff.sig_d, ff.sig_q, is_enable);
}
2026-02-13 01:12:50 +01:00
// Main processing function
void run()
{
log("Processing module %s\n", log_id(module));
// Collect all registers
std::vector<Cell*> registers;
for (auto cell : module->cells()) {
2026-02-13 01:12:50 +01:00
if (!cell->type.in(ID($ff), ID($dff), ID($dffe), ID($adff), ID($adffe),
ID($sdff), ID($sdffe), ID($sdffce), ID($dffsr),
ID($dffsre), ID($_DFF_P_), ID($_DFF_N_), ID($_DFFE_PP_),
ID($_DFFE_PN_), ID($_DFFE_NP_), ID($_DFFE_NN_)))
continue;
FfData ff(nullptr, cell);
// Skip registers that already have CE
if (ff.has_ce) {
log_debug(" Skipping %s: already has CE\n", log_id(cell));
continue;
}
if (!ff.has_clk) {
log_debug(" Skipping %s: no clock\n", log_id(cell));
continue;
}
registers.push_back(cell);
}
log(" Found %zu registers without CE\n", registers.size());
// Inverted index approach: net -> list of gate indices containing that net
// This allows finding subsets/supersets, not just exact matches
struct AcceptedGate {
std::vector<SigBit> conds;
pool<SigBit> cond_set; // For fast subset/superset checks
std::vector<Cell*> regs;
bool is_enable;
};
std::vector<AcceptedGate> accepted_gates;
dict<SigBit, std::vector<size_t>> net_to_accepted; // Inverted index
2026-02-13 01:12:50 +01:00
int processed = 0;
for (auto reg : registers) {
if (processed % 100 == 0 && processed > 0)
log(" Processed %d/%zu registers\n", processed, registers.size());
processed++;
log_debug("Processing register %s\n", log_id(reg));
auto [gating_conds, is_enable] = findGatingCondition(reg);
if (gating_conds.empty()) {
log_debug(" No valid gating condition found\n");
continue;
}
// Build set of condition signals for this register
pool<SigBit> cond_set;
2026-02-13 01:12:50 +01:00
for (auto bit : gating_conds)
cond_set.insert(bit);
// Find all accepted gates sharing any net with this register's condition
pool<size_t> candidate_gates;
for (auto bit : gating_conds) {
if (net_to_accepted.count(bit)) {
for (auto idx : net_to_accepted[bit])
candidate_gates.insert(idx);
}
}
2026-02-13 01:12:50 +01:00
// Try to find a compatible existing gate (SAT-verify each candidate)
bool found_match = false;
for (auto idx : candidate_gates) {
auto &gate = accepted_gates[idx];
// Must match enable/disable polarity
if (gate.is_enable != is_enable)
continue;
// Check if existing gate's condition works for this register
// This allows: gate condition {x,y} can work for register with {x,y,z}
// (existing is subset) or register with {x} (existing is superset)
if (canReuseGate(gate.conds, reg, is_enable)) {
gate.regs.push_back(reg);
log_debug(" Reusing existing gate %zu for %s (flexible match)\n",
idx, log_id(reg));
found_match = true;
break;
}
}
if (!found_match) {
// Create new accepted gate
size_t new_idx = accepted_gates.size();
accepted_gates.push_back({gating_conds, cond_set, {reg}, is_enable});
// Update inverted index
for (auto bit : gating_conds)
net_to_accepted[bit].push_back(new_idx);
log(" Found new gating condition for %s (%s)\n",
log_id(reg), is_enable ? "enable" : "disable");
}
}
2026-02-13 01:12:50 +01:00
// Insert clock gates for groups that meet minimum register threshold
int gates_inserted = 0;
for (auto &gate : accepted_gates) {
if ((int)gate.regs.size() >= min_regs) {
insertClockGate(gate.regs, gate.conds, gate.is_enable);
2026-02-13 01:12:50 +01:00
gates_inserted++;
accepted_count += gate.regs.size();
2026-02-13 01:12:50 +01:00
} else {
log_debug(" Skipping gating condition (only %zu registers, need %d)\n",
gate.regs.size(), min_regs);
2026-02-13 01:12:50 +01:00
}
}
log(" Inserted %d clock gates\n", gates_inserted);
log(" Statistics: accepted=%d, rejected_sim=%d, rejected_sat=%d\n",
accepted_count, rejected_sim_count, rejected_sat_count);
2026-02-14 01:34:15 +01:00
log(" SAT stats: literals=%d, expressions=%d\n",
ez->numLiterals(), ez->numExpressions());
}
2026-02-13 01:12:50 +01:00
};
2026-02-10 23:33:37 +01:00
struct SatClockgatePass : public Pass {
2026-02-13 01:12:50 +01:00
SatClockgatePass() : Pass("sat_clockgate", "SAT-based automatic clock gating") { }
2026-02-10 23:33:37 +01:00
void help() override
{
log("\n");
log(" sat_clockgate [options] [selection]\n");
log("\n");
2026-02-13 01:12:50 +01:00
log("This command performs SAT-based automatic clock gating insertion.\n");
log("It analyzes registers and uses SAT solving to find signals that can\n");
log("serve as clock enable conditions (when the signal is low, D==Q).\n");
2026-02-10 23:33:37 +01:00
log("\n");
2026-02-13 01:12:50 +01:00
log("Algorithm based on:\n");
log(" - \"Automatic Synthesis of Clock Gating Logic\" by Aaron P. Hurst\n");
log(" - OpenROAD's cgt module implementation\n");
log("\n");
log(" -max_cover <n>\n");
log(" maximum number of candidate signals to consider per register\n");
log(" (default: %d)\n", DEFAULT_MAX_COVER);
log("\n");
log(" -min_regs <n>\n");
log(" minimum number of registers that must share a gating condition\n");
log(" for a clock gate to be inserted (default: %d)\n", DEFAULT_MIN_REGS);
2026-02-10 23:33:37 +01:00
log("\n");
}
2026-02-13 01:12:50 +01:00
2026-02-10 23:33:37 +01:00
void execute(std::vector<std::string> args, RTLIL::Design *design) override
{
2026-02-13 01:12:50 +01:00
log_header(design, "Executing SAT_CLOCKGATE pass.\n");
int max_cover = DEFAULT_MAX_COVER;
int min_regs = DEFAULT_MIN_REGS;
int sim_iterations = DEFAULT_SIM_ITERATIONS;
std::vector<std::string> clockgate_args;
2026-02-13 01:12:50 +01:00
2026-02-10 23:33:37 +01:00
size_t argidx;
for (argidx = 1; argidx < args.size(); argidx++) {
2026-02-13 01:12:50 +01:00
if (args[argidx] == "-max_cover" && argidx+1 < args.size()) {
max_cover = std::stoi(args[++argidx]);
continue;
}
if (args[argidx] == "-min_regs" && argidx+1 < args.size()) {
min_regs = std::stoi(args[++argidx]);
continue;
}
// Pass remaining args to clockgate
if (args[argidx][0] == '-') {
clockgate_args.push_back(args[argidx]);
continue;
}
// Non-flag argument (value for previous flag)
clockgate_args.push_back(args[argidx]);
2026-02-10 23:33:37 +01:00
}
2026-02-13 01:12:50 +01:00
log("Configuration: max_cover=%d, min_regs=%d\n", max_cover, min_regs);
// Clear profile file and write header
std::ofstream clear_file("ff_profile.txt", std::ios::trunc);
clear_file << "Flip-Flop Profile Report\n";
clear_file << "========================\n";
clear_file.close();
2026-02-13 01:12:50 +01:00
int total_gates = 0;
2026-02-10 23:33:37 +01:00
for (auto module : design->selected_modules()) {
// Profile BEFORE clock gating
profileFlipFlops(module, "ff_profile.txt", "BEFORE sat_clockgate");
2026-02-13 01:12:50 +01:00
SatClockgateWorker worker(module, max_cover, min_regs, sim_iterations);
worker.run();
total_gates += worker.accepted_count;
// Profile AFTER clock gating
profileFlipFlops(module, "ff_profile.txt", "AFTER sat_clockgate");
2026-02-10 23:33:37 +01:00
}
2026-02-13 01:12:50 +01:00
log("Total clock gates inserted: %d\n", total_gates);
// Convert CEs to actual clock gate cells
std::string clockgate_cmd = "clockgate";
for (auto &arg : clockgate_args)
clockgate_cmd += " " + arg;
log("Calling clockgate with args: %s\n", clockgate_cmd);
Pass::call(design, clockgate_cmd);
2026-02-10 23:33:37 +01:00
}
} SatClockgatePass;
PRIVATE_NAMESPACE_END