[llvm-objdump] Quote filename to fix windows test failure

[mmpozulp]

Summary

Attempts to fix buildbot failure
http://lab.llvm.org:8011/builders/llvm-clang-lld-x86_64-scei-ps4-windows10pro-fast/builds/27368
which Douglas Yung alerted me to. Doug observed that:
2 tests modified r367776 are failing when run on a Windows bot.
It seems to be due to the [[FILE]] substitution escaping characters
and then expecting the output generated to match it which it does
not since things are then doubly escaped.

[mmpozulp]

@dyung @jhenderson do either of you know how I can test this on windows without having my own windows machine? It passes on my linux box but that's not where the failure was. Thanks :)

[grimar]

It is not OK to have the bot red for a long time.
The builder mentioned (http://lab.llvm.org:8011/builders/llvm-clang-lld-x86_64-scei-ps4-windows10pro-fast/builds/27368)
is down for about 24h because of r367776 it seems.
The normal action would be to revert it, then retest with this patch and reland the fixed version I think.

I can help you with the testing on windows if needed.

[mmpozulp]

@grimar I reverted the commit, re-opened the original revision, and updated it with the '[[FILE]]' change. I'd love if you could test it on windows for me! Please use https://reviews.llvm.org/D62462.

[jhenderson]

Drive by comment, because I don't have time right now to verify my suggestion myself, but it's important to remember that on Windows, file paths are usually printed with backslashes in, i.e. "foo\bar\wibble.c" or whatever. %p and %t etc substitutions use backward slashes on Windows, unless you specify them as '%/p' and '%/t' or '%\p' and '%\t' (which force the slash direction IIRC). Note that this means that your current expansion looks like 'C:\an\absolute\path/Inputs/source-interleave.x86-64.c' or something like that. I don't think the double escaping is relevant - that's just an artifact of how FileCheck prints its messages, though you probably will need to be careful when sed gets involved (i.e. use %/t etc). I think your solution is going to need to be cleverer than this. I don't think quoting is what you want - those single quote will just try to match single quotes in the output, and have no effect on the escaping etc. You are probably going to need to be cleverer with your test. It probably needs to copy the source into a temporary file location or something like that, so that you can reference it as %t.c (or some equivalent), which allows you to use that path without slashes in your -DFILE check.

[dyung]

I'm not at a Windows machine at the moment, so I can't test your fix, but I'm doubtful that it would actually work.

I think that in my experience trying to get "[[FILE]]" to work on Windows and non-Windows platforms is really hard. You might want to try another approach. Do you need to explicitly verify the entire path is present? Or would it be enough to just verify that the test filename appears in that line?

[mmpozulp]

Ok thanks for the explanations @jhenderson and @dyung. I abandoned my attempt to use [[FILE]] in the tests. See https://reviews.llvm.org/D62462.

llvm/test/tools/llvm-objdump/X86/source-interleave-invalid-source.test

 ## Test llvm-objdump's --source behaviour when a line number is greater than the
 ## file length and ensure that we emit a warning.
 
 # RUN: sed -e "s,SRC_COMPDIR,%/p/Inputs,g" %p/Inputs/source-interleave.ll > %t.ll
 # RUN: sed -e "s,line: 7,line: 9999,g" %t.ll > %t2.ll
 
 # RUN: llc -o %t.o -filetype=obj -mtriple=x86_64-pc-linux %t.ll
 # RUN: llc -o %t2.o -filetype=obj -mtriple=x86_64-pc-linux %t2.ll
 
 # RUN: llvm-objdump --source %t.o | FileCheck %s --check-prefixes=CHECK,GOOD
 # RUN: llvm-objdump --source %t2.o 2> %t2.e | FileCheck %s --check-prefixes=CHECK --implicit-check-not="int *b = &a;"
 # RUN: FileCheck %s --input-file %t2.e --check-prefixes=WARN -DFILE=%p/Inputs/source-interleave-x86_64.c
 
 # CHECK:      main:
 # CHECK-NEXT: ; int main() {
-# WARN:       warning: debug info line number 9999 exceeds the number of lines in [[FILE]]
+# WARN:       warning: debug info line number 9999 exceeds the number of lines in '[[FILE]]'
 # GOOD:       ;   int *b = &a;
 # CHECK:      ;   return *b + foo();

llvm/test/tools/llvm-objdump/X86/source-interleave-missing-source.test

 ## Test that if the source cannot be found that disassembly is still printed,
 ## that no source is printed, and that we emit a warning.
 
 # RUN: sed -e "s,SRC_COMPDIR,%/t,g" %p/Inputs/source-interleave.ll > %t.ll
 # RUN: sed -e "s,SRC_COMPDIR,%/p/Inputs,g" %p/Inputs/source-interleave.ll > %t2.ll
 
 # RUN: llc -o %t.o -filetype=obj -mtriple=x86_64-pc-linux %t.ll
 # RUN: llc -o %t2.o -filetype=obj -mtriple=x86_64-pc-linux %t2.ll
 
 # RUN: llvm-objdump --source %t.o 2> %t.e | FileCheck %s --check-prefixes=CHECK --implicit-check-not='main()'
 # RUN: llvm-objdump --source %t2.o | FileCheck %s --check-prefixes=CHECK,SOURCE
 # RUN: FileCheck %s --input-file %t.e --check-prefixes=WARN -DFILE=%t/source-interleave-x86_64.c
 
-# WARN:        warning: failed to find source [[FILE]]
+# WARN:        warning: failed to find source '[[FILE]]'
 # CHECK:       0000000000000010 main:
 # SOURCE-NEXT: ; int main() {
 # CHECK-NEXT:   10:   55                      pushq   %rbp

llvm/test/tools/llvm-objdump/X86/source-interleave-no-debug-info.test

 ## Test that if an object has no debug information, only the disassembly is
 ## printed when --source is specified, and that we emit a warning.
 
 # RUN: sed -e "s,SRC_COMPDIR,%/p/Inputs,g" %p/Inputs/source-interleave.ll > %t.ll
 # RUN: llc -o %t.o -filetype=obj -mtriple=x86_64-pc-linux %t.ll
 # RUN: llvm-objcopy --strip-debug %t.o %t2.o
 
 # RUN: llvm-objdump --source %t.o | FileCheck %s --check-prefixes=CHECK,SOURCE
 # RUN: llvm-objdump --source %t2.o 2> %t2.e | FileCheck %s --check-prefixes=CHECK --implicit-check-not='main()'
 # RUN: FileCheck %s --input-file %t2.e --check-prefixes=WARN -DFILE=%t2.o
 
-# WARN:        warning: failed to parse debug information for [[FILE]]
+# WARN:        warning: failed to parse debug information for '[[FILE]]'
 # CHECK:       0000000000000010 main:
 # SOURCE-NEXT: ; int main() {
 # CHECK-NEXT:   10:   55                      pushq   %rbp

llvm/tools/llvm-objdump/llvm-objdump.cpp

 bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
   std::unique_ptr<MemoryBuffer> Buffer;
   if (LineInfo.Source) {
     Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
   } else {
     auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
     if (!BufferOrError) {
       if (MissingSources.insert(LineInfo.FileName).second)
-        warn("failed to find source " + LineInfo.FileName);
+        warn(formatv("failed to find source '{0}'", LineInfo.FileName));
+
       return false;
     }
     Buffer = std::move(*BufferOrError);
   }
   // Chomp the file to get lines
   const char *BufferStart = Buffer->getBufferStart(),
              *BufferEnd = Buffer->getBufferEnd();
   std::vector<StringRef> &Lines = LineCache[LineInfo.FileName];
void SourcePrinter::printSourceLine(raw_ostream &OS,
   std::string ErrorMessage;
   if (!ExpectedLineInfo)
     ErrorMessage = toString(ExpectedLineInfo.takeError());
   else
     LineInfo = *ExpectedLineInfo;
 
   if (LineInfo.FileName == DILineInfo::BadString) {
     if (!WarnedNoDebugInfo) {
-      std::string Warning =
-          "failed to parse debug information for " + ObjectFilename.str();
+      std::string Warning = formatv(
+          "failed to parse debug information for '{0}'", ObjectFilename.str());
       if (!ErrorMessage.empty())
         Warning += ": " + ErrorMessage;
       warn(Warning);
       WarnedNoDebugInfo = true;
     }
     return;
   }
 
   if (LineInfo.Line == 0 || ((OldLineInfo.Line == LineInfo.Line) &&
                              (OldLineInfo.FileName == LineInfo.FileName)))
     return;
 
   if (PrintLines)
     OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
   if (PrintSource) {
     if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
       if (!cacheSource(LineInfo))
         return;
     auto LineBuffer = LineCache.find(LineInfo.FileName);
     if (LineBuffer != LineCache.end()) {
       if (LineInfo.Line > LineBuffer->second.size()) {
         warn(formatv(
-            "debug info line number {0} exceeds the number of lines in {1}",
+            "debug info line number {0} exceeds the number of lines in '{1}'",
             LineInfo.Line, LineInfo.FileName));
         return;
       }
       // Vector begins at 0, line numbers are non-zero
       OS << Delimiter << LineBuffer->second[LineInfo.Line - 1] << '\n';
     }
   }
   OldLineInfo = LineInfo;