ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libecb/ecb.h
Revision: 1.86
Committed: Thu Apr 12 04:09:25 2012 UTC (12 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.85: +2 -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 #elif defined __mips__
104 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
105 #elif defined __alpha__
106 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mb" : : : "memory")
107 #endif
108 #endif
109 #endif
110
111 #ifndef ECB_MEMORY_FENCE
112 #if ECB_GCC_VERSION(4,4) || defined __INTEL_COMPILER || defined __clang__
113 #define ECB_MEMORY_FENCE __sync_synchronize ()
114 /*#define ECB_MEMORY_FENCE_ACQUIRE ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); }) */
115 /*#define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release (&dummy ); }) */
116 #elif _MSC_VER >= 1400 /* VC++ 2005 */
117 #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
118 #define ECB_MEMORY_FENCE _ReadWriteBarrier ()
119 #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
120 #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
121 #elif defined _WIN32
122 #include <WinNT.h>
123 #define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */
124 #elif __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
125 #include <mbarrier.h>
126 #define ECB_MEMORY_FENCE __machine_rw_barrier ()
127 #define ECB_MEMORY_FENCE_ACQUIRE __machine_r_barrier ()
128 #define ECB_MEMORY_FENCE_RELEASE __machine_w_barrier ()
129 #elif __xlC__
130 #define ECB_MEMORY_FENCE __sync ()
131 #endif
132 #endif
133
134 #ifndef ECB_MEMORY_FENCE
135 #if !ECB_AVOID_PTHREADS
136 /*
137 * if you get undefined symbol references to pthread_mutex_lock,
138 * or failure to find pthread.h, then you should implement
139 * the ECB_MEMORY_FENCE operations for your cpu/compiler
140 * OR provide pthread.h and link against the posix thread library
141 * of your system.
142 */
143 #include <pthread.h>
144 #define ECB_NEEDS_PTHREADS 1
145 #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1
146
147 static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER;
148 #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
149 #endif
150 #endif
151
152 #if !defined ECB_MEMORY_FENCE_ACQUIRE && defined ECB_MEMORY_FENCE
153 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
154 #endif
155
156 #if !defined ECB_MEMORY_FENCE_RELEASE && defined ECB_MEMORY_FENCE
157 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
158 #endif
159
160 /*****************************************************************************/
161
162 #define ECB_C99 (__STDC_VERSION__ >= 199901L)
163
164 #if __cplusplus
165 #define ecb_inline static inline
166 #elif ECB_GCC_VERSION(2,5)
167 #define ecb_inline static __inline__
168 #elif ECB_C99
169 #define ecb_inline static inline
170 #else
171 #define ecb_inline static
172 #endif
173
174 #if ECB_GCC_VERSION(3,3)
175 #define ecb_restrict __restrict__
176 #elif ECB_C99
177 #define ecb_restrict restrict
178 #else
179 #define ecb_restrict
180 #endif
181
182 typedef int ecb_bool;
183
184 #define ECB_CONCAT_(a, b) a ## b
185 #define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
186 #define ECB_STRINGIFY_(a) # a
187 #define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)
188
189 #define ecb_function_ ecb_inline
190
191 #if ECB_GCC_VERSION(3,1)
192 #define ecb_attribute(attrlist) __attribute__(attrlist)
193 #define ecb_is_constant(expr) __builtin_constant_p (expr)
194 #define ecb_expect(expr,value) __builtin_expect ((expr),(value))
195 #define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
196 #else
197 #define ecb_attribute(attrlist)
198 #define ecb_is_constant(expr) 0
199 #define ecb_expect(expr,value) (expr)
200 #define ecb_prefetch(addr,rw,locality)
201 #endif
202
203 /* no emulation for ecb_decltype */
204 #if ECB_GCC_VERSION(4,5)
205 #define ecb_decltype(x) __decltype(x)
206 #elif ECB_GCC_VERSION(3,0)
207 #define ecb_decltype(x) __typeof(x)
208 #endif
209
210 #define ecb_noinline ecb_attribute ((__noinline__))
211 #define ecb_noreturn ecb_attribute ((__noreturn__))
212 #define ecb_unused ecb_attribute ((__unused__))
213 #define ecb_const ecb_attribute ((__const__))
214 #define ecb_pure ecb_attribute ((__pure__))
215
216 #if ECB_GCC_VERSION(4,3)
217 #define ecb_artificial ecb_attribute ((__artificial__))
218 #define ecb_hot ecb_attribute ((__hot__))
219 #define ecb_cold ecb_attribute ((__cold__))
220 #else
221 #define ecb_artificial
222 #define ecb_hot
223 #define ecb_cold
224 #endif
225
226 /* put around conditional expressions if you are very sure that the */
227 /* expression is mostly true or mostly false. note that these return */
228 /* booleans, not the expression. */
229 #define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
230 #define ecb_expect_true(expr) ecb_expect (!!(expr), 1)
231 /* for compatibility to the rest of the world */
232 #define ecb_likely(expr) ecb_expect_true (expr)
233 #define ecb_unlikely(expr) ecb_expect_false (expr)
234
235 /* count trailing zero bits and count # of one bits */
236 #if ECB_GCC_VERSION(3,4)
237 /* we assume int == 32 bit, long == 32 or 64 bit and long long == 64 bit */
238 #define ecb_ld32(x) (__builtin_clz (x) ^ 31)
239 #define ecb_ld64(x) (__builtin_clzll (x) ^ 63)
240 #define ecb_ctz32(x) __builtin_ctz (x)
241 #define ecb_ctz64(x) __builtin_ctzll (x)
242 #define ecb_popcount32(x) __builtin_popcount (x)
243 /* no popcountll */
244 #else
245 ecb_function_ int ecb_ctz32 (uint32_t x) ecb_const;
246 ecb_function_ int
247 ecb_ctz32 (uint32_t x)
248 {
249 int r = 0;
250
251 x &= ~x + 1; /* this isolates the lowest bit */
252
253 #if ECB_branchless_on_i386
254 r += !!(x & 0xaaaaaaaa) << 0;
255 r += !!(x & 0xcccccccc) << 1;
256 r += !!(x & 0xf0f0f0f0) << 2;
257 r += !!(x & 0xff00ff00) << 3;
258 r += !!(x & 0xffff0000) << 4;
259 #else
260 if (x & 0xaaaaaaaa) r += 1;
261 if (x & 0xcccccccc) r += 2;
262 if (x & 0xf0f0f0f0) r += 4;
263 if (x & 0xff00ff00) r += 8;
264 if (x & 0xffff0000) r += 16;
265 #endif
266
267 return r;
268 }
269
270 ecb_function_ int ecb_ctz64 (uint64_t x) ecb_const;
271 ecb_function_ int
272 ecb_ctz64 (uint64_t x)
273 {
274 int shift = x & 0xffffffffU ? 0 : 32;
275 return ecb_ctz32 (x >> shift) + shift;
276 }
277
278 ecb_function_ int ecb_popcount32 (uint32_t x) ecb_const;
279 ecb_function_ int
280 ecb_popcount32 (uint32_t x)
281 {
282 x -= (x >> 1) & 0x55555555;
283 x = ((x >> 2) & 0x33333333) + (x & 0x33333333);
284 x = ((x >> 4) + x) & 0x0f0f0f0f;
285 x *= 0x01010101;
286
287 return x >> 24;
288 }
289
290 ecb_function_ int ecb_ld32 (uint32_t x) ecb_const;
291 ecb_function_ int ecb_ld32 (uint32_t x)
292 {
293 int r = 0;
294
295 if (x >> 16) { x >>= 16; r += 16; }
296 if (x >> 8) { x >>= 8; r += 8; }
297 if (x >> 4) { x >>= 4; r += 4; }
298 if (x >> 2) { x >>= 2; r += 2; }
299 if (x >> 1) { r += 1; }
300
301 return r;
302 }
303
304 ecb_function_ int ecb_ld64 (uint64_t x) ecb_const;
305 ecb_function_ int ecb_ld64 (uint64_t x)
306 {
307 int r = 0;
308
309 if (x >> 32) { x >>= 32; r += 32; }
310
311 return r + ecb_ld32 (x);
312 }
313 #endif
314
315 ecb_function_ uint8_t ecb_bitrev8 (uint8_t x) ecb_const;
316 ecb_function_ uint8_t ecb_bitrev8 (uint8_t x)
317 {
318 return ( (x * 0x0802U & 0x22110U)
319 | (x * 0x8020U & 0x88440U)) * 0x10101U >> 16;
320 }
321
322 ecb_function_ uint16_t ecb_bitrev16 (uint16_t x) ecb_const;
323 ecb_function_ uint16_t ecb_bitrev16 (uint16_t x)
324 {
325 x = ((x >> 1) & 0x5555) | ((x & 0x5555) << 1);
326 x = ((x >> 2) & 0x3333) | ((x & 0x3333) << 2);
327 x = ((x >> 4) & 0x0f0f) | ((x & 0x0f0f) << 4);
328 x = ( x >> 8 ) | ( x << 8);
329
330 return x;
331 }
332
333 ecb_function_ uint32_t ecb_bitrev32 (uint32_t x) ecb_const;
334 ecb_function_ uint32_t ecb_bitrev32 (uint32_t x)
335 {
336 x = ((x >> 1) & 0x55555555) | ((x & 0x55555555) << 1);
337 x = ((x >> 2) & 0x33333333) | ((x & 0x33333333) << 2);
338 x = ((x >> 4) & 0x0f0f0f0f) | ((x & 0x0f0f0f0f) << 4);
339 x = ((x >> 8) & 0x00ff00ff) | ((x & 0x00ff00ff) << 8);
340 x = ( x >> 16 ) | ( x << 16);
341
342 return x;
343 }
344
345 /* popcount64 is only available on 64 bit cpus as gcc builtin */
346 /* so for this version we are lazy */
347 ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
348 ecb_function_ int
349 ecb_popcount64 (uint64_t x)
350 {
351 return ecb_popcount32 (x) + ecb_popcount32 (x >> 32);
352 }
353
354 ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) ecb_const;
355 ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) ecb_const;
356 ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) ecb_const;
357 ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) ecb_const;
358 ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
359 ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
360 ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) ecb_const;
361 ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) ecb_const;
362
363 ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) { return (x >> ( 8 - count)) | (x << count); }
364 ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) { return (x << ( 8 - count)) | (x >> count); }
365 ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) { return (x >> (16 - count)) | (x << count); }
366 ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) { return (x << (16 - count)) | (x >> count); }
367 ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) { return (x >> (32 - count)) | (x << count); }
368 ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) { return (x << (32 - count)) | (x >> count); }
369 ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) { return (x >> (64 - count)) | (x << count); }
370 ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) { return (x << (64 - count)) | (x >> count); }
371
372 #if ECB_GCC_VERSION(4,3)
373 #define ecb_bswap16(x) (__builtin_bswap32 (x) >> 16)
374 #define ecb_bswap32(x) __builtin_bswap32 (x)
375 #define ecb_bswap64(x) __builtin_bswap64 (x)
376 #else
377 ecb_function_ uint16_t ecb_bswap16 (uint16_t x) ecb_const;
378 ecb_function_ uint16_t
379 ecb_bswap16 (uint16_t x)
380 {
381 return ecb_rotl16 (x, 8);
382 }
383
384 ecb_function_ uint32_t ecb_bswap32 (uint32_t x) ecb_const;
385 ecb_function_ uint32_t
386 ecb_bswap32 (uint32_t x)
387 {
388 return (((uint32_t)ecb_bswap16 (x)) << 16) | ecb_bswap16 (x >> 16);
389 }
390
391 ecb_function_ uint64_t ecb_bswap64 (uint64_t x) ecb_const;
392 ecb_function_ uint64_t
393 ecb_bswap64 (uint64_t x)
394 {
395 return (((uint64_t)ecb_bswap32 (x)) << 32) | ecb_bswap32 (x >> 32);
396 }
397 #endif
398
399 #if ECB_GCC_VERSION(4,5)
400 #define ecb_unreachable() __builtin_unreachable ()
401 #else
402 /* this seems to work fine, but gcc always emits a warning for it :/ */
403 ecb_inline void ecb_unreachable (void) ecb_noreturn;
404 ecb_inline void ecb_unreachable (void) { }
405 #endif
406
407 /* try to tell the compiler that some condition is definitely true */
408 #define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
409
410 ecb_inline unsigned char ecb_byteorder_helper (void) ecb_const;
411 ecb_inline unsigned char
412 ecb_byteorder_helper (void)
413 {
414 const uint32_t u = 0x11223344;
415 return *(unsigned char *)&u;
416 }
417
418 ecb_inline ecb_bool ecb_big_endian (void) ecb_const;
419 ecb_inline ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
420 ecb_inline ecb_bool ecb_little_endian (void) ecb_const;
421 ecb_inline ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
422
423 #if ECB_GCC_VERSION(3,0) || ECB_C99
424 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
425 #else
426 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
427 #endif
428
429 #if __cplusplus
430 template<typename T>
431 static inline T ecb_div_rd (T val, T div)
432 {
433 return val < 0 ? - ((-val + div - 1) / div) : (val ) / div;
434 }
435 template<typename T>
436 static inline T ecb_div_ru (T val, T div)
437 {
438 return val < 0 ? - ((-val ) / div) : (val + div - 1) / div;
439 }
440 #else
441 #define ecb_div_rd(val,div) ((val) < 0 ? - ((-(val) + (div) - 1) / (div)) : ((val) ) / (div))
442 #define ecb_div_ru(val,div) ((val) < 0 ? - ((-(val) ) / (div)) : ((val) + (div) - 1) / (div))
443 #endif
444
445 #if ecb_cplusplus_does_not_suck
446 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
447 template<typename T, int N>
448 static inline int ecb_array_length (const T (&arr)[N])
449 {
450 return N;
451 }
452 #else
453 #define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
454 #endif
455
456 #endif
457