Merge pull request #22392 from adrian-prantl/DIFiles

adrian-prantl · web-flow · commit 70140a2d0ab2 · 2019-02-14T19:34:40.000-08:00
Bring the Swift frontend's handling of DIFiles in synch with CFE.
diff --git a/lib/IRGen/IRGenDebugInfo.cpp b/lib/IRGen/IRGenDebugInfo.cpp
@@ -371,28 +371,66 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
     }
 
     // Detect the main file.
-    if (MainFile && Filename.endswith(MainFile->getFilename())) {
+    StringRef MainFileName = MainFile->getFilename();
+    if (MainFile && Filename.endswith(MainFileName)) {
       SmallString<256> AbsThisFile, AbsMainFile;
       AbsThisFile = Filename;
       llvm::sys::fs::make_absolute(AbsThisFile);
-      llvm::sys::path::append(AbsMainFile, MainFile->getDirectory(),
-                              MainFile->getFilename());
-      if (AbsThisFile == AbsMainFile) {
+      if (llvm::sys::path::is_absolute(MainFileName))
+        AbsMainFile = MainFileName;
+      else
+        llvm::sys::path::append(AbsMainFile, MainFile->getDirectory(),
+                                MainFileName);
+      if (AbsThisFile == DebugPrefixMap.remapPath(AbsMainFile)) {
         DIFileCache[Filename] = llvm::TrackingMDNodeRef(MainFile);
         return MainFile;
       }
     }
 
-    // Create a new one.
-    StringRef File = llvm::sys::path::filename(Filename);
-    llvm::SmallString<512> Path(Filename);
-    llvm::sys::path::remove_filename(Path);
-    llvm::sys::path::remove_dots(Path);
-    llvm::DIFile *F = DBuilder.createFile(DebugPrefixMap.remapPath(File),
-                                          DebugPrefixMap.remapPath(Path));
-
-    // Cache it.
-    DIFileCache[Filename] = llvm::TrackingMDNodeRef(F);
+    return createFile(Filename, None, None);
+  }
+
+  /// This is effectively \p clang::CGDebugInfo::createFile().
+  llvm::DIFile *
+  createFile(StringRef FileName,
+             Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
+             Optional<StringRef> Source) {
+    StringRef Dir;
+    StringRef File;
+    SmallString<128> DirBuf;
+    SmallString<128> FileBuf;
+    std::string RemappedFileString = DebugPrefixMap.remapPath(FileName);
+    SmallString<128> RemappedFile = StringRef(RemappedFileString);
+    llvm::sys::path::remove_dots(RemappedFile);
+    std::string CurDir = DebugPrefixMap.remapPath(Opts.DebugCompilationDir);
+    if (llvm::sys::path::is_absolute(RemappedFile)) {
+      // Strip the common prefix (if it is more than just "/") from current
+      // directory and FileName for a more space-efficient encoding.
+      auto FileIt = llvm::sys::path::begin(RemappedFile);
+      auto FileE = llvm::sys::path::end(RemappedFile);
+      auto CurDirIt = llvm::sys::path::begin(CurDir);
+      auto CurDirE = llvm::sys::path::end(CurDir);
+      for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
+        llvm::sys::path::append(DirBuf, *CurDirIt);
+      if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
+        // Don't strip the common prefix if it is only the root "/"
+        // since that would make LLVM diagnostic locations confusing.
+        Dir = {};
+        File = RemappedFile;
+      } else {
+        for (; FileIt != FileE; ++FileIt)
+          llvm::sys::path::append(FileBuf, *FileIt);
+        Dir = DirBuf;
+        File = FileBuf;
+      }
+    } else {
+      File = RemappedFile;
+      // Leave <compiler-generated> & friends as is, without directory.
+      if (!(File.startswith("<") && File.endswith(">")))
+        Dir = CurDir;
+    }
+    llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
+    DIFileCache[FileName.data()].reset(F);
     return F;
   }
 
