mirror of
				https://github.com/YosysHQ/yosys
				synced 2025-11-03 21:09:12 +00:00 
			
		
		
		
	Add opt_ffinv pass.
This commit is contained in:
		
							parent
							
								
									f56a3bd48f
								
							
						
					
					
						commit
						2858bb03cd
					
				
					 4 changed files with 268 additions and 3 deletions
				
			
		| 
						 | 
				
			
			@ -19,6 +19,7 @@ OBJS += passes/opt/opt_demorgan.o
 | 
			
		|||
OBJS += passes/opt/rmports.o
 | 
			
		||||
OBJS += passes/opt/opt_lut.o
 | 
			
		||||
OBJS += passes/opt/opt_lut_ins.o
 | 
			
		||||
OBJS += passes/opt/opt_ffinv.o
 | 
			
		||||
OBJS += passes/opt/pmux2shiftx.o
 | 
			
		||||
OBJS += passes/opt/muxpack.o
 | 
			
		||||
endif
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										255
									
								
								passes/opt/opt_ffinv.cc
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										255
									
								
								passes/opt/opt_ffinv.cc
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,255 @@
 | 
			
		|||
/*
 | 
			
		||||
 *  yosys -- Yosys Open SYnthesis Suite
 | 
			
		||||
 *
 | 
			
		||||
 *  Copyright (C) 2022  Marcelina Kościelnicka <mwk@0x04.net>
 | 
			
		||||
 *
 | 
			
		||||
 *  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/modtools.h"
 | 
			
		||||
#include "kernel/ffinit.h"
 | 
			
		||||
#include "kernel/ff.h"
 | 
			
		||||
 | 
			
		||||
USING_YOSYS_NAMESPACE
 | 
			
		||||
PRIVATE_NAMESPACE_BEGIN
 | 
			
		||||
 | 
			
		||||
struct OptFfInvWorker
 | 
			
		||||
{
 | 
			
		||||
	int count = 0;
 | 
			
		||||
	RTLIL::Module *module;
 | 
			
		||||
	ModWalker walker;
 | 
			
		||||
	FfInitVals initvals;
 | 
			
		||||
 | 
			
		||||
	// Case 1:
 | 
			
		||||
	// - FF is driven by inverter
 | 
			
		||||
	// - ... which has no other users
 | 
			
		||||
	// - all users of FF are LUTs
 | 
			
		||||
	bool push_d_inv(FfData &ff) {
 | 
			
		||||
		pool<SigBit> dummy;
 | 
			
		||||
 | 
			
		||||
		if (walker.get_inputs(dummy, ff.sig_d))
 | 
			
		||||
			return false;
 | 
			
		||||
		if (walker.get_outputs(dummy, ff.sig_d))
 | 
			
		||||
			return false;
 | 
			
		||||
		pool<ModWalker::PortBit> d_drivers;
 | 
			
		||||
		walker.get_drivers(d_drivers, ff.sig_d);
 | 
			
		||||
		if (d_drivers.size() != 1)
 | 
			
		||||
			return false;
 | 
			
		||||
		Cell *d_inv = nullptr;
 | 
			
		||||
		for (auto &driver: d_drivers) {
 | 
			
		||||
			if (driver.cell->type.in(ID($not), ID($_NOT_))) {
 | 
			
		||||
				// OK
 | 
			
		||||
			} else if (driver.cell->type.in(ID($lut))) {
 | 
			
		||||
				if (driver.cell->getParam(ID::WIDTH) != 1)
 | 
			
		||||
					return false;
 | 
			
		||||
				if (driver.cell->getParam(ID::LUT).as_int() != 1)
 | 
			
		||||
					return false;
 | 
			
		||||
			} else {
 | 
			
		||||
				return false;
 | 
			
		||||
			}
 | 
			
		||||
			d_inv = driver.cell;
 | 
			
		||||
		}
 | 
			
		||||
		pool<ModWalker::PortBit> d_consumers;
 | 
			
		||||
		walker.get_consumers(d_consumers, ff.sig_d);
 | 
			
		||||
		if (d_consumers.size() != 1)
 | 
			
		||||
			return false;
 | 
			
		||||
 | 
			
		||||
		if (walker.get_outputs(dummy, ff.sig_q))
 | 
			
		||||
			return false;
 | 
			
		||||
		pool<Cell *> q_luts;
 | 
			
		||||
		pool<ModWalker::PortBit> q_consumers;
 | 
			
		||||
		walker.get_consumers(q_consumers, ff.sig_q);
 | 
			
		||||
		for (auto &consumer: q_consumers) {
 | 
			
		||||
			if (!consumer.cell->type.in(ID($not), ID($_NOT_), ID($lut)))
 | 
			
		||||
				return false;
 | 
			
		||||
			q_luts.insert(consumer.cell);
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		ff.flip_rst_bits({0});
 | 
			
		||||
		ff.sig_d = d_inv->getPort(ID::A);
 | 
			
		||||
 | 
			
		||||
		for (Cell *lut: q_luts) {
 | 
			
		||||
			if (lut->type == ID($lut)) {
 | 
			
		||||
				int flip_mask = 0;
 | 
			
		||||
				SigSpec sig_a = lut->getPort(ID::A);
 | 
			
		||||
				for (int i = 0; i < GetSize(sig_a); i++) {
 | 
			
		||||
					if (walker.sigmap(sig_a[i]) == walker.sigmap(ff.sig_q)) {
 | 
			
		||||
						flip_mask |= 1 << i;
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
				Const mask = lut->getParam(ID::LUT);
 | 
			
		||||
				Const new_mask;
 | 
			
		||||
				for (int j = 0; j < (1 << GetSize(sig_a)); j++) {
 | 
			
		||||
					new_mask.bits.push_back(mask.bits[j ^ flip_mask]);
 | 
			
		||||
				}
 | 
			
		||||
				if (GetSize(sig_a) == 1 && new_mask.as_int() == 2) {
 | 
			
		||||
					module->connect(lut->getPort(ID::Y), ff.sig_q);
 | 
			
		||||
					module->remove(lut);
 | 
			
		||||
				} else {
 | 
			
		||||
					lut->setParam(ID::LUT, new_mask);
 | 
			
		||||
				}
 | 
			
		||||
			} else {
 | 
			
		||||
				// it was an inverter
 | 
			
		||||
				module->connect(lut->getPort(ID::Y), ff.sig_q);
 | 
			
		||||
				module->remove(lut);
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		ff.emit();
 | 
			
		||||
		return true;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// Case 2:
 | 
			
		||||
	// - FF is driven by LUT
 | 
			
		||||
	// - ... which has no other users
 | 
			
		||||
	// - FF has one user
 | 
			
		||||
	// - ... which is an inverter
 | 
			
		||||
	bool push_q_inv(FfData &ff) {
 | 
			
		||||
		pool<SigBit> dummy;
 | 
			
		||||
 | 
			
		||||
		if (walker.get_inputs(dummy, ff.sig_d))
 | 
			
		||||
			return false;
 | 
			
		||||
		if (walker.get_outputs(dummy, ff.sig_d))
 | 
			
		||||
			return false;
 | 
			
		||||
 | 
			
		||||
		Cell *d_lut = nullptr;
 | 
			
		||||
		pool<ModWalker::PortBit> d_drivers;
 | 
			
		||||
		walker.get_drivers(d_drivers, ff.sig_d);
 | 
			
		||||
		if (d_drivers.size() != 1)
 | 
			
		||||
			return false;
 | 
			
		||||
		for (auto &driver: d_drivers) {
 | 
			
		||||
			if (!driver.cell->type.in(ID($not), ID($_NOT_), ID($lut)))
 | 
			
		||||
				return false;
 | 
			
		||||
			d_lut = driver.cell;
 | 
			
		||||
		}
 | 
			
		||||
		pool<ModWalker::PortBit> d_consumers;
 | 
			
		||||
		walker.get_consumers(d_consumers, ff.sig_d);
 | 
			
		||||
		if (d_consumers.size() != 1)
 | 
			
		||||
			return false;
 | 
			
		||||
 | 
			
		||||
		if (walker.get_outputs(dummy, ff.sig_q))
 | 
			
		||||
			return false;
 | 
			
		||||
		pool<ModWalker::PortBit> q_consumers;
 | 
			
		||||
		walker.get_consumers(q_consumers, ff.sig_q);
 | 
			
		||||
		if (q_consumers.size() != 1)
 | 
			
		||||
			return false;
 | 
			
		||||
		Cell *q_inv = nullptr;
 | 
			
		||||
		for (auto &consumer: q_consumers) {
 | 
			
		||||
			if (consumer.cell->type.in(ID($not), ID($_NOT_))) {
 | 
			
		||||
				// OK
 | 
			
		||||
			} else if (consumer.cell->type.in(ID($lut))) {
 | 
			
		||||
				if (consumer.cell->getParam(ID::WIDTH) != 1)
 | 
			
		||||
					return false;
 | 
			
		||||
				if (consumer.cell->getParam(ID::LUT).as_int() != 1)
 | 
			
		||||
					return false;
 | 
			
		||||
			} else {
 | 
			
		||||
				return false;
 | 
			
		||||
			}
 | 
			
		||||
			q_inv = consumer.cell;
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		ff.flip_rst_bits({0});
 | 
			
		||||
		ff.sig_q = q_inv->getPort(ID::Y);
 | 
			
		||||
		module->remove(q_inv);
 | 
			
		||||
 | 
			
		||||
		if (d_lut->type == ID($lut)) {
 | 
			
		||||
			Const mask = d_lut->getParam(ID::LUT);
 | 
			
		||||
			Const new_mask;
 | 
			
		||||
			for (int i = 0; i < GetSize(mask); i++) {
 | 
			
		||||
				if (mask.bits[i] == State::S0)
 | 
			
		||||
					new_mask.bits.push_back(State::S1);
 | 
			
		||||
				else
 | 
			
		||||
					new_mask.bits.push_back(State::S0);
 | 
			
		||||
			}
 | 
			
		||||
			d_lut->setParam(ID::LUT, new_mask);
 | 
			
		||||
			if (d_lut->getParam(ID::WIDTH) == 1 && new_mask.as_int() == 2) {
 | 
			
		||||
				module->connect(ff.sig_d, d_lut->getPort(ID::A));
 | 
			
		||||
				module->remove(d_lut);
 | 
			
		||||
			}
 | 
			
		||||
		} else {
 | 
			
		||||
			// it was an inverter
 | 
			
		||||
			module->connect(ff.sig_d, d_lut->getPort(ID::A));
 | 
			
		||||
			module->remove(d_lut);
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		ff.emit();
 | 
			
		||||
		return true;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	OptFfInvWorker(RTLIL::Module *module) :
 | 
			
		||||
		module(module), walker(module->design, module), initvals(&walker.sigmap, module)
 | 
			
		||||
	{
 | 
			
		||||
		log("Discovering LUTs.\n");
 | 
			
		||||
 | 
			
		||||
		for (Cell *cell : module->selected_cells()) {
 | 
			
		||||
			if (!RTLIL::builtin_ff_cell_types().count(cell->type))
 | 
			
		||||
				continue;
 | 
			
		||||
 | 
			
		||||
			FfData ff(&initvals, cell);
 | 
			
		||||
			if (ff.has_sr)
 | 
			
		||||
				continue;
 | 
			
		||||
			if (!ff.has_clk)
 | 
			
		||||
				continue;
 | 
			
		||||
			if (ff.has_aload)
 | 
			
		||||
				continue;
 | 
			
		||||
			if (ff.width != 1)
 | 
			
		||||
				continue;
 | 
			
		||||
 | 
			
		||||
			if (push_d_inv(ff)) {
 | 
			
		||||
				count++;
 | 
			
		||||
			} else if (push_q_inv(ff)) {
 | 
			
		||||
				count++;
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
struct OptFfInvPass : public Pass {
 | 
			
		||||
	OptFfInvPass() : Pass("opt_ffinv", "push inverters through FFs") { }
 | 
			
		||||
	void help() override
 | 
			
		||||
	{
 | 
			
		||||
		//   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
 | 
			
		||||
		log("\n");
 | 
			
		||||
		log("    opt_ffinv [selection]\n");
 | 
			
		||||
		log("\n");
 | 
			
		||||
		log("This pass pushes inverters to the other side of a FF when they can be merged\n");
 | 
			
		||||
		log("into LUTs on the other side.\n");
 | 
			
		||||
		log("\n");
 | 
			
		||||
	}
 | 
			
		||||
	void execute(std::vector<std::string> args, RTLIL::Design *design) override
 | 
			
		||||
	{
 | 
			
		||||
		log_header(design, "Executing OPT_FFINV pass (push inverters through FFs).\n");
 | 
			
		||||
 | 
			
		||||
		size_t argidx;
 | 
			
		||||
		for (argidx = 1; argidx < args.size(); argidx++)
 | 
			
		||||
		{
 | 
			
		||||
			break;
 | 
			
		||||
		}
 | 
			
		||||
		extra_args(args, argidx, design);
 | 
			
		||||
 | 
			
		||||
		int total_count = 0;
 | 
			
		||||
		for (auto module : design->selected_modules())
 | 
			
		||||
		{
 | 
			
		||||
			OptFfInvWorker worker(module);
 | 
			
		||||
			total_count += worker.count;
 | 
			
		||||
		}
 | 
			
		||||
		if (total_count)
 | 
			
		||||
			design->scratchpad_set_bool("opt.did_something", true);
 | 
			
		||||
		log("Pushed %d inverters.\n", total_count);
 | 
			
		||||
	}
 | 
			
		||||
} OptFfInvPass;
 | 
			
		||||
 | 
			
		||||
PRIVATE_NAMESPACE_END
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue