sim: Add support for generating back traces on errors

Add functionality to generate a back trace if gem5 crashes (SIGABRT or
SIGSEGV). The current implementation uses glibc's stack traversal
support if available and stubs out the call to print_backtrace()
otherwise.

1 files changed, 66 insertions, 0 deletions

diff --git a/src/sim/backtrace_glibc.cc b/src/sim/backtrace_glibc.cc
new file mode 100644
index 000000000..93badc134
--- /dev/null
+++ b/src/sim/backtrace_glibc.cc
@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2015 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Andreas Sandberg
+ */
+
+#include "sim/backtrace.hh"
+
+#include <execinfo.h>
+#include <unistd.h>
+
+#include "base/atomicio.hh"
+
+#define SAFE_MSG(m)                                             \
+    do {                                                        \
+        static const char msg[] = m;                            \
+        atomic_write(STDERR_FILENO, msg, sizeof(msg) - 1);      \
+    } while(0)
+
+void
+print_backtrace()
+{
+    void *buffer[32];
+    int size;
+
+    size = backtrace(buffer, sizeof(buffer) / sizeof(*buffer));
+
+    STATIC_ERR("--- BEGIN LIBC BACKTRACE ---\n");
+    backtrace_symbols_fd(buffer, size, STDERR_FILENO);
+    if (size == sizeof(buffer))
+        STATIC_ERR("Warning: Backtrace may have been truncated.\n");
+    STATIC_ERR("--- END LIBC BACKTRACE ---\n");
+}