@@ -1620,16 +1658,17 @@ IRGenDebugInfoImpl::IRGenDebugInfoImpl(const IRGenOptions &Opts,
   // No split DWARF on Darwin.
   StringRef SplitName = StringRef();
   // Note that File + Dir need not result in a valid path.
-  // Clang is doing the same thing here.
+  // The directory part of the main file is the current working directory.
+  MainFile =
+      DBuilder.createFile(DebugPrefixMap.remapPath(SourcePath),
+                          DebugPrefixMap.remapPath(Opts.DebugCompilationDir));
+
   TheCU = DBuilder.createCompileUnit(
-      Lang, DBuilder.createFile(
-          DebugPrefixMap.remapPath(SourcePath),
-          DebugPrefixMap.remapPath(Opts.DebugCompilationDir)),
+      Lang, MainFile,
       Producer, Opts.shouldOptimize(), Flags, MajorRuntimeVersion, SplitName,
       Opts.DebugInfoLevel > IRGenDebugInfoLevel::LineTables
           ? llvm::DICompileUnit::FullDebug
           : llvm::DICompileUnit::LineTablesOnly);
-  MainFile = getOrCreateFile(SourcePath);
 
   // Because the swift compiler relies on Clang to setup the Module,
   // the clang CU is always created first.  Several dwarf-reading
diff --git a/test/DebugInfo/ClangPathDots.swift b/test/DebugInfo/ClangPathDots.swift
@@ -5,8 +5,10 @@
 // RUN: %target-swift-frontend -emit-ir %s -g -I %S/Inputs -o - \
 // RUN:   -module-cache-path %t.cache | %FileCheck %s --check-prefix=CACHED
 
-// FIRST: !DIFile(filename: "NSObject.h", directory: {{.*}}/include/objc")
-// CACHED: !DIFile(filename: "NSObject.h", directory: {{.*}}/include/objc")
+// Test that the paths have no extra "./" components on rebuild.
+
+// FIRST: !DIFile(filename: "{{.*}}/include/objc/NSObject.h",
+// CACHED: !DIFile(filename: "{{.*}}/include/objc/NSObject.h",
 
 import ObjectiveC
 
diff --git a/test/DebugInfo/Imports.swift b/test/DebugInfo/Imports.swift
@@ -7,8 +7,8 @@
 
 // CHECK-DAG: ![[FOOMODULE:[0-9]+]] = !DIModule({{.*}}, name: "Foo", includePath: "{{.*}}test{{.*}}DebugInfo{{.*}}"
 // CHECK-DAG: !DIImportedEntity(tag: DW_TAG_imported_module, scope: ![[THISFILE:[0-9]+]], entity: ![[FOOMODULE]]
-// CHECK-DAG: ![[THISFILE]] = !DIFile(filename: "Imports.swift", directory: "{{.*}}test{{/|\\5C}}DebugInfo")
-// CHECK-DAG: ![[SWIFTFILE:[0-9]+]] = !DIFile(filename: "Swift.swiftmodule"
+// CHECK-DAG: ![[THISFILE]] = !DIFile(filename: "{{.*}}test{{/|\\5C}}DebugInfo{{/|\\5C}}Imports.swift",
+// CHECK-DAG: ![[SWIFTFILE:[0-9]+]] = !DIFile(filename: "{{.*}}Swift.swiftmodule"
 // CHECK-DAG: ![[SWIFTMODULE:[0-9]+]] = !DIModule({{.*}}, name: "Swift"
 // CHECK-DAG: !DIImportedEntity(tag: DW_TAG_imported_module, scope: ![[THISFILE]], entity: ![[SWIFTMODULE]]
 // CHECK-DAG: ![[BASICMODULE:[0-9]+]] = !DIModule({{.*}}, name: "basic"
diff --git a/test/DebugInfo/ImportsStdlib.swift b/test/DebugInfo/ImportsStdlib.swift
@@ -11,9 +11,9 @@
 
 // CHECK-DAG: ![[MODULE:[0-9]+]] = !DIModule({{.*}}, name: "NotTheStdlib", includePath: "{{.*}}test{{.*}}DebugInfo{{.*}}"
 // CHECK-DAG: !DIImportedEntity(tag: DW_TAG_imported_module, scope: ![[THISFILE:[0-9]+]], entity: ![[MODULE]]
-// CHECK-DAG: ![[THISFILE]] = !DIFile(filename: "ImportsStdlib.swift", directory: "{{.*}}test{{/|\\5C}}DebugInfo")
+// CHECK-DAG: ![[THISFILE]] = !DIFile(filename: "{{.*}}test{{/|\\5C}}DebugInfo{{/|\\5C}}ImportsStdlib.swift"
 
-// NEGATIVE-NOT: !DIFile(filename: "Swift.swiftmodule"
+// NEGATIVE-NOT: !DIFile(filename: "{{.*}}Swift.swiftmodule"
 // NEGATIVE-NOT: !DIModule({{.*}}, name: "Swift"
 
 // DWARF: .debug_info
diff --git a/test/DebugInfo/basic.swift b/test/DebugInfo/basic.swift
@@ -3,8 +3,9 @@
 // Verify that we don't emit any debug info by default.
 // RUN: %target-swift-frontend %s -emit-ir -o - \
 // RUN:   | %FileCheck %s --check-prefix NDEBUG
+// NDEBUG: source_filename
 // NDEBUG-NOT: !dbg
-// NDEBUG-NOT: DW_TAG
+// NDEBUG-NOT: DICompileUnit
 // --------------------------------------------------------------------
 // Verify that we don't emit any debug info with -gnone.
 // RUN: %target-swift-frontend %s -emit-ir -gnone -o - \
@@ -14,9 +15,9 @@
 // RUN: %target-swift-frontend %s -emit-ir -gline-tables-only -o - \
 // RUN:   | %FileCheck %s --check-prefix CHECK-LINETABLES
 // CHECK: !dbg
-// CHECK-LINETABLES-NOT: DW_TAG_{{.*}}variable
+// CHECK-LINETABLES-NOT: DI{{.*}}Variable
 // CHECK-LINETABLES-NOT: DW_TAG_structure_type
-// CHECK-LINETABLES-NOT: DW_TAG_basic_type
+// CHECK-LINETABLES-NOT: DIBasicType
 // --------------------------------------------------------------------
 // Now check that we do generate line+scope info with -g.
 // RUN: %target-swift-frontend %/s -emit-ir -g -o - \
@@ -71,9 +72,8 @@ func foo(_ a: Int64, _ b: Int64) -> Int64 {
      }
 }
 
