Merge pull request #473 from SymbiFlow/upstream_sync

Upstream sync

Author: litghost

.gitattributes

@@ -20,3 +20,34 @@
 abc/**                  -text
 abc_with_bb_support/**  -text
 libs/EXTERNAL/**        -text
+
+# Settings to improve linguist data reporting (used by GitHub)
+#-------------------------------------------------------------------------
+*.v                     linguist-language=Verilog
+*.vh                    linguist-language=Verilog
+*.pv                    linguist-language=Verilog
+*.pl                    linguist-language=Perl
+*.sp                    linguist-language=Spice
+*.pm                    linguist-language=Spice
+
+# External ABC
+abc/**                  linguist-vendored
+abc_with_bb_support/**  linguist-vendored
+# External libraries
+libs/EXTERNAL/**        linguist-vendored
+# External benchmarks imported into vtr_flow benchmark suite.
+vtr_flow/benchmarks/**  linguist-vendored
+vtr_flow/scripts/perl_libs/** linguist-vendored
+# External benchmarks imported into ODIN_II benchmark suite.
+ODIN_II/regression_test/benchmark/verilog/large/** linguist-vendored
+ODIN_II/regression_test/benchmark/verilog/full/** linguist-vendored
+ODIN_II/regression_test/benchmark/verilog/FIR/** linguist-vendored
+
+# Documentation
+doc/**                  linguist-documentation
+*.txt                   linguist-documentation
+*.md                    linguist-documentation
+*.rst                   linguist-documentation
+
+# Generated files
+vpr/src/route/gen/**    linguist-generated

.travis.yml

@@ -1,15 +1,20 @@
+version: ~> 1.0
 language: cpp
 
 dist: trusty
 addons:
   apt:
     sources:
-    - george-edison55-precise-backports # For cmake
-    - llvm-toolchain-precise-3.6
-    - llvm-toolchain-trusty-6.0
-    - llvm-toolchain-trusty-7 # For clang-format-7
-    - llvm-toolchain-trusty-8
-    - ubuntu-toolchain-r-test
+    - sourceline: 'ppa:george-edison55/precise-backports' # For cmake
+    - sourceline: 'deb http://apt.llvm.org/precise llvm-toolchain-precise-3.6 main'
+      key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key'
+    - sourceline: 'deb http://apt.llvm.org/trusty llvm-toolchain-trusty-6.0 main'
+      key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key'
+    - sourceline: 'deb http://apt.llvm.org/trusty llvm-toolchain-trusty-7 main' # For clang-format-7
+      key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key'
+    - sourceline: 'deb http://apt.llvm.org/trusty llvm-toolchain-trusty-8 main'
+      key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key'
+    - sourceline: 'ppa:ubuntu-toolchain-r/test'
     packages:
     - autoconf
     - automake
@@ -47,8 +52,6 @@ addons:
     - qt5-default
     - clang-format-7
     # All the compilers!
-    - g++-4.9
-    - gcc-4.9
     - g++-5
     - gcc-5
     - g++-6
@@ -112,7 +115,7 @@ jobs:
         - MATRIX_EVAL="CC=gcc-5 && CXX=g++-5"
       script:
         - ./.github/travis/build.sh
-        - ./run_reg_test.pl vtr_reg_basic -show_failures -j2
+        - travis_wait 30 ./run_reg_test.pl vtr_reg_basic -show_failures -j2
     - stage: Test
       name: "Strong Regression Tests"
       env:
@@ -128,7 +131,8 @@ jobs:
         - MATRIX_EVAL="CC=gcc-5 && CXX=g++-5"
       script:
         - ./.github/travis/build.sh
-        - ./run_reg_test.pl vtr_reg_valgrind_small -show_failures -j2
+        - travis_wait 30 ./run_reg_test.pl vtr_reg_valgrind_small -show_failures -j2
+    - stage: Test
       name: "Sanitized Basic Regression Tests"
       env:
         - CMAKE_PARAMS="-DVTR_ASSERT_LEVEL=3 -DVTR_ENABLE_SANITIZE=on -DVTR_IPO_BUILD=off -DWITH_BLIFEXPLORER=on"

ODIN_II/SRC/include/Hashtable.hpp

@@ -26,6 +26,7 @@
 #include <stdlib.h>
 #include <stdint.h>
 #include <unordered_map>
+#include <string>
 
 class Hashtable {
   private:

README.developers.md

@@ -751,6 +751,77 @@ $ make
 ```
 this turns on more extensive assertion checking and re-builds VTR.
 
+## GDB Pretty Printers
+To make it easier to debug some of VTR's data structures with [GDB](www.gnu.org/gdb).
+
+### STL Pretty Printers
+
+It is helpful to enable [STL pretty printers](https://sourceware.org/gdb/wiki/STLSupport), which make it much easier to debug data structures using STL.
+
+For example printing a `std::vector<int>` by default prints:
+
+    (gdb) p/r x_locs
+    $2 = {<std::_Vector_base<int, std::allocator<int> >> = {
+        _M_impl = {<std::allocator<int>> = {<__gnu_cxx::new_allocator<int>> = {<No data fields>}, <No data fields>}, _M_start = 0x555556f063b0, 
+          _M_finish = 0x555556f063dc, _M_end_of_storage = 0x555556f064b0}}, <No data fields>}
+
+which is not very helpful.
+
+But with STL pretty printers it prints:
+
+    (gdb) p x_locs
+    $2 = std::vector of length 11, capacity 64 = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
+
+which is much more helpful for debugging!
+
+If STL pretty printers aren't already enabled on your system, add the following to your [.gdbinit file](https://sourceware.org/gdb/current/onlinedocs/gdb/gdbinit-man.html):
+
+    python
+    import sys
+    sys.path.insert(0, '$STL_PRINTER_ROOT')
+    from libstdcxx.v6.printers import register_libstdcxx_printers
+    register_libstdcxx_printers(None)
+
+    end
+
+where `$STL_PRINTER_ROOT` should be replaced with the appropriate path to the STL pretty printers.
+For example recent versions of GCC include these under `/usr/share/gcc-*/python` (e.g. `/usr/share/gcc-9/python`)
+
+
+### VTR Pretty Printers
+
+VTR includes some pretty printers for some VPR/VTR specific types.
+
+For example, without the pretty printers you would see the following when printing a VPR `AtomBlockId`:
+
+    (gdb) p blk_id
+    $1 = {
+      id_ = 71
+    }
+
+But with the VTR pretty printers enabled you would see:
+
+    (gdb) p blk_id
+    $1 = AtomBlockId(71)
+
+To enable the VTR pretty printers in GDB add the following to your [.gdbinit file](https://sourceware.org/gdb/current/onlinedocs/gdb/gdbinit-man.html):
+
+    python
+    import sys
+
+    sys.path.insert(0, "$VTR_ROOT/dev")
+    import vtr_gdb_pretty_printers
+    gdb.pretty_printers.append(vtr_gdb_pretty_printers.vtr_type_lookup)
+
+    end
+
+where ``$VTR_ROOT`` should be replaced with the root of the VTR source tree on your system.
+
+## RR (Record Replay) Debugger
+
+[RR](https://rr-project.org/) extends GDB with the ability to to record a run of a tool and then re-run it to reproduce any observed issues.
+RR also enables efficient reverse execution (!) which can be *extremely helpful* when tracking down the source of a bug.
+
 # External Subtrees
 VTR includes some code which is developed in external repositories, and is integrated into the VTR source tree using [git subtrees](https://www.atlassian.com/blog/git/alternatives-to-git-submodule-git-subtree).
 

README.md

@@ -23,6 +23,15 @@ VTR includes a set of benchmark designs known to work with the design flow.
 
 VTR can also produce [FASM](https://symbiflow.readthedocs.io/en/latest/fasm/docs/specification.html) to program some commercial FPGAs (via [Symbiflow](https://symbiflow.github.io/))
 
+| Placement (carry-chains highlighted) | Critical Path |
+| ------------------------------------ | ------------- |
+| <img src="https://verilogtorouting.org/img/des90_placement_macros.gif" width="350"/> | <img src="https://verilogtorouting.org/img/des90_cpd.gif" width="350"/> | 
+
+| Logical Connections | Routing Utilziation |
+| ------------------- | ------------------- |
+| <img src="https://verilogtorouting.org/img/des90_nets.gif" width="350"/> | <img src="https://verilogtorouting.org/img/des90_routing_util.gif" width="350"/> |
+
+
 ## Documentation
 VTR's [full documentation](https://docs.verilogtorouting.org) includes tutorials, descriptions of the VTR design flow, and tool options.
 

dev/vpr_animate.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+
+import argparse
+import sys
+
+GRAPHICS_COMMAND = "set_draw_block_outlines 0; set_draw_block_text 0; save_graphics img_{i}_place.png; set_macros 1; save_graphics img_{i}_macros.png; set_macros 0; set_draw_net_max_fanout 1000; set_nets 1; save_graphics img_{i}_nets1.png; set_nets 2; save_graphics img_{i}_nets2.png; set_nets 0; set_cpd 1; save_graphics img_{i}_cpd1.png; set_cpd 2; save_graphics img_{i}_cpd2.png; set_cpd 0; set_routing_util 4; set_clip_routing_util 1; save_graphics img_{i}_routing_util4.png; set_routing_util 0; set_congestion 1; save_graphics img_{i}_congestion2.png; exit 0;"
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("vpr")
+    parser.add_argument("arch")
+    parser.add_argument("circuit")
+    parser.add_argument("--gen_state", action="store_true", default=False)
+    parser.add_argument("--gen_frames", action="store_true", default=False)
+    parser.add_argument("--render", action="store_true", default=False)
+    parser.add_argument("--placements", nargs="+")
+    parser.add_argument("--routings", nargs="+")
+
+    return parser.parse_known_args()
+
+def main():
+    args, extra_args = parse_args()
+
+    vpr_base_cmd = "{} {} {} --route_chan_width 300 --max_router_iterations 400 --router_lookahead map --verify_file_digests off --save_graphics on".format(args.vpr, args.arch, args.circuit)
+
+    for arg in extra_args:
+        vpr_base_cmd += " " + arg
+
+    if args.gen_state:
+        vpr_cmd = vpr_base_command + "--write_rr_graph rr_graph.bin --write_placement_delay_lookup placement_delay_lookup.bin --write_router_lookahead router_lookahead.bin"
+
+        print(vpr_cmd)
+
+    if args.gen_frames:
+        i = 0
+        for placement in args.placements:
+            cmd = '/usr/bin/time -v ' + vpr_base_cmd + " --place_file " + placement + " --read_rr_graph rr_graph.bin --read_placement_delay_lookup placement_delay_lookup.bin --read_router_lookahead router_lookahead.bin "
+            cmd += " --route"
+            cmd += " --graphics_commands '{}'".format(GRAPHICS_COMMAND.format(i=i))
+            cmd += " >& vpr_img_{}.log".format(i)
+            cmd += " && echo 'Finished {}' || echo 'Failed {}'".format(i, i)
+            print(cmd)
+            i += 1
+
+        for routing in args.routings:
+            cmd = '/usr/bin/time -v ' + vpr_base_cmd + " --place_file " + args.placements[-1] + " --read_rr_graph rr_graph.bin --read_placement_delay_lookup placement_delay_lookup.bin --read_router_lookahead router_lookahead.bin "
+            cmd += " --route_file " + routing + " --analysis"
+            cmd += " --graphics_commands '{}'".format(GRAPHICS_COMMAND.format(i=i))
+            cmd += " >& vpr_img_{}.log".format(i)
+            cmd += " && echo 'Finished {}' || echo 'Failed {}'".format(i, i)
+            print(cmd)
+            i += 1
+
+    num_frames = len(args.placements) + len(args.routings)
+
+    run_time = 20
+
+    fps = num_frames / run_time
+
+    if args.render:
+        # cmd = "ffmpeg -y -pattern_type sequence -i 'img_%d_{inmetric}.png' -map_metadata -1 -vf scale=402:300:flags=lanczos -b:v 0 -crf 24 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -t 15 {out}.mp4"
+
+        #Scale in raw format to lower resolution
+        cmd_hq_yuv = "ffmpeg -y -framerate {fps} -pattern_type sequence -i 'img_%d_{inmetric}.png' -vf scale=640:480:flags=lanczos -vcodec rawvideo -pix_fmt yuv420p raw_hq_{out}.yuv"
+        cmd_lq_yuv = "ffmpeg -y -framerate {fps} -pattern_type sequence -i 'img_%d_{inmetric}.png' -vf scale=250:186:flags=lanczos -vcodec rawvideo -pix_fmt yuv420p raw_lq_{out}.yuv"
+
+        #Encode skipping every other frame (select=)
+        cmd_hq = cmd_hq_yuv + " && ffmpeg -y -framerate {fps2} -s 640x480 -i raw_hq_{out}.yuv -b:v 0 -crf 24 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -ss 0 -filter:v select=\"mod(n-1\,2)\" {out}.mp4"
+        cmd_mq = cmd_hq_yuv + " && ffmpeg -y -framerate {fps2} -s 640x480 -i raw_hq_{out}.yuv -b:v 0 -crf 28 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -ss 0 -filter:v select=\"mod(n-1\,2)\" {out}.mp4"
+        cmd_lq = cmd_hq_yuv + " && ffmpeg -y -framerate {fps2} -s 640x480 -i raw_hq_{out}.yuv -b:v 0 -crf 34 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -ss 0 -filter:v select=\"mod(n-1\,2)\" {out}.mp4"
+        
+        # cmd_hq = "ffmpeg -y -framerate {fps} -pattern_type sequence -i 'img_%d_{inmetric}.png' -map_metadata -1 -vf scale=536:400:flags=lanczos -b:v 0 -crf 24 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -ss 0 {out}.mp4"
+        # cmd_mq = "ffmpeg -y -framerate {fps} -pattern_type sequence -i 'img_%d_{inmetric}.png' -map_metadata -1 -vf scale=536:400:flags=lanczos -b:v 0 -crf 28 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -ss 0 {out}.mp4"
+        # cmd_lq = "ffmpeg -y -framerate {fps} -pattern_type sequence -i 'img_%d_{inmetric}.png' -map_metadata -1 -vf scale=536:400:flags=lanczos -b:v 0 -crf 34 -f mp4 -vcodec libx264 -pix_fmt yuv420p -movflags +faststart -preset veryslow -tune animation -an -ss 0 {out}.mp4"
+
+        #For GIF use only half of frames (select) at lower resolution and skip 2 seconds (-ss 2) at beginning 
+        cmd_gif = "ffmpeg -y -framerate {fps} -pattern_type sequence -i 'img_%d_{inmetric}.png' -vf scale=250:186:flags=lanczos -vcodec rawvideo -pix_fmt yuv420p raw_gif_{out}.yuv && ffmpeg -y -framerate {fps2} -s 250x186 -i raw_gif_{out}.yuv -ss 2 -filter:v select=\"mod(n-1\,2)\" {out}.gif"
+
+        #AV1
+        # cmd = "ffmpeg -y -framerate 30 -pattern_type sequence -i 'img_%d_{inmetric}.png' -map_metadata -1 -vf scale=644:480 -b:v 0 -crf 50 -f mp4 -c:v libaom-av1 -pix_fmt yuv420p -movflags +faststart -strict experimental {out}.av1.mp4"
+
+        for inval, outval in [('macros', 'placement_macros'), ('cpd1', 'cpd'), ('routing_util4', 'routing_util'), ('nets2', 'nets')]:
+            if 'nets' in inval:
+                print(cmd_lq.format(inmetric=inval, out=outval, fps=fps, fps2=2*fps))
+            elif 'routing_util' in inval:
+                print(cmd_mq.format(inmetric=inval, out=outval, fps=fps, fps2=2*fps))
+            else:
+                print(cmd_hq.format(inmetric=inval, out=outval, fps=fps, fps2=2*fps))
+            print(cmd_gif.format(inmetric=inval, out=outval, fps=fps, fps2=2*fps))
+
+if __name__ == "__main__":
+    main()