MdePkg/Test: Add SafeIntLib and BaseLib Base64 unit tests

https://bugzilla.tianocore.org/show_bug.cgi?id=2505

* Add unit tests for SafeIntLib class
* Add unit tests for BaseLib Base64 conversion APIs.
* Add Test/MdePkgHostTest.dsc -to build host based unit
  tests
* Update MdePkg.dsc to build target based tests for
  SafeIntLib and BaseLib
* Update MdePkg.ci.yaml to build and run host based
  tests for SafeIntLib and BaseLib

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Acked-by: Hao A Wu <hao.a.wu@intel.com>
Reviewed-by: Bret Barkelew <Bret.Barkelew@microsoft.com>
This commit is contained in:
Michael D Kinney
2020-01-22 10:15:11 -08:00
committed by mergify[bot]
parent 3e61b953b7
commit e50c2bb383
16 changed files with 5034 additions and 3 deletions

View File

@@ -0,0 +1,540 @@
/** @file
IA32-specific functions for unit-testing INTN and UINTN functions in
SafeIntLib.
Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "TestBaseSafeIntLib.h"
UNIT_TEST_STATUS
EFIAPI
TestSafeInt32ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT32 Operand;
UINTN Result;
//
// If Operand is non-negative, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeInt32ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (-1537977259);
Status = SafeInt32ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint32ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT32 Operand;
INTN Result;
//
// If Operand is <= MAX_INTN, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeUint32ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xabababab);
Status = SafeUint32ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToInt32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Operand;
INT32 Result;
//
// INTN is same as INT32 in IA32, so this is just a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeIntnToInt32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToUint32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Operand;
UINT32 Result;
//
// If Operand is non-negative, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (-1537977259);
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToUint32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
UINT32 Result;
//
// UINTN is same as UINT32 in IA32, so this is just a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUintnToUint32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
INTN Result;
//
// If Operand is <= MAX_INTN, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeUintnToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xabababab);
Status = SafeUintnToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToInt64 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
INT64 Result;
//
// UINTN is same as UINT32 in IA32, and UINT32 is a subset of
// INT64, so this is just a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUintnToInt64(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT64 Operand;
INTN Result;
//
// If Operand is between MIN_INTN and MAX_INTN2 inclusive, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
Operand = (-1537977259);
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-1537977259), Result);
//
// Otherwise should result in an error status
//
Operand = (0x5babababefefefef);
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Operand = (-6605562033422200815);
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT64 Operand;
UINTN Result;
//
// If Operand is between 0 and MAX_UINTN inclusive, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0x5babababefefefef);
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Operand = (-6605562033422200815);
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT64 Operand;
INTN Result;
//
// If Operand is <= MAX_INTN, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeUint64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUint64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT64 Operand;
UINTN Result;
//
// If Operand is <= MAX_UINTN, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUint64ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUint64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnAdd (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Augend;
UINTN Addend;
UINTN Result;
//
// If the result of addition doesn't overflow MAX_UINTN, then it's addition
//
Augend = 0x3a3a3a3a;
Addend = 0x3a3a3a3a;
Result = 0;
Status = SafeUintnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x74747474, Result);
//
// Otherwise should result in an error status
//
Augend = 0xabababab;
Addend = 0xbcbcbcbc;
Status = SafeUintnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnAdd (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Augend;
INTN Addend;
INTN Result;
//
// If the result of addition doesn't overflow MAX_INTN
// and doesn't underflow MIN_INTN, then it's addition
//
Augend = 0x3a3a3a3a;
Addend = 0x3a3a3a3a;
Result = 0;
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x74747474, Result);
Augend = (-976894522);
Addend = (-976894522);
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-1953789044), Result);
//
// Otherwise should result in an error status
//
Augend = 0x5a5a5a5a;
Addend = 0x5a5a5a5a;
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Augend = (-1515870810);
Addend = (-1515870810);
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnSub (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Minuend;
UINTN Subtrahend;
UINTN Result;
//
// If Minuend >= Subtrahend, then it's subtraction
//
Minuend = 0x5a5a5a5a;
Subtrahend = 0x3b3b3b3b;
Result = 0;
Status = SafeUintnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x1f1f1f1f, Result);
//
// Otherwise should result in an error status
//
Minuend = 0x5a5a5a5a;
Subtrahend = 0x6d6d6d6d;
Status = SafeUintnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnSub (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Minuend;
INTN Subtrahend;
INTN Result;
//
// If the result of subtractions doesn't overflow MAX_INTN or
// underflow MIN_INTN, then it's subtraction
//
Minuend = 0x5a5a5a5a;
Subtrahend = 0x3a3a3a3a;
Result = 0;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x20202020, Result);
Minuend = 0x3a3a3a3a;
Subtrahend = 0x5a5a5a5a;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-538976288), Result);
//
// Otherwise should result in an error status
//
Minuend = (-2054847098);
Subtrahend = 2054847098;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Minuend = (2054847098);
Subtrahend = (-2054847098);
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnMult (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Multiplicand;
UINTN Multiplier;
UINTN Result;
//
// If the result of multiplication doesn't overflow MAX_UINTN, it will succeed
//
Multiplicand = 0xa122a;
Multiplier = 0xd23;
Result = 0;
Status = SafeUintnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x844c9dbe, Result);
//
// Otherwise should result in an error status
//
Multiplicand = 0xa122a;
Multiplier = 0xed23;
Status = SafeUintnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnMult (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Multiplicand;
INTN Multiplier;
INTN Result;
//
// If the result of multiplication doesn't overflow MAX_INTN and doesn't
// underflow MIN_UINTN, it will succeed
//
Multiplicand = 0x123456;
Multiplier = 0x678;
Result = 0;
Status = SafeIntnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x75c28c50, Result);
//
// Otherwise should result in an error status
//
Multiplicand = 0x123456;
Multiplier = 0xabc;
Status = SafeIntnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}

View File

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

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,123 @@
/** @file
UEFI OS based application for unit testing the SafeIntLib.
Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _TEST_BASE_SAFE_INT_LIB_H_
#define _TEST_BASE_SAFE_INT_LIB_H_
#include <PiPei.h>
#include <Uefi.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UnitTestLib.h>
#include <Library/SafeIntLib.h>
UNIT_TEST_STATUS
EFIAPI
TestSafeInt32ToUintn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUint32ToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToInt32(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToUint32(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToUint32(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToInt64(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToUintn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToUintn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnAdd(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnAdd(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnSub(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnSub(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnMult(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnMult(
IN UNIT_TEST_CONTEXT Context
);
#endif

View File

@@ -0,0 +1,13 @@
// /** @file
// Application that Unit Tests the SafeIntLib
//
// Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
// **/
#string STR_MODULE_ABSTRACT #language en-US "Application that Unit Tests the SafeIntLib"
#string STR_MODULE_DESCRIPTION #language en-US "Application that Unit Tests the SafeIntLib."

