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#ifdef __cplusplus
 10#define CXX_GUARD_START extern "C" {
 11#define CXX_GUARD_END }
 12#else
 13#define CXX_GUARD_START
 14#define CXX_GUARD_END
 15#endif
 16
 17CXX_GUARD_START
 18
 19#include <ctype.h>
 20#include <fcntl.h>
 21#include <inttypes.h>
 22#include <limits.h>
 23#include <math.h>
 24#include <stdarg.h>
 25#include <stdbool.h>
 26#include <stddef.h>
 27#include <stdint.h>
 28#include <stdio.h>
 29#include <stdlib.h>
 30#include <string.h>
 31#include <time.h>
 32
 33#ifdef _WIN32
 34// WinSock2 gets very angry if it's included too late
 35#include <winsock2.h>
 36#endif
 37
 38#if defined(_MSC_VER) || defined(__cplusplus)
 39#define restrict __restrict
 40#endif
 41
 42#ifdef _MSC_VER
 43#include <Windows.h>
 44#include <sys/types.h>
 45typedef intptr_t ssize_t;
 46#define PATH_MAX MAX_PATH
 47#define strcasecmp _stricmp
 48#define strncasecmp _strnicmp
 49#define ftruncate _chsize
 50#define snprintf _snprintf
 51#define strdup _strdup
 52#define lseek _lseek
 53#define O_ACCMODE (O_RDONLY|O_WRONLY|O_RDWR)
 54#elif defined(__wii__)
 55#include <sys/time.h>
 56typedef intptr_t ssize_t;
 57#else
 58#include <strings.h>
 59#include <unistd.h>
 60#include <sys/time.h>
 61#endif
 62
 63#ifdef PSP2
 64// For PATH_MAX on modern toolchains
 65#include <sys/syslimits.h>
 66#endif
 67
 68#ifndef SSIZE_MAX
 69#define SSIZE_MAX ((ssize_t) (SIZE_MAX >> 1))
 70#endif
 71
 72#ifndef UNUSED
 73#define UNUSED(V) (void)(V)
 74#endif
 75
 76#ifndef M_PI
 77#define M_PI 3.141592654f
 78#endif
 79
 80#if !defined(_MSC_VER) && (defined(__llvm__) || (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7))
 81#define ATOMIC_STORE(DST, SRC) __atomic_store_n(&DST, SRC, __ATOMIC_RELEASE)
 82#define ATOMIC_LOAD(DST, SRC) DST = __atomic_load_n(&SRC, __ATOMIC_ACQUIRE)
 83#define ATOMIC_ADD(DST, OP) __atomic_add_fetch(&DST, OP, __ATOMIC_RELEASE)
 84#define ATOMIC_OR(DST, OP) __atomic_or_fetch(&DST, OP, __ATOMIC_RELEASE)
 85#define ATOMIC_AND(DST, OP) __atomic_and_fetch(&DST, OP, __ATOMIC_RELEASE)
 86#define ATOMIC_CMPXCHG(DST, EXPECTED, SRC) __atomic_compare_exchange_n(&DST, &EXPECTED, SRC, true,__ATOMIC_ACQ_REL, __ATOMIC_ACQUIRE)
 87#else
 88// TODO
 89#define ATOMIC_STORE(DST, SRC) DST = SRC
 90#define ATOMIC_LOAD(DST, SRC) DST = SRC
 91#define ATOMIC_ADD(DST, OP) DST += OP
 92#define ATOMIC_OR(DST, OP) DST |= OP
 93#define ATOMIC_AND(DST, OP) DST &= OP
 94#define ATOMIC_CMPXCHG(DST, EXPECTED, OP) ((DST == EXPECTED) ? ((DST = OP), true) : false)
 95#endif
 96
 97#if defined(_3DS) || defined(GEKKO) || defined(PSP2)
 98// newlib doesn't support %z properly by default
 99#define PRIz ""
