fiddlerwoaroof/crawl - Change KOMZPTDEZP3P6EWBUECWDY7OWELOUTMAUKNEOJ7PWX5LJBTMRVQAC

Implemented crash data reporting, though it's only some stubs on Windows and

DOS. On UNIX with USE_UNIX_SIGNALS defined, when any crash causing signal happens it will dump to a file the current crawl_state, anything caught by the items and monsters scans, and level building info if the crash happened during level generation.

Also, if crawl is linked against the GNU C library (and the exectuable is in ELF format) it will dump the stack trace. The code attempts to automatically detect the presence of glibc, but that might not work on all systems. This should work on OS X, since there's an OS X man page for the glibc functions that get the stack trace. Don't know if it would work with MinGW.

Actually getting function names for the stack trace requires the use of the "-rdynamic" linker option, which increases the size of the stripped executable by 27% (yikes!), but still prints the function names even when stripped.

All of the function names in the stack trace are mangled C++ ones, but that shouldn't be too much of a problem.

git-svn-id: https://crawl-ref.svn.sourceforge.net/svnroot/crawl-ref/trunk@8532 c06c8d41-db1a-0410-9941-cceddc491573

Created by zelgadis on January 17, 2009

KOMZPTDEZP3P6EWBUECWDY7OWELOUTMAUKNEOJ7PWX5LJBTMRVQAC

Dependencies

In channels

main

Change contents

Insertion in crawl-ref/source/state.h at line 14 [7.42804]
[5.326]
[6.1190]
```
#include <stdio.h>
```

Insertion in crawl-ref/source/state.h at line 31 [7.42804]

[7.43209]

    bool game_crashed;      // The game crashed and is now in the process of
                            // dumping crash info.

Insertion in crawl-ref/source/state.h at line 122 [7.42804]
[6.1850]
[7.44711]
```
    void dump(FILE* file);
```
Insertion in crawl-ref/source/state.cc at line 22 [8.1546]
[8.1988]
[8.1988]
```
#include "religion.h"
```

Replacement in crawl-ref/source/state.cc at line 28 [8.1546]

B:BD[8.2073] → [8.2073:2129]

    : mouse_enabled(false), waiting_for_command(false),

[8.2073]

[8.2129]

    : game_crashed(false), mouse_enabled(false), waiting_for_command(false),

Insertion in crawl-ref/source/state.cc at line 375 [8.1546]

