commit bddb2583f2fe3529787f55a4143b24db42951721
author Cathal Corbett <cathal.corbett@arm.com> Tue Nov 23 11:49:23 2021 +0000
committer Cathal Corbett <cathal.corbett@arm.com> Tue Nov 23 16:52:46 2021 +0000
tree 37061e1bb32cc1d466cc04cdfbd85665c8542aa0
parent f7b5011298367c6d635b17ad029c627076072198

IVGCVSW-6610 No bounds checking performed when indexing PermutationVector elements.

  * Added out of bounds index error checking to PermutationVector operator[] method
    in Types.hpp.
  * Added armnn unit tests to UnitsTests.cpp to check error when using
    PermutationVector alone and with TransposeDescriptor and PermuteDescriptor.
  * Added pyarmnn unit test to check error when using PermutationVector.

Signed-off-by: Cathal Corbett <cathal.corbett@arm.com>
Change-Id: Ie5a8090f07b571a6bdf79a8cad621c31cc1891b7

include/armnn/Types.hpp

diff --git a/include/armnn/Types.hpp b/include/armnn/Types.hpp
index b5a4266..880a6dd 100644
--- a/include/armnn/Types.hpp
+++ b/include/armnn/Types.hpp
@@ -306,7 +306,21 @@
 
     PermutationVector(std::initializer_list<ValueType> dimMappings);
 
-    ValueType operator[](SizeType i) const { return m_DimMappings.at(i); }
+    ///
+    /// Indexing method with out-of-bounds error checking for the m_DimMappings array.
+    /// @param i - integer value corresponding to index of m_DimMappings array to retrieve element from.
+    /// @return element at index i of m_DimMappings array.
+    /// @throws InvalidArgumentException when indexing out-of-bounds index of m_DimMappings array.
+    ///
+    ValueType operator[](SizeType i) const
+    {
+        if (i >= GetSize())
+        {
+            throw InvalidArgumentException("Invalid indexing of PermutationVector of size " + std::to_string(GetSize())
+                                            + " at location [" + std::to_string(i) + "].");
+        }
+        return m_DimMappings.at(i);
+    }
 
     SizeType GetSize() const { return m_NumDimMappings; }
 

python/pyarmnn/test/test_types.py

diff --git a/python/pyarmnn/test/test_types.py b/python/pyarmnn/test/test_types.py
index dfe1429..500a779 100644
--- a/python/pyarmnn/test/test_types.py
+++ b/python/pyarmnn/test/test_types.py
@@ -27,3 +27,8 @@
 
     pv4 = ann.PermutationVector((0, 3, 1, 2))
     assert pv.IsInverse(pv4)
+
+    with pytest.raises(ValueError) as err:
+        pv4[4]
+
+    assert err.type is ValueError

src/armnn/test/UtilsTests.cpp

diff --git a/src/armnn/test/UtilsTests.cpp b/src/armnn/test/UtilsTests.cpp
index 1599d0c..6388437 100644
--- a/src/armnn/test/UtilsTests.cpp
+++ b/src/armnn/test/UtilsTests.cpp
@@ -269,6 +269,28 @@
     CHECK(permuted.GetQuantizationDim().value() == 3U);
 }
 
+TEST_CASE("EmptyPermuteVectorIndexOutOfBounds")
+{
+    armnn::PermutationVector pv = armnn::PermutationVector({});
+    CHECK_THROWS_AS(pv[0], armnn::InvalidArgumentException);
+}
+
+TEST_CASE("PermuteDescriptorIndexOutOfBounds")
+{
+    armnn::PermutationVector pv = armnn::PermutationVector({ 1u, 2u, 0u });
+    armnn::PermuteDescriptor desc = armnn::PermuteDescriptor(pv);
+    CHECK_THROWS_AS(desc.m_DimMappings[3], armnn::InvalidArgumentException);
+    CHECK(desc.m_DimMappings[0] == 1u);
+}
+
+TEST_CASE("TransposeDescriptorIndexOutOfBounds")
+{
+    armnn::PermutationVector pv = armnn::PermutationVector({ 2u, 1u, 0u });
+    armnn::TransposeDescriptor desc = armnn::TransposeDescriptor(pv);
+    CHECK_THROWS_AS(desc.m_DimMappings[3], armnn::InvalidArgumentException);
+    CHECK(desc.m_DimMappings[2] == 0u);
+}
+
 TEST_CASE("PermuteVectorIterator")
 {
     // We're slightly breaking the spirit of std::array.end() because we're using it as a