uint128.h revision 90eb38579e280c6a0e466177b2a9632ab9eb8c44
/** @file
* IPRT - RTUINT128U & uint128_t methods.
*/
/*
* Copyright (C) 2011 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___iprt_uint128_h
#define ___iprt_uint128_h
/** @defgroup grp_rt_once RTUInt128 - 128-bit Unsigned Integer Methods
* @ingroup grp_rt
* @{
*/
/**
* Test if a 128-bit unsigned integer value is zero.
*
* @returns true if they are, false if they aren't.
* @param pValue The input and output value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
}
/**
* Set a 128-bit unsigned integer value to zero.
*
* @returns pResult
* @param pResult The result variable.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pResult;
}
/**
* Set a 128-bit unsigned integer value to the maximum value.
*
* @returns pResult
* @param pResult The result variable.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pResult;
}
/**
* Assigns one 128-bit unsigned integer value to another.
*
* @returns pResult
* @param pResult The result variable.
* @param pValue The value to assign.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pResult;
}
/**
* Assigns a boolean value to 128-bit unsigned integer.
*
* @returns pResult
* @param pResult The result variable.
* @param fValue The boolean value.
*/
{
#if ARCH_BITS >= 64
pValueResult->s.Hi = 0;
#else
#endif
return pValueResult;
}
/**
* Assigns a 8-bit unsigned integer value to 128-bit unsigned integer.
*
* @returns pResult
* @param pResult The result variable.
* @param u8Value The 8-bit unsigned integer value.
*/
{
#if ARCH_BITS >= 64
pValueResult->s.Hi = 0;
#else
#endif
return pValueResult;
}
/**
* Assigns a 16-bit unsigned integer value to 128-bit unsigned integer.
*
* @returns pResult
* @param pResult The result variable.
* @param u16Value The 16-bit unsigned integer value.
*/
{
#if ARCH_BITS >= 64
pValueResult->s.Hi = 0;
#else
#endif
return pValueResult;
}
/**
* Assigns a 16-bit unsigned integer value to 128-bit unsigned integer.
*
* @returns pResult
* @param pResult The result variable.
* @param u32Value The 32-bit unsigned integer value.
*/
{
#if ARCH_BITS >= 64
pValueResult->s.Hi = 0;
#else
#endif
return pValueResult;
}
/**
* Assigns a 64-bit unsigned integer value to 128-bit unsigned integer.
*
* @returns pResult
* @param pResult The result variable.
* @param u32Value The 32-bit unsigned integer value.
*/
{
pValueResult->s.Hi = 0;
return pValueResult;
}
/**
* Performs a bitwise AND of two 128-bit unsigned integer values and assigned
* the result to the first one.
*
* @returns pValue1Result.
* @param pValue1Result The first value and result.
* @param pValue2 The second value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pValue1Result;
}
/**
* Performs a bitwise AND of a 128-bit unsigned integer value and a mask made
* up of the first N bits, assigning the result to the the 128-bit value.
*
* @returns pValueResult.
* @param pValueResult The value and result.
* @param cBits The number of bits to AND (counting from the first
* bit).
*/
{
if (cBits <= 64)
{
if (cBits != 64)
pValueResult->s.Hi = 0;
}
else if (cBits < 128)
/** @todo #if ARCH_BITS >= 64 */
return pValueResult;
}
/**
* Performs a bitwise OR of two 128-bit unsigned integer values and assigned
* the result to the first one.
*
* @returns pValue1Result.
* @param pValue1Result The first value and result.
* @param pValue2 The second value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pValue1Result;
}
/**
* Performs a bitwise XOR of two 128-bit unsigned integer values and assigned
* the result to the first one.
*
* @returns pValue1Result.
* @param pValue1Result The first value and result.
* @param pValue2 The second value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pValue1Result;
}
/**
* Performs a bitwise left shift on a 128-bit unsigned integer value, assigning
* the result to it.
*
* @returns pValue1Result.
* @param pValue1Result The first value and result.
* @param cBits The number of bits to shift.
*/
{
/** @todo #if ARCH_BITS >= 64 */
if (cBits > 0)
{
/* (left shift) */
if (cBits >= 128)
else if (cBits >= 64)
{
pValueResult->s.Lo = 0;
}
else
{
}
}
else if (cBits < 0)
{
/* (right shift) */
if (cBits >= 128)
else if (cBits >= 64)
{
pValueResult->s.Hi = 0;
}
else
{
}
}
return pValueResult;
}
/**
* Performs a bitwise left shift on a 128-bit unsigned integer value, assigning
* the result to it.
*
* @returns pValue1Result.
* @param pValue1Result The first value and result.
* @param cBits The number of bits to shift.
*/
{
}
/**
* Performs a bitwise NOT on a 128-bit unsigned integer value, assigning the
* result to it.
*
* @returns pValueResult
* @param pValueResult The value and result.
*/
{
#if ARCH_BITS >= 64
#else
#endif
return pValueResult;
}
/**
* Performs a boolean NOT on a 128-bit unsigned integer value, assigning the
* result to it.
*
* @returns pValueResult
* @param pValueResult The value and result.
*/
{
}
/**
* Compares two 128-bit unsigned integer values.
*
* @retval 0 if equal.
* @retval -1 if the first value is smaller than the second.
* @retval 1 if the first value is larger than the second.
*
* @param pValue1 The first value.
* @param pValue2 The second value.
*/
{
#if ARCH_BITS >= 64
return 0;
#else
return 0;
#endif
}
/**
* Tests if two 128-bit unsigned integer values not equal.
*
* @returns true if equal, false if not equal.
* @param pValue1 The first value.
* @param pValue2 The second value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
}
/**
* Tests if two 128-bit unsigned integer values are not equal.
*
* @returns true if not equal, false if equal.
* @param pValue1 The first value.
* @param pValue2 The second value.
*/
{
}
/**
* Sets a bit in a 128-bit unsigned integer type.
*
* @returns pValueResult.
* @param pValueResult The input and output value.
* @param iBit The bit to set.
*/
{
if (iBit < 64)
{
#if ARCH_BITS >= 64
#else
if (iBit < 32)
else
#endif
}
else if (iBit < 128)
{
#if ARCH_BITS >= 64
#else
if (iBit < 96)
else
#endif
}
return pValueResult;
}
/**
* Sets a bit in a 128-bit unsigned integer type.
*
* @returns pValueResult.
* @param pValueResult The input and output value.
* @param iBit The bit to set.
*/
{
if (iBit < 64)
{
#if ARCH_BITS >= 64
#else
if (iBit < 32)
else
#endif
}
else if (iBit < 128)
{
#if ARCH_BITS >= 64
#else
if (iBit < 96)
else
#endif
}
return pValueResult;
}
/**
* Tests if a bit in a 128-bit unsigned integer value is set.
*
* @returns pValueResult.
* @param pValueResult The input and output value.
* @param iBit The bit to test.
*/
{
bool fRc;
if (iBit < 64)
{
#if ARCH_BITS >= 64
#else
if (iBit < 32)
else
#endif
}
else if (iBit < 128)
{
#if ARCH_BITS >= 64
#else
if (iBit < 96)
else
#endif
}
else
fRc = false;
return fRc;
}
/**
* Set a range of bits a 128-bit unsigned integer value.
*
* @returns pValueResult.
* @param pValueResult The input and output value.
* @param iFirstBit The first bit to test.
* @param cBits The number of bits to set.
*/
DECLINLINE(PRTUINT128U) RTUInt128BitSetRange(PRTUINT128U pValueResult, unsigned iFirstBit, unsigned cBits)
{
/* bounds check & fix. */
if (iFirstBit < 128)
{
#if ARCH_BITS >= 64
else
#else
else
#endif
while (cBits-- > 0)
}
return pValueResult;
}
/**
* Test if all the bits of a 128-bit unsigned integer value are set.
*
* @returns true if they are, false if they aren't.
* @param pValue The input and output value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
}
/**
* Test if all the bits of a 128-bit unsigned integer value are clear.
*
* @returns true if they are, false if they aren't.
* @param pValue The input and output value.
*/
{
#if ARCH_BITS >= 64
#else
#endif
}
/** @} */
#endif