#include <stddef.h>
#include <string.h>
#include <limits.h>

Include dependency graph for mem.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	MEM_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */

#define	__has_builtin(x) 0 /* compat. with non-clang compilers */

#define	MEM_STATIC_ASSERT(c) { enum { MEM_static_assert = 1/(int)(!!(c)) }; }

Typedefs
typedef unsigned char	BYTE

typedef unsigned short	U16

typedef signed short	S16

typedef unsigned int	U32

typedef signed int	S32

typedef unsigned long long	U64

typedef signed long long	S64

Functions
MEM_STATIC void	MEM_check (void)

MEM_STATIC unsigned	MEM_32bits (void)

MEM_STATIC unsigned	MEM_64bits (void)

MEM_STATIC unsigned	MEM_isLittleEndian (void)

MEM_STATIC U16	MEM_read16 (const void *memPtr)

MEM_STATIC U32	MEM_read32 (const void *memPtr)

MEM_STATIC U64	MEM_read64 (const void *memPtr)

MEM_STATIC size_t	MEM_readST (const void *memPtr)

MEM_STATIC void	MEM_write16 (void *memPtr, U16 value)

MEM_STATIC void	MEM_write32 (void *memPtr, U32 value)

MEM_STATIC void	MEM_write64 (void *memPtr, U64 value)

MEM_STATIC U32	MEM_swap32 (U32 in)

MEM_STATIC U64	MEM_swap64 (U64 in)

MEM_STATIC size_t	MEM_swapST (size_t in)

MEM_STATIC U16	MEM_readLE16 (const void *memPtr)

MEM_STATIC void	MEM_writeLE16 (void *memPtr, U16 val)

MEM_STATIC U32	MEM_readLE24 (const void *memPtr)

MEM_STATIC void	MEM_writeLE24 (void *memPtr, U32 val)

MEM_STATIC U32	MEM_readLE32 (const void *memPtr)

MEM_STATIC void	MEM_writeLE32 (void *memPtr, U32 val32)

MEM_STATIC U64	MEM_readLE64 (const void *memPtr)

MEM_STATIC void	MEM_writeLE64 (void *memPtr, U64 val64)

MEM_STATIC size_t	MEM_readLEST (const void *memPtr)

MEM_STATIC void	MEM_writeLEST (void *memPtr, size_t val)

MEM_STATIC U32	MEM_readBE32 (const void *memPtr)

MEM_STATIC void	MEM_writeBE32 (void *memPtr, U32 val32)

MEM_STATIC U64	MEM_readBE64 (const void *memPtr)

MEM_STATIC void	MEM_writeBE64 (void *memPtr, U64 val64)

MEM_STATIC size_t	MEM_readBEST (const void *memPtr)

MEM_STATIC void	MEM_writeBEST (void *memPtr, size_t val)

Macro Definition Documentation

◆ __has_builtin

#define __has_builtin ( x ) 0 /* compat. with non-clang compilers */

Definition at line 43 of file mem.h.

◆ MEM_STATIC

#define MEM_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */

Definition at line 39 of file mem.h.

◆ MEM_STATIC_ASSERT

#define MEM_STATIC_ASSERT ( c ) { enum { MEM_static_assert = 1/(int)(!!(c)) }; }

Definition at line 47 of file mem.h.

Typedef Documentation

◆ BYTE

typedef unsigned char BYTE

Definition at line 141 of file mem.h.

◆ S16

typedef signed short S16

Definition at line 146 of file mem.h.

◆ S32

typedef signed int S32

Definition at line 151 of file mem.h.

◆ S64

typedef signed long long S64

Definition at line 155 of file mem.h.

◆ U16

typedef unsigned short U16

Definition at line 145 of file mem.h.

◆ U32

typedef unsigned int U32

Definition at line 150 of file mem.h.

◆ U64

typedef unsigned long long U64

Definition at line 154 of file mem.h.

Function Documentation

◆ MEM_32bits()

MEM_STATIC unsigned MEM_32bits ( void )

Definition at line 183 of file mem.h.

183{ return sizeof(size_t)==4; }

size_t

__kernel_size_t size_t

Definition: linux.h:237

Referenced by HUF_decodeStreamX1(), MEM_readBEST(), MEM_readLEST(), MEM_swapST(), MEM_writeBEST(), MEM_writeLEST(), and ZSTD_encodeSequences_body().

◆ MEM_64bits()

MEM_STATIC unsigned MEM_64bits ( void )

