Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Classes | Macros | Typedefs | Functions
misc.h File Reference

Utility functions for the Crypto++ library. More...

Go to the source code of this file.

Classes

class  ObjectHolder< T >
 Uses encapsulation to hide an object in derived classes. More...
 
class  NotCopyable
 Ensures an object is not copyable. More...
 
class  NewObject< T >
 An object factory function. More...
 
class  Singleton< T, F, instance >
 Restricts the instantiation of a class to one static object without locks. More...
 
class  GetBlock< T, B, A >
 
class  PutBlock< T, B, A >
 
struct  BlockGetAndPut< T, B, GA, PA >
 
struct  SafeShifter< overflow >
 
struct  SafeShifter< true >
 
struct  SafeShifter< false >
 

Macros

#define SIZE_MAX   ...
 The maximum value of a machine word. More...
 
#define CRYPTOPP_COMPILE_ASSERT(expr)   ...
 Compile time assertion. More...
 
#define COUNTOF(arr)
 Counts elements in an array. More...
 
#define MEMORY_BARRIER   ...
 A memory barrier. More...
 
#define RETURN_IF_NONZERO(x)   size_t returnedValue = x; if (returnedValue) return returnedValue
 
#define GETBYTE(x, y)   (unsigned int)byte((x)>>(8*(y)))
 
#define CRYPTOPP_GET_BYTE_AS_BYTE(x, y)   byte((x)>>(8*(y)))
 
#define CRYPTOPP_BLOCK_1(n, t, s)   t* m_##n() {return (t *)(m_aggregate+0);} size_t SS1() {return sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_2(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS1());} size_t SS2() {return SS1()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_3(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS2());} size_t SS3() {return SS2()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_4(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS3());} size_t SS4() {return SS3()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_5(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS4());} size_t SS5() {return SS4()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_6(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS5());} size_t SS6() {return SS5()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_7(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS6());} size_t SS7() {return SS6()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCK_8(n, t, s)   t* m_##n() {return (t *)(m_aggregate+SS7());} size_t SS8() {return SS7()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}
 
#define CRYPTOPP_BLOCKS_END(i)   size_t SST() {return SS##i();} void AllocateBlocks() {m_aggregate.New(SST());} AlignedSecByteBlock m_aggregate;
 

Typedefs

typedef LittleEndian NativeByteOrder
 

Functions

void memcpy_s (void *dest, size_t sizeInBytes, const void *src, size_t count)
 Bounds checking replacement for memcpy() More...
 
void memmove_s (void *dest, size_t sizeInBytes, const void *src, size_t count)
 Bounds checking replacement for memmove() More...
 
void * memset_z (void *ptr, int value, size_t num)
 Memory block initializer and eraser that attempts to survive optimizations. More...
 
template<class T >
const T & STDMIN (const T &a, const T &b)
 Replacement function for std::min. More...
 
template<class T >
const T & STDMAX (const T &a, const T &b)
 Replacement function for std::max. More...
 
template<class T1 , class T2 >
const T1 UnsignedMin (const T1 &a, const T2 &b)
 Safe comparison of values that could be neagtive and incorrectly promoted. More...
 
template<class T1 , class T2 >
bool SafeConvert (T1 from, T2 &to)
 Tests whether a conversion from → to is safe to perform. More...
 
template<class T >
std::string IntToString (T value, unsigned int base=10)
 Converts a value to a string. More...
 
template<>
std::string IntToString< unsigned long long > (unsigned long long value, unsigned int base)
 Converts an unsigned value to a string. More...
 
template<>
std::string IntToString< Integer > (Integer value, unsigned int base)
 Converts an Integer to a string. More...
 
template<class T >
unsigned int Parity (T value)
 Returns the parity of a value. More...
 
template<class T >
unsigned int BytePrecision (const T &value)
 Returns the number of 8-bit bytes or octets required for a value. More...
 
template<class T >
unsigned int BitPrecision (const T &value)
 Returns the number of bits required for a value. More...
 
unsigned int TrailingZeros (word32 v)
 Determines the number of trailing 0-bits in a value. More...
 
unsigned int TrailingZeros (word64 v)
 Determines the number of trailing 0-bits in a value. More...
 
template<class T >
Crop (T value, size_t bits)
 Truncates the value to the specified number of bits. More...
 
size_t BitsToBytes (size_t bitCount)
 Returns the number of 8-bit bytes or octets required for the specified number of bits. More...
 
size_t BytesToWords (size_t byteCount)
 Returns the number of words required for the specified number of bytes. More...
 
size_t BitsToWords (size_t bitCount)
 Returns the number of words required for the specified number of bits. More...
 
size_t BitsToDwords (size_t bitCount)
 Returns the number of double words required for the specified number of bits. More...
 
void xorbuf (byte *buf, const byte *mask, size_t count)
 Performs an XOR of a buffer with a mask. More...
 
void xorbuf (byte *output, const byte *input, const byte *mask, size_t count)
 Performs an XOR of an input buffer with a mask and stores the result in an output buffer. More...
 
bool VerifyBufsEqual (const byte *buf1, const byte *buf2, size_t count)
 Performs a near constant-time comparison of two equally sized buffers. More...
 
template<class T >
bool IsPowerOf2 (const T &value)
 Tests whether a value is a power of 2. More...
 
template<class T1 , class T2 >
T2 ModPowerOf2 (const T1 &a, const T2 &b)
 Tests whether the residue of a value is a power of 2. More...
 
template<class T1 , class T2 >
T1 RoundDownToMultipleOf (const T1 &n, const T2 &m)
 Rounds a value down to a multiple of a second value. More...
 
template<class T1 , class T2 >
T1 RoundUpToMultipleOf (const T1 &n, const T2 &m)
 Rounds a value up to a multiple of a second value. More...
 
template<class T >
unsigned int GetAlignmentOf (T *dummy=NULL)
 Returns the minimum alignment requirements of a type. More...
 
bool IsAlignedOn (const void *ptr, unsigned int alignment)
 Determines whether ptr is aligned to a minimum value. More...
 
template<class T >
bool IsAligned (const void *ptr, T *dummy=NULL)
 Determines whether ptr is minimally aligned. More...
 
