DFCxx simulation #49

Muxianesty · 2024-08-16T16:01:35Z

This Pull Request introduces DFCxx simulation to Utopia HLS.

~~[!!!] NO REVIEWER SELECTED YET. THIS PULL REQUEST IS INCOMPLETE.~~
Pull Request ready for review.

… the new subcommand.

…simplified; DFCXXSimulator class was added.

… example minor fixes.

…data file instead of a vector.

ssmolov

Too many copy-paste, I am exhausted :((

ssmolov · 2024-08-27T07:15:52Z

README.md

+
+* `-h,--help`: *optional* flag; used to print the help-message about other arguments.
+* `--in <PATH>`: *optional* filesystem-path option; used to specify the input file for simulation data (default: `sim.txt`). Its format is presented in *DFCxx Simulation Input Format* section.
+* `--out <PATH>`: *optional* filesystem-path option; used to specify the output VCD file (default: `sim_out.txt`).


It looks strange that the output VCD file has sim_out.txt name. A "*.vcd" extension would be better.

ssmolov · 2024-08-27T07:20:02Z

README.md

@@ -268,6 +274,33 @@ Here is an example of a JSON configuration file, containing latencies for multip
 }
 ```

+### DFCxx Simulation Input Format


IMHO, it would be better to have a concise README and describe auxiliary information in separate Markdown files. Let's move this chapter there.

Trailing whitespace is detected here also.

ssmolov · 2024-08-27T07:24:03Z

README.md

@@ -268,6 +274,33 @@ Here is an example of a JSON configuration file, containing latencies for multip
 }
 ```

+### DFCxx Simulation Input Format
+
+DFCxx kernels can be simulated to check that they describe computations as expected. The simulation doesn't include scheduling-related characteristics, thus DFCxx concepts like *offsets* are not supported, every computational node has to use **and** accept some value. 


First sentence is ok. The second one is hardly understandable; could be better to have the specific section called "Supported DFCxx constructions" (or something like that) in this document.

ssmolov · 2024-08-27T07:25:06Z

README.md

+DFCxx kernels can be simulated to check that they describe computations as expected. The simulation doesn't include scheduling-related characteristics, thus DFCxx concepts like *offsets* are not supported, every computational node has to use **and** accept some value. 
+The format to provide simulation input data is the following:
+
+* input data is divided into blocks separated with a newline character (`\n`) - one block for each clock period


"for each clock period" -> "at a simulation step"

ssmolov · 2024-08-27T07:34:15Z

README.md

+The format to provide simulation input data is the following:
+
+* input data is divided into blocks separated with a newline character (`\n`) - one block for each clock period
+* every block has a number of lines, each of which has the name of some **input** stream/scalar value and its hex-value (these values do not have a type - it is assumed from the corresponding computational nodes)


"these values do not have a type - it is assumed from the corresponding computational nodes" -> "these values do not have an explicit type - they will be casted to the types of related computational nodes"

ssmolov · 2024-08-27T09:09:58Z

src/model/dfcxx/lib/dfcxx/vars/stream.cpp

+  meta.storage.addVariable(newVar);
+  meta.graph.addNode(newVar, OpType::NEQ, NodeData{});
+  meta.graph.addChannel(this, newVar, 0, false);
+  meta.graph.addChannel(&rhs, newVar, 1, false);


ssmolov · 2024-08-27T09:10:07Z

src/model/dfcxx/lib/dfcxx/vars/stream.cpp

+  meta.storage.addVariable(newVar);
+  meta.graph.addNode(newVar, OpType::SHR, NodeData{.bitShift=bits});
+  meta.graph.addChannel(this, newVar, 0, false);


ssmolov · 2024-08-27T09:11:14Z

src/options.h

    }
  }

+  std::string latConfigFile;


latConfigFile -> latencyCfgFile

ssmolov · 2024-08-27T09:11:34Z

src/options.h

    }
  }

+  std::string latConfigFile;
+  DFLatencyConfig latConfig;


latConfig -> latencyCfg

ssmolov · 2024-08-27T09:12:01Z

src/options.h

+    get(json, SIM_IN_JSON,                   inFilePath);
+    get(json, SIM_OUT_JSON,                  outFilePath);


