8242181: [Linux] Show source information when printing native stack traces in hs_err files

Reviewed-by: erikj, tschatzl, stuefe, ihse

Author: chhagedorn

make/RunTests.gmk

@@ -785,6 +785,8 @@ define SetupRunJtregTestBody
   # symbol lookup in hserr files
   ifeq ($$(call isTargetOs, windows), true)
     $1_JTREG_BASIC_OPTIONS += -e:_NT_SYMBOL_PATH
+  else ifeq ($$(call isTargetOs, linux), true)
+      $1_JTREG_BASIC_OPTIONS += -e:_JVM_DWARF_PATH=$$(SYMBOLS_IMAGE_DIR)
   endif
 
   $1_JTREG_BASIC_OPTIONS += \

make/autoconf/flags-cflags.m4

@@ -113,7 +113,7 @@ AC_DEFUN([FLAGS_SETUP_DEBUG_SYMBOLS],
       )
     fi
 
-    CFLAGS_DEBUG_SYMBOLS="-g"
+    CFLAGS_DEBUG_SYMBOLS="-g -gdwarf-4"
     ASFLAGS_DEBUG_SYMBOLS="-g"
   elif test "x$TOOLCHAIN_TYPE" = xclang; then
     if test "x$ALLOW_ABSOLUTE_PATHS_IN_OUTPUT" = "xfalse"; then

make/conf/jib-profiles.js

@@ -943,15 +943,16 @@ var getJibProfilesProfiles = function (input, common, data) {
             target_cpu: input.build_cpu,
             dependencies: [
                 "jtreg", "gnumake", "boot_jdk", "devkit", "jib", "jcov", testedProfileJdk,
-                testedProfileTest
+                testedProfileTest, testedProfile + ".jdk_symbols",
             ],
             src: "src.conf",
             make_args: testOnlyMake,
             environment: {
                 "BOOT_JDK": common.boot_jdk_home,
                 "JT_HOME": input.get("jtreg", "home_path"),
                 "JDK_IMAGE_DIR": input.get(testedProfileJdk, "home_path"),
-                "TEST_IMAGE_DIR": input.get(testedProfileTest, "home_path")
+                "TEST_IMAGE_DIR": input.get(testedProfileTest, "home_path"),
+                "SYMBOLS_IMAGE_DIR": input.get(testedProfile + ".jdk_symbols", "home_path")
             },
             labels: "test"
         }
@@ -991,17 +992,6 @@ var getJibProfilesProfiles = function (input, common, data) {
         profiles["run-test"] = concatObjects(profiles["run-test"], macosxRunTestExtra);
         profiles["run-test-prebuilt"] = concatObjects(profiles["run-test-prebuilt"], macosxRunTestExtra);
     }
-    // On windows we want the debug symbols available at test time
-    if (input.build_os == "windows") {
-        windowsRunTestPrebuiltExtra = {
-            dependencies: [ testedProfile + ".jdk_symbols" ],
-            environment: {
-                "SYMBOLS_IMAGE_DIR": input.get(testedProfile + ".jdk_symbols", "home_path"),
-            }
-        };
-        profiles["run-test-prebuilt"] = concatObjects(profiles["run-test-prebuilt"],
-            windowsRunTestPrebuiltExtra);
-    }
 
     // The profile run-test-prebuilt defines src.conf as the src bundle. When
     // running in Mach 5, this reduces the time it takes to populate the

src/hotspot/os/windows/decoder_windows.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -35,7 +35,7 @@ bool Decoder::decode(address addr, char* buf, int buflen, int* offset, const voi
   return SymbolEngine::decode(addr, buf, buflen, offset, true);
 }
 
-bool Decoder::get_source_info(address pc, char* buf, size_t buflen, int* line) {
+bool Decoder::get_source_info(address pc, char* buf, size_t buflen, int* line, bool is_pc_after_call) {
   return SymbolEngine::get_source_info(pc, buf, buflen, line);
 }
 

src/hotspot/share/runtime/globals.hpp

@@ -511,6 +511,10 @@ const int ObjectAlignmentInBytes = 8;
           "error log in case of a crash.")                                  \
           range(0, (uint64_t)max_jlong/1000)                                \
                                                                             \
+  develop(intx, TraceDwarfLevel, 0,                                         \
+          "Debug levels for the dwarf parser")                              \
+          range(0, 4)                                                       \
+                                                                            \
   product(bool, SuppressFatalErrorMessage, false,                           \
           "Report NO fatal error message (avoid deadlock)")                 \
                                                                             \

src/hotspot/share/utilities/decoder.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2017, 2020 SAP SE. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
@@ -113,8 +113,13 @@ bool Decoder::demangle(const char* symbol, char* buf, int buflen) {
 void Decoder::print_state_on(outputStream* st) {
 }
 
-bool Decoder::get_source_info(address pc, char* buf, size_t buflen, int* line) {
-  return false;
+bool Decoder::get_source_info(address pc, char* filename, size_t filename_len, int* line, bool is_pc_after_call) {
+  if (VMError::is_error_reported_in_current_thread()) {
+    return get_error_handler_instance()->get_source_info(pc, filename, filename_len, line, is_pc_after_call);
+  } else {
+    MutexLocker locker(shared_decoder_lock(), Mutex::_no_safepoint_check_flag);
+    return get_shared_instance()->get_source_info(pc, filename, filename_len, line, is_pc_after_call);
+  }
 }
 
 #endif // !_WINDOWS

src/hotspot/share/utilities/decoder.hpp

@@ -63,6 +63,11 @@ class AbstractDecoder : public CHeapObj<mtInternal> {
   // demangle a C++ symbol
   virtual bool demangle(const char* symbol, char* buf, int buflen) = 0;
 
+  // Get filename and line number information.
+  virtual bool get_source_info(address pc, char* filename, size_t filename_len, int* line, bool is_pc_after_call) {
+    return false;
+  }
+
   virtual decoder_status status() const {
     return _decoder_status;
   }
@@ -109,9 +114,11 @@ class Decoder : AllStatic {
   static bool demangle(const char* symbol, char* buf, int buflen);
 
   // Attempts to retrieve source file name and line number associated with a pc.
-  // If buf != NULL, points to a buffer of size buflen which will receive the
+  // If filename != NULL, points to a buffer of size filename_len which will receive the
   // file name. File name will be silently truncated if output buffer is too small.
-  static bool get_source_info(address pc, char* buf, size_t buflen, int* line);
+  // If is_pc_after_call is true, then pc is treated as pointing to the next instruction
+  // after a call. The source information for the call instruction is fetched in that case.
+  static bool get_source_info(address pc, char* filename, size_t filename_len, int* line, bool is_pc_after_call = false);
 
   static void print_state_on(outputStream* st);
 

src/hotspot/share/utilities/decoder_elf.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -26,7 +26,8 @@
 
 #if !defined(_WINDOWS) && !defined(__APPLE__)
 #include "decoder_elf.hpp"
-#include "memory/allocation.inline.hpp"
+#include "logging/log.hpp"
+#include "runtime/os.hpp"
 
 ElfDecoder::~ElfDecoder() {
   if (_opened_elf_files != NULL) {
@@ -53,6 +54,45 @@ bool ElfDecoder::decode(address addr, char *buf, int buflen, int* offset, const
   return true;
 }
 
+bool ElfDecoder::get_source_info(address pc, char* filename, size_t filename_len, int* line, bool is_pc_after_call) {
+  assert(filename != nullptr && filename_len > 0 && line != nullptr, "Argument error");
+  filename[0] = '\0';
+  *line = -1;
+
+  char filepath[JVM_MAXPATHLEN];
+  filepath[JVM_MAXPATHLEN - 1] = '\0';
+  int offset_in_library = -1;
+  if (!os::dll_address_to_library_name(pc, filepath, sizeof(filepath), &offset_in_library)) {
+    // Method not found. offset_in_library should not overflow.
+    DWARF_LOG_ERROR("Did not find library for address " INTPTR_FORMAT, p2i(pc))
+    return false;
+  }
+
+  if (filepath[JVM_MAXPATHLEN - 1] != '\0') {
+    DWARF_LOG_ERROR("File path is too large to fit into buffer of size %d", JVM_MAXPATHLEN);
+    return false;
+  }
+
+  const uint32_t unsigned_offset_in_library = (uint32_t)offset_in_library;
+
+  ElfFile* file = get_elf_file(filepath);
+  if (file == NULL) {
+    return false;
+  }
+  DWARF_LOG_INFO("##### Find filename and line number for offset " PTR32_FORMAT " in library %s #####",
+                 unsigned_offset_in_library, filepath);
+
+  if (!file->get_source_info(unsigned_offset_in_library, filename, filename_len, line, is_pc_after_call)) {
+    return false;
+  }
+
+  DWARF_LOG_SUMMARY("pc: " INTPTR_FORMAT ", offset: " PTR32_FORMAT ", filename: %s, line: %u",
+                       p2i(pc), offset_in_library, filename, *line);
+  DWARF_LOG_INFO("") // To structure the debug output better.
+  return true;
+}
+
+
 ElfFile* ElfDecoder::get_elf_file(const char* filepath) {
   ElfFile* file;
 

src/hotspot/share/utilities/decoder_elf.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -45,6 +45,7 @@ class ElfDecoder : public AbstractDecoder {
     ShouldNotReachHere();
     return false;
   }
+  bool get_source_info(address pc, char* buf, size_t buflen, int* line, bool is_pc_after_call);
 
 private:
   ElfFile*         get_elf_file(const char* filepath);