libecb/ecb.h

/*
 * libecb - http://software.schmorp.de/pkg/libecb
 *
 * Copyright (©) 2009-2012 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

/* 16 bits major, 16 bits minor */
#define ECB_VERSION 0x00010001

#ifdef _WIN32
  typedef   signed char   int8_t;
  typedef unsigned char  uint8_t;
  typedef   signed short  int16_t;
  typedef unsigned short uint16_t;
  typedef   signed int    int32_t;
  typedef unsigned int   uint32_t;
  #if __GNUC__
    typedef   signed long long int64_t;
    typedef unsigned long long uint64_t;
  #else /* _MSC_VER || __BORLANDC__ */
    typedef   signed __int64   int64_t;
    typedef unsigned __int64   uint64_t;
  #endif
  #ifdef _WIN64
    #define ECB_PTRSIZE 8
    typedef uint64_t uintptr_t;
    typedef  int64_t  intptr_t;
  #else
    #define ECB_PTRSIZE 4
    typedef uint32_t uintptr_t;
    typedef  int32_t  intptr_t;
  #endif
#else
  #include <inttypes.h>
  #if UINTMAX_MAX > 0xffffffffU
    #define ECB_PTRSIZE 8
  #else
    #define ECB_PTRSIZE 4
  #endif
#endif

/* many compilers define _GNUC_ to some versions but then only implement
 * what their idiot authors think are the "more important" extensions,
 * causing enormous 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 __GNUC_MINOR__ || defined __INTEL_COMPILER || defined __SUNPRO_C || defined __SUNPRO_CC || defined __llvm__ || defined __clang__
    #define ECB_GCC_VERSION(major,minor) 0
  #else
    #define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
  #endif
#endif

/*****************************************************************************/

/* ECB_NO_THREADS - ecb is not used by multiple threads, ever */
/* ECB_NO_SMP     - ecb might be used in multiple threads, but only on a single cpu */

#if ECB_NO_THREADS
# define ECB_NO_SMP 1
#endif

#if ECB_NO_THREADS || ECB_NO_SMP
  #define ECB_MEMORY_FENCE do { } while (0)
#endif

#ifndef ECB_MEMORY_FENCE
  #if ECB_GCC_VERSION(2,5) || defined __INTEL_COMPILER || (__llvm__ && __GNUC__) || __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
    #if __i386 || __i386__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory")
      #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE /* non-lock xchg might be enough */
      #define ECB_MEMORY_FENCE_RELEASE do { } while (0) /* unlikely to change in future cpus */
    #elif __amd64 || __amd64__ || __x86_64 || __x86_64__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("mfence" : : : "memory")
      #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory")
      #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence") /* play safe - not needed in any current cpu */
    #elif __powerpc__ || __ppc__ || __powerpc64__ || __ppc64__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("sync" : : : "memory")
    #elif defined __ARM_ARCH_6__  || defined __ARM_ARCH_6J__  \
       || defined __ARM_ARCH_6K__ || defined __ARM_ARCH_6ZK__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("mcr p15,0,%0,c7,c10,5" : : "r" (0) : "memory")
    #elif defined __ARM_ARCH_7__  || defined __ARM_ARCH_7A__  \
       || defined __ARM_ARCH_7M__ || defined __ARM_ARCH_7R__ 
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("dmb" : : : "memory")
    #elif __sparc || __sparc__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("membar #LoadStore | #LoadLoad | #StoreStore | #StoreLoad | " : : : "memory")
      #define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("membar #LoadStore | #LoadLoad"                               : : : "memory")
      #define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("membar #LoadStore |             #StoreStore")
    #elif defined __s390__ || defined __s390x__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("bcr 15,0" : : : "memory")
    #elif defined __mips__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("sync" : : : "memory")
    #elif defined __alpha__
      #define ECB_MEMORY_FENCE         __asm__ __volatile__ ("mb" : : : "memory")
    #endif
  #endif
#endif

