1 /*
2 * Copyright (c) Yann Collet, Facebook, Inc.
3 * All rights reserved.
4 *
5 * This source code is licensed under both the BSD-style license (found in the
6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7 * in the COPYING file in the root directory of this source tree).
8 * You may select, at your option, one of the above-listed licenses.
9 */
10
11 #ifndef MEM_H_MODULE
12 #define MEM_H_MODULE
13
14 #if defined (__cplusplus)
15 extern "C" {
16 #endif
17
18 /*-****************************************
19 * Dependencies
20 ******************************************/
21 #include <stddef.h> /* size_t, ptrdiff_t */
22 #include "compiler.h" /* __has_builtin */
23 #include "debug.h" /* DEBUG_STATIC_ASSERT */
24 #include "zstd_deps.h" /* ZSTD_memcpy */
25
26
27 /*-****************************************
28 * Compiler specifics
29 ******************************************/
30 #if defined(_MSC_VER) /* Visual Studio */
31 # include <stdlib.h> /* _byteswap_ulong */
32 # include <intrin.h> /* _byteswap_* */
33 #endif
34 #if defined(__GNUC__)
35 # define MEM_STATIC static __inline __attribute__((unused))
36 #elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
37 # define MEM_STATIC static inline
38 #elif defined(_MSC_VER)
39 # define MEM_STATIC static __inline
40 #else
41 # define MEM_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */
42 #endif
43
44 /*-**************************************************************
45 * Basic Types
46 *****************************************************************/
47 #if !defined (__VMS) && (defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) )
48 # if defined(_AIX)
49 # include <inttypes.h>
50 # else
51 # include <stdint.h> /* intptr_t */
52 # endif
53 typedef uint8_t BYTE;
54 typedef uint16_t U16;
55 typedef int16_t S16;
56 typedef uint32_t U32;
57 typedef int32_t S32;
58 typedef uint64_t U64;
59 typedef int64_t S64;
60 #else
61 # include <limits.h>
62 #if CHAR_BIT != 8
63 # error "this implementation requires char to be exactly 8-bit type"
64 #endif
65 typedef unsigned char BYTE;
66 #if USHRT_MAX != 65535
67 # error "this implementation requires short to be exactly 16-bit type"
68 #endif
69 typedef unsigned short U16;
70 typedef signed short S16;
71 #if UINT_MAX != 4294967295
72 # error "this implementation requires int to be exactly 32-bit type"
73 #endif
74 typedef unsigned int U32;
75 typedef signed int S32;
76 /* note : there are no limits defined for long long type in C90.
77 * limits exist in C99, however, in such case, <stdint.h> is preferred */
78 typedef unsigned long long U64;
79 typedef signed long long S64;
80 #endif
81
82
83 /*-**************************************************************
84 * Memory I/O API
85 *****************************************************************/
86 /*=== Static platform detection ===*/
87 MEM_STATIC unsigned MEM_32bits(void);
88 MEM_STATIC unsigned MEM_64bits(void);
89 MEM_STATIC unsigned MEM_isLittleEndian(void);
90
91 /*=== Native unaligned read/write ===*/
92 MEM_STATIC U16 MEM_read16(const void* memPtr);
93 MEM_STATIC U32 MEM_read32(const void* memPtr);
94 MEM_STATIC U64 MEM_read64(const void* memPtr);
95 MEM_STATIC size_t MEM_readST(const void* memPtr);
96
97 MEM_STATIC void MEM_write16(void* memPtr, U16 value);
98 MEM_STATIC void MEM_write32(void* memPtr, U32 value);
99 MEM_STATIC void MEM_write64(void* memPtr, U64 value);
100
101 /*=== Little endian unaligned read/write ===*/
102 MEM_STATIC U16 MEM_readLE16(const void* memPtr);
103 MEM_STATIC U32 MEM_readLE24(const void* memPtr);
104 MEM_STATIC U32 MEM_readLE32(const void* memPtr);
105 MEM_STATIC U64 MEM_readLE64(const void* memPtr);
106 MEM_STATIC size_t MEM_readLEST(const void* memPtr);
107
108 MEM_STATIC void MEM_writeLE16(void* memPtr, U16 val);
109 MEM_STATIC void MEM_writeLE24(void* memPtr, U32 val);
110 MEM_STATIC void MEM_writeLE32(void* memPtr, U32 val32);
111 MEM_STATIC void MEM_writeLE64(void* memPtr, U64 val64);
112 MEM_STATIC void MEM_writeLEST(void* memPtr, size_t val);
113
114 /*=== Big endian unaligned read/write ===*/
115 MEM_STATIC U32 MEM_readBE32(const void* memPtr);
116 MEM_STATIC U64 MEM_readBE64(const void* memPtr);
117 MEM_STATIC size_t MEM_readBEST(const void* memPtr);
118
119 MEM_STATIC void MEM_writeBE32(void* memPtr, U32 val32);
120 MEM_STATIC void MEM_writeBE64(void* memPtr, U64 val64);
121 MEM_STATIC void MEM_writeBEST(void* memPtr, size_t val);
122
123 /*=== Byteswap ===*/
124 MEM_STATIC U32 MEM_swap32(U32 in);
125 MEM_STATIC U64 MEM_swap64(U64 in);
126 MEM_STATIC size_t MEM_swapST(size_t in);
127
128
129 /*-**************************************************************
130 * Memory I/O Implementation
131 *****************************************************************/
132 /* MEM_FORCE_MEMORY_ACCESS :
133 * By default, access to unaligned memory is controlled by `memcpy()`, which is safe and portable.
134 * Unfortunately, on some target/compiler combinations, the generated assembly is sub-optimal.
135 * The below switch allow to select different access method for improved performance.
136 * Method 0 (default) : use `memcpy()`. Safe and portable.
137 * Method 1 : `__packed` statement. It depends on compiler extension (i.e., not portable).
138 * This method is safe if your compiler supports it, and *generally* as fast or faster than `memcpy`.
139 * Method 2 : direct access. This method is portable but violate C standard.
140 * It can generate buggy code on targets depending on alignment.
141 * In some circumstances, it's the only known way to get the most performance (i.e. GCC + ARMv6)
142 * See http://fastcompression.blogspot.fr/2015/08/accessing-unaligned-memory.html for details.
143 * Prefer these methods in priority order (0 > 1 > 2)
144 */
145 #ifndef MEM_FORCE_MEMORY_ACCESS /* can be defined externally, on command line for example */
146 # if defined(__INTEL_COMPILER) || defined(__GNUC__) || defined(__ICCARM__)
147 # define MEM_FORCE_MEMORY_ACCESS 1
148 # endif
149 #endif
150
MEM_32bits(void)151 MEM_STATIC unsigned MEM_32bits(void) { return sizeof(size_t)==4; }
MEM_64bits(void)152 MEM_STATIC unsigned MEM_64bits(void) { return sizeof(size_t)==8; }
153
MEM_isLittleEndian(void)154 MEM_STATIC unsigned MEM_isLittleEndian(void)
155 {
156 const union { U32 u; BYTE c[4]; } one = { 1 }; /* don't use static : performance detrimental */
157 return one.c[0];
158 }
159
160 #if defined(MEM_FORCE_MEMORY_ACCESS) && (MEM_FORCE_MEMORY_ACCESS==2)
161
162 /* violates C standard, by lying on structure alignment.
163 Only use if no other choice to achieve best performance on target platform */
MEM_read16(const void * memPtr)164 MEM_STATIC U16 MEM_read16(const void* memPtr) { return *(const U16*) memPtr; }
MEM_read32(const void * memPtr)165 MEM_STATIC U32 MEM_read32(const void* memPtr) { return *(const U32*) memPtr; }
MEM_read64(const void * memPtr)166 MEM_STATIC U64 MEM_read64(const void* memPtr) { return *(const U64*) memPtr; }
MEM_readST(const void * memPtr)167 MEM_STATIC size_t MEM_readST(const void* memPtr) { return *(const size_t*) memPtr; }
168
MEM_write16(void * memPtr,U16 value)169 MEM_STATIC void MEM_write16(void* memPtr, U16 value) { *(U16*)memPtr = value; }
MEM_write32(void * memPtr,U32 value)170 MEM_STATIC void MEM_write32(void* memPtr, U32 value) { *(U32*)memPtr = value; }
MEM_write64(void * memPtr,U64 value)171 MEM_STATIC void MEM_write64(void* memPtr, U64 value) { *(U64*)memPtr = value; }
172
173 #elif defined(MEM_FORCE_MEMORY_ACCESS) && (MEM_FORCE_MEMORY_ACCESS==1)
174
175 /* __pack instructions are safer, but compiler specific, hence potentially problematic for some compilers */
176 /* currently only defined for gcc and icc */
177 #if defined(_MSC_VER) || (defined(__INTEL_COMPILER) && defined(WIN32))
178 __pragma( pack(push, 1) )
179 typedef struct { U16 v; } unalign16;
180 typedef struct { U32 v; } unalign32;
181 typedef struct { U64 v; } unalign64;
182 typedef struct { size_t v; } unalignArch;
__pragma(pack (pop))183 __pragma( pack(pop) )
184 #else
185 typedef struct { U16 v; } __attribute__((packed)) unalign16;
186 typedef struct { U32 v; } __attribute__((packed)) unalign32;
187 typedef struct { U64 v; } __attribute__((packed)) unalign64;
188 typedef struct { size_t v; } __attribute__((packed)) unalignArch;
189 #endif
190
191 MEM_STATIC U16 MEM_read16(const void* ptr) { return ((const unalign16*)ptr)->v; }
MEM_read32(const void * ptr)192 MEM_STATIC U32 MEM_read32(const void* ptr) { return ((const unalign32*)ptr)->v; }
MEM_read64(const void * ptr)193 MEM_STATIC U64 MEM_read64(const void* ptr) { return ((const unalign64*)ptr)->v; }
MEM_readST(const void * ptr)194 MEM_STATIC size_t MEM_readST(const void* ptr) { return ((const unalignArch*)ptr)->v; }
195
MEM_write16(void * memPtr,U16 value)196 MEM_STATIC void MEM_write16(void* memPtr, U16 value) { ((unalign16*)memPtr)->v = value; }
MEM_write32(void * memPtr,U32 value)197 MEM_STATIC void MEM_write32(void* memPtr, U32 value) { ((unalign32*)memPtr)->v = value; }
MEM_write64(void * memPtr,U64 value)198 MEM_STATIC void MEM_write64(void* memPtr, U64 value) { ((unalign64*)memPtr)->v = value; }
199
200 #else
201
202 /* default method, safe and standard.
203 can sometimes prove slower */
204
MEM_read16(const void * memPtr)205 MEM_STATIC U16 MEM_read16(const void* memPtr)
206 {
207 U16 val; ZSTD_memcpy(&val, memPtr, sizeof(val)); return val;
208 }
209
MEM_read32(const void * memPtr)210 MEM_STATIC U32 MEM_read32(const void* memPtr)
211 {
212 U32 val; ZSTD_memcpy(&val, memPtr, sizeof(val)); return val;
213 }
214
MEM_read64(const void * memPtr)215 MEM_STATIC U64 MEM_read64(const void* memPtr)
216 {
217 U64 val; ZSTD_memcpy(&val, memPtr, sizeof(val)); return val;
218 }
219
MEM_readST(const void * memPtr)220 MEM_STATIC size_t MEM_readST(const void* memPtr)
221 {
222 size_t val; ZSTD_memcpy(&val, memPtr, sizeof(val)); return val;
223 }
224
MEM_write16(void * memPtr,U16 value)225 MEM_STATIC void MEM_write16(void* memPtr, U16 value)
226 {
227 ZSTD_memcpy(memPtr, &value, sizeof(value));
228 }
229
MEM_write32(void * memPtr,U32 value)230 MEM_STATIC void MEM_write32(void* memPtr, U32 value)
231 {
232 ZSTD_memcpy(memPtr, &value, sizeof(value));
233 }
234
MEM_write64(void * memPtr,U64 value)235 MEM_STATIC void MEM_write64(void* memPtr, U64 value)
236 {
237 ZSTD_memcpy(memPtr, &value, sizeof(value));
238 }
239
240 #endif /* MEM_FORCE_MEMORY_ACCESS */
241
MEM_swap32(U32 in)242 MEM_STATIC U32 MEM_swap32(U32 in)
243 {
244 #if defined(_MSC_VER) /* Visual Studio */
245 return _byteswap_ulong(in);
246 #elif (defined (__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 403)) \
247 || (defined(__clang__) && __has_builtin(__builtin_bswap32))
248 return __builtin_bswap32(in);
249 #else
250 return ((in << 24) & 0xff000000 ) |
251 ((in << 8) & 0x00ff0000 ) |
252 ((in >> 8) & 0x0000ff00 ) |
253 ((in >> 24) & 0x000000ff );
254 #endif
255 }
256
MEM_swap64(U64 in)257 MEM_STATIC U64 MEM_swap64(U64 in)
258 {
259 #if defined(_MSC_VER) /* Visual Studio */
260 return _byteswap_uint64(in);
261 #elif (defined (__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 403)) \
262 || (defined(__clang__) && __has_builtin(__builtin_bswap64))
263 return __builtin_bswap64(in);
264 #else
265 return ((in << 56) & 0xff00000000000000ULL) |
266 ((in << 40) & 0x00ff000000000000ULL) |
267 ((in << 24) & 0x0000ff0000000000ULL) |
268 ((in << 8) & 0x000000ff00000000ULL) |
269 ((in >> 8) & 0x00000000ff000000ULL) |
270 ((in >> 24) & 0x0000000000ff0000ULL) |
271 ((in >> 40) & 0x000000000000ff00ULL) |
272 ((in >> 56) & 0x00000000000000ffULL);
273 #endif
274 }
275
MEM_swapST(size_t in)276 MEM_STATIC size_t MEM_swapST(size_t in)
277 {
278 if (MEM_32bits())
279 return (size_t)MEM_swap32((U32)in);
280 else
281 return (size_t)MEM_swap64((U64)in);
282 }
283
284 /*=== Little endian r/w ===*/
285
MEM_readLE16(const void * memPtr)286 MEM_STATIC U16 MEM_readLE16(const void* memPtr)
287 {
288 if (MEM_isLittleEndian())
289 return MEM_read16(memPtr);
290 else {
291 const BYTE* p = (const BYTE*)memPtr;
292 return (U16)(p[0] + (p[1]<<8));
293 }
294 }
295
MEM_writeLE16(void * memPtr,U16 val)296 MEM_STATIC void MEM_writeLE16(void* memPtr, U16 val)
297 {
298 if (MEM_isLittleEndian()) {
299 MEM_write16(memPtr, val);
300 } else {
301 BYTE* p = (BYTE*)memPtr;
302 p[0] = (BYTE)val;
303 p[1] = (BYTE)(val>>8);
304 }
305 }
306
MEM_readLE24(const void * memPtr)307 MEM_STATIC U32 MEM_readLE24(const void* memPtr)
308 {
309 return (U32)MEM_readLE16(memPtr) + ((U32)(((const BYTE*)memPtr)[2]) << 16);
310 }
311
MEM_writeLE24(void * memPtr,U32 val)312 MEM_STATIC void MEM_writeLE24(void* memPtr, U32 val)
313 {
314 MEM_writeLE16(memPtr, (U16)val);
315 ((BYTE*)memPtr)[2] = (BYTE)(val>>16);
316 }
317
MEM_readLE32(const void * memPtr)318 MEM_STATIC U32 MEM_readLE32(const void* memPtr)
319 {
320 if (MEM_isLittleEndian())
321 return MEM_read32(memPtr);
322 else
323 return MEM_swap32(MEM_read32(memPtr));
324 }
325
MEM_writeLE32(void * memPtr,U32 val32)326 MEM_STATIC void MEM_writeLE32(void* memPtr, U32 val32)
327 {
328 if (MEM_isLittleEndian())
329 MEM_write32(memPtr, val32);
330 else
331 MEM_write32(memPtr, MEM_swap32(val32));
332 }
333
MEM_readLE64(const void * memPtr)334 MEM_STATIC U64 MEM_readLE64(const void* memPtr)
335 {
336 if (MEM_isLittleEndian())
337 return MEM_read64(memPtr);
338 else
339 return MEM_swap64(MEM_read64(memPtr));
340 }
341
MEM_writeLE64(void * memPtr,U64 val64)342 MEM_STATIC void MEM_writeLE64(void* memPtr, U64 val64)
343 {
344 if (MEM_isLittleEndian())
345 MEM_write64(memPtr, val64);
346 else
347 MEM_write64(memPtr, MEM_swap64(val64));
348 }
349
MEM_readLEST(const void * memPtr)350 MEM_STATIC size_t MEM_readLEST(const void* memPtr)
351 {
352 if (MEM_32bits())
353 return (size_t)MEM_readLE32(memPtr);
354 else
355 return (size_t)MEM_readLE64(memPtr);
356 }
357
MEM_writeLEST(void * memPtr,size_t val)358 MEM_STATIC void MEM_writeLEST(void* memPtr, size_t val)
359 {
360 if (MEM_32bits())
361 MEM_writeLE32(memPtr, (U32)val);
362 else
363 MEM_writeLE64(memPtr, (U64)val);
364 }
365
366 /*=== Big endian r/w ===*/
367
MEM_readBE32(const void * memPtr)368 MEM_STATIC U32 MEM_readBE32(const void* memPtr)
369 {
370 if (MEM_isLittleEndian())
371 return MEM_swap32(MEM_read32(memPtr));
372 else
373 return MEM_read32(memPtr);
374 }
375
MEM_writeBE32(void * memPtr,U32 val32)376 MEM_STATIC void MEM_writeBE32(void* memPtr, U32 val32)
377 {
378 if (MEM_isLittleEndian())
379 MEM_write32(memPtr, MEM_swap32(val32));
380 else
381 MEM_write32(memPtr, val32);
382 }
383
MEM_readBE64(const void * memPtr)384 MEM_STATIC U64 MEM_readBE64(const void* memPtr)
385 {
386 if (MEM_isLittleEndian())
387 return MEM_swap64(MEM_read64(memPtr));
388 else
389 return MEM_read64(memPtr);
390 }
391
MEM_writeBE64(void * memPtr,U64 val64)392 MEM_STATIC void MEM_writeBE64(void* memPtr, U64 val64)
393 {
394 if (MEM_isLittleEndian())
395 MEM_write64(memPtr, MEM_swap64(val64));
396 else
397 MEM_write64(memPtr, val64);
398 }
399
MEM_readBEST(const void * memPtr)400 MEM_STATIC size_t MEM_readBEST(const void* memPtr)
401 {
402 if (MEM_32bits())
403 return (size_t)MEM_readBE32(memPtr);
404 else
405 return (size_t)MEM_readBE64(memPtr);
406 }
407
MEM_writeBEST(void * memPtr,size_t val)408 MEM_STATIC void MEM_writeBEST(void* memPtr, size_t val)
409 {
410 if (MEM_32bits())
411 MEM_writeBE32(memPtr, (U32)val);
412 else
413 MEM_writeBE64(memPtr, (U64)val);
414 }
415
416 /* code only tested on 32 and 64 bits systems */
MEM_check(void)417 MEM_STATIC void MEM_check(void) { DEBUG_STATIC_ASSERT((sizeof(size_t)==4) || (sizeof(size_t)==8)); }
418
419
420 #if defined (__cplusplus)
421 }
422 #endif
423
424 #endif /* MEM_H_MODULE */
425