[llvm] r305609 - obj2yaml: Improve error reporting

[Sam Clegg via llvm-commits]

Author: sbc
Date: Fri Jun 16 18:29:54 2017
New Revision: 305609

URL: http://llvm.org/viewvc/llvm-project?rev=305609&view=rev
Log:
obj2yaml: Improve error reporting

Previously only the error codes were reported which
meant that useful information about malformed inputs
was not shown.

Differential Revision: https://reviews.llvm.org/D34008

Added:
    llvm/trunk/test/tools/obj2yaml/
    llvm/trunk/test/tools/obj2yaml/invalid_input_file.test
Modified:
    llvm/trunk/test/Object/obj2yaml.test
    llvm/trunk/test/ObjectYAML/wasm/header_invalid_version.yaml
    llvm/trunk/tools/obj2yaml/obj2yaml.cpp

Modified: llvm/trunk/test/Object/obj2yaml.test
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/test/Object/obj2yaml.test?rev=305609&r1=305608&r2=305609&view=diff
==============================================================================
--- llvm/trunk/test/Object/obj2yaml.test (original)
+++ llvm/trunk/test/Object/obj2yaml.test Fri Jun 16 18:29:54 2017
@@ -478,4 +478,4 @@ ELF-X86-64-UNWIND-NEXT:   AddressAlign:
 ELF-X86-64-UNWIND-NEXT:   Content:         ''
 
 RUN: not obj2yaml %t.blah 2>&1 | FileCheck --check-prefix=ENOENT %s
-ENOENT: Error: '{{[Nn]}}o such file or directory'
+ENOENT: Error reading file: {{.*}}.blah: {{[Nn]}}o such file or directory

Modified: llvm/trunk/test/ObjectYAML/wasm/header_invalid_version.yaml
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/test/ObjectYAML/wasm/header_invalid_version.yaml?rev=305609&r1=305608&r2=305609&view=diff
==============================================================================
--- llvm/trunk/test/ObjectYAML/wasm/header_invalid_version.yaml (original)
+++ llvm/trunk/test/ObjectYAML/wasm/header_invalid_version.yaml Fri Jun 16 18:29:54 2017
@@ -3,4 +3,4 @@
 FileHeader:
   Version:         0x00000002
 ...
-# CHECK: Error: 'Invalid data was encountered while parsing the file'
+# CHECK: Error reading file: <stdin>: Bad version number

Added: llvm/trunk/test/tools/obj2yaml/invalid_input_file.test
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/test/tools/obj2yaml/invalid_input_file.test?rev=305609&view=auto
==============================================================================
--- llvm/trunk/test/tools/obj2yaml/invalid_input_file.test (added)
+++ llvm/trunk/test/tools/obj2yaml/invalid_input_file.test Fri Jun 16 18:29:54 2017
@@ -0,0 +1,4 @@
+# RUN: not obj2yaml  %p/path/does/not/exist 2>&1 | FileCheck %s
+
+# Don't check the OS-dependent message "No such file or directory".
+# CHECK: Error reading file: {{.*}}/path/does/not/exist: {{.*}}

Modified: llvm/trunk/tools/obj2yaml/obj2yaml.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/obj2yaml/obj2yaml.cpp?rev=305609&r1=305608&r2=305609&view=diff
==============================================================================
--- llvm/trunk/tools/obj2yaml/obj2yaml.cpp (original)
+++ llvm/trunk/tools/obj2yaml/obj2yaml.cpp Fri Jun 16 18:29:54 2017
@@ -30,21 +30,32 @@ static std::error_code dumpObject(const
   return obj2yaml_error::unsupported_obj_file_format;
 }
 
-static std::error_code dumpInput(StringRef File) {
+static Error dumpInput(StringRef File) {
   Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
   if (!BinaryOrErr)
-    return errorToErrorCode(BinaryOrErr.takeError());
+    return BinaryOrErr.takeError();
 
   Binary &Binary = *BinaryOrErr.get().getBinary();
   // Universal MachO is not a subclass of ObjectFile, so it needs to be handled
   // here with the other binary types.
   if (Binary.isMachO() || Binary.isMachOUniversalBinary())
-    return macho2yaml(outs(), Binary);
+    return errorCodeToError(macho2yaml(outs(), Binary));
   // TODO: If this is an archive, then burst it and dump each entry
   if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
-    return dumpObject(*Obj);
+    return errorCodeToError(dumpObject(*Obj));
 
-  return obj2yaml_error::unrecognized_file_format;
+  return Error::success();
+}
+
+static void reportError(StringRef Input, Error Err) {
+  if (Input == "-")
+    Input = "<stdin>";
+  std::string ErrMsg;
+  raw_string_ostream OS(ErrMsg);
+  logAllUnhandledErrors(std::move(Err), OS, "");
+  OS.flush();
+  errs() << "Error reading file: " << Input << ": " << ErrMsg;
+  errs().flush();
 }
 
 cl::opt<std::string> InputFilename(cl::Positional, cl::desc("<input file>"),
@@ -56,8 +67,8 @@ int main(int argc, char *argv[]) {
   PrettyStackTraceProgram X(argc, argv);
   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
 
-  if (std::error_code EC = dumpInput(InputFilename)) {
-    errs() << "Error: '" << EC.message() << "'\n";
+  if (Error Err = dumpInput(InputFilename)) {
+    reportError(InputFilename, std::move(Err));
     return 1;
   }