linux/lib/zstd/common/mem.h

/* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
/*
 * Copyright (c) Yann Collet, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under both the BSD-style license (found in the
 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
 * in the COPYING file in the root directory of this source tree).
 * You may select, at your option, one of the above-listed licenses.
 */

#ifndef MEM_H_MODULE
#define MEM_H_MODULE

/*-****************************************
*  Dependencies
******************************************/
#include <linux/unaligned.h>  /* get_unaligned, put_unaligned* */
#include <linux/compiler.h>  /* inline */
#include <linux/swab.h>  /* swab32, swab64 */
#include <linux/types.h>  /* size_t, ptrdiff_t */
#include "debug.h"  /* DEBUG_STATIC_ASSERT */

/*-****************************************
*  Compiler specifics
******************************************/
#define MEM_STATIC …

/*-**************************************************************
*  Basic Types
*****************************************************************/
BYTE;
U8;
S8;
U16;
S16;
U32;
S32;
U64;
S64;

/*-**************************************************************
*  Memory I/O API
*****************************************************************/
/*=== Static platform detection ===*/
MEM_STATIC unsigned MEM_32bits(void);
MEM_STATIC unsigned MEM_64bits(void);
MEM_STATIC unsigned MEM_isLittleEndian(void);

/*=== Native unaligned read/write ===*/
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);

/*=== Little endian unaligned read/write ===*/
MEM_STATIC U16 MEM_readLE16(const void* memPtr);
MEM_STATIC U32 MEM_readLE24(const void* memPtr);
MEM_STATIC U32 MEM_readLE32(const void* memPtr);
MEM_STATIC U64 MEM_readLE64(const void* memPtr);
MEM_STATIC size_t MEM_readLEST(const void* memPtr);

MEM_STATIC void MEM_writeLE16(void* memPtr, U16 val);
MEM_STATIC void MEM_writeLE24(void* memPtr, U32 val);
MEM_STATIC void MEM_writeLE32(void* memPtr, U32 val32);
MEM_STATIC void MEM_writeLE64(void* memPtr, U64 val64);
MEM_STATIC void MEM_writeLEST(void* memPtr, size_t val);

/*=== Big endian unaligned read/write ===*/
MEM_STATIC U32 MEM_readBE32(const void* memPtr);
MEM_STATIC U64 MEM_readBE64(const void* memPtr);
MEM_STATIC size_t MEM_readBEST(const void* memPtr);

MEM_STATIC void MEM_writeBE32(void* memPtr, U32 val32);
MEM_STATIC void MEM_writeBE64(void* memPtr, U64 val64);
MEM_STATIC void MEM_writeBEST(void* memPtr, size_t val);

/*=== Byteswap ===*/
MEM_STATIC U32 MEM_swap32(U32 in);
MEM_STATIC U64 MEM_swap64(U64 in);
MEM_STATIC size_t MEM_swapST(size_t in);

/*-**************************************************************
*  Memory I/O Implementation
*****************************************************************/
MEM_STATIC unsigned MEM_32bits(void)
{ … }

MEM_STATIC unsigned MEM_64bits(void)
{ … }

#if defined(__LITTLE_ENDIAN)
#define MEM_LITTLE_ENDIAN …
#else
#define MEM_LITTLE_ENDIAN …
#endif

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)
{ … }

/*=== Little endian r/w ===*/

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)
{ … }

/*=== Big endian r/w ===*/

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)
{ … }

MEM_STATIC U32 MEM_swap32(U32 in)
{ … }

MEM_STATIC U64 MEM_swap64(U64 in)
{ … }

MEM_STATIC size_t MEM_swapST(size_t in)
{ … }

#endif /* MEM_H_MODULE */