libecb/ecb.h

/*
 * libecb - http://software.schmorp.de/pkg/libecb
 *
 * Copyright (©) 2009-2011 Marc Alexander Lehmann <libecb@schmorp.de>
 * Copyright (©) 2011 Emanuele Giaquinta
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modifica-
 * tion, are permitted provided that the following conditions are met:
 *
 *   1.  Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *
 *   2.  Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ECB_H
#define ECB_H

#include <inttypes.h>

/* many compilers define _GNUC_ to some versions but then only implement
 * what their idiot authors think are the "more important" extensions,
 * causing enourmous grief in return for some better fake benchmark numbers.
 * or so.
 * we try to detect these and simply assume they are not gcc - if they have
 * an issue with that they should have done it right in the first place.
 */
#ifndef ECB_GCC_VERSION
# if defined(__INTEL_COMPILER) || defined(__SUNPRO_C) || defined(__llvm__)
#  define ECB_GCC_VERSION(major,minor) 0
# else
#  define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
# endif
#endif

#ifndef __cplusplus
# if __STDC_VERSION__ >= 199901L
#  define ECB_INLINE static inline
typedef _Bool ecb_bool;
# else
#  define ECB_INLINE static inline /* yeah! */
typedef int ecb_bool;
# endif
#else
# define ECB_INLINE static inline
typedef bool ecb_bool;
#endif

#define ECB_CONCAT_(a, b) a ## b
#define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
#define ECB_STRINGIFY_(a) # a
#define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)

#define ECB_HEADER_INLINE ECB_INLINE

#if ECB_GCC_VERSION(3,1)
# define ecb_attribute(attrlist)        __attribute__(attrlist)
# define ecb_is_constant(expr)          __builtin_constant_p (expr)
# define ecb_expect(expr,value)         __builtin_expect ((expr),(value))
# define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
#else
# define ecb_attribute(attrlist)
# define ecb_is_constant(expr)          0
# define ecb_expect(expr,value)         (expr)
# define ecb_prefetch(addr,rw,locality)
#endif

/* no emulation for ecb_decltype */
#if ECB_GCC_VERSION(4,5)
# define ecb_decltype(x) __decltype(x)
#elif ECB_GCC_VERSION(3,0)
# define ecb_decltype(x) typeof(x)
#endif

#define ecb_noinline   ecb_attribute ((__noinline__))
#define ecb_noreturn   ecb_attribute ((__noreturn__))
#define ecb_unused     ecb_attribute ((__unused__))
#define ecb_const      ecb_attribute ((__const__))
#define ecb_pure       ecb_attribute ((__pure__))

#if ECB_GCC_VERSION(4,3)
  #define ecb_artificial ecb_attribute ((__artificial__)) /* 4.3 */
  #define ecb_hot        ecb_attribute ((__hot__))        /* 4.3 */
  #define ecb_cold       ecb_attribute ((__cold__))       /* 4.3 */
#else
  #define ecb_artificial
  #define ecb_hot
  #define ecb_cold
#endif

/* put into if's if you are very sure that the expression */
/* is mostly true or mostly false. note that these return */
/* booleans, not the expression. */
#define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
#define ecb_expect_true(expr)  ecb_expect (!!(expr), 1)
#define ecb_likely(expr)   ecb_expect_true  (expr)
#define ecb_unlikely(expr) ecb_expect_false (expr)

/* try to tell the compiler that some condition is definitely true */
#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)

/* count trailing zero bits and count # of one bits */
#if ECB_GCC_VERSION(3,4)
  #define ecb_ctz32(x)      __builtin_ctz      (x)
  #define ecb_popcount32(x) __builtin_popcount (x)
#else
  ECB_HEADER_INLINE int ecb_ctz32 (uint32_t x) ecb_const;
  ECB_HEADER_INLINE int
  ecb_ctz32 (uint32_t x)
  {
    int r = 0;

    x &= -x; /* this isolates the lowest bit */

    if (x & 0xaaaaaaaa) r +=  1;
    if (x & 0xcccccccc) r +=  2;
    if (x & 0xf0f0f0f0) r +=  4;
    if (x & 0xff00ff00) r +=  8;
    if (x & 0xffff0000) r += 16;

    return r;
  }

  ECB_HEADER_INLINE int ecb_popcount32 (uint32_t x) ecb_const;
  ECB_HEADER_INLINE int
  ecb_popcount32 (uint32_t x)
  {
    x -=  (x >> 1) & 0x55555555;
    x  = ((x >> 2) & 0x33333333) + (x & 0x33333333);
    x  = ((x >> 4) + x) & 0x0f0f0f0f;
    x *= 0x01010101;

    return x >> 24;
  }
#endif

#if ECB_GCC_VERSION(4,3)
  #define ecb_bswap32(x) __builtin_bswap32 (x)
  #define ecb_bswap16(x) (__builtin_bswap32(x) >> 16)
#else
  ECB_HEADER_INLINE uint32_t ecb_bswap32 (uint32_t x) ecb_const;
  ECB_HEADER_INLINE uint32_t
  ecb_bswap32 (uint32_t x)
  {
    return (x >> 24)
        | ((x >>  8) & 0x0000ff00)
        | ((x <<  8) & 0x00ff0000)
        |  (x << 24);
  }

  ECB_HEADER_INLINE uint32_t ecb_bswap16 (uint32_t x) ecb_const;
  ECB_HEADER_INLINE uint32_t
  ecb_bswap16 (uint32_t x)
  {
    return ((x >>  8) & 0xff)
        |  ((x <<  8) & 0x00ff0000)
        |  (x << 24);
  }
#endif

#if ECB_GCC_VERSION(4,5)
  #define ecb_unreachable() __builtin_unreachable ()
#else
  /* this seems to work fine, but gcc always emits a warning for it :/ */
  ECB_HEADER_INLINE void ecb_unreachable (void) ecb_noreturn;
  ECB_HEADER_INLINE void ecb_unreachable (void) { }
#endif

ECB_HEADER_INLINE unsigned char ecb_byteorder_helper (void) ecb_const;
ECB_HEADER_INLINE unsigned char
ecb_byteorder_helper (void)
{
  const uint32_t u = 0x11223344;
  return *(unsigned char *)&u;
}

ECB_HEADER_INLINE ecb_bool ecb_big_endian    (void) ecb_const;
ECB_HEADER_INLINE ecb_bool ecb_big_endian    (void) { return ecb_byteorder_helper () == 0x11; };
ECB_HEADER_INLINE ecb_bool ecb_little_endian (void) ecb_const;
ECB_HEADER_INLINE ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; };

#if ECB_GCC_VERSION(3,0)
  #define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
#else
  #define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
#endif

#if ecb_cplusplus_does_not_suck
  // does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm)
  template<typename T, int N>
  static inline int ecb_array_length (const T (&arr)[N])
  {
    return N;
  }
#else
  #define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
#endif

ECB_INLINE uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
ECB_INLINE uint32_t
ecb_rotr32 (uint32_t x, unsigned int count)
{
  return (x << (32 - count)) | (x >> count);
}

ECB_INLINE uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
ECB_INLINE uint32_t
ecb_rotl32 (uint32_t x, unsigned int count)
{
  return (x >> (32 - count)) | (x << count);
}

#endif

