q_platform.h

/*
===========================================================================
Copyright (C) 1999-2005 Id Software, Inc.
 
This file is part of Quake III Arena source code.
 
Quake III Arena source code is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the License,
or (at your option) any later version.
 
Quake III Arena source code is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with Quake III Arena source code; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
===========================================================================
*/
 
#ifndef __Q_PLATFORM_H
#define __Q_PLATFORM_H
 
// this is for determining if we have an asm version of a C function
#define idx64 0
#define C_ONLY
 
#ifdef Q3_VM
 
#define id386 0
#define idppc 0
#define idppc_altivec 0
#define idsparc 0
 
#else
 
#if (defined _M_IX86 || defined __i386__) && !defined(C_ONLY)
#define id386 1
#else
#define id386 0
#endif
 
#if (defined(powerc) || defined(powerpc) || defined(ppc) || \
    defined(__ppc) || defined(__ppc__)) && !defined(C_ONLY)
#define idppc 1
#if defined(__VEC__)
#define idppc_altivec 1
#ifdef __APPLE__  // Apple's GCC does this differently than the FSF.
#define VECCONST_UINT8(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) \
    (vector unsigned char) (a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)
#else
#define VECCONST_UINT8(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p) \
    (vector unsigned char) {a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p}
#endif
#else
#define idppc_altivec 0
#endif
#else
#define idppc 0
#define idppc_altivec 0
#endif
 
#if defined(__sparc__) && !defined(C_ONLY)
#define idsparc 1
#else
#define idsparc 0
#endif
 
#endif
 
// for windows fastcall option
#define QDECL
#define QCALL
 
#define MAC_STATIC
 
//================================================================= WIN64/32 ===
 
#if defined(_DEBUG)
#define DLL_SUFFIX "-dbg"
#else
#define DLL_SUFFIX
#endif
 
#if defined(TARGET_LOCAL_SYSTEM)
#  define ARCH_SUFFIX
#elif defined(TARGET_MULTIPLE_ARCHITECTURES)
// Targeting multiple architecture in a single binary.
// For example, OSX supports compiling multiple architectures in a single binary
#  define ARCH_SUFFIX ".multiarch"
#else
#  define ARCH_SUFFIX "." ARCH_STRING
#endif
 
// alloca
#ifdef _MSC_VER
#  include <malloc.h>
#elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
#  include <stdlib.h>
#else
#  include <alloca.h>
#endif
 
#if defined(_WIN64) || defined(__WIN64__)
 
#undef idx64
#define idx64 1
 
#undef QDECL
#define QDECL __cdecl
 
#undef QCALL
#define QCALL __stdcall
 
#if defined( _MSC_VER )
#define OS_STRING "win_msvc64"
#elif defined __MINGW64__
#define OS_STRING "win_mingw64"
#endif
 
#define ID_INLINE __inline
#define PATH_SEP '\\'
 
#if defined(__x86_64) || defined(__x86_64__) || defined(__amd64) || defined(_M_X64)
#  define ARCH_STRING "x86_64"
#elif defined(__aarch64__) || defined(__ARM64__) || defined (_M_ARM64)
#  define ARCH_STRING "arm64"
#elif defined _M_ALPHA
#  define ARCH_STRING "AXP"
#endif
 
#define Q3_LITTLE_ENDIAN
 
#define DLL_EXT ".dll"
#define EXE_EXT ".exe"
 
#elif defined(_WIN32) || defined(__WIN32__)
 
#undef QDECL
#define QDECL __cdecl
 
#undef QCALL
#define QCALL __stdcall
 
#if defined( _MSC_VER )
#define OS_STRING "win_msvc"
#elif defined __MINGW32__
#define OS_STRING "win_mingw"
#endif
 
#define ID_INLINE __inline
#define PATH_SEP '\\'
 
#if defined( _M_IX86 ) || defined( __i386__ )
#define ARCH_STRING "x86"
#endif
 
#define Q3_LITTLE_ENDIAN
 
#define DLL_EXT ".dll"
#define EXE_EXT ".exe"
 
#endif
 
//============================================================== MAC OS X ===
 
#if defined(MACOS_X) || defined(__APPLE_CC__)
 
// make sure this is defined, just for sanity's sake...
#ifndef MACOS_X
#define MACOS_X
#endif
 
#define OS_STRING "macosx"
#define ID_INLINE inline
#define PATH_SEP '/'
 
#ifdef __ppc__
#  define ARCH_STRING "ppc"
#  define Q3_BIG_ENDIAN
#elif defined __i386__
#  define ARCH_STRING "i386"
#  define Q3_LITTLE_ENDIAN
#endif
 
#define DLL_EXT ".dylib"
#define EXE_EXT ""
 
#endif
 
//================================================================= LINUX ===
 
#ifdef __linux__
 
#ifndef _LINUX
#define _LINUX
#endif
 
#include <stdint.h>
#include <endian.h>
 
#define OS_STRING "linux"
#define ID_INLINE inline
#define PATH_SEP '/'
 