ByteOrder GetNativeByteOrder ()
 Returns NativeByteOrder as an enumerated ByteOrder value. More...
 
bool NativeByteOrderIs (ByteOrder order)
 Determines whether order follows native byte ordering. More...
 
template<class T1 , class T2 >
T1 SaturatingSubtract (const T1 &a, const T2 &b)
 Performs a saturating subtract clamped at 0. More...
 
template<class T1 , class T2 >
T1 SaturatingSubtract1 (const T1 &a, const T2 &b)
 Performs a saturating subtract clamped at 1. More...
 
template<class T >
CipherDir GetCipherDir (const T &obj)
 Returns the direction the cipher is being operated. More...
 
void CallNewHandler ()
 Attempts to reclaim unused memory. More...
 
void IncrementCounterByOne (byte *inout, unsigned int size)
 Performs an addition with carry on a block of bytes. More...
 
void IncrementCounterByOne (byte *output, const byte *input, unsigned int size)
 Performs an addition with carry on a block of bytes. More...
 
template<class T >
void ConditionalSwap (bool c, T &a, T &b)
 Performs a branchless swap of values a and b if condition c is true. More...
 
template<class T >
void ConditionalSwapPointers (bool c, T &a, T &b)
 Performs a branchless swap of pointers a and b if condition c is true. More...
 
template<class T >
void SecureWipeBuffer (T *buf, size_t n)
 Sets each element of an array to 0. More...
 
template<class T >
void SecureWipeArray (T *buf, size_t n)
 Sets each element of an array to 0. More...
 
void * AlignedAllocate (size_t size)
 Allocates a buffer on 16-byte boundary. More...
 
void AlignedDeallocate (void *ptr)
 Frees a buffer allocated with AlignedAllocate. More...
 
void * UnalignedAllocate (size_t size)
 Allocates a buffer. More...
 
void UnalignedDeallocate (void *ptr)
 Frees a buffer allocated with UnalignedAllocate. More...
 
template<class T >
rotlFixed (T x, unsigned int y)
 Performs a left rotate. More...
 
template<class T >
rotrFixed (T x, unsigned int y)
 Performs a right rotate. More...
 
template<class T >
rotlVariable (T x, unsigned int y)
 Performs a left rotate. More...
 
template<class T >
rotrVariable (T x, unsigned int y)
 Performs a right rotate. More...
 
template<class T >
rotlMod (T x, unsigned int y)
 Performs a left rotate. More...
 
template<class T >
rotrMod (T x, unsigned int y)
 Performs a right rotate. More...
 
template<class T >
unsigned int GetByte (ByteOrder order, T value, unsigned int index)
 Gets a byte from a value. More...
 
byte ByteReverse (byte value)
 Reverses bytes in a 8-bit value. More...
 
word16 ByteReverse (word16 value)
 Reverses bytes in a 16-bit value. More...
 
word32 ByteReverse (word32 value)
 Reverses bytes in a 32-bit value. More...
 
word64 ByteReverse (word64 value)
 Reverses bytes in a 64-bit value. More...
 
byte BitReverse (byte value)
 Reverses bits in a 8-bit value. More...
 
word16 BitReverse (word16 value)
 Reverses bits in a 16-bit value. More...
 
word32 BitReverse (word32 value)
 Reverses bits in a 32-bit value. More...
 
word64 BitReverse (word64 value)
 Reverses bits in a 64-bit value. More...
 
template<class T >
BitReverse (T value)
 Reverses bits in a value. More...
 
template<class T >
ConditionalByteReverse (ByteOrder order, T value)
 Reverses bytes in a value depending upon endianess. More...
 
template<class T >
void ByteReverse (T *out, const T *in, size_t byteCount)
 Reverses bytes in an element among an array of elements. More...
 
template<class T >
void ConditionalByteReverse (ByteOrder order, T *out, const T *in, size_t byteCount)
 Reverses bytes in an element among an array of elements depending upon endianess. More...
 
template<class T >
void GetUserKey (ByteOrder order, T *out, size_t outlen, const byte *in, size_t inlen)
 
byte UnalignedGetWordNonTemplate (ByteOrder order, const byte *block, const byte *)
 
word16 UnalignedGetWordNonTemplate (ByteOrder order, const byte *block, const word16 *)
 
word32 UnalignedGetWordNonTemplate (ByteOrder order, const byte *block, const word32 *)
 
word64 UnalignedGetWordNonTemplate (ByteOrder order, const byte *block, const word64 *)
 
void UnalignedbyteNonTemplate (ByteOrder order, byte *block, byte value, const byte *xorBlock)
 
void UnalignedbyteNonTemplate (ByteOrder order, byte *block, word16 value, const byte *xorBlock)
 
void UnalignedbyteNonTemplate (ByteOrder order, byte *block, word32 value, const byte *xorBlock)
 
void UnalignedbyteNonTemplate (ByteOrder order, byte *block, word64 value, const byte *xorBlock)
 
template<class T >
GetWord (bool assumeAligned, ByteOrder order, const byte *block)
 
template<class T >
void GetWord (bool assumeAligned, ByteOrder order, T &result, const byte *block)
 
template<class T >
void PutWord (bool assumeAligned, ByteOrder order, byte *block, T value, const byte *xorBlock=NULL)
 
template<class T >
std::string WordToString (T value, ByteOrder order=BIG_ENDIAN_ORDER)
 
template<class T >
StringToWord (const std::string &str, ByteOrder order=BIG_ENDIAN_ORDER)
 
template<unsigned int bits, class T >
SafeRightShift (T value)
 
template<unsigned int bits, class T >
SafeLeftShift (T value)
 

Detailed Description

Utility functions for the Crypto++ library.

Definition in file misc.h.

Macro Definition Documentation

#define SIZE_MAX   ...

The maximum value of a machine word.

SIZE_MAX provides the maximum value of a machine word. The value is 0xffffffff on 32-bit machines, and 0xffffffffffffffff on 64-bit machines. Internally, SIZE_MAX is defined as __SIZE_MAX__ if __SIZE_MAX__ is defined. If not defined, then SIZE_T_MAX is tried. If neither __SIZE_MAX__ nor SIZE_T_MAX is is defined, the library uses std::numeric_limits<size_t>::max(). The library prefers __SIZE_MAX__ because its a constexpr that is optimized well by all compilers. std::numeric_limits<size_t>::max() is not a constexpr, and it is not always optimized well.

