From 3de61ead55662c919a0b9a47be105f883812b96c Mon Sep 17 00:00:00 2001
From: mergify[bot]
Date: Fri, 4 Mar 2022 02:23:34 +0000
Subject: Issue errors on out-of-range extracts when width is known (#2428)
 (#2429)

* Issue errors on out-of-range extracts when width is known

Firrtl will catch this later on, but better to error early if possible.

* Test that errors are generated on OOB extracts when width is known

(cherry picked from commit 462def429aa87becb544533880a3075a806c53e4)

Co-authored-by: Andrew Waterman <andrew@sifive.com>---
 core/src/main/scala/chisel3/Bits.scala   | 13 +++++++++++++
 src/test/scala/chiselTests/UIntOps.scala | 18 ++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/core/src/main/scala/chisel3/Bits.scala b/core/src/main/scala/chisel3/Bits.scala
index 8a616d02..4133592f 100644
--- a/core/src/main/scala/chisel3/Bits.scala
+++ b/core/src/main/scala/chisel3/Bits.scala
@@ -107,6 +107,12 @@ sealed abstract class Bits(private[chisel3] val width: Width) extends Element wi
       (((value >> castToInt(x, "Index")) & 1) == 1).asBool
     }.getOrElse {
       requireIsHardware(this, "bits to be indexed")
+
+      widthOption match {
+        case Some(w) if x >= w => Builder.error(s"High index $x is out of range [0, ${w - 1}]")
+        case _                 =>
+      }
+
       pushOp(DefPrim(sourceInfo, Bool(), BitsExtractOp, this.ref, ILit(x), ILit(x)))
     }
   }
@@ -160,6 +166,13 @@ sealed abstract class Bits(private[chisel3] val width: Width) extends Element wi
       ((value >> y) & ((BigInt(1) << w) - 1)).asUInt(w.W)
     }.getOrElse {
       requireIsHardware(this, "bits to be sliced")
+
+      widthOption match {
+        case Some(w) if y >= w => Builder.error(s"High and low indices $x and $y are both out of range [0, ${w - 1}]")
+        case Some(w) if x >= w => Builder.error(s"High index $x is out of range [0, ${w - 1}]")
+        case _                 =>
+      }
+
       pushOp(DefPrim(sourceInfo, UInt(Width(w)), BitsExtractOp, this.ref, ILit(x), ILit(y)))
     }
   }
diff --git a/src/test/scala/chiselTests/UIntOps.scala b/src/test/scala/chiselTests/UIntOps.scala
index 5fb86001..0010e9ac 100644
--- a/src/test/scala/chiselTests/UIntOps.scala
+++ b/src/test/scala/chiselTests/UIntOps.scala
@@ -199,6 +199,24 @@ class UIntOpsSpec extends ChiselPropSpec with Matchers with Utils {
     a[Exception] should be thrownBy extractCause[Exception] { ChiselStage.elaborate(new BadBoolConversion) }
   }
 
+  property("Out-of-bounds extraction from known-width UInts") {
+    a[ChiselException] should be thrownBy extractCause[ChiselException] {
+      ChiselStage.elaborate(new RawModule {
+        val u = IO(Input(UInt(2.W)))
+        u(2, 1)
+      })
+    }
+  }
+
+  property("Out-of-bounds single-bit extraction from known-width UInts") {
+    a[ChiselException] should be thrownBy extractCause[ChiselException] {
+      ChiselStage.elaborate(new RawModule {
+        val u = IO(Input(UInt(2.W)))
+        u(2)
+      })
+    }
+  }
+
   property("UIntOps should elaborate") {
     ChiselStage.elaborate { new UIntOps }
   }
-- 
cgit v1.2.3