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