Definition at line 184 of file mem.h.

184{ return sizeof(size_t)==8; }

◆ MEM_check()

MEM_STATIC void MEM_check ( void )

Definition at line 48 of file mem.h.

48{ MEM_STATIC_ASSERT((sizeof(size_t)==4) || (sizeof(size_t)==8)); }

MEM_STATIC_ASSERT

#define MEM_STATIC_ASSERT(c)

Definition: mem.h:47

◆ MEM_isLittleEndian()

MEM_STATIC unsigned MEM_isLittleEndian ( void )

Definition at line 186 of file mem.h.

{
    const union { U32 u; BYTE c[4]; } one = { 1 };   /* don't use static : performance detrimental  */
    return one.c[0];
}

Referenced by MEM_readBE32(), MEM_readBE64(), MEM_readLE16(), MEM_readLE32(), MEM_readLE64(), MEM_writeBE32(), MEM_writeBE64(), MEM_writeLE16(), MEM_writeLE32(), MEM_writeLE64(), and ZSTD_readMINMATCH().

◆ MEM_read16()

MEM_STATIC U16 MEM_read16 ( const void * memPtr )

Definition at line 237 of file mem.h.

{
    U16 val; memcpy(&val, memPtr, sizeof(val)); return val;
}

Referenced by MEM_readLE16(), and ZSTD_getFSEMaxSymbolValue().

◆ MEM_read32()

MEM_STATIC U32 MEM_read32 ( const void * memPtr )

Definition at line 242 of file mem.h.

{
    U32 val; memcpy(&val, memPtr, sizeof(val)); return val;
}

Referenced by HIST_count_parallel_wksp(), MEM_readBE32(), MEM_readLE32(), ZSTD_compressBlock_doubleFast_extDict_generic(), ZSTD_compressBlock_doubleFast_generic(), ZSTD_compressBlock_fast_dictMatchState_generic(), ZSTD_compressBlock_fast_extDict_generic(), ZSTD_compressBlock_fast_generic(), ZSTD_compressBlock_lazy_extDict_generic(), ZSTD_compressBlock_lazy_generic(), ZSTD_HcFindBestMatch_generic(), and ZSTD_readMINMATCH().

◆ MEM_read64()

MEM_STATIC U64 MEM_read64 ( const void * memPtr )

Definition at line 247 of file mem.h.

{
    U64 val; memcpy(&val, memPtr, sizeof(val)); return val;
}

Referenced by MEM_readBE64(), MEM_readLE64(), ZSTD_compressBlock_doubleFast_extDict_generic(), and ZSTD_compressBlock_doubleFast_generic().

◆ MEM_readBE32()

MEM_STATIC U32 MEM_readBE32 ( const void * memPtr )

Definition at line 396 of file mem.h.

{
    if (MEM_isLittleEndian())
        return MEM_swap32(MEM_read32(memPtr));
    else
        return MEM_read32(memPtr);
}

Referenced by MEM_readBEST().

◆ MEM_readBE64()

MEM_STATIC U64 MEM_readBE64 ( const void * memPtr )

Definition at line 412 of file mem.h.

{
    if (MEM_isLittleEndian())
        return MEM_swap64(MEM_read64(memPtr));
    else
        return MEM_read64(memPtr);
}

Referenced by MEM_readBEST().

◆ MEM_readBEST()

MEM_STATIC size_t MEM_readBEST ( const void * memPtr )

Definition at line 428 of file mem.h.

{
    if (MEM_32bits())
        return (size_t)MEM_readBE32(memPtr);
    else
        return (size_t)MEM_readBE64(memPtr);
}

◆ MEM_readLE16()

MEM_STATIC U16 MEM_readLE16 ( const void * memPtr )

Definition at line 314 of file mem.h.

{
    if (MEM_isLittleEndian())
        return MEM_read16(memPtr);
    else {
        const BYTE* p = (const BYTE*)memPtr;
        return (U16)(p[0] + (p[1]<<8));
    }
}

Referenced by HUF_decompress4X1_usingDTable_internal_body(), HUF_decompress4X2_usingDTable_internal_body(), MEM_readLE24(), and ZSTD_getFrameHeader_advanced().

◆ MEM_readLE24()

MEM_STATIC U32 MEM_readLE24 ( const void * memPtr )

Definition at line 335 of file mem.h.

{
    return MEM_readLE16(memPtr) + (((const BYTE*)memPtr)[2] << 16);
}

