Handle mixed-OS paths in DWARF reader

[eugene]

Summary

Make sure that DWARF line information generated by Windows can be properly read by Posix OS and vice versa.

[eugene]

clang-format

[aprantl]

This will also need a testcase.

lib/DebugInfo/DWARF/DWARFDebugLine.cpp

956 ↗

(On Diff #137703)

Shouldn't this function be provided in libSupport? For example, by adding a new enumerator sys::path::Style::any ?

[eugene]

Added a test

[zturner]

Is there some kind of field we can write inside the DWARF that can tell us what path syntax to assume? I'm a little weary about trying to guess. It seems like there could be lots of edge cases where we incorrectly determine what syntax a path is using.

lib/DebugInfo/DWARF/DWARFDebugLine.cpp

956 ↗

(On Diff #137703)

It seems pretty special purpose. If we were going to put something in support I would rather have it be something like sys::path::guess_path_syntax(const Twine &Path)

[eugene]

In D44290#1034041, @zturner wrote:

Is there some kind of field we can write inside the DWARF that can tell us what path syntax to assume?

As far as I know DWARF doesn't have a field like this.

I'm a little weary about trying to guess. It seems like there could be lots of edge cases where we incorrectly determine what syntax a path is using.

I share your worry for the general practice, but in this particular case I think it's ok.
If path is absolute on any OS (starts with / or X:) the code will treat it like it is absolute, and just won't try to concatenate more things together.

On Windows Android NDK produces binaries where different CUs have different path styles. Those binaries need to be symbolized on Linux and Mac OS, hence this change removing assumption that path style is always native.

[labath]

I think that adding a path-style field to dwarf (it would probably have to be a vendor extension) is an excellent idea. However, that won't help us with parsing the existing debug info corpus. This isn't going to be 100% correct (e.g. c:\foo.cpp is a valid relative path on unix), but I hope nobody actually uses file names where that matters. If someone like that turns up, then we'd probably have to add a some flag about how the user wants the paths to be treated, as there is no way we can figure out the correct behavior automatically.

[aprantl]

Oh well, I think you convinced me.

llvm/trunk/lib/DebugInfo/DWARF/DWARFDebugLine.cpp

Optional<StringRef> DWARFDebugLine::LineTable::getSourceByIndex(uint64_t FileIndex,
   if (Kind == FileLineInfoKind::None || !hasFileAtIndex(FileIndex))
     return None;
   const FileNameEntry &Entry = Prologue.FileNames[FileIndex - 1];
   if (Optional<const char *> source = Entry.Source.getAsCString())
     return StringRef(*source);
   return None;
 }
 
+static bool isPathAbsoluteOnWindowsOrPosix(const Twine &Path) {
+  // Debug info can contain paths from any OS, not necessarily
+  // an OS we're currently running on. Moreover different compilation units can
+  // be compiled on different operating systems and linked together later.
+  return sys::path::is_absolute(Path, sys::path::Style::posix) ||
+         sys::path::is_absolute(Path, sys::path::Style::windows);
+}
+
 bool DWARFDebugLine::LineTable::getFileNameByIndex(uint64_t FileIndex,
                                                    const char *CompDir,
                                                    FileLineInfoKind Kind,
                                                    std::string &Result) const {
   if (Kind == FileLineInfoKind::None || !hasFileAtIndex(FileIndex))
     return false;
   const FileNameEntry &Entry = Prologue.FileNames[FileIndex - 1];
   StringRef FileName = Entry.Name.getAsCString().getValue();
   if (Kind != FileLineInfoKind::AbsoluteFilePath ||
-      sys::path::is_absolute(FileName)) {
+      isPathAbsoluteOnWindowsOrPosix(FileName)) {
     Result = FileName;
     return true;
   }
 
   SmallString<16> FilePath;
   uint64_t IncludeDirIndex = Entry.DirIdx;
   StringRef IncludeDir;
   // Be defensive about the contents of Entry.
   if (IncludeDirIndex > 0 &&
       IncludeDirIndex <= Prologue.IncludeDirectories.size())
     IncludeDir = Prologue.IncludeDirectories[IncludeDirIndex - 1]
                      .getAsCString()
                      .getValue();
 
   // We may still need to append compilation directory of compile unit.
   // We know that FileName is not absolute, the only way to have an
   // absolute path at this point would be if IncludeDir is absolute.
   if (CompDir && Kind == FileLineInfoKind::AbsoluteFilePath &&
-      sys::path::is_relative(IncludeDir))
+      !isPathAbsoluteOnWindowsOrPosix(IncludeDir))
     sys::path::append(FilePath, CompDir);
 
   // sys::path::append skips empty strings.
   sys::path::append(FilePath, IncludeDir, FileName);
   Result = FilePath.str();
   return true;
 }
 

llvm/trunk/test/DebugInfo/debuglineinfo-path.ll

+; Make sure that absolute source dir is detected correctly regardless of the platform.
+; REQUIRES: object-emission
+; RUN: %llc_dwarf -filetype=obj -o %t < %s
+; RUN: echo -n 0x > %t.posix_relative_func
+; RUN: echo -n 0x > %t.posix_absolute_func
+; RUN: echo -n 0x > %t.win_func
+; RUN: llvm-nm %t | grep posix_absolute_func >> %t.posix_absolute_func
+; RUN: llvm-nm %t | grep posix_relative_func >> %t.posix_relative_func
+; RUN: llvm-nm %t | grep win_func  >> %t.win_func
+; RUN: llvm-symbolizer --functions=linkage --inlining --demangle=false --obj %t < %t.posix_absolute_func | FileCheck %s --check-prefix=POSIX_A
+; RUN: llvm-symbolizer --functions=linkage --inlining --demangle=false --obj %t < %t.posix_relative_func | FileCheck %s --check-prefix=POSIX_R
+; RUN: llvm-symbolizer --functions=linkage --inlining --demangle=false --obj %t < %t.win_func | FileCheck %s --check-prefix=WIN
+
+;POSIX_A: posix_absolute_func
+;POSIX_A: /absolute/posix/path{{[\/]}}posix.c
+
+;POSIX_R: posix_relative_func
+;POSIX_R: /ABSOLUTE/CU/PATH{{[\/]}}relative/posix/path{{[\/]}}posix2.c
+
+;WIN: win_func
+;WIN: E:\absolute\windows\path{{[\/]}}win.c
+
+
+target datalayout = "e-m:e-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-pc-linux-gnu"
+
+define i32 @win_func() #0 !dbg !54 {
+  ret i32 5, !dbg !511
+}
+
+define i32 @posix_absolute_func() #0 !dbg !34 {
+  ret i32 3, !dbg !311
+}
+
+define i32 @posix_relative_func() #0 !dbg !44 {
+  ret i32 4, !dbg !411
+}
+
+!llvm.dbg.cu = !{!50, !30, !40}
+!llvm.module.flags = !{!8, !9}
+!llvm.ident = !{!10}
+!8 = !{i32 2, !"Dwarf Version", i32 4}
+!9 = !{i32 2, !"Debug Info Version", i32 3}
+!10 = !{!"clang"}
+
+!50 = distinct !DICompileUnit(language: DW_LANG_C99, file: !512, producer: "clang", isOptimized: false, runtimeVersion: 0, emissionKind: 1, enums: !52)
+!51 = !DIFile(filename: "win.c", directory: "E:\\absolute\\windows\\path")
+!52 = !{}
+!53 = !{!54}
+!54 = distinct !DISubprogram(name: "win_func", scope: !51, file: !51, line: 55, type: !55, unit: !50, isLocal: false, isDefinition: true, scopeLine: 1, isOptimized: false, variables: !52)
+!55 = !DISubroutineType(types: !56)
+!56 = !{!57}
+!57 = !DIBasicType(name: "int", size: 32, align: 32, encoding: DW_ATE_signed)
+!511 = !DILocation(line: 55, column: 2, scope: !54)
+!512 = !DIFile(filename: "a.c", directory: "/WIN_CU/PATH")
+
+!30 = distinct !DICompileUnit(language: DW_LANG_C99, file: !312, producer: "clang", isOptimized: false, runtimeVersion: 0, emissionKind: 1, enums: !32)
+!31 = !DIFile(filename: "posix.c", directory: "/absolute/posix/path")
+!32 = !{}
+!33 = !{!34}
+!34 = distinct !DISubprogram(name: "posix_absolute_func", scope: !31, file: !31, line: 33, type: !35, unit: !30, isLocal: false, isDefinition: true, scopeLine: 1, isOptimized: false, variables: !32)
+!35 = !DISubroutineType(types: !36)
+!36 = !{!37}
+!37 = !DIBasicType(name: "int", size: 32, align: 32, encoding: DW_ATE_signed)
+!311 = !DILocation(line: 33, column: 2, scope: !34)
+!312 = !DIFile(filename: "b.c", directory: "/POSIX_CU/PATH")
+
+!40 = distinct !DICompileUnit(language: DW_LANG_C99, file: !412, producer: "clang", isOptimized: false, runtimeVersion: 0, emissionKind: 1, enums: !42)
+!41 = !DIFile(filename: "posix2.c", directory: "relative/posix/path")
+!42 = !{}
+!43 = !{!44}
+!44 = distinct !DISubprogram(name: "posix_relative_func", scope: !41, file: !41, line: 44, type: !45, unit: !40, isLocal: false, isDefinition: true, scopeLine: 1, isOptimized: false, variables: !42)
+!45 = !DISubroutineType(types: !46)
+!46 = !{!47}
+!47 = !DIBasicType(name: "int", size: 32, align: 32, encoding: DW_ATE_signed)
+!411 = !DILocation(line: 44, column: 2, scope: !44)
+!412 = !DIFile(filename: "c.c", directory: "/ABSOLUTE/CU/PATH")
+