Revision:	1.35
Committed:	Sat Jun 11 13:25:25 2011 UTC (13 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.34:	+72 -65 lines
Log Message:	new pp-codingstyle, gcc stupidly warns about unknown attributes
#	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.6	#include <inttypes.h>
34
35	root	1.12	/* many compilers define _GNUC_ to some versions but then only implement
36			* what their idiot authors think are the "more important" extensions,
37	root	1.18	* causing enourmous grief in return for some better fake benchmark numbers.
38			* or so.
39	root	1.12	* we try to detect these and simply assume they are not gcc - if they have
40			* an issue with that they should have done it right in the first place.
41			*/
42	root	1.14	#ifndef ECB_GCC_VERSION
43			# if defined(__INTEL_COMPILER) \|\| defined(__SUNPRO_C) \|\| defined(__llvm__)
44			# define ECB_GCC_VERSION(major,minor) 0
45			# else
46			# define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) \|\| (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
47			# endif
48	root	1.12	#endif
49	root	1.1
50	root	1.4	#ifndef __cplusplus
51			# if __STDC_VERSION__ >= 199901L
52	root	1.34	# define ECB_INLINE static inline
53	root	1.4	typedef _Bool ecb_bool;
54			# else
55	root	1.34	# define ECB_INLINE static inline /* yeah! */
56	root	1.4	typedef int ecb_bool;
57			# endif
58	root	1.29	#else
59	root	1.34	# define ECB_INLINE static inline
60	root	1.29	typedef bool ecb_bool;
61	root	1.4	#endif
62
63	root	1.8	#define ECB_CONCAT_(a, b) a ## b
64			#define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
65			#define ECB_STRINGIFY_(a) # a
66			#define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)
67
68	root	1.34	#define ECB_HEADER_INLINE ECB_INLINE
69	root	1.3
70	root	1.1	#if ECB_GCC_VERSION(3,1)
71			# define ecb_attribute(attrlist) __attribute__(attrlist)
72	root	1.22	# define ecb_is_constant(expr) __builtin_constant_p (expr)
73	root	1.1	# define ecb_expect(expr,value) __builtin_expect ((expr),(value))
74			# define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
75			#else
76			# define ecb_attribute(attrlist)
77	root	1.22	# define ecb_is_constant(expr) 0
78	root	1.1	# define ecb_expect(expr,value) (expr)
79			# define ecb_prefetch(addr,rw,locality)
80			#endif
81
82	root	1.2	/* no emulation for ecb_decltype */
83	root	1.1	#if ECB_GCC_VERSION(4,5)
84			# define ecb_decltype(x) __decltype(x)
85			#elif ECB_GCC_VERSION(3,0)
86			# define ecb_decltype(x) typeof(x)
87			#endif
88
89	root	1.24	#define ecb_noinline ecb_attribute ((__noinline__))
90			#define ecb_noreturn ecb_attribute ((__noreturn__))
91			#define ecb_unused ecb_attribute ((__unused__))
92			#define ecb_const ecb_attribute ((__const__))
93			#define ecb_pure ecb_attribute ((__pure__))
94	root	1.35
95			#if ECB_GCC_VERSION(4,3)
96			#define ecb_artificial ecb_attribute ((__artificial__)) /* 4.3 */
97			#define ecb_hot ecb_attribute ((__hot__)) /* 4.3 */
98			#define ecb_cold ecb_attribute ((__cold__)) /* 4.3 */
99			#else
100			#define ecb_artificial
101			#define ecb_hot
102			#define ecb_cold
103			#endif
104	root	1.1
105	root	1.22	/* put into if's if you are very sure that the expression */
106	root	1.33	/* is mostly true or mostly false. note that these return */
107	root	1.3	/* booleans, not the expression. */
108	root	1.33	#define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
109			#define ecb_expect_true(expr) ecb_expect (!!(expr), 1)
110			#define ecb_likely(expr) ecb_expect_true (expr)
111			#define ecb_unlikely(expr) ecb_expect_false (expr)
112	root	1.1
113	root	1.3	/* try to tell the compiler that some condition is definitely true */
114	root	1.19	#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
115	root	1.1
116	root	1.3	/* count trailing zero bits and count # of one bits */
117	root	1.1	#if ECB_GCC_VERSION(3,4)
118	root	1.35	#define ecb_ctz32(x) __builtin_ctz (x)
119			#define ecb_popcount32(x) __builtin_popcount (x)
120	root	1.1	#else
121	root	1.35	ECB_HEADER_INLINE int ecb_ctz32 (uint32_t x) ecb_const;
122			ECB_HEADER_INLINE int
123			ecb_ctz32 (uint32_t x)
124			{
125			int r = 0;
126
127			x &= -x; /* this isolates the lowest bit */
128
129			if (x & 0xaaaaaaaa) r += 1;
130			if (x & 0xcccccccc) r += 2;
131			if (x & 0xf0f0f0f0) r += 4;
132			if (x & 0xff00ff00) r += 8;
133			if (x & 0xffff0000) r += 16;
134
135			return r;
136			}
137
138			ECB_HEADER_INLINE int ecb_popcount32 (uint32_t x) ecb_const;
139			ECB_HEADER_INLINE int
140			ecb_popcount32 (uint32_t x)
141			{
142			x -= (x >> 1) & 0x55555555;
143			x = ((x >> 2) & 0x33333333) + (x & 0x33333333);
144			x = ((x >> 4) + x) & 0x0f0f0f0f;
145			x *= 0x01010101;
146	root	1.1
147	root	1.35	return x >> 24;
148			}
149	root	1.1	#endif
150
151	root	1.13	#if ECB_GCC_VERSION(4,3)
152	root	1.35	#define ecb_bswap32(x) __builtin_bswap32 (x)
153			#define ecb_bswap16(x) (__builtin_bswap32(x) >> 16)
154	root	1.13	#else
155	root	1.35	ECB_HEADER_INLINE uint32_t ecb_bswap32 (uint32_t x) ecb_const;
156			ECB_HEADER_INLINE uint32_t
157			ecb_bswap32 (uint32_t x)
158			{
159			return (x >> 24)
160			\| ((x >> 8) & 0x0000ff00)
161			\| ((x << 8) & 0x00ff0000)
162			\| (x << 24);
163			}
164
165			ECB_HEADER_INLINE uint32_t ecb_bswap16 (uint32_t x) ecb_const;
166			ECB_HEADER_INLINE uint32_t
167			ecb_bswap16 (uint32_t x)
168			{
169			return ((x >> 8) & 0xff)
170			\| ((x << 8) & 0x00ff0000)
171			\| (x << 24);
172			}
173	root	1.13	#endif
174
175			#if ECB_GCC_VERSION(4,5)
176	root	1.35	#define ecb_unreachable() __builtin_unreachable ()
177	root	1.13	#else
178	root	1.35	/* this seems to work fine, but gcc always emits a warning for it :/ */
179			ECB_HEADER_INLINE void ecb_unreachable (void) ecb_noreturn;
180			ECB_HEADER_INLINE void ecb_unreachable (void) { }
181	root	1.13	#endif
182
183	root	1.23	ECB_HEADER_INLINE unsigned char ecb_byteorder_helper (void) ecb_const;
184	root	1.3	ECB_HEADER_INLINE unsigned char
185	root	1.23	ecb_byteorder_helper (void)
186	root	1.3	{
187			const uint32_t u = 0x11223344;
188			return (unsigned char )&u;
189			}
190
191	root	1.23	ECB_HEADER_INLINE ecb_bool ecb_big_endian (void) ecb_const;
192			ECB_HEADER_INLINE ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; };
193			ECB_HEADER_INLINE ecb_bool ecb_little_endian (void) ecb_const;
194			ECB_HEADER_INLINE ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; };
195	root	1.3
196	root	1.32	#if ECB_GCC_VERSION(3,0)
197	root	1.35	#define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
198	root	1.31	#else
199	root	1.35	#define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
200	root	1.31	#endif
201	root	1.21
202	root	1.5	#if ecb_cplusplus_does_not_suck
203	root	1.35	// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm)
204			template<typename T, int N>
205			static inline int ecb_array_length (const T (&arr)[N])
206			{
207			return N;
208			}
209	root	1.5	#else
210	root	1.35	#define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
211	root	1.5	#endif
212
213	root	1.14	ECB_INLINE uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
214	root	1.6	ECB_INLINE uint32_t
215	root	1.9	ecb_rotr32 (uint32_t x, unsigned int count)
216	root	1.6	{
217	root	1.9	return (x << (32 - count)) \| (x >> count);
218	root	1.6	}
219
220	root	1.14	ECB_INLINE uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
221	root	1.6	ECB_INLINE uint32_t
222	root	1.9	ecb_rotl32 (uint32_t x, unsigned int count)
223	root	1.6	{
224	root	1.9	return (x >> (32 - count)) \| (x << count);
225	root	1.6	}
226
227	root	1.1	#endif
228