#ifndef ECB_MEMORY_FENCE
  #if ECB_GCC_VERSION(4,4) || defined __INTEL_COMPILER || defined __clang__
    #define ECB_MEMORY_FENCE         __sync_synchronize ()
    /*#define ECB_MEMORY_FENCE_ACQUIRE ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); }) */
    /*#define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release      (&dummy   ); }) */
  #elif _MSC_VER >= 1400 /* VC++ 2005 */
    #pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
    #define ECB_MEMORY_FENCE         _ReadWriteBarrier ()
    #define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
    #define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
  #elif defined _WIN32
    #include <WinNT.h>
    #define ECB_MEMORY_FENCE         MemoryBarrier () /* actually just xchg on x86... scary */
  #elif __SUNPRO_C >= 0x5110 || __SUNPRO_CC >= 0x5110
    #include <mbarrier.h>
    #define ECB_MEMORY_FENCE         __machine_rw_barrier ()
    #define ECB_MEMORY_FENCE_ACQUIRE __machine_r_barrier  ()
    #define ECB_MEMORY_FENCE_RELEASE __machine_w_barrier  ()
  #elif __xlC__
    #define ECB_MEMORY_FENCE         __sync ()
  #endif
#endif

#ifndef ECB_MEMORY_FENCE
  #if !ECB_AVOID_PTHREADS
    /*
     * if you get undefined symbol references to pthread_mutex_lock,
     * or failure to find pthread.h, then you should implement
     * the ECB_MEMORY_FENCE operations for your cpu/compiler
     * OR provide pthread.h and link against the posix thread library
     * of your system.
     */
    #include <pthread.h>
    #define ECB_NEEDS_PTHREADS 1
    #define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1

    static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER;
    #define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
  #endif
#endif

#if !defined ECB_MEMORY_FENCE_ACQUIRE && defined ECB_MEMORY_FENCE
  #define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
#endif

#if !defined ECB_MEMORY_FENCE_RELEASE && defined ECB_MEMORY_FENCE
  #define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
#endif

/*****************************************************************************/

#define ECB_C99 (__STDC_VERSION__ >= 199901L)

#if __cplusplus
  #define ecb_inline static inline
#elif ECB_GCC_VERSION(2,5)
  #define ecb_inline static __inline__
#elif ECB_C99
  #define ecb_inline static inline
#else
  #define ecb_inline static
#endif

#if ECB_GCC_VERSION(3,3)
  #define ecb_restrict __restrict__
#elif ECB_C99
  #define ecb_restrict restrict
#else
  #define ecb_restrict
#endif

typedef int ecb_bool;

#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_function_ 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__))
  #define ecb_hot        ecb_attribute ((__hot__))
  #define ecb_cold       ecb_attribute ((__cold__))
#else
  #define ecb_artificial
  #define ecb_hot
  #define ecb_cold
#endif

/* put around conditional expressions 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)
/* for compatibility to the rest of the world */
#define ecb_likely(expr)   ecb_expect_true  (expr)
#define ecb_unlikely(expr) ecb_expect_false (expr)

/* count trailing zero bits and count # of one bits */
#if ECB_GCC_VERSION(3,4)
  /* we assume int == 32 bit, long == 32 or 64 bit and long long == 64 bit */
  #define ecb_ld32(x)      (__builtin_clz      (x) ^ 31)
  #define ecb_ld64(x)      (__builtin_clzll    (x) ^ 63)
  #define ecb_ctz32(x)      __builtin_ctz      (x)
  #define ecb_ctz64(x)      __builtin_ctzll    (x)
  #define ecb_popcount32(x) __builtin_popcount (x)
  /* no popcountll */
#else
  ecb_function_ int ecb_ctz32 (uint32_t x) ecb_const;
  ecb_function_ int
  ecb_ctz32 (uint32_t x)
  {
    int r = 0;

    x &= ~x + 1; /* this isolates the lowest bit */

#if ECB_branchless_on_i386
    r += !!(x & 0xaaaaaaaa) << 0;
    r += !!(x & 0xcccccccc) << 1;
    r += !!(x & 0xf0f0f0f0) << 2;
    r += !!(x & 0xff00ff00) << 3;
    r += !!(x & 0xffff0000) << 4;
#else
    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;
#endif

    return r;
  }

  ecb_function_ int ecb_ctz64 (uint64_t x) ecb_const;
  ecb_function_ int
  ecb_ctz64 (uint64_t x)
  {
    int shift = x & 0xffffffffU ? 0 : 32;
    return ecb_ctz32 (x >> shift) + shift;
  }

  ecb_function_ int ecb_popcount32 (uint32_t x) ecb_const;
  ecb_function_ 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;
  }

  ecb_function_ int ecb_ld32 (uint32_t x) ecb_const;
  ecb_function_ int ecb_ld32 (uint32_t x)
  {
    int r = 0;

    if (x >> 16) { x >>= 16; r += 16; }
    if (x >>  8) { x >>=  8; r +=  8; }
    if (x >>  4) { x >>=  4; r +=  4; }
    if (x >>  2) { x >>=  2; r +=  2; }
    if (x >>  1) {           r +=  1; }

    return r;
  }

  ecb_function_ int ecb_ld64 (uint64_t x) ecb_const;
  ecb_function_ int ecb_ld64 (uint64_t x)
  {
    int r = 0;

    if (x >> 32) { x >>= 32; r += 32; }

    return r + ecb_ld32 (x);
  }
#endif

ecb_function_ uint8_t  ecb_bitrev8  (uint8_t  x) ecb_const;
ecb_function_ uint8_t  ecb_bitrev8  (uint8_t  x)
{
  return (  (x * 0x0802U & 0x22110U)
          | (x * 0x8020U & 0x88440U)) * 0x10101U >> 16; 
}

ecb_function_ uint16_t ecb_bitrev16 (uint16_t x) ecb_const;
ecb_function_ uint16_t ecb_bitrev16 (uint16_t x)
{
  x = ((x >>  1) &     0x5555) | ((x &     0x5555) <<  1);
  x = ((x >>  2) &     0x3333) | ((x &     0x3333) <<  2);
  x = ((x >>  4) &     0x0f0f) | ((x &     0x0f0f) <<  4);
  x = ( x >>  8              ) | ( x               <<  8);

  return x;
}

ecb_function_ uint32_t ecb_bitrev32 (uint32_t x) ecb_const;
ecb_function_ uint32_t ecb_bitrev32 (uint32_t x)
{
  x = ((x >>  1) & 0x55555555) | ((x & 0x55555555) <<  1);
  x = ((x >>  2) & 0x33333333) | ((x & 0x33333333) <<  2);
  x = ((x >>  4) & 0x0f0f0f0f) | ((x & 0x0f0f0f0f) <<  4);
  x = ((x >>  8) & 0x00ff00ff) | ((x & 0x00ff00ff) <<  8);
  x = ( x >> 16              ) | ( x               << 16);

  return x;
}

/* popcount64 is only available on 64 bit cpus as gcc builtin */
/* so for this version we are lazy */
ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
ecb_function_ int
ecb_popcount64 (uint64_t x)
{
  return ecb_popcount32 (x) + ecb_popcount32 (x >> 32);
}

ecb_inline uint8_t  ecb_rotl8  (uint8_t  x, unsigned int count) ecb_const;
ecb_inline uint8_t  ecb_rotr8  (uint8_t  x, unsigned int count) ecb_const;
ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) ecb_const;
ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) ecb_const;
ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) ecb_const;
ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) ecb_const;

ecb_inline uint8_t  ecb_rotl8  (uint8_t  x, unsigned int count) { return (x >> ( 8 - count)) | (x << count); }
ecb_inline uint8_t  ecb_rotr8  (uint8_t  x, unsigned int count) { return (x << ( 8 - count)) | (x >> count); }
ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) { return (x >> (16 - count)) | (x << count); }
ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) { return (x << (16 - count)) | (x >> count); }
ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) { return (x >> (32 - count)) | (x << count); }
ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) { return (x << (32 - count)) | (x >> count); }
ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) { return (x >> (64 - count)) | (x << count); }
ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) { return (x << (64 - count)) | (x >> count); }

#if ECB_GCC_VERSION(4,3)
  #define ecb_bswap16(x) (__builtin_bswap32 (x) >> 16)
  #define ecb_bswap32(x)  __builtin_bswap32 (x)
  #define ecb_bswap64(x)  __builtin_bswap64 (x)
#else
  ecb_function_ uint16_t ecb_bswap16 (uint16_t x) ecb_const;
  ecb_function_ uint16_t
  ecb_bswap16 (uint16_t x)
  {
    return ecb_rotl16 (x, 8);
  }

  ecb_function_ uint32_t ecb_bswap32 (uint32_t x) ecb_const;
  ecb_function_ uint32_t
  ecb_bswap32 (uint32_t x)
  {
    return (((uint32_t)ecb_bswap16 (x)) << 16) | ecb_bswap16 (x >> 16);
  }

  ecb_function_ uint64_t ecb_bswap64 (uint64_t x) ecb_const;
  ecb_function_ uint64_t
  ecb_bswap64 (uint64_t x)
  {
    return (((uint64_t)ecb_bswap32 (x)) << 32) | ecb_bswap32 (x >> 32);
  }
#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_inline void ecb_unreachable (void) ecb_noreturn;
  ecb_inline void ecb_unreachable (void) { }
#endif

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

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

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