-// CHECK-DAG: ![[FILE_CWD:[0-9]+]] = !DIFile(filename: "{{.*}}DebugInfo/basic.swift", directory: "{{.*}}")
-// CHECK-DAG: ![[MAINFILE:[0-9]+]] = !DIFile(filename: "basic.swift", directory: "{{.*}}DebugInfo")
-// CHECK-DAG: !DICompileUnit(language: DW_LANG_Swift, file: ![[FILE_CWD]],{{.*}} producer: "{{.*}}Swift version{{.*}},{{.*}}
+// CHECK-DAG: ![[MAINFILE:[0-9]+]] = !DIFile(filename: "{{.*}}DebugInfo/basic.swift", directory: "{{.*}}")
+// CHECK-DAG: !DICompileUnit(language: DW_LANG_Swift, file: ![[MAINFILE]],{{.*}} producer: "{{.*}}Swift version{{.*}},{{.*}}
 // CHECK-DAG: !DISubprogram(name: "main", {{.*}}file: ![[MAINFILE]],
 
 // Function type for foo.
diff --git a/test/DebugInfo/gsil.swift b/test/DebugInfo/gsil.swift
@@ -3,7 +3,7 @@
 // RUN: %FileCheck %s < %t/out.ir
 // RUN: %FileCheck %s --check-prefix=CHECK_OUT_SIL < %t/out.ir.gsil_0.sil
 
-// CHECK: [[F:![0-9]+]] = !DIFile(filename: "out.ir.gsil_0.sil", directory: "{{.+}}")
+// CHECK: [[F:![0-9]+]] = !DIFile(filename: "{{.+}}out.ir.gsil_0.sil",
 // CHECK: !DISubprogram(linkageName: "$s3out6testityyF", scope: !{{[0-9]+}}, file: [[F]], line: {{[1-9][0-9]+}},
 
 // CHECK_OUT_SIL: sil @$s3out6testityyF : $@convention(thin) () -> () {
diff --git a/test/DebugInfo/inlinescopes.swift b/test/DebugInfo/inlinescopes.swift
@@ -7,7 +7,7 @@
 
 // CHECK: define{{( dllexport)?}}{{( protected)?( signext)?}} i32 @main
 // CHECK: call {{.*}}noinline{{.*}}, !dbg ![[CALL:.*]]
-// CHECK-DAG: ![[TOPLEVEL:.*]] = !DIFile(filename: "inlinescopes.swift"
+// CHECK-DAG: ![[TOPLEVEL:.*]] = !DIFile(filename: "{{.*}}inlinescopes.swift"
 
 import FooBar
 
diff --git a/test/DebugInfo/line-directive.swift b/test/DebugInfo/line-directive.swift
@@ -8,18 +8,18 @@ func f() {
   markUsed("Test")
 #sourceLocation(file: "abc.swift", line: 142)
   markUsed("abc again")
-#sourceLocation(file: "def.swift", line:  142)
+#sourceLocation(file: "/absolute/path/def.swift", line:  142)
   markUsed("jump directly to def")
 }
 
 // RUN: %target-swift-frontend -primary-file %/s -S -g -o - | %FileCheck %s
 // CHECK: .file	[[MAIN:.*]] "{{.*}}line-directive.swift"
 // CHECK: .loc	[[MAIN]] 1
-// CHECK: .file	[[ABC:.*]] "abc.swift"
+// CHECK: .file	[[ABC:.*]] "{{.*}}abc.swift"
 // CHECK: .loc	[[ABC]] 42
 // CHECK: .loc	[[MAIN]] 8
 // CHECK: .loc	[[ABC]] 142