Definition at line 70 of file misc.h.

Referenced by PolynomialMod2::AllOnes(), AllocatorBase< word32 >::destroy(), FilterWithBufferedInput::FilterWithBufferedInput(), FixedRNG::GenerateBlock(), FilterWithBufferedInput::IsolatedInitialize(), MeterFilter::IsolatedMessageSeriesEnd(), AllocatorBase< word32 >::max_size(), RoundUpToMultipleOf(), and FileStore::TransferTo2().

#define CRYPTOPP_COMPILE_ASSERT (   expr)    ...

Compile time assertion.

Parameters
exprthe expression to evaluate

Asserts the expression expr though a dummy struct.

Definition at line 98 of file misc.h.

Referenced by RandomPool::GenerateIntoBufferedTransformation(), and UnsignedMin().

#define COUNTOF (   arr)

Counts elements in an array.

Parameters
arran array of elements

COUNTOF counts elements in an array. On Windows COUNTOF(x) is deinfed to _countof(x) to ensure correct results for pointers. Since the library code is cross-platform, Windows will ensure the safety on non-Windows platforms.

Note
COUNTOF does not produce correct results with pointers, and an array must be used. The library ensures correct application of COUNTOF by enlisting _countof on Windows platforms. Microsoft's _countof fails to compile using pointers.

Definition at line 137 of file misc.h.

Referenced by Deflator::IsolatedFlush().

#define MEMORY_BARRIER   ...

A memory barrier.

MEMORY_BARRIER attempts to ensure reads and writes are completed in the absence of a language synchronization point. It is used by the Singleton class if the compiler supports it. The use is provided at the customary check points in a double-checked initialization.

Internally, MEMORY_BARRIER uses intrinsic(_ReadWriteBarrier), _ReadWriteBarrier() or __asm__("" ::: "memory").

Definition at line 210 of file misc.h.

Referenced by Singleton< T, F, instance >::Ref().

Function Documentation

void memcpy_s ( void *  dest,
size_t  sizeInBytes,
const void *  src,
size_t  count 
)
inline

Bounds checking replacement for memcpy()

Parameters
destpointer to the desination memory block
sizeInBytesthe size of the desination memory block, in bytes
srcpointer to the source memory block
countthe size of the source memory block, in bytes
Exceptions
InvalidArgument

ISO/IEC TR-24772 provides bounds checking interfaces for potentially unsafe functions like memcpy(), strcpy() and memmove(). However, not all standard libraries provides them, like Glibc. The library's memcpy_s() is a near-drop in replacement. Its only a near-replacement because the library's version throws an InvalidArgument on a bounds violation.

memcpy_s() and memmove_s() are guarded by __STDC_WANT_SECURE_LIB__. If __STDC_WANT_SECURE_LIB__ is not defined or defined to 0, then the library makes memcpy_s() and memmove_s() available. The library will also optionally make the symbols available if CRYPTOPP_WANT_SECURE_LIB is defined. CRYPTOPP_WANT_SECURE_LIB is in config.h, but it is disabled by default.

memcpy_s() will assert the pointers src and dest are not NULL in debug builds. Passing NULL for either pointer is undefined behavior.

Definition at line 296 of file misc.h.

Referenced by SecBlock< word32 >::Assign(), ConditionalByteReverse(), HKDF< T >::DeriveKey(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), PKCS12_PBKDF< T >::DeriveKey(), IncrementCounterByOne(), CFB_ModePolicy::IVRequirement(), SecBlock< word32 >::operator+(), SecBlock< word32 >::operator+=(), FixedSizeAllocatorWithCleanup< unsigned int, S >::reallocate(), BlockOrientedCipherModeBase::Resynchronize(), SecBlock< word32 >::SecBlock(), and StandardReallocate().

void memmove_s ( void *  dest,
size_t  sizeInBytes,
const void *  src,
size_t  count 
)
inline

Bounds checking replacement for memmove()

Parameters
destpointer to the desination memory block
sizeInBytesthe size of the desination memory block, in bytes
srcpointer to the source memory block
countthe size of the source memory block, in bytes
Exceptions
InvalidArgument

ISO/IEC TR-24772 provides bounds checking interfaces for potentially unsafe functions like memcpy(), strcpy() and memmove(). However, not all standard libraries provides them, like Glibc. The library's memmove_s() is a near-drop in replacement. Its only a near-replacement because the library's version throws an InvalidArgument on a bounds violation.

memcpy_s() and memmove_s() are guarded by __STDC_WANT_SECURE_LIB__. If __STDC_WANT_SECURE_LIB__ is not defined or defined to 0, then the library makes memcpy_s() and memmove_s() available. The library will also optionally make the symbols available if CRYPTOPP_WANT_SECURE_LIB is defined. CRYPTOPP_WANT_SECURE_LIB is in config.h, but it is disabled by default.

memmove_s() will assert the pointers src and dest are not NULL in debug builds. Passing NULL for either pointer is undefined behavior.

Definition at line 335 of file misc.h.

void* memset_z ( void *  ptr,
int  value,
size_t  num 
)
inline

Memory block initializer and eraser that attempts to survive optimizations.

Parameters
ptrpointer to the memory block being written
valuethe integer value to write for each byte
numthe size of the source memory block, in bytes

Internally the function calls memset with the value value, and receives the return value from memset as a volatile pointer.

Definition at line 370 of file misc.h.

Referenced by SecBlock< word32 >::CleanGrow(), SecBlock< word32 >::CleanNew(), and ConditionalByteReverse().

template<class T >
const T& STDMIN ( const T &  a,
const T &  b 
)
inline
template<class T >
const T& STDMAX ( const T &  a,
const T &  b 
)
inline

Replacement function for std::max.

Parameters
athe first value
bthe second value
Returns
the minimum value based on a comparison of a < b using operator<

STDMAX was provided because the library could not use std::min or std::max in MSVC60 or Cygwin 1.1.0

Definition at line 396 of file misc.h.

