From cedda158136f533cbcc6fc755962af249a015190 Mon Sep 17 00:00:00 2001 From: Alibek Omarov Date: Wed, 1 May 2024 17:06:54 +0300 Subject: [PATCH] Basic Xash3D support (#71) Use Xash3D physics interface as an alternative linkent method --- metamod/CMakeLists.txt | 5 +- metamod/include/engine/physint.h | 173 ++++++++++++++++++++++++++++ metamod/src/dllapi.cpp | 27 +++++ metamod/src/linkent.h | 3 + metamod/src/osdep_linkent_linux.cpp | 18 ++- metamod/src/osdep_linkent_win32.cpp | 5 + metamod/src/precompiled.h | 1 + 7 files changed, 229 insertions(+), 3 deletions(-) create mode 100644 metamod/include/engine/physint.h diff --git a/metamod/CMakeLists.txt b/metamod/CMakeLists.txt index 18d46fc..a58ab1e 100644 --- a/metamod/CMakeLists.txt +++ b/metamod/CMakeLists.txt @@ -35,7 +35,7 @@ set(CMAKE_SHARED_LIBRARY_CXX_FLAGS "") set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "") set(COMPILE_FLAGS "-m32 -U_FORTIFY_SOURCE") -set(LINK_FLAGS "-m32 -s") +set(LINK_FLAGS "-m32") set(COMPILE_FLAGS "${COMPILE_FLAGS} -Wall -fno-exceptions -fno-builtin -Wno-unknown-pragmas") @@ -43,9 +43,10 @@ set(COMPILE_FLAGS "${COMPILE_FLAGS} -Wall -fno-exceptions -fno-builtin -Wno-unkn set(COMPILE_FLAGS "${COMPILE_FLAGS} -ffunction-sections -fdata-sections") if (DEBUG) - set(COMPILE_FLAGS "${COMPILE_FLAGS} -g3 -O3 -ggdb") + set(COMPILE_FLAGS "${COMPILE_FLAGS} -g3 -O0 -ggdb") else() set(COMPILE_FLAGS "${COMPILE_FLAGS} -g0 -O3 -fno-stack-protector") + set(LINK_FLAGS "${LINK_FLAGS} -s") endif() # Check Intel C++ compiler diff --git a/metamod/include/engine/physint.h b/metamod/include/engine/physint.h new file mode 100644 index 0000000..d5baeea --- /dev/null +++ b/metamod/include/engine/physint.h @@ -0,0 +1,173 @@ +/* +physint.h - Server Physics Interface +Copyright (C) 2011 Uncle Mike + +This program 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 3 of the License, or +(at your option) any later version. + +This program 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. +*/ + +#ifndef PHYSINT_H +#define PHYSINT_H + +#include "eiface.h" // offsetof + +#define SV_PHYSICS_INTERFACE_VERSION 6 + +#define STRUCT_FROM_LINK( l, t, m ) ((t *)((byte *)l - offsetof(t, m))) +#define EDICT_FROM_AREA( l ) STRUCT_FROM_LINK( l, edict_t, area ) + +// values that can be returned with pfnServerState +#define SERVER_DEAD 0 +#define SERVER_LOADING 1 +#define SERVER_ACTIVE 2 + +// LUMP reading errors +#define LUMP_LOAD_OK 0 +#define LUMP_LOAD_COULDNT_OPEN 1 +#define LUMP_LOAD_BAD_HEADER 2 +#define LUMP_LOAD_BAD_VERSION 3 +#define LUMP_LOAD_NO_EXTRADATA 4 +#define LUMP_LOAD_INVALID_NUM 5 +#define LUMP_LOAD_NOT_EXIST 6 +#define LUMP_LOAD_MEM_FAILED 7 +#define LUMP_LOAD_CORRUPTED 8 + +// LUMP saving errors +#define LUMP_SAVE_OK 0 +#define LUMP_SAVE_COULDNT_OPEN 1 +#define LUMP_SAVE_BAD_HEADER 2 +#define LUMP_SAVE_BAD_VERSION 3 +#define LUMP_SAVE_NO_EXTRADATA 4 +#define LUMP_SAVE_INVALID_NUM 5 +#define LUMP_SAVE_ALREADY_EXIST 6 +#define LUMP_SAVE_NO_DATA 7 +#define LUMP_SAVE_CORRUPTED 8 + +#ifndef ALLOC_CHECK +#define ALLOC_CHECK( x ) +#endif + +typedef struct areanode_s +{ + int axis; // -1 = leaf node + float dist; + struct areanode_s *children[2]; + link_t trigger_edicts; + link_t solid_edicts; + link_t portal_edicts; +} areanode_t; + +typedef struct server_physics_api_s +{ + // unlink edict from old position and link onto new + void ( *pfnLinkEdict) ( edict_t *ent, qboolean touch_triggers ); + double ( *pfnGetServerTime )( void ); // unclamped + double ( *pfnGetFrameTime )( void ); // unclamped + void* ( *pfnGetModel )( int modelindex ); + areanode_t* ( *pfnGetHeadnode )( void ); // AABB tree for all physic entities + int ( *pfnServerState )( void ); + void ( *pfnHost_Error )( const char *error, ... ); // cause Host Error +// ONLY ADD NEW FUNCTIONS TO THE END OF THIS STRUCT. INTERFACE VERSION IS FROZEN AT 6 + struct triangleapi_s *pTriAPI; // draw coliisions etc. Only for local system + + // draw debug messages (must be called from DrawOrthoTriangles). Only for local system + int ( *pfnDrawConsoleString )( int x, int y, char *string ); + void ( *pfnDrawSetTextColor )( float r, float g, float b ); + void ( *pfnDrawConsoleStringLen )( const char *string, int *length, int *height ); + void ( *Con_NPrintf )( int pos, const char *fmt, ... ); + void ( *Con_NXPrintf )( struct con_nprint_s *info, const char *fmt, ... ); + const char *( *pfnGetLightStyle )( int style ); // read custom appreance for selected lightstyle + void ( *pfnUpdateFogSettings )( unsigned int packed_fog ); + char **(*pfnGetFilesList)( const char *pattern, int *numFiles, int gamedironly ); + struct msurface_s *(*pfnTraceSurface)( edict_t *pTextureEntity, const float *v1, const float *v2 ); + const byte *(*pfnGetTextureData)( unsigned int texnum ); + + // static allocations + void *(*pfnMemAlloc)( size_t cb, const char *filename, const int fileline ) ALLOC_CHECK( 1 ); + void (*pfnMemFree)( void *mem, const char *filename, const int fileline ); + + // trace & contents + int (*pfnMaskPointContents)( const float *pos, int groupmask ); + trace_t (*pfnTrace)( const float *p0, float *mins, float *maxs, const float *p1, int type, edict_t *e ); + trace_t (*pfnTraceNoEnts)( const float *p0, float *mins, float *maxs, const float *p1, int type, edict_t *e ); + int (*pfnBoxInPVS)( const float *org, const float *boxmins, const float *boxmaxs ); + + // message handler (missed function to write raw bytes) + void (*pfnWriteBytes)( const byte *bytes, int count ); + + // BSP lump management + int (*pfnCheckLump)( const char *filename, const int lump, int *lumpsize ); + int (*pfnReadLump)( const char *filename, const int lump, void **lumpdata, int *lumpsize ); + int (*pfnSaveLump)( const char *filename, const int lump, void *lumpdata, int lumpsize ); + + // FS tools + int (*pfnSaveFile)( const char *filename, const void *data, int len ); + const byte *(*pfnLoadImagePixels)( const char *filename, int *width, int *height ); + + const char *(*pfnGetModelName)( int modelindex ); + + // FWGS extension + void *(*pfnGetNativeObject)( const char *object ); +} server_physics_api_t; + +// physic callbacks +typedef struct physics_interface_s +{ + int version; + // passed through pfnCreate (0 is attempt to create, -1 is reject) + int ( *SV_CreateEntity )( edict_t *pent, const char *szName ); + // run custom physics for each entity (return 0 to use built-in engine physic) + int ( *SV_PhysicsEntity )( edict_t *pEntity ); + // spawn entities with internal mod function e.g. for re-arrange spawn order (0 - use engine parser, 1 - use mod parser) + int ( *SV_LoadEntities )( const char *mapname, char *entities ); + // update conveyor belt for clients + void ( *SV_UpdatePlayerBaseVelocity )( edict_t *ent ); + // The game .dll should return 1 if save game should be allowed + int ( *SV_AllowSaveGame )( void ); +// ONLY ADD NEW FUNCTIONS TO THE END OF THIS STRUCT. INTERFACE VERSION IS FROZEN AT 6 + // override trigger area checking and touching + int ( *SV_TriggerTouch )( edict_t *pent, edict_t *trigger ); + // some engine features can be enabled only through this function + unsigned int ( *SV_CheckFeatures )( void ); + // used for draw debug collisions for custom physic engine etc + void ( *DrawDebugTriangles )( void ); + // used for draw debug overlay (textured) + void ( *DrawNormalTriangles )( void ); + // used for draw debug messages (2d mode) + void ( *DrawOrthoTriangles )( void ); + // tracing entities with SOLID_CUSTOM mode on a server (not used by pmove code) + void ( *ClipMoveToEntity)( edict_t *ent, const float *start, float *mins, float *maxs, const float *end, trace_t *trace ); + // tracing entities with SOLID_CUSTOM mode on a server (only used by pmove code) + void ( *ClipPMoveToEntity)( struct physent_s *pe, const float *start, float *mins, float *maxs, const float *end, struct pmtrace_s *tr ); + // called at end the frame of SV_Physics call + void ( *SV_EndFrame )( void ); + // obsolete + void (*pfnPrepWorldFrame)( void ); + // called through save\restore process + void (*pfnCreateEntitiesInRestoreList)( SAVERESTOREDATA *pSaveData, int levelMask, qboolean create_world ); + // allocate custom string (e.g. using user implementation of stringtable, not engine strings) + string_t (*pfnAllocString)( const char *szValue ); + // make custom string (e.g. using user implementation of stringtable, not engine strings) + string_t (*pfnMakeString)( const char *szValue ); + // read custom string (e.g. using user implementation of stringtable, not engine strings) + const char* (*pfnGetString)( string_t iString ); + // helper for restore custom decals that have custom message (e.g. Paranoia) + int (*pfnRestoreDecal)( struct decallist_s *entry, edict_t *pEdict, qboolean adjacent ); + // handle custom trigger touching for player + void (*PM_PlayerTouch)( struct playermove_s *ppmove, edict_t *client ); + // alloc or destroy model custom data (called only for dedicated servers, otherwise using an client version) + void (*Mod_ProcessUserData)( struct model_s *mod, qboolean create, const byte *buffer ); + // select BSP-hull for trace with specified mins\maxs + void *(*SV_HullForBsp)( edict_t *ent, const float *mins, const float *maxs, float *offset ); + // handle player custom think function + int (*SV_PlayerThink)( edict_t *ent, float frametime, double time ); +} physics_interface_t; + +#endif//PHYSINT_H diff --git a/metamod/src/dllapi.cpp b/metamod/src/dllapi.cpp index ea3bc80..e18bc87 100644 --- a/metamod/src/dllapi.cpp +++ b/metamod/src/dllapi.cpp @@ -221,6 +221,33 @@ C_DLLEXPORT int GetNewDLLFunctions(NEW_DLL_FUNCTIONS *pNewFunctionTable, int *in return TRUE; } +C_DLLEXPORT int Server_GetPhysicsInterface(int iVersion, server_physics_api_t *pfuncsFromEngine, physics_interface_t *pFunctionTable) +{ + // TODO: provide physint to plugins + if (iVersion != SV_PHYSICS_INTERFACE_VERSION || pfuncsFromEngine == nullptr || pFunctionTable == nullptr) + return FALSE; + + + // we have linkent alternative, shutdown linkent replacement + meta_shutdown_linkent_replacement(); + + // engine always require for nullptr, only replace single function needed for linkent alternative + Q_memset(pFunctionTable, 0, sizeof(*pFunctionTable)); + pFunctionTable->SV_CreateEntity = [](edict_t *pent, const char *szName) + { + // check if gamedll implements this entity + ENTITY_FN SpawnEdict = reinterpret_cast(g_GameDLL.sys_module.getsym(szName)); + + // should we check metamod module itself? engine will do GPA on metamod module before failing back to this call anyway + if( !SpawnEdict ) + return -1; // failed + + SpawnEdict( &pent->v ); + return 0; // handled + }; + return TRUE; +} + void compile_dllfunc_callbacks() { jitdata_t jitdata; diff --git a/metamod/src/linkent.h b/metamod/src/linkent.h index 76bc64c..aee0cac 100644 --- a/metamod/src/linkent.h +++ b/metamod/src/linkent.h @@ -39,6 +39,9 @@ // Initializes replacement code bool meta_init_linkent_replacement(CSysModule *moduleMetamod, CSysModule *moduleGame); +// Remove replacement code if new linkent mechanism was found +void meta_shutdown_linkent_replacement(); + // Comments from SDK dlls/util.h: //! This is the glue that hooks .MAP entity class names to our CPP classes. //! The _declspec forces them to be exported by name so we can do a lookup with GetProcAddress(). diff --git a/metamod/src/osdep_linkent_linux.cpp b/metamod/src/osdep_linkent_linux.cpp index 76dbadc..d706f5f 100644 --- a/metamod/src/osdep_linkent_linux.cpp +++ b/metamod/src/osdep_linkent_linux.cpp @@ -60,6 +60,8 @@ static unsigned char dlsym_old_bytes[BYTES_SIZE]; // Mutex for our protection static pthread_mutex_t mutex_replacement_dlsym = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP; +static int is_original_restored; + // constructs new jmp forwarder inline void construct_jmp_instruction(void *x, void *place, void *target) { @@ -105,7 +107,6 @@ static void *__replacement_dlsym(void *module, const char *funcname) // these are needed in case dlsym calls dlsym, default one doesn't do // it but some LD_PRELOADed library that hooks dlsym might actually // do so. - static int is_original_restored = 0; int was_original_restored = is_original_restored; // Lock before modifing original dlsym @@ -215,3 +216,18 @@ bool meta_init_linkent_replacement(CSysModule *moduleMetamod, CSysModule *module // done return true; } + +void meta_shutdown_linkent_replacement() +{ + // Lock before modifing original dlsym + pthread_mutex_lock(&mutex_replacement_dlsym); + + // restore old dlsym + if (!is_original_restored) + { + restore_original_dlsym(); + is_original_restored = 1; + } + + pthread_mutex_unlock(&mutex_replacement_dlsym); +} diff --git a/metamod/src/osdep_linkent_win32.cpp b/metamod/src/osdep_linkent_win32.cpp index fa9f52a..0479a9c 100644 --- a/metamod/src/osdep_linkent_win32.cpp +++ b/metamod/src/osdep_linkent_win32.cpp @@ -244,3 +244,8 @@ bool meta_init_linkent_replacement(CSysModule *moduleMetamod, CSysModule *module { return combine_module_export_tables(moduleMetamod, moduleGame); } + +void meta_shutdown_linkent_replacement() +{ + // no-op +} diff --git a/metamod/src/precompiled.h b/metamod/src/precompiled.h index 8087677..70821a3 100644 --- a/metamod/src/precompiled.h +++ b/metamod/src/precompiled.h @@ -53,6 +53,7 @@ #include "mem_utils.h" #include "callback_jit.h" #include "meta_rehlds_api.h" +#include "physint.h" #undef CreateInterface #include "linkent.h"