Add bounds checking for BitOps.rotl and BitOps.rotr (#27814)

jabraham17 · web-flow · commit 4436c9fe25b7 · 2025-09-17T10:47:26.000-07:00
Adds bounds checking to prevent users calling BitOps.rotl and BitOps.rotr incorrectly This PR also expands the BitOps test cases significantly Resolves #27803 - [x] paratest
diff --git a/modules/internal/ChapelHashing.chpl b/modules/internal/ChapelHashing.chpl
@@ -84,6 +84,11 @@ module ChapelHashing {
     pragma "codegen for CPU and GPU"
     extern proc chpl_bitops_rotl_64(x: uint(64), n: uint(64)) : uint(64);
     var n:uint = (17 + fieldnum):uint;
+    if boundsChecking {
+      if n >= 64 {
+        halt("rotation amount must be between 0 and 63 - got " + n:string);
+      }
+    }
     return _gen_key(a ^ chpl_bitops_rotl_64(b, n));
   }
 
diff --git a/modules/standard/BitOps.chpl b/modules/standard/BitOps.chpl
@@ -308,6 +308,15 @@ private module BitOps_internal {
   }
 
   inline proc rotl(x: uint(?bits), n: integral) {
+    if boundsChecking {
+      use HaltWrappers;
+      if n < 0 || n >= bits {
+        HaltWrappers.boundsCheckHalt("rotation amount must be between 0 and " +
+                                     (bits-1):string +
+                                     " for type of size " +
+                                     bits:string + " - got " + n:string);
+      }
+    }
     // the select will be folded out at compile time.
     select bits {
       when 64 do
@@ -328,6 +337,15 @@ private module BitOps_internal {
   }
 
   inline proc rotr(x: uint(?bits), n: integral) {
+    if boundsChecking {
+      use HaltWrappers;
+      if n < 0 || n >= bits {
+        HaltWrappers.boundsCheckHalt("rotation amount must be between 0 and " +
+                                     (bits-1):string +
+                                     " for type of size " +
+                                     bits:string + " - got " + n:string);
+      }
+    }
     // the select will be folded out at compile time.
     select bits {
       when 64 do
diff --git a/test/library/standard/BitOps/clz.chpl b/test/library/standard/BitOps/clz.chpl
@@ -5,3 +5,7 @@ writeln(clz(x));
 writeln(clz(x:uint(16)));
 writeln(clz(x:uint(32)));
 writeln(clz(x:uint(64)));
+writeln(clz(x:int(8)));
+writeln(clz(x:int(16)));
+writeln(clz(x:int(32)));
+writeln(clz(x:int(64)));
diff --git a/test/library/standard/BitOps/clz.good b/test/library/standard/BitOps/clz.good
@@ -2,3 +2,7 @@
 12
 28
 60
+4
+12
+28
+60
diff --git a/test/library/standard/BitOps/ctz.chpl b/test/library/standard/BitOps/ctz.chpl
@@ -1,10 +1,19 @@
 use BitOps;
 
-var x: uint = 0x0004000000000000;
+var x: uint(64) = 0x0004000000000000;
 writeln(ctz(x));
 var x2: uint(32) = 0x00040000;
 writeln(ctz(x2));
 var x3: uint(16) = 0x0040;
 writeln(ctz(x3));
 var x4: uint(8) = 0x04;
 writeln(ctz(x4));
+
+var x5: int(64) = 0x0004000000000000;
+writeln(ctz(x5));
+var x6: int(32) = 0x00040000;
+writeln(ctz(x6));
+var x7: int(16) = 0x0040;
+writeln(ctz(x7));
+var x8: int(8) = 0x04;
+writeln(ctz(x8));
diff --git a/test/library/standard/BitOps/ctz.good b/test/library/standard/BitOps/ctz.good
@@ -2,3 +2,7 @@
 18
 6
 2
+50
+18
+6
+2
diff --git a/test/library/standard/BitOps/parity.chpl b/test/library/standard/BitOps/parity.chpl
@@ -1,6 +1,6 @@
 use BitOps;
 
-var x: uint = 0xFF773311FF773311;
+var x: uint(64) = 0xFF773311FF773311;
 writeln(parity(x));
 x = 0xFF773311FF773313;
 writeln(parity(x));
@@ -19,3 +19,25 @@ var x4: uint(8) = 0x0F;
 writeln(parity(x4));
 x4 = 0x1F;
 writeln(parity(x4));
+
+var y: int(64) = -0x773311FF773311;
+writeln(parity(y));
+y = -0x773311FF773313;
+writeln(parity(y));
+
+var y2: int(32) = -0x731F731;
+writeln(parity(y2));
+y2 = -0x731F733;
+writeln(parity(y2));
+
+var y3: int(16) = -0x731;
+writeln(parity(y3));
+y3 = -0x733;
+writeln(parity(y3));
+
+var y4: int(8) = -0x0F;
+writeln(parity(y4));
+y4 = -0x1F;
+writeln(parity(y4));
+
+
diff --git a/test/library/standard/BitOps/parity.good b/test/library/standard/BitOps/parity.good
@@ -6,3 +6,11 @@
 1
 0
 1
+1
+0
+1
+0
+1
+0
+1
+0
diff --git a/test/library/standard/BitOps/popcount.chpl b/test/library/standard/BitOps/popcount.chpl
@@ -1,10 +1,19 @@
 use BitOps;
 
-var x: uint = 0xFF773311FF773311;
+var x: uint(64) = 0xFF773311FF773311;
 writeln(popCount(x));
 var x2: uint(32) = 0xF731F731;
 writeln(popCount(x2));
 var x3: uint(16) = 0xF731;
 writeln(popCount(x3));
 var x4: uint(8) = 0xF1;
 writeln(popCount(x4));
+
+var y: int(64) = 0x0F773311FF773311;
+writeln(popCount(y));
+var y2: int(32) = 0x0731F731;
+writeln(popCount(y2));
+var y3: int(16) = 0x0731;
+writeln(popCount(y3));
+var y4: int(8) = 0x71;
+writeln(popCount(y4));
diff --git a/test/library/standard/BitOps/popcount.good b/test/library/standard/BitOps/popcount.good
@@ -2,3 +2,7 @@
 20
 10
 5
+36
+16
+6
+4
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.16.good b/test/library/standard/BitOps/rotl-rotr-checks.16.good
@@ -0,0 +1 @@
+rotl-rotr-checks.chpl:NN: error: halt reached - rotation amount must be between 0 and 15 for type of size 16 - got N
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.32.good b/test/library/standard/BitOps/rotl-rotr-checks.32.good
@@ -0,0 +1 @@
+rotl-rotr-checks.chpl:NN: error: halt reached - rotation amount must be between 0 and 31 for type of size 32 - got N
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.64.good b/test/library/standard/BitOps/rotl-rotr-checks.64.good
@@ -0,0 +1 @@
+rotl-rotr-checks.chpl:NN: error: halt reached - rotation amount must be between 0 and 63 for type of size 64 - got N
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.8.good b/test/library/standard/BitOps/rotl-rotr-checks.8.good
@@ -0,0 +1 @@
+rotl-rotr-checks.chpl:NN: error: halt reached - rotation amount must be between 0 and 7 for type of size 8 - got N
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.chpl b/test/library/standard/BitOps/rotl-rotr-checks.chpl
@@ -0,0 +1,37 @@
+use BitOps;
+
+config const testCase = 0;
+
+// check edge cases of -1 and numBits(x.type)
+proc test(param BW, testCaseStart=0) {
+  if testCase == testCaseStart + 0 {
+    var x: uint(BW) = 0x17;
+    writeln(rotl(x, -1));
+  } else if testCase == testCaseStart + 1 {
+    var x: uint(BW) = 0x17;
+    writeln(rotr(x, -1));
+  } else if testCase == testCaseStart + 2 {
+    var x: uint(BW) = 0x17;
+    writeln(rotl(x, numBits(x.type)));
+  } else if testCase == testCaseStart + 3 {
+    var x: uint(BW) = 0x17;
+    writeln(rotr(x, numBits(x.type)));
+  } else if testCase == testCaseStart + 4 {
+    var x: int(BW) = 0x17;
+    writeln(rotl(x, -1));
+  } else if testCase == testCaseStart + 5 {
+    var x: int(BW) = 0x17;
+    writeln(rotr(x, -1));
+  } else if testCase == testCaseStart + 6 {
+    var x: int(BW) = 0x17;
+    writeln(rotl(x, numBits(x.type)));
+  } else if testCase == testCaseStart + 7 {
+    var x: int(BW) = 0x17;
+    writeln(rotr(x, numBits(x.type)));
+  }
+}
+
+test(8);
+test(16, testCaseStart=8);
+test(32, testCaseStart=16);
+test(64, testCaseStart=24);
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.execopts b/test/library/standard/BitOps/rotl-rotr-checks.execopts
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+for i in {0..7}; do
+  echo "--testCase=$i # rotl-rotr-checks.8.good";
+done
+for i in {8..15}; do
+  echo "--testCase=$i # rotl-rotr-checks.16.good";
+done
+for i in {16..23}; do
+  echo "--testCase=$i # rotl-rotr-checks.32.good";
+done
+for i in {24..31}; do
+  echo "--testCase=$i # rotl-rotr-checks.64.good";
+done
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.lastcompopts b/test/library/standard/BitOps/rotl-rotr-checks.lastcompopts
@@ -0,0 +1 @@
+--checks
diff --git a/test/library/standard/BitOps/rotl-rotr-checks.prediff b/test/library/standard/BitOps/rotl-rotr-checks.prediff
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+file=$2
+
+sed -E 's/chpl:[0-9]+:/chpl:NN:/' $file > $file.tmp
+mv $file.tmp $file
+
+sed -E 's/got -?[0-9]+/got N/' $file > $file.tmp
+mv $file.tmp $file
diff --git a/test/library/standard/BitOps/rotl.chpl b/test/library/standard/BitOps/rotl.chpl
@@ -11,3 +11,15 @@ writef("%@06xu\n", rotl(x3, 5));
 
 var x4: uint(8) = 0xF0;
 writef("%@04xu\n", rotl(x4, 3));
+
+var x5: int(64) = 0x0FFFFFFF00000000;
+writef("%@018xu\n", rotl(x5, 17));
+
+var x6: int(32) = 0x0FFF0000;
+writef("%@010xu\n", rotl(x6, 9));
+
+var x7: int(16) = 0x0F00;
+writef("%@06xu\n", rotl(x7, 5));
+
+var x8: int(8) = 0x70;
+writef("%@04xu\n", rotl(x8, 3));
diff --git a/test/library/standard/BitOps/rotl.good b/test/library/standard/BitOps/rotl.good
@@ -2,3 +2,7 @@
 0xfe0001ff
 0xe01f
 0x87
+0xfffe000000001fff
+0xfe00001f
+0xe001
+0x83
diff --git a/test/library/standard/BitOps/rotr.chpl b/test/library/standard/BitOps/rotr.chpl
@@ -11,3 +11,15 @@ writef("%@06xu\n", rotr(x3, 5));
 
 var x4: uint(8) = 0xF0;
 writef("%@04xu\n", rotr(x4, 3));
+
+var x5: int(64) = 0x0FFFFFFF00000000;
+writef("%@018xu\n", rotr(x5, 17));
+
+var x6: int(32) = 0x0FFF0000;
+writef("%@010xu\n", rotr(x6, 9));
+
+var x7: int(16) = 0x0F00;
+writef("%@06xu\n", rotr(x7, 5));
+
+var x8: int(8) = 0x70;
+writef("%@04xu\n", rotr(x8, 3));
diff --git a/test/library/standard/BitOps/rotr.good b/test/library/standard/BitOps/rotr.good
@@ -2,3 +2,7 @@
 0x007fff80
 0x07f8
 0x1e
+0x000007ffffff8000
+0x0007ff80
+0x0078
+0x0e

Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,7 @@`
`2`	`2`	`12`
`3`	`3`	`28`
`4`	`4`	`60`
	`5`	`+4`
	`6`	`+12`
	`7`	`+28`
	`8`	`+60`
Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,7 @@`
`2`	`2`	`18`
`3`	`3`	`6`
`4`	`4`	`2`
	`5`	`+50`
	`6`	`+18`
	`7`	`+6`
	`8`	`+2`
Original file line number	Diff line number	Diff line change
`@@ -6,3 +6,11 @@`
`6`	`6`	`1`
`7`	`7`	`0`
`8`	`8`	`1`
	`9`	`+1`
	`10`	`+0`
	`11`	`+1`
	`12`	`+0`
	`13`	`+1`
	`14`	`+0`
	`15`	`+1`
	`16`	`+0`
Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,7 @@`
`2`	`2`	`20`
`3`	`3`	`10`
`4`	`4`	`5`
	`5`	`+36`
	`6`	`+16`
	`7`	`+6`
	`8`	`+4`