TakeV/dxx-rebirth
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
dxx-rebirth/common/misc/vg-wrap-physfs.h

63 lines
1.8 KiB
C
Raw Normal View History

Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
#include "dxxsconf.h"
Add PHYSFS_read wrapper support - Add wrappers for PHYSFS_read and its convenience functions. Poison the memory before calling PHYSFS, so that any uninitialized bytes (likely caused by a short read) are reported if the caller tries to access the value anyway. - Add SConstruct options to enable wrapping, so that users do not need to enumerate the wrapped functions manually. - Fix link failure when using LTO+wrappers.
2017-07-26 03:15:58 +00:00
#ifndef DXX_ENABLE_wrap_PHYSFS_read
#define DXX_ENABLE_wrap_PHYSFS_read DXX_HAVE_POISON_VALGRIND
#endif
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
#ifndef DXX_ENABLE_wrap_PHYSFS_write
#define DXX_ENABLE_wrap_PHYSFS_write DXX_HAVE_POISON_VALGRIND
#endif
Add PHYSFS_read wrapper support - Add wrappers for PHYSFS_read and its convenience functions. Poison the memory before calling PHYSFS, so that any uninitialized bytes (likely caused by a short read) are reported if the caller tries to access the value anyway. - Add SConstruct options to enable wrapping, so that users do not need to enumerate the wrapped functions manually. - Fix link failure when using LTO+wrappers.
2017-07-26 03:15:58 +00:00
#if DXX_ENABLE_wrap_PHYSFS_read || DXX_ENABLE_wrap_PHYSFS_write
Use ugly preprocessor hook hack to fix Clang build failure Clang rejects a declared (but never defined and never used) `static` function. Change the declaration to be the value of a macro that will be expanded only when the function is both defined and used. Reported-by: kreatordxx <https://github.com/dxx-rebirth/dxx-rebirth/issues/295> Fixes: 55822d0b4db827176a2e13d039ee3606efe7d279 ("Add wrappers for more precise Valgrind physfs diagnostics")
2017-01-07 19:09:04 +00:00
#include <physfs.h>
Fix pch=1 build PCH mode causes the Valgrind-wrapper header to be included in places it is not meant to be used, which leads to spurious compiler errors. PCH mode causes the Valgrind-wrapper __real_* stub functions to see the physfsx.h PHYSFS macros, which also causes errors. Fortunately, both cases can be easily fixed. Add preprocessor guards to the Valgrind-wrapper header to cause it to compile out when the PCH phase runs. It has no include guard, so it will be rescanned with the proper macros when the two consuming files are built normally. Modify the Valgrind-wrapper __real_* stub functions to use the standard macro avoidance trick so that they do not call the physfsx.h PHYSFS macros.
2017-01-31 04:25:06 +00:00
#ifdef DXX_VG_DECLARE_EXTERN_C
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
extern "C" {
Add PHYSFS_read wrapper support - Add wrappers for PHYSFS_read and its convenience functions. Poison the memory before calling PHYSFS, so that any uninitialized bytes (likely caused by a short read) are reported if the caller tries to access the value anyway. - Add SConstruct options to enable wrapping, so that users do not need to enumerate the wrapped functions manually. - Fix link failure when using LTO+wrappers.
2017-07-26 03:15:58 +00:00
#if DXX_ENABLE_wrap_PHYSFS_read
DXX_VG_DECLARE_EXTERN_C(PHYSFS_read);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_readSBE16);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_readSBE32);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_readSLE16);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_readSLE32);
#endif
#if DXX_ENABLE_wrap_PHYSFS_write
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
DXX_VG_DECLARE_EXTERN_C(PHYSFS_write);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_writeSBE16);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_writeSBE32);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_writeSLE16);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_writeSLE32);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_writeULE16);
DXX_VG_DECLARE_EXTERN_C(PHYSFS_writeULE32);
Add PHYSFS_read wrapper support - Add wrappers for PHYSFS_read and its convenience functions. Poison the memory before calling PHYSFS, so that any uninitialized bytes (likely caused by a short read) are reported if the caller tries to access the value anyway. - Add SConstruct options to enable wrapping, so that users do not need to enumerate the wrapped functions manually. - Fix link failure when using LTO+wrappers.
2017-07-26 03:15:58 +00:00
#endif
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
}
Fix pch=1 build PCH mode causes the Valgrind-wrapper header to be included in places it is not meant to be used, which leads to spurious compiler errors. PCH mode causes the Valgrind-wrapper __real_* stub functions to see the physfsx.h PHYSFS macros, which also causes errors. Fortunately, both cases can be easily fixed. Add preprocessor guards to the Valgrind-wrapper header to cause it to compile out when the PCH phase runs. It has no include guard, so it will be rescanned with the proper macros when the two consuming files are built normally. Modify the Valgrind-wrapper __real_* stub functions to use the standard macro avoidance trick so that they do not call the physfsx.h PHYSFS macros.
2017-01-31 04:25:06 +00:00
#endif
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
Add PHYSFS_read wrapper support - Add wrappers for PHYSFS_read and its convenience functions. Poison the memory before calling PHYSFS, so that any uninitialized bytes (likely caused by a short read) are reported if the caller tries to access the value anyway. - Add SConstruct options to enable wrapping, so that users do not need to enumerate the wrapped functions manually. - Fix link failure when using LTO+wrappers.
2017-07-26 03:15:58 +00:00
#if DXX_ENABLE_wrap_PHYSFS_read
#ifdef DXX_VG_DECLARE_READ_HELPER
DXX_VG_DECLARE_READ_HELPER;
#endif
#ifdef DXX_VG_DEFINE_READ
DXX_VG_DEFINE_READ(PHYSFS_readSBE16, PHYSFS_sint16);
DXX_VG_DEFINE_READ(PHYSFS_readSBE32, PHYSFS_sint32);
DXX_VG_DEFINE_READ(PHYSFS_readSLE16, PHYSFS_sint16);
DXX_VG_DEFINE_READ(PHYSFS_readSLE32, PHYSFS_sint32);
#endif
#endif
#if DXX_ENABLE_wrap_PHYSFS_write
Use ugly preprocessor hook hack to fix Clang build failure Clang rejects a declared (but never defined and never used) `static` function. Change the declaration to be the value of a macro that will be expanded only when the function is both defined and used. Reported-by: kreatordxx <https://github.com/dxx-rebirth/dxx-rebirth/issues/295> Fixes: 55822d0b4db827176a2e13d039ee3606efe7d279 ("Add wrappers for more precise Valgrind physfs diagnostics")
2017-01-07 19:09:04 +00:00
#ifdef DXX_VG_DECLARE_WRITE_HELPER
DXX_VG_DECLARE_WRITE_HELPER;
#endif
Fix pch=1 build PCH mode causes the Valgrind-wrapper header to be included in places it is not meant to be used, which leads to spurious compiler errors. PCH mode causes the Valgrind-wrapper __real_* stub functions to see the physfsx.h PHYSFS macros, which also causes errors. Fortunately, both cases can be easily fixed. Add preprocessor guards to the Valgrind-wrapper header to cause it to compile out when the PCH phase runs. It has no include guard, so it will be rescanned with the proper macros when the two consuming files are built normally. Modify the Valgrind-wrapper __real_* stub functions to use the standard macro avoidance trick so that they do not call the physfsx.h PHYSFS macros.
2017-01-31 04:25:06 +00:00
#ifdef DXX_VG_DEFINE_WRITE
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
DXX_VG_DEFINE_WRITE(PHYSFS_writeSBE16, PHYSFS_sint16);
DXX_VG_DEFINE_WRITE(PHYSFS_writeSBE32, PHYSFS_sint32);
DXX_VG_DEFINE_WRITE(PHYSFS_writeSLE16, PHYSFS_sint16);
DXX_VG_DEFINE_WRITE(PHYSFS_writeSLE32, PHYSFS_sint32);
DXX_VG_DEFINE_WRITE(PHYSFS_writeULE16, PHYSFS_uint16);
DXX_VG_DEFINE_WRITE(PHYSFS_writeULE32, PHYSFS_uint32);
Fix pch=1 build PCH mode causes the Valgrind-wrapper header to be included in places it is not meant to be used, which leads to spurious compiler errors. PCH mode causes the Valgrind-wrapper __real_* stub functions to see the physfsx.h PHYSFS macros, which also causes errors. Fortunately, both cases can be easily fixed. Add preprocessor guards to the Valgrind-wrapper header to cause it to compile out when the PCH phase runs. It has no include guard, so it will be rescanned with the proper macros when the two consuming files are built normally. Modify the Valgrind-wrapper __real_* stub functions to use the standard macro avoidance trick so that they do not call the physfsx.h PHYSFS macros.
2017-01-31 04:25:06 +00:00
#endif
Add PHYSFS_read wrapper support - Add wrappers for PHYSFS_read and its convenience functions. Poison the memory before calling PHYSFS, so that any uninitialized bytes (likely caused by a short read) are reported if the caller tries to access the value anyway. - Add SConstruct options to enable wrapping, so that users do not need to enumerate the wrapped functions manually. - Fix link failure when using LTO+wrappers.
2017-07-26 03:15:58 +00:00
#endif
Add wrappers for more precise Valgrind physfs diagnostics
2017-01-01 23:19:21 +00:00
#endif
Reference in a new issue Copy permalink