Referenced by NetworkSink::ComputeCurrentSpeed(), ByteQueue::CreatePutSpace(), DefaultDecryptor::DefaultDecryptor(), DEREncodeBitString(), PolynomialOver< T >::Divide(), Integer::Encode(), PolynomialMod2::MinEncodedSize(), Integer::MinEncodedSize(), ByteQueue::Put2(), FilterTester::Put2(), ArrayXorSink::Put2(), FixedSizeAllocatorWithCleanup< unsigned int, S >::reallocate(), and Deflator::SetDeflateLevel().

template<class T1 , class T2 >
const T1 UnsignedMin ( const T1 &  a,
const T2 &  b 
)
inline
template<class T1 , class T2 >
bool SafeConvert ( T1  from,
T2 &  to 
)
inline

Tests whether a conversion from → to is safe to perform.

Parameters
fromthe first value
tothe second value
Returns
true if its safe to convert from into to, false otherwise.

Definition at line 436 of file misc.h.

Referenced by DERLengthEncode(), PolynomialMod2::Divide(), FileSink::Put2(), PK_DefaultEncryptionFilter::Put2(), PK_DefaultDecryptionFilter::Put2(), and FileStore::Skip().

template<class T >
std::string IntToString ( value,
unsigned int  base = 10 
)
template<>
std::string IntToString< unsigned long long > ( unsigned long long  value,
unsigned int  base 
)

Converts an unsigned value to a string.

Parameters
valuethe value to convert
basethe base to use during the conversion
Returns
the string representation of value in base.

this template function specialization was added to suppress Coverity findings on IntToString() with unsigned types.

Definition at line 4373 of file integer.cpp.

Referenced by IntToString().

template<>
std::string IntToString< Integer > ( Integer  value,
unsigned int  base 
)

Converts an Integer to a string.

Parameters
valuethe Integer to convert
basethe base to use during the conversion
Returns
the string representation of value in base.

This is a template specialization of IntToString(). Use it like IntToString():

  // Print integer in base 10
  Integer n...
  std::string s = IntToString(n, 10);

The string is presented with lowercase letters by default. A hack is available to switch to uppercase letters without modifying the function signature.sha

  // Print integer in base 10, uppercase letters
  Integer n...
  const unsigned int UPPER = (1 << 31);
  std::string s = IntToString(n, (UPPER | 10));

Definition at line 4307 of file integer.cpp.

References BitPrecision(), Integer::Divide(), and SaturatingSubtract1().

Referenced by IntToString().

template<class T >
unsigned int Parity ( value)

Returns the parity of a value.

Parameters
valuethe value to provide the parity
Returns
1 if the number 1-bits in the value is odd, 0 otherwise

Definition at line 532 of file misc.h.

Referenced by PolynomialMod2::operator[](), and PolynomialMod2::Parity().

template<class T >
unsigned int BytePrecision ( const T &  value)

Returns the number of 8-bit bytes or octets required for a value.

Parameters
valuethe value to test
Returns
the minimum number of 8-bit bytes or octets required to represent a value

Definition at line 543 of file misc.h.

Referenced by PolynomialMod2::ByteCount(), Integer::ByteCount(), and DERLengthEncode().

template<class T >
unsigned int BitPrecision ( const T &  value)

Returns the number of bits required for a value.

Parameters
valuethe value to test
Returns
the maximum number of bits required to represent a value.

Definition at line 565 of file misc.h.

Referenced by PolynomialMod2::BitCount(), Integer::BitCount(), DEREncodeBitString(), Integer::Divide(), MersenneTwister< K, M, N, F, S >::GenerateWord32(), RandomNumberGenerator::GenerateWord32(), and IntToString< Integer >().

unsigned int TrailingZeros ( word32  v)
inline

Determines the number of trailing 0-bits in a value.

Parameters
vthe 32-bit value to test
Returns
the number of trailing 0-bits in v, starting at the least significant bit position

TrailingZeros returns the number of trailing 0-bits in v, starting at the least significant bit position. The return value is undefined if there are no 1-bits set in the value v.

Note
The function does not return 0 if no 1-bits are set because 0 collides with a 1-bit at the 0-th position.

Definition at line 590 of file misc.h.

Referenced by TrailingZeros().

unsigned int TrailingZeros ( word64  v)
inline

Determines the number of trailing 0-bits in a value.

Parameters
vthe 64-bit value to test
Returns
the number of trailing 0-bits in v, starting at the least significant bit position

TrailingZeros returns the number of trailing 0-bits in v, starting at the least significant bit position. The return value is undefined if there are no 1-bits set in the value v.

Note
The function does not return 0 if no 1-bits are set because 0 collides with a 1-bit at the 0-th position.

Definition at line 616 of file misc.h.

References TrailingZeros().

template<class T >
T Crop ( value,
size_t  bits 
)
inline

Truncates the value to the specified number of bits.

Parameters
valuethe value to truncate or mask
bitsthe number of bits to truncate or mask
Returns
the value truncated to the specified number of bits, starting at the least significant bit position

This function masks the low-order bits of value and returns the result. The mask is created with (1 << bits) - 1.

Definition at line 638 of file misc.h.

Referenced by PolynomialMod2::AllOnes(), MersenneTwister< K, M, N, F, S >::GenerateWord32(), RandomNumberGenerator::GenerateWord32(), PolynomialMod2::IsIrreducible(), PolynomialMod2::PolynomialMod2(), and Integer::Randomize().

size_t BitsToBytes ( size_t  bitCount)
inline

Returns the number of 8-bit bytes or octets required for the specified number of bits.

Parameters
bitCountthe number of bits
Returns
the minimum number of 8-bit bytes or octets required by bitCount

BitsToBytes is effectively a ceiling function based on 8-bit bytes.

Definition at line 650 of file misc.h.

Referenced by Inflator::IsolatedFlush(), Integer::OpenPGPDecode(), Integer::OpenPGPEncode(), and DL_GroupParameters_DSA::ValidateGroup().

size_t BytesToWords ( size_t  byteCount)
inline

Returns the number of words required for the specified number of bytes.

Parameters
byteCountthe number of bytes
Returns
the minimum number of words required by byteCount

BytesToWords is effectively a ceiling function based on WORD_SIZE. WORD_SIZE is defined in config.h

Definition at line 660 of file misc.h.

