1/* Copyright (c) 2013-2014 Jeffrey Pfau
  2 *
  3 * This Source Code Form is subject to the terms of the Mozilla Public
  4 * License, v. 2.0. If a copy of the MPL was not distributed with this
  5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  6#ifndef COMMON_H
  7#define COMMON_H
  8
  9#include <ctype.h>
 10#include <fcntl.h>
 11#include <inttypes.h>
 12#include <limits.h>
 13#include <math.h>
 14#include <stdarg.h>
 15#include <stdbool.h>
 16#include <stddef.h>
 17#include <stdint.h>
 18#include <stdio.h>
 19#include <stdlib.h>
 20#include <string.h>
 21
 22#ifdef _WIN32
 23// WinSock2 gets very angry if it's included too late
 24#include <winsock2.h>
 25#endif
 26#ifdef _MSC_VER
 27#include <Windows.h>
 28#include <sys/types.h>
 29typedef intptr_t ssize_t;
 30#define PATH_MAX MAX_PATH
 31#define restrict __restrict
 32#define strcasecmp _stricmp
 33#define strncasecmp _strnicmp
 34#define ftruncate _chsize
 35#define snprintf _snprintf
 36#define strdup _strdup
 37#define lseek _lseek
 38#elif defined(__wii__)
 39typedef intptr_t ssize_t;
 40#else
 41#include <strings.h>
 42#include <unistd.h>
 43#endif
 44
 45#ifndef SSIZE_MAX
 46#define SSIZE_MAX ((ssize_t) (SIZE_MAX >> 1))
 47#endif
 48
 49#define UNUSED(V) (void)(V)
 50
 51#ifndef M_PI
 52#define M_PI 3.141592654f
 53#endif
 54
 55#ifndef _MSC_VER
 56#define ATOMIC_STORE(DST, SRC) __atomic_store_n(&DST, SRC, __ATOMIC_RELEASE)
 57#define ATOMIC_LOAD(DST, SRC) DST = __atomic_load_n(&SRC, __ATOMIC_ACQUIRE)
 58#define ATOMIC_ADD(DST, OP) __atomic_add_fetch(&DST, OP, __ATOMIC_RELEASE)
 59#define ATOMIC_OR(DST, OP) __atomic_or_fetch(&DST, OP, __ATOMIC_RELEASE)
 60#define ATOMIC_AND(DST, OP) __atomic_and_fetch(&DST, OP, __ATOMIC_RELEASE)
 61#define ATOMIC_CMPXCHG(DST, EXPECTED, SRC) __atomic_compare_exchange_n(&DST, &EXPECTED, SRC, true,__ATOMIC_ACQ_REL, __ATOMIC_ACQUIRE)
 62#else
 63// TODO
 64#define ATOMIC_STORE(DST, SRC) DST = SRC
 65#define ATOMIC_LOAD(DST, SRC) DST = SRC
 66#define ATOMIC_ADD(DST, OP) DST += OP
 67#define ATOMIC_OR(DST, OP) DST |= OP
 68#define ATOMIC_AND(DST, OP) DST &= OP
 69#define ATOMIC_CMPXCHG(DST, EXPECTED, OP) ((DST == EXPECTED) ? ((DST = OP), true) : false)
 70#endif
 71
 72#if defined(__PPC__) || defined(__POWERPC__)
 73#define LOAD_32LE(DEST, ADDR, ARR) { \
 74	uint32_t _addr = (ADDR); \
 75	const void* _ptr = (ARR); \
 76	__asm__("lwbrx %0, %1, %2" : "=r"(DEST) : "b"(_ptr), "r"(_addr)); \
 77}
 78
 79#define LOAD_16LE(DEST, ADDR, ARR) { \
 80	uint32_t _addr = (ADDR); \
 81	const void* _ptr = (ARR); \
 82	__asm__("lhbrx %0, %1, %2" : "=r"(DEST) : "b"(_ptr), "r"(_addr)); \
 83}
 84
 85#define STORE_32LE(SRC, ADDR, ARR) { \
 86	uint32_t _addr = (ADDR); \
 87	void* _ptr = (ARR); \
 88	__asm__("stwbrx %0, %1, %2" : : "r"(SRC), "b"(_ptr), "r"(_addr)); \
 89}
 90
 91#define STORE_16LE(SRC, ADDR, ARR) { \
 92	uint32_t _addr = (ADDR); \
 93	void* _ptr = (ARR); \
 94	__asm__("sthbrx %0, %1, %2" : : "r"(SRC), "b"(_ptr), "r"(_addr)); \
 95}
 96
 97#define LOAD_64LE(DEST, ADDR, ARR) DEST = __builtin_bswap64(((uint64_t*) ARR)[(ADDR) >> 3])
 98#define STORE_64LE(SRC, ADDR, ARR) ((uint64_t*) ARR)[(ADDR) >> 3] = __builtin_bswap64(SRC)
 99#elif defined __BIG_ENDIAN__
100#if defined(__llvm__) || (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
101#define LOAD_64LE(DEST, ADDR, ARR) DEST = __builtin_bswap64(((uint64_t*) ARR)[(ADDR) >> 3])
102#define LOAD_32LE(DEST, ADDR, ARR) DEST = __builtin_bswap32(((uint32_t*) ARR)[(ADDR) >> 2])
103#define LOAD_16LE(DEST, ADDR, ARR) DEST = __builtin_bswap16(((uint16_t*) ARR)[(ADDR) >> 1])
104#define STORE_64LE(SRC, ADDR, ARR) ((uint64_t*) ARR)[(ADDR) >> 3] = __builtin_bswap64(SRC)
105#define STORE_32LE(SRC, ADDR, ARR) ((uint32_t*) ARR)[(ADDR) >> 2] = __builtin_bswap32(SRC)
106#define STORE_16LE(SRC, ADDR, ARR) ((uint16_t*) ARR)[(ADDR) >> 1] = __builtin_bswap16(SRC)
107#else
108#error Big endian build not supported on this platform.
109#endif
110#else
111#define LOAD_64LE(DEST, ADDR, ARR) DEST = *(uint64_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
112#define LOAD_32LE(DEST, ADDR, ARR) DEST = *(uint32_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
113#define LOAD_16LE(DEST, ADDR, ARR) DEST = *(uint16_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
114#define STORE_64LE(SRC, ADDR, ARR) *(uint64_t*) ((uintptr_t) (ARR) + (size_t) (ADDR)) = SRC
115#define STORE_32LE(SRC, ADDR, ARR) *(uint32_t*) ((uintptr_t) (ARR) + (size_t) (ADDR)) = SRC
116#define STORE_16LE(SRC, ADDR, ARR) *(uint16_t*) ((uintptr_t) (ARR) + (size_t) (ADDR)) = SRC
117#endif
118
119#define MAKE_MASK(START, END) (((1 << ((END) - (START))) - 1) << (START))
120#define CHECK_BITS(SRC, START, END) ((SRC) & MAKE_MASK(START, END))
121#define EXT_BITS(SRC, START, END) (((SRC) >> (START)) & ((1 << ((END) - (START))) - 1))
122#define INS_BITS(SRC, START, END, BITS) (CLEAR_BITS(SRC, START, END) | (((BITS) << (START)) & MAKE_MASK(START, END)))
123#define CLEAR_BITS(SRC, START, END) ((SRC) & ~MAKE_MASK(START, END))
124#define FILL_BITS(SRC, START, END) ((SRC) | MAKE_MASK(START, END))
125#define TEST_FILL_BITS(SRC, START, END, TEST) ((TEST) ? (FILL_BITS(SRC, START, END)) : (CLEAR_BITS(SRC, START, END)))
126
127#ifdef _MSC_VER
128#define ATTRIBUTE_UNUSED
129#define ATTRIBUTE_FORMAT(X, Y, Z)
130#else
131#define ATTRIBUTE_UNUSED __attribute__((unused))
132#define ATTRIBUTE_FORMAT(X, Y, Z) __attribute__((format(X, Y, Z)))
133#endif
134
135#define DECL_BITFIELD(NAME, TYPE) typedef TYPE NAME
136
137#define DECL_BITS(TYPE, FIELD, START, SIZE) \
138	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Is ## FIELD (TYPE src) { \
139		return CHECK_BITS(src, (START), (START) + (SIZE)); \
140	} \
141	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Get ## FIELD (TYPE src) { \
142		return EXT_BITS(src, (START), (START) + (SIZE)); \
143	} \
144	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Clear ## FIELD (TYPE src) { \
145		return CLEAR_BITS(src, (START), (START) + (SIZE)); \
146	} \
147	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Fill ## FIELD (TYPE src) { \
148		return FILL_BITS(src, (START), (START) + (SIZE)); \
149	} \
150	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Set ## FIELD (TYPE src, TYPE bits) { \
151		return INS_BITS(src, (START), (START) + (SIZE), bits); \
152	} \
153	ATTRIBUTE_UNUSED static inline TYPE TYPE ## TestFill ## FIELD (TYPE src, bool test) { \
154		return TEST_FILL_BITS(src, (START), (START) + (SIZE), test); \
155	}
156
157#define DECL_BIT(TYPE, FIELD, BIT) DECL_BITS(TYPE, FIELD, BIT, 1)
158
159#ifndef _MSC_VER
160#define LIKELY(X) __builtin_expect(!!(X), 1)
161#define UNLIKELY(X) __builtin_expect(!!(X), 0)
162#else
163#define LIKELY(X) (!!(X))
164#define UNLIKELY(X) (!!(X))
165#endif
166
167#define ROR(I, ROTATE) ((((uint32_t) (I)) >> ROTATE) | ((uint32_t) (I) << ((-ROTATE) & 31)))
168
169#endif