From 55704f2ba2a9ff6ca31b911a5154c0a72dabe1ff Mon Sep 17 00:00:00 2001 From: Alug Date: Wed, 23 Apr 2025 16:02:41 +0200 Subject: [PATCH] port RRs improved paranoia thinker/mobj prints https://git.srb2.org/KartKrew/RingRacers/-/commit/509a023329ea1cd583c500a3287c488e5ee3e3a6 https://git.srb2.org/KartKrew/RingRacers/-/commit/17aaf178d587970a3a845aa6c2f3807077996a77 --- src/d_think.h | 6 +++ src/p_mobj.c | 8 ++++ src/p_polyobj.c | 3 ++ src/p_tick.c | 123 ++++++++++++++++++++++++++++++++++++++++++------ src/p_tick.h | 14 +++++- 5 files changed, 139 insertions(+), 15 deletions(-) diff --git a/src/d_think.h b/src/d_think.h index 6b8ee113a..8177f464d 100644 --- a/src/d_think.h +++ b/src/d_think.h @@ -17,6 +17,8 @@ #ifndef __D_THINK__ #define __D_THINK__ +#include "doomdef.h" + #ifdef __GNUG__ #pragma interface #endif @@ -50,6 +52,10 @@ typedef struct thinker_s // this one using pointers. Used for garbage collection. INT32 references; boolean cachable; +#ifdef PARANOIA + INT32 debug_mobjtype; + tic_t debug_time; +#endif } thinker_t; #endif diff --git a/src/p_mobj.c b/src/p_mobj.c index 66d4493ca..fb34b335d 100644 --- a/src/p_mobj.c +++ b/src/p_mobj.c @@ -10132,6 +10132,10 @@ void P_RemoveMobj(mobj_t *mobj) { // Add thinker just to delay removing it until refrences are gone. mobj->flags &= ~MF_NOTHINK; P_AddThinker((thinker_t *)mobj); +#ifdef PARANOIA + // Saved to avoid being scrambled like below... + mobj->thinker.debug_mobjtype = mobj->type; +#endif #ifdef SCRAMBLE_REMOVED // Invalidate mobj_t data to cause crashes if accessed! memset((UINT8 *)mobj + sizeof(thinker_t), 0xff, sizeof(mobj_t) - sizeof(thinker_t)); @@ -10141,6 +10145,10 @@ void P_RemoveMobj(mobj_t *mobj) } else { +#ifdef PARANOIA + // Saved to avoid being scrambled like below... + mobj->thinker.debug_mobjtype = mobj->type; +#endif #ifdef SCRAMBLE_REMOVED // Invalidate mobj_t data to cause crashes if accessed! memset((UINT8 *)mobj + sizeof(thinker_t), 0xff, sizeof(mobj_t) - sizeof(thinker_t)); diff --git a/src/p_polyobj.c b/src/p_polyobj.c index 61c08a05d..629595068 100644 --- a/src/p_polyobj.c +++ b/src/p_polyobj.c @@ -156,6 +156,9 @@ FUNCINLINE static ATTRINLINE void PolyObj_AddThinker(thinker_t *th) th->references = 0; th->cachable = false; // not initialising this made the mobjcache die thx! +#ifdef PARANOIA + th->debug_mobjtype = MT_NULL; +#endif } static void FreeSideLists(void) diff --git a/src/p_tick.c b/src/p_tick.c index 91f40c623..986708767 100644 --- a/src/p_tick.c +++ b/src/p_tick.c @@ -11,6 +11,10 @@ /// \file p_tick.c /// \brief Archiving: SaveGame I/O, Thinker, Ticker +#ifdef PARANOIA +#include "dehacked.h" // MOBJTYPE_LIST +#endif + #include "doomstat.h" #include "g_game.h" #include "g_input.h" @@ -204,6 +208,9 @@ void P_AddThinker(thinker_t *thinker) thinker->references = 0; // killough 11/98: init reference counter to 0 thinker->cachable = (thinker->function.acp1 == (actionf_p1)P_MobjThinker); +#ifdef PARANOIA + thinker->debug_mobjtype = MT_NULL; +#endif } // @@ -220,8 +227,48 @@ void P_AddPrecipThinker(thinker_t *thinker) thinker->references = 0; // killough 11/98: init reference counter to 0 thinker->cachable = false; +#ifdef PARANOIA + thinker->debug_mobjtype = MT_NULL; +#endif } +#ifdef PARANOIA +static const char *MobjTypeName(const mobj_t *mobj) +{ + actionf_p1 p1 = mobj->thinker.function.acp1; + + if (p1 == (actionf_p1)P_MobjThinker) + { + return MOBJTYPE_LIST[mobj->type]; + } + else if (p1 == (actionf_p1)P_RemoveThinkerDelayed) + { + if (mobj->thinker.debug_mobjtype != MT_NULL) + { + return MOBJTYPE_LIST[mobj->thinker.debug_mobjtype]; + } + } + + return ""; +} + +static const char *MobjThinkerName(const mobj_t *mobj) +{ + actionf_p1 p1 = mobj->thinker.function.acp1; + + if (p1 == (actionf_p1)P_MobjThinker) + { + return "P_MobjThinker"; + } + else if (p1 == (actionf_p1)P_RemoveThinkerDelayed) + { + return "P_RemoveThinkerDelayed"; + } + + return ""; +} +#endif + // // killough 11/98: // @@ -242,20 +289,35 @@ static thinker_t *currentthinker; // void P_RemoveThinkerDelayed(thinker_t *thinker) { -#ifdef PARANOIA -#define BEENAROUNDBIT (0x40000000) // has to be sufficiently high that it's unlikely to happen in regular gameplay. If you change this, pay attention to the bit pattern of INT32_MIN. - if (thinker->references & ~BEENAROUNDBIT) + if (thinker->references != 0) { - if (thinker->references & BEENAROUNDBIT) // Usually gets cleared up in one frame; what's going on here, then? - CONS_Printf("Number of potentially faulty references: %d\n", (thinker->references & ~BEENAROUNDBIT)); - thinker->references |= BEENAROUNDBIT; +#ifdef PARANOIA + // Removed mobjs can be the target of another mobj. In + // that case, the other mobj will manage its reference + // to the removed mobj in P_MobjThinker. However, if + // the removed mobj is removed after the other object + // thinks, the reference management is delayed by one + // tic (or two?) + const UINT8 delay = 2; + + if (thinker->debug_time > leveltime) + { + thinker->debug_time = leveltime + delay + 1; // do not print errors again + } + else if ((thinker->debug_time + delay) <= leveltime) + { + CONS_Printf( + "PARANOIA/P_RemoveThinkerDelayed: %p %s references=%d\n", + (void*)thinker, + MobjTypeName((mobj_t*)thinker), + thinker->references + ); + + thinker->debug_time = leveltime + delay + 1; // do not print this error again + } +#endif return; } -#undef BEENAROUNDBIT -#else - if (thinker->references != 0) - return; -#endif /* Remove from main thinker list */ thinker_t *next = thinker->next; @@ -333,12 +395,45 @@ void P_RemoveThinker(thinker_t *thinker) * references, and delay removal until the count is 0. */ -mobj_t *P_SetTarget(mobj_t **mop, mobj_t *targ) +mobj_t *P_SetTarget2(mobj_t **mop, mobj_t *targ +#ifdef PARANOIA + , const char *source_file, int source_line +#endif +) { - if (*mop) // If there was a target already, decrease its refcount + if (*mop) // If there was a target already, decrease its refcount + { (*mop)->thinker.references--; - if ((*mop = targ) != NULL) // Set new target and if non-NULL, increase its counter + +#ifdef PARANOIA + if ((*mop)->thinker.references < 0) + { + CONS_Printf( + "PARANOIA/P_SetTarget: %p %s %s references=%d, references go negative! (%s:%d)\n", + (void*)*mop, + MobjTypeName(*mop), + MobjThinkerName(*mop), + (*mop)->thinker.references, + source_file, + source_line + ); + } + + (*mop)->thinker.debug_time = leveltime; +#endif + } + + if (targ != NULL) // Set new target and if non-NULL, increase its counter + { targ->thinker.references++; + +#ifdef PARANOIA + targ->thinker.debug_time = leveltime; +#endif + } + + *mop = targ; + return targ; } diff --git a/src/p_tick.h b/src/p_tick.h index 11b5889ed..a903be0fd 100644 --- a/src/p_tick.h +++ b/src/p_tick.h @@ -14,6 +14,8 @@ #ifndef __P_TICK__ #define __P_TICK__ +#include "doomdef.h" + #ifdef __GNUG__ #pragma interface #endif @@ -29,6 +31,16 @@ void P_Ticker(boolean run); void P_PreTicker(INT32 frames); void P_DoTeamscrambling(void); void P_RemoveThinkerDelayed(thinker_t *thinker); -mobj_t *P_SetTarget(mobj_t **mo, mobj_t *target); // killough 11/98 +mobj_t *P_SetTarget2(mobj_t **mo, mobj_t *target +#ifdef PARANOIA +, const char *source_file, int source_line +#endif +); + +#ifdef PARANOIA +#define P_SetTarget(...) P_SetTarget2(__VA_ARGS__, __FILE__, __LINE__) +#else +#define P_SetTarget P_SetTarget2 +#endif #endif