Referenced by Integer::Decode(), PolynomialMod2::Encode(), PolynomialMod2::SetByte(), and Integer::SetByte().

size_t BitsToWords ( size_t  bitCount)
inline

Returns the number of words required for the specified number of bits.

Parameters
bitCountthe number of bits
Returns
the minimum number of words required by bitCount

BitsToWords is effectively a ceiling function based on WORD_BITS. WORD_BITS is defined in config.h

Definition at line 670 of file misc.h.

Referenced by PolynomialMod2::Divide(), Integer::DivideByPowerOf2(), PolynomialMod2::IsIrreducible(), Integer::Power2(), and Integer::SetBit().

size_t BitsToDwords ( size_t  bitCount)
inline

Returns the number of double words required for the specified number of bits.

Parameters
bitCountthe number of bits
Returns
the minimum number of double words required by bitCount

BitsToDwords is effectively a ceiling function based on 2*WORD_BITS. WORD_BITS is defined in config.h

Definition at line 680 of file misc.h.

References VerifyBufsEqual(), and xorbuf().

void xorbuf ( byte *  buf,
const byte *  mask,
size_t  count 
)

Performs an XOR of a buffer with a mask.

Parameters
bufthe buffer to XOR with the mask
maskthe mask to XOR with the buffer
countthe size of the buffers, in bytes

The function effectively visits each element in the buffers and performs buf[i] ^= mask[i]. buf and mask must be of equal size.

Definition at line 25 of file misc.cpp.

Referenced by BlockTransformation::AdvancedProcessBlocks(), BitsToDwords(), DES::CorrectKeyParityBits(), PKCS5_PBKDF2_HMAC< T >::DeriveKey(), AdditiveCipherTemplate< BASE >::GenerateBlock(), X917RNG::GenerateIntoBufferedTransformation(), TestDataNameValuePairs::GetVoidValue(), CBC_CTS_Encryption::ProcessLastBlock(), CBC_CTS_Decryption::ProcessLastBlock(), ArrayXorSink::Put2(), CMAC_Base::Update(), SHA3::Update(), and X917RNG::X917RNG().

void xorbuf ( byte *  output,
const byte *  input,
const byte *  mask,
size_t  count 
)

Performs an XOR of an input buffer with a mask and stores the result in an output buffer.

Parameters
outputthe destination buffer
inputthe source buffer to XOR with the mask
maskthe mask buffer to XOR with the input buffer
countthe size of the buffers, in bytes

The function effectively visits each element in the buffers and performs output[i] = input[i] ^ mask[i]. output, input and mask must be of equal size.

Definition at line 58 of file misc.cpp.

bool VerifyBufsEqual ( const byte *  buf1,
const byte *  buf2,
size_t  count 
)

Performs a near constant-time comparison of two equally sized buffers.

Parameters
buf1the first buffer
buf2the second buffer
countthe size of the buffers, in bytes

The function effectively performs an XOR of the elements in two equally sized buffers and retruns a result based on the XOR operation. The function is near constant-time because CPU micro-code timings could affect the "constant-ness". Calling code is responsible for mitigating timing attacks if the buffers are not equally sized.

Definition at line 93 of file misc.cpp.

Referenced by BitsToDwords(), DefaultDecryptor::DefaultDecryptor(), IntegrityCheckModule(), SecBlock< word32 >::operator==(), VMAC_Base::Resynchronize(), and HashTransformation::TruncatedVerify().

template<class T >
bool IsPowerOf2 ( const T &  value)
inline

Tests whether a value is a power of 2.

Parameters
valuethe value to test
Returns
true if value is a power of 2, false otherwise

The function creates a mask of value - 1 and returns the result of an AND operation compared to 0. If value is 0 or less than 0, then the function returns false.

Definition at line 718 of file misc.h.

Referenced by IsAlignedOn(), ModPowerOf2(), and RoundDownToMultipleOf().

template<class T1 , class T2 >
T2 ModPowerOf2 ( const T1 &  a,
const T2 &  b 
)
inline

Tests whether the residue of a value is a power of 2.

Parameters
athe value to test
bthe value to use to reduce to its residue
Returns
true if a%b is a power of 2, false otherwise

The function effectively creates a mask of b - 1 and returns the result of an AND operation compared to 0. b must be a power of 2 or the result is undefined.

Definition at line 730 of file misc.h.

References IsPowerOf2().

Referenced by IsAlignedOn(), VMAC_Base::OptimalDataAlignment(), RoundDownToMultipleOf(), and VMAC_Base::TruncatedFinal().

template<class T1 , class T2 >
T1 RoundDownToMultipleOf ( const T1 &  n,
const T2 &  m 
)
inline

Rounds a value down to a multiple of a second value.

Parameters
nthe value to reduce
mthe value to reduce
to to a multiple
Returns
the possibly unmodified value

RoundDownToMultipleOf is effectively a floor function based on m. The function returns the value n - n%m. If n is a multiple of m, then the original value is returned.

Definition at line 743 of file misc.h.

References IsPowerOf2(), and ModPowerOf2().

Referenced by FilterWithBufferedInput::IsolatedFlush(), ArrayXorSink::Put2(), and RoundUpToMultipleOf().

template<class T1 , class T2 >
T1 RoundUpToMultipleOf ( const T1 &  n,
const T2 &  m 
)
inline

Rounds a value up to a multiple of a second value.

Parameters
nthe value to reduce
mthe value to reduce
to to a multiple
Returns
the possibly unmodified value

RoundUpToMultipleOf is effectively a ceiling function based on m. The function returns the value n + n%m. If n is a multiple of m, then the original value is returned. If the value n would overflow, then an InvalidArgument exception is thrown.

Definition at line 759 of file misc.h.

References RoundDownToMultipleOf(), and SIZE_MAX.

Referenced by ConditionalByteReverse(), DEREncodeBitString(), PKCS12_PBKDF< T >::DeriveKey(), MersenneTwister< K, M, N, F, S >::DiscardBytes(), AdditiveCipherTemplate< BASE >::GenerateBlock(), and Deflator::IsolatedFlush().

template<class T >
unsigned int GetAlignmentOf ( T *  dummy = NULL)
inline

Returns the minimum alignment requirements of a type.

Parameters
dummyan unused Visual C++ 6.0 workaround
Returns
the minimum alignment requirements of a type, in bytes

Internally the function calls C++11's alignof if available. If not available, the function uses compiler specific extensions such as __alignof and _alignof_. sizeof(T) is used if the others are not available. In all cases, if CRYPTOPP_ALLOW_UNALIGNED_DATA_ACCESS is defined, then the function returns 1.

Definition at line 774 of file misc.h.

References UnsignedMin().

bool IsAlignedOn ( const void *  ptr,
unsigned int  alignment 
)
inline

Determines whether ptr is aligned to a minimum value.

Parameters
ptrthe pointer being checked for alignment
alignmentthe alignment value to test the pointer against
Returns
true if ptr is aligned on at least align boundary

Internally the function tests whether alignment is 1. If so, the function returns true. If not, then the function effectively performs a modular reduction and returns true if the residue is 0

Definition at line 801 of file misc.h.

References IsPowerOf2(), and ModPowerOf2().

Referenced by FixedSizeAllocatorWithCleanup< unsigned int, S >::allocate(), CallNewHandler(), AdditiveCipherTemplate< BASE >::GenerateBlock(), and IsAligned().

template<class T >
bool IsAligned ( const void *  ptr,
T *  dummy = NULL 
)
inline

Determines whether ptr is minimally aligned.

Parameters
ptrthe pointer to check for alignment
dummyan unused Visual C++ 6.0 workaround
Returns
true if ptr follows native byte ordering, false otherwise

Internally the function calls IsAlignedOn with a second parameter of GetAlignmentOf<T>

Definition at line 812 of file misc.h.

References IsAlignedOn().

ByteOrder GetNativeByteOrder ( )
inline

Returns NativeByteOrder as an enumerated ByteOrder value.

Returns
LittleEndian if the native byte order is little-endian, and BigEndian if the native byte order is big-endian

NativeByteOrder is a typedef depending on the platform. If IS_LITTLE_ENDIAN is set in GetNativeByteOrder returns LittleEndian. If IS_BIG_ENDIAN is set, then GetNativeByteOrder returns BigEndian.

Note
There are other byte orders besides little- and big-endian, and they include bi-endian and PDP-endian. If a system is neither little-endian nor big-endian, then a compile time error occurs.

Definition at line 834 of file misc.h.

Referenced by NativeByteOrderIs().

bool NativeByteOrderIs ( ByteOrder  order)
inline

Determines whether order follows native byte ordering.

Parameters
orderthe ordering being tested against native byte ordering
Returns
true if order follows native byte ordering, false otherwise

Definition at line 842 of file misc.h.

References GetNativeByteOrder().

Referenced by ConditionalByteReverse().

template<class T1 , class T2 >
T1 SaturatingSubtract ( const T1 &  a,
const T2 &  b 
)
inline

Performs a saturating subtract clamped at 0.

Parameters
athe minuend
bthe subtrahend
Returns
the difference produced by the saturating subtract

Saturating arithmetic restricts results to a fixed range. Results that are less than 0 are clamped at 0.

Use of saturating arithmetic in places can be advantageous because it can avoid a branch by using an instruction like a conditional move (CMOVE).

Definition at line 855 of file misc.h.

Referenced by ArraySink::CreatePutSpace(), NonblockingSource::GeneralPump2(), NetworkSource::GetWaitObjects(), ESIGNFunction::ImageBound(), OAEP_Base::MaxUnpaddedLength(), PKCS_EncryptionPaddingScheme::MaxUnpaddedLength(), Filter::MessageSeriesEnd(), NetworkSink::Put2(), ArraySink::Put2(), ArrayXorSink::Put2(), Deflator::SetDeflateLevel(), NonblockingSink::TimedFlush(), and DL_GroupParameters_DSA::ValidateGroup().

template<class T1 , class T2 >
T1 SaturatingSubtract1 ( const T1 &  a,
const T2 &  b 
)
inline

Performs a saturating subtract clamped at 1.

Parameters
athe minuend
bthe subtrahend
Returns
the difference produced by the saturating subtract

Saturating arithmetic restricts results to a fixed range. Results that are less than 1 are clamped at 1.

Use of saturating arithmetic in places can be advantageous because it can avoid a branch by using an instruction like a conditional move (CMOVE).

Definition at line 869 of file misc.h.

Referenced by IntToString< Integer >().

template<class T >
CipherDir GetCipherDir ( const T &  obj)
inline

Returns the direction the cipher is being operated.

Parameters
objthe cipher object being queried
Returns
/p ENCRYPTION if the cipher obj is being operated in its forward direction, DECRYPTION otherwise

ciphers can be operated in a "forward" direction (encryption) and a "reverse" direction (decryption). The operations do not have to be symmetric, meaning a second application of the transformation does not necessariy return the original message. That is, E(D(m)) may not equal E(E(m)); and D(E(m)) may not equal D(D(m)).

Definition at line 884 of file misc.h.

References CallNewHandler().

Referenced by AdditiveCipherTemplate< BASE >::GenerateBlock().

void CallNewHandler ( )

Attempts to reclaim unused memory.

Exceptions
bad_alloc

In the normal course of running a program, a request for memory normally succeeds. If a call to AlignedAllocate or UnalignedAllocate fails, then CallNewHandler is called in an effort to recover. Internally, CallNewHandler calls set_new_handler(NULL) in an effort to free memory. There is no guarantee CallNewHandler will be able to procure more memory so an allocation succeeds. If the call to set_new_handler fails, then CallNewHandler throws a bad_alloc exception.

Definition at line 138 of file misc.cpp.

References AlignedAllocate(), AlignedDeallocate(), and IsAlignedOn().

Referenced by GetCipherDir(), and UnalignedAllocate().

void IncrementCounterByOne ( byte *  inout,
unsigned int  size 
)
inline

Performs an addition with carry on a block of bytes.

Parameters
inoutthe byte block
sizethe size of the block, in bytes

Performs an addition with carry by adding 1 on a block of bytes starting at the least significant byte. Once carry is 0, the function terminates and returns to the caller.

Note
The function is not constant time because it stops processing when the carry is 0.

Definition at line 905 of file misc.h.

Referenced by X917RNG::GenerateIntoBufferedTransformation().