View File

@@ -0,0 +1,45 @@
## @file
# DXE Driver that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibDxe
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 9729DB60-FB9D-4625-9EE1-93B21EC246B8
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
ENTRY_POINT = DxeEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
UefiDriverEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib
[Depex]
TRUE

View File

@@ -0,0 +1,40 @@
## @file
# Host OS based Application that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibHost
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 95487689-9E30-41AD-B773-3650C94BCBE2
MODULE_TYPE = HOST_APPLICATION
VERSION_STRING = 1.0
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
BaseLib
DebugLib
SafeIntLib
UnitTestLib

View File

@@ -0,0 +1,45 @@
## @file
# PEIM that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibPei
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 7D910602-ED53-45E6-826E-8266705B9734
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
ENTRY_POINT = PeiEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
PeimEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib
[Depex]
TRUE

View File

@@ -0,0 +1,45 @@
## @file
# SMM Driver that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibSmm
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 2F2A1907-B1B4-4E33-8B83-62A60AB4F0D4
MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0
ENTRY_POINT = DxeEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
UefiDriverEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib
[Depex]
TRUE

View File

@@ -0,0 +1,42 @@
## @file
# UEFI Shell based Application that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibUefiShell
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 1F91B73E-5B6A-4317-80E8-E7C36A3C7AF4
MODULE_TYPE = UEFI_APPLICATION
VERSION_STRING = 1.0
ENTRY_POINT = DxeEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
UefiApplicationEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib