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

Comparing libecb/ecb.h (file contents):
Revision 1.61 by root, Thu Aug 4 14:27:40 2011 UTC vs.
Revision 1.91 by root, Tue May 29 14:30:44 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 enormous 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
68/* ECB_NO_THREADS - ecb is not used by multiple threads, ever */ 93/* 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 */ 94/* ECB_NO_SMP - ecb might be used in multiple threads, but only on a single cpu */
70 95
96#if ECB_NO_THREADS
97# define ECB_NO_SMP 1
98#endif
99
71#if ECB_NO_THREADS || ECB_NO_SMP 100#if ECB_NO_THREADS || ECB_NO_SMP
72 #define ECB_MEMORY_FENCE do { } while (0) 101 #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 102#endif
76 103
77#ifndef ECB_MEMORY_FENCE 104#ifndef ECB_MEMORY_FENCE
78 #if ECB_GCC_VERSION(2,5) 105 #if ECB_C11 && !defined __STDC_NO_ATOMICS__
79 #if __x86 106 /* we assume that these memory fences work on all variables/all memory accesses, */
107 /* not just C11 atomics and atomic accesses */
108 #include <stdatomic.h>
109 #define ECB_MEMORY_FENCE atomic_thread_fence (memory_order_acq_rel)
110 #define ECB_MEMORY_FENCE_ACQUIRE atomic_thread_fence (memory_order_acquire)
111 #define ECB_MEMORY_FENCE_RELEASE atomic_thread_fence (memory_order_release)
112 #endif
113#endif
114
115#ifndef ECB_MEMORY_FENCE
116 #if ECB_GCC_VERSION(2,5) || defined __INTEL_COMPILER || (__llvm__ && __GNUC__) || __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
117 #if __i386 || __i386__
80 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory") 118 #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 */ 119 #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 */ 120 #define ECB_MEMORY_FENCE_RELEASE do { } while (0) /* unlikely to change in future cpus */
83 #elif __amd64 121 #elif __amd64 || __amd64__ || __x86_64 || __x86_64__
84 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory") 122 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory")
85 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory") 123 #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 */ 124 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence") /* play safe - not needed in any current cpu */
125 #elif __powerpc__ || __ppc__ || __powerpc64__ || __ppc64__
126 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
127 #elif defined __ARM_ARCH_6__ || defined __ARM_ARCH_6J__ \
128 || defined __ARM_ARCH_6K__ || defined __ARM_ARCH_6ZK__
129 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mcr p15,0,%0,c7,c10,5" : : "r" (0) : "memory")
130 #elif defined __ARM_ARCH_7__ || defined __ARM_ARCH_7A__ \
131 || defined __ARM_ARCH_7M__ || defined __ARM_ARCH_7R__
132 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("dmb" : : : "memory")
133 #elif __sparc || __sparc__
134 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad | #StoreStore | #StoreLoad | " : : : "memory")
135 #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad" : : : "memory")
136 #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("membar #LoadStore | #StoreStore")
137 #elif defined __s390__ || defined __s390x__
138 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("bcr 15,0" : : : "memory")
139 #elif defined __mips__
140 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
141 #elif defined __alpha__
142 #define ECB_MEMORY_FENCE __asm__ __volatile__ ("mb" : : : "memory")
87 #endif 143 #endif
88 #endif 144 #endif
89#endif 145#endif
90 146
91#ifndef ECB_MEMORY_FENCE 147#ifndef ECB_MEMORY_FENCE
92 #if ECB_GCC_VERSION(4,4) || defined(__INTEL_COMPILER) 148 #if ECB_GCC_VERSION(4,4) || defined __INTEL_COMPILER || defined __clang__
93 #define ECB_MEMORY_FENCE __sync_synchronize () 149 #define ECB_MEMORY_FENCE __sync_synchronize ()
94 #define ECB_MEMORY_FENCE_ACQUIRE __sync_synchronize () /* ({ 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); }) */
95 #define ECB_MEMORY_FENCE_RELEASE __sync_synchronize () /* ({ char dummy = 1; __sync_lock_release (&dummy ); }) */ 151 /*#define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release (&dummy ); }) */
96 #elif _MSC_VER >= 1400 /* VC++ 2005 */ 152 #elif _MSC_VER >= 1400 /* VC++ 2005 */
97 #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier) 153 #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
98 #define ECB_MEMORY_FENCE _ReadWriteBarrier () 154 #define ECB_MEMORY_FENCE _ReadWriteBarrier ()
99 #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */ 155 #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
100 #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier () 156 #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
101 #elif defined(_WIN32) 157 #elif defined _WIN32
102 #include <WinNT.h> 158 #include <WinNT.h>
103 #define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */ 159 #define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */
104 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE 160 #elif __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
105 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE 161 #include <mbarrier.h>
162 #define ECB_MEMORY_FENCE __machine_rw_barrier ()
163 #define ECB_MEMORY_FENCE_ACQUIRE __machine_r_barrier ()
164 #define ECB_MEMORY_FENCE_RELEASE __machine_w_barrier ()
165 #elif __xlC__
166 #define ECB_MEMORY_FENCE __sync ()
106 #endif 167 #endif
107#endif 168#endif
108 169
109#ifndef ECB_MEMORY_FENCE 170#ifndef ECB_MEMORY_FENCE
171 #if !ECB_AVOID_PTHREADS
110 /* 172 /*
111 * if you get undefined symbol references to pthread_mutex_lock, 173 * if you get undefined symbol references to pthread_mutex_lock,
112 * or failure to find pthread.h, then you should implement 174 * or failure to find pthread.h, then you should implement
113 * the ECB_MEMORY_FENCE operations for your cpu/compiler 175 * the ECB_MEMORY_FENCE operations for your cpu/compiler
114 * OR provide pthread.h and link against the posix thread library 176 * OR provide pthread.h and link against the posix thread library
115 * of your system. 177 * of your system.
116 */ 178 */
117 #include <pthread.h> 179 #include <pthread.h>
118 #define ECB_NEEDS_PTHREADS 1 180 #define ECB_NEEDS_PTHREADS 1
119 #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1 181 #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1
120 182
121 static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER; 183 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) 184 #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
185 #endif
186#endif
187
188#if !defined ECB_MEMORY_FENCE_ACQUIRE && defined ECB_MEMORY_FENCE
123 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE 189 #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
190#endif
191
192#if !defined ECB_MEMORY_FENCE_RELEASE && defined ECB_MEMORY_FENCE
124 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE 193 #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
125#endif 194#endif
126 195
127/*****************************************************************************/ 196/*****************************************************************************/
128
129#define ECB_C99 (__STDC_VERSION__ >= 199901L)
130 197
131#if __cplusplus 198#if __cplusplus
132 #define ecb_inline static inline 199 #define ecb_inline static inline
133#elif ECB_GCC_VERSION(2,5) 200#elif ECB_GCC_VERSION(2,5)
134 #define ecb_inline static __inline__ 201 #define ecb_inline static __inline__
173#elif ECB_GCC_VERSION(3,0) 240#elif ECB_GCC_VERSION(3,0)
174 #define ecb_decltype(x) __typeof(x) 241 #define ecb_decltype(x) __typeof(x)
175#endif 242#endif
176 243
177#define ecb_noinline ecb_attribute ((__noinline__)) 244#define ecb_noinline ecb_attribute ((__noinline__))
178#define ecb_noreturn ecb_attribute ((__noreturn__))
179#define ecb_unused ecb_attribute ((__unused__)) 245#define ecb_unused ecb_attribute ((__unused__))
180#define ecb_const ecb_attribute ((__const__)) 246#define ecb_const ecb_attribute ((__const__))
181#define ecb_pure ecb_attribute ((__pure__)) 247#define ecb_pure ecb_attribute ((__pure__))
248
249#if ECB_C11
250 #define ecb_noreturn _Noreturn
251#else
252 #define ecb_noreturn ecb_attribute ((__noreturn__))
253#endif
182 254
183#if ECB_GCC_VERSION(4,3) 255#if ECB_GCC_VERSION(4,3)
184 #define ecb_artificial ecb_attribute ((__artificial__)) 256 #define ecb_artificial ecb_attribute ((__artificial__))
185 #define ecb_hot ecb_attribute ((__hot__)) 257 #define ecb_hot ecb_attribute ((__hot__))
186 #define ecb_cold ecb_attribute ((__cold__)) 258 #define ecb_cold ecb_attribute ((__cold__))
277 349
278 return r + ecb_ld32 (x); 350 return r + ecb_ld32 (x);
279 } 351 }
280#endif 352#endif
281 353
354ecb_function_ ecb_bool ecb_is_pot32 (uint32_t x) ecb_const;
355ecb_function_ ecb_bool ecb_is_pot32 (uint32_t x) { return !(x & (x - 1)); }
356ecb_function_ ecb_bool ecb_is_pot64 (uint64_t x) ecb_const;
357ecb_function_ ecb_bool ecb_is_pot64 (uint64_t x) { return !(x & (x - 1)); }
358
359ecb_function_ uint8_t ecb_bitrev8 (uint8_t x) ecb_const;
360ecb_function_ uint8_t ecb_bitrev8 (uint8_t x)
361{
362 return ( (x * 0x0802U & 0x22110U)
363 | (x * 0x8020U & 0x88440U)) * 0x10101U >> 16;
364}
365
366ecb_function_ uint16_t ecb_bitrev16 (uint16_t x) ecb_const;
367ecb_function_ uint16_t ecb_bitrev16 (uint16_t x)
368{
369 x = ((x >> 1) & 0x5555) | ((x & 0x5555) << 1);
370 x = ((x >> 2) & 0x3333) | ((x & 0x3333) << 2);
371 x = ((x >> 4) & 0x0f0f) | ((x & 0x0f0f) << 4);
372 x = ( x >> 8 ) | ( x << 8);
373
374 return x;
375}
376
377ecb_function_ uint32_t ecb_bitrev32 (uint32_t x) ecb_const;
378ecb_function_ uint32_t ecb_bitrev32 (uint32_t x)
379{
380 x = ((x >> 1) & 0x55555555) | ((x & 0x55555555) << 1);
381 x = ((x >> 2) & 0x33333333) | ((x & 0x33333333) << 2);
382 x = ((x >> 4) & 0x0f0f0f0f) | ((x & 0x0f0f0f0f) << 4);
383 x = ((x >> 8) & 0x00ff00ff) | ((x & 0x00ff00ff) << 8);
384 x = ( x >> 16 ) | ( x << 16);
385
386 return x;
387}
388
282/* popcount64 is only available on 64 bit cpus as gcc builtin */ 389/* popcount64 is only available on 64 bit cpus as gcc builtin */
283/* so for this version we are lazy */ 390/* so for this version we are lazy */
284ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const; 391ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
285ecb_function_ int 392ecb_function_ int
286ecb_popcount64 (uint64_t x) 393ecb_popcount64 (uint64_t x)
335 442
336#if ECB_GCC_VERSION(4,5) 443#if ECB_GCC_VERSION(4,5)
337 #define ecb_unreachable() __builtin_unreachable () 444 #define ecb_unreachable() __builtin_unreachable ()
338#else 445#else
339 /* this seems to work fine, but gcc always emits a warning for it :/ */ 446 /* this seems to work fine, but gcc always emits a warning for it :/ */
340 ecb_function_ void ecb_unreachable (void) ecb_noreturn; 447 ecb_inline void ecb_unreachable (void) ecb_noreturn;
341 ecb_function_ void ecb_unreachable (void) { } 448 ecb_inline void ecb_unreachable (void) { }
342#endif 449#endif
343 450
344/* try to tell the compiler that some condition is definitely true */ 451/* try to tell the compiler that some condition is definitely true */
345#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0) 452#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
346 453
347ecb_function_ unsigned char ecb_byteorder_helper (void) ecb_const; 454ecb_inline unsigned char ecb_byteorder_helper (void) ecb_const;
348ecb_function_ unsigned char 455ecb_inline unsigned char
349ecb_byteorder_helper (void) 456ecb_byteorder_helper (void)
350{ 457{
351 const uint32_t u = 0x11223344; 458 const uint32_t u = 0x11223344;
352 return *(unsigned char *)&u; 459 return *(unsigned char *)&u;
353} 460}
354 461
355ecb_function_ ecb_bool ecb_big_endian (void) ecb_const; 462ecb_inline ecb_bool ecb_big_endian (void) ecb_const;
356ecb_function_ ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; } 463ecb_inline ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
357ecb_function_ ecb_bool ecb_little_endian (void) ecb_const; 464ecb_inline ecb_bool ecb_little_endian (void) ecb_const;
358ecb_function_ ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; } 465ecb_inline ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
359 466
360#if ECB_GCC_VERSION(3,0) || ECB_C99 467#if ECB_GCC_VERSION(3,0) || ECB_C99
361 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0)) 468 #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
362#else 469#else
363 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n))) 470 #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
471#endif
472
473#if __cplusplus
474 template<typename T>
475 static inline T ecb_div_rd (T val, T div)
476 {
477 return val < 0 ? - ((-val + div - 1) / div) : (val ) / div;
478 }
479 template<typename T>
480 static inline T ecb_div_ru (T val, T div)
481 {
482 return val < 0 ? - ((-val ) / div) : (val + div - 1) / div;
483 }
484#else
485 #define ecb_div_rd(val,div) ((val) < 0 ? - ((-(val) + (div) - 1) / (div)) : ((val) ) / (div))
486 #define ecb_div_ru(val,div) ((val) < 0 ? - ((-(val) ) / (div)) : ((val) + (div) - 1) / (div))
364#endif 487#endif
365 488
366#if ecb_cplusplus_does_not_suck 489#if ecb_cplusplus_does_not_suck
367 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */ 490 /* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
368 template<typename T, int N> 491 template<typename T, int N>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines