mirror of
https://github.com/1dot13/source.git
synced 2026-08-05 14:00:23 +02:00
56e6873b80
Assertions ship in every configuration - Ja2/builddefines.h defines FORCE_ASSERTS_ON unconditionally - so a player on a release build hits the runtime error screen with a line and a file, and that is all anyone ever gets. The crash handler that would have written a report never runs, because an assertion faults nothing. Raise a software exception from _FailMessage so it does. The code has the customer bit set, the handler recognizes it, and the report carries the assertion's line, file and message alongside the usual registers, module table and frame chain, which symbolizes back to the assertion site. The exception is swallowed again immediately: first-chance is all the handler needs, and letting it travel further would kill a game that means to show its error screen. The dumper needed two adjustments to cope with an exception nobody faulted: its one-report-per-address rule keys on the assertion's own file and line, since every raise shares RaiseException's address, and the re-entry latch is lifted in the __except, which is the only code that runs if writing a report faults. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
93 lines
3.7 KiB
C++
93 lines
3.7 KiB
C++
// Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
// This is a cross platform interface for helper functions related to debuggers.
|
|
// You should use this to test if you're running under a debugger, and if you
|
|
// would like to yield (breakpoint) into the debugger.
|
|
|
|
#ifndef BASE_DEBUG_UTIL_H_
|
|
#define BASE_DEBUG_UTIL_H_
|
|
|
|
#include <iosfwd>
|
|
#include <vector>
|
|
|
|
#include "sgp_logger.h"
|
|
|
|
// A macro to disallow the copy constructor and operator= functions
|
|
// This should be used in the private: declarations for a class
|
|
#define DISALLOW_COPY_AND_ASSIGN(TypeName) \
|
|
TypeName(const TypeName&); \
|
|
void operator=(const TypeName&)
|
|
|
|
// An older, deprecated, politically incorrect name for the above.
|
|
#define DISALLOW_EVIL_CONSTRUCTORS(TypeName) DISALLOW_COPY_AND_ASSIGN(TypeName)
|
|
|
|
// A stacktrace can be helpful in debugging. For example, you can include a
|
|
// stacktrace member in a object (probably around #ifndef NDEBUG) so that you
|
|
// can later see where the given object was created from.
|
|
class StackTrace {
|
|
public:
|
|
// Create a stacktrace from the current location
|
|
StackTrace();
|
|
// Get an array of instruction pointer values.
|
|
// count: (output) the number of elements in the returned array
|
|
const void *const *Addresses(size_t* count);
|
|
// Print a backtrace to stderr
|
|
void PrintBacktrace(const char* msg);
|
|
|
|
// Resolve backtrace to symbols and write to stream.
|
|
void OutputToStream(const char* msg, sgp::Logger::LogInstance* os);
|
|
|
|
private:
|
|
std::vector<void*> trace_;
|
|
int count_;
|
|
|
|
DISALLOW_EVIL_CONSTRUCTORS(StackTrace);
|
|
};
|
|
|
|
struct _EXCEPTION_POINTERS;
|
|
|
|
// Assertion failures raise this software exception so they get the same crash
|
|
// report as a real fault. Bit 29 set marks it customer-defined, so it can never
|
|
// collide with a system code; the top two bits mark it an error.
|
|
#define SGP_EXCEPTION_ASSERT 0xE1A55E27
|
|
|
|
namespace sgp
|
|
{
|
|
void dumpStackTrace(vfs::String const& msg);
|
|
|
|
// Raise SGP_EXCEPTION_ASSERT and swallow it again, so the vectored crash
|
|
// handler writes a report for an assertion that never faults. Carries the
|
|
// assert's line, file and message (NULL for a plain Assert) as exception
|
|
// parameters.
|
|
void raiseAssertException(unsigned lineNum, const char* sourceFileName,
|
|
const char* message);
|
|
|
|
// Write a heap-free crash report (registers + a raw return-address backtrace)
|
|
// for the faulting context to a numbered crash_report file; symbolize it
|
|
// offline against the build's PDB. Call first-chance from a vectored handler.
|
|
void writeExceptionBacktrace(_EXCEPTION_POINTERS* ep);
|
|
|
|
// Record the build-id (game version string) to stamp into crash reports, so
|
|
// a report can be matched to the exact build's PDB. Call once at startup.
|
|
void setCrashBuildId(const char* id);
|
|
|
|
// What to tell the player: why we died and where the report landed. NULL if
|
|
// no crash was recorded. Built by the handler, shown from the exit path.
|
|
const wchar_t* crashReportMessage();
|
|
|
|
// Record the player's optional self-chosen handle (HANDLE in Ja2 Settings) to
|
|
// stamp into crash reports, so a report can be tied to whoever raises it with
|
|
// us on Discord. Empty or unset simply omits the field. Call once at startup.
|
|
void setCrashUserHandle(const wchar_t* handle);
|
|
|
|
// Startup crash-telemetry pass (heap is healthy here — never call from a
|
|
// crash handler). If url is empty the feature is off. On first run, asks the
|
|
// player for consent (native dialog) and remembers it; if granted, POSTs each
|
|
// pending crash_report_*.txt to url and deletes the ones that upload cleanly.
|
|
void processCrashTelemetry(const wchar_t* url);
|
|
}
|
|
|
|
#endif // BASE_DEBUG_UTIL_H_
|