zig

commit eab51b7785ce0989f90a5cdde4b1110f40875ddb (tree)
parent ed357f9897a6c96a1744307b1bc75a370dd85461
Author: Ian Simonson <ian.simonson@protonmail.com>
Date:   Sun, 27 Sep 2020 15:07:50 +1000

Make LinearFifo not crash when discarding from empty buffer

Previously if a LinearFifo was empty and discard was called
an unsigned overflow would occur. However it is safe to perform
this overflow as a bitwise & operation with 0xFFFFFFFFFFFFFF is a noop

Diffstat:
M
lib/std/fifo.zig
 | 
12
+++++++++++-

1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/lib/std/fifo.zig b/lib/std/fifo.zig
@@ -186,7 +186,9 @@ pub fn LinearFifo(
             } else {
                 var head = self.head + count;
                 if (powers_of_two) {
-                    head &= self.buf.len - 1;
+                    // Note it is safe to do a wrapping subtract as
+                    // bitwise & with all 1s is a noop
+                    head &= self.buf.len -% 1;
                 } else {
                     head %= self.buf.len;
                 }
@@ -376,6 +378,14 @@ pub fn LinearFifo(
     };
 }
 
+test "LinearFifo(u8, .Dynamic) discard(0) from empty buffer should not error on overflow" {
+    var fifo = LinearFifo(u8, .Dynamic).init(testing.allocator);
+    defer fifo.deinit();
+
+    // If overflow is not explicitly allowed this will crash in debug / safe mode
+    fifo.discard(0);
+}
+
 test "LinearFifo(u8, .Dynamic)" {
     var fifo = LinearFifo(u8, .Dynamic).init(testing.allocator);
     defer fifo.deinit();