summaryrefslogtreecommitdiff
path: root/passes/opt/opt_reduce.cc
blob: fee8fb71b1069119cec512b29d81646e0a76dc92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/*
 *  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 "opt_status.h"
#include "kernel/register.h"
#include "kernel/sigtools.h"
#include "kernel/log.h"
#include "kernel/celltypes.h"
#include "libs/sha1/sha1.h"
#include <stdlib.h>
#include <assert.h>
#include <stdio.h>
#include <set>

struct OptReduceWorker
{
	RTLIL::Design *design;
	RTLIL::Module *module;
	SigMap assign_map;

	int total_count;
	bool did_something;

	void opt_reduce(std::set<RTLIL::Cell*> &cells, SigSet<RTLIL::Cell*> &drivers, RTLIL::Cell *cell)
	{
		if (cells.count(cell) == 0)
			return;
		cells.erase(cell);

		RTLIL::SigSpec sig_a = assign_map(cell->connections["\\A"]);
		sig_a.sort_and_unify();
		sig_a.expand();

		RTLIL::SigSpec new_sig_a;
		for (auto &chunk : sig_a.chunks)
		{
			if (chunk.wire == NULL && chunk.data.bits[0] == RTLIL::State::S0) {
				if (cell->type == "$reduce_and") {
					new_sig_a = RTLIL::SigSpec(RTLIL::State::S0);
					break;
				}
				continue;
			}
			if (chunk.wire == NULL && chunk.data.bits[0] == RTLIL::State::S1) {
				if (cell->type == "$reduce_or") {
					new_sig_a = RTLIL::SigSpec(RTLIL::State::S1);
					break;
				}
				continue;
			}
			if (chunk.wire == NULL) {
				new_sig_a.append(chunk);
				continue;
			}

			bool imported_children = false;
			for (auto child_cell : drivers.find(chunk)) {
				if (child_cell->type == cell->type) {
					opt_reduce(cells, drivers, child_cell);
					new_sig_a.append(child_cell->connections["\\A"]);
					imported_children = true;
				}
			}
			if (!imported_children)
				new_sig_a.append(chunk);
		}
		new_sig_a.sort_and_unify();

		if (new_sig_a != sig_a || sig_a.width != cell->connections["\\A"].width) {
			log("    New input vector for %s cell %s: %s\n", cell->type.c_str(), cell->name.c_str(), log_signal(new_sig_a));
			did_something = true;
			OPT_DID_SOMETHING = true;
			total_count++;
		}

		cell->connections["\\A"] = new_sig_a;
		cell->parameters["\\A_WIDTH"] = RTLIL::Const(new_sig_a.width);
		return;
	}

	void opt_mux(RTLIL::Cell *cell)
	{
		RTLIL::SigSpec sig_a = assign_map(cell->connections["\\A"]);
		RTLIL::SigSpec sig_b = assign_map(cell->connections["\\B"]);
		RTLIL::SigSpec sig_s = assign_map(cell->connections["\\S"]);

		RTLIL::SigSpec new_sig_b, new_sig_s;
		std::set<RTLIL::SigSpec> handled_sig;

		handled_sig.insert(sig_a);
		for (int i = 0; i < sig_s.width; i++)
		{
			RTLIL::SigSpec this_b = sig_b.extract(i*sig_a.width, sig_a.width);
			if (handled_sig.count(this_b) > 0)
				continue;

			RTLIL::SigSpec this_s = sig_s.extract(i, 1);
			for (int j = i+1; j < sig_s.width; j++) {
				RTLIL::SigSpec that_b = sig_b.extract(j*sig_a.width, sig_a.width);
				if (this_b == that_b)
					this_s.append(sig_s.extract(j, 1));
			}

			if (this_s.width > 1)
			{
				RTLIL::Wire *reduce_or_wire = new RTLIL::Wire;
				reduce_or_wire->name = NEW_ID;
				module->wires[reduce_or_wire->name] = reduce_or_wire;

				RTLIL::Cell *reduce_or_cell = new RTLIL::Cell;
				reduce_or_cell->name = NEW_ID;
				reduce_or_cell->type = "$reduce_or";
				reduce_or_cell->connections["\\A"] = this_s;
				reduce_or_cell->parameters["\\A_SIGNED"] = RTLIL::Const(0);
				reduce_or_cell->parameters["\\A_WIDTH"] = RTLIL::Const(this_s.width);
				reduce_or_cell->parameters["\\Y_WIDTH"] = RTLIL::Const(1);
				module->cells[reduce_or_cell->name] = reduce_or_cell;

				this_s = RTLIL::SigSpec(reduce_or_wire);
				reduce_or_cell->connections["\\Y"] = this_s;
			}

			new_sig_b.append(this_b);
			new_sig_s.append(this_s);
			handled_sig.insert(this_b);
		}

		if (new_sig_s.width != sig_s.width) {
			log("    New ctrl vector for %s cell %s: %s\n", cell->type.c_str(), cell->name.c_str(), log_signal(new_sig_s));
			did_something = true;
			OPT_DID_SOMETHING = true;
			total_count++;
		}

		if (new_sig_s.width == 0)
		{
			module->connections.push_back(RTLIL::SigSig(cell->connections["\\Y"], cell->connections["\\A"]));
			assign_map.add(cell->connections["\\Y"], cell->connections["\\A"]);
			module->cells.erase(cell->name);
			delete cell;
		}
		else
		{
			cell->connections["\\B"] = new_sig_b;
			cell->connections["\\S"] = new_sig_s;
			if (new_sig_s.width > 1) {
				cell->parameters["\\S_WIDTH"] = RTLIL::Const(new_sig_s.width);
			} else {
				cell->type = "$mux";
				cell->parameters.erase("\\S_WIDTH");
			}
		}
	}

	OptReduceWorker(RTLIL::Design *design, RTLIL::Module *module) :
			design(design), module(module), assign_map(module)
	{
		log("  Optimizing cells in module %s.\n", module->name.c_str());

		total_count = 0;
		did_something = true;

		while (did_something)
		{
			did_something = false;

			// merge trees of reduce_* cells to one single cell and unify input vectors
			// (only handle recduce_and and reduce_or for various reasons)

			const char *type_list[] = { "$reduce_or", "$reduce_and" };
			for (auto type : type_list)
			{
				SigSet<RTLIL::Cell*> drivers;
				std::set<RTLIL::Cell*> cells;

				for (auto &cell_it : module->cells) {
					RTLIL::Cell *cell = cell_it.second;
					if (cell->type != type || !design->selected(module, cell))
						continue;
					drivers.insert(assign_map(cell->connections["\\Y"]), cell);
					cells.insert(cell);
				}

				while (cells.size() > 0) {
					RTLIL::Cell *cell = *cells.begin();
					opt_reduce(cells, drivers, cell);
				}
			}

			// merge identical inputs on $mux and $pmux cells

			for (auto &cell_it : module->cells)
			{
				RTLIL::Cell *cell = cell_it.second;
				if ((cell->type != "$mux" && cell->type != "$pmux" && cell->type != "$safe_pmux") || !design->selected(module, cell))
					continue;
				opt_mux(cell);
			}
		}
	}
};

struct OptReducePass : public Pass {
	OptReducePass() : Pass("opt_reduce", "simplify large MUXes and AND/OR gates") { }
	virtual void help()
	{
		//   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
		log("\n");
		log("    opt_reduce [selection]\n");
		log("\n");
		log("This pass performs two interlinked optimizations:\n");
		log("\n");
		log("1. it consolidates trees of large AND gates or OR gates and eliminates\n");
		log("duplicated inputs.\n");
		log("\n");
		log("2. it identifies duplicated inputs to MUXes and replaces them with a single\n");
		log("input with the original control signals OR'ed together.\n");
		log("\n");
	}
	virtual void execute(std::vector<std::string> args, RTLIL::Design *design)
	{
		log_header("Executing OPT_REDUCE pass (consolidate $*mux and $reduce_* inputs).\n");
		extra_args(args, 1, design);

		int total_count = 0;
		for (auto &mod_it : design->modules) {
			if (!design->selected(mod_it.second))
				continue;
			OptReduceWorker worker(design, mod_it.second);
			total_count += worker.total_count;
		}

		log("Performed a total of %d changes.\n", total_count);
	}
} OptReducePass;