Merge pull request #1287 from verilog-to-routing/place_debug

Adding placer debug user interface

Author: vaughnbetz

README.md

@@ -75,16 +75,11 @@ This is the development trunk for the Verilog-to-Routing project.
 Unlike the nicely packaged releases that we create, you are working with code in a constant state of flux.
 You should expect that the tools are not always stable and that more work is needed to get the flow to run.
 
-For new developers, please [do the tutorial](dev/tutorial/NewDeveloperTutorial.txt).
-You will be directed back here once you ramp up.
+For new developers, please follow the [quickstart guide](https://docs.verilogtorouting.org/en/latest/quickstart/).
 
-VTR development follows a classic centralized repository (svn-like) workflow.
-The 'master' branch is supposed to be the most current stable version of the project.
-Developers checkout a local copy of the code at the start of development, then do regular updates (e.g. `git pull --rebase`) to keep in sync with the GitHub master.
-When a developer has a tested, working change to put back into the trunk, he/she performs a `git push` operation.
-Unstable code should remain in the developer's local copy.
+We follow a feature branch flow, where you create a new branch for new code, test it, measure its Quality of Results, and eventually produce a pull request for review by other developers. Pull requests that meet all the quality and review criteria are then merged into the master branch by a developer with the authority to do so.
 
-We do automated testing of the trunk using BuildBot to verify functionality and Quality of Results (QoR).
+In addition to measuring QoR and functionality automatically on pull requests, we do periodic automated testing of the master using BuildBot, and the results can be viewed below to track QoR and stability.
 * [Trunk Status](http://builds.verilogtorouting.org:8080/waterfall)
 * [QoR Tracking](http://builds.verilogtorouting.org:8080/)
 

doc/src/vpr/debug_aids.rst

@@ -11,6 +11,9 @@ To access detailed echo files from VPR’s operation, use the command-line optio
 After parsing the netlist and architecture files, VPR dumps out an image of its internal data structures into echo files (typically ending in ``.echo``).
 These files can be examined to be sure that VPR is parsing the input files as you expect.
 
+You ca visualize and control the placement move generator whenever the placement engine is paused in the UI. Run with graphics and VTR_ENABLE_DEBUG_LOGGONG enabled and set a breakpoint to stop placement. The new location of the moving block for each proposed move will be highlighted with GREEN and the old location will be highlighted with GOLD. The fanin and fanout blocks will also be highlighted. The move type, move outcome and delta cost will be printed in the status bar.
+.. warning:: VPR must have been compiled with `VTR_ENABLE_DEBUG_LOGGING` on to get any debug output from this flag.   
+
 If the preprocessor flag ``DEBUG`` is defined in ``vpr_types.h``, some additional sanity checks are performed during a run.
 ``DEBUG`` only slows execution by 1 to 2%.
 The major sanity checks are always enabled, regardless of the state of ``DEBUG``.

libs/libvtrutil/src/vtr_expr_eval.cpp

@@ -5,11 +5,19 @@
 #include <vector>
 #include <stack>
 #include <cstring>
+#include <iostream>
 
 #include "vtr_util.h"
 #include "vtr_error.h"
 #include "vtr_string_view.h"
 #include "vtr_flat_map.h"
+#include "../../../vpr/src/draw/breakpoint_state_globals.h"
+
+/**The expression evaluator is capable of performing many operations on given variables, after parsing the expression. The parser goes character by character and identifies the type of char or chars. (e.g bracket, comma, number, operator, variable). The supported operations include addition, subtraction, multiplication, division, finding max, min, gcd, lcm, as well as boolean operators such as &&, ||, ==, >=, <= etc. The result is returned as an int value and operation precedance is taken into account. (e.g given 3-2*4, the result will be -5). This class is also used to parse expressions indicating breakpoints. The breakpoint expressions consist of variable names such as move_num, temp_num, from_block etc, and boolean operators (e.g move_num == 3). Multiple breakpoints can be expressed in one expression**/
+
+//function declarations
+//returns the global variable that holds all values that can trigger a breakpoint and are updated by the router and placer
+BreakpointStateGlobals* get_bp_state_globals();
 
 namespace vtr {
 
@@ -50,6 +58,7 @@ typedef enum e_formula_obj {
     E_FML_BRACKET,
     E_FML_COMMA,
     E_FML_OPERATOR,
+    E_FML_VARIABLE,
     E_FML_NUM_FORMULA_OBJS
 } t_formula_obj;
 
@@ -60,16 +69,34 @@ typedef enum e_operator {
     E_OP_SUB,
     E_OP_MULT,
     E_OP_DIV,
-    E_OP_MOD,
-    E_OP_GT,
-    E_OP_LT,
     E_OP_MIN,
     E_OP_MAX,
     E_OP_GCD,
     E_OP_LCM,
+    E_OP_AND,
+    E_OP_OR,
+    E_OP_GT,
+    E_OP_LT,
+    E_OP_GTE,
+    E_OP_LTE,
+    E_OP_EQ,
+    E_OP_MOD,
+    E_OP_AA,
     E_OP_NUM_OPS
 } t_operator;
 
+/* Used to identify operators with more than one character */
+typedef enum e_compound_operator {
+    E_COM_OP_UNDEFINED = 0,
+    E_COM_OP_AND,
+    E_COM_OP_OR,
+    E_COM_OP_EQ,
+    E_COM_OP_AA,
+    E_COM_OP_GTE,
+    E_COM_OP_LTE
+
+} t_compound_operator;
+
 /**** Class Definitions ****/
 /* This class is used to represent an object in a formula, such as
  * a number, a bracket, an operator, or a variable */
@@ -83,6 +110,7 @@ class Formula_Object {
         int num;           /*for number objects*/
         t_operator op;     /*for operator objects*/
         bool left_bracket; /*for bracket objects -- specifies if this is a left bracket*/
+        //std::string variable;
 
         u_Data() { memset(this, 0, sizeof(u_Data)); }
     } data;
@@ -92,7 +120,7 @@ class Formula_Object {
     }
 
     std::string to_string() const {
-        if (type == E_FML_NUMBER) {
+        if (type == E_FML_NUMBER || type == E_FML_VARIABLE) {
             return std::to_string(data.num);
         } else if (type == E_FML_BRACKET) {
             if (data.left_bracket) {
@@ -113,10 +141,20 @@ class Formula_Object {
                 return "/";
             } else if (data.op == E_OP_MOD) {
                 return "%";
+            } else if (data.op == E_OP_AND) {
+                return "&&";
+            } else if (data.op == E_OP_OR) {
+                return "||";
             } else if (data.op == E_OP_GT) {
                 return ">";
             } else if (data.op == E_OP_LT) {
                 return "<";
+            } else if (data.op == E_OP_GTE) {
+                return ">=";
+            } else if (data.op == E_OP_LTE) {
+                return "<=";
+            } else if (data.op == E_OP_EQ) {
+                return "==";
             } else if (data.op == E_OP_MIN) {
                 return "min";
             } else if (data.op == E_OP_MAX) {
@@ -125,6 +163,8 @@ class Formula_Object {
                 return "gcd";
             } else if (data.op == E_OP_LCM) {
                 return "lcm";
+            } else if (data.op == E_OP_AA) {
+                return "+=";
             } else {
                 return "???"; //Unkown
             }
@@ -141,7 +181,7 @@ class FormulaParser {
     FormulaParser& operator=(const FormulaParser&) = delete;
 
     /* returns integer result according to specified formula and data */
-    int parse_formula(std::string formula, const t_formula_data& mydata);
+    int parse_formula(std::string formula, const t_formula_data& mydata, bool is_breakpoint = false);
 
     /* returns integer result according to specified piece-wise formula and data */
     int parse_piecewise_formula(const char* formula, const t_formula_data& mydata);
@@ -154,5 +194,6 @@ class FormulaParser {
     std::stack<Formula_Object> op_stack_; /* stack for handling operators and brackets in formula */
 };
 
-} //namespace vtr
+} // namespace vtr
+
 #endif

libs/libvtrutil/src/vtr_expr_eval.h

@@ -126,31 +126,31 @@
             <property name="visible">True</property>
             <property name="can_focus">False</property>
             <child>
-              <object class="GtkButton" id="ProceedButton">
-                <property name="label" translatable="yes">Proceed</property>
+              <object class="GtkButton" id="SaveGraphics">
+                <property name="label" translatable="yes">Save</property>
                 <property name="visible">True</property>
                 <property name="can_focus">True</property>
                 <property name="receives_default">True</property>
                 <property name="image_position">right</property>
               </object>
               <packing>
                 <property name="left_attach">0</property>
-                <property name="top_attach">2</property>
+		<property name="top_attach">0</property>
                 <property name="width">1</property>
                 <property name="height">1</property>
               </packing>
             </child>
             <child>
-              <object class="GtkButton" id="SaveGraphics">
-                <property name="label" translatable="yes">Save</property>
+              <object class="GtkButton" id="ProceedButton">
+                <property name="label" translatable="yes">Proceed</property>
                 <property name="visible">True</property>
                 <property name="can_focus">True</property>
                 <property name="receives_default">True</property>
                 <property name="image_position">right</property>
               </object>
               <packing>
                 <property name="left_attach">0</property>
-                <property name="top_attach">0</property>
+                <property name="top_attach">3</property>
                 <property name="width">1</property>
                 <property name="height">1</property>
               </packing>
@@ -163,6 +163,20 @@
                 <property name="receives_default">True</property>
                 <property name="image_position">right</property>
               </object>
+              <packing>
+                <property name="left_attach">0</property>
+                <property name="top_attach">2</property>
+                <property name="width">1</property>
+                <property name="height">1</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="debugButton">
+                <property name="label" translatable="yes">Debug</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+              </object>
               <packing>
                 <property name="left_attach">0</property>
                 <property name="top_attach">1</property>

vpr/main.ui

@@ -0,0 +1,65 @@
+#Packing pin usage report
+Type: io
+	Input Pin Usage:
+		Max: 1.00 (0.50)
+		Avg: 0.34 (0.17)
+		Min: 0.00 (0.00)
+		Histogram:
+		[        0:      0.2) 41 ( 66.1%) |************************************************
+		[      0.2:      0.4)  0 (  0.0%) |
+		[      0.4:      0.6)  0 (  0.0%) |
+		[      0.6:      0.8)  0 (  0.0%) |
+		[      0.8:        1) 21 ( 33.9%) |*************************
+		[        1:      1.2)  0 (  0.0%) |
+		[      1.2:      1.4)  0 (  0.0%) |
+		[      1.4:      1.6)  0 (  0.0%) |
+		[      1.6:      1.8)  0 (  0.0%) |
+		[      1.8:        2)  0 (  0.0%) |
+	Output Pin Usage:
+		Max: 1.00 (1.00)
+		Avg: 0.66 (0.66)
+		Min: 0.00 (0.00)
+		Histogram:
+		[        0:      0.1) 21 ( 33.9%) |*************************
+		[      0.1:      0.2)  0 (  0.0%) |
+		[      0.2:      0.3)  0 (  0.0%) |
+		[      0.3:      0.4)  0 (  0.0%) |
+		[      0.4:      0.5)  0 (  0.0%) |
+		[      0.5:      0.6)  0 (  0.0%) |
+		[      0.6:      0.7)  0 (  0.0%) |
+		[      0.7:      0.8)  0 (  0.0%) |
+		[      0.8:      0.9)  0 (  0.0%) |
+		[      0.9:        1) 41 ( 66.1%) |************************************************
+
+Type: clb
+	Input Pin Usage:
+		Max: 17.00 (0.40)
+		Avg: 11.60 (0.28)
+		Min: 4.00 (0.10)
+		Histogram:
+		[        0:      4.2) 1 ( 20.0%) |*************************
+		[      4.2:      8.4) 1 ( 20.0%) |*************************
+		[      8.4:       13) 0 (  0.0%) |
+		[       13:       17) 1 ( 20.0%) |*************************
+		[       17:       21) 2 ( 40.0%) |*************************************************
+		[       21:       25) 0 (  0.0%) |
+		[       25:       29) 0 (  0.0%) |
+		[       29:       34) 0 (  0.0%) |
+		[       34:       38) 0 (  0.0%) |
+		[       38:       42) 0 (  0.0%) |
+	Output Pin Usage:
+		Max: 9.00 (0.43)
+		Avg: 4.60 (0.22)
+		Min: 2.00 (0.10)
+		Histogram:
+		[        0:      2.1) 3 ( 60.0%) |*************************************************
+		[      2.1:      4.2) 0 (  0.0%) |
+		[      4.2:      6.3) 0 (  0.0%) |
+		[      6.3:      8.4) 1 ( 20.0%) |****************
+		[      8.4:       10) 1 ( 20.0%) |****************
+		[       10:       13) 0 (  0.0%) |
+		[       13:       15) 0 (  0.0%) |
+		[       15:       17) 0 (  0.0%) |
+		[       17:       19) 0 (  0.0%) |
+		[       19:       21) 0 (  0.0%) |
+