[ThinLTO] Escape module paths when printing

[chrisjackson]

Summary

We have located a bug in AssemblyWriter::printModuleSummaryIndex(). This
function outputs path strings incorrectly. Backslashes in the string are not
correctly escaped. Hence, only windows environments are affected.

Consequently, if a path name contains a backslash followed by two hexadecimal
characters, the sequence is incorrectly interpreted when the output is read by
another component. This mangles the path and results in error.

This patch fixes this issue by calling printEscapedString() to output the paths.

[pcc]

Would it be possible to make the test case simpler? I'm thinking that you could start with an input file with an embedded path containing a backslash, pipe it through llvm-as | llvm-dis and check that the escaping is preserved. That would mean that it could run on non-Windows as well.

[dexonsmith]

test/Assembler/asm-path-writer.ll

1

It's unfortunate that this requires Windows. Is it possible to check in textual IR file where a path: has (properly escaped) backslashes in it, and round-trip it back to assembly?

[tejohnson]

test/Assembler/asm-path-writer.ll

1

Right, this is possible since the asm parsing support is also in now. All you should need is a module path and at least one corresponding GV entry. If you use the guid form instead of a name for the gv, it will not require any corresponding IR. I.e. it can just be something like:

^0 = module: (path: "someescapedpath", hash: (0, 0, 0, 0, 0))
^1 = gv: (guid: 17407585008595848568, summaries: (function: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), insts: 1)))

(but using an escaped path reproducing the issue)

Then just round trip through llvm-as and llvm-dis and check the output as Peter and Duncan suggested.

[chrisjackson]

Followed suggestions to make the test simpler.

[tejohnson]

LGTM

[dexonsmith]

LGTM too.

lib/IR/AsmWriter.cpp

moduleVec[Machine.getModulePathSlot(ModPath.first())] = std::make_pair(
         // during the thin link.
         ModPath.second.first == -1u ? RegularLTOModuleName
                                     : (std::string)ModPath.first(),
         ModPath.second.second);
 
   unsigned i = 0;
   for (auto &ModPair : moduleVec) {
     Out << "^" << i++ << " = module: (";
-    Out << "path: \"" << ModPair.first << "\"";
-    Out << ", hash: (";
+    Out << "path: \"";
+    printEscapedString(ModPair.first, Out);
+    Out << "\", hash: (";
     FieldSeparator FS;
     for (auto Hash : ModPair.second)
       Out << FS << Hash;
     Out << "))\n";
   }
 
   // FIXME: Change AliasSummary to hold a ValueInfo instead of summary pointer
   // for aliasee (then update BitcodeWriter.cpp and remove get/setAliaseeGUID).

test/Assembler/asm-path-writer.ll

+; REQUIRES: system-windows
+; RUN: mkdir -p %t.dir\f4folder
+; RUN: opt -module-summary %s -o %t.dir\f4folder\thinlto-alias.tmp.o
+; RUN: opt -module-summary %p\..\BitCode\Inputs\thinlto-alias.ll -o %t.dir\f4folder\thinlto-alias.tmp2.o
+; RUN: llvm-lto -thinlto -o %t.dir\f4folder\thinlto-alias %t.dir\f4folder\thinlto-alias.tmp.o %t.dir\f4folder\thinlto-alias.tmp2.o
+; RUN: llvm-dis  %t.dir\f4folder\thinlto-alias.thinlto.bc -o %t.dir\f4folder\thinlto-alias.thinlto.dis
+; RUN: llvm-as %t.dir\f4folder\thinlto-alias.thinlto.dis
+
+; ModuleID = 'thinlto-function-summary-callgraph.ll'
+target datalayout = "e-m:e-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-unknown-linux-gnu"
+
+; Function Attrs: nounwind uwtable
+define i32 @main() {
+entry:
+    call void (...) @analias()
+    ret i32 0
+}
+
+declare void @analias(...)
+
+; DIS: ^0 = module: (path: "{{.*}}", hash: (0, 0, 0, 0, 0))
+; DIS: ^1 = gv: (name: "analias", summaries: (alias: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), aliasee: ^2))) ; guid = 12695095382722328222
+; DIS: ^2 = gv: (name: "aliasee", summaries: (function: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), insts: 1))) ; guid = 17407585008595848568
+
+; COMBINED-DIS: ^0 = module: (path: "{{.*}}thinlto-alias.ll.tmp.o", hash: (0, 0, 0, 0, 0))
+; COMBINED-DIS: ^1 = module: (path: "{{.*}}thinlto-alias.ll.tmp2.o", hash: (0, 0, 0, 0, 0))
+; COMBINED-DIS: ^2 = gv: (guid: 12695095382722328222, summaries: (alias: (module: ^1, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), aliasee: ^4)))
+; COMBINED-DIS: ^3 = gv: (guid: 15822663052811949562, summaries: (function: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), insts: 2, calls: ((callee: ^2)))))
+; COMBINED-DIS: ^4 = gv: (guid: 17407585008595848568, summaries: (function: (module: ^1, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), insts: 1)))