From ff8bd4ec527c6b87cddfe6ee746f7299f426aa30 Mon Sep 17 00:00:00 2001
From: Schuyler Eldridge
Date: Thu, 27 Sep 2018 13:13:29 -0400
Subject: Inlining uses "_", respects namespaces

Summary of changes:
  - Use "_" as an inlining delimiter instead of "$"
  - Makes inlining avoid namespace conflicts

This changes the delimiter used for inlining to "_" instead of "$". This
avoids problems with buggy parsers that may not handle "$" correctly. As
ClockListTransform relies on the explicit use of "$", the delimiter is a
FIRRTL-private val that the ClockListTransform overrides (to the original
"$").

Namespace conflicts could occur previously, but are very rare as users
will almost never use "$" in a name (even though it's allowed by both the
FIRRTL and Verilog specifications). Moving to "_" increases the
probability of namespace conflicts occurring. This adds explicit checking
that inlined names will not introduce namespace conflicts and that
generated names are prefix unique (as defined in the spec).

Note: inlined modules may not have unique prefixes. A test is included
that this is the case and an ignored test shows what prefix uniqueness
would look like.

MISC:
  - [skip chisel tests]: Changing the delimiter causes the Chisel
    InlineSpec to fail as this explicitly checks for "$".

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
---
 src/test/scala/firrtlTests/FlattenTests.scala | 60 +++++++++++++--------------
 1 file changed, 30 insertions(+), 30 deletions(-)

(limited to 'src/test/scala/firrtlTests/FlattenTests.scala')

diff --git a/src/test/scala/firrtlTests/FlattenTests.scala b/src/test/scala/firrtlTests/FlattenTests.scala
index 570d03bf..77a221be 100644
--- a/src/test/scala/firrtlTests/FlattenTests.scala
+++ b/src/test/scala/firrtlTests/FlattenTests.scala
@@ -44,11 +44,11 @@ class FlattenTests extends LowTransformSpec {
           |  module Top :
           |    input a : UInt<32>
           |    output b : UInt<32>
-          |    wire i$a : UInt<32>
-          |    wire i$b : UInt<32>
-          |    i$b <= i$a
-          |    b <= i$b
-          |    i$a <= a
+          |    wire i_a : UInt<32>
+          |    wire i_b : UInt<32>
+          |    i_b <= i_a
+          |    b <= i_b
+          |    i_a <= a
           |  module Inline1 :
           |    input a : UInt<32>
           |    output b : UInt<32>
@@ -77,16 +77,16 @@ class FlattenTests extends LowTransformSpec {
           |  module Top :
           |    input a : UInt<32>
           |    output b : UInt<32>
-          |    wire i1$a : UInt<32>
-          |    wire i1$b : UInt<32>
-          |    i1$b <= i1$a
-          |    wire i2$a : UInt<32>
-          |    wire i2$b : UInt<32>
-          |    i2$b <= i2$a
-          |    node tmp = i1$b
-          |    b <= i2$b
-          |    i1$a <= a
-          |    i2$a <= tmp
+          |    wire i1_a : UInt<32>
+          |    wire i1_b : UInt<32>
+          |    i1_b <= i1_a
+          |    wire i2_a : UInt<32>
+          |    wire i2_b : UInt<32>
+          |    i2_b <= i2_a
+          |    node tmp = i1_b
+          |    b <= i2_b
+          |    i1_a <= a
+          |    i2_a <= tmp
           |  module Inline1 :
           |    input a : UInt<32>
           |    output b : UInt<32>
@@ -131,17 +131,17 @@ class FlattenTests extends LowTransformSpec {
           |    input na : UInt<32>
           |    output b : UInt<32>
           |    output nb : UInt<32>
-          |    wire i$a : UInt<32>
-          |    wire i$b : UInt<32>
-          |    wire i$i$a : UInt<32>
-          |    wire i$i$b : UInt<32>
-          |    i$i$b <= i$i$a
-          |    i$b <= i$i$a
-          |    i$i$a <= i$a
+          |    wire i_a : UInt<32>
+          |    wire i_b : UInt<32>
+          |    wire i_i_a : UInt<32>
+          |    wire i_i_b : UInt<32>
+          |    i_i_b <= i_i_a
+          |    i_b <= i_i_a
+          |    i_i_a <= i_a
           |    inst ni of NotInline1
-          |    b <= i$b
-          |    nb <= ni.b         
-          |    i$a <= a
+          |    b <= i_b
+          |    nb <= ni.b
+          |    i_a <= a
           |    ni.a <= na
           |  module NotInline1 :
           |    input a : UInt<32>
@@ -213,11 +213,11 @@ class FlattenTests extends LowTransformSpec {
           |  module Inline1 :
           |    input a : UInt<32>
           |    output b : UInt<32>
-          |    wire i$a : UInt<32>
-          |    wire i$b : UInt<32>
-          |    i$b <= i$a 
-          |    b <= i$a 
-          |    i$a <= a
+          |    wire i_a : UInt<32>
+          |    wire i_b : UInt<32>
+          |    i_b <= i_a
+          |    b <= i_a
+          |    i_a <= a
           |  module Inline2 :
           |    input a : UInt<32>
           |    output b : UInt<32>
-- 
cgit v1.2.3