mirror of
https://github.com/brues-code/ClassicAPI.git
synced 2026-11-14 07:00:37 +00:00
Brues
c5b1431073
Sets the cvar most people already set by hand, so a fresh install does not meet the interface memory popup. Only the default is overridden: the write happens when the live value still equals the cvar's registered value (read from +0x30, so no hardcoded 49152), which leaves a deliberate Config.wtf choice alone. The archive flag makes the 0 persist, so the comparison fails on every later boot and the write happens once per install. What the cvar gates, since none of it is obvious: FUN_00495590 polls Lua's live allocation (KB) against it, forces a full GC when over, and if still over fires MEMORY_EXHAUSTED and starts a 15-second timer, after which FUN_00401560(0) exits the process. FrameXML shows the event as the "disable some interface add-ons and restart" popup. The poll is gated on `limit > 0`, so 0 disables it, and nothing else caps Lua memory (lmemPool's allocator is six size classes falling through to the Storm heap, with no ceiling of its own). Timing is load-bearing: scriptMemory is writable on the glue state and read-only in the world, where the innermost setter's `if (flags & 4) return;` makes any write a silent no-op. The glue registration is what makes this land; the in-game one stays as a second chance. Verified by deleting the Config.wtf line, launching, and finding 0 in the AddOns dialog and back in Config.wtf on exit. Adds CVar::Factory::GetDefaultString for the comparison.
110 lines
5.2 KiB
C++
110 lines
5.2 KiB
C++
// This file is part of ClassicAPI.
|
|
//
|
|
// ClassicAPI 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.
|
|
//
|
|
// ClassicAPI 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
|
|
// ClassicAPI. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
// `CVar::ScriptMemory` — turn the interface memory watchdog off by default.
|
|
//
|
|
// The engine polls Lua's live allocation against the `scriptMemory` cvar
|
|
// (KB; registered with default "49152", so 48 MB) in `FUN_00495590`:
|
|
//
|
|
// limit = *(int *)(scriptMemoryCVar + 0x28); // parsed-int cache
|
|
// if (enabled && limit > 0) {
|
|
// if (luaKB() > limit) ForceFullGC();
|
|
// if (luaKB() > limit) {
|
|
// if (!deadline) { deadline = now + 15000;
|
|
// Fire(MEMORY_EXHAUSTED, "%d", mb); }
|
|
// else if (now >= deadline) Quit(); // FUN_00401560(0)
|
|
// } else if (deadline) { deadline = 0; Fire(MEMORY_RECOVERED); }
|
|
// }
|
|
//
|
|
// FrameXML turns MEMORY_EXHAUSTED into the "disable some interface add-ons
|
|
// and restart" popup, and 15 seconds later the client EXITS. So the cap is
|
|
// not advisory: it ends the session.
|
|
//
|
|
// 48 MB was a reasonable budget for the addons of the day and is not one for
|
|
// a modern set, so the popup and the shutdown land on people whose addons
|
|
// are working correctly. The gate is `limit > 0`, so writing 0 disables the
|
|
// poll outright — the value Blizzard's own AddOns dialog at character select
|
|
// lets a user type, via `SetScriptMemory` (which multiplies by 1024;
|
|
// verified `SHL EAX,0xa` at 0x0046DA8D).
|
|
//
|
|
// Nothing else caps Lua memory. `lmemPool.cpp`'s allocator (`FUN_006FAE90`)
|
|
// is six size classes that fall through to the Storm heap for anything
|
|
// larger, with no ceiling of its own; its "not enough memory" is a genuine
|
|
// allocation failure. So 0 hands the bound to the process address space
|
|
// (this client is Large Address Aware) rather than to a number picked in
|
|
// 2006 — the engine's real limit instead of an invented one.
|
|
//
|
|
// TIMING IS THE WHOLE TRICK. The cvar becomes READ-ONLY partway through boot:
|
|
// in the world, `SetCVar("scriptMemory", "49152")` raises `"scriptMemory" is
|
|
// read only` and `GetCVarInfo` reports `isReadOnly`, which is bit
|
|
// `CVAR_FLAG_READ_ONLY` at `+0x1C` — and the innermost setter
|
|
// (`FUN_0063E0B0`) opens with `if (flags & 4) return;`, so a write then is a
|
|
// silent no-op. But the bit is NOT set yet on the glue state, where the write
|
|
// below lands: verified in game by deleting the Config.wtf line, launching,
|
|
// and finding 0 in the AddOns dialog and back in Config.wtf on exit.
|
|
//
|
|
// The bit is not set at registration either: the disassembly at `0x00402E24`
|
|
// pushes flags 0 and registerConsole 0, so the registrar computes
|
|
// `0 | 1 | 0x80000000`, and nothing in the binary ORs bit 2 into a cvar's
|
|
// flags. Something between the glue screen and the world sets it; the
|
|
// mechanism is still unidentified. Practical consequence: this must keep
|
|
// running from the GLUE registration. Do not "simplify" it to the in-game
|
|
// hook alone — the write would silently stop working, and the in-game hook
|
|
// stays only as a second chance for a boot that somehow skips glue.
|
|
//
|
|
// We override the DEFAULT ONLY: if the live value differs from the value the
|
|
// cvar was registered with, someone chose it and we leave it alone. The cvar
|
|
// carries the archive flag, so our 0 persists to Config.wtf and the
|
|
// comparison then fails on every later boot — the write happens once per
|
|
// install, not once per session. The one false positive is a user who puts
|
|
// exactly the default in Config.wtf, which reads as untouched; recovering the
|
|
// watchdog means choosing any other value.
|
|
//
|
|
// Runs from both the glue and in-game registration flows. Cvar storage is
|
|
// process-global and the write is idempotent by construction (afterwards the
|
|
// value no longer equals the default), so whichever fires first wins and the
|
|
// other is a no-op. Glue fires earliest, which also means the AddOns dialog
|
|
// shows 0 rather than 48 on a first launch.
|
|
|
|
#include "cvar/Factory.h"
|
|
|
|
#include "Game.h"
|
|
|
|
#include <cstring>
|
|
|
|
namespace CVar::ScriptMemory {
|
|
|
|
namespace {
|
|
|
|
constexpr const char *kCVarName = "scriptMemory";
|
|
|
|
void ApplyDefaultOverride() {
|
|
Factory::Handle cvar = Factory::Find(kCVarName);
|
|
if (cvar == nullptr)
|
|
return; // registered at boot by the engine; absent only if that moved
|
|
const char *value = Factory::GetString(cvar);
|
|
const char *fallback = Factory::GetDefaultString(cvar);
|
|
if (value == nullptr || fallback == nullptr)
|
|
return;
|
|
if (std::strcmp(value, fallback) != 0)
|
|
return; // deliberately set — the user's choice stands
|
|
Factory::SetInt(cvar, 0); // lands on the glue state; see the timing note
|
|
}
|
|
|
|
const Game::ModuleAutoRegister _autoreg{&ApplyDefaultOverride};
|
|
const Game::GlueModuleAutoRegister _glueAutoreg{&ApplyDefaultOverride};
|
|
|
|
} // namespace
|
|
|
|
} // namespace CVar::ScriptMemory
|