extra spaces between args

Muxianesty

Fixes regarding comments above were made.

ssmolov · 2024-09-03T10:23:57Z

README.md


-The list of arguments for `hls`-mode is presented below:
+`hls` mode is used to translate the provided DFCxx kernel to different output formats. The list of arguments for `hls`-mode is presented below:


hls mode is used to perform a High-Level Synthesis of digital hardware description from the input DFCxx kernel

ssmolov · 2024-09-03T10:24:44Z

README.md

@@ -232,43 +232,13 @@ Here is an example of an Utopia HLS CLI call:
 umain hls --config ~/utopia-user/config.json --out-sv ~/outFile.sv --out-dfcir ~/outFile2.mlir -a
 ```

-### JSON Configuration
+`sim` mode is used to simulate the provided DFCxx kernel. The list of arguments for `sim`-mode is presented below:


"provided DFCxx kernel" -> "input DFCxx kernel"

ssmolov · 2024-09-03T10:26:33Z

docs/latency_config.md

@@ -0,0 +1,35 @@
+## JSON Configuration
+
+Latency configuration for each computational operation (number of pipeline stages) used in a DFCxx kernel is provided via a JSON file.


"Latency configuration for each computational operation (number of pipeline stages)" -> "Latency configuration (in terms of pipeline stages) for each computational operation"

ssmolov · 2024-09-03T10:32:22Z

docs/latency_config.md

+
+Latency configuration for each computational operation (number of pipeline stages) used in a DFCxx kernel is provided via a JSON file.
+
+Currently each operation has two specifications: for integer values (`INT`) and floating point (`FLOAT`) values. 


Each operation has two specifications are based on the supported types of arguments: integer (INT) and floating point (FLOAT) respectively.

...or something like that

ssmolov · 2024-09-03T10:32:36Z

docs/latency_config.md

+
+Currently each operation has two specifications: for integer values (`INT`) and floating point (`FLOAT`) values. 
+
+The list of all computational operations is provided below:


All the supported computational operations are listed below:

ssmolov · 2024-09-03T10:58:07Z

src/model/dfcxx/lib/dfcxx/simulator.cpp

+                                 const std::unordered_map<Node,
+                                                          std::string> &idMap) {


Line-splitted type again

src/model/dfcxx/lib/dfcxx/vars/scalar.cpp

src/model/dfcxx/lib/dfcxx/vars/stream.cpp

Muxianesty

Fixed according to comments above.

ssmolov · 2024-09-05T06:56:29Z

docs/latency_config.md

@@ -0,0 +1,35 @@
+## JSON Configuration


File was renamed, but the title remains the same -- is it ok?

ssmolov · 2024-09-05T07:00:16Z

docs/latency_config.md

@@ -0,0 +1,35 @@
+## JSON Configuration
+
+Latency configuration (in terms of pipeline stages) for each computational operation used in a DFCxx kernel is provided via a JSON file.


There is no information about pipeline stages in this document, so the refinement looks like "hanging in the air" fact.

Also passive voice is used, it makes sentence complicated. It would be more clear to start like "Latency configuration is a JSON-based file describing characteristics of computational operations for the specific DFCxx kernel."

ssmolov · 2024-09-05T07:09:34Z

src/model/dfcxx/lib/dfcxx/IRbuilders/builder.cpp

+                                                        map[first], attr);
+      break;
+    }
+    default: assert(false);


It will be helpful to print an informative message that shows unexpected 'node.type' value

Muxianesty

Fixed according to comments above.

ssmolov

Ok, merged

Muxianesty added 2 commits August 16, 2024 18:57

Initial DFCxx simulation code was added; options.h was changed to fit…

ddd2366

… the new subcommand.

config.json expanded with 'sim'-section.

4505cce

Muxianesty added the enhancement New feature or request label Aug 16, 2024

Muxianesty self-assigned this Aug 16, 2024

Muxianesty added the stage II For issues applicable to Stage II of the project label Aug 16, 2024

Muxianesty added 3 commits August 16, 2024 20:50

DFCxx node top-sort was moved to utils.h/utils.cpp; DFCIRBuilder was …

80a8097

…simplified; DFCXXSimulator class was added.

Various struct/classes/enum declarations for simulator were added.

5aabc77

Simulation output path option was added.

4ebe450

Muxianesty marked this pull request as draft August 17, 2024 17:35

Muxianesty and others added 13 commits August 19, 2024 20:08

Additional (not finished) simulation logic was added.

8a0fe36

Additional simulation logic added (incomplete).

29dac55

Minor simulation logic fixes; added simulation input data examples.

6e0e750

SimVars -> IOVars; IDCT example simulation input data was added; IDCT…

58b7a0d

… example minor fixes.

Simulation CLI fixes; subcommand sim now accepts only a single input …

ddac5f9

…data file instead of a vector.

[INCOMPLETE] DFCxx interfaces fixes.

38d04cf

[COMPLETE] DFCxx interfaces fixes.

bd65dbb

License header for simulator.cpp .

596a936

DFCxx operation simulation handling logic revamped.

df531b0

Merge branch 'master' into dfcxx_sim

9673380

Merge master.

424f328

DFCxx simulation now outputs VCD files.

6c48c88

README.md was updated.

031d2d7

Muxianesty requested a review from ssmolov August 26, 2024 17:12

Muxianesty marked this pull request as ready for review August 26, 2024 17:14

ssmolov reviewed Aug 27, 2024

View reviewed changes

Fixes regarding Pull Request review.

252e0c4

Muxianesty commented Aug 27, 2024

View reviewed changes

README.md restructuring.

fd31d82

Muxianesty requested a review from ssmolov August 28, 2024 14:12

ssmolov reviewed Sep 3, 2024

View reviewed changes

Fixes regarding Pull Request comments.

2a829bf

Muxianesty commented Sep 3, 2024

View reviewed changes

ssmolov reviewed Sep 5, 2024

View reviewed changes

Fixes regarding Pull Request comments.

8eb9020

Muxianesty commented Sep 5, 2024

View reviewed changes

Unknown node type logging in builder.cpp added.

97d413d

ssmolov approved these changes Sep 5, 2024

View reviewed changes

ssmolov merged commit be9a08f into master Sep 5, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DFCxx simulation #49

DFCxx simulation #49

Muxianesty commented Aug 16, 2024 •

edited

Loading

ssmolov left a comment

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

ssmolov Aug 27, 2024

Muxianesty left a comment

ssmolov Sep 3, 2024

ssmolov Sep 3, 2024

ssmolov Sep 3, 2024

ssmolov Sep 3, 2024

ssmolov Sep 3, 2024

ssmolov Sep 3, 2024

Muxianesty left a comment

ssmolov Sep 5, 2024

ssmolov Sep 5, 2024

ssmolov Sep 5, 2024

Muxianesty left a comment

ssmolov left a comment

		get(json, SIM_IN_JSON, inFilePath);
		get(json, SIM_OUT_JSON, outFilePath);


		The list of arguments for `hls`-mode is presented below:
		`hls` mode is used to translate the provided DFCxx kernel to different output formats. The list of arguments for `hls`-mode is presented below:

		@@ -0,0 +1,35 @@
		## JSON Configuration

		Latency configuration for each computational operation (number of pipeline stages) used in a DFCxx kernel is provided via a JSON file.


		Latency configuration for each computational operation (number of pipeline stages) used in a DFCxx kernel is provided via a JSON file.

		Currently each operation has two specifications: for integer values (`INT`) and floating point (`FLOAT`) values.


		Currently each operation has two specifications: for integer values (`INT`) and floating point (`FLOAT`) values.

		The list of all computational operations is provided below:

		@@ -0,0 +1,35 @@
		## JSON Configuration

		Latency configuration (in terms of pipeline stages) for each computational operation used in a DFCxx kernel is provided via a JSON file.

DFCxx simulation #49

DFCxx simulation #49

Conversation

Muxianesty commented Aug 16, 2024 • edited Loading

ssmolov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Muxianesty left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Muxianesty left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Muxianesty left a comment

Choose a reason for hiding this comment

ssmolov left a comment

Choose a reason for hiding this comment

Muxianesty commented Aug 16, 2024 •

edited

Loading