Referenced by ZSTD_getcBlockSize().

◆ MEM_readLE32()

MEM_STATIC U32 MEM_readLE32 ( const void * memPtr )

Definition at line 346 of file mem.h.

{
    if (MEM_isLittleEndian())
        return MEM_read32(memPtr);
    else
        return MEM_swap32(MEM_read32(memPtr));
}

Referenced by FSE_readNCount(), MEM_readLEST(), readSkippableFrameSize(), ZSTD_compress_insertDictionary(), ZSTD_decompress_insertDictionary(), ZSTD_decompressContinue(), ZSTD_decompressFrame(), ZSTD_decompressMultiFrame(), ZSTD_decompressStream(), ZSTD_findDecompressedSize(), ZSTD_findFrameSizeInfo(), ZSTD_getDictID_fromDict(), ZSTD_getFrameHeader_advanced(), ZSTD_isFrame(), ZSTD_loadCEntropy(), ZSTD_loadDEntropy(), ZSTD_loadEntropy_intoDDict(), and ZSTD_loadZstdDictionary().

◆ MEM_readLE64()

MEM_STATIC U64 MEM_readLE64 ( const void * memPtr )

Definition at line 362 of file mem.h.

{
    if (MEM_isLittleEndian())
        return MEM_read64(memPtr);
    else
        return MEM_swap64(MEM_read64(memPtr));
}

Referenced by MEM_readLEST(), ZSTD_getFrameHeader_advanced(), and ZSTD_hashPtr().

◆ MEM_readLEST()

MEM_STATIC size_t MEM_readLEST ( const void * memPtr )

Definition at line 378 of file mem.h.

{
    if (MEM_32bits())
        return (size_t)MEM_readLE32(memPtr);
    else
        return (size_t)MEM_readLE64(memPtr);
}

Referenced by BIT_initDStream(), BIT_reloadDStream(), and BIT_reloadDStreamFast().

◆ MEM_readST()

MEM_STATIC size_t MEM_readST ( const void * memPtr )

Definition at line 252 of file mem.h.

{
    size_t val; memcpy(&val, memPtr, sizeof(val)); return val;
}

◆ MEM_swap32()

MEM_STATIC U32 MEM_swap32 ( U32 in )

Definition at line 274 of file mem.h.

{
#if (defined (__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 403)) \
  || (defined(__clang__) && __has_builtin(__builtin_bswap32))
    return __builtin_bswap32(in);
#else
    return  ((in << 24) & 0xff000000 ) |
            ((in <<  8) & 0x00ff0000 ) |
            ((in >>  8) & 0x0000ff00 ) |
            ((in >> 24) & 0x000000ff );
#endif
}

Referenced by MEM_readBE32(), MEM_readLE32(), MEM_swapST(), MEM_writeBE32(), and MEM_writeLE32().

◆ MEM_swap64()

MEM_STATIC U64 MEM_swap64 ( U64 in )

Definition at line 287 of file mem.h.

{
#if (defined (__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 403)) \
  || (defined(__clang__) && __has_builtin(__builtin_bswap64))
    return __builtin_bswap64(in);
#else
    return  ((in << 56) & 0xff00000000000000ULL) |
            ((in << 40) & 0x00ff000000000000ULL) |
            ((in << 24) & 0x0000ff0000000000ULL) |
            ((in << 8)  & 0x000000ff00000000ULL) |
            ((in >> 8)  & 0x00000000ff000000ULL) |
            ((in >> 24) & 0x0000000000ff0000ULL) |
            ((in >> 40) & 0x000000000000ff00ULL) |
            ((in >> 56) & 0x00000000000000ffULL);
#endif
}

Referenced by MEM_readBE64(), MEM_readLE64(), MEM_swapST(), MEM_writeBE64(), and MEM_writeLE64().

◆ MEM_swapST()

MEM_STATIC size_t MEM_swapST ( size_t in )

Definition at line 304 of file mem.h.

{
    if (MEM_32bits())
        return (size_t)MEM_swap32((U32)in);
    else
        return (size_t)MEM_swap64((U64)in);
}

◆ MEM_write16()

MEM_STATIC void MEM_write16	(	void *	memPtr,
		U16	value
	)

Definition at line 257 of file mem.h.

{
    memcpy(memPtr, &value, sizeof(value));
}

Referenced by MEM_writeLE16().

◆ MEM_write32()

MEM_STATIC void MEM_write32	(	void *	memPtr,
		U32	value
	)

