passes/pmgen/test_pmgen.cc - third_party/yosys - Git at Google

 /*
  *  yosys -- Yosys Open SYnthesis Suite
  *
  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
  *
  *  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"

 USING_YOSYS_NAMESPACE
 PRIVATE_NAMESPACE_BEGIN

 #include "passes/pmgen/test_pmgen_pm.h"
 #include "passes/pmgen/ice40_dsp_pm.h"
 #include "passes/pmgen/xilinx_srl_pm.h"

 #include "generate.h"

 void reduce_chain(test_pmgen_pm &pm)
 {
 	auto &st = pm.st_reduce;
 	auto &ud = pm.ud_reduce;

 	if (ud.longest_chain.empty())
 		return;

 	log("Found chain of length %d (%s):\n", GetSize(ud.longest_chain), log_id(st.first->type));

 	SigSpec A;
 	SigSpec Y = ud.longest_chain.front().first->getPort(ID(Y));
 	auto last_cell = ud.longest_chain.back().first;

 	for (auto it : ud.longest_chain) {
 		auto cell = it.first;
 		if (cell == last_cell) {
 			A.append(cell->getPort(ID(A)));
 			A.append(cell->getPort(ID(B)));
 		} else {
 			A.append(cell->getPort(it.second == ID(A) ? ID(B) : ID(A)));
 		}
 		log("    %s\n", log_id(cell));
 		pm.autoremove(cell);
 	}

 	Cell *c;

 	if (last_cell->type == ID($_AND_))
 		c = pm.module->addReduceAnd(NEW_ID, A, Y);
 	else if (last_cell->type == ID($_OR_))
 		c = pm.module->addReduceOr(NEW_ID, A, Y);
 	else if (last_cell->type == ID($_XOR_))
 		c = pm.module->addReduceXor(NEW_ID, A, Y);
 	else
 		log_abort();

 	log("    -> %s (%s)\n", log_id(c), log_id(c->type));
 }

 void reduce_tree(test_pmgen_pm &pm)
 {
 	auto &st = pm.st_reduce;
 	auto &ud = pm.ud_reduce;

 	if (ud.longest_chain.empty())
 		return;

 	SigSpec A = ud.leaves;
 	SigSpec Y = st.first->getPort(ID(Y));
 	pm.autoremove(st.first);

 	log("Found %s tree with %d leaves for %s (%s).\n", log_id(st.first->type),
 			GetSize(A), log_signal(Y), log_id(st.first));

 	Cell *c;

 	if (st.first->type == ID($_AND_))
 		c = pm.module->addReduceAnd(NEW_ID, A, Y);
 	else if (st.first->type == ID($_OR_))
 		c = pm.module->addReduceOr(NEW_ID, A, Y);
 	else if (st.first->type == ID($_XOR_))
 		c = pm.module->addReduceXor(NEW_ID, A, Y);
 	else
 		log_abort();

 	log("    -> %s (%s)\n", log_id(c), log_id(c->type));
 }

 void opt_eqpmux(test_pmgen_pm &pm)
 {
 	auto &st = pm.st_eqpmux;

 	SigSpec Y = st.pmux->getPort(ID::Y);
 	int width = GetSize(Y);

 	SigSpec EQ = st.pmux->getPort(ID::B).extract(st.pmux_slice_eq*width, width);
 	SigSpec NE = st.pmux->getPort(ID::B).extract(st.pmux_slice_ne*width, width);

 	log("Found eqpmux circuit driving %s (eq=%s, ne=%s, pmux=%s).\n",
 			log_signal(Y), log_id(st.eq), log_id(st.ne), log_id(st.pmux));

 	pm.autoremove(st.pmux);
 	Cell *c = pm.module->addMux(NEW_ID, NE, EQ, st.eq->getPort(ID::Y), Y);
 	log("    -> %s (%s)\n", log_id(c), log_id(c->type));
 }

 struct TestPmgenPass : public Pass {
 	TestPmgenPass() : Pass("test_pmgen", "test pass for pmgen") { }
 	void help() YS_OVERRIDE
 	{
 		//   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
 		log("\n");
 		log("    test_pmgen -reduce_chain [options] [selection]\n");
 		log("\n");
 		log("Demo for recursive pmgen patterns. Map chains of AND/OR/XOR to $reduce_*.\n");
 		log("\n");

 		log("\n");
 		log("    test_pmgen -reduce_tree [options] [selection]\n");
 		log("\n");
 		log("Demo for recursive pmgen patterns. Map trees of AND/OR/XOR to $reduce_*.\n");
 		log("\n");

 		log("\n");
 		log("    test_pmgen -eqpmux [options] [selection]\n");
 		log("\n");
 		log("Demo for recursive pmgen patterns. Optimize EQ/NE/PMUX circuits.\n");
 		log("\n");

 		log("\n");
 		log("    test_pmgen -generate [options] <pattern_name>\n");
 		log("\n");
 		log("Create modules that match the specified pattern.\n");
 		log("\n");
 	}

 	void execute_reduce_chain(std::vector<std::string> args, RTLIL::Design *design)
 	{
 		log_header(design, "Executing TEST_PMGEN pass (-reduce_chain).\n");

 		size_t argidx;
 		for (argidx = 2; argidx < args.size(); argidx++)
 		{
 			// if (args[argidx] == "-singleton") {
 			// 	singleton_mode = true;
 			// 	continue;
 			// }
 			break;
 		}
 		extra_args(args, argidx, design);

 		for (auto module : design->selected_modules())
 			while (test_pmgen_pm(module, module->selected_cells()).run_reduce(reduce_chain)) {}
 	}

 	void execute_reduce_tree(std::vector<std::string> args, RTLIL::Design *design)
 	{
 		log_header(design, "Executing TEST_PMGEN pass (-reduce_tree).\n");

 		size_t argidx;
 		for (argidx = 2; argidx < args.size(); argidx++)
 		{
 			// if (args[argidx] == "-singleton") {
 			// 	singleton_mode = true;
 			// 	continue;
 			// }
 			break;
 		}
 		extra_args(args, argidx, design);

 		for (auto module : design->selected_modules())
 			test_pmgen_pm(module, module->selected_cells()).run_reduce(reduce_tree);
 	}

 	void execute_eqpmux(std::vector<std::string> args, RTLIL::Design *design)
 	{
 		log_header(design, "Executing TEST_PMGEN pass (-eqpmux).\n");

 		size_t argidx;
 		for (argidx = 2; argidx < args.size(); argidx++)
 		{
 			// if (args[argidx] == "-singleton") {
 			// 	singleton_mode = true;
 			// 	continue;
 			// }
 			break;
 		}
 		extra_args(args, argidx, design);

 		for (auto module : design->selected_modules())
 			test_pmgen_pm(module, module->selected_cells()).run_eqpmux(opt_eqpmux);
 	}

 	void execute_generate(std::vector<std::string> args, RTLIL::Design *design)
 	{
 		log_header(design, "Executing TEST_PMGEN pass (-generate).\n");

 		size_t argidx;
 		for (argidx = 2; argidx < args.size(); argidx++)
 		{
 			// if (args[argidx] == "-singleton") {
 			// 	singleton_mode = true;
 			// 	continue;
 			// }
 			break;
 		}

 		if (argidx+1 != args.size())
 			log_cmd_error("Expected exactly one pattern.\n");

 		string pattern = args[argidx];

 		if (pattern == "reduce")
 			return GENERATE_PATTERN(test_pmgen_pm, reduce);

 		if (pattern == "eqpmux")
 			return GENERATE_PATTERN(test_pmgen_pm, eqpmux);

 		if (pattern == "ice40_dsp")
 			return GENERATE_PATTERN(ice40_dsp_pm, ice40_dsp);

 		if (pattern == "xilinx_srl.fixed")
 			return GENERATE_PATTERN(xilinx_srl_pm, fixed);
 		if (pattern == "xilinx_srl.variable")
 			return GENERATE_PATTERN(xilinx_srl_pm, variable);

 		log_cmd_error("Unknown pattern: %s\n", pattern.c_str());
 	}

 	void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
 	{
 		if (GetSize(args) > 1)
 		{
 			if (args[1] == "-reduce_chain")
 				return execute_reduce_chain(args, design);
 			if (args[1] == "-reduce_tree")
 				return execute_reduce_tree(args, design);
 			if (args[1] == "-eqpmux")
 				return execute_eqpmux(args, design);
 			if (args[1] == "-generate")
 				return execute_generate(args, design);
 		}
 		help();
 		log_cmd_error("Missing or unsupported mode parameter.\n");
 	}
 } TestPmgenPass;

 PRIVATE_NAMESPACE_END
	/*
	* yosys -- Yosys Open SYnthesis Suite
	*
	* Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
	*
	* 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"

	USING_YOSYS_NAMESPACE
	PRIVATE_NAMESPACE_BEGIN

	#include "passes/pmgen/test_pmgen_pm.h"
	#include "passes/pmgen/ice40_dsp_pm.h"
	#include "passes/pmgen/xilinx_srl_pm.h"

	#include "generate.h"

	void reduce_chain(test_pmgen_pm &pm)
	{
	auto &st = pm.st_reduce;
	auto &ud = pm.ud_reduce;

	if (ud.longest_chain.empty())
	return;

	log("Found chain of length %d (%s):\n", GetSize(ud.longest_chain), log_id(st.first->type));

	SigSpec A;
	SigSpec Y = ud.longest_chain.front().first->getPort(ID(Y));
	auto last_cell = ud.longest_chain.back().first;

	for (auto it : ud.longest_chain) {
	auto cell = it.first;
	if (cell == last_cell) {
	A.append(cell->getPort(ID(A)));
	A.append(cell->getPort(ID(B)));
	} else {
	A.append(cell->getPort(it.second == ID(A) ? ID(B) : ID(A)));
	}
	log(" %s\n", log_id(cell));
	pm.autoremove(cell);
	}

	Cell *c;

	if (last_cell->type == ID($_AND_))
	c = pm.module->addReduceAnd(NEW_ID, A, Y);
	else if (last_cell->type == ID($_OR_))
	c = pm.module->addReduceOr(NEW_ID, A, Y);
	else if (last_cell->type == ID($_XOR_))
	c = pm.module->addReduceXor(NEW_ID, A, Y);
	else
	log_abort();

	log(" -> %s (%s)\n", log_id(c), log_id(c->type));
	}

	void reduce_tree(test_pmgen_pm &pm)
	{
	auto &st = pm.st_reduce;
	auto &ud = pm.ud_reduce;

	if (ud.longest_chain.empty())
	return;

	SigSpec A = ud.leaves;
	SigSpec Y = st.first->getPort(ID(Y));
	pm.autoremove(st.first);

	log("Found %s tree with %d leaves for %s (%s).\n", log_id(st.first->type),
	GetSize(A), log_signal(Y), log_id(st.first));

	Cell *c;

	if (st.first->type == ID($_AND_))
	c = pm.module->addReduceAnd(NEW_ID, A, Y);
	else if (st.first->type == ID($_OR_))
	c = pm.module->addReduceOr(NEW_ID, A, Y);
	else if (st.first->type == ID($_XOR_))
	c = pm.module->addReduceXor(NEW_ID, A, Y);
	else
	log_abort();

	log(" -> %s (%s)\n", log_id(c), log_id(c->type));
	}

	void opt_eqpmux(test_pmgen_pm &pm)
	{
	auto &st = pm.st_eqpmux;

	SigSpec Y = st.pmux->getPort(ID::Y);
	int width = GetSize(Y);

	SigSpec EQ = st.pmux->getPort(ID::B).extract(st.pmux_slice_eq*width, width);
	SigSpec NE = st.pmux->getPort(ID::B).extract(st.pmux_slice_ne*width, width);

	log("Found eqpmux circuit driving %s (eq=%s, ne=%s, pmux=%s).\n",
	log_signal(Y), log_id(st.eq), log_id(st.ne), log_id(st.pmux));

	pm.autoremove(st.pmux);
	Cell *c = pm.module->addMux(NEW_ID, NE, EQ, st.eq->getPort(ID::Y), Y);
	log(" -> %s (%s)\n", log_id(c), log_id(c->type));
	}

	struct TestPmgenPass : public Pass {
	TestPmgenPass() : Pass("test_pmgen", "test pass for pmgen") { }
	void help() YS_OVERRIDE
	{
	// \|---v---\|---v---\|---v---\|---v---\|---v---\|---v---\|---v---\|---v---\|---v---\|---v---\|
	log("\n");
	log(" test_pmgen -reduce_chain [options] [selection]\n");
	log("\n");
	log("Demo for recursive pmgen patterns. Map chains of AND/OR/XOR to $reduce_*.\n");
	log("\n");

	log("\n");
	log(" test_pmgen -reduce_tree [options] [selection]\n");
	log("\n");
	log("Demo for recursive pmgen patterns. Map trees of AND/OR/XOR to $reduce_*.\n");
	log("\n");

	log("\n");
	log(" test_pmgen -eqpmux [options] [selection]\n");
	log("\n");
	log("Demo for recursive pmgen patterns. Optimize EQ/NE/PMUX circuits.\n");
	log("\n");

	log("\n");
	log(" test_pmgen -generate [options] <pattern_name>\n");
	log("\n");
	log("Create modules that match the specified pattern.\n");
	log("\n");
	}

	void execute_reduce_chain(std::vector<std::string> args, RTLIL::Design *design)
	{
	log_header(design, "Executing TEST_PMGEN pass (-reduce_chain).\n");

	size_t argidx;
	for (argidx = 2; argidx < args.size(); argidx++)
	{
	// if (args[argidx] == "-singleton") {
	// singleton_mode = true;
	// continue;
	// }
	break;
	}
	extra_args(args, argidx, design);

	for (auto module : design->selected_modules())
	while (test_pmgen_pm(module, module->selected_cells()).run_reduce(reduce_chain)) {}
	}

	void execute_reduce_tree(std::vector<std::string> args, RTLIL::Design *design)
	{
	log_header(design, "Executing TEST_PMGEN pass (-reduce_tree).\n");

	size_t argidx;
	for (argidx = 2; argidx < args.size(); argidx++)
	{
	// if (args[argidx] == "-singleton") {
	// singleton_mode = true;
	// continue;
	// }
	break;
	}
	extra_args(args, argidx, design);

	for (auto module : design->selected_modules())
	test_pmgen_pm(module, module->selected_cells()).run_reduce(reduce_tree);
	}

	void execute_eqpmux(std::vector<std::string> args, RTLIL::Design *design)
	{
	log_header(design, "Executing TEST_PMGEN pass (-eqpmux).\n");

	size_t argidx;
	for (argidx = 2; argidx < args.size(); argidx++)
	{
	// if (args[argidx] == "-singleton") {
	// singleton_mode = true;
	// continue;
	// }
	break;
	}
	extra_args(args, argidx, design);

	for (auto module : design->selected_modules())
	test_pmgen_pm(module, module->selected_cells()).run_eqpmux(opt_eqpmux);
	}

	void execute_generate(std::vector<std::string> args, RTLIL::Design *design)
	{
	log_header(design, "Executing TEST_PMGEN pass (-generate).\n");

	size_t argidx;
	for (argidx = 2; argidx < args.size(); argidx++)
	{
	// if (args[argidx] == "-singleton") {
	// singleton_mode = true;
	// continue;
	// }
	break;
	}

	if (argidx+1 != args.size())
	log_cmd_error("Expected exactly one pattern.\n");

	string pattern = args[argidx];

	if (pattern == "reduce")
	return GENERATE_PATTERN(test_pmgen_pm, reduce);

	if (pattern == "eqpmux")
	return GENERATE_PATTERN(test_pmgen_pm, eqpmux);

	if (pattern == "ice40_dsp")
	return GENERATE_PATTERN(ice40_dsp_pm, ice40_dsp);

	if (pattern == "xilinx_srl.fixed")
	return GENERATE_PATTERN(xilinx_srl_pm, fixed);
	if (pattern == "xilinx_srl.variable")
	return GENERATE_PATTERN(xilinx_srl_pm, variable);

	log_cmd_error("Unknown pattern: %s\n", pattern.c_str());
	}

	void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
	{
	if (GetSize(args) > 1)
	{
	if (args[1] == "-reduce_chain")
	return execute_reduce_chain(args, design);
	if (args[1] == "-reduce_tree")
	return execute_reduce_tree(args, design);
	if (args[1] == "-eqpmux")
	return execute_eqpmux(args, design);
	if (args[1] == "-generate")
	return execute_generate(args, design);
	}
	help();
	log_cmd_error("Missing or unsupported mode parameter.\n");
	}
	} TestPmgenPass;

	PRIVATE_NAMESPACE_END