Merge pull request #1795 from verilog-to-routing/manual_moves

Manual Moves Timing

Author: vaughnbetz

doc/src/vpr/graphics.rst

@@ -213,4 +213,30 @@ Button Description Table
 |                   |                   |                              | FPGA                         |
 +-------------------+-------------------+------------------------------+------------------------------+
 
+Manual Moves
+------------
+
+The manual moves feature allows the user to specify the next move in placement. If the move is legal, blocks are swapped and the new move is shown on the architecture. 
+
+.. figure:: https://www.verilogtorouting.org/img/manual_move_toggle_button.png
+   :align: center
+
+To enable the feature, activate the Manual Move toggle button and press Proceed. Alternatively, the user can active the Manual Move toggle button and click on the block to be moved.
+
+.. figure:: https://www.verilogtorouting.org/img/draw_manual_moves_window.png
+   :align: center
+
+On the manual move window, the user can specify the Block ID/Block name of the block to move and the To location, with the x position, y position and subtile position. For the manual move to be valid:
+
+- The To location requested by the user should be within the grid's dimensions.
+- The block to be moved is found, valid and not fixed.
+- The blocks to be swapped are compatible.
+- The location choosen by the user is different from the block's current location.
+  
+If the manual move is legal, the cost summary window will display the delta cost, delta timing, delta bounding box cost and the placer's annealing decision that would result from this move. 
+
+.. figure:: https://www.verilogtorouting.org/img/manual_move_cost_dialog.png
+   :align: center
+
+The user can Accept or Reject the manual move based on the values provided. If accepted the block's new location is shown. 
 

vpr/main.ui

@@ -192,7 +192,7 @@
             <property name="height">1</property>
           </packing>
         </child>
-        <child>
+         <child>
           <object class="GtkGrid" id="checkboxes">
             <property name="visible">True</property>
             <property name="can_focus">False</property>
@@ -229,8 +229,8 @@
                 <property name="width">1</property>
                 <property name="height">1</property>
               </packing>
-            </child>
-            <child>
+           </child>
+	    <child>
               <object class="GtkCheckButton" id="clipRoutingUtil">
                 <property name="label" translatable="yes">Clip Routing Util</property>
                 <property name="visible">True</property>
@@ -247,14 +247,31 @@
                 <property name="height">1</property>
               </packing>
             </child>
+            <child>
+              <object class="GtkCheckButton" id="manualMove">
+                <property name="label" translatable="yes">Manual Move</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="xalign">0</property>
+                <property name="draw_indicator">True</property>
+              </object>
+              <packing>
+                <property name="left_attach">0</property>
+                <property name="top_attach">3</property>
+                <property name="width">1</property>
+                <property name="height">1</property>
+              </packing>
+            </child>   
+
           </object>
           <packing>
             <property name="left_attach">4</property>
             <property name="top_attach">2</property>
             <property name="width">1</property>
             <property name="height">1</property>
           </packing>
-        </child>
+  	</child>
         <child>
           <placeholder/>
         </child>

vpr/src/draw/draw.cpp

@@ -14,6 +14,7 @@
 #    include "draw_color.h"
 #    include "search_bar.h"
 #    include "draw_debug.h"
+#    include "manual_moves.h"
 
 extern ezgl::application::settings settings;
 extern ezgl::application application;

vpr/src/draw/draw.h

@@ -1,4 +1,7 @@
 /** This file contains all functions reagrding the graphics related to the setting of place and route breakpoints **/
+#ifndef DRAW_DEBUG_H
+#define DRAW_DEBUG_H
+
 #ifndef NO_GRAPHICS
 
 #    include "breakpoint.h"
@@ -35,4 +38,6 @@ void invalid_breakpoint_entry_window(std::string error);
 bool valid_expression(std::string exp);
 void breakpoint_info_window(std::string bpDescription, BreakpointState draw_breakpoint_state, bool in_placer);
 
-#endif
+#endif /*NO_GRAPHICS*/
+
+#endif /*DRAW_DEBUG_H*/

vpr/src/draw/draw_debug.h

@@ -27,6 +27,7 @@
 #    include "vtr_color_map.h"
 #    include "vtr_vector.h"
 #    include "breakpoint.h"
+#    include "manual_moves.h"
 
 #    include "ezgl/point.hpp"
 #    include "ezgl/rectangle.hpp"
@@ -196,6 +197,7 @@ struct t_draw_state {
     int sequence_number = 0;
     float net_alpha = 0.1;
     float pres_fac = 1.;
+    ManualMovesState manual_moves_state;
 
     std::vector<Breakpoint> list_of_breakpoints;