#if ECB_GCC_VERSION(3,0) || ECB_C99
  #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 __cplusplus
  template<typename T>
  static inline T ecb_div_rd (T val, T div)
  {
    return val < 0 ? - ((-val + div - 1) / div) : (val          ) / div;
  }
  template<typename T>
  static inline T ecb_div_ru (T val, T div)
  {
    return val < 0 ? - ((-val          ) / div) : (val + div - 1) / div;
  }
#else
  #define ecb_div_rd(val,div) ((val) < 0 ? - ((-(val) + (div) - 1) / (div)) : ((val)            ) / (div))
  #define ecb_div_ru(val,div) ((val) < 0 ? - ((-(val)            ) / (div)) : ((val) + (div) - 1) / (div))
#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

#endif

Revision:	1.87
Committed:	Mon May 28 08:28:26 2012 UTC (12 years ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.86:	+17 -0 lines
Log Message:	* empty log message *
#	Content
1	/*
2	* libecb - http://software.schmorp.de/pkg/libecb
3	*
4	* Copyright (©) 2009-2012 Marc Alexander Lehmann <libecb@schmorp.de>
5	* Copyright (©) 2011 Emanuele Giaquinta
6	* 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	/* 16 bits major, 16 bits minor */
34	#define ECB_VERSION 0x00010001
35
36	#ifdef _WIN32
37	typedef signed char int8_t;
38	typedef unsigned char uint8_t;
39	typedef signed short int16_t;
40	typedef unsigned short uint16_t;
41	typedef signed int int32_t;
42	typedef unsigned int uint32_t;
43	#if __GNUC__
44	typedef signed long long int64_t;
45	typedef unsigned long long uint64_t;
46	#else /* _MSC_VER \|\| __BORLANDC__ */
47	typedef signed __int64 int64_t;
48	typedef unsigned __int64 uint64_t;
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	#else
60	#include <inttypes.h>
61	#if UINTMAX_MAX > 0xffffffffU
62	#define ECB_PTRSIZE 8
63	#else
64	#define ECB_PTRSIZE 4
65	#endif
66	#endif
67
68	/* many compilers define _GNUC_ to some versions but then only implement
69	* what their idiot authors think are the "more important" extensions,
70	* causing enormous grief in return for some better fake benchmark numbers.
71	* or so.
72	* we try to detect these and simply assume they are not gcc - if they have
73	* an issue with that they should have done it right in the first place.
74	*/
75	#ifndef ECB_GCC_VERSION
76	#if !defined __GNUC_MINOR__ \|\| defined __INTEL_COMPILER \|\| defined __SUNPRO_C \|\| defined __SUNPRO_CC \|\| defined __llvm__ \|\| defined __clang__
77	#define ECB_GCC_VERSION(major,minor) 0
78	#else
79	#define ECB_GCC_VERSION(major,minor) (__GNUC__ > (major) \|\| (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor)))
80	#endif
81	#endif
82
83	/*****************************************************************************/
84
85	/* ECB_NO_THREADS - ecb is not used by multiple threads, ever */
86	/* ECB_NO_SMP - ecb might be used in multiple threads, but only on a single cpu */
87
88	#if ECB_NO_THREADS
89	# define ECB_NO_SMP 1
90	#endif
91
92	#if ECB_NO_THREADS \|\| ECB_NO_SMP
93	#define ECB_MEMORY_FENCE do { } while (0)
94	#endif
95
96	#ifndef ECB_MEMORY_FENCE
97	#if ECB_GCC_VERSION(2,5) \|\| defined __INTEL_COMPILER \|\| (__llvm__ && __GNUC__) \|\| __SUNPRO_C >= 0x5110 \|\| __SUNPRO_CC >= 0x5110
98	#if __i386 \|\| __i386__
99	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("lock; orb $0, -1(%%esp)" : : : "memory")
100	#define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE /* non-lock xchg might be enough */
101	#define ECB_MEMORY_FENCE_RELEASE do { } while (0) /* unlikely to change in future cpus */
102	#elif __amd64 \|\| __amd64__ \|\| __x86_64 \|\| __x86_64__
103	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("mfence" : : : "memory")
104	#define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("lfence" : : : "memory")
105	#define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("sfence") /* play safe - not needed in any current cpu */
106	#elif __powerpc__ \|\| __ppc__ \|\| __powerpc64__ \|\| __ppc64__
107	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
108	#elif defined __ARM_ARCH_6__ \|\| defined __ARM_ARCH_6J__ \
109	\|\| defined __ARM_ARCH_6K__ \|\| defined __ARM_ARCH_6ZK__
110	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("mcr p15,0,%0,c7,c10,5" : : "r" (0) : "memory")
111	#elif defined __ARM_ARCH_7__ \|\| defined __ARM_ARCH_7A__ \
112	\|\| defined __ARM_ARCH_7M__ \|\| defined __ARM_ARCH_7R__
113	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("dmb" : : : "memory")
114	#elif __sparc \|\| __sparc__
115	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("membar #LoadStore \| #LoadLoad \| #StoreStore \| #StoreLoad \| " : : : "memory")
116	#define ECB_MEMORY_FENCE_ACQUIRE __asm__ __volatile__ ("membar #LoadStore \| #LoadLoad" : : : "memory")
117	#define ECB_MEMORY_FENCE_RELEASE __asm__ __volatile__ ("membar #LoadStore \| #StoreStore")
118	#elif defined __s390__ \|\| defined __s390x__
119	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("bcr 15,0" : : : "memory")
120	#elif defined __mips__
121	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("sync" : : : "memory")
122	#elif defined __alpha__
123	#define ECB_MEMORY_FENCE __asm__ __volatile__ ("mb" : : : "memory")
124	#endif
125	#endif
126	#endif
127
128	#ifndef ECB_MEMORY_FENCE
129	#if ECB_GCC_VERSION(4,4) \|\| defined __INTEL_COMPILER \|\| defined __clang__
130	#define ECB_MEMORY_FENCE __sync_synchronize ()
131	/#define ECB_MEMORY_FENCE_ACQUIRE ({ char dummy = 0; __sync_lock_test_and_set (&dummy, 1); }) /
132	/#define ECB_MEMORY_FENCE_RELEASE ({ char dummy = 1; __sync_lock_release (&dummy ); }) /
133	#elif _MSC_VER >= 1400 /* VC++ 2005 */
134	#pragma intrinsic(_ReadBarrier,_WriteBarrier,_ReadWriteBarrier)
135	#define ECB_MEMORY_FENCE _ReadWriteBarrier ()
136	#define ECB_MEMORY_FENCE_ACQUIRE _ReadWriteBarrier () /* according to msdn, _ReadBarrier is not a load fence */
137	#define ECB_MEMORY_FENCE_RELEASE _WriteBarrier ()
138	#elif defined _WIN32
139	#include <WinNT.h>
140	#define ECB_MEMORY_FENCE MemoryBarrier () /* actually just xchg on x86... scary */
141	#elif __SUNPRO_C >= 0x5110 \|\| __SUNPRO_CC >= 0x5110
142	#include <mbarrier.h>
143	#define ECB_MEMORY_FENCE __machine_rw_barrier ()
144	#define ECB_MEMORY_FENCE_ACQUIRE __machine_r_barrier ()
145	#define ECB_MEMORY_FENCE_RELEASE __machine_w_barrier ()
146	#elif __xlC__
147	#define ECB_MEMORY_FENCE __sync ()
148	#endif
149	#endif
150
151	#ifndef ECB_MEMORY_FENCE
152	#if !ECB_AVOID_PTHREADS
153	/*
154	* if you get undefined symbol references to pthread_mutex_lock,
155	* or failure to find pthread.h, then you should implement
156	* the ECB_MEMORY_FENCE operations for your cpu/compiler
157	* OR provide pthread.h and link against the posix thread library
158	* of your system.
159	*/
160	#include <pthread.h>
161	#define ECB_NEEDS_PTHREADS 1
162	#define ECB_MEMORY_FENCE_NEEDS_PTHREADS 1
163
164	static pthread_mutex_t ecb_mf_lock = PTHREAD_MUTEX_INITIALIZER;
165	#define ECB_MEMORY_FENCE do { pthread_mutex_lock (&ecb_mf_lock); pthread_mutex_unlock (&ecb_mf_lock); } while (0)
166	#endif
167	#endif
168
169	#if !defined ECB_MEMORY_FENCE_ACQUIRE && defined ECB_MEMORY_FENCE
170	#define ECB_MEMORY_FENCE_ACQUIRE ECB_MEMORY_FENCE
171	#endif
172
173	#if !defined ECB_MEMORY_FENCE_RELEASE && defined ECB_MEMORY_FENCE
174	#define ECB_MEMORY_FENCE_RELEASE ECB_MEMORY_FENCE
175	#endif
176
177	/*****************************************************************************/
178
179	#define ECB_C99 (__STDC_VERSION__ >= 199901L)
180
181	#if __cplusplus
182	#define ecb_inline static inline
183	#elif ECB_GCC_VERSION(2,5)
184	#define ecb_inline static __inline__
185	#elif ECB_C99
186	#define ecb_inline static inline
187	#else
188	#define ecb_inline static
189	#endif
190
191	#if ECB_GCC_VERSION(3,3)
192	#define ecb_restrict __restrict__
193	#elif ECB_C99
194	#define ecb_restrict restrict
195	#else
196	#define ecb_restrict
197	#endif
198
199	typedef int ecb_bool;
200
201	#define ECB_CONCAT_(a, b) a ## b
202	#define ECB_CONCAT(a, b) ECB_CONCAT_(a, b)
203	#define ECB_STRINGIFY_(a) # a
204	#define ECB_STRINGIFY(a) ECB_STRINGIFY_(a)
205
206	#define ecb_function_ ecb_inline
207
208	#if ECB_GCC_VERSION(3,1)
209	#define ecb_attribute(attrlist) __attribute__(attrlist)
210	#define ecb_is_constant(expr) __builtin_constant_p (expr)
211	#define ecb_expect(expr,value) __builtin_expect ((expr),(value))
212	#define ecb_prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
213	#else
214	#define ecb_attribute(attrlist)
215	#define ecb_is_constant(expr) 0
216	#define ecb_expect(expr,value) (expr)
217	#define ecb_prefetch(addr,rw,locality)
218	#endif
219
220	/* no emulation for ecb_decltype */
221	#if ECB_GCC_VERSION(4,5)
222	#define ecb_decltype(x) __decltype(x)
223	#elif ECB_GCC_VERSION(3,0)
224	#define ecb_decltype(x) __typeof(x)
225	#endif
226
227	#define ecb_noinline ecb_attribute ((__noinline__))
228	#define ecb_noreturn ecb_attribute ((__noreturn__))
229	#define ecb_unused ecb_attribute ((__unused__))
230	#define ecb_const ecb_attribute ((__const__))
231	#define ecb_pure ecb_attribute ((__pure__))
232
233	#if ECB_GCC_VERSION(4,3)
234	#define ecb_artificial ecb_attribute ((__artificial__))
235	#define ecb_hot ecb_attribute ((__hot__))
236	#define ecb_cold ecb_attribute ((__cold__))
237	#else
238	#define ecb_artificial
239	#define ecb_hot
240	#define ecb_cold
241	#endif
242
243	/* put around conditional expressions if you are very sure that the */
244	/* expression is mostly true or mostly false. note that these return */
245	/* booleans, not the expression. */
246	#define ecb_expect_false(expr) ecb_expect (!!(expr), 0)
247	#define ecb_expect_true(expr) ecb_expect (!!(expr), 1)
248	/* for compatibility to the rest of the world */
249	#define ecb_likely(expr) ecb_expect_true (expr)
250	#define ecb_unlikely(expr) ecb_expect_false (expr)
251
252	/* count trailing zero bits and count # of one bits */
253	#if ECB_GCC_VERSION(3,4)
254	/* we assume int == 32 bit, long == 32 or 64 bit and long long == 64 bit */
255	#define ecb_ld32(x) (__builtin_clz (x) ^ 31)
256	#define ecb_ld64(x) (__builtin_clzll (x) ^ 63)
257	#define ecb_ctz32(x) __builtin_ctz (x)
258	#define ecb_ctz64(x) __builtin_ctzll (x)
259	#define ecb_popcount32(x) __builtin_popcount (x)
260	/* no popcountll */
261	#else
262	ecb_function_ int ecb_ctz32 (uint32_t x) ecb_const;
263	ecb_function_ int
264	ecb_ctz32 (uint32_t x)
265	{
266	int r = 0;
267
268	x &= ~x + 1; /* this isolates the lowest bit */
269
270	#if ECB_branchless_on_i386
271	r += !!(x & 0xaaaaaaaa) << 0;
272	r += !!(x & 0xcccccccc) << 1;
273	r += !!(x & 0xf0f0f0f0) << 2;
274	r += !!(x & 0xff00ff00) << 3;
275	r += !!(x & 0xffff0000) << 4;
276	#else
277	if (x & 0xaaaaaaaa) r += 1;
278	if (x & 0xcccccccc) r += 2;
279	if (x & 0xf0f0f0f0) r += 4;
280	if (x & 0xff00ff00) r += 8;
281	if (x & 0xffff0000) r += 16;
282	#endif
283
284	return r;
285	}
286
287	ecb_function_ int ecb_ctz64 (uint64_t x) ecb_const;
288	ecb_function_ int
289	ecb_ctz64 (uint64_t x)
290	{
291	int shift = x & 0xffffffffU ? 0 : 32;
292	return ecb_ctz32 (x >> shift) + shift;
293	}
294
295	ecb_function_ int ecb_popcount32 (uint32_t x) ecb_const;
296	ecb_function_ int
297	ecb_popcount32 (uint32_t x)
298	{
299	x -= (x >> 1) & 0x55555555;
300	x = ((x >> 2) & 0x33333333) + (x & 0x33333333);
301	x = ((x >> 4) + x) & 0x0f0f0f0f;
302	x *= 0x01010101;
303
304	return x >> 24;
305	}
306
307	ecb_function_ int ecb_ld32 (uint32_t x) ecb_const;
308	ecb_function_ int ecb_ld32 (uint32_t x)
309	{
310	int r = 0;
311
312	if (x >> 16) { x >>= 16; r += 16; }
313	if (x >> 8) { x >>= 8; r += 8; }
314	if (x >> 4) { x >>= 4; r += 4; }
315	if (x >> 2) { x >>= 2; r += 2; }
316	if (x >> 1) { r += 1; }
317
318	return r;
319	}
320
321	ecb_function_ int ecb_ld64 (uint64_t x) ecb_const;
322	ecb_function_ int ecb_ld64 (uint64_t x)
323	{
324	int r = 0;
325
326	if (x >> 32) { x >>= 32; r += 32; }
327
328	return r + ecb_ld32 (x);
329	}
330	#endif
331
332	ecb_function_ uint8_t ecb_bitrev8 (uint8_t x) ecb_const;
333	ecb_function_ uint8_t ecb_bitrev8 (uint8_t x)
334	{
335	return ( (x * 0x0802U & 0x22110U)
336	\| (x * 0x8020U & 0x88440U)) * 0x10101U >> 16;
337	}
338
339	ecb_function_ uint16_t ecb_bitrev16 (uint16_t x) ecb_const;
340	ecb_function_ uint16_t ecb_bitrev16 (uint16_t x)
341	{
342	x = ((x >> 1) & 0x5555) \| ((x & 0x5555) << 1);
343	x = ((x >> 2) & 0x3333) \| ((x & 0x3333) << 2);
344	x = ((x >> 4) & 0x0f0f) \| ((x & 0x0f0f) << 4);
345	x = ( x >> 8 ) \| ( x << 8);
346
347	return x;
348	}
349
350	ecb_function_ uint32_t ecb_bitrev32 (uint32_t x) ecb_const;
351	ecb_function_ uint32_t ecb_bitrev32 (uint32_t x)
352	{
353	x = ((x >> 1) & 0x55555555) \| ((x & 0x55555555) << 1);
354	x = ((x >> 2) & 0x33333333) \| ((x & 0x33333333) << 2);
355	x = ((x >> 4) & 0x0f0f0f0f) \| ((x & 0x0f0f0f0f) << 4);
356	x = ((x >> 8) & 0x00ff00ff) \| ((x & 0x00ff00ff) << 8);
357	x = ( x >> 16 ) \| ( x << 16);
358
359	return x;
360	}
361
362	/* popcount64 is only available on 64 bit cpus as gcc builtin */
363	/* so for this version we are lazy */
364	ecb_function_ int ecb_popcount64 (uint64_t x) ecb_const;
365	ecb_function_ int
366	ecb_popcount64 (uint64_t x)
367	{
368	return ecb_popcount32 (x) + ecb_popcount32 (x >> 32);
369	}
370
371	ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) ecb_const;
372	ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) ecb_const;
373	ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) ecb_const;
374	ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) ecb_const;
375	ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) ecb_const;
376	ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) ecb_const;
377	ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) ecb_const;
378	ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) ecb_const;
379
380	ecb_inline uint8_t ecb_rotl8 (uint8_t x, unsigned int count) { return (x >> ( 8 - count)) \| (x << count); }
381	ecb_inline uint8_t ecb_rotr8 (uint8_t x, unsigned int count) { return (x << ( 8 - count)) \| (x >> count); }
382	ecb_inline uint16_t ecb_rotl16 (uint16_t x, unsigned int count) { return (x >> (16 - count)) \| (x << count); }
383	ecb_inline uint16_t ecb_rotr16 (uint16_t x, unsigned int count) { return (x << (16 - count)) \| (x >> count); }
384	ecb_inline uint32_t ecb_rotl32 (uint32_t x, unsigned int count) { return (x >> (32 - count)) \| (x << count); }
385	ecb_inline uint32_t ecb_rotr32 (uint32_t x, unsigned int count) { return (x << (32 - count)) \| (x >> count); }
386	ecb_inline uint64_t ecb_rotl64 (uint64_t x, unsigned int count) { return (x >> (64 - count)) \| (x << count); }
387	ecb_inline uint64_t ecb_rotr64 (uint64_t x, unsigned int count) { return (x << (64 - count)) \| (x >> count); }
388
389	#if ECB_GCC_VERSION(4,3)
390	#define ecb_bswap16(x) (__builtin_bswap32 (x) >> 16)
391	#define ecb_bswap32(x) __builtin_bswap32 (x)
392	#define ecb_bswap64(x) __builtin_bswap64 (x)
393	#else
394	ecb_function_ uint16_t ecb_bswap16 (uint16_t x) ecb_const;
395	ecb_function_ uint16_t
396	ecb_bswap16 (uint16_t x)
397	{
398	return ecb_rotl16 (x, 8);
399	}
400
401	ecb_function_ uint32_t ecb_bswap32 (uint32_t x) ecb_const;
402	ecb_function_ uint32_t
403	ecb_bswap32 (uint32_t x)
404	{
405	return (((uint32_t)ecb_bswap16 (x)) << 16) \| ecb_bswap16 (x >> 16);
406	}
407
408	ecb_function_ uint64_t ecb_bswap64 (uint64_t x) ecb_const;
409	ecb_function_ uint64_t
410	ecb_bswap64 (uint64_t x)
411	{
412	return (((uint64_t)ecb_bswap32 (x)) << 32) \| ecb_bswap32 (x >> 32);
413	}
414	#endif
415
416	#if ECB_GCC_VERSION(4,5)
417	#define ecb_unreachable() __builtin_unreachable ()
418	#else
419	/* this seems to work fine, but gcc always emits a warning for it :/ */
420	ecb_inline void ecb_unreachable (void) ecb_noreturn;
421	ecb_inline void ecb_unreachable (void) { }
422	#endif
423
424	/* try to tell the compiler that some condition is definitely true */
425	#define ecb_assume(cond) do { if (!(cond)) ecb_unreachable (); } while (0)
426
427	ecb_inline unsigned char ecb_byteorder_helper (void) ecb_const;
428	ecb_inline unsigned char
429	ecb_byteorder_helper (void)
430	{
431	const uint32_t u = 0x11223344;
432	return (unsigned char )&u;
433	}
434
435	ecb_inline ecb_bool ecb_big_endian (void) ecb_const;
436	ecb_inline ecb_bool ecb_big_endian (void) { return ecb_byteorder_helper () == 0x11; }
437	ecb_inline ecb_bool ecb_little_endian (void) ecb_const;
438	ecb_inline ecb_bool ecb_little_endian (void) { return ecb_byteorder_helper () == 0x44; }
439
440	#if ECB_GCC_VERSION(3,0) \|\| ECB_C99
441	#define ecb_mod(m,n) ((m) % (n) + ((m) % (n) < 0 ? (n) : 0))
442	#else
443	#define ecb_mod(m,n) ((m) < 0 ? ((n) - 1 - ((-1 - (m)) % (n))) : ((m) % (n)))
444	#endif
445
446	#if __cplusplus
447	template<typename T>
448	static inline T ecb_div_rd (T val, T div)
449	{
450	return val < 0 ? - ((-val + div - 1) / div) : (val ) / div;
451	}
452	template<typename T>
453	static inline T ecb_div_ru (T val, T div)
454	{
455	return val < 0 ? - ((-val ) / div) : (val + div - 1) / div;
456	}
457	#else
458	#define ecb_div_rd(val,div) ((val) < 0 ? - ((-(val) + (div) - 1) / (div)) : ((val) ) / (div))
459	#define ecb_div_ru(val,div) ((val) < 0 ? - ((-(val) ) / (div)) : ((val) + (div) - 1) / (div))
460	#endif
461
462	#if ecb_cplusplus_does_not_suck
463	/* does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm) */
464	template<typename T, int N>
465	static inline int ecb_array_length (const T (&arr)[N])
466	{
467	return N;
468	}
469	#else
470	#define ecb_array_length(name) (sizeof (name) / sizeof (name [0]))
471	#endif
472
473	#endif
474