Definition at line 262 of file mem.h.

{
    memcpy(memPtr, &value, sizeof(value));
}

Referenced by MEM_writeBE32(), and MEM_writeLE32().

◆ MEM_write64()

MEM_STATIC void MEM_write64	(	void *	memPtr,
		U64	value
	)

Definition at line 267 of file mem.h.

{
    memcpy(memPtr, &value, sizeof(value));
}

Referenced by MEM_writeBE64(), and MEM_writeLE64().

◆ MEM_writeBE32()

MEM_STATIC void MEM_writeBE32	(	void *	memPtr,
		U32	val32
	)

Definition at line 404 of file mem.h.

{
    if (MEM_isLittleEndian())
        MEM_write32(memPtr, MEM_swap32(val32));
    else
        MEM_write32(memPtr, val32);
}

Referenced by MEM_writeBEST().

◆ MEM_writeBE64()

MEM_STATIC void MEM_writeBE64	(	void *	memPtr,
		U64	val64
	)

Definition at line 420 of file mem.h.

{
    if (MEM_isLittleEndian())
        MEM_write64(memPtr, MEM_swap64(val64));
    else
        MEM_write64(memPtr, val64);
}

Referenced by MEM_writeBEST().

◆ MEM_writeBEST()

MEM_STATIC void MEM_writeBEST	(	void *	memPtr,
		size_t	val
	)

Definition at line 436 of file mem.h.

{
    if (MEM_32bits())
        MEM_writeBE32(memPtr, (U32)val);
    else
        MEM_writeBE64(memPtr, (U64)val);
}

◆ MEM_writeLE16()

MEM_STATIC void MEM_writeLE16	(	void *	memPtr,
		U16	val
	)

Definition at line 324 of file mem.h.

{
    if (MEM_isLittleEndian()) {
        MEM_write16(memPtr, val);
    } else {
        BYTE* p = (BYTE*)memPtr;
        p[0] = (BYTE)val;
        p[1] = (BYTE)(val>>8);
    }
}

Referenced by HUF_compress4X_usingCTable_internal(), HUF_fillDTableX2(), HUF_fillDTableX2Level2(), MEM_writeLE24(), ZSTD_compressRleLiteralsBlock(), ZSTD_compressSequences_internal(), ZSTD_compressSubBlock_sequences(), ZSTD_noCompressLiterals(), and ZSTD_writeFrameHeader().

◆ MEM_writeLE24()

MEM_STATIC void MEM_writeLE24	(	void *	memPtr,
		U32	val
	)

Definition at line 340 of file mem.h.

{
    MEM_writeLE16(memPtr, (U16)val);
    ((BYTE*)memPtr)[2] = (BYTE)(val>>16);
}

Referenced by ZSTD_compress_frameChunk(), ZSTD_compressLiterals(), ZSTD_compressSubBlock(), ZSTD_compressSubBlock_literal(), and ZSTD_writeLastEmptyBlock().

◆ MEM_writeLE32()

MEM_STATIC void MEM_writeLE32	(	void *	memPtr,
		U32	val32
	)

Definition at line 354 of file mem.h.

{
    if (MEM_isLittleEndian())
        MEM_write32(memPtr, val32);
    else
        MEM_write32(memPtr, MEM_swap32(val32));
}

Referenced by MEM_writeLEST(), ZSTD_compressLiterals(), ZSTD_compressRleLiteralsBlock(), ZSTD_compressSubBlock_literal(), ZSTD_noCompressLiterals(), ZSTD_writeEpilogue(), and ZSTD_writeFrameHeader().

◆ MEM_writeLE64()

MEM_STATIC void MEM_writeLE64	(	void *	memPtr,
		U64	val64
	)

Definition at line 370 of file mem.h.

{
    if (MEM_isLittleEndian())
        MEM_write64(memPtr, val64);
    else
        MEM_write64(memPtr, MEM_swap64(val64));
}

Referenced by MEM_writeLEST(), and ZSTD_writeFrameHeader().

◆ MEM_writeLEST()

MEM_STATIC void MEM_writeLEST	(	void *	memPtr,
		size_t	val
	)

Definition at line 386 of file mem.h.

{
    if (MEM_32bits())
        MEM_writeLE32(memPtr, (U32)val);
    else
        MEM_writeLE64(memPtr, (U64)val);
}

Referenced by BIT_flushBits(), and BIT_flushBitsFast().

Macros

Typedefs

Functions