ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libecb/ecb.h
Revision: 1.56
Committed: Thu Jul 28 13:45:44 2011 UTC (12 years, 10 months ago) by sf-exg
Content type: text/plain
Branch: MAIN
Changes since 1.55: +0 -3 lines
Log Message:
Remove obsolete comment.

File Contents

# User Rev Content
1 root 1.1 /*
2 root 1.17 * libecb - http://software.schmorp.de/pkg/libecb
3 root 1.1 *
4 root 1.30 * Copyright (©) 2009-2011 Marc Alexander Lehmann <libecb@schmorp.de>
5 root 1.7 * Copyright (©) 2011 Emanuele Giaquinta
6 root 1.1 * 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 root 1.44 #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 root 1.51 #else /* _MSC_VER || __BORLANDC__ */
44 root 1.44 typedef signed __int64 int64_t;
45     typedef unsigned __int64 uint64_t;
46     #endif
47     #else
48     #include <inttypes.h>
49     #endif
50 root 1.6
51 root 1.12 /* many compilers define _GNUC_ to some versions but then only implement
52     * what their idiot authors think are the "more important" extensions,
53 root 1.18 * causing enourmous grief in return for some better fake benchmark numbers.
54     * or so.
55 root 1.12 * 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 root 1.14 #ifndef ECB_GCC_VERSION
59 root 1.47 #if !defined(__GNUC_MINOR__) || defined(__INTEL_COMPILER) || defined(__SUNPRO_C) || defined(__SUNPRO_CC) || defined(__llvm__) || defined(__clang__)
60 root 1.37 #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 root 1.12 #endif
65 root 1.1
66 root 1.52 /*****************************************************************************/
67    
68     #ifndef ECB_MEMORY_FENCE
69     #if ECB_GCC_VERSION(2,5)
70     #if __x86
71 root 1.54 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory")
72 root 1.52 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
73 root 1.53 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE /* better be safe than sorry */
74 root 1.52 #elif __amd64
75     #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory")
76     #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory")
77     #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence")
78     #endif
79     #endif
80     #endif
81    
82     #ifndef ECB_MEMORY_FENCE
83     #if ECB_GCC_VERSION(4,4)
84     #define ECB_MEMORY_FENCE __sync_synchronize ()
85     #define ECB_MEMORY_FENCE_ACQUIRE ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); })
86     #define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release (&dummy ); })
87 root 1.55 #elif _MSC_VER >= 1400 && 0 /* TODO: only true when using volatiles */
88 root 1.52 #define ECB_MEMORY_FENCE do { } while (0)
89     #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
90     #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
91 root 1.55 #elif defined(_WIN32)
92     #include <WinNT.h>
93 root 1.52 #define ECB_MEMORY_FENCE MemoryBarrier ()
94     #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
95     #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
96     #endif
97     #endif
98    
99 root 1.53 #ifndef ECB_MEMORY_FENCE
100 root 1.52 #include <pthread.h>
101    
102     static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER;
103     #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
104     #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
105     #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
106     #endif
107    
108     /*****************************************************************************/
109    
110 root 1.39 #define ECB_C99 (__STDC_VERSION__ >= 199901L)
111    
112     #if __cplusplus
113 root 1.46 #define ecb_inline static inline
114 root 1.38 #elif ECB_GCC_VERSION(2,5)
115 root 1.46 #define ecb_inline static __inline__
116 root 1.39 #elif ECB_C99
117 root 1.46 #define ecb_inline static inline
118 root 1.29 #else
119 root 1.46 #define ecb_inline static
120 root 1.38 #endif
121    
122     #if ECB_GCC_VERSION(3,3)
123     #define ecb_restrict __restrict__
124 root 1.39 #elif ECB_C99
125 root 1.38 #define ecb_restrict restrict
126     #else
127     #define ecb_restrict
128 root 1.4 #endif
129    
130 root 1.38 typedef int ecb_bool;
131    
132 root 1.8 #define ECB_CONCAT_(a, b) a ## b
133     #define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
134     #define ECB_STRINGIFY_(a) # a
135     #define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)
136    
137 root 1.46 #define ecb_function_ ecb_inline
138 root 1.3
139 root 1.1 #if ECB_GCC_VERSION(3,1)
140 root 1.37 #define ecb_attribute(attrlist) __attribute__(attrlist)
141     #define ecb_is_constant(expr) __builtin_constant_p (expr)
142     #define ecb_expect(expr,value) __builtin_expect ((expr),(value))
143     #define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
144     #else
145     #define ecb_attribute(attrlist)
146     #define ecb_is_constant(expr) 0
147     #define ecb_expect(expr,value) (expr)
148     #define ecb_prefetch(addr,rw,locality)
149 root 1.1 #endif
150    
151 root 1.2 /* no emulation for ecb_decltype */
152 root 1.1 #if ECB_GCC_VERSION(4,5)
153 root 1.37 #define ecb_decltype(x) __decltype(x)
154 root 1.1 #elif ECB_GCC_VERSION(3,0)
155 root 1.39 #define ecb_decltype(x) __typeof(x)
156 root 1.1 #endif
157    
158 root 1.24 #define ecb_noinline ecb_attribute ((__noinline__))
159     #define ecb_noreturn ecb_attribute ((__noreturn__))
160     #define ecb_unused ecb_attribute ((__unused__))
161     #define ecb_const ecb_attribute ((__const__))
162     #define ecb_pure ecb_attribute ((__pure__))
163 root 1.35
164     #if ECB_GCC_VERSION(4,3)
165 root 1.39 #define ecb_artificial ecb_attribute ((__artificial__))
166     #define ecb_hot ecb_attribute ((__hot__))
167     #define ecb_cold ecb_attribute ((__cold__))
168 root 1.35 #else
169     #define ecb_artificial
170     #define ecb_hot
171     #define ecb_cold
172     #endif
173 root 1.1
174 root 1.39 /* put around conditional expressions if you are very sure that the */
175     /* expression is mostly true or mostly false. note that these return */
176     /* booleans, not the expression. */
177 root 1.33 #define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
178     #define ecb_expect_true(expr) ecb_expect (!!(expr), 1)
179 root 1.36 /* for compatibility to the rest of the world */
180 root 1.33 #define ecb_likely(expr) ecb_expect_true (expr)
181     #define ecb_unlikely(expr) ecb_expect_false (expr)
182 root 1.1
183 root 1.3 /* count trailing zero bits and count # of one bits */
184 root 1.1 #if ECB_GCC_VERSION(3,4)
185 root 1.49 /* we assume int == 32 bit, long == 32 or 64 bit and long long == 64 bit */
186     #define ecb_ld32(x) (__builtin_clz (x) ^ 31)
187     #define ecb_ld64(x) (__builtin_clzll (x) ^ 63)
188 root 1.35 #define ecb_ctz32(x) __builtin_ctz (x)
189 root 1.49 #define ecb_ctz64(x) __builtin_ctzll (x)
190 root 1.35 #define ecb_popcount32(x) __builtin_popcount (x)
191 root 1.49 /* no popcountll */
192 root 1.1 #else
193 root 1.39 ecb_function_ int ecb_ctz32 (uint32_t x) ecb_const;
194     ecb_function_ int
195 root 1.35 ecb_ctz32 (uint32_t x)
196     {
197     int r = 0;
198    
199 root 1.48 x &= ~x + 1; /* this isolates the lowest bit */
200 root 1.35
201 root 1.50 #if ECB_branchless_on_i386
202     r += !!(x & 0xaaaaaaaa) << 0;
203     r += !!(x & 0xcccccccc) << 1;
204     r += !!(x & 0xf0f0f0f0) << 2;
205     r += !!(x & 0xff00ff00) << 3;
206     r += !!(x & 0xffff0000) << 4;
207     #else
208 root 1.35 if (x & 0xaaaaaaaa) r += 1;
209     if (x & 0xcccccccc) r += 2;
210     if (x & 0xf0f0f0f0) r += 4;
211     if (x & 0xff00ff00) r += 8;
212     if (x & 0xffff0000) r += 16;
213 root 1.50 #endif
214 root 1.35
215     return r;
216     }
217    
218 root 1.49 ecb_function_ int ecb_ctz64 (uint64_t x) ecb_const;
219     ecb_function_ int
220     ecb_ctz64 (uint64_t x)
221     {
222     int shift = x & 0xffffffffU ? 0 : 32;
223 root 1.50 return ecb_ctz32 (x >> shift) + shift;
224 root 1.49 }
225    
226 root 1.39 ecb_function_ int ecb_popcount32 (uint32_t x) ecb_const;
227     ecb_function_ int
228 root 1.35 ecb_popcount32 (uint32_t x)
229     {
230     x -= (x >> 1) & 0x55555555;
231     x = ((x >> 2) & 0x33333333) + (x & 0x33333333);
232     x = ((x >> 4) + x) & 0x0f0f0f0f;
233     x *= 0x01010101;
234 root 1.1
235 root 1.35 return x >> 24;
236     }
237 root 1.49
238     ecb_function_ int ecb_ld32 (uint32_t x) ecb_const;
239     ecb_function_ int ecb_ld32 (uint32_t x)
240     {
241 root 1.50 int r = 0;
242 root 1.49
243 root 1.50 if (x >> 16) { x >>= 16; r += 16; }
244     if (x >> 8) { x >>= 8; r += 8; }
245     if (x >> 4) { x >>= 4; r += 4; }
246     if (x >> 2) { x >>= 2; r += 2; }
247     if (x >> 1) { r += 1; }
248 root 1.49
249     return r;
250     }
251    
252     ecb_function_ int ecb_ld64 (uint64_t x) ecb_const;
253     ecb_function_ int ecb_ld64 (uint64_t x)
254     {
255 root 1.50 int r = 0;
256 root 1.49
257 root 1.50 if (x >> 32) { x >>= 32; r += 32; }
258 root 1.49
259 root 1.50 return r + ecb_ld32 (x);
260 root 1.49 }
261 root 1.1 #endif
262    
263 root 1.49 /* popcount64 is only available on 64 bit cpus as gcc builtin */
264     /* so for this version we are lazy */
265     ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
266     ecb_function_ int
267     ecb_popcount64 (uint64_t x)
268     {
269     return ecb_popcount32 (x) + ecb_popcount32 (x >> 32);
270     }
271    
272 root 1.50 ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) ecb_const;
273     ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) ecb_const;
274     ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) ecb_const;
275     ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) ecb_const;
276     ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
277     ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
278     ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) ecb_const;
279     ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) ecb_const;
280    
281     ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) { return (x >> ( 8 - count)) | (x << count); }
282     ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) { return (x << ( 8 - count)) | (x >> count); }
283     ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) { return (x >> (16 - count)) | (x << count); }
284     ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) { return (x << (16 - count)) | (x >> count); }
285     ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) { return (x >> (32 - count)) | (x << count); }
286     ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) { return (x << (32 - count)) | (x >> count); }
287     ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) { return (x >> (64 - count)) | (x << count); }
288     ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) { return (x << (64 - count)) | (x >> count); }
289    
290 root 1.13 #if ECB_GCC_VERSION(4,3)
291 root 1.49 #define ecb_bswap16(x) (__builtin_bswap32 (x) >> 16)
292     #define ecb_bswap32(x) __builtin_bswap32 (x)
293     #define ecb_bswap64(x) __builtin_bswap64 (x)
294 root 1.13 #else
295 root 1.50 ecb_function_ uint16_t ecb_bswap16 (uint16_t x) ecb_const;
296     ecb_function_ uint16_t
297     ecb_bswap16 (uint16_t x)
298 root 1.49 {
299 root 1.50 return ecb_rotl16 (x, 8);
300 root 1.49 }
301    
302 root 1.39 ecb_function_ uint32_t ecb_bswap32 (uint32_t x) ecb_const;
303     ecb_function_ uint32_t
304 root 1.35 ecb_bswap32 (uint32_t x)
305     {
306 root 1.50 return (((uint32_t)ecb_bswap16 (x)) << 16) | ecb_bswap16 (x >> 16);
307 root 1.35 }
308    
309 root 1.49 ecb_function_ uint64_t ecb_bswap64 (uint64_t x) ecb_const;
310     ecb_function_ uint64_t
311     ecb_bswap64 (uint64_t x)
312 root 1.35 {
313 root 1.50 return (((uint64_t)ecb_bswap32 (x)) << 32) | ecb_bswap32 (x >> 32);
314 root 1.35 }
315 root 1.13 #endif
316    
317     #if ECB_GCC_VERSION(4,5)
318 root 1.35 #define ecb_unreachable() __builtin_unreachable ()
319 root 1.13 #else
320 root 1.35 /* this seems to work fine, but gcc always emits a warning for it :/ */
321 root 1.39 ecb_function_ void ecb_unreachable (void) ecb_noreturn;
322     ecb_function_ void ecb_unreachable (void) { }
323 root 1.13 #endif
324    
325 root 1.41 /* try to tell the compiler that some condition is definitely true */
326     #define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
327    
328 root 1.39 ecb_function_ unsigned char ecb_byteorder_helper (void) ecb_const;
329     ecb_function_ unsigned char
330 root 1.23 ecb_byteorder_helper (void)
331 root 1.3 {
332     const uint32_t u = 0x11223344;
333     return *(unsigned char *)&u;
334     }
335    
336 root 1.39 ecb_function_ ecb_bool ecb_big_endian (void) ecb_const;
337 root 1.42 ecb_function_ ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
338 root 1.39 ecb_function_ ecb_bool ecb_little_endian (void) ecb_const;
339 root 1.42 ecb_function_ ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
340 root 1.3
341 root 1.39 #if ECB_GCC_VERSION(3,0) || ECB_C99
342 root 1.35 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
343 root 1.31 #else
344 root 1.35 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
345 root 1.31 #endif
346 root 1.21
347 root 1.5 #if ecb_cplusplus_does_not_suck
348 root 1.40 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
349 root 1.35 template<typename T, int N>
350     static inline int ecb_array_length (const T (&arr)[N])
351     {
352     return N;
353     }
354 root 1.5 #else
355 root 1.35 #define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
356 root 1.5 #endif
357    
358 root 1.1 #endif
359