-// CHECK: .file	[[DEF:.*]] "def.swift"
+// CHECK: .file	[[DEF:.*]] "/absolute/path/def.swift"
 // CHECK: .loc	[[DEF]] 142
 // CHECK: .asciz "{{.*}}test/DebugInfo"
 
@@ -28,10 +28,10 @@ func f() {
 // RUN: %target-swift-frontend -vfsoverlay %t/overlay.yaml -primary-file %/S/vfs-relocated-line-directive.swift -S -g -o - | %FileCheck -check-prefix=VFS %s
 // VFS: .file  [[MAIN:.*]] "{{.*}}vfs-relocated-line-directive.swift"
 // VFS: .loc  [[MAIN]] 1
-// VFS: .file  [[ABC:.*]] "abc.swift"
+// VFS: .file  [[ABC:.*]] "{{.*}}abc.swift"
 // VFS: .loc  [[ABC]] 42
 // VFS: .loc  [[MAIN]] 8
 // VFS: .loc  [[ABC]] 142
-// VFS: .file  [[DEF:.*]] "def.swift"
+// VFS: .file  [[DEF:.*]] "/absolute/path/def.swift"
 // VFS: .loc  [[DEF]] 142
 // VFS: .asciz "{{.*}}test/DebugInfo"
diff --git a/test/DebugInfo/test-foundation.swift b/test/DebugInfo/test-foundation.swift
@@ -17,7 +17,7 @@ class MyObject : NSObject {
   // LOC-CHECK: ret {{.*}}, !dbg ![[DBG:.*]]
   // LOC-CHECK: ret
   @objc var MyArr = NSArray()
-  // IMPORT-CHECK: filename: "test-foundation.swift"
+  // IMPORT-CHECK: filename: "{{.*}}test-foundation.swift"
   // IMPORT-CHECK-DAG: [[FOUNDATION:[0-9]+]] = !DIModule({{.*}} name: "Foundation",{{.*}} includePath: {{.*}}Foundation.framework
   // IMPORT-CHECK-DAG: [[OVERLAY:[0-9]+]] = !DIModule({{.*}} name: "Foundation",{{.*}} includePath: {{.*}}Foundation.swiftmodule
   // IMPORT-CHECK-DAG: !DICompositeType(tag: DW_TAG_structure_type, name: "NSArray", scope: ![[NSARRAY:[0-9]+]]
diff --git a/test/DebugInfo/variables.swift b/test/DebugInfo/variables.swift
@@ -41,7 +41,7 @@ print(", \(glob_b)", terminator: "")
 print(", \(glob_s)", terminator: "")
 var unused: Int32 = -1
 
-// CHECK-DAG: ![[RT:[0-9]+]] ={{.*}}"Swift.swiftmodule"
+// CHECK-DAG: ![[RT:[0-9]+]] ={{.*}}"{{.*}}Swift.swiftmodule"
 
 
 // Stack variables.
@@ -114,4 +114,4 @@ func myprint(_ value: TriValue) {
 }
 myprint(unknown)
 
-// CHECK-DAG: !DIFile(filename: "variables.swift"
+// CHECK-DAG: !DIFile(filename: "{{.*}}variables.swift"
diff --git a/test/IRGen/multithread_module.swift b/test/IRGen/multithread_module.swift
@@ -62,8 +62,8 @@ func callproto(_ p: MyProto) {
 
 // Check if the DI filename is correct and not "<unknown>".
 
-// CHECK-MAINLL: DICompileUnit(language: DW_LANG_Swift, file: [[F:![0-9]+]]
-// CHECK-MAINLL: [[F]] = !DIFile(filename: "{{.*}}IRGen/Inputs/multithread_module/main.swift", directory: "{{.*}}")
+// CHECK-MAINLL: [[F:![0-9]+]] = !DIFile(filename: "{{.*}}IRGen/Inputs/multithread_module/main.swift", directory: "{{.*}}")
+// CHECK-MAINLL: DICompileUnit(language: DW_LANG_Swift, file: [[F]],
 
-// CHECK-MODULELL: DICompileUnit(language: DW_LANG_Swift, file: [[F:![0-9]+]]
-// CHECK-MODULELL: [[F]] = !DIFile(filename: "{{.*}}IRGen/multithread_module.swift", directory: "{{.*}}")
+// CHECK-MODULELL: [[F:![0-9]]] = !DIFile(filename: "{{.*}}IRGen/multithread_module.swift", directory: "{{.*}}")
+// CHECK-MODULELL: DICompileUnit(language: DW_LANG_Swift, file: [[F]],
