--- /dev/null
+/** @file\r
+ x64-specific functions for unit-testing INTN and UINTN functions in\r
+ SafeIntLib.\r
+\r
+ Copyright (c) Microsoft Corporation.<BR>\r
+ Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include <gtest/gtest.h>\r
+extern "C" {\r
+ #include <Base.h>\r
+ #include <Library/SafeIntLib.h>\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeInt32ToUintn) {\r
+ RETURN_STATUS Status;\r
+ INT32 Operand;\r
+ UINTN Result;\r
+\r
+ //\r
+ // If Operand is non-negative, then it's a cast\r
+ //\r
+ Operand = 0x5bababab;\r
+ Result = 0;\r
+ Status = SafeInt32ToUintn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((UINTN)0x5bababab, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (-1537977259);\r
+ Status = SafeInt32ToUintn (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeUint32ToIntn) {\r
+ RETURN_STATUS Status;\r
+ UINT32 Operand;\r
+ INTN Result;\r
+\r
+ //\r
+ // For x64, INTN is same as INT64 which is a superset of INT32\r
+ // This is just a cast then, and it'll never fail\r
+ //\r
+\r
+ //\r
+ // If Operand is non-negative, then it's a cast\r
+ //\r
+ Operand = 0xabababab;\r
+ Result = 0;\r
+ Status = SafeUint32ToIntn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0xabababab, Result);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeIntnToInt32) {\r
+ RETURN_STATUS Status;\r
+ INTN Operand;\r
+ INT32 Result;\r
+\r
+ //\r
+ // If Operand is between MIN_INT32 and MAX_INT32 inclusive, then it's a cast\r
+ //\r
+ Operand = 0x5bababab;\r
+ Result = 0;\r
+ Status = SafeIntnToInt32 (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x5bababab, Result);\r
+\r
+ Operand = (-1537977259);\r
+ Status = SafeIntnToInt32 (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((-1537977259), Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (0x5babababefefefef);\r
+ Status = SafeIntnToInt32 (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+\r
+ Operand = (-6605562033422200815);\r
+ Status = SafeIntnToInt32 (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeIntnToUint32) {\r
+ RETURN_STATUS Status;\r
+ INTN Operand;\r
+ UINT32 Result;\r
+\r
+ //\r
+ // If Operand is between 0 and MAX_UINT32 inclusive, then it's a cast\r
+ //\r
+ Operand = 0xabababab;\r
+ Result = 0;\r
+ Status = SafeIntnToUint32 (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0xabababab, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (0x5babababefefefef);\r
+ Status = SafeIntnToUint32 (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+\r
+ Operand = (-6605562033422200815);\r
+ Status = SafeIntnToUint32 (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeUintnToUint32) {\r
+ RETURN_STATUS Status;\r
+ UINTN Operand;\r
+ UINT32 Result;\r
+\r
+ //\r
+ // If Operand is <= MAX_UINT32, then it's a cast\r
+ //\r
+ Operand = 0xabababab;\r
+ Result = 0;\r
+ Status = SafeUintnToUint32 (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0xabababab, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (0xababababefefefef);\r
+ Status = SafeUintnToUint32 (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeUintnToIntn) {\r
+ RETURN_STATUS Status;\r
+ UINTN Operand;\r
+ INTN Result;\r
+\r
+ //\r
+ // If Operand is <= MAX_INTN (0x7fff_ffff_ffff_ffff), then it's a cast\r
+ //\r
+ Operand = 0x5babababefefefef;\r
+ Result = 0;\r
+ Status = SafeUintnToIntn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x5babababefefefef, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (0xababababefefefef);\r
+ Status = SafeUintnToIntn (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeUintnToInt64) {\r
+ RETURN_STATUS Status;\r
+ UINTN Operand;\r
+ INT64 Result;\r
+\r
+ //\r
+ // If Operand is <= MAX_INT64, then it's a cast\r
+ //\r
+ Operand = 0x5babababefefefef;\r
+ Result = 0;\r
+ Status = SafeUintnToInt64 (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x5babababefefefef, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (0xababababefefefef);\r
+ Status = SafeUintnToInt64 (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeInt64ToIntn) {\r
+ RETURN_STATUS Status;\r
+ INT64 Operand;\r
+ INTN Result;\r
+\r
+ //\r
+ // INTN is same as INT64 in x64, so this is just a cast\r
+ //\r
+ Operand = 0x5babababefefefef;\r
+ Result = 0;\r
+ Status = SafeInt64ToIntn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x5babababefefefef, Result);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeInt64ToUintn) {\r
+ RETURN_STATUS Status;\r
+ INT64 Operand;\r
+ UINTN Result;\r
+\r
+ //\r
+ // If Operand is non-negative, then it's a cast\r
+ //\r
+ Operand = 0x5babababefefefef;\r
+ Result = 0;\r
+ Status = SafeInt64ToUintn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((UINTN)0x5babababefefefef, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (-6605562033422200815);\r
+ Status = SafeInt64ToUintn (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeUint64ToIntn) {\r
+ RETURN_STATUS Status;\r
+ UINT64 Operand;\r
+ INTN Result;\r
+\r
+ //\r
+ // If Operand is <= MAX_INTN (0x7fff_ffff_ffff_ffff), then it's a cast\r
+ //\r
+ Operand = 0x5babababefefefef;\r
+ Result = 0;\r
+ Status = SafeUint64ToIntn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x5babababefefefef, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Operand = (0xababababefefefef);\r
+ Status = SafeUint64ToIntn (Operand, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(ConversionTestSuite, TestSafeUint64ToUintn) {\r
+ RETURN_STATUS Status;\r
+ UINT64 Operand;\r
+ UINTN Result;\r
+\r
+ //\r
+ // UINTN is same as UINT64 in x64, so this is just a cast\r
+ //\r
+ Operand = 0xababababefefefef;\r
+ Result = 0;\r
+ Status = SafeUint64ToUintn (Operand, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0xababababefefefef, Result);\r
+}\r
+\r
+TEST(AdditionSubtractionTestSuite, TestSafeUintnAdd) {\r
+ RETURN_STATUS Status;\r
+ UINTN Augend;\r
+ UINTN Addend;\r
+ UINTN Result;\r
+\r
+ //\r
+ // If the result of addition doesn't overflow MAX_UINTN, then it's addition\r
+ //\r
+ Augend = 0x3a3a3a3a12121212;\r
+ Addend = 0x3a3a3a3a12121212;\r
+ Result = 0;\r
+ Status = SafeUintnAdd (Augend, Addend, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((UINTN)0x7474747424242424, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Augend = 0xababababefefefef;\r
+ Addend = 0xbcbcbcbcdededede;\r
+ Status = SafeUintnAdd (Augend, Addend, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(AdditionSubtractionTestSuite, TestSafeIntnAdd) {\r
+ RETURN_STATUS Status;\r
+ INTN Augend;\r
+ INTN Addend;\r
+ INTN Result;\r
+\r
+ //\r
+ // If the result of addition doesn't overflow MAX_INTN\r
+ // and doesn't underflow MIN_INTN, then it's addition\r
+ //\r
+ Augend = 0x3a3a3a3a3a3a3a3a;\r
+ Addend = 0x3a3a3a3a3a3a3a3a;\r
+ Result = 0;\r
+ Status = SafeIntnAdd (Augend, Addend, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x7474747474747474, Result);\r
+\r
+ Augend = (-4195730024608447034);\r
+ Addend = (-4195730024608447034);\r
+ Status = SafeIntnAdd (Augend, Addend, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((-8391460049216894068), Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Augend = 0x5a5a5a5a5a5a5a5a;\r
+ Addend = 0x5a5a5a5a5a5a5a5a;\r
+ Status = SafeIntnAdd (Augend, Addend, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+\r
+ Augend = (-6510615555426900570);\r
+ Addend = (-6510615555426900570);\r
+ Status = SafeIntnAdd (Augend, Addend, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(AdditionSubtractionTestSuite, TestSafeUintnSub) {\r
+ RETURN_STATUS Status;\r
+ UINTN Minuend;\r
+ UINTN Subtrahend;\r
+ UINTN Result;\r
+\r
+ //\r
+ // If Minuend >= Subtrahend, then it's subtraction\r
+ //\r
+ Minuend = 0x5a5a5a5a5a5a5a5a;\r
+ Subtrahend = 0x3b3b3b3b3b3b3b3b;\r
+ Result = 0;\r
+ Status = SafeUintnSub (Minuend, Subtrahend, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((UINTN)0x1f1f1f1f1f1f1f1f, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Minuend = 0x5a5a5a5a5a5a5a5a;\r
+ Subtrahend = 0x6d6d6d6d6d6d6d6d;\r
+ Status = SafeUintnSub (Minuend, Subtrahend, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(AdditionSubtractionTestSuite, TestSafeIntnSub) {\r
+ RETURN_STATUS Status;\r
+ INTN Minuend;\r
+ INTN Subtrahend;\r
+ INTN Result;\r
+\r
+ //\r
+ // If the result of subtractions doesn't overflow MAX_INTN or\r
+ // underflow MIN_INTN, then it's subtraction\r
+ //\r
+ Minuend = 0x5a5a5a5a5a5a5a5a;\r
+ Subtrahend = 0x3a3a3a3a3a3a3a3a;\r
+ Result = 0;\r
+ Status = SafeIntnSub (Minuend, Subtrahend, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x2020202020202020, Result);\r
+\r
+ Minuend = 0x3a3a3a3a3a3a3a3a;\r
+ Subtrahend = 0x5a5a5a5a5a5a5a5a;\r
+ Status = SafeIntnSub (Minuend, Subtrahend, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((-2314885530818453536), Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Minuend = (-8825501086245354106);\r
+ Subtrahend = 8825501086245354106;\r
+ Status = SafeIntnSub (Minuend, Subtrahend, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+\r
+ Minuend = (8825501086245354106);\r
+ Subtrahend = (-8825501086245354106);\r
+ Status = SafeIntnSub (Minuend, Subtrahend, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(MultiplicationTestSuite, TestSafeUintnMult) {\r
+ RETURN_STATUS Status;\r
+ UINTN Multiplicand;\r
+ UINTN Multiplier;\r
+ UINTN Result;\r
+\r
+ //\r
+ // If the result of multiplication doesn't overflow MAX_UINTN, it will succeed\r
+ //\r
+ Multiplicand = 0x123456789a;\r
+ Multiplier = 0x1234567;\r
+ Result = 0;\r
+ Status = SafeUintnMult (Multiplicand, Multiplier, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ ((UINTN)0x14b66db9745a07f6, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Multiplicand = 0x123456789a;\r
+ Multiplier = 0x12345678;\r
+ Status = SafeUintnMult (Multiplicand, Multiplier, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r
+\r
+TEST(MultiplicationTestSuite, TestSafeIntnMult) {\r
+ RETURN_STATUS Status;\r
+ INTN Multiplicand;\r
+ INTN Multiplier;\r
+ INTN Result;\r
+\r
+ //\r
+ // If the result of multiplication doesn't overflow MAX_INTN and doesn't\r
+ // underflow MIN_UINTN, it will succeed\r
+ //\r
+ Multiplicand = 0x123456789;\r
+ Multiplier = 0x6789abcd;\r
+ Result = 0;\r
+ Status = SafeIntnMult (Multiplicand, Multiplier, &Result);\r
+ ASSERT_EQ (Status, RETURN_SUCCESS);\r
+ ASSERT_EQ (0x75cd9045220d6bb5, Result);\r
+\r
+ //\r
+ // Otherwise should result in an error status\r
+ //\r
+ Multiplicand = 0x123456789;\r
+ Multiplier = 0xa789abcd;\r
+ Status = SafeIntnMult (Multiplicand, Multiplier, &Result);\r
+ ASSERT_EQ (RETURN_BUFFER_TOO_SMALL, Status);\r
+}\r