100#elif defined(_WIN64)
101#define PRIz "ll"
102#elif defined(_WIN32)
103#define PRIz ""
104#else
105#define PRIz "z"
106#endif
107
108#if defined __BIG_ENDIAN__
109#define LOAD_32BE(DEST, ADDR, ARR) DEST = *(uint32_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
110#if defined(__PPC__) || defined(__POWERPC__)
111#define LOAD_32LE(DEST, ADDR, ARR) { \
112	uint32_t _addr = (ADDR); \
113	const void* _ptr = (ARR); \
114	__asm__("lwbrx %0, %1, %2" : "=r"(DEST) : "b"(_ptr), "r"(_addr)); \
115}
116
117#define LOAD_16LE(DEST, ADDR, ARR) { \
118	uint32_t _addr = (ADDR); \
119	const void* _ptr = (ARR); \
120	__asm__("lhbrx %0, %1, %2" : "=r"(DEST) : "b"(_ptr), "r"(_addr)); \
121}
122
123#define STORE_32LE(SRC, ADDR, ARR) { \
124	uint32_t _addr = (ADDR); \
125	void* _ptr = (ARR); \
126	__asm__("stwbrx %0, %1, %2" : : "r"(SRC), "b"(_ptr), "r"(_addr) : "memory"); \
127}
128
129#define STORE_16LE(SRC, ADDR, ARR) { \
130	uint32_t _addr = (ADDR); \
131	void* _ptr = (ARR); \
132	__asm__("sthbrx %0, %1, %2" : : "r"(SRC), "b"(_ptr), "r"(_addr) : "memory"); \
133}
134
135#define LOAD_64LE(DEST, ADDR, ARR) { \
136	uint32_t _addr = (ADDR); \
137	union { \
138		struct { \
139			uint32_t hi; \
140			uint32_t lo; \
141		}; \
142		uint64_t b64; \
143	} bswap; \
144	const void* _ptr = (ARR); \
145	__asm__( \
146		"lwbrx %0, %2, %3 \n" \
147		"lwbrx %1, %2, %4 \n" \
148		: "=&r"(bswap.lo), "=&r"(bswap.hi) : "b"(_ptr), "r"(_addr), "r"(_addr + 4)) ; \
149	DEST = bswap.b64; \
150}
151
152#define STORE_64LE(SRC, ADDR, ARR) { \
153	uint32_t _addr = (ADDR); \
154	union { \
155		struct { \
156			uint32_t hi; \
157			uint32_t lo; \
158		}; \
159		uint64_t b64; \
160	} bswap = { .b64 = SRC }; \
161	const void* _ptr = (ARR); \
162	__asm__( \
163		"stwbrx %0, %2, %3 \n" \
164		"stwbrx %1, %2, %4 \n" \
165		: : "r"(bswap.hi), "r"(bswap.lo), "b"(_ptr), "r"(_addr), "r"(_addr + 4) : "memory"); \
166}
167
168#elif defined(__llvm__) || (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)
169#define LOAD_64LE(DEST, ADDR, ARR) DEST = __builtin_bswap64(((uint64_t*) ARR)[(ADDR) >> 3])
170#define LOAD_32LE(DEST, ADDR, ARR) DEST = __builtin_bswap32(((uint32_t*) ARR)[(ADDR) >> 2])
171#define LOAD_16LE(DEST, ADDR, ARR) DEST = __builtin_bswap16(((uint16_t*) ARR)[(ADDR) >> 1])
172#define STORE_64LE(SRC, ADDR, ARR) ((uint64_t*) ARR)[(ADDR) >> 3] = __builtin_bswap64(SRC)
173#define STORE_32LE(SRC, ADDR, ARR) ((uint32_t*) ARR)[(ADDR) >> 2] = __builtin_bswap32(SRC)
174#define STORE_16LE(SRC, ADDR, ARR) ((uint16_t*) ARR)[(ADDR) >> 1] = __builtin_bswap16(SRC)
175#else
176#error Big endian build not supported on this platform.
177#endif
178#else
179#define LOAD_64LE(DEST, ADDR, ARR) DEST = *(uint64_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
180#define LOAD_32LE(DEST, ADDR, ARR) DEST = *(uint32_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
181#define LOAD_16LE(DEST, ADDR, ARR) DEST = *(uint16_t*) ((uintptr_t) (ARR) + (size_t) (ADDR))
182#define STORE_64LE(SRC, ADDR, ARR) *(uint64_t*) ((uintptr_t) (ARR) + (size_t) (ADDR)) = SRC
183#define STORE_32LE(SRC, ADDR, ARR) *(uint32_t*) ((uintptr_t) (ARR) + (size_t) (ADDR)) = SRC
184#define STORE_16LE(SRC, ADDR, ARR) *(uint16_t*) ((uintptr_t) (ARR) + (size_t) (ADDR)) = SRC
185#ifdef _MSC_VER
186#define LOAD_32BE(DEST, ADDR, ARR) DEST = _byteswap_ulong(((uint32_t*) ARR)[(ADDR) >> 2])
187#else
188#define LOAD_32BE(DEST, ADDR, ARR) DEST = __builtin_bswap32(((uint32_t*) ARR)[(ADDR) >> 2])
189#endif
190#endif
191
192#define MAKE_MASK(START, END) (((1 << ((END) - (START))) - 1) << (START))
193#define CHECK_BITS(SRC, START, END) ((SRC) & MAKE_MASK(START, END))
194#define EXT_BITS(SRC, START, END) (((SRC) >> (START)) & ((1 << ((END) - (START))) - 1))
195#define INS_BITS(SRC, START, END, BITS) (CLEAR_BITS(SRC, START, END) | (((BITS) << (START)) & MAKE_MASK(START, END)))
196#define CLEAR_BITS(SRC, START, END) ((SRC) & ~MAKE_MASK(START, END))
197#define FILL_BITS(SRC, START, END) ((SRC) | MAKE_MASK(START, END))
198#define TEST_FILL_BITS(SRC, START, END, TEST) ((TEST) ? (FILL_BITS(SRC, START, END)) : (CLEAR_BITS(SRC, START, END)))
199
200#ifdef _MSC_VER
201#pragma section(".CRT$XCU",read)
202#define ATTRIBUTE_UNUSED
203#define ATTRIBUTE_FORMAT(X, Y, Z)
204#define ATTRIBUTE_NOINLINE
205// Adapted from https://stackoverflow.com/a/2390626
206#define _CONSTRUCTOR(FN, PRE) \
207    static void FN(void); \
208    __declspec(allocate(".CRT$XCU")) void (*_CONSTRUCTOR_ ## FN)(void) = FN; \
209    __pragma(comment(linker,"/include:" PRE "_CONSTRUCTOR_" #FN)) \
210    static void FN(void)
211#ifdef _WIN64
212#define CONSTRUCTOR(FN) _CONSTRUCTOR(FN, "")
213#else
214#define CONSTRUCTOR(FN) _CONSTRUCTOR(FN, "_")
215#endif
216#else
217#define ATTRIBUTE_UNUSED __attribute__((unused))
218#define ATTRIBUTE_FORMAT(X, Y, Z) __attribute__((format(X, Y, Z)))
219#define ATTRIBUTE_NOINLINE __attribute__((noinline))
220#define CONSTRUCTOR(FN) static __attribute__((constructor)) void FN(void)
221#endif
222
223#define DECL_BITFIELD(NAME, TYPE) typedef TYPE NAME
224
225#define DECL_BITS(TYPE, FIELD, START, SIZE) \
226	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Is ## FIELD (TYPE src) { \
227		return CHECK_BITS(src, (START), (START) + (SIZE)); \
228	} \
229	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Get ## FIELD (TYPE src) { \
230		return EXT_BITS(src, (START), (START) + (SIZE)); \
231	} \
232	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Clear ## FIELD (TYPE src) { \
233		return CLEAR_BITS(src, (START), (START) + (SIZE)); \
234	} \
235	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Fill ## FIELD (TYPE src) { \
236		return FILL_BITS(src, (START), (START) + (SIZE)); \
237	} \
238	ATTRIBUTE_UNUSED static inline TYPE TYPE ## Set ## FIELD (TYPE src, TYPE bits) { \
239		return INS_BITS(src, (START), (START) + (SIZE), bits); \
240	} \
241	ATTRIBUTE_UNUSED static inline TYPE TYPE ## TestFill ## FIELD (TYPE src, bool test) { \
242		return TEST_FILL_BITS(src, (START), (START) + (SIZE), test); \
243	}
244
245#define DECL_BIT(TYPE, FIELD, BIT) DECL_BITS(TYPE, FIELD, BIT, 1)
246
247#ifndef _MSC_VER
248#define LIKELY(X) __builtin_expect(!!(X), 1)
249#define UNLIKELY(X) __builtin_expect(!!(X), 0)
250#else
251#define LIKELY(X) (!!(X))
252#define UNLIKELY(X) (!!(X))
253#endif
254
255#define ROR(I, ROTATE) ((((uint32_t) (I)) >> ROTATE) | ((uint32_t) (I) << ((-ROTATE) & 31)))
256
257CXX_GUARD_END
258
259#endif