void IncrementCounterByOne ( byte *  output,
const byte *  input,
unsigned int  size 
)
inline

Performs an addition with carry on a block of bytes.

Parameters
outputthe destination block of bytes
inputthe source block of bytes
sizethe size of the block

Performs an addition with carry on a block of bytes starting at the least significant byte. Once carry is 0, the remaining bytes from input are copied to output using memcpy.

The function is close to near-constant time because it operates on all the bytes in the blocks.

Definition at line 919 of file misc.h.

References memcpy_s().

template<class T >
void ConditionalSwap ( bool  c,
T &  a,
T &  b 
)
inline

Performs a branchless swap of values a and b if condition c is true.

Parameters
cthe condition to perform the swap
athe first value
bthe second value

Definition at line 934 of file misc.h.

template<class T >
void ConditionalSwapPointers ( bool  c,
T &  a,
T &  b 
)
inline

Performs a branchless swap of pointers a and b if condition c is true.

Parameters
cthe condition to perform the swap
athe first pointer
bthe second pointer

Definition at line 946 of file misc.h.

template<class T >
void SecureWipeBuffer ( T *  buf,
size_t  n 
)

Sets each element of an array to 0.

Parameters
bufan array of elements
nthe number of elements in the array

The operation is effectively a wipe or zeroization. The operation attempts to survive optimizations and dead code removal

Definition at line 961 of file misc.h.

Referenced by SecureWipeArray().

template<class T >
void SecureWipeArray ( T *  buf,
size_t  n 
)
inline

Sets each element of an array to 0.

Parameters
bufan array of elements
nthe number of elements in the array

The operation is effectively a wipe or zeroization. The operation attempts to survive optimizations and dead code removal

Definition at line 1038 of file misc.h.

References AlignedAllocate(), AlignedDeallocate(), IntToString(), SecureWipeBuffer(), UnalignedAllocate(), and UnalignedDeallocate().

Referenced by AllocatorWithCleanup< word32 >::deallocate(), FixedSizeAllocatorWithCleanup< unsigned int, S >::deallocate(), and FixedSizeAllocatorWithCleanup< unsigned int, S >::reallocate().

void* AlignedAllocate ( size_t  size)

Allocates a buffer on 16-byte boundary.

Parameters
sizethe size of the buffer

AlignedAllocate is primarily used when the data will be proccessed by MMX and SSE2 instructions. The assembly language routines rely on the alignment. If the alignment is not respected, then a SIGBUS is generated under Unix and an EXCEPTION_DATATYPE_MISALIGNMENT is generated under Windows.

Note
AlignedAllocate and AlignedDeallocate are available when CRYPTOPP_BOOL_ALIGN16 is defined. CRYPTOPP_BOOL_ALIGN16 is defined in config.h

Referenced by AllocatorWithCleanup< word32 >::allocate(), CallNewHandler(), and SecureWipeArray().

void AlignedDeallocate ( void *  ptr)

Frees a buffer allocated with AlignedAllocate.

Parameters
ptrthe buffer to free
Note
AlignedAllocate and AlignedDeallocate are available when CRYPTOPP_BOOL_ALIGN16 is defined. CRYPTOPP_BOOL_ALIGN16 is defined in config.h

Referenced by CallNewHandler(), AllocatorWithCleanup< word32 >::deallocate(), and SecureWipeArray().

void* UnalignedAllocate ( size_t  size)

Allocates a buffer.

Parameters
sizethe size of the buffer

Definition at line 192 of file misc.cpp.

References CallNewHandler().

Referenced by AllocatorWithCleanup< word32 >::allocate(), and SecureWipeArray().

void UnalignedDeallocate ( void *  ptr)

Frees a buffer allocated with UnalignedAllocate.

Parameters
ptrthe buffer to free

Definition at line 200 of file misc.cpp.

Referenced by AllocatorWithCleanup< word32 >::deallocate(), and SecureWipeArray().

template<class T >
T rotlFixed ( x,
unsigned int  y 
)
inline

Performs a left rotate.

Parameters
xthe value to rotate
ythe number of bit positions to rotate the value

This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits.

y must be in the range [0, sizeof(T)*8 - 1] to avoid undefined behavior. Use rotlMod if the rotate amount y is outside the range.

Note
rotlFixed attempts to enlist a rotate IMM instruction because its often faster than a rotate REG. Immediate rotates can be up to three times faster than their register counterparts.

Definition at line 1166 of file misc.h.

Referenced by BitReverse(), ByteReverse(), and SAFER::Base::UncheckedSetKey().

template<class T >
T rotrFixed ( x,
unsigned int  y 
)
inline

Performs a right rotate.

Parameters
xthe value to rotate
ythe number of bit positions to rotate the value

This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits.

y must be in the range [0, sizeof(T)*8 - 1] to avoid undefined behavior. Use rotrMod if the rotate amount y is outside the range.

Note
rotrFixed attempts to enlist a rotate IMM instruction because its often faster than a rotate REG. Immediate rotates can be up to three times faster than their register counterparts.

Definition at line 1189 of file misc.h.

Referenced by ByteReverse().

template<class T >
T rotlVariable ( x,
unsigned int  y 
)
inline

Performs a left rotate.

Parameters
xthe value to rotate
ythe number of bit positions to rotate the value

This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits.

y must be in the range [0, sizeof(T)*8 - 1] to avoid undefined behavior. Use rotlMod if the rotate amount y is outside the range.

Note
rotlVariable attempts to enlist a rotate IMM instruction because its often faster than a rotate REG. Immediate rotates can be up to three times faster than their register counterparts.

Definition at line 1210 of file misc.h.

template<class T >
T rotrVariable ( x,
unsigned int  y 
)
inline

Performs a right rotate.

Parameters
xthe value to rotate
ythe number of bit positions to rotate the value

This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits.

y must be in the range [0, sizeof(T)*8 - 1] to avoid undefined behavior. Use rotrMod if the rotate amount y is outside the range.

Note
rotrVariable attempts to enlist a rotate IMM instruction because its often faster than a rotate REG. Immediate rotates can be up to three times faster than their register counterparts.

Definition at line 1227 of file misc.h.

template<class T >
T rotlMod ( x,
unsigned int  y 
)
inline

Performs a left rotate.

Parameters
xthe value to rotate
ythe number of bit positions to rotate the value

This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits.

y is reduced to the range [0, sizeof(T)*8 - 1] to avoid undefined behavior.

Note
rotrVariable will use either rotate IMM or rotate REG.

Definition at line 1241 of file misc.h.

template<class T >
T rotrMod ( x,
unsigned int  y 
)
inline

Performs a right rotate.

Parameters
xthe value to rotate
ythe number of bit positions to rotate the value

This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits.

y is reduced to the range [0, sizeof(T)*8 - 1] to avoid undefined behavior.

Note
rotrVariable will use either rotate IMM or rotate REG.

Definition at line 1254 of file misc.h.

template<class T >
unsigned int GetByte ( ByteOrder  order,
value,
unsigned int  index 
)
inline

Gets a byte from a value.

Parameters
orderthe ByteOrder of the value
valuethe value to retrieve the byte
indexthe location of the byte to retrieve

Definition at line 1540 of file misc.h.

Referenced by PolynomialMod2::GetBit(), and RandomNumberGenerator::Shuffle().

byte ByteReverse ( byte  value)
inline

Reverses bytes in a 8-bit value.

Parameters
valuethe 8-bit value to reverse
Note
ByteReverse returns the value passed to it since there is nothing to reverse

Definition at line 1551 of file misc.h.

Referenced by BitReverse(), ByteReverse(), ConditionalByteReverse(), and MersenneTwister< K, M, N, F, S >::GenerateBlock().

word16 ByteReverse ( word16  value)
inline

Reverses bytes in a 16-bit value.

Performs an endian reversal

Parameters
valuethe 16-bit value to reverse

ByteReverse calls bswap if available. Otherwise the function performs a 8-bit rotate on the word16

Definition at line 1560 of file misc.h.

References rotlFixed().

word32 ByteReverse ( word32  value)
inline

Reverses bytes in a 32-bit value.

Performs an endian reversal

Parameters
valuethe 32-bit value to reverse

ByteReverse calls bswap if available. Otherwise the function uses a combination of rotates on the word32

Definition at line 1575 of file misc.h.

References rotlFixed(), and rotrFixed().

word64 ByteReverse ( word64  value)
inline

Reverses bytes in a 64-bit value.

Performs an endian reversal

Parameters
valuethe 64-bit value to reverse

ByteReverse calls bswap if available. Otherwise the function uses a combination of rotates on the word64

Definition at line 1600 of file misc.h.

References ByteReverse(), and rotlFixed().

byte BitReverse ( byte  value)
inline

Reverses bits in a 8-bit value.

Parameters
valuethe 8-bit value to reverse

BitReverse performs a combination of shifts on the byte

Definition at line 1621 of file misc.h.

References rotlFixed().

Referenced by BitReverse(), and HuffmanEncoder::Initialize().

word16 BitReverse ( word16  value)
inline

Reverses bits in a 16-bit value.

Parameters
valuethe 16-bit value to reverse

BitReverse performs a combination of shifts on the word16

Definition at line 1631 of file misc.h.

References ByteReverse().

word32 BitReverse ( word32  value)
inline

Reverses bits in a 32-bit value.

Parameters
valuethe 32-bit value to reverse

BitReverse performs a combination of shifts on the word32

Definition at line 1642 of file misc.h.

References ByteReverse().

word64 BitReverse ( word64  value)
inline

Reverses bits in a 64-bit value.

Parameters
valuethe 64-bit value to reverse

BitReverse performs a combination of shifts on the word64

Definition at line 1653 of file misc.h.

References BitReverse(), and ByteReverse().

template<class T >
T BitReverse ( value)
inline

Reverses bits in a value.

Parameters
valuethe value to reverse

The template overload of BitReverse operates on signed and unsigned values. Internally the size of T is checked, and then value is cast to a byte, word16, word32 or word64. After the cast, the appropriate BitReverse overload is called.

Definition at line 1672 of file misc.h.

References BitReverse().

template<class T >
T ConditionalByteReverse ( ByteOrder  order,
value 
)
inline

Reverses bytes in a value depending upon endianess.

Template Parameters
Tthe class or type
Parameters
orderthe ByteOrder the data is represented
valuethe value to conditionally reverse

Internally, the ConditionalByteReverse calls NativeByteOrderIs. If order matches native byte order, then the original value is returned. If not, then ByteReverse is called on the value before returning to the caller.

Definition at line 1695 of file misc.h.

References ByteReverse(), and NativeByteOrderIs().

Referenced by ConditionalByteReverse(), and VMAC_Base::TruncatedFinal().

template<class T >
void ByteReverse ( T *  out,
const T *  in,
size_t  byteCount 
)

Reverses bytes in an element among an array of elements.

Template Parameters
Tthe class or type
Parameters
outthe output array of elements
inthe input array of elements
byteCountthe byte count of the arrays

Internally, ByteReverse visits each element in the in array calls ByteReverse on it, and writes the result to out.

ByteReverse does not process tail byes, or bytes that are not part of a full element. If T is int (and int is 4 bytes), then byteCount = 10 means only the first 8 bytes are reversed.

Note
ByteReverse uses the number of bytes in the arrays, and not the count of elements in the arrays.

Definition at line 1713 of file misc.h.

References ByteReverse().

template<class T >
void ConditionalByteReverse ( ByteOrder  order,
T *  out,
const T *  in,
size_t  byteCount 
)
inline

Reverses bytes in an element among an array of elements depending upon endianess.

Template Parameters
Tthe class or type
Parameters
orderthe ByteOrder the data is represented
outthe output array of elements
inthe input array of elements
byteCountthe byte count of the arrays

Internally, ByteReverse visits each element in the in array calls ByteReverse on it, and writes the result to out.

ByteReverse does not process tail byes, or bytes that are not part of a full element. If T is int (and int is 4 bytes), then byteCount = 10 means only the first 8 bytes are reversed.

Note
ByteReverse uses the number of bytes in the arrays, and not the count of elements in the arrays.

Definition at line 1735 of file misc.h.

References ByteReverse(), ConditionalByteReverse(), memcpy_s(), memset_z(), NativeByteOrderIs(), and RoundUpToMultipleOf().