#if defined(__i386) || defined(__i386__) || defined(_M_IX86)
#  define ARCH_STRING "x86"
#elif defined(__x86_64) || defined(__x86_64__) || defined(__amd64) || defined(_M_X64)
#  define ARCH_STRING "x86_64"
#elif defined(__PPC64__) || defined(__ppc64__) || defined(__powerpc64__) || defined(_ARCH_PPC64)
#  if __BIG_ENDIAN__
#    define ARCH_STRING "ppc64"
#  else
#    define ARCH_STRING "ppc64el"
#  endif
#elif defined(__ppc__) || defined(__ppc) || defined(__powerpc__)
#  define ARCH_STRING "ppc"
#elif defined __s390__
#  define ARCH_STRING "s390"
#elif defined __s390x__
#  define ARCH_STRING "s390x"
#elif defined __ia64__
#  define ARCH_STRING "ia64"
#elif defined __e2k__
#  define ARCH_STRING "e2k"
#elif defined __alpha__
#  define ARCH_STRING "alpha"
#elif defined __sparc__
#  define ARCH_STRING "sparc"
#elif defined(__aarch64__) || defined(__ARM64__) || defined(_M_ARM64)
#  define ARCH_STRING "arm64"
#elif defined __arm__ || defined (_M_ARM)
#  if defined(__ARM_PCS_VFP) && (__ARM_PCS_VFP)
#    define ARCH_STRING "armhf"
#  else
#    define ARCH_STRING "armel"
#  endif
#elif defined __cris__
#  define ARCH_STRING "cris"
#elif defined __hppa__
#  define ARCH_STRING "hppa"
#elif defined __mips__
#  define ARCH_STRING "mips"
#elif defined __sh__
#  define ARCH_STRING "sh"
#elif defined __riscv
#  if __UINTPTR_MAX__ == __UINT64_MAX__
#    define ARCH_STRING "riscv64"
#  else
#    define ARCH_STRING "riscv"
#  endif
#endif
 
#if __BIG_ENDIAN__
#  define Q3_BIG_ENDIAN
#else
#  define Q3_LITTLE_ENDIAN
#endif
 
#define DLL_EXT ".so"
#define EXE_EXT ""
 
#endif
 
//================================================================ MAC OS ===
 
#if defined(__APPLE__) || defined(__APPLE_CC__)
 
#define OS_STRING "macosx"
#define ID_INLINE inline
#define PATH_SEP '/'
 
#ifdef __ppc__
#  define ARCH_STRING "ppc"
#  define Q3_BIG_ENDIAN
#elif defined __i386__
#  define ARCH_STRING "x86"
#  define Q3_LITTLE_ENDIAN
#elif defined __x86_64__
#  undef idx64
#  define idx64 1
#  define ARCH_STRING "x86_64"
#  define Q3_LITTLE_ENDIAN
#elif defined __aarch64__
#  define ARCH_STRING "arm64"
#  define Q3_LITTLE_ENDIAN
#endif
 
#define DLL_EXT ".dylib"
#define EXE_EXT ""
 
#endif
 
//=================================================================== BSD ===
 
#if defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
 
#include <sys/types.h>
#include <machine/endian.h>
 
#if defined(__FreeBSD__)
#define OS_STRING "freebsd"
#elif defined(__OpenBSD__)
#define OS_STRING "openbsd"
#elif defined(__NetBSD__)
#define OS_STRING "netbsd"
#endif
 
#define ID_INLINE inline
#define PATH_SEP '/'
 
#if defined(__i386__) || defined(__i386)
#define ARCH_STRING "x86"
#elif defined(__amd64__) || defined(__x86_64__)
#define ARCH_STRING "x86_64"
#elif defined(__arm__)
#define ARCH_STRING "arm"
#elif defined(__aarch64__)
#define ARCH_STRING "arm64"
#elif defined(__powerpc__) || defined(__ppc__)
#define ARCH_STRING "ppc"
#elif defined(__powerpc64__)
#define ARCH_STRING "ppc64"
#elif defined(__sparc64__)
#define ARCH_STRING "sparc64"
#elif defined(__mips__)
#define ARCH_STRING "mips"
#elif defined(__riscv)
#if __SIZEOF_POINTER__ == 8
#define ARCH_STRING "riscv64"
#else
#define ARCH_STRING "riscv"
#endif
#else
#define ARCH_STRING "unknown"
#endif
 
#if BYTE_ORDER == BIG_ENDIAN
#define Q3_BIG_ENDIAN
#else
#define Q3_LITTLE_ENDIAN
#endif
 
#define DLL_EXT ".so"
#define EXE_EXT ""
 
#endif
 
//================================================================= SUNOS ===
 
#ifdef __sun
 
#include <stdint.h>
#include <sys/byteorder.h>
 
#define OS_STRING "solaris"
#define ID_INLINE inline
#define PATH_SEP '/'
 
#ifdef __i386__
#define ARCH_STRING "i386"
#elif defined __sparc
#define ARCH_STRING "sparc"
#endif
 
#if defined( _BIG_ENDIAN )
#define Q3_BIG_ENDIAN
#elif defined( _LITTLE_ENDIAN )
#define Q3_LITTLE_ENDIAN
#endif
 
#define DLL_EXT ".so"
#define EXE_EXT ""
 
#endif
 
//================================================================== IRIX ===
 
#ifdef __sgi
 
#define OS_STRING "irix"
#define ID_INLINE __inline
#define PATH_SEP '/'
 
#define ARCH_STRING "mips"
 
#define Q3_BIG_ENDIAN // SGI's MIPS are always big endian
 
#define DLL_EXT ".so"
#define EXE_EXT ""
 
#endif
 
//============================================================ EMSCRIPTEN ===
 
#ifdef __EMSCRIPTEN__
 
#define OS_STRING "emscripten"
#define ID_INLINE inline
#define PATH_SEP '/'
 
#define ARCH_STRING "wasm32"
 
#define Q3_LITTLE_ENDIAN
 
#define DLL_EXT ".wasm"
 
#endif
 
//================================================================== Q3VM ===
 
#ifdef Q3_VM
 
#define OS_STRING "q3vm"
#define ID_INLINE
#define PATH_SEP '/'
 
#define ARCH_STRING "bytecode"
 
#define DLL_EXT ".qvm"
 
#endif
 
//===========================================================================
 
// Catch missing defines in above blocks
 
#ifndef OS_STRING
#error "Operating system not supported"
#endif
 
#ifndef ARCH_STRING
// ARCH_STRING is (mostly) only used for informational purposes, so we allow
// it to be undefined so that more diverse architectures may be compiled
#define ARCH_STRING "unknown"
#endif
 
#ifndef ID_INLINE
#error "ID_INLINE not defined"
#endif
 
#ifndef PATH_SEP
#error "PATH_SEP not defined"
#endif
 
#ifndef DLL_EXT
#error "DLL_EXT not defined"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
//endianness
void CopyShortSwap(void* dest, const void* src);
void CopyLongSwap(void* dest, const void* src);
short ShortSwap(short l);
unsigned short UnsignedShortSwap(unsigned short l);
int LongSwap(int l);
unsigned int UnsignedLongSwap(unsigned int l);
float FloatSwap(const float* f);
short ShortSwapPtr(const void* l);
int LongSwapPtr(const void* l);
short ShortNoSwapPtr(const void* l);
int LongNoSwapPtr(const void* l);
float FloatSwapPtr(const void* l);
float FloatNoSwapPtr(const void* l);
void SwapValue(void* dest, size_t size);
 
#ifdef __cplusplus
}
#endif
 
#if defined( Q3_BIG_ENDIAN ) && defined( Q3_LITTLE_ENDIAN )
#error "Endianness defined as both big and little"
#elif defined( Q3_BIG_ENDIAN )
 
#define CopyLittleShort(dest, src) CopyShortSwap(dest, src)
#define CopyLittleLong(dest, src) CopyLongSwap(dest, src)
 
//
// Those Little*Ptr are used to avoid alignment problems
//
 
#define LittleShort(x) ShortSwap(x)
#define LittleUnsignedShort(x) UnsignedShortSwap(x)
#define LittleLong(x) LongSwap(x)
#define LittleUnsignedLong(x) UnsignedLongSwap(x)
#define LittleFloat(x) FloatSwap(&x)
#define LittleShortPtr(x) ShortSwapPtr(&x)
#define LittleLongPtr(x) LongSwapPtr(&x)
#define LittleFloatPtr(x) FloatSwapPtr(&x)
#define LittleSwap(x, size) SwapValue(x, size)
 
#define BigShort
#define BigLong
#define BigFloat
#define BigShortPtr(x) ShortNoSwapPtr(&x)
#define BigLongPtr(x) LongNoSwapPtr(&x)
#define BigSwap(x, size)
 
#elif defined( Q3_LITTLE_ENDIAN )
 
#define CopyLittleShort(dest, src) Com_Memcpy(dest, src, 2)
#define CopyLittleLong(dest, src) Com_Memcpy(dest, src, 4)
 
#define LittleShort
#define LittleUnsignedShort
#define LittleLong
#define LittleFloat
#define LittleShortPtr(x) ShortNoSwapPtr(&x)
#define LittleLongPtr(x) LongNoSwapPtr(&x)
#define LittleFloatPtr(x) FloatNoSwapPtr(&x)
#define LittleSwap(x, size)
 
#define BigShort(x) ShortSwap(x)
#define BigUnsignedShort(x) UnsignedShortSwap(x)
#define BigLong(x) LongSwap(x)
#define BigUnsignedLong(x) UnsignedLongSwap(x)
#define BigFloat(x) FloatSwap(&x)
#define BigShortPtr(x) ShortSwapPtr(&x)
#define BigLongPtr(x) LongSwapPtr(&x)
#define BigSwap(x, size) SwapValue(x, size)
 
#else
#error "Endianness not defined"
#endif
 
//platform string
#ifdef NDEBUG
#define PLATFORM_STRING OS_STRING "-" ARCH_STRING
#else
#define PLATFORM_STRING OS_STRING "-" ARCH_STRING "-debug"
#endif
 
#endif