1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
|
/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2020 Warzone 2100 Project
Warzone 2100 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 2 of the License, or
(at your option) any later version.
Warzone 2100 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 Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
* Debug.c
*
* Various debugging output functions.
*
*/
#include "frame.h"
#include "wztime.h"
#include <string.h>
#include <stdio.h>
#include <time.h>
#include "string_ext.h"
#include "wzapp.h"
#include <map>
#include <string>
// On Fedora 40, GCC 14 produces false-positive warnings for -Walloc-zero
// when compiling <regex> with optimizations. Silence these warnings.
#if !defined(__clang__) && !defined(__INTEL_COMPILER) && defined(__GNUC__) && __GNUC__ >= 14 && defined(__OPTIMIZE__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Walloc-zero"
#endif
# include <regex>
#if !defined(__clang__) && !defined(__INTEL_COMPILER) && defined(__GNUC__) && __GNUC__ >= 14 && defined(__OPTIMIZE__)
# pragma GCC diagnostic pop
#endif
#include <array>
#if defined(WZ_OS_LINUX) && defined(__GLIBC__)
#include <execinfo.h> // Nonfatal runtime backtraces.
#include <cxxabi.h>
#endif // defined(WZ_OS_LINUX) && defined(__GLIBC__)
#if defined(WZ_OS_UNIX)
# include <fcntl.h>
# ifndef _POSIX_C_SOURCE
# define _POSIX_C_SOURCE 1
# endif
# ifndef _XOPEN_SOURCE
# define _XOPEN_SOURCE
# endif
# ifndef _POSIX_SOURCE
# define _POSIX_SOURCE
# endif
# include <stdio.h>
#endif
#define MAX_LEN_LOG_LINE 1024
char last_called_script_event[MAX_EVENT_NAME_LEN];
UDWORD traceID = -1;
static debug_callback *callbackRegistry = nullptr;
bool enabled_debug[LOG_LAST]; // global
#ifdef DEBUG
bool assertEnabled = true;
#else
bool assertEnabled = false;
#endif
#ifdef WZ_OS_MAC
#include "cocoa_wrapper.h"
#endif
/*
* This list _must_ match the enum in debug.h!
* Names must be 8 chars long at max!
*/
static const char *code_part_names[] =
{
"all",
"main",
"sound",
"video",
"wz",
"3d",
"texture",
"net",
"memory",
"warning",
"error",
"never",
"script",
"movement",
"attack",
"fog",
"sensor",
"gui",
"map",
"save",
"sync",
"death",
"life",
"gateway",
"message",
"info",
"terrain",
"feature",
"fatal",
"input",
"popup",
"console",
"activity",
"research",
"savegame",
"repairs",
"last"
};
static bool useInputBuffer1 = false;
static bool debug_flush_stderr = false;
static std::map<std::string, int> warning_list; // only used for LOG_WARNING
static std::mutex warning_list_mutex;
/**
* Convert code_part names to enum. Case insensitive.
*
* \return Codepart number or LOG_LAST if can't match.
*/
static code_part code_part_from_str(const char *str)
{
unsigned int i;
for (i = 0; i < LOG_LAST; i++)
{
if (strcasecmp(code_part_names[i], str) == 0)
{
return (code_part)i;
}
}
return LOG_LAST;
}
/**
* Callback for outputing to stderr
*
* \param data Ignored. Use NULL.
* \param outputBuffer Buffer containing the preprocessed text to output.
*/
void debug_callback_stderr(WZ_DECL_UNUSED void **data, const char *outputBuffer, code_part)
{
if (outputBuffer[strlen(outputBuffer) - 1] != '\n')
{
fprintf(stderr, "%s\n", outputBuffer);
}
else
{
fprintf(stderr, "%s", outputBuffer);
}
// Make sure that all output is flushed to stderr when requested by the user
if (debug_flush_stderr)
{
fflush(stderr);
}
}
/**
* Callback for outputting to a win32 debugger
*
* \param data Ignored. Use NULL.
* \param outputBuffer Buffer containing the preprocessed text to output.
*/
#if defined(_WIN32) && defined(DEBUG)
void debug_callback_win32debug(WZ_DECL_UNUSED void **data, const char *outputBuffer, code_part)
{
char tmpStr[MAX_LEN_LOG_LINE];
sstrcpy(tmpStr, outputBuffer);
if (!strchr(tmpStr, '\n'))
{
sstrcat(tmpStr, "\n");
}
OutputDebugStringA(tmpStr);
}
#endif // WIN32
/**
* Callback for outputing to a file
*
* \param data Filehandle to output to.
* \param outputBuffer Buffer containing the preprocessed text to output.
*/
void debug_callback_file(void **data, const char *outputBuffer, code_part)
{
FILE *logfile = (FILE *)*data;
if (!strchr(outputBuffer, '\n'))
{
fprintf(logfile, "%s\n", outputBuffer);
}
else
{
fprintf(logfile, "%s", outputBuffer);
}
}
static WzString replaceUsernameInPath(WzString path)
{
// Some common forms:
// C:\Users\<USERNAME>\... (Windows Vista+)
// C:\Documents and Settings\<USERNAME>\... (Windows XP)
// /Users/<USERNAME>/... (macOS)
// /home/<USERNAME>/... (Linux)
// First pass, do a simple string regex replacement
const auto win_re = std::regex("^[A-Za-z]:\\\\(Users|Documents and Settings)\\\\[^\\\\]+", std::regex_constants::ECMAScript);
auto result = std::regex_replace(path.toUtf8(), win_re, "[WIN_USER_FOLDER]");
const auto unix_re = std::regex("^\\/(Users|home)\\/[^\\/]+", std::regex_constants::ECMAScript);
result = std::regex_replace(result, unix_re, "[USER_HOME]");
// POSSIBLE FUTURE TODO: Do OS-specific handling where we query the "home"/user folder?
return WzString::fromUtf8(result);
}
char WZ_DBGFile[PATH_MAX] = {0}; //Used to save path of the created log file
/**
* Setup the file callback
*
* Sets data to the filehandle opened for the filename found in data.
*
* \param[in,out] data In: The filename to output to.
* Out: The filehandle.
*/
WzString WZDebugfilename;
bool debug_callback_file_init(void **data)
{
WzString * pFileName = (WzString *)*data;
ASSERT(pFileName, "Debug filename required");
WZDebugfilename = *pFileName;
#if defined(WZ_OS_WIN)
// On Windows, path strings passed to fopen() are interpreted using the ANSI or OEM codepage
// (and not as UTF-8). To support Unicode paths, the string must be converted to a wide-char
// string and passed to _wfopen.
int wstr_len = MultiByteToWideChar(CP_UTF8, 0, WZDebugfilename.toUtf8().c_str(), -1, NULL, 0);
if (wstr_len <= 0)
{
fprintf(stderr, "Could not not convert string from UTF-8; MultiByteToWideChar failed with error %lu: %s\n", GetLastError(), WZDebugfilename.toUtf8().c_str());
return false;
}
std::vector<wchar_t> wstr_filename(wstr_len, 0);
if (MultiByteToWideChar(CP_UTF8, 0, WZDebugfilename.toUtf8().c_str(), -1, &wstr_filename[0], wstr_len) == 0)
{
fprintf(stderr, "Could not not convert string from UTF-8; MultiByteToWideChar[2] failed with error %lu: %s\n", GetLastError(), WZDebugfilename.toUtf8().c_str());
return false;
}
FILE *const logfile = _wfopen(&wstr_filename[0], L"w");
#else
FILE *const logfile = fopen(WZDebugfilename.toUtf8().c_str(), "w");
#endif
if (!logfile)
{
fprintf(stderr, "Could not open %s for appending!\n", WZDebugfilename.toUtf8().c_str());
return false;
}
#if defined(WZ_OS_UNIX)
int fd = fileno(logfile);
if (fd != -1)
{
fcntl(fd, F_SETFD, FD_CLOEXEC);
}
#endif
snprintf(WZ_DBGFile, sizeof(WZ_DBGFile), "%s", WZDebugfilename.toUtf8().c_str());
setbuf(logfile, nullptr);
WzString fileNameStripped = replaceUsernameInPath(WZDebugfilename);
fprintf(logfile, "--- Starting log [%s]---\n", fileNameStripped.toUtf8().c_str());
*data = logfile;
return true;
}
/**
* Shutdown the file callback
*
* Closes the logfile.
*
* \param data The filehandle to close.
*/
void debug_callback_file_exit(void **data)
{
FILE *logfile = (FILE *)*data;
fclose(logfile);
*data = nullptr;
}
void debugFlushStderr()
{
debug_flush_stderr = true;
}
// MSVC specific rotuines to set/clear allocation tracking
#if defined(_MSC_VER) && defined(DEBUG)
void debug_MEMCHKOFF()
{
// Disable allocation tracking
int flags = _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG);
flags &= ~_CRTDBG_ALLOC_MEM_DF;
_CrtSetDbgFlag(flags);
}
void debug_MEMCHKON()
{
// Enable allocation tracking
int flags = _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG);
flags |= _CRTDBG_ALLOC_MEM_DF;
_CrtSetDbgFlag(flags);
}
void debug_MEMSTATS()
{
_CrtMemState state;
_CrtMemCheckpoint(&state);
_CrtMemDumpStatistics(&state);
}
#endif
void debug_init()
{
/*** Initialize the debug subsystem ***/
#if defined(WZ_CC_MSVC) && defined(DEBUG)
int tmpDbgFlag;
_CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_DEBUG); // Output CRT info to debugger
tmpDbgFlag = _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG); // Grab current flags
# if defined(DEBUG_MEMORY)
tmpDbgFlag |= _CRTDBG_CHECK_ALWAYS_DF; // Check every (de)allocation
# endif // DEBUG_MEMORY
tmpDbgFlag |= _CRTDBG_ALLOC_MEM_DF; // Check allocations
tmpDbgFlag |= _CRTDBG_LEAK_CHECK_DF; // Check for memleaks
_CrtSetDbgFlag(tmpDbgFlag);
#endif // WZ_CC_MSVC && DEBUG
STATIC_ASSERT(ARRAY_SIZE(code_part_names) - 1 == LOG_LAST); // enums start at 0
memset(enabled_debug, false, sizeof(enabled_debug));
enabled_debug[LOG_ERROR] = true;
enabled_debug[LOG_INFO] = true;
enabled_debug[LOG_FATAL] = true;
enabled_debug[LOG_POPUP] = true;
#if defined(__EMSCRIPTEN__)
// start with certain options off so that we can control them predictably from the command-line options via the web interface
enabled_debug[LOG_INFO] = false;
enabled_debug[LOG_WARNING] = false;
enabled_debug[LOG_3D] = false;
// must be false or sound breaks (some openal edge case)
enabled_debug[LOG_SOUND] = false;
#endif
#ifdef DEBUG
enabled_debug[LOG_WARNING] = true;
#endif
}
void debug_exit()
{
debug_callback *curCallback = callbackRegistry, * tmpCallback = nullptr;
while (curCallback)
{
if (curCallback->exit)
{
curCallback->exit(&curCallback->data);
}
tmpCallback = curCallback->next;
free(curCallback);
curCallback = tmpCallback;
}
{
std::lock_guard<std::mutex> guard(warning_list_mutex);
warning_list.clear();
}
callbackRegistry = nullptr;
}
void debug_register_callback(debug_callback_fn callback, debug_callback_init init, debug_callback_exit exit, void *data)
{
debug_callback *curCallback = callbackRegistry, * tmpCallback = nullptr;
tmpCallback = (debug_callback *)malloc(sizeof(*tmpCallback));
tmpCallback->next = nullptr;
tmpCallback->callback = callback;
tmpCallback->init = init;
tmpCallback->exit = exit;
tmpCallback->data = data;
if (tmpCallback->init
&& !tmpCallback->init(&tmpCallback->data))
{
fprintf(stderr, "Failed to initialise debug callback, debugfile set to [%s]!\n", WZDebugfilename.toUtf8().c_str());
free(tmpCallback);
return;
}
if (!curCallback)
{
callbackRegistry = tmpCallback;
return;
}
while (curCallback->next)
{
curCallback = curCallback->next;
}
curCallback->next = tmpCallback;
}
bool debug_enable_switch(const char *str)
{
code_part part = code_part_from_str(str);
if (part != LOG_LAST)
{
enabled_debug[part] = !enabled_debug[part];
}
if (part == LOG_ALL)
{
memset(enabled_debug, true, sizeof(enabled_debug));
}
return (part != LOG_LAST);
}
/** Send the given string to all debug callbacks.
*
* @param str The string to send to debug callbacks.
*/
static void printToDebugCallbacks(const char *const str, code_part part)
{
debug_callback *curCallback;
// Loop over all callbacks, invoking them with the given data string
for (curCallback = callbackRegistry; curCallback != nullptr; curCallback = curCallback->next)
{
curCallback->callback(&curCallback->data, str, part);
}
}
void _realObjTrace(int id, const char *function, const char *str, ...)
{
char vaBuffer[MAX_LEN_LOG_LINE];
char outputBuffer[MAX_LEN_LOG_LINE];
va_list ap;
va_start(ap, str);
vssprintf(vaBuffer, str, ap);
va_end(ap);
ssprintf(outputBuffer, "[%6d]: [%s] %s", id, function, vaBuffer);
printToDebugCallbacks(outputBuffer, LOG_INFO);
}
// Thread local to prevent a race condition on read and write to this buffer if multiple
// threads log errors. This means we will not be reporting any errors to console from threads
// other than main. If we want to fix this, make sure accesses are protected by a mutex.
static thread_local char errorStore[512];
static thread_local bool errorWaiting = false;
const char *debugLastError()
{
if (errorWaiting)
{
errorWaiting = false;
return errorStore;
}
else
{
return nullptr;
}
}
static void debugDisplayFatalErrorMsgBox(const char* outputLogLine)
{
if (wzIsFullscreen())
{
wzChangeWindowMode(WINDOW_MODE::windowed, true);
}
#if defined(WZ_OS_WIN)
char wbuf[MAX_LEN_LOG_LINE+512];
ssprintf(wbuf, "%s\n\nPlease check the file (%s) in your configuration directory for more details. \
\nDo not forget to upload the %s file, WZdebuginfo.txt and the warzone2100.rpt files in your bug reports at https://github.com/Warzone2100/warzone2100/issues/new!", outputLogLine, WZ_DBGFile, WZ_DBGFile);
wzDisplayDialog(Dialog_Error, "Warzone has terminated unexpectedly", wbuf);
#elif defined(WZ_OS_MAC)
char wbuf[MAX_LEN_LOG_LINE+128];
ssprintf(wbuf, "%s\n\nPlease check your logs and attach them along with a bug report. Thanks!", outputLogLine);
size_t clickedIndex = wzDisplayDialogAdvanced(Dialog_Error, "Warzone has quit unexpectedly.", wbuf, {"Show Log Files & Open Bug Reporter", "Ignore"});
if (clickedIndex == 1)
{
if (!cocoaOpenURL("https://github.com/Warzone2100/warzone2100/issues/new"))
{
wzDisplayDialogAdvanced(Dialog_Error,
"Failed to open URL",
"Could not open URL: https://github.com/Warzone2100/warzone2100/issues/new\nPlease open this URL manually in your web browser.", {"Continue"});
}
if (strnlen(WZ_DBGFile, sizeof(WZ_DBGFile)/sizeof(WZ_DBGFile[0])) <= 0)
{
wzDisplayDialogAdvanced(Dialog_Error,
"Unable to open debug log.",
"The debug log subsystem has not yet been initialised.", {"Continue"});
}
else
{
if (!cocoaSelectFileInFinder(WZ_DBGFile))
{
wzDisplayDialogAdvanced(Dialog_Error,
"Cannot Display Log File",
"The attempt to open a Finder window highlighting the log file from this run failed.", {"Continue"});
}
}
cocoaOpenUserCrashReportFolder();
}
#else
wzDisplayDialog(Dialog_Error, "Warzone has terminated unexpectedly", outputLogLine);
#endif
}
struct DebugGfxCallbackPersistentData
{
char lastGfxCallbackMsg[MAX_LEN_LOG_LINE] = {'\0'};
unsigned int repeated = 0; /* times last message repeated */
unsigned int prev = 0; /* total on last update */
};
static DebugGfxCallbackPersistentData savedDebugGfxCallbackData;
std::mutex savedDebugGfxCallbackData_mutex; // protects savedDebugGfxCallbackData
// Special version of _debug that doesn't use any of the normal global debug-logging state (or special sauce) *except* the callbackRegistry (via printToDebugCallbacks)
void _debugFromGfxCallback(int line, code_part part, const char *function, const char *str, ...)
{
char outputBuffer[MAX_LEN_LOG_LINE];
char tmpRepeatBuffer[128] = {0};
time_t rawtime;
struct tm timeinfo = {};
char ourtime[15]; //HH:MM:SS
time(&rawtime);
timeinfo = getLocalTime(rawtime, true);
strftime(ourtime, 15, "%H:%M:%S", &timeinfo);
int numPrefixChars = ssprintf(outputBuffer, "%-8s|%s: [%s:%d] ", code_part_names[part], ourtime, function, line);
if (numPrefixChars < 0)
{
// encoding error occurred...
ssprintf(outputBuffer, "%s", "ssprintf failed: encoding error");
printToDebugCallbacks(outputBuffer, LOG_ERROR);
return;
}
// Then calculate the remaining length manually and pass the appropriate pointer and length to vsnprintf
size_t remainingLength = MAX_LEN_LOG_LINE - static_cast<size_t>(numPrefixChars);
char* pStartOutputLineContents = outputBuffer + numPrefixChars;
va_list ap;
va_start(ap, str);
vsnprintf(pStartOutputLineContents, remainingLength, str, ap);
va_end(ap);
unsigned int curr_repeated = 0;
{ // lock_guard(savedDebugGfxCallbackData_mutex) scope
std::lock_guard<std::mutex> guard(savedDebugGfxCallbackData_mutex);
if (strncmp(savedDebugGfxCallbackData.lastGfxCallbackMsg, pStartOutputLineContents, MAX_LEN_LOG_LINE) == 0)
{
// last message, duplicated
++savedDebugGfxCallbackData.repeated;
bool isRepeatedPowOf2 = savedDebugGfxCallbackData.repeated >= 2 && ((savedDebugGfxCallbackData.repeated & (savedDebugGfxCallbackData.repeated - 1)) == 0);
if (isRepeatedPowOf2)
{
if (savedDebugGfxCallbackData.repeated > 2)
{
snprintf(pStartOutputLineContents, remainingLength, "last message repeated %u times (total %u repeats)", savedDebugGfxCallbackData.repeated - savedDebugGfxCallbackData.prev, savedDebugGfxCallbackData.repeated);
}
else
{
snprintf(pStartOutputLineContents, remainingLength, "last message repeated %u times", savedDebugGfxCallbackData.repeated - savedDebugGfxCallbackData.prev);
}
savedDebugGfxCallbackData.prev = savedDebugGfxCallbackData.repeated;
}
else
{
return; // do nothing - no printing
}
}
else
{
// Received another line, cleanup the old
if (savedDebugGfxCallbackData.repeated > 0 && savedDebugGfxCallbackData.repeated != savedDebugGfxCallbackData.prev && savedDebugGfxCallbackData.repeated != 1)
{
/* just repeat the previous message when only one repeat occurred */
if (savedDebugGfxCallbackData.repeated > 2)
{
ssprintf(tmpRepeatBuffer, "last message repeated %u times (total %u repeats)", savedDebugGfxCallbackData.repeated - savedDebugGfxCallbackData.prev, savedDebugGfxCallbackData.repeated);
}
else
{
ssprintf(tmpRepeatBuffer, "last message repeated %u times", savedDebugGfxCallbackData.repeated - savedDebugGfxCallbackData.prev);
}
}
savedDebugGfxCallbackData.repeated = 0;
savedDebugGfxCallbackData.prev = 0;
sstrcpy(savedDebugGfxCallbackData.lastGfxCallbackMsg, pStartOutputLineContents);
}
curr_repeated = savedDebugGfxCallbackData.repeated;
} // end lock_guard(savedDebugGfxCallbackData_mutex)
if (tmpRepeatBuffer[0] != '\0')
{
printToDebugCallbacks(tmpRepeatBuffer, part);
}
printToDebugCallbacks(outputBuffer, part);
if (!curr_repeated)
{
if (part == LOG_FATAL)
{
debugDisplayFatalErrorMsgBox(pStartOutputLineContents);
}
}
}
void _debug(int line, code_part part, const char *function, const char *str, ...)
{
char outputBuffer[MAX_LEN_LOG_LINE];
thread_local std::array<std::vector<char>, 2> inputBuffer = {std::vector<char>(MAX_LEN_LOG_LINE, 0), std::vector<char>(MAX_LEN_LOG_LINE, 0)};
thread_local unsigned int repeated = 0; /* times current message repeated */
thread_local unsigned int next = 2; /* next total to print update */
thread_local unsigned int prev = 0; /* total on last update */
va_list ap;
va_start(ap, str);
vssprintf(outputBuffer, str, ap);
va_end(ap);
if (part == LOG_WARNING)
{
bool addedNew = false;
{
std::lock_guard<std::mutex> guard(warning_list_mutex);
addedNew = warning_list.insert(std::pair<std::string, int>(std::string(function) + "-" + std::string(outputBuffer), line)).second;
}
if (addedNew)
{
auto& currInputBuffer = inputBuffer[useInputBuffer1 ? 1 : 0];
snprintf(currInputBuffer.data(), currInputBuffer.size(), "[%s:%d] %s (**Further warnings of this type are suppressed.)", function, line, outputBuffer);
}
else
{
return; // don't bother adding any more
}
}
else
{
auto& currInputBuffer = inputBuffer[useInputBuffer1 ? 1 : 0];
snprintf(currInputBuffer.data(), currInputBuffer.size(), "[%s:%d] %s", function, line, outputBuffer);
}
if (strncmp(inputBuffer[0].data(), inputBuffer[1].data(), std::min(inputBuffer[0].size(), inputBuffer[1].size())) == 0)
{
// Received again the same line
repeated++;
if (repeated == next)
{
if (repeated > 2)
{
ssprintf(outputBuffer, "last message repeated %u times (total %u repeats)", repeated - prev, repeated);
}
else
{
ssprintf(outputBuffer, "last message repeated %u times", repeated - prev);
}
printToDebugCallbacks(outputBuffer, part);
prev = repeated;
next *= 2;
}
}
else
{
// Received another line, cleanup the old
if (repeated > 0 && repeated != prev && repeated != 1)
{
/* just repeat the previous message when only one repeat occurred */
if (repeated > 2)
{
ssprintf(outputBuffer, "last message repeated %u times (total %u repeats)", repeated - prev, repeated);
}
else
{
ssprintf(outputBuffer, "last message repeated %u times", repeated - prev);
}
printToDebugCallbacks(outputBuffer, part);
}
repeated = 0;
next = 2;
prev = 0;
}
if (!repeated)
{
time_t rawtime;
struct tm timeinfo = {};
char ourtime[15]; //HH:MM:SS
time(&rawtime);
timeinfo = getLocalTime(rawtime, true);
strftime(ourtime, 15, "%H:%M:%S", &timeinfo);
auto& currInputBuffer = inputBuffer[useInputBuffer1 ? 1 : 0];
// Assemble the outputBuffer:
ssprintf(outputBuffer, "%-8s|%s: %s", code_part_names[part], ourtime, currInputBuffer.data());
printToDebugCallbacks(outputBuffer, part);
if (part == LOG_ERROR)
{
// used to signal user that there was a error condition, and to check the logs.
sstrcpy(errorStore, currInputBuffer.data());
errorWaiting = true;
}
// Throw up a dialog box for users since most don't have a clue to check the dump file for information. Use for (duh) Fatal errors, that force us to terminate the game.
if (part == LOG_FATAL)
{
debugDisplayFatalErrorMsgBox(currInputBuffer.data());
}
// Throw up a dialog box for windows users since most don't have a clue to check the stderr.txt file for information
// This is a popup dialog used for times when the error isn't fatal, but we still need to notify user what is going on.
if (part == LOG_POPUP)
{
wzDisplayDialog(Dialog_Information, "Warzone has detected a problem.", currInputBuffer.data());
}
}
useInputBuffer1 = !useInputBuffer1; // Swap buffers
}
void _debugBacktrace(code_part part)
{
#if defined(WZ_OS_LINUX) && defined(__GLIBC__)
void *btv[20];
unsigned num = backtrace(btv, sizeof(btv) / sizeof(*btv));
char **btc = backtrace_symbols(btv, num);
unsigned i;
auto trim = [](const char *in, char *out) {
const char *begin = strchr(in, '_');
if (begin)
{
const char *end = strchr(begin, '+');
if (end)
{
memcpy(out, begin, end - begin);
out[end - begin] = '\0';
}
}
};
for (i = 1; i + 2 < num; ++i)
{
int status = -1;
char buf[1024];
const char *p = btc[i];
trim(p, buf);
char *readableName = abi::__cxa_demangle(buf, NULL, NULL, &status);
if (status == 0)
{
_debug(0, part, "BT", "%s", readableName);
}
else
{
_debug(0, part, "BT", "%s [status: %i]", btc[i], status);
}
}
free(btc);
#else
// debugBacktrace not implemented.
#endif
}
bool debugPartEnabled(code_part codePart)
{
return enabled_debug[codePart];
}
void debugDisableAssert()
{
assertEnabled = false;
}
#include <sstream>
void _debug_multiline(int line, code_part part, const char *function, const std::string &multilineString)
{
std::stringstream ss(multilineString);
std::string to;
while(std::getline(ss,to,'\n')){
_debug(line, part, function, "%s", to.c_str());
}
}
#if defined(__EMSCRIPTEN__)
#include <emscripten.h>
/**
* Callback for outputting to a emscripten log / console
*
* \param data Ignored. Use NULL.
* \param outputBuffer Buffer containing the preprocessed text to output.
*/
void debug_callback_emscripten_log(WZ_DECL_UNUSED void **data, const char *outputBuffer, code_part part)
{
int flags = EM_LOG_NO_PATHS | EM_LOG_CONSOLE;
switch (part)
{
case LOG_ERROR:
flags |= EM_LOG_ERROR;
break;
case LOG_WARNING:
flags |= EM_LOG_WARN;
break;
default:
break;
}
if (outputBuffer[strlen(outputBuffer) - 1] != '\n')
{
emscripten_log(flags, "%s\n", outputBuffer);
}
else
{
emscripten_log(flags, "%s", outputBuffer);
}
}
#endif
|