ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libecb/ecb.h
Revision: 1.79
Committed: Sat Feb 4 17:57:47 2012 UTC (12 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.78: +4 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 /*
2 * libecb - http://software.schmorp.de/pkg/libecb
3 *
4 * Copyright (©) 2009-2012 Marc Alexander Lehmann <libecb@schmorp.de>
5 * Copyright (©) 2011 Emanuele Giaquinta
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without modifica-
9 * tion, are permitted provided that the following conditions are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
20 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
22 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
26 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 * OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifndef ECB_H
31 #define ECB_H
32
33 #ifdef _WIN32
34 typedef signed char int8_t;
35 typedef unsigned char uint8_t;
36 typedef signed short int16_t;
37 typedef unsigned short uint16_t;
38 typedef signed int int32_t;
39 typedef unsigned int uint32_t;
40 #if __GNUC__
41 typedef signed long long int64_t;
42 typedef unsigned long long uint64_t;
43 #else /* _MSC_VER || __BORLANDC__ */
44 typedef signed __int64 int64_t;
45 typedef unsigned __int64 uint64_t;
46 #endif
47 #else
48 #include <inttypes.h>
49 #endif
50
51 /* many compilers define _GNUC_ to some versions but then only implement
52 * what their idiot authors think are the "more important" extensions,
53 * causing enormous grief in return for some better fake benchmark numbers.
54 * or so.
55 * we try to detect these and simply assume they are not gcc - if they have
56 * an issue with that they should have done it right in the first place.
57 */
58 #ifndef ECB_GCC_VERSION
59 #if !defined(__GNUC_MINOR__) || defined(__INTEL_COMPILER) || defined(__SUNPRO_C) || defined(__SUNPRO_CC) || defined(__llvm__) || defined(__clang__)
60 #define ECB_GCC_VERSION(major,minor) 0
61 #else
62 #define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
63 #endif
64 #endif
65
66 /*****************************************************************************/
67
68 /* ECB_NO_THREADS - ecb is not used by multiple threads, ever */
69 /* ECB_NO_SMP - ecb might be used in multiple threads, but only on a single cpu */
70
71 #if ECB_NO_THREADS
72 # define ECB_NO_SMP 1
73 #endif
74
75 #if ECB_NO_THREADS || ECB_NO_SMP
76 #define ECB_MEMORY_FENCE do { } while (0)
77 #endif
78
79 #ifndef ECB_MEMORY_FENCE
80 #if ECB_GCC_VERSION(2,5) || defined(__INTEL_COMPILER) || (__llvm__ && __GNUC__) || __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
81 #if __i386 || __i386__
82 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory")
83 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE /* non-lock xchg might be enough */
84 #define ECB_MEMORY_FENCE_RELEASE do { } while (0) /* unlikely to change in future cpus */
85 #elif __amd64 || __amd64__ || __x86_64 || __x86_64__
86 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory")
87 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory")
88 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence") /* play safe - not needed in any current cpu */
89 #elif __powerpc__ || __ppc__ || __powerpc64__ || __ppc64__
90 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
91 #elif defined(__ARM_ARCH_6__ ) || defined(__ARM_ARCH_6J__ ) \
92 || defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6ZK__)
93 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mcr p15,0,%0,c7,c10,5" : : "r" (0) : "memory")
94 #elif defined(__ARM_ARCH_7__ ) || defined(__ARM_ARCH_7A__ ) \
95 || defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7R__ )
96 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("dmb" : : : "memory")
97 #elif __sparc || __sparc__
98 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad | #StoreStore | #StoreLoad | " : : : "memory")
99 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad" : : : "memory")
100 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("membar #LoadStore | #StoreStore")
101 #elif defined(__s390__) || defined(__s390x__)
102 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("bcr 15,0" : : : "memory")
103 #endif
104 #endif
105 #endif
106
107 #ifndef ECB_MEMORY_FENCE
108 #if ECB_GCC_VERSION(4,4) || defined(__INTEL_COMPILER) || defined(__clang__)
109 #define ECB_MEMORY_FENCE __sync_synchronize ()
110 /*#define ECB_MEMORY_FENCE_ACQUIRE ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); }) */
111 /*#define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release (&dummy ); }) */
112 #elif _MSC_VER >= 1400 /* VC++ 2005 */
113 #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
114 #define ECB_MEMORY_FENCE _ReadWriteBarrier ()
115 #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
116 #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
117 #elif defined(_WIN32)
118 #include <WinNT.h>
119 #define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */
120 #elif __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
121 #include <mbarrier.h>
122 #define ECB_MEMORY_FENCE __machine_rw_barrier ()
123 #define ECB_MEMORY_FENCE_ACQUIRE __machine_r_barrier ()
124 #define ECB_MEMORY_FENCE_RELEASE __machine_w_barrier ()
125 #endif
126 #endif
127
128 #ifndef ECB_MEMORY_FENCE
129 #if !ECB_AVOID_PTHREADS
130 /*
131 * if you get undefined symbol references to pthread_mutex_lock,
132 * or failure to find pthread.h, then you should implement
133 * the ECB_MEMORY_FENCE operations for your cpu/compiler
134 * OR provide pthread.h and link against the posix thread library
135 * of your system.
136 */
137 #include <pthread.h>
138 #define ECB_NEEDS_PTHREADS 1
139 #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1
140
141 static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER;
142 #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
143 #endif
144 #endif
145
146 #if !defined(ECB_MEMORY_FENCE_ACQUIRE) && defined(ECB_MEMORY_FENCE)
147 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
148 #endif
149
150 #if !defined(ECB_MEMORY_FENCE_RELEASE) && defined(ECB_MEMORY_FENCE)
151 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
152 #endif
153
154 /*****************************************************************************/
155
156 #define ECB_C99 (__STDC_VERSION__ >= 199901L)
157
158 #if __cplusplus
159 #define ecb_inline static inline
160 #elif ECB_GCC_VERSION(2,5)
161 #define ecb_inline static __inline__
162 #elif ECB_C99
163 #define ecb_inline static inline
164 #else
165 #define ecb_inline static
166 #endif
167
168 #if ECB_GCC_VERSION(3,3)
169 #define ecb_restrict __restrict__
170 #elif ECB_C99
171 #define ecb_restrict restrict
172 #else
173 #define ecb_restrict
174 #endif
175
176 typedef int ecb_bool;
177
178 #define ECB_CONCAT_(a, b) a ## b
179 #define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
180 #define ECB_STRINGIFY_(a) # a
181 #define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)
182
183 #define ecb_function_ ecb_inline
184
185 #if ECB_GCC_VERSION(3,1)
186 #define ecb_attribute(attrlist) __attribute__(attrlist)
187 #define ecb_is_constant(expr) __builtin_constant_p (expr)
188 #define ecb_expect(expr,value) __builtin_expect ((expr),(value))
189 #define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
190 #else
191 #define ecb_attribute(attrlist)
192 #define ecb_is_constant(expr) 0
193 #define ecb_expect(expr,value) (expr)
194 #define ecb_prefetch(addr,rw,locality)
195 #endif
196
197 /* no emulation for ecb_decltype */
198 #if ECB_GCC_VERSION(4,5)
199 #define ecb_decltype(x) __decltype(x)
200 #elif ECB_GCC_VERSION(3,0)
201 #define ecb_decltype(x) __typeof(x)
202 #endif
203
204 #define ecb_noinline ecb_attribute ((__noinline__))
205 #define ecb_noreturn ecb_attribute ((__noreturn__))
206 #define ecb_unused ecb_attribute ((__unused__))
207 #define ecb_const ecb_attribute ((__const__))
208 #define ecb_pure ecb_attribute ((__pure__))
209
210 #if ECB_GCC_VERSION(4,3)
211 #define ecb_artificial ecb_attribute ((__artificial__))
212 #define ecb_hot ecb_attribute ((__hot__))
213 #define ecb_cold ecb_attribute ((__cold__))
214 #else
215 #define ecb_artificial
216 #define ecb_hot
217 #define ecb_cold
218 #endif
219
220 /* put around conditional expressions if you are very sure that the */
221 /* expression is mostly true or mostly false. note that these return */
222 /* booleans, not the expression. */
223 #define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
224 #define ecb_expect_true(expr) ecb_expect (!!(expr), 1)
225 /* for compatibility to the rest of the world */
226 #define ecb_likely(expr) ecb_expect_true (expr)
227 #define ecb_unlikely(expr) ecb_expect_false (expr)
228
229 /* count trailing zero bits and count # of one bits */
230 #if ECB_GCC_VERSION(3,4)
231 /* we assume int == 32 bit, long == 32 or 64 bit and long long == 64 bit */
232 #define ecb_ld32(x) (__builtin_clz (x) ^ 31)
233 #define ecb_ld64(x) (__builtin_clzll (x) ^ 63)
234 #define ecb_ctz32(x) __builtin_ctz (x)
235 #define ecb_ctz64(x) __builtin_ctzll (x)
236 #define ecb_popcount32(x) __builtin_popcount (x)
237 /* no popcountll */
238 #else
239 ecb_function_ int ecb_ctz32 (uint32_t x) ecb_const;
240 ecb_function_ int
241 ecb_ctz32 (uint32_t x)
242 {
243 int r = 0;
244
245 x &= ~x + 1; /* this isolates the lowest bit */
246
247 #if ECB_branchless_on_i386
248 r += !!(x & 0xaaaaaaaa) << 0;
249 r += !!(x & 0xcccccccc) << 1;
250 r += !!(x & 0xf0f0f0f0) << 2;
251 r += !!(x & 0xff00ff00) << 3;
252 r += !!(x & 0xffff0000) << 4;
253 #else
254 if (x & 0xaaaaaaaa) r += 1;
255 if (x & 0xcccccccc) r += 2;
256 if (x & 0xf0f0f0f0) r += 4;
257 if (x & 0xff00ff00) r += 8;
258 if (x & 0xffff0000) r += 16;
259 #endif
260
261 return r;
262 }
263
264 ecb_function_ int ecb_ctz64 (uint64_t x) ecb_const;
265 ecb_function_ int
266 ecb_ctz64 (uint64_t x)
267 {
268 int shift = x & 0xffffffffU ? 0 : 32;
269 return ecb_ctz32 (x >> shift) + shift;
270 }
271
272 ecb_function_ int ecb_popcount32 (uint32_t x) ecb_const;
273 ecb_function_ int
274 ecb_popcount32 (uint32_t x)
275 {
276 x -= (x >> 1) & 0x55555555;
277 x = ((x >> 2) & 0x33333333) + (x & 0x33333333);
278 x = ((x >> 4) + x) & 0x0f0f0f0f;
279 x *= 0x01010101;
280
281 return x >> 24;
282 }
283
284 ecb_function_ int ecb_ld32 (uint32_t x) ecb_const;
285 ecb_function_ int ecb_ld32 (uint32_t x)
286 {
287 int r = 0;
288
289 if (x >> 16) { x >>= 16; r += 16; }
290 if (x >> 8) { x >>= 8; r += 8; }
291 if (x >> 4) { x >>= 4; r += 4; }
292 if (x >> 2) { x >>= 2; r += 2; }
293 if (x >> 1) { r += 1; }
294
295 return r;
296 }
297
298 ecb_function_ int ecb_ld64 (uint64_t x) ecb_const;
299 ecb_function_ int ecb_ld64 (uint64_t x)
300 {
301 int r = 0;
302
303 if (x >> 32) { x >>= 32; r += 32; }
304
305 return r + ecb_ld32 (x);
306 }
307 #endif
308
309 ecb_function_ uint8_t ecb_bitrev8 (uint8_t x) ecb_const;
310 ecb_function_ uint8_t ecb_bitrev8 (uint8_t x)
311 {
312 return ( (x * 0x0802U & 0x22110U)
313 | (x * 0x8020U & 0x88440U)) * 0x10101U >> 16;
314 }
315
316 ecb_function_ uint16_t ecb_bitrev16 (uint16_t x) ecb_const;
317 ecb_function_ uint16_t ecb_bitrev16 (uint16_t x)
318 {
319 x = ((x >> 1) & 0x5555) | ((x & 0x5555) << 1);
320 x = ((x >> 2) & 0x3333) | ((x & 0x3333) << 2);
321 x = ((x >> 4) & 0x0f0f) | ((x & 0x0f0f) << 4);
322 x = ( x >> 8 ) | ( x << 8);
323
324 return x;
325 }
326
327 ecb_function_ uint32_t ecb_bitrev32 (uint32_t x) ecb_const;
328 ecb_function_ uint32_t ecb_bitrev32 (uint32_t x)
329 {
330 x = ((x >> 1) & 0x55555555) | ((x & 0x55555555) << 1);
331 x = ((x >> 2) & 0x33333333) | ((x & 0x33333333) << 2);
332 x = ((x >> 4) & 0x0f0f0f0f) | ((x & 0x0f0f0f0f) << 4);
333 x = ((x >> 8) & 0x00ff00ff) | ((x & 0x00ff00ff) << 8);
334 x = ( x >> 16 ) | ( x << 16);
335
336 return x;
337 }
338
339 /* popcount64 is only available on 64 bit cpus as gcc builtin */
340 /* so for this version we are lazy */
341 ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
342 ecb_function_ int
343 ecb_popcount64 (uint64_t x)
344 {
345 return ecb_popcount32 (x) + ecb_popcount32 (x >> 32);
346 }
347
348 ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) ecb_const;
349 ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) ecb_const;
350 ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) ecb_const;
351 ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) ecb_const;
352 ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
353 ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
354 ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) ecb_const;
355 ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) ecb_const;
356
357 ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) { return (x >> ( 8 - count)) | (x << count); }
358 ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) { return (x << ( 8 - count)) | (x >> count); }
359 ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) { return (x >> (16 - count)) | (x << count); }
360 ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) { return (x << (16 - count)) | (x >> count); }
361 ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) { return (x >> (32 - count)) | (x << count); }
362 ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) { return (x << (32 - count)) | (x >> count); }
363 ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) { return (x >> (64 - count)) | (x << count); }
364 ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) { return (x << (64 - count)) | (x >> count); }
365
366 #if ECB_GCC_VERSION(4,3)
367 #define ecb_bswap16(x) (__builtin_bswap32 (x) >> 16)
368 #define ecb_bswap32(x) __builtin_bswap32 (x)
369 #define ecb_bswap64(x) __builtin_bswap64 (x)
370 #else
371 ecb_function_ uint16_t ecb_bswap16 (uint16_t x) ecb_const;
372 ecb_function_ uint16_t
373 ecb_bswap16 (uint16_t x)
374 {
375 return ecb_rotl16 (x, 8);
376 }
377
378 ecb_function_ uint32_t ecb_bswap32 (uint32_t x) ecb_const;
379 ecb_function_ uint32_t
380 ecb_bswap32 (uint32_t x)
381 {
382 return (((uint32_t)ecb_bswap16 (x)) << 16) | ecb_bswap16 (x >> 16);
383 }
384
385 ecb_function_ uint64_t ecb_bswap64 (uint64_t x) ecb_const;
386 ecb_function_ uint64_t
387 ecb_bswap64 (uint64_t x)
388 {
389 return (((uint64_t)ecb_bswap32 (x)) << 32) | ecb_bswap32 (x >> 32);
390 }
391 #endif
392
393 #if ECB_GCC_VERSION(4,5)
394 #define ecb_unreachable() __builtin_unreachable ()
395 #else
396 /* this seems to work fine, but gcc always emits a warning for it :/ */
397 ecb_inline void ecb_unreachable (void) ecb_noreturn;
398 ecb_inline void ecb_unreachable (void) { }
399 #endif
400
401 /* try to tell the compiler that some condition is definitely true */
402 #define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
403
404 ecb_inline unsigned char ecb_byteorder_helper (void) ecb_const;
405 ecb_inline unsigned char
406 ecb_byteorder_helper (void)
407 {
408 const uint32_t u = 0x11223344;
409 return *(unsigned char *)&u;
410 }
411
412 ecb_inline ecb_bool ecb_big_endian (void) ecb_const;
413 ecb_inline ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
414 ecb_inline ecb_bool ecb_little_endian (void) ecb_const;
415 ecb_inline ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
416
417 #if ECB_GCC_VERSION(3,0) || ECB_C99
418 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
419 #else
420 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
421 #endif
422
423 #if __cplusplus
424 template<typename T>
425 static inline T ecb_div_rd (T val, T div)
426 {
427 return val < 0 ? - ((-val + div - 1) / div) : (val ) / div;
428 }
429 template<typename T>
430 static inline T ecb_div_ru (T val, T div)
431 {
432 return val < 0 ? - ((-val ) / div) : (val + div - 1) / div;
433 }
434 #else
435 #define ecb_div_rd(val,div) ((val) < 0 ? - ((-(val) + (div) - 1) / (div)) : ((val) ) / (div))
436 #define ecb_div_ru(val,div) ((val) < 0 ? - ((-(val) ) / (div)) : ((val) + (div) - 1) / (div))
437 #endif
438
439 #if ecb_cplusplus_does_not_suck
440 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
441 template<typename T, int N>
442 static inline int ecb_array_length (const T (&arr)[N])
443 {
444 return N;
445 }
446 #else
447 #define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
448 #endif
449
450 #endif
451