1 /* Copyright 2016 Google Inc. All Rights Reserved.
2
3 Distributed under MIT license.
4 See file LICENSE for detail or copy at https://opensource.org/licenses/MIT
5 */
6
7 /* Macros for compiler / platform specific features and build options.
8
9 Build options are:
10 * BROTLI_BUILD_32_BIT disables 64-bit optimizations
11 * BROTLI_BUILD_64_BIT forces to use 64-bit optimizations
12 * BROTLI_BUILD_BIG_ENDIAN forces to use big-endian optimizations
13 * BROTLI_BUILD_ENDIAN_NEUTRAL disables endian-aware optimizations
14 * BROTLI_BUILD_LITTLE_ENDIAN forces to use little-endian optimizations
15 * BROTLI_BUILD_PORTABLE disables dangerous optimizations, like unaligned
16 read and overlapping memcpy; this reduces decompression speed by 5%
17 * BROTLI_BUILD_NO_RBIT disables "rbit" optimization for ARM CPUs
18 * BROTLI_DEBUG dumps file name and line number when decoder detects stream
19 or memory error
20 * BROTLI_ENABLE_LOG enables asserts and dumps various state information
21 */
22
23 #ifndef BROTLI_COMMON_PLATFORM_H_
24 #define BROTLI_COMMON_PLATFORM_H_
25
26 #include <string.h> /* memcpy */
27 #include <stdlib.h> /* malloc, free */
28
29 #include <brotli/port.h>
30 #include <brotli/types.h>
31
32 #if defined(OS_LINUX) || defined(OS_CYGWIN)
33 #include <endian.h>
34 #elif defined(OS_FREEBSD)
35 #include <machine/endian.h>
36 #elif defined(OS_MACOSX)
37 #include <machine/endian.h>
38 /* Let's try and follow the Linux convention */
39 #define BROTLI_X_BYTE_ORDER BYTE_ORDER
40 #define BROTLI_X_LITTLE_ENDIAN LITTLE_ENDIAN
41 #define BROTLI_X_BIG_ENDIAN BIG_ENDIAN
42 #endif
43
44 #if defined(BROTLI_ENABLE_LOG) || defined(BROTLI_DEBUG)
45 #include <assert.h>
46 #include <stdio.h>
47 #endif
48
49 /* The following macros were borrowed from https://github.com/nemequ/hedley
50 * with permission of original author - Evan Nemerson <evan@nemerson.com> */
51
52 /* >>> >>> >>> hedley macros */
53
54 /* Define "BROTLI_PREDICT_TRUE" and "BROTLI_PREDICT_FALSE" macros for capable
55 compilers.
56
57 To apply compiler hint, enclose the branching condition into macros, like this:
58
59 if (BROTLI_PREDICT_TRUE(zero == 0)) {
60 // main execution path
61 } else {
62 // compiler should place this code outside of main execution path
63 }
64
65 OR:
66
67 if (BROTLI_PREDICT_FALSE(something_rare_or_unexpected_happens)) {
68 // compiler should place this code outside of main execution path
69 }
70
71 */
72 #if BROTLI_GNUC_HAS_BUILTIN(__builtin_expect, 3, 0, 0) || \
73 BROTLI_INTEL_VERSION_CHECK(16, 0, 0) || \
74 BROTLI_SUNPRO_VERSION_CHECK(5, 12, 0) || \
75 BROTLI_ARM_VERSION_CHECK(4, 1, 0) || \
76 BROTLI_IBM_VERSION_CHECK(10, 1, 0) || \
77 BROTLI_TI_VERSION_CHECK(7, 3, 0) || \
78 BROTLI_TINYC_VERSION_CHECK(0, 9, 27)
79 #define BROTLI_PREDICT_TRUE(x) (__builtin_expect(!!(x), 1))
80 #define BROTLI_PREDICT_FALSE(x) (__builtin_expect(x, 0))
81 #else
82 #define BROTLI_PREDICT_FALSE(x) (x)
83 #define BROTLI_PREDICT_TRUE(x) (x)
84 #endif
85
86 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && \
87 !defined(__cplusplus)
88 #define BROTLI_RESTRICT restrict
89 #elif BROTLI_GNUC_VERSION_CHECK(3, 1, 0) || \
90 BROTLI_MSVC_VERSION_CHECK(14, 0, 0) || \
91 BROTLI_INTEL_VERSION_CHECK(16, 0, 0) || \
92 BROTLI_ARM_VERSION_CHECK(4, 1, 0) || \
93 BROTLI_IBM_VERSION_CHECK(10, 1, 0) || \
94 BROTLI_PGI_VERSION_CHECK(17, 10, 0) || \
95 BROTLI_TI_VERSION_CHECK(8, 0, 0) || \
96 BROTLI_IAR_VERSION_CHECK(8, 0, 0) || \
97 (BROTLI_SUNPRO_VERSION_CHECK(5, 14, 0) && defined(__cplusplus))
98 #define BROTLI_RESTRICT __restrict
99 #elif BROTLI_SUNPRO_VERSION_CHECK(5, 3, 0) && !defined(__cplusplus)
100 #define BROTLI_RESTRICT _Restrict
101 #else
102 #define BROTLI_RESTRICT
103 #endif
104
105 #if (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || \
106 (defined(__cplusplus) && (__cplusplus >= 199711L))
107 #define BROTLI_MAYBE_INLINE inline
108 #elif defined(__GNUC_STDC_INLINE__) || defined(__GNUC_GNU_INLINE__) || \
109 BROTLI_ARM_VERSION_CHECK(6, 2, 0)
110 #define BROTLI_MAYBE_INLINE __inline__
111 #elif BROTLI_MSVC_VERSION_CHECK(12, 0, 0) || \
112 BROTLI_ARM_VERSION_CHECK(4, 1, 0) || BROTLI_TI_VERSION_CHECK(8, 0, 0)
113 #define BROTLI_MAYBE_INLINE __inline
114 #else
115 #define BROTLI_MAYBE_INLINE
116 #endif
117
118 #if BROTLI_GNUC_HAS_ATTRIBUTE(always_inline, 4, 0, 0) || \
119 BROTLI_INTEL_VERSION_CHECK(16, 0, 0) || \
120 BROTLI_SUNPRO_VERSION_CHECK(5, 11, 0) || \
121 BROTLI_ARM_VERSION_CHECK(4, 1, 0) || \
122 BROTLI_IBM_VERSION_CHECK(10, 1, 0) || \
123 BROTLI_TI_VERSION_CHECK(8, 0, 0) || \
124 (BROTLI_TI_VERSION_CHECK(7, 3, 0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__))
125 #define BROTLI_INLINE BROTLI_MAYBE_INLINE __attribute__((__always_inline__))
126 #elif BROTLI_MSVC_VERSION_CHECK(12, 0, 0)
127 #define BROTLI_INLINE BROTLI_MAYBE_INLINE __forceinline
128 #elif BROTLI_TI_VERSION_CHECK(7, 0, 0) && defined(__cplusplus)
129 #define BROTLI_INLINE BROTLI_MAYBE_INLINE _Pragma("FUNC_ALWAYS_INLINE;")
130 #elif BROTLI_IAR_VERSION_CHECK(8, 0, 0)
131 #define BROTLI_INLINE BROTLI_MAYBE_INLINE _Pragma("inline=forced")
132 #else
133 #define BROTLI_INLINE BROTLI_MAYBE_INLINE
134 #endif
135
136 #if BROTLI_GNUC_HAS_ATTRIBUTE(noinline, 4, 0, 0) || \
137 BROTLI_INTEL_VERSION_CHECK(16, 0, 0) || \
138 BROTLI_SUNPRO_VERSION_CHECK(5, 11, 0) || \
139 BROTLI_ARM_VERSION_CHECK(4, 1, 0) || \
140 BROTLI_IBM_VERSION_CHECK(10, 1, 0) || \
141 BROTLI_TI_VERSION_CHECK(8, 0, 0) || \
142 (BROTLI_TI_VERSION_CHECK(7, 3, 0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__))
143 #define BROTLI_NOINLINE __attribute__((__noinline__))
144 #elif BROTLI_MSVC_VERSION_CHECK(13, 10, 0)
145 #define BROTLI_NOINLINE __declspec(noinline)
146 #elif BROTLI_PGI_VERSION_CHECK(10, 2, 0)
147 #define BROTLI_NOINLINE _Pragma("noinline")
148 #elif BROTLI_TI_VERSION_CHECK(6, 0, 0) && defined(__cplusplus)
149 #define BROTLI_NOINLINE _Pragma("FUNC_CANNOT_INLINE;")
150 #elif BROTLI_IAR_VERSION_CHECK(8, 0, 0)
151 #define BROTLI_NOINLINE _Pragma("inline=never")
152 #else
153 #define BROTLI_NOINLINE
154 #endif
155
156 /* BROTLI_INTERNAL could be defined to override visibility, e.g. for tests. */
157 #if !defined(BROTLI_INTERNAL)
158 #if defined(_WIN32) || defined(__CYGWIN__)
159 #define BROTLI_INTERNAL
160 #elif BROTLI_GNUC_VERSION_CHECK(3, 3, 0) || \
161 BROTLI_TI_VERSION_CHECK(8, 0, 0) || \
162 BROTLI_INTEL_VERSION_CHECK(16, 0, 0) || \
163 BROTLI_ARM_VERSION_CHECK(4, 1, 0) || \
164 BROTLI_IBM_VERSION_CHECK(13, 1, 0) || \
165 BROTLI_SUNPRO_VERSION_CHECK(5, 11, 0) || \
166 (BROTLI_TI_VERSION_CHECK(7, 3, 0) && \
167 defined(__TI_GNU_ATTRIBUTE_SUPPORT__) && defined(__TI_EABI__))
168 #define BROTLI_INTERNAL __attribute__ ((visibility ("hidden")))
169 #else
170 #define BROTLI_INTERNAL
171 #endif
172 #endif
173
174 /* <<< <<< <<< end of hedley macros. */
175
176 #if BROTLI_GNUC_HAS_ATTRIBUTE(unused, 2, 7, 0) || \
177 BROTLI_INTEL_VERSION_CHECK(16, 0, 0)
178 #define BROTLI_UNUSED_FUNCTION static BROTLI_INLINE __attribute__ ((unused))
179 #else
180 #define BROTLI_UNUSED_FUNCTION static BROTLI_INLINE
181 #endif
182
183 #if (defined(__ARM_ARCH) && (__ARM_ARCH == 7)) || \
184 (defined(M_ARM) && (M_ARM == 7))
185 #define BROTLI_TARGET_ARMV7
186 #endif /* ARMv7 */
187
188 #if (defined(__ARM_ARCH) && (__ARM_ARCH == 8)) || \
189 defined(__aarch64__) || defined(__ARM64_ARCH_8__)
190 #define BROTLI_TARGET_ARMV8_ANY
191
192 #if defined(__ARM_32BIT_STATE)
193 #define BROTLI_TARGET_ARMV8_32
194 #elif defined(__ARM_64BIT_STATE)
195 #define BROTLI_TARGET_ARMV8_64
196 #endif
197
198 #endif /* ARMv8 */
199
200 #if defined(__i386) || defined(_M_IX86)
201 #define BROTLI_TARGET_X86
202 #endif
203
204 #if defined(__x86_64__) || defined(_M_X64)
205 #define BROTLI_TARGET_X64
206 #endif
207
208 #if defined(__PPC64__)
209 #define BROTLI_TARGET_POWERPC64
210 #endif
211
212 #if defined(__riscv) && defined(__riscv_xlen) && __riscv_xlen == 64
213 #define BROTLI_TARGET_RISCV64
214 #endif
215
216 #if defined(BROTLI_BUILD_64_BIT)
217 #define BROTLI_64_BITS 1
218 #elif defined(BROTLI_BUILD_32_BIT)
219 #define BROTLI_64_BITS 0
220 #elif defined(BROTLI_TARGET_X64) || defined(BROTLI_TARGET_ARMV8_64) || \
221 defined(BROTLI_TARGET_POWERPC64) || defined(BROTLI_TARGET_RISCV64)
222 #define BROTLI_64_BITS 1
223 #else
224 #define BROTLI_64_BITS 0
225 #endif
226
227 #if (BROTLI_64_BITS)
228 #define brotli_reg_t uint64_t
229 #else
230 #define brotli_reg_t uint32_t
231 #endif
232
233 #if defined(BROTLI_BUILD_BIG_ENDIAN)
234 #define BROTLI_BIG_ENDIAN 1
235 #elif defined(BROTLI_BUILD_LITTLE_ENDIAN)
236 #define BROTLI_LITTLE_ENDIAN 1
237 #elif defined(BROTLI_BUILD_ENDIAN_NEUTRAL)
238 /* Just break elif chain. */
239 #elif defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__)
240 #define BROTLI_LITTLE_ENDIAN 1
241 #elif defined(_WIN32) || defined(BROTLI_TARGET_X64)
242 /* Win32 & x64 can currently always be assumed to be little endian */
243 #define BROTLI_LITTLE_ENDIAN 1
244 #elif defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
245 #define BROTLI_BIG_ENDIAN 1
246 #elif defined(BROTLI_X_BYTE_ORDER)
247 #if BROTLI_X_BYTE_ORDER == BROTLI_X_LITTLE_ENDIAN
248 #define BROTLI_LITTLE_ENDIAN 1
249 #elif BROTLI_X_BYTE_ORDER == BROTLI_X_BIG_ENDIAN
250 #define BROTLI_BIG_ENDIAN 1
251 #endif
252 #endif /* BROTLI_X_BYTE_ORDER */
253
254 #if !defined(BROTLI_LITTLE_ENDIAN)
255 #define BROTLI_LITTLE_ENDIAN 0
256 #endif
257
258 #if !defined(BROTLI_BIG_ENDIAN)
259 #define BROTLI_BIG_ENDIAN 0
260 #endif
261
262 #if defined(BROTLI_X_BYTE_ORDER)
263 #undef BROTLI_X_BYTE_ORDER
264 #undef BROTLI_X_LITTLE_ENDIAN
265 #undef BROTLI_X_BIG_ENDIAN
266 #endif
267
268 #if defined(BROTLI_BUILD_PORTABLE)
269 #define BROTLI_ALIGNED_READ (!!1)
270 #elif defined(BROTLI_TARGET_X86) || defined(BROTLI_TARGET_X64) || \
271 defined(BROTLI_TARGET_ARMV7) || defined(BROTLI_TARGET_ARMV8_ANY) || \
272 defined(BROTLI_TARGET_RISCV64)
273 /* Allow unaligned read only for white-listed CPUs. */
274 #define BROTLI_ALIGNED_READ (!!0)
275 #else
276 #define BROTLI_ALIGNED_READ (!!1)
277 #endif
278
279 #if BROTLI_ALIGNED_READ
280 /* Portable unaligned memory access: read / write values via memcpy. */
BrotliUnalignedRead16(const void * p)281 static BROTLI_INLINE uint16_t BrotliUnalignedRead16(const void* p) {
282 uint16_t t;
283 memcpy(&t, p, sizeof t);
284 return t;
285 }
BrotliUnalignedRead32(const void * p)286 static BROTLI_INLINE uint32_t BrotliUnalignedRead32(const void* p) {
287 uint32_t t;
288 memcpy(&t, p, sizeof t);
289 return t;
290 }
BrotliUnalignedRead64(const void * p)291 static BROTLI_INLINE uint64_t BrotliUnalignedRead64(const void* p) {
292 uint64_t t;
293 memcpy(&t, p, sizeof t);
294 return t;
295 }
BrotliUnalignedWrite64(void * p,uint64_t v)296 static BROTLI_INLINE void BrotliUnalignedWrite64(void* p, uint64_t v) {
297 memcpy(p, &v, sizeof v);
298 }
299 #else /* BROTLI_ALIGNED_READ */
300 /* Unaligned memory access is allowed: just cast pointer to requested type. */
301 #if defined(ADDRESS_SANITIZER) || defined(THREAD_SANITIZER) || \
302 defined(MEMORY_SANITIZER)
303 /* Consider we have an unaligned load/store of 4 bytes from address 0x...05.
304 AddressSanitizer will treat it as a 3-byte access to the range 05:07 and
305 will miss a bug if 08 is the first unaddressable byte.
306 ThreadSanitizer will also treat this as a 3-byte access to 05:07 and will
307 miss a race between this access and some other accesses to 08.
308 MemorySanitizer will correctly propagate the shadow on unaligned stores
309 and correctly report bugs on unaligned loads, but it may not properly
310 update and report the origin of the uninitialized memory.
311 For all three tools, replacing an unaligned access with a tool-specific
312 callback solves the problem. */
313 #if defined(__cplusplus)
314 extern "C" {
315 #endif /* __cplusplus */
316 uint16_t __sanitizer_unaligned_load16(const void* p);
317 uint32_t __sanitizer_unaligned_load32(const void* p);
318 uint64_t __sanitizer_unaligned_load64(const void* p);
319 void __sanitizer_unaligned_store64(void* p, uint64_t v);
320 #if defined(__cplusplus)
321 } /* extern "C" */
322 #endif /* __cplusplus */
323 #define BrotliUnalignedRead16 __sanitizer_unaligned_load16
324 #define BrotliUnalignedRead32 __sanitizer_unaligned_load32
325 #define BrotliUnalignedRead64 __sanitizer_unaligned_load64
326 #define BrotliUnalignedWrite64 __sanitizer_unaligned_store64
327 #else
BrotliUnalignedRead16(const void * p)328 static BROTLI_INLINE uint16_t BrotliUnalignedRead16(const void* p) {
329 return *(const uint16_t*)p;
330 }
BrotliUnalignedRead32(const void * p)331 static BROTLI_INLINE uint32_t BrotliUnalignedRead32(const void* p) {
332 return *(const uint32_t*)p;
333 }
334 #if (BROTLI_64_BITS)
BrotliUnalignedRead64(const void * p)335 static BROTLI_INLINE uint64_t BrotliUnalignedRead64(const void* p) {
336 return *(const uint64_t*)p;
337 }
BrotliUnalignedWrite64(void * p,uint64_t v)338 static BROTLI_INLINE void BrotliUnalignedWrite64(void* p, uint64_t v) {
339 *(uint64_t*)p = v;
340 }
341 #else /* BROTLI_64_BITS */
342 /* Avoid emitting LDRD / STRD, which require properly aligned address. */
343 /* If __attribute__(aligned) is available, use that. Otherwise, memcpy. */
344
345 #if BROTLI_GNUC_HAS_ATTRIBUTE(aligned, 2, 7, 0)
346 typedef __attribute__((aligned(1))) uint64_t brotli_unaligned_uint64_t;
347
BrotliUnalignedRead64(const void * p)348 static BROTLI_INLINE uint64_t BrotliUnalignedRead64(const void* p) {
349 return (uint64_t) ((brotli_unaligned_uint64_t*) p)[0];
350 }
BrotliUnalignedWrite64(void * p,uint64_t v)351 static BROTLI_INLINE void BrotliUnalignedWrite64(void* p, uint64_t v) {
352 brotli_unaligned_uint64_t* dwords = (brotli_unaligned_uint64_t*) p;
353 dwords[0] = (brotli_unaligned_uint64_t) v;
354 }
355 #else /* BROTLI_GNUC_HAS_ATTRIBUTE(aligned, 2, 7, 0) */
BrotliUnalignedRead64(const void * p)356 static BROTLI_INLINE uint64_t BrotliUnalignedRead64(const void* p) {
357 uint64_t v;
358 memcpy(&v, p, sizeof(uint64_t));
359 return v;
360 }
361
BrotliUnalignedWrite64(void * p,uint64_t v)362 static BROTLI_INLINE void BrotliUnalignedWrite64(void* p, uint64_t v) {
363 memcpy(p, &v, sizeof(uint64_t));
364 }
365 #endif /* BROTLI_GNUC_HAS_ATTRIBUTE(aligned, 2, 7, 0) */
366 #endif /* BROTLI_64_BITS */
367 #endif /* ASAN / TSAN / MSAN */
368 #endif /* BROTLI_ALIGNED_READ */
369
370 #if BROTLI_LITTLE_ENDIAN
371 /* Straight endianness. Just read / write values. */
372 #define BROTLI_UNALIGNED_LOAD16LE BrotliUnalignedRead16
373 #define BROTLI_UNALIGNED_LOAD32LE BrotliUnalignedRead32
374 #define BROTLI_UNALIGNED_LOAD64LE BrotliUnalignedRead64
375 #define BROTLI_UNALIGNED_STORE64LE BrotliUnalignedWrite64
376 #elif BROTLI_BIG_ENDIAN /* BROTLI_LITTLE_ENDIAN */
377 /* Explain compiler to byte-swap values. */
378 #define BROTLI_BSWAP16_(V) ((uint16_t)( \
379 (((V) & 0xFFU) << 8) | \
380 (((V) >> 8) & 0xFFU)))
BROTLI_UNALIGNED_LOAD16LE(const void * p)381 static BROTLI_INLINE uint16_t BROTLI_UNALIGNED_LOAD16LE(const void* p) {
382 uint16_t value = BrotliUnalignedRead16(p);
383 return BROTLI_BSWAP16_(value);
384 }
385 #define BROTLI_BSWAP32_(V) ( \
386 (((V) & 0xFFU) << 24) | (((V) & 0xFF00U) << 8) | \
387 (((V) >> 8) & 0xFF00U) | (((V) >> 24) & 0xFFU))
BROTLI_UNALIGNED_LOAD32LE(const void * p)388 static BROTLI_INLINE uint32_t BROTLI_UNALIGNED_LOAD32LE(const void* p) {
389 uint32_t value = BrotliUnalignedRead32(p);
390 return BROTLI_BSWAP32_(value);
391 }
392 #define BROTLI_BSWAP64_(V) ( \
393 (((V) & 0xFFU) << 56) | (((V) & 0xFF00U) << 40) | \
394 (((V) & 0xFF0000U) << 24) | (((V) & 0xFF000000U) << 8) | \
395 (((V) >> 8) & 0xFF000000U) | (((V) >> 24) & 0xFF0000U) | \
396 (((V) >> 40) & 0xFF00U) | (((V) >> 56) & 0xFFU))
BROTLI_UNALIGNED_LOAD64LE(const void * p)397 static BROTLI_INLINE uint64_t BROTLI_UNALIGNED_LOAD64LE(const void* p) {
398 uint64_t value = BrotliUnalignedRead64(p);
399 return BROTLI_BSWAP64_(value);
400 }
BROTLI_UNALIGNED_STORE64LE(void * p,uint64_t v)401 static BROTLI_INLINE void BROTLI_UNALIGNED_STORE64LE(void* p, uint64_t v) {
402 uint64_t value = BROTLI_BSWAP64_(v);
403 BrotliUnalignedWrite64(p, value);
404 }
405 #else /* BROTLI_LITTLE_ENDIAN */
406 /* Read / store values byte-wise; hopefully compiler will understand. */
BROTLI_UNALIGNED_LOAD16LE(const void * p)407 static BROTLI_INLINE uint16_t BROTLI_UNALIGNED_LOAD16LE(const void* p) {
408 const uint8_t* in = (const uint8_t*)p;
409 return (uint16_t)(in[0] | (in[1] << 8));
410 }
BROTLI_UNALIGNED_LOAD32LE(const void * p)411 static BROTLI_INLINE uint32_t BROTLI_UNALIGNED_LOAD32LE(const void* p) {
412 const uint8_t* in = (const uint8_t*)p;
413 uint32_t value = (uint32_t)(in[0]);
414 value |= (uint32_t)(in[1]) << 8;
415 value |= (uint32_t)(in[2]) << 16;
416 value |= (uint32_t)(in[3]) << 24;
417 return value;
418 }
BROTLI_UNALIGNED_LOAD64LE(const void * p)419 static BROTLI_INLINE uint64_t BROTLI_UNALIGNED_LOAD64LE(const void* p) {
420 const uint8_t* in = (const uint8_t*)p;
421 uint64_t value = (uint64_t)(in[0]);
422 value |= (uint64_t)(in[1]) << 8;
423 value |= (uint64_t)(in[2]) << 16;
424 value |= (uint64_t)(in[3]) << 24;
425 value |= (uint64_t)(in[4]) << 32;
426 value |= (uint64_t)(in[5]) << 40;
427 value |= (uint64_t)(in[6]) << 48;
428 value |= (uint64_t)(in[7]) << 56;
429 return value;
430 }
BROTLI_UNALIGNED_STORE64LE(void * p,uint64_t v)431 static BROTLI_INLINE void BROTLI_UNALIGNED_STORE64LE(void* p, uint64_t v) {
432 uint8_t* out = (uint8_t*)p;
433 out[0] = (uint8_t)v;
434 out[1] = (uint8_t)(v >> 8);
435 out[2] = (uint8_t)(v >> 16);
436 out[3] = (uint8_t)(v >> 24);
437 out[4] = (uint8_t)(v >> 32);
438 out[5] = (uint8_t)(v >> 40);
439 out[6] = (uint8_t)(v >> 48);
440 out[7] = (uint8_t)(v >> 56);
441 }
442 #endif /* BROTLI_LITTLE_ENDIAN */
443
444 /* BROTLI_IS_CONSTANT macros returns true for compile-time constants. */
445 #if BROTLI_GNUC_HAS_BUILTIN(__builtin_constant_p, 3, 0, 1) || \
446 BROTLI_INTEL_VERSION_CHECK(16, 0, 0)
447 #define BROTLI_IS_CONSTANT(x) (!!__builtin_constant_p(x))
448 #else
449 #define BROTLI_IS_CONSTANT(x) (!!0)
450 #endif
451
452 #if defined(BROTLI_TARGET_ARMV7) || defined(BROTLI_TARGET_ARMV8_ANY)
453 #define BROTLI_HAS_UBFX (!!1)
454 #else
455 #define BROTLI_HAS_UBFX (!!0)
456 #endif
457
458 #if defined(BROTLI_ENABLE_LOG)
459 #define BROTLI_DCHECK(x) assert(x)
460 #define BROTLI_LOG(x) printf x
461 #else
462 #define BROTLI_DCHECK(x)
463 #define BROTLI_LOG(x)
464 #endif
465
466 #if defined(BROTLI_DEBUG) || defined(BROTLI_ENABLE_LOG)
BrotliDump(const char * f,int l,const char * fn)467 static BROTLI_INLINE void BrotliDump(const char* f, int l, const char* fn) {
468 fprintf(stderr, "%s:%d (%s)\n", f, l, fn);
469 fflush(stderr);
470 }
471 #define BROTLI_DUMP() BrotliDump(__FILE__, __LINE__, __FUNCTION__)
472 #else
473 #define BROTLI_DUMP() (void)(0)
474 #endif
475
476 /* TODO: add appropriate icc/sunpro/arm/ibm/ti checks. */
477 #if (BROTLI_GNUC_VERSION_CHECK(3, 0, 0) || defined(__llvm__)) && \
478 !defined(BROTLI_BUILD_NO_RBIT)
479 #if defined(BROTLI_TARGET_ARMV7) || defined(BROTLI_TARGET_ARMV8_ANY)
480 /* TODO: detect ARMv6T2 and enable this code for it. */
BrotliRBit(brotli_reg_t input)481 static BROTLI_INLINE brotli_reg_t BrotliRBit(brotli_reg_t input) {
482 brotli_reg_t output;
483 __asm__("rbit %0, %1\n" : "=r"(output) : "r"(input));
484 return output;
485 }
486 #define BROTLI_RBIT(x) BrotliRBit(x)
487 #endif /* armv7 / armv8 */
488 #endif /* gcc || clang */
489 #if !defined(BROTLI_RBIT)
BrotliRBit(void)490 static BROTLI_INLINE void BrotliRBit(void) { /* Should break build if used. */ }
491 #endif /* BROTLI_RBIT */
492
493 #define BROTLI_REPEAT(N, X) { \
494 if ((N & 1) != 0) {X;} \
495 if ((N & 2) != 0) {X; X;} \
496 if ((N & 4) != 0) {X; X; X; X;} \
497 }
498
499 #define BROTLI_UNUSED(X) (void)(X)
500
501 #define BROTLI_MIN_MAX(T) \
502 static BROTLI_INLINE T brotli_min_ ## T (T a, T b) { return a < b ? a : b; } \
503 static BROTLI_INLINE T brotli_max_ ## T (T a, T b) { return a > b ? a : b; }
BROTLI_MIN_MAX(float)504 BROTLI_MIN_MAX(double) BROTLI_MIN_MAX(float) BROTLI_MIN_MAX(int)
505 BROTLI_MIN_MAX(size_t) BROTLI_MIN_MAX(uint32_t) BROTLI_MIN_MAX(uint8_t)
506 #undef BROTLI_MIN_MAX
507 #define BROTLI_MIN(T, A, B) (brotli_min_ ## T((A), (B)))
508 #define BROTLI_MAX(T, A, B) (brotli_max_ ## T((A), (B)))
509
510 #define BROTLI_SWAP(T, A, I, J) { \
511 T __brotli_swap_tmp = (A)[(I)]; \
512 (A)[(I)] = (A)[(J)]; \
513 (A)[(J)] = __brotli_swap_tmp; \
514 }
515
516 /* Default brotli_alloc_func */
517 static void* BrotliDefaultAllocFunc(void* opaque, size_t size) {
518 BROTLI_UNUSED(opaque);
519 return malloc(size);
520 }
521
522 /* Default brotli_free_func */
BrotliDefaultFreeFunc(void * opaque,void * address)523 static void BrotliDefaultFreeFunc(void* opaque, void* address) {
524 BROTLI_UNUSED(opaque);
525 free(address);
526 }
527
BrotliSuppressUnusedFunctions(void)528 BROTLI_UNUSED_FUNCTION void BrotliSuppressUnusedFunctions(void) {
529 BROTLI_UNUSED(&BrotliSuppressUnusedFunctions);
530 BROTLI_UNUSED(&BrotliUnalignedRead16);
531 BROTLI_UNUSED(&BrotliUnalignedRead32);
532 BROTLI_UNUSED(&BrotliUnalignedRead64);
533 BROTLI_UNUSED(&BrotliUnalignedWrite64);
534 BROTLI_UNUSED(&BROTLI_UNALIGNED_LOAD16LE);
535 BROTLI_UNUSED(&BROTLI_UNALIGNED_LOAD32LE);
536 BROTLI_UNUSED(&BROTLI_UNALIGNED_LOAD64LE);
537 BROTLI_UNUSED(&BROTLI_UNALIGNED_STORE64LE);
538 BROTLI_UNUSED(&BrotliRBit);
539 BROTLI_UNUSED(&brotli_min_double);
540 BROTLI_UNUSED(&brotli_max_double);
541 BROTLI_UNUSED(&brotli_min_float);
542 BROTLI_UNUSED(&brotli_max_float);
543 BROTLI_UNUSED(&brotli_min_int);
544 BROTLI_UNUSED(&brotli_max_int);
545 BROTLI_UNUSED(&brotli_min_size_t);
546 BROTLI_UNUSED(&brotli_max_size_t);
547 BROTLI_UNUSED(&brotli_min_uint32_t);
548 BROTLI_UNUSED(&brotli_max_uint32_t);
549 BROTLI_UNUSED(&brotli_min_uint8_t);
550 BROTLI_UNUSED(&brotli_max_uint8_t);
551 BROTLI_UNUSED(&BrotliDefaultAllocFunc);
552 BROTLI_UNUSED(&BrotliDefaultFreeFunc);
553 #if defined(BROTLI_DEBUG) || defined(BROTLI_ENABLE_LOG)
554 BROTLI_UNUSED(&BrotliDump);
555 #endif
556 }
557
558 #endif /* BROTLI_COMMON_PLATFORM_H_ */
559