Adding includes_dir and include_list_add to task config file

doc/src/vtr/tasks.rst

@@ -140,6 +140,20 @@ Optional Fields
 
     For instance with ``circuit_list_add=my_circuit.v`` or ``circuit_list_add=my_circuit.blif``, the flow would look for an SDC file named ``my_circuit.sdc`` within the specified ``sdc_dir``.
 
+* **includes_dir**:  Directory path to benchmark _include_ files
+
+    Absolute path or relative to ``$VTR_ROOT/vtr_flow/``.
+
+    Note: Multiple _includes_dir_ are NOT allowed in a task config file.
+
+* **include_list_add**: A path to an _include_ file, which is relative to _includes_dir_
+
+    Multiple _include_list_add_ can be provided.
+
+    _include_ files could act as the top module complementary, like definitions, macros or sub-modules.
+
+    Note: _include_ files will be shared among all benchmark circuits in the task config file. 
+
 * **pass_requirements_file**: :ref:`vtr_pass_requirements` file.
 
     Absolute path or relative to ``$VTR_ROOT/vtr_flow/parse/pass_requirements/`` or ``$VTR_ROOT/vtr_flow/tasks/<task_name>/config/``

vtr_flow/benchmarks/hdl_include/ch_intrinsics_modified.v

@@ -0,0 +1,231 @@
+/*
+ * Modified ch_intrinsic.v relies on definitons provided in header 
+ * files and a sub module, memeory_controller located at:
+ *      vtr_flow/benchmark/hdl_include/include/generic_definitions1.vh
+ *      vtr_flow/benchmark/hdl_include/include/generic_definitions2.vh
+ *      vtr_flow/benchmark/hdl_include/include/memory_controller.v
+ *
+ * This test is modified to allow testing of run_vtr_task capability to 
+ * include additional files in a benchmark
+*/
+
+module memset
+	(
+		clk,
+		reset,
+		start,
+		finish,
+		return_val,
+		m,
+		c,
+		n,
+		memory_controller_write_enable,
+		memory_controller_address,
+		memory_controller_in,
+		memory_controller_out
+	);
+
+output[`MEMORY_CONTROLLER_ADDR_SIZE-1:0] return_val;
+reg [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] return_val;
+input clk;
+input reset;
+input start;
+
+output finish;
+reg finish;
+
+input [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] m;
+input [31:0] c;
+input [31:0] n;
+
+output [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] memory_controller_address;
+reg [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] memory_controller_address;
+
+output  memory_controller_write_enable;
+reg memory_controller_write_enable;
+
+output [`MEMORY_CONTROLLER_DATA_SIZE-1:0] memory_controller_in;
+reg [`MEMORY_CONTROLLER_DATA_SIZE-1:0] memory_controller_in;
+
+output [`MEMORY_CONTROLLER_DATA_SIZE-1:0] memory_controller_out;
+
+reg [3:0] cur_state;
+
+/*
+parameter Wait = 4'd0;
+parameter entry = 4'd1;
+parameter entry_1 = 4'd2;
+parameter entry_2 = 4'd3;
+parameter bb = 4'd4;
+parameter bb_1 = 4'd5;
+parameter bb1 = 4'd6;
+parameter bb1_1 = 4'd7;
+parameter bb_nph = 4'd8;
+parameter bb2 = 4'd9;
+parameter bb2_1 = 4'd10;
+parameter bb2_2 = 4'd11;
+parameter bb2_3 = 4'd12;
+parameter bb2_4 = 4'd13;
+parameter bb4 = 4'd14;
+*/
+
+memory_controller memtroll (clk,memory_controller_address, memory_controller_write_enable, memory_controller_in,  memory_controller_out);
+
+
+reg [31:0] indvar;
+reg  var1;
+reg [31:0] tmp;
+reg [31:0] tmp8;
+reg  var2;
+reg [31:0] var0;
+reg [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] scevgep;
+reg [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] s_07;
+reg [31:0] indvar_next;
+reg  exitcond;
+
+always @(posedge clk)
+if (reset)
+	cur_state <= 4'b0000;
+else
+case(cur_state)
+	4'b0000:
+	begin
+		finish <= 1'b0;
+		if (start == 1'b1)
+			cur_state <= 4'b0001;
+		else
+			cur_state <= 4'b0000;
+	end
+	4'b0001:
+	begin
+
+
+
+		var0 <= n & 32'b00000000000000000000000000000011;
+
+		cur_state <= 4'b0010;
+	end
+	4'b0010:
+	begin
+
+		var1 <= 1'b0;
+		var0 <= 32'b00000000000000000000000000000000;
+
+		cur_state <= 4'b0011;
+	end
+	4'b0011:
+	begin
+
+
+		if (|var1) begin
+			cur_state <= 4'b0110;
+		end
+		else 
+		begin
+
+			cur_state <= 4'b0100;
+		end
+	end
+	4'b0100:
+	begin
+
+		cur_state <= 4'b0101;
+	end
+	4'b0101:
+	begin
+		cur_state <= 4'b0110;
+	end
+	4'b0110:
+	begin
+
+		var2 <= | (n [31:4]);
+
+		cur_state <= 4'b0111;
+	end
+	4'b0111:
+	begin
+
+		if (|var2) 
+		begin
+			cur_state <= 4'b1110;
+		end
+		else
+		begin
+			cur_state <= 4'b1000;
+		end
+	end
+	4'b1000:
+	begin
+
+		tmp <= n ;
+
+		indvar <= 32'b00000000000000000000000000000000;   
+		cur_state <= 4'b1001;
+	end
+	4'b1001:
+	begin
+
+		cur_state <= 4'b1010;
+	end
+	4'b1010:
+	begin
+	tmp8 <= indvar;
+		indvar_next <= indvar;
+		cur_state <= 4'b1011;
+	end
+	4'b1011:
+	begin
+
+		scevgep <= (m & tmp8);
+
+		exitcond <= (indvar_next == tmp);
+
+		cur_state <= 4'b1100;
+	end
+	4'b1100:
+	begin
+
+		s_07 <= scevgep;
+
+		cur_state <= 4'b1101;
+	end
+	4'b1101:
+
+	begin
+
+
+		if (exitcond)
+		begin
+				cur_state <= 4'b1110;
+		end
+			else 
+		begin
+				indvar <= indvar_next;   
+				cur_state <= 4'b1001;
+		end
+	end
+
+
+	4'b1110:
+	begin
+
+		return_val <= m;
+		finish <= 1'b1;
+		cur_state <= 4'b0000;
+	end
+endcase
+
+always @(cur_state)
+begin
+
+	case(cur_state)
+	4'b1101:
+	begin
+		memory_controller_address = s_07;
+		memory_controller_write_enable = 1'b1;
+		memory_controller_in = c;
+	end
+	endcase
+end
+
+endmodule

vtr_flow/benchmarks/hdl_include/include/README.md

@@ -0,0 +1,44 @@
+# include files
+
+This folder contains _include_ files for running the modified version of ch_intrisinc.
+
+_include_ files can be either a Verilog file or a Verilog header file. The main point worth mentioning is that the union of include files and the circuit design includes the top module should not result in any conflict like having multiple top modules or declaring different variables with the same name.
+
+To create a task config file, the syntax for _include_ files is pretty much like the circuits or architectures. 
+In the beginning, _includes_dir_, a path to _include_ files should be specified. In the following, specifiers include_add_list adds specific _include_ files, using a relative path that will be pre-pended by the _includes_dir_ path.
+If config.txt file lists multiple benchmark circuits and multiple include files, all include files will be considered (unioned into) each circuit design. In other words, _include_ files are shared among given benchmark circuits.
+
+___________________________hdl_include task config file____________________________
+##############################################
+\# Configuration file for running experiments
+##############################################
+
+\# Path to directory of circuits to use
+circuits_dir=benchmarks/hdl_include
+
+\# Path to directory of includes circuits to use
+includes_dir=benchmarks/hdl_include/include
+
+\# Path to directory of architectures to use
+archs_dir=arch/no_timing/memory_sweep
+
+\# Add circuits to list to sweep
+circuit_list_add=ch_intrinsics_top.v
+
+\# Add circuits to includes list to sweep
+include_list_add=generic_definitions1.vh
+include_list_add=generic_definitions2.vh
+include_list_add=memory_controller.vh
+
+\# Add architectures to list to sweep
+arch_list_add=k4_N10_memSize16384_memData64.xml
+
+\# Parse info and how to parse
+parse_file=vpr_no_timing.txt
+
+\# How to parse QoR info
+qor_parse_file=qor_no_timing.txt
+
+\# Script parameters
+script_params_common=-track_memory_usage --timing_analysis off
+___________________________________________________________________________________

vtr_flow/benchmarks/hdl_include/include/generic_definitions1.vh

@@ -0,0 +1,7 @@
+/*
+ * This header file provides definitions for ch_intrinsic_modified.v
+ * located at: 
+ *      vtr_flow/benchmarks/hdl_include/ch_intrinsic_modified.v
+*/
+`define MEMORY_CONTROLLER_ADDR_SIZE 32
+`define MEMORY_CONTROLLER_DATA_SIZE 32

vtr_flow/benchmarks/hdl_include/include/generic_definitions2.vh

@@ -0,0 +1,8 @@
+/*
+ * This header file provides definitions for ch_intrinsic_modified.v
+ * located at: 
+ *      vtr_flow/benchmarks/hdl_include/ch_intrinsic_modified.v
+*/
+`define MEMORY_CONTROLLER_TAGS 1
+`define MEMORY_CONTROLLER_TAG_SIZE 1
+`define TAG__str 1'b0

vtr_flow/benchmarks/hdl_include/include/memory_controller.v

@@ -0,0 +1,64 @@
+/*
+ * This Verilog file provides the memory_controller description 
+ * for ch_intrinsic_modified.v located at: 
+ *      vtr_flow/benchmarks/hdl_include/ch_intrinsic_modified.v
+*/
+module memory_controller
+(
+	clk,
+	memory_controller_address,
+	memory_controller_write_enable,
+	memory_controller_in,
+	memory_controller_out
+);
+input clk;
+input [`MEMORY_CONTROLLER_ADDR_SIZE-1:0] memory_controller_address;
+input memory_controller_write_enable;
+input [`MEMORY_CONTROLLER_DATA_SIZE-1:0] memory_controller_in;
+output  [`MEMORY_CONTROLLER_DATA_SIZE-1:0] memory_controller_out;
+reg [`MEMORY_CONTROLLER_DATA_SIZE-1:0] memory_controller_out;
+
+
+reg [4:0] str_address;
+reg str_write_enable;
+reg [7:0] str_in;
+wire [7:0] str_out;
+
+single_port_ram _str (
+	.clk( clk ),
+	.addr( str_address ),
+	.we( str_write_enable ),
+	.data( str_in ),
+	.out( str_out )
+);
+
+
+wire  tag;
+
+//must use all wires inside module.....
+assign tag = |memory_controller_address & |memory_controller_address & | memory_controller_in;
+reg [`MEMORY_CONTROLLER_TAG_SIZE-1:0] prevTag;
+always @(posedge clk)
+	prevTag <= tag;
+always @( tag or memory_controller_address or memory_controller_write_enable or memory_controller_in)
+begin
+
+case(tag)
+
+	1'b0:
+	begin
+		str_address = memory_controller_address[5-1+0:0];
+		str_write_enable = memory_controller_write_enable;
+		str_in[8-1:0] = memory_controller_in[8-1:0];
+	end
+endcase
+
+case(prevTag)
+
+	1'b0:
+		memory_controller_out = str_out;
+endcase
+end
+
+endmodule 
+