[6.4109]

}
void game_state::dump(FILE* file)
{
    fprintf(file, "\r\nGame state:\r\n\r\n");
    fprintf(file, "mouse_enabled: %d, waiting_for_command: %d "
                  "terminal_resized: %d\r\n",
            mouse_enabled, waiting_for_command, terminal_resized);
    fprintf(file, "io_inited: %d, need_save: %d, saving_game: %d, "
                  "updating_scores: %d\r\n:",
            io_inited, need_save, saving_game, updating_scores);
    fprintf(file, "seen_hups: %d, map_stat_gen: %d, arena: %d, "
                  "arena_suspended: %d, unicode_ok: %d\r\n",
            seen_hups, map_stat_gen, arena, arena_suspended, unicode_ok);
    fprintf(file, "\r\n");
    if (!startup_errors.empty())
    {
        fprintf(file, "Startup errors:\r\n");
        for (unsigned int i = 0; i < startup_errors.size(); i++)
            fprintf(file, "%s\n", startup_errors[i].c_str());
        fprintf(file, "\r\n");
    }
    fprintf(file, "prev_cmd = %s\r\n", command_to_name(prev_cmd).c_str());
    if (doing_prev_cmd_again)
    {
        fprintf(file, "Doing prev_cmd again with keys: ");
        for (unsigned int i = 0; i < prev_cmd_keys.size(); i++)
            fprintf(file, "%d, ", prev_cmd_keys[i]);
        fprintf(file, "\r\n");
        fprintf(file, "As ASCII keys: ");
        for (unsigned int i = 0; i < prev_cmd_keys.size(); i++)
            fprintf(file, "%c", (char) prev_cmd_keys[i]);
        fprintf(file, "\r\n\r\n");
    }
    fprintf(file, "repeat_cmd = %s\r\n", command_to_name(repeat_cmd).c_str());
    if (cmd_repeat_count > 0 || cmd_repeat_goal > 0)
    {
        fprintf(file, "Doing command repitition: \r\n");
        fprintf(file, "cmd_repeat_start:%d, cmd_repeat_count: %d, "
                      "cmd_repeat_goal:%d\r\nprev_cmd_repeat_goal: %d\r\n",
                cmd_repeat_start, cmd_repeat_count, cmd_repeat_goal, 
                prev_cmd_repeat_goal);
        fprintf(file, "Keys being repeated: ");
        for (unsigned int i = 0; i < repeat_cmd_keys.size(); i++)
            fprintf(file, "%d, ", repeat_cmd_keys[i]);
        fprintf(file, "\r\n");
        fprintf(file, "As ASCII keys: ");
        for (unsigned int i = 0; i < repeat_cmd_keys.size(); i++)
            fprintf(file, "%c", (char) repeat_cmd_keys[i]);
        fprintf(file, "\r\n\r\n");
    }
    if (god_act.which_god != GOD_NO_GOD || god_act.depth != 0)
    {
        fprintf(file, "God %s currently acting with depth %d\r\n\r\n",
                god_name(god_act.which_god).c_str(), god_act.depth);
    }
    if (god_act_stack.size() != 0)
    {
        fprintf(file, "Other gods acting: \r\n");
        for (unsigned int i = 0; i < god_act_stack.size(); i++)
            fprintf(file, "God %s with depth %d\r\n",
                    god_name(god_act_stack[i].which_god).c_str(),
                    god_act_stack[i].depth);
        fprintf(file, "\r\n");
    }

Insertion in crawl-ref/source/message.h at line 130 [10.1990888]
[9.813]
[9.813]
```
void set_msg_dump_file(FILE* file);
```
Insertion in crawl-ref/source/message.cc at line 63 [10.1993826]
[11.356]
[12.555229]
```
static FILE* _msg_dump_file = NULL;
```

Insertion in crawl-ref/source/message.cc at line 422 [10.1993826]

[10.1999075]

[4.2653]

    if (_msg_dump_file != NULL)
        fprintf(_msg_dump_file, "%s\n", inf);
    if (crawl_state.game_crashed)
        return;

Insertion in crawl-ref/source/message.cc at line 1286 [10.1993826]
[10.2006999]
```
void set_msg_dump_file(FILE* file)
{
    _msg_dump_file = file;
}
```
Insertion in crawl-ref/source/makefile_tiles.unix at line 23 [14.5756330]
[3.1277948]
[13.164683]
```
# To get stack trace symbols.
LDFLAGS = -rdynamic
```
Insertion in crawl-ref/source/makefile.unix at line 19 [12.604320]
[12.604652]
[12.604652]
```
# To get stack trace symbols.
LDFLAGS = -rdynamic
```
Insertion in crawl-ref/source/libw32c.h at line 10 [10.2475780]
[10.2476093]
[15.1135]
```
#include <stdio.h>
```

Insertion in crawl-ref/source/libw32c.h at line 64 [10.2475780]

[10.2476815]

void init_crash_handler();
void dump_crash_info(FILE* file);
void write_stack_trace(FILE* file, int ignore_count);

Insertion in crawl-ref/source/libw32c.cc at line 1149 [10.2476860]

[16.6420]


void init_crash_handler()
{
}
void dump_crash_info(FILE* file)
{
}
void write_stack_trace(FILE* file, int ignore_count)
{
}

Insertion in crawl-ref/source/libunix.h at line 24 [10.2548819]
[17.148]
[10.2548973]
```
#include <stdio.h>
```

Insertion in crawl-ref/source/libunix.h at line 70 [10.2548819]

[18.5811]

[19.1177]


void init_crash_handler();
void dump_crash_info(FILE* file);
void write_stack_trace(FILE* file, int ignore_count);

Insertion in crawl-ref/source/libunix.cc at line 36 [10.2550041]
[20.818]
[7.73869]
```
#include "initfile.h"
```
Insertion in crawl-ref/source/libunix.cc at line 71 [10.2550041]
[10.2552279]
[10.2552279]
```
#endif
#ifdef __GLIBC__
#include <execinfo.h>
```

Insertion in crawl-ref/source/libunix.cc at line 1142 [10.2550041]

[17.392]

    }
}
/////////////////////////////////////////////////////////////////////////////
// Code for printing out debugging info on a crash.
////////////////////////////////////////////////////////////////////////////
static int _crash_signal = 0;
static void _crash_signal_handler(int sig_num)
{
    if (crawl_state.game_crashed)
    {
        fprintf(stderr, "Recursive crash.\n");
        std::string dir = (!Options.morgue_dir.empty() ? Options.morgue_dir :
                           !SysEnv.crawl_dir.empty()   ? SysEnv.crawl_dir
                                                       : "");
        if (!dir.empty() && dir[dir.length() - 1] != FILE_SEPARATOR)
            dir += FILE_SEPARATOR;
        char name[180];
        sprintf(name, "%scrash-recursive-%s-%d.txt", dir.c_str(),
                you.your_name, (int) time(NULL));
        FILE* file = fopen(name, "w");
        if (file == NULL)
            file = stderr;
        write_stack_trace(file, 0);
        if (file != stderr)
            fclose(file);
        return;
    }
    _crash_signal            = sig_num;
    crawl_state.game_crashed = true;
    do_crash_dump();
    // Now crash for real.
    signal(sig_num, SIG_DFL);
    raise(sig_num);
}
void init_crash_handler()
{
#if defined(USE_UNIX_SIGNALS)
    for (int i = 1; i <= 64; i++)
    {
#ifdef SIGHUP_SAVE
        if (i == SIGHUP)
            continue;
#endif
#ifdef SIGQUIT
        if (i == SIGQUIT)
            continue;
#endif
#ifdef SIGINT
        if (i == SIGINT)
            continue;
#endif
#ifdef SIGCHLD
        if (i == SIGCHLD)
            continue;
#endif
#ifdef SIGTSTP
        if (i == SIGTSTP)
            continue;
#endif
#ifdef SIGCONT
        if (i == SIGCONT)
            continue;
#endif
#ifdef SIGIO
        if (i == SIGIO)
            continue;
#endif
#ifdef SIGPROF
        if (i == SIGPROF)
            continue;
#endif
        if (i == SIGWINCH)
            continue;
        signal(i, _crash_signal_handler);

Insertion in crawl-ref/source/libunix.cc at line 1233 [10.2550041]

[17.398]


#endif // if defined(USE_UNIX_SIGNALS)
}
void dump_crash_info(FILE* file)
{
    const char *name = strsignal(_crash_signal);
    if (name == NULL)
        name = "INVALID";
    fprintf(file, "Crash caused by signal #%d: %s\r\n", _crash_signal,
            name);

Insertion in crawl-ref/source/libunix.cc at line 1246 [10.2550041]

[17.400]


#ifdef __GLIBC__
// NOTE: This should work on OS X, according to
// http://developer.apple.com/DOCUMENTATION/DARWIN/Reference/ManPages/man3/backtrace_symbols.3.html
void write_stack_trace(FILE* file, int ignore_count)
{
    void* frames[50];
    int num_frames = backtrace(frames, ARRAYSZ(frames));
    char **symbols = backtrace_symbols(frames, num_frames);
    if (symbols == NULL)
    {
        fprintf(stderr, "Out of memroy.\r\n");
        fprintf(file,   "Out of memory.\r\n");
        // backtrace_symbols_fd() can print out the stack trace even if
        // malloc() can't find any free memory.
        backtrace_symbols_fd(frames, num_frames, fileno(file));
        return;
    }
    for (int i = ignore_count; i < num_frames; i++)
    {
        fprintf(file, "%s\r\n", symbols[i]);
    }
    free(symbols);
}
#else // ifdef __GLIBC__
void write_stack_trace(FILE* file, int ignore_count)
{
    const char* msg = "Unable to get stack trace on this platform.\n";
    fprintf(stderr, msg);
    fprintf(file, msg);
}
#endif

Insertion in crawl-ref/source/libdos.h at line 15 [12.630690]
[21.678]
[15.2747]
```
#include <stdio.h>
```

Insertion in crawl-ref/source/libdos.h at line 48 [12.630690]

[11.3718]

[22.1326]

void init_crash_handler();
void dump_crash_info(FILE* file);
void write_stack_trace(FILE* file, int ignore_count);

Insertion in crawl-ref/source/libdos.cc at line 140 [12.630803]

[23.426]

[11.3914]

}
void init_crash_handler()
{
}
void dump_crash_info(FILE* file)
{
}
void write_stack_trace(FILE* file, int ignore_count)
{

Insertion in crawl-ref/source/debug.h at line 147 [10.4011741]
[10.4016395]
[10.4016395]
```
void do_crash_dump();
```
Deletion in crawl-ref/source/debug.cc at line 47 [10.4016436]
∅:D[24.29932] → [25.308:334]
B:BD[7.101391] → [25.308:334]
```
#ifdef DEBUG_DIAGNOSTICS
```
Deletion in crawl-ref/source/debug.cc at line 48 [10.4016436]
B:BD[25.356] → [25.356:364]
```
#endif
```

Insertion in crawl-ref/source/debug.cc at line 5503 [10.4016436]

[2.92489]


void do_crash_dump()
{
    std::string dir = (!Options.morgue_dir.empty() ? Options.morgue_dir :
                       !SysEnv.crawl_dir.empty()   ? SysEnv.crawl_dir
                                                   : "");
    if (!dir.empty() && dir[dir.length() - 1] != FILE_SEPARATOR)
        dir += FILE_SEPARATOR;
    char name[180];
    sprintf(name, "%scrash-%s-%d.txt", dir.c_str(),
            you.your_name, (int) time(NULL));
    FILE* file = fopen(name, "w");
    if (file == NULL)
    {
        fprintf(stderr, "\r\nUnable to open file '%s' for writing: %s\r\n",
                name, strerror(errno));
        file = stderr;
    }
    else
        fprintf(stderr, "\r\nWriting crash info to %s\r\n", name);

Insertion in crawl-ref/source/debug.cc at line 5529 [10.4016436]

[2.92490]

[26.2380]

    set_msg_dump_file(file);
    // First get the immediate cause of the crash and the stack trace,
    // since that's most important and later attempts to get more information
    // might themselves cause crashes.
    dump_crash_info(file);
    // Ignore the top five stack frames, since the first three involve
    // signal handling and the last two are do_crash_dump() and
    // write_stack_trace().
    write_stack_trace(file, 5);
    if (Generating_Level)
    {
        fprintf(file, "\nCrashed while generating level.\r\n");
        fprintf(file, "your_level = %d, level_type = %d, type_name = %s\r\n",
                you.your_level, you.level_type, you.level_type_name.c_str());
        extern std::string dgn_Build_Method;
        extern bool river_level, lake_level, many_pools_level;
        fprintf(file, "dgn_Build_Method = %s\r\n", dgn_Build_Method.c_str());
        fprintf(file, "dgn_Layout_Type  = %s\r\n", dgn_Layout_Type.c_str());
        extern bool river_level, lake_level, many_pools_level;
        if (river_level)
            fprintf(file, "river level\r\n");
        if (lake_level)
            fprintf(file, "lake level\r\n");
        if (many_pools_level)
            fprintf(file, "many pools level\r\n");
        fprintf(file, "\r\n");
    }
    // Dumping the crawl state is least likely to cause another crash,
    // so do that next.
    crawl_state.dump(file);
    // Next item and monster scans.  Any messages will be sent straight to
    // the file because of set_msg_dump_file()
#if DEBUG_ITEM_SCAN
    debug_item_scan();
#endif
#if DEBUG_MONS_SCAN
    debug_mons_scan();
#endif
    set_msg_dump_file(NULL);
    if (file != stderr)
        fclose(file);
}

Insertion in crawl-ref/source/acr.cc at line 198 [10.4397395]
[27.38377]
[27.38377]
```
    init_crash_handler();
```

Implemented crash data reporting, though it's only some stubs on Windows and

Dependencies

In channels

Change contents

Insertion in crawl-ref/source/state.h at line 14 [7.42804]

Insertion in crawl-ref/source/state.h at line 31 [7.42804]

Insertion in crawl-ref/source/state.h at line 122 [7.42804]

Insertion in crawl-ref/source/state.cc at line 22 [8.1546]

Replacement in crawl-ref/source/state.cc at line 28 [8.1546]

Insertion in crawl-ref/source/state.cc at line 375 [8.1546]

Insertion in crawl-ref/source/message.h at line 130 [10.1990888]

Insertion in crawl-ref/source/message.cc at line 63 [10.1993826]

Insertion in crawl-ref/source/message.cc at line 422 [10.1993826]

Insertion in crawl-ref/source/message.cc at line 1286 [10.1993826]

Insertion in crawl-ref/source/makefile_tiles.unix at line 23 [14.5756330]

Insertion in crawl-ref/source/makefile.unix at line 19 [12.604320]

Insertion in crawl-ref/source/libw32c.h at line 10 [10.2475780]

Insertion in crawl-ref/source/libw32c.h at line 64 [10.2475780]

Insertion in crawl-ref/source/libw32c.cc at line 1149 [10.2476860]

Insertion in crawl-ref/source/libunix.h at line 24 [10.2548819]

Insertion in crawl-ref/source/libunix.h at line 70 [10.2548819]

Insertion in crawl-ref/source/libunix.cc at line 36 [10.2550041]

Insertion in crawl-ref/source/libunix.cc at line 71 [10.2550041]

Insertion in crawl-ref/source/libunix.cc at line 1142 [10.2550041]

Insertion in crawl-ref/source/libunix.cc at line 1233 [10.2550041]

Insertion in crawl-ref/source/libunix.cc at line 1246 [10.2550041]

Insertion in crawl-ref/source/libdos.h at line 15 [12.630690]

Insertion in crawl-ref/source/libdos.h at line 48 [12.630690]

Insertion in crawl-ref/source/libdos.cc at line 140 [12.630803]

Insertion in crawl-ref/source/debug.h at line 147 [10.4011741]

Deletion in crawl-ref/source/debug.cc at line 47 [10.4016436]

Deletion in crawl-ref/source/debug.cc at line 48 [10.4016436]

Insertion in crawl-ref/source/debug.cc at line 5503 [10.4016436]

Insertion in crawl-ref/source/debug.cc at line 5529 [10.4016436]

Insertion in crawl-ref/source/acr.cc at line 198 [10.4397395]