base: Fix isSubset() for addr ranges with interleaving

This change extends isSubset() which checks whether the range is a
subset of an input range to support address ranges with interleaving
and hashing.

Change-Id: I3dc9ceccb189b7c8665de0355f0555fc2c37d872
Reviewed-on: https://gem5-review.googlesource.com/12319
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>
Maintainer: Nikos Nikoleris <nikos.nikoleris@arm.com>

src/base/SConscript

@@ -82,6 +82,7 @@ Source('loader/symtab.cc')
 
 Source('stats/text.cc')
 
+GTest('addr_range_test', 'addr_range_test.cc')
 GTest('bituniontest', 'bituniontest.cc')
 
 DebugFlag('Annotate', "State machine annotation debugging")

src/base/addr_range.hh

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2014, 2017 ARM Limited
+ * Copyright (c) 2012, 2014, 2017-2018 ARM Limited
  * All rights reserved
  *
  * The license below extends only to copyright in the software and shall
@@ -45,6 +45,7 @@
 #ifndef __BASE_ADDR_RANGE_HH__
 #define __BASE_ADDR_RANGE_HH__
 
+#include <algorithm>
 #include <list>
 #include <vector>
 
@@ -195,7 +196,17 @@ class AddrRange
      */
     uint64_t granularity() const
     {
-        return ULL(1) << (intlvHighBit - intlvBits + 1);
+        if (interleaved()) {
+            const uint8_t intlv_low_bit = intlvHighBit - intlvBits + 1;
+            if (hashed()) {
+                const uint8_t xor_low_bit = xorHighBit - intlvBits + 1;
+                return ULL(1) << std::min(intlv_low_bit, xor_low_bit);
+            } else {
+                return ULL(1) << intlv_low_bit;
+            }
+        } else {
+            return size();
+        }
     }
 
     /**
@@ -316,7 +327,17 @@ class AddrRange
     {
         if (interleaved())
             panic("Cannot test subset of interleaved range %s\n", to_string());
-        return _start >= r._start && _end <= r._end;
+
+        // This address range is not interleaved and therefore it
+        // suffices to check the upper bound, the lower bound and
+        // whether it would fit in a continuous segment of the input
+        // addr range.
+        if (r.interleaved()) {
+            return r.contains(_start) && r.contains(_end) &&
+                size() <= r.granularity();
+        } else {
+            return _start >= r._start && _end <= r._end;
+        }
     }
 
     /**

src/base/addr_range_test.cc

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2018 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Nikos Nikoleris
+ */
+
+#include <gtest/gtest.h>
+
+#include "base/addr_range.hh"
+
+TEST(AddrRangeComp, AddrRangeIsSubset)
+{
+    AddrRange r, r1, r2;
+
+    // Test non-interleaved ranges
+    r1 = AddrRange(0x0, 0x7f);
+    r2 = AddrRange(0x80, 0xff);
+
+    r = AddrRange(0x0, 0xf);
+    EXPECT_TRUE(r.isSubset(r1));
+    EXPECT_FALSE(r.isSubset(r2));
+
+    r = AddrRange(0x80, 0x8f);
+    EXPECT_FALSE(r.isSubset(r1));
+    EXPECT_TRUE(r.isSubset(r2));
+
+    // Test interleaved ranges
+    r1 = AddrRange(0x0, 0xff, 6, 0, 1, 0);
+    r2 = AddrRange(0x0, 0xff, 6, 0, 1, 1);
+
+    r = AddrRange(0x0, 0xf);
+    EXPECT_TRUE(r.isSubset(r1));
+    EXPECT_FALSE(r.isSubset(r2));
+
+    r = AddrRange(0x40, 0x4f);
+    EXPECT_FALSE(r.isSubset(r1));
+    EXPECT_TRUE(r.isSubset(r2));
+
+    r = AddrRange(0xbf, 0xc0);
+    EXPECT_FALSE(r.isSubset(r1));
+    EXPECT_FALSE(r.isSubset(r2));
+
+    // Test interleaved ranges with hashing
+    r1 = AddrRange(0x0, 0xff, 6, 7, 1, 0);
+    r2 = AddrRange(0x0, 0xff, 6, 7, 1, 1);
+
+    r = AddrRange(0x0, 0xf);
+    EXPECT_TRUE(r.isSubset(r1));
+    EXPECT_FALSE(r.isSubset(r2));
+
+    r = AddrRange(0x40, 0x4f);
+    EXPECT_FALSE(r.isSubset(r1));
+    EXPECT_TRUE(r.isSubset(r2));
+
+    r = AddrRange(0xbf, 0xc0);
+    EXPECT_FALSE(r.isSubset(r1));
+    EXPECT_FALSE(r.isSubset(r2));
+}