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

Comparing libecb/ecb.h (file contents):
Revision 1.56 by sf-exg, Thu Jul 28 13:45:44 2011 UTC vs.
Revision 1.94 by root, Tue May 29 21:03:20 2012 UTC

1/* 1/*
2 * libecb - http://software.schmorp.de/pkg/libecb 2 * libecb - http://software.schmorp.de/pkg/libecb
3 * 3 *
4 * Copyright (©) 2009-2011 Marc Alexander Lehmann <libecb@schmorp.de> 4 * Copyright (©) 2009-2012 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/* 16 bits major, 16 bits minor */
34#define ECB_VERSION 0x00010001
35
33#ifdef _WIN32 36#ifdef _WIN32
34 typedef signed char int8_t; 37 typedef signed char int8_t;
35 typedef unsigned char uint8_t; 38 typedef unsigned char uint8_t;
36 typedef signed short int16_t; 39 typedef signed short int16_t;
37 typedef unsigned short uint16_t; 40 typedef unsigned short uint16_t;
42 typedef unsigned long long uint64_t; 45 typedef unsigned long long uint64_t;
43 #else /* _MSC_VER || __BORLANDC__ */ 46 #else /* _MSC_VER || __BORLANDC__ */
44 typedef signed __int64 int64_t; 47 typedef signed __int64 int64_t;
45 typedef unsigned __int64 uint64_t; 48 typedef unsigned __int64 uint64_t;
46 #endif 49 #endif
50 #ifdef _WIN64
51 #define ECB_PTRSIZE 8
52 typedef uint64_t uintptr_t;
53 typedef int64_t intptr_t;
54 #else
55 #define ECB_PTRSIZE 4
56 typedef uint32_t uintptr_t;
57 typedef int32_t intptr_t;
58 #endif
59 typedef intptr_t ptrdiff_t;
47#else 60#else
48 #include <inttypes.h> 61 #include <inttypes.h>
62 #if UINTMAX_MAX > 0xffffffffU
63 #define ECB_PTRSIZE 8
64 #else
65 #define ECB_PTRSIZE 4
66 #endif
49#endif 67#endif
50 68
51/* many compilers define _GNUC_ to some versions but then only implement 69/* many compilers define _GNUC_ to some versions but then only implement
52 * what their idiot authors think are the "more important" extensions, 70 * what their idiot authors think are the "more important" extensions,
53 * causing enourmous grief in return for some better fake benchmark numbers. 71 * causing enormous grief in return for some better fake benchmark numbers.
54 * or so. 72 * or so.
55 * we try to detect these and simply assume they are not gcc - if they have 73 * 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. 74 * an issue with that they should have done it right in the first place.
57 */ 75 */
58#ifndef ECB_GCC_VERSION 76#ifndef ECB_GCC_VERSION
59 #if !defined(__GNUC_MINOR__) || defined(__INTEL_COMPILER) || defined(__SUNPRO_C) || defined(__SUNPRO_CC) || defined(__llvm__) || defined(__clang__) 77 #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 78 #define ECB_GCC_VERSION(major,minor) 0
61 #else 79 #else
62 #define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor))) 80 #define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
63 #endif 81 #endif
64#endif 82#endif
65 83
84#define ECB_C (__STDC__+0) /* this assumes that __STDC__ is either empty or a number */
85#define ECB_C99 (__STDC_VERSION__ >= 199901L)
86#define ECB_C11 (__STDC_VERSION__ >= 201112L)
87#define ECB_CPP (__cplusplus+0)
88#define ECB_CPP98 (__cplusplus >= 199711L)
89#define ECB_CPP11 (__cplusplus >= 201103L)
90
66/*****************************************************************************/ 91/*****************************************************************************/
67 92
93/* ECB_NO_THREADS - ecb is not used by multiple threads, ever */
94/* ECB_NO_SMP - ecb might be used in multiple threads, but only on a single cpu */
95
96#if ECB_NO_THREADS
97# define ECB_NO_SMP 1
98#endif
99
100#if ECB_NO_SMP
101 #define ECB_MEMORY_FENCE do { } while (0)
102#endif
103
68#ifndef ECB_MEMORY_FENCE 104#ifndef ECB_MEMORY_FENCE
69 #if ECB_GCC_VERSION(2,5) 105 #if ECB_GCC_VERSION(2,5) || defined __INTEL_COMPILER || (__llvm__ && __GNUC__) || __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
70 #if __x86 106 #if __i386 || __i386__
71 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory") 107 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory")
72 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE 108 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("" : : : "memory")
73 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE /* better be safe than sorry */ 109 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("")
74 #elif __amd64 110 #elif __amd64 || __amd64__ || __x86_64 || __x86_64__
75 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory") 111 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory")
76 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory") 112 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("" : : : "memory")
77 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence") 113 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("")
114 #elif __powerpc__ || __ppc__ || __powerpc64__ || __ppc64__
115 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
116 #elif defined __ARM_ARCH_6__ || defined __ARM_ARCH_6J__ \
117 || defined __ARM_ARCH_6K__ || defined __ARM_ARCH_6ZK__
118 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mcr p15,0,%0,c7,c10,5" : : "r" (0) : "memory")
119 #elif defined __ARM_ARCH_7__ || defined __ARM_ARCH_7A__ \
120 || defined __ARM_ARCH_7M__ || defined __ARM_ARCH_7R__
121 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("dmb" : : : "memory")
122 #elif __sparc || __sparc__
123 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad | #StoreStore | #StoreLoad" : : : "memory")
124 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad" : : : "memory")
125 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("membar #LoadStore | #StoreStore")
126 #elif defined __s390__ || defined __s390x__
127 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("bcr 15,0" : : : "memory")
128 #elif defined __mips__
129 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
130 #elif defined __alpha__
131 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mb" : : : "memory")
132 #elif defined __hppa__
133 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("" : : : "memory")
134 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("")
135 #elif defined __ia64__
136 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mf" : : : "memory")
78 #endif 137 #endif
79 #endif 138 #endif
80#endif 139#endif
81 140
82#ifndef ECB_MEMORY_FENCE 141#ifndef ECB_MEMORY_FENCE
83 #if ECB_GCC_VERSION(4,4) 142 #if ECB_GCC_VERSION(4,7)
143 /* see comment below about the C11 memory model. in short - avoid */
144 #define ECB_MEMORY_FENCE __atomic_thread_fence (__ATOMIC_SEQ_CST)
145 #elif defined __clang && __has_feature (cxx_atomic)
146 /* see above */
147 #define ECB_MEMORY_FENCE __c11_atomic_thread_fence (__ATOMIC_SEQ_CST)
148 #elif ECB_GCC_VERSION(4,4) || defined __INTEL_COMPILER || defined __clang__
84 #define ECB_MEMORY_FENCE __sync_synchronize () 149 #define ECB_MEMORY_FENCE __sync_synchronize ()
85 #define ECB_MEMORY_FENCE_ACQUIRE ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); }) 150 /*#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 ); }) 151 /*#define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release (&dummy ); }) */
87 #elif _MSC_VER >= 1400 && 0 /* TODO: only true when using volatiles */ 152 #elif _MSC_VER >= 1400 /* VC++ 2005 */
153 #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
88 #define ECB_MEMORY_FENCE do { } while (0) 154 #define ECB_MEMORY_FENCE _ReadWriteBarrier ()
89 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE 155 #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
90 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE 156 #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
91 #elif defined(_WIN32) 157 #elif defined _WIN32
92 #include <WinNT.h> 158 #include <WinNT.h>
159 #define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */
160 #elif __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
161 #include <mbarrier.h>
93 #define ECB_MEMORY_FENCE MemoryBarrier () 162 #define ECB_MEMORY_FENCE __machine_rw_barrier ()
94 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE 163 #define ECB_MEMORY_FENCE_ACQUIRE __machine_r_barrier ()
95 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE 164 #define ECB_MEMORY_FENCE_RELEASE __machine_w_barrier ()
165 #elif __xlC__
166 #define ECB_MEMORY_FENCE __sync ()
96 #endif 167 #endif
97#endif 168#endif
98 169
99#ifndef ECB_MEMORY_FENCE 170#ifndef ECB_MEMORY_FENCE
171 #if ECB_C11 && !defined __STDC_NO_ATOMICS__
172 /* we assume that these memory fences work on all variables/all memory accesses, */
173 /* not just C11 atomics and atomic accesses */
174 #include <stdatomic.h>
175 /* unfortunately, the C11 memory model seems to be very limited, and unable to express */
176 /* simple barrier semantics. That means we need to take out thor's hammer. */
177 #define ECB_MEMORY_FENCE atomic_thread_fence (memory_order_seq_cst)
178 #endif
179 #endif
180#endif
181
182#ifndef ECB_MEMORY_FENCE
183 #if !ECB_AVOID_PTHREADS
184 /*
185 * if you get undefined symbol references to pthread_mutex_lock,
186 * or failure to find pthread.h, then you should implement
187 * the ECB_MEMORY_FENCE operations for your cpu/compiler
188 * OR provide pthread.h and link against the posix thread library
189 * of your system.
190 */
100 #include <pthread.h> 191 #include <pthread.h>
192 #define ECB_NEEDS_PTHREADS 1
193 #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1
101 194
102 static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER; 195 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) 196 #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
197 #endif
198#endif
199
200#if !defined ECB_MEMORY_FENCE_ACQUIRE && defined ECB_MEMORY_FENCE
104 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE 201 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
202#endif
203
204#if !defined ECB_MEMORY_FENCE_RELEASE && defined ECB_MEMORY_FENCE
105 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE 205 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
106#endif 206#endif
107 207
108/*****************************************************************************/ 208/*****************************************************************************/
109
110#define ECB_C99 (__STDC_VERSION__ >= 199901L)
111 209
112#if __cplusplus 210#if __cplusplus
113 #define ecb_inline static inline 211 #define ecb_inline static inline
114#elif ECB_GCC_VERSION(2,5) 212#elif ECB_GCC_VERSION(2,5)
115 #define ecb_inline static __inline__ 213 #define ecb_inline static __inline__
154#elif ECB_GCC_VERSION(3,0) 252#elif ECB_GCC_VERSION(3,0)
155 #define ecb_decltype(x) __typeof(x) 253 #define ecb_decltype(x) __typeof(x)
156#endif 254#endif
157 255
158#define ecb_noinline ecb_attribute ((__noinline__)) 256#define ecb_noinline ecb_attribute ((__noinline__))
159#define ecb_noreturn ecb_attribute ((__noreturn__))
160#define ecb_unused ecb_attribute ((__unused__)) 257#define ecb_unused ecb_attribute ((__unused__))
161#define ecb_const ecb_attribute ((__const__)) 258#define ecb_const ecb_attribute ((__const__))
162#define ecb_pure ecb_attribute ((__pure__)) 259#define ecb_pure ecb_attribute ((__pure__))
260
261#if ECB_C11
262 #define ecb_noreturn _Noreturn
263#else
264 #define ecb_noreturn ecb_attribute ((__noreturn__))
265#endif
163 266
164#if ECB_GCC_VERSION(4,3) 267#if ECB_GCC_VERSION(4,3)
165 #define ecb_artificial ecb_attribute ((__artificial__)) 268 #define ecb_artificial ecb_attribute ((__artificial__))
166 #define ecb_hot ecb_attribute ((__hot__)) 269 #define ecb_hot ecb_attribute ((__hot__))
167 #define ecb_cold ecb_attribute ((__cold__)) 270 #define ecb_cold ecb_attribute ((__cold__))
258 361
259 return r + ecb_ld32 (x); 362 return r + ecb_ld32 (x);
260 } 363 }
261#endif 364#endif
262 365
366ecb_function_ ecb_bool ecb_is_pot32 (uint32_t x) ecb_const;
367ecb_function_ ecb_bool ecb_is_pot32 (uint32_t x) { return !(x & (x - 1)); }
368ecb_function_ ecb_bool ecb_is_pot64 (uint64_t x) ecb_const;
369ecb_function_ ecb_bool ecb_is_pot64 (uint64_t x) { return !(x & (x - 1)); }
370
371ecb_function_ uint8_t ecb_bitrev8 (uint8_t x) ecb_const;
372ecb_function_ uint8_t ecb_bitrev8 (uint8_t x)
373{
374 return ( (x * 0x0802U & 0x22110U)
375 | (x * 0x8020U & 0x88440U)) * 0x10101U >> 16;
376}
377
378ecb_function_ uint16_t ecb_bitrev16 (uint16_t x) ecb_const;
379ecb_function_ uint16_t ecb_bitrev16 (uint16_t x)
380{
381 x = ((x >> 1) & 0x5555) | ((x & 0x5555) << 1);
382 x = ((x >> 2) & 0x3333) | ((x & 0x3333) << 2);
383 x = ((x >> 4) & 0x0f0f) | ((x & 0x0f0f) << 4);
384 x = ( x >> 8 ) | ( x << 8);
385
386 return x;
387}
388
389ecb_function_ uint32_t ecb_bitrev32 (uint32_t x) ecb_const;
390ecb_function_ uint32_t ecb_bitrev32 (uint32_t x)
391{
392 x = ((x >> 1) & 0x55555555) | ((x & 0x55555555) << 1);
393 x = ((x >> 2) & 0x33333333) | ((x & 0x33333333) << 2);
394 x = ((x >> 4) & 0x0f0f0f0f) | ((x & 0x0f0f0f0f) << 4);
395 x = ((x >> 8) & 0x00ff00ff) | ((x & 0x00ff00ff) << 8);
396 x = ( x >> 16 ) | ( x << 16);
397
398 return x;
399}
400
263/* popcount64 is only available on 64 bit cpus as gcc builtin */ 401/* popcount64 is only available on 64 bit cpus as gcc builtin */
264/* so for this version we are lazy */ 402/* so for this version we are lazy */
265ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const; 403ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
266ecb_function_ int 404ecb_function_ int
267ecb_popcount64 (uint64_t x) 405ecb_popcount64 (uint64_t x)
316 454
317#if ECB_GCC_VERSION(4,5) 455#if ECB_GCC_VERSION(4,5)
318 #define ecb_unreachable() __builtin_unreachable () 456 #define ecb_unreachable() __builtin_unreachable ()
319#else 457#else
320 /* this seems to work fine, but gcc always emits a warning for it :/ */ 458 /* this seems to work fine, but gcc always emits a warning for it :/ */
321 ecb_function_ void ecb_unreachable (void) ecb_noreturn; 459 ecb_inline void ecb_unreachable (void) ecb_noreturn;
322 ecb_function_ void ecb_unreachable (void) { } 460 ecb_inline void ecb_unreachable (void) { }
323#endif 461#endif
324 462
325/* try to tell the compiler that some condition is definitely true */ 463/* try to tell the compiler that some condition is definitely true */
326#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0) 464#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
327 465
328ecb_function_ unsigned char ecb_byteorder_helper (void) ecb_const; 466ecb_inline unsigned char ecb_byteorder_helper (void) ecb_const;
329ecb_function_ unsigned char 467ecb_inline unsigned char
330ecb_byteorder_helper (void) 468ecb_byteorder_helper (void)
331{ 469{
332 const uint32_t u = 0x11223344; 470 const uint32_t u = 0x11223344;
333 return *(unsigned char *)&u; 471 return *(unsigned char *)&u;
334} 472}
335 473
336ecb_function_ ecb_bool ecb_big_endian (void) ecb_const; 474ecb_inline ecb_bool ecb_big_endian (void) ecb_const;
337ecb_function_ ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; } 475ecb_inline ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
338ecb_function_ ecb_bool ecb_little_endian (void) ecb_const; 476ecb_inline ecb_bool ecb_little_endian (void) ecb_const;
339ecb_function_ ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; } 477ecb_inline ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
340 478
341#if ECB_GCC_VERSION(3,0) || ECB_C99 479#if ECB_GCC_VERSION(3,0) || ECB_C99
342 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0)) 480 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
343#else 481#else
344 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n))) 482 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
483#endif
484
485#if __cplusplus
486 template<typename T>
487 static inline T ecb_div_rd (T val, T div)
488 {
489 return val < 0 ? - ((-val + div - 1) / div) : (val ) / div;
490 }
491 template<typename T>
492 static inline T ecb_div_ru (T val, T div)
493 {
494 return val < 0 ? - ((-val ) / div) : (val + div - 1) / div;
495 }
496#else
497 #define ecb_div_rd(val,div) ((val) < 0 ? - ((-(val) + (div) - 1) / (div)) : ((val) ) / (div))
498 #define ecb_div_ru(val,div) ((val) < 0 ? - ((-(val) ) / (div)) : ((val) + (div) - 1) / (div))
345#endif 499#endif
346 500
347#if ecb_cplusplus_does_not_suck 501#if ecb_cplusplus_does_not_suck
348 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */ 502 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
349 template<typename T, int N> 503 template<typename T, int N>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines