ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libecb/ecb.h
(Generate patch)

Comparing libecb/ecb.h (file contents):
Revision 1.12 by root, Thu May 26 18:17:45 2011 UTC vs.
Revision 1.61 by root, Thu Aug 4 14:27:40 2011 UTC

1/* 1/*
2 * libecb 2 * libecb - http://software.schmorp.de/pkg/libecb
3 * 3 *
4 * Copyright (©) 2009-2011 Marc Alexander Lehmann 4 * Copyright (©) 2009-2011 Marc Alexander Lehmann <libecb@schmorp.de>
5 * Copyright (©) 2011 Emanuele Giaquinta 5 * Copyright (©) 2011 Emanuele Giaquinta
6 * All rights reserved. 6 * All rights reserved.
7 * 7 *
8 * Redistribution and use in source and binary forms, with or without modifica- 8 * Redistribution and use in source and binary forms, with or without modifica-
9 * tion, are permitted provided that the following conditions are met: 9 * tion, are permitted provided that the following conditions are met:
… …
28 */ 28 */
29 29
30#ifndef ECB_H 30#ifndef ECB_H
31#define ECB_H 31#define ECB_H
32 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
33#include <inttypes.h> 48 #include <inttypes.h>
49#endif
34 50
35/* many compilers define _GNUC_ to some versions but then only implement 51/* many compilers define _GNUC_ to some versions but then only implement
36 * what their idiot authors think are the "more important" extensions, 52 * what their idiot authors think are the "more important" extensions,
37 * causing enourmous grief for some better fake benchmark numbers or so. 53 * causing enormous grief in return for some better fake benchmark numbers.
54 * or so.
38 * we try to detect these and simply assume they are not gcc - if they have 55 * we try to detect these and simply assume they are not gcc - if they have
39 * an issue with that they should have done it right in the first place. 56 * an issue with that they should have done it right in the first place.
40 */ 57 */
41#if defined(__INTEL_COMPILER) || defined(__SUNPRO_C) || defined(__llvm__) 58#ifndef ECB_GCC_VERSION
59 #if !defined(__GNUC_MINOR__) || defined(__INTEL_COMPILER) || defined(__SUNPRO_C) || defined(__SUNPRO_CC) || defined(__llvm__) || defined(__clang__)
42# define ECB_GCC_VERSION(major,minor) 0 60 #define ECB_GCC_VERSION(major,minor) 0
43#else 61 #else
44# define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor))) 62 #define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
45#endif 63 #endif
64#endif
46 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 || ECB_NO_SMP
72 #define ECB_MEMORY_FENCE do { } while (0)
73 #define ECB_MEMORY_FENCE_ACQUIRE do { } while (0)
74 #define ECB_MEMORY_FENCE_RELEASE do { } while (0)
75#endif
76
77#ifndef ECB_MEMORY_FENCE
78 #if ECB_GCC_VERSION(2,5)
79 #if __x86
80 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory")
81 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE /* non-lock xchg might be enough */
82 #define ECB_MEMORY_FENCE_RELEASE do { } while (0) /* unlikely to change in future cpus */
83 #elif __amd64
84 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory")
85 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory")
86 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence") /* play safe - not needed in any current cpu */
87 #endif
88 #endif
89#endif
90
91#ifndef ECB_MEMORY_FENCE
92 #if ECB_GCC_VERSION(4,4) || defined(__INTEL_COMPILER)
93 #define ECB_MEMORY_FENCE __sync_synchronize ()
94 #define ECB_MEMORY_FENCE_ACQUIRE __sync_synchronize () /* ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); }) */
95 #define ECB_MEMORY_FENCE_RELEASE __sync_synchronize () /* ({ char dummy = 1; __sync_lock_release (&dummy ); }) */
96 #elif _MSC_VER >= 1400 /* VC++ 2005 */
97 #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
98 #define ECB_MEMORY_FENCE _ReadWriteBarrier ()
99 #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
100 #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
101 #elif defined(_WIN32)
102 #include <WinNT.h>
103 #define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */
104 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
105 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
106 #endif
107#endif
108
109#ifndef ECB_MEMORY_FENCE
110 /*
111 * if you get undefined symbol references to pthread_mutex_lock,
112 * or failure to find pthread.h, then you should implement
113 * the ECB_MEMORY_FENCE operations for your cpu/compiler
114 * OR provide pthread.h and link against the posix thread library
115 * of your system.
116 */
117 #include <pthread.h>
118 #define ECB_NEEDS_PTHREADS 1
119 #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1
120
121 static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER;
122 #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
123 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
124 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
125#endif
126
127/*****************************************************************************/
128
129#define ECB_C99 (__STDC_VERSION__ >= 199901L)
130
47#ifndef __cplusplus 131#if __cplusplus
48# if __STDC_VERSION__ >= 199901L 132 #define ecb_inline static inline
49# define ECB_INLINE inline 133#elif ECB_GCC_VERSION(2,5)
50typedef _Bool ecb_bool; 134 #define ecb_inline static __inline__
135#elif ECB_C99
136 #define ecb_inline static inline
51# else 137#else
52# define ECB_INLINE inline /* yeah! */ 138 #define ecb_inline static
139#endif
140
141#if ECB_GCC_VERSION(3,3)
142 #define ecb_restrict __restrict__
143#elif ECB_C99
144 #define ecb_restrict restrict
145#else
146 #define ecb_restrict
147#endif
148
53typedef int ecb_bool; 149typedef int ecb_bool;
54# endif
55#endif
56 150
57#define ECB_CONCAT_(a, b) a ## b 151#define ECB_CONCAT_(a, b) a ## b
58#define ECB_CONCAT(a, b) ECB_CONCAT_(a, b) 152#define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
59#define ECB_STRINGIFY_(a) # a 153#define ECB_STRINGIFY_(a) # a
60#define ECB_STRINGIFY(a) ECB_STRINGIFY_(a) 154#define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)
61 155
62#define ECB_HEADER_INLINE static ECB_INLINE 156#define ecb_function_ ecb_inline
63 157
64#if ECB_GCC_VERSION(3,1) 158#if ECB_GCC_VERSION(3,1)
65# define ecb_attribute(attrlist) __attribute__(attrlist) 159 #define ecb_attribute(attrlist) __attribute__(attrlist)
66# define ecb_is_constant(c) __builtin_constant_p (c) 160 #define ecb_is_constant(expr) __builtin_constant_p (expr)
67# define ecb_expect(expr,value) __builtin_expect ((expr),(value)) 161 #define ecb_expect(expr,value) __builtin_expect ((expr),(value))
68# define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 162 #define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
69#else 163#else
70# define ecb_attribute(attrlist) 164 #define ecb_attribute(attrlist)
71# define ecb_is_constant(c) 0 165 #define ecb_is_constant(expr) 0
72# define ecb_expect(expr,value) (expr) 166 #define ecb_expect(expr,value) (expr)
73# define ecb_prefetch(addr,rw,locality) 167 #define ecb_prefetch(addr,rw,locality)
74#endif 168#endif
75 169
76/* no emulation for ecb_decltype */ 170/* no emulation for ecb_decltype */
77#if ECB_GCC_VERSION(4,5) 171#if ECB_GCC_VERSION(4,5)
78# define ecb_decltype(x) __decltype(x) 172 #define ecb_decltype(x) __decltype(x)
79#elif ECB_GCC_VERSION(3,0) 173#elif ECB_GCC_VERSION(3,0)
80# define ecb_decltype(x) typeof(x) 174 #define ecb_decltype(x) __typeof(x)
81#endif 175#endif
82 176
83#define ecb_noinline ecb_attribute ((noinline)) 177#define ecb_noinline ecb_attribute ((__noinline__))
84#define ecb_noreturn ecb_attribute ((noreturn)) 178#define ecb_noreturn ecb_attribute ((__noreturn__))
85#define ecb_unused ecb_attribute ((unused)) 179#define ecb_unused ecb_attribute ((__unused__))
86#define ecb_const ecb_attribute ((const)) 180#define ecb_const ecb_attribute ((__const__))
87#define ecb_pure ecb_attribute ((pure)) 181#define ecb_pure ecb_attribute ((__pure__))
88#define ecb_hot ecb_attribute ((hot)) /* 4.3 */
89#define ecb_cold ecb_attribute ((cold)) /* 4.3 */
90 182
91#if ECB_GCC_VERSION(4,5) 183#if ECB_GCC_VERSION(4,3)
92# define ecb_unreachable() __builtin_unreachable () 184 #define ecb_artificial ecb_attribute ((__artificial__))
185 #define ecb_hot ecb_attribute ((__hot__))
186 #define ecb_cold ecb_attribute ((__cold__))
93#else 187#else
94/* this seems to work fine, but gcc always emits a warning for it :/ */ 188 #define ecb_artificial
95ECB_HEADER_INLINE void ecb_unreachable () ecb_attribute ((noreturn)); 189 #define ecb_hot
96ECB_HEADER_INLINE void ecb_unreachable () { } 190 #define ecb_cold
97#endif 191#endif
98 192
99/* put into ifs if you are very sure that the expression */ 193/* put around conditional expressions if you are very sure that the */
100/* is mostly true or mosty false. note that these return */ 194/* expression is mostly true or mostly false. note that these return */
101/* booleans, not the expression. */ 195/* booleans, not the expression. */
102#define ecb_unlikely(expr) ecb_expect (!!(expr), 0) 196#define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
197#define ecb_expect_true(expr) ecb_expect (!!(expr), 1)
198/* for compatibility to the rest of the world */
103#define ecb_likely(expr) ecb_expect (!!(expr), 1) 199#define ecb_likely(expr) ecb_expect_true (expr)
104 200#define ecb_unlikely(expr) ecb_expect_false (expr)
105/* try to tell the compiler that some condition is definitely true */
106#define ecb_assume(cond) do { if (!(cond)) unreachable (); } while (0)
107 201
108/* count trailing zero bits and count # of one bits */ 202/* count trailing zero bits and count # of one bits */
109#if ECB_GCC_VERSION(3,4) 203#if ECB_GCC_VERSION(3,4)
110ECB_HEADER_INLINE int ecb_ctz32 (uint32_t x) { return __builtin_ctz (x); } 204 /* we assume int == 32 bit, long == 32 or 64 bit and long long == 64 bit */
111ECB_HEADER_INLINE int ecb_popcount32 (uint32_t x) { return __builtin_popcount (x); } 205 #define ecb_ld32(x) (__builtin_clz (x) ^ 31)
206 #define ecb_ld64(x) (__builtin_clzll (x) ^ 63)
207 #define ecb_ctz32(x) __builtin_ctz (x)
208 #define ecb_ctz64(x) __builtin_ctzll (x)
209 #define ecb_popcount32(x) __builtin_popcount (x)
210 /* no popcountll */
112#else 211#else
113ECB_HEADER_INLINE 212 ecb_function_ int ecb_ctz32 (uint32_t x) ecb_const;
213 ecb_function_ int
114ecb_ctz32 (uint32_t x) ecb_const 214 ecb_ctz32 (uint32_t x)
215 {
216 int r = 0;
217
218 x &= ~x + 1; /* this isolates the lowest bit */
219
220#if ECB_branchless_on_i386
221 r += !!(x & 0xaaaaaaaa) << 0;
222 r += !!(x & 0xcccccccc) << 1;
223 r += !!(x & 0xf0f0f0f0) << 2;
224 r += !!(x & 0xff00ff00) << 3;
225 r += !!(x & 0xffff0000) << 4;
226#else
227 if (x & 0xaaaaaaaa) r += 1;
228 if (x & 0xcccccccc) r += 2;
229 if (x & 0xf0f0f0f0) r += 4;
230 if (x & 0xff00ff00) r += 8;
231 if (x & 0xffff0000) r += 16;
232#endif
233
234 return r;
235 }
236
237 ecb_function_ int ecb_ctz64 (uint64_t x) ecb_const;
238 ecb_function_ int
239 ecb_ctz64 (uint64_t x)
240 {
241 int shift = x & 0xffffffffU ? 0 : 32;
242 return ecb_ctz32 (x >> shift) + shift;
243 }
244
245 ecb_function_ int ecb_popcount32 (uint32_t x) ecb_const;
246 ecb_function_ int
247 ecb_popcount32 (uint32_t x)
248 {
249 x -= (x >> 1) & 0x55555555;
250 x = ((x >> 2) & 0x33333333) + (x & 0x33333333);
251 x = ((x >> 4) + x) & 0x0f0f0f0f;
252 x *= 0x01010101;
253
254 return x >> 24;
255 }
256
257 ecb_function_ int ecb_ld32 (uint32_t x) ecb_const;
258 ecb_function_ int ecb_ld32 (uint32_t x)
259 {
260 int r = 0;
261
262 if (x >> 16) { x >>= 16; r += 16; }
263 if (x >> 8) { x >>= 8; r += 8; }
264 if (x >> 4) { x >>= 4; r += 4; }
265 if (x >> 2) { x >>= 2; r += 2; }
266 if (x >> 1) { r += 1; }
267
268 return r;
269 }
270
271 ecb_function_ int ecb_ld64 (uint64_t x) ecb_const;
272 ecb_function_ int ecb_ld64 (uint64_t x)
273 {
274 int r = 0;
275
276 if (x >> 32) { x >>= 32; r += 32; }
277
278 return r + ecb_ld32 (x);
279 }
280#endif
281
282/* popcount64 is only available on 64 bit cpus as gcc builtin */
283/* so for this version we are lazy */
284ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
285ecb_function_ int
286ecb_popcount64 (uint64_t x)
115{ 287{
116 int r = 0; 288 return ecb_popcount32 (x) + ecb_popcount32 (x >> 32);
117
118 x &= -x; /* this isolates the lowest bit */
119
120 if (x & 0xaaaaaaaa) r += 1;
121 if (x & 0xcccccccc) r += 2;
122 if (x & 0xf0f0f0f0) r += 4;
123 if (x & 0xff00ff00) r += 8;
124 if (x & 0xffff0000) r += 16;
125
126 return r;
127} 289}
128 290
129ECB_HEADER_INLINE 291ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) ecb_const;
130ecb_popcount32 (uint32_t x) ecb_const 292ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) ecb_const;
131{ 293ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) ecb_const;
132 x -= (x >> 1) & 0x55555555; 294ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) ecb_const;
133 x = ((x >> 2) & 0x33333333) + (x & 0x33333333); 295ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
134 x = ((x >> 4) + x) & 0x0f0f0f0f; 296ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
135 x *= 0x01010101; 297ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) ecb_const;
298ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) ecb_const;
136 299
137 return x >> 24; 300ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) { return (x >> ( 8 - count)) | (x << count); }
138} 301ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) { return (x << ( 8 - count)) | (x >> count); }
139#endif 302ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) { return (x >> (16 - count)) | (x << count); }
303ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) { return (x << (16 - count)) | (x >> count); }
304ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) { return (x >> (32 - count)) | (x << count); }
305ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) { return (x << (32 - count)) | (x >> count); }
306ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) { return (x >> (64 - count)) | (x << count); }
307ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) { return (x << (64 - count)) | (x >> count); }
140 308
141ECB_HEADER_INLINE unsigned char 309#if ECB_GCC_VERSION(4,3)
310 #define ecb_bswap16(x) (__builtin_bswap32 (x) >> 16)
311 #define ecb_bswap32(x) __builtin_bswap32 (x)
312 #define ecb_bswap64(x) __builtin_bswap64 (x)
313#else
314 ecb_function_ uint16_t ecb_bswap16 (uint16_t x) ecb_const;
315 ecb_function_ uint16_t
316 ecb_bswap16 (uint16_t x)
317 {
318 return ecb_rotl16 (x, 8);
319 }
320
321 ecb_function_ uint32_t ecb_bswap32 (uint32_t x) ecb_const;
322 ecb_function_ uint32_t
323 ecb_bswap32 (uint32_t x)
324 {
325 return (((uint32_t)ecb_bswap16 (x)) << 16) | ecb_bswap16 (x >> 16);
326 }
327
328 ecb_function_ uint64_t ecb_bswap64 (uint64_t x) ecb_const;
329 ecb_function_ uint64_t
330 ecb_bswap64 (uint64_t x)
331 {
332 return (((uint64_t)ecb_bswap32 (x)) << 32) | ecb_bswap32 (x >> 32);
333 }
334#endif
335
336#if ECB_GCC_VERSION(4,5)
337 #define ecb_unreachable() __builtin_unreachable ()
338#else
339 /* this seems to work fine, but gcc always emits a warning for it :/ */
340 ecb_function_ void ecb_unreachable (void) ecb_noreturn;
341 ecb_function_ void ecb_unreachable (void) { }
342#endif
343
344/* try to tell the compiler that some condition is definitely true */
345#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
346
347ecb_function_ unsigned char ecb_byteorder_helper (void) ecb_const;
348ecb_function_ unsigned char
142ecb_byteorder_helper () ecb_const 349ecb_byteorder_helper (void)
143{ 350{
144 const uint32_t u = 0x11223344; 351 const uint32_t u = 0x11223344;
145 return *(unsigned char *)&u; 352 return *(unsigned char *)&u;
146} 353}
147 354
355ecb_function_ ecb_bool ecb_big_endian (void) ecb_const;
148ECB_HEADER_INLINE ecb_bool ecb_big_endian () ecb_const { return ecb_byteorder_helper () == 0x11; }; 356ecb_function_ ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
357ecb_function_ ecb_bool ecb_little_endian (void) ecb_const;
149ECB_HEADER_INLINE ecb_bool ecb_little_endian () ecb_const { return ecb_byteorder_helper () == 0x44; }; 358ecb_function_ ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
359
360#if ECB_GCC_VERSION(3,0) || ECB_C99
361 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
362#else
363 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
364#endif
150 365
151#if ecb_cplusplus_does_not_suck 366#if ecb_cplusplus_does_not_suck
152// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) 367 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
153template<typename T, int N> 368 template<typename T, int N>
154static inline int ecb_array_length (const T (&arr)[N]) 369 static inline int ecb_array_length (const T (&arr)[N])
155{ 370 {
156 return N; 371 return N;
157} 372 }
158#else 373#else
159#define ecb_array_length(name) (sizeof (name) / sizeof (name [0])) 374 #define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
160#endif 375#endif
161 376
162ECB_INLINE uint32_t
163ecb_rotr32 (uint32_t x, unsigned int count)
164{
165 return (x << (32 - count)) | (x >> count);
166}
167
168ECB_INLINE uint32_t
169ecb_rotl32 (uint32_t x, unsigned int count)
170{
171 return (x >> (32 - count)) | (x << count);
172}
173
174#if ECB_GCC_VERSION(4,3)
175ECB_GCC_VERSION uint32_t ecb_bswap32 (uint32_t x) { return __builtin_bswap32 (x); }
176#else
177ECB_GCC_VERSION uint32_t
178ecb_bswap32 (uint32_t x)
179{
180 return (x >> 24)
181 | ((x >> 8) & 0x0000ff00)
182 | ((x << 8) & 0x00ff0000)
183 | (x << 24);
184}
185#endif 377#endif
186 378
187#endif
188

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines