mem.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. /* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
  2. /*
  3. * Copyright (c) Yann Collet, Facebook, Inc.
  4. * All rights reserved.
  5. *
  6. * This source code is licensed under both the BSD-style license (found in the
  7. * LICENSE file in the root directory of this source tree) and the GPLv2 (found
  8. * in the COPYING file in the root directory of this source tree).
  9. * You may select, at your option, one of the above-listed licenses.
  10. */
  11. #ifndef MEM_H_MODULE
  12. #define MEM_H_MODULE
  13. /*-****************************************
  14. * Dependencies
  15. ******************************************/
  16. #include <asm/unaligned.h> /* get_unaligned, put_unaligned* */
  17. #include <linux/compiler.h> /* inline */
  18. #include <linux/swab.h> /* swab32, swab64 */
  19. #include <linux/types.h> /* size_t, ptrdiff_t */
  20. #include "debug.h" /* DEBUG_STATIC_ASSERT */
  21. /*-****************************************
  22. * Compiler specifics
  23. ******************************************/
  24. #define MEM_STATIC static inline
  25. /*-**************************************************************
  26. * Basic Types
  27. *****************************************************************/
  28. typedef uint8_t BYTE;
  29. typedef uint16_t U16;
  30. typedef int16_t S16;
  31. typedef uint32_t U32;
  32. typedef int32_t S32;
  33. typedef uint64_t U64;
  34. typedef int64_t S64;
  35. /*-**************************************************************
  36. * Memory I/O API
  37. *****************************************************************/
  38. /*=== Static platform detection ===*/
  39. MEM_STATIC unsigned MEM_32bits(void);
  40. MEM_STATIC unsigned MEM_64bits(void);
  41. MEM_STATIC unsigned MEM_isLittleEndian(void);
  42. /*=== Native unaligned read/write ===*/
  43. MEM_STATIC U16 MEM_read16(const void* memPtr);
  44. MEM_STATIC U32 MEM_read32(const void* memPtr);
  45. MEM_STATIC U64 MEM_read64(const void* memPtr);
  46. MEM_STATIC size_t MEM_readST(const void* memPtr);
  47. MEM_STATIC void MEM_write16(void* memPtr, U16 value);
  48. MEM_STATIC void MEM_write32(void* memPtr, U32 value);
  49. MEM_STATIC void MEM_write64(void* memPtr, U64 value);
  50. /*=== Little endian unaligned read/write ===*/
  51. MEM_STATIC U16 MEM_readLE16(const void* memPtr);
  52. MEM_STATIC U32 MEM_readLE24(const void* memPtr);
  53. MEM_STATIC U32 MEM_readLE32(const void* memPtr);
  54. MEM_STATIC U64 MEM_readLE64(const void* memPtr);
  55. MEM_STATIC size_t MEM_readLEST(const void* memPtr);
  56. MEM_STATIC void MEM_writeLE16(void* memPtr, U16 val);
  57. MEM_STATIC void MEM_writeLE24(void* memPtr, U32 val);
  58. MEM_STATIC void MEM_writeLE32(void* memPtr, U32 val32);
  59. MEM_STATIC void MEM_writeLE64(void* memPtr, U64 val64);
  60. MEM_STATIC void MEM_writeLEST(void* memPtr, size_t val);
  61. /*=== Big endian unaligned read/write ===*/
  62. MEM_STATIC U32 MEM_readBE32(const void* memPtr);
  63. MEM_STATIC U64 MEM_readBE64(const void* memPtr);
  64. MEM_STATIC size_t MEM_readBEST(const void* memPtr);
  65. MEM_STATIC void MEM_writeBE32(void* memPtr, U32 val32);
  66. MEM_STATIC void MEM_writeBE64(void* memPtr, U64 val64);
  67. MEM_STATIC void MEM_writeBEST(void* memPtr, size_t val);
  68. /*=== Byteswap ===*/
  69. MEM_STATIC U32 MEM_swap32(U32 in);
  70. MEM_STATIC U64 MEM_swap64(U64 in);
  71. MEM_STATIC size_t MEM_swapST(size_t in);
  72. /*-**************************************************************
  73. * Memory I/O Implementation
  74. *****************************************************************/
  75. MEM_STATIC unsigned MEM_32bits(void)
  76. {
  77. return sizeof(size_t) == 4;
  78. }
  79. MEM_STATIC unsigned MEM_64bits(void)
  80. {
  81. return sizeof(size_t) == 8;
  82. }
  83. #if defined(__LITTLE_ENDIAN)
  84. #define MEM_LITTLE_ENDIAN 1
  85. #else
  86. #define MEM_LITTLE_ENDIAN 0
  87. #endif
  88. MEM_STATIC unsigned MEM_isLittleEndian(void)
  89. {
  90. return MEM_LITTLE_ENDIAN;
  91. }
  92. MEM_STATIC U16 MEM_read16(const void *memPtr)
  93. {
  94. return get_unaligned((const U16 *)memPtr);
  95. }
  96. MEM_STATIC U32 MEM_read32(const void *memPtr)
  97. {
  98. return get_unaligned((const U32 *)memPtr);
  99. }
  100. MEM_STATIC U64 MEM_read64(const void *memPtr)
  101. {
  102. return get_unaligned((const U64 *)memPtr);
  103. }
  104. MEM_STATIC size_t MEM_readST(const void *memPtr)
  105. {
  106. return get_unaligned((const size_t *)memPtr);
  107. }
  108. MEM_STATIC void MEM_write16(void *memPtr, U16 value)
  109. {
  110. put_unaligned(value, (U16 *)memPtr);
  111. }
  112. MEM_STATIC void MEM_write32(void *memPtr, U32 value)
  113. {
  114. put_unaligned(value, (U32 *)memPtr);
  115. }
  116. MEM_STATIC void MEM_write64(void *memPtr, U64 value)
  117. {
  118. put_unaligned(value, (U64 *)memPtr);
  119. }
  120. /*=== Little endian r/w ===*/
  121. MEM_STATIC U16 MEM_readLE16(const void *memPtr)
  122. {
  123. return get_unaligned_le16(memPtr);
  124. }
  125. MEM_STATIC void MEM_writeLE16(void *memPtr, U16 val)
  126. {
  127. put_unaligned_le16(val, memPtr);
  128. }
  129. MEM_STATIC U32 MEM_readLE24(const void *memPtr)
  130. {
  131. return MEM_readLE16(memPtr) + (((const BYTE *)memPtr)[2] << 16);
  132. }
  133. MEM_STATIC void MEM_writeLE24(void *memPtr, U32 val)
  134. {
  135. MEM_writeLE16(memPtr, (U16)val);
  136. ((BYTE *)memPtr)[2] = (BYTE)(val >> 16);
  137. }
  138. MEM_STATIC U32 MEM_readLE32(const void *memPtr)
  139. {
  140. return get_unaligned_le32(memPtr);
  141. }
  142. MEM_STATIC void MEM_writeLE32(void *memPtr, U32 val32)
  143. {
  144. put_unaligned_le32(val32, memPtr);
  145. }
  146. MEM_STATIC U64 MEM_readLE64(const void *memPtr)
  147. {
  148. return get_unaligned_le64(memPtr);
  149. }
  150. MEM_STATIC void MEM_writeLE64(void *memPtr, U64 val64)
  151. {
  152. put_unaligned_le64(val64, memPtr);
  153. }
  154. MEM_STATIC size_t MEM_readLEST(const void *memPtr)
  155. {
  156. if (MEM_32bits())
  157. return (size_t)MEM_readLE32(memPtr);
  158. else
  159. return (size_t)MEM_readLE64(memPtr);
  160. }
  161. MEM_STATIC void MEM_writeLEST(void *memPtr, size_t val)
  162. {
  163. if (MEM_32bits())
  164. MEM_writeLE32(memPtr, (U32)val);
  165. else
  166. MEM_writeLE64(memPtr, (U64)val);
  167. }
  168. /*=== Big endian r/w ===*/
  169. MEM_STATIC U32 MEM_readBE32(const void *memPtr)
  170. {
  171. return get_unaligned_be32(memPtr);
  172. }
  173. MEM_STATIC void MEM_writeBE32(void *memPtr, U32 val32)
  174. {
  175. put_unaligned_be32(val32, memPtr);
  176. }
  177. MEM_STATIC U64 MEM_readBE64(const void *memPtr)
  178. {
  179. return get_unaligned_be64(memPtr);
  180. }
  181. MEM_STATIC void MEM_writeBE64(void *memPtr, U64 val64)
  182. {
  183. put_unaligned_be64(val64, memPtr);
  184. }
  185. MEM_STATIC size_t MEM_readBEST(const void *memPtr)
  186. {
  187. if (MEM_32bits())
  188. return (size_t)MEM_readBE32(memPtr);
  189. else
  190. return (size_t)MEM_readBE64(memPtr);
  191. }
  192. MEM_STATIC void MEM_writeBEST(void *memPtr, size_t val)
  193. {
  194. if (MEM_32bits())
  195. MEM_writeBE32(memPtr, (U32)val);
  196. else
  197. MEM_writeBE64(memPtr, (U64)val);
  198. }
  199. MEM_STATIC U32 MEM_swap32(U32 in)
  200. {
  201. return swab32(in);
  202. }
  203. MEM_STATIC U64 MEM_swap64(U64 in)
  204. {
  205. return swab64(in);
  206. }
  207. MEM_STATIC size_t MEM_swapST(size_t in)
  208. {
  209. if (MEM_32bits())
  210. return (size_t)MEM_swap32((U32)in);
  211. else
  212. return (size_t)MEM_swap64((U64)in);
  213. }
  214. #endif /* MEM_H_MODULE */