update error messages

davidtwco · David Wood · commit 8556a510cc02 · 2021-12-15T16:26:38.000Z
Modify commit messages to improve consistency and quality.

Signed-off-by: David Wood &lt;david.wood@huawei.com&gt;
diff --git a/tests/archive.test b/tests/archive.test
@@ -71,5 +71,5 @@ CHECK:   DW_AT_name {{.*}} "e.cpp"
 CHECK:   DW_TAG_subprogram
 CHECK:     DW_AT_name {{.*}} "e"
 
-MISSING: Error: Failed to finish creation of DWARF package
-MISSING:  Unit 0x{{.*}} was referenced by executable but not found
+MISSING: Error: Failed verifying final DWARF package
+MISSING:  Unit 0x{{.*}} referenced by executable was not found
diff --git a/tests/compress-fail.test b/tests/compress-fail.test
@@ -2,9 +2,9 @@ RUN: not thorin %p/inputs/compress-fail-a.dwo -o %t 2>&1 | FileCheck %s
 RUN: not thorin %p/inputs/empty-compressed-section.dwo -o %t 2>&1 | FileCheck %s
 RUN: not thorin %p/inputs/invalid-compressed.dwo -o %t 2>&1 | FileCheck --check-prefix=INVALID %s
 
-CHECK: Error: Failed to add input object to DWARF package
+CHECK: Error: Failed to add `{{.*}}` to DWARF package
 CHECK:  Invalid ELF GNU compressed section header
 
 # `llvm-dwp` fails to decompress this, but `thorin` is able to but the contents aren't meaningful.
-INVALID: Error: Failed to add input object to DWARF package
-INVALID:  Failed to read string at offset 00000000 of `.debug_str.dwo` section
+INVALID: Error: Failed to add `{{.*}}/invalid-compressed.dwo` to DWARF package
+INVALID:  Read string at offset 0x00000000 of `.debug_str.dwo` section
diff --git a/tests/duplicate.test b/tests/duplicate.test
@@ -16,20 +16,20 @@ RUN:   | FileCheck --check-prefix=DWO1DWP %s
 RUN: not thorin %p/inputs/duplicate-dwo-name-c.dwo %p/inputs/duplicate-dwo-name-bc.dwp -o %t 2>&1 \
 RUN:   | FileCheck --check-prefix=DWO2DWP %s
 
-DWOS: Error: Failed to add input object to DWARF package
-DWOS:  Found duplicate split compilation unit ({{.*}})
+DWOS: Error: Failed to add `{{.*}}` to DWARF package
+DWOS:  Duplicate split compilation unit ({{.*}})
 
-1DWP: Error: Failed to add input object to DWARF package
-1DWP:  Found duplicate split compilation unit ({{.*}})
+1DWP: Error: Failed to add `{{.*}}` to DWARF package
+1DWP:  Duplicate split compilation unit ({{.*}})
 
-2DWP: Error: Failed to add input object to DWARF package
-2DWP:  Found duplicate split compilation unit ({{.*}})
+2DWP: Error: Failed to add `{{.*}}` to DWARF package
+2DWP:  Duplicate split compilation unit ({{.*}})
 
-DWODWOS: Error: Failed to add input object to DWARF package
-DWODWOS:  Found duplicate split compilation unit ({{.*}})
+DWODWOS: Error: Failed to add `{{.*}}` to DWARF package
+DWODWOS:  Duplicate split compilation unit ({{.*}})
 
-DWO1DWP: Error: Failed to add input object to DWARF package
-DWO1DWP:  Found duplicate split compilation unit ({{.*}})
+DWO1DWP: Error: Failed to add `{{.*}}` to DWARF package
+DWO1DWP:  Duplicate split compilation unit ({{.*}})
 
-DWO2DWP: Error: Failed to add input object to DWARF package
-DWO2DWP:  Found duplicate split compilation unit ({{.*}})
+DWO2DWP: Error: Failed to add `{{.*}}` to DWARF package
+DWO2DWP:  Duplicate split compilation unit ({{.*}})
diff --git a/tests/gcc-type.test b/tests/gcc-type.test
@@ -4,5 +4,5 @@ RUN: not thorin %p/inputs/gcc-type.dwo %p/inputs/gcc-type.dwo -o %t 2>&1 | FileC
 CHECK: Type Unit
 CHECK: Type Unit
 
-DUP: Error: Failed to add input object to DWARF package
-DUP:  Found duplicate split compilation unit ({{.*}})
+DUP: Error: Failed to add `{{.*}}/gcc-type.dwo` to DWARF package
+DUP:  Duplicate split compilation unit ({{.*}})
diff --git a/tests/handle-strx.test b/tests/handle-strx.test
@@ -6,5 +6,5 @@ RUN:   | FileCheck --check-prefix=PARSE_STRX %s
 
 READ_STRX: DW_AT_name [DW_FORM_strx1]{{.*}}dw5.cc
 
-PARSE_STRX: Error: Failed to add input object to DWARF package
-PARSE_STRX:  Found duplicate split compilation unit ({{.*}})
+PARSE_STRX: Error: Failed to add `{{.*}}/handle-strx-v5.dwo` to DWARF package
+PARSE_STRX:  Duplicate split compilation unit ({{.*}})
diff --git a/tests/incompatible-cu-index-versions.s b/tests/incompatible-cu-index-versions.s
@@ -1,7 +1,7 @@
 # RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o %t.dwp
 # RUN: not thorin %t.dwp -o %t 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/incompatible-cu-index-versions.s.tmp.dwp` to DWARF package
 # CHECK:  Incompatible `.debug_cu_index` index version: found version 2, expected version 5
 
     .section .debug_info.dwo, "e", @progbits
diff --git a/tests/incompatible-tu-index-version.s b/tests/incompatible-tu-index-version.s
@@ -1,7 +1,7 @@
 # RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o %t.dwp
 # RUN: not thorin %t.dwp -o %t 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/incompatible-tu-index-version.s.tmp.dwp` to DWARF package
 # CHECK:  Incompatible `.debug_tu_index` index version: found version 5, expected version 2
 
 .section .debug_abbrev.dwo, "e", @progbits
diff --git a/tests/invalid-cu-header-length-type.s b/tests/invalid-cu-header-length-type.s
@@ -2,7 +2,7 @@
 # RUN:     -dwarf-version=5
 # RUN: not thorin %t.dwo -o %t.dwp 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/invalid-cu-header-length-type.s.tmp.dwo` to DWARF package
 # CHECK:  0: Failed to parse unit header
 # CHECK:  1: Hit the end of input before it was expected
 
diff --git a/tests/invalid-cu-header-length.s b/tests/invalid-cu-header-length.s
@@ -2,7 +2,7 @@
 # RUN:         -split-dwarf-file=%t.dwo -dwarf-version=5
 # RUN: not thorin %t.dwo -o %t.dwp 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/invalid-cu-header-length.s.tmp.dwo` to DWARF package
 # CHECK:  0: Failed to parse unit header
 # CHECK:  1: Hit the end of input before it was expected
 
diff --git a/tests/invalid-cu-header-version.s b/tests/invalid-cu-header-version.s
@@ -2,7 +2,7 @@
 # RUN:         -split-dwarf-file=%t.dwo -dwarf-version=5
 # RUN: not thorin %t.dwo -o %t.dwp 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/invalid-cu-header-version.s.tmp.dwo` to DWARF package
 # CHECK:  0: Failed to parse unit header
 # CHECK:  1: Hit the end of input before it was expected
 
diff --git a/tests/invalid-cu-index.test b/tests/invalid-cu-index.test
@@ -1,5 +1,5 @@
 RUN: not thorin %p/inputs/invalid-cu-index.dwp -o %t 2>&1 | FileCheck %s
 
-CHECK: Error: Failed to add input object to DWARF package
-CHECK:  0: Failed to parse `.debug_cu_index` section
+CHECK: Error: Failed to add `{{.*}}/invalid-cu-index.dwp` to DWARF package
+CHECK:  0: Failed to parse `.debug_cu_index` index section
 CHECK:  1: Hit the end of input before it was expected
diff --git a/tests/invalid-string-form.test b/tests/invalid-string-form.test
@@ -1,5 +1,5 @@
 RUN: not thorin %p/inputs/invalid-string-form.dwo -o %t 2>&1 | FileCheck %s
 
-CHECK: Error: Failed to add input object to DWARF package
+CHECK: Error: Failed to add `{{.*}}/invalid-string-form.dwo` to DWARF package
 CHECK:  0: Failed to parse unit attribute
 CHECK:  1: Found an unknown `DW_FORM_*` type
diff --git a/tests/invalid-tu-header-length.s b/tests/invalid-tu-header-length.s
@@ -2,7 +2,7 @@
 # RUN:   -dwarf-version=5
 # RUN: not thorin %t.dwo -o %t.dwp 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/invalid-tu-header-length.s.tmp.dwo` to DWARF package
 # CHECK:  0: Failed to parse unit header
 # CHECK:  1: Hit the end of input before it was expected
 
diff --git a/tests/missing-dwo-id.test b/tests/missing-dwo-id.test
@@ -2,5 +2,5 @@ RUN: rm -f %t
 RUN: not thorin %p/inputs/missing-dwo-id.dwo -o %t 2>&1 | FileCheck %s
 RUN: not ls %t
 
-CHECK: Error: Failed to add input object to DWARF package
-CHECK:  Found regular compilation unit in DWARF object (missing DWO id)
+CHECK: Error: Failed to add `{{.*}}/missing-dwo-id.dwo` to DWARF package
+CHECK:  Regular compilation unit in object (missing dwo identifier)
diff --git a/tests/missing-tu-index.test b/tests/missing-tu-index.test
@@ -1,8 +1,8 @@
 # RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o %t.dwp
 # RUN: not thorin %t.dwp -o %t 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
-# CHECK:  0: Failed to parse `.debug_tu_index` section
+# CHECK: Error: Failed to add `{{.*}}/missing-tu-index.test.tmp.dwp` to DWARF package
+# CHECK:  0: Failed to parse `.debug_tu_index` index section
 # CHECK:  1: Hit the end of input before it was expected
 
 .section .debug_abbrev.dwo, "e", @progbits
diff --git a/tests/multiple-debug-info-sections-in-dwp.s b/tests/multiple-debug-info-sections-in-dwp.s
@@ -1,8 +1,8 @@
 # RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o %t.dwp
 # RUN: not thorin %t.dwp -o /dev/null 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
-# CHECK:  0: Failed to parse `.debug_cu_index` section
+# CHECK: Error: Failed to add `{{.*}}/multiple-debug-info-sections-in-dwp.s.tmp.dwp` to DWARF package
+# CHECK:  0: Failed to parse `.debug_cu_index` index section
 # CHECK:  1: Hit the end of input before it was expected
 
     .section	.debug_info.dwo,"G",@progbits,0xFDFDFDFD,comdat
diff --git a/tests/multiple-type-sections.test b/tests/multiple-type-sections.test
@@ -1,4 +1,4 @@
 RUN: not thorin %p/inputs/multiple-type-sections.dwp -o %t 2>&1 | FileCheck %s
 
-CHECK: Error: Failed to add input object to DWARF package
-CHECK:  Found multiple `.debug_types.dwo` sections in a DWARF package file
+CHECK: Error: Failed to add `{{.*}}/multiple-type-sections.dwp` to DWARF package
+CHECK:  Multiple `.debug_types.dwo` sections in a package
diff --git a/tests/no-cu-found.s b/tests/no-cu-found.s
@@ -2,7 +2,7 @@
 # RUN:   -dwarf-version=5 %s -o %t.o
 # RUN: not thorin %t.dwo -o /dev/null 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/no-cu-found.s.tmp.dwo` to DWARF package
 # CHECK:  0: Failed to parse unit header
 # CHECK:  1: The `DW_UT_*` value for this unit is not supported yet
 
diff --git a/tests/non-cu-top-level.test b/tests/non-cu-top-level.test
@@ -1,4 +1,4 @@
 RUN: not thorin %p/inputs/non-cu-top-level.dwo -o %t 2>&1 | FileCheck %s
 
-CHECK: Error: Failed to add input object to DWARF package
+CHECK: Error: Failed to add `{{.*}}/non-cu-top-level.dwo` to DWARF package
 CHECK:  Top-level debugging information entry is not a compilation/type unit
diff --git a/tests/wrong-unit-type-info-v4.s b/tests/wrong-unit-type-info-v4.s
@@ -1,7 +1,7 @@
 # RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o %t.dwp
 # RUN: not thorin %t.dwp -o %t 2>&1 | FileCheck %s
 
-# CHECK: Error: Failed to add input object to DWARF package
+# CHECK: Error: Failed to add `{{.*}}/wrong-unit-type-info-v4.s.tmp.dwp` to DWARF package
 # CHECK:  0: Failed to parse unit
 # CHECK:  1: Hit the end of input before it was expected
 
diff --git a/thorin-bin/src/main.rs b/thorin-bin/src/main.rs
@@ -18,20 +18,16 @@ use typed_arena::Arena;
 
 #[derive(Debug, Error)]
 enum Error {
-    #[error("Failed to add input object to DWARF package")]
-    AddInputObject,
-    #[error("Failed to add referenced DWARF object/packages from executable to DWARF package")]
-    AddExecutable,
-    #[error("Failed to create output object")]
-    CreateOutputFile,
-    #[error("Failed to finish creation of DWARF package")]
+    #[error("Failed to add `{0}` to DWARF package")]
+    AddInputObject(String),
+    #[error("Failed to add referenced DWARF object/packages from `{0}` to DWARF package")]
+    AddExecutable(String),
+    #[error("Failed to create output object file at `{0}`")]
+    CreateOutputFile(String),
+    #[error("Failed verifying final DWARF package")]
     Finish,
-    #[error("Failed to emit output object to buffer")]
+    #[error("Failed writing output object to output buffer")]
     EmitOutputObject,
-    #[error("Failed to write output object to buffer")]
-    WriteBuffer,
-    #[error("Failed to write output object to disk")]
-    FlushBufferedWriter,
 }
 
 #[derive(Debug, StructOpt)]
@@ -155,7 +151,9 @@ fn main() -> Result<()> {
     }
 
     for input in opt.inputs {
-        package.add_input_object(&input).context(Error::AddInputObject)?;
+        package
+            .add_input_object(&input)
+            .with_context(|| Error::AddInputObject(input.display().to_string()))?;
     }
 
     if let Some(executables) = opt.executables {
@@ -165,17 +163,18 @@ fn main() -> Result<()> {
             // input - calling `finish` will return an error in this case.
             package
                 .add_executable(&executable, thorin::MissingReferencedObjectBehaviour::Skip)
-                .context(Error::AddExecutable)?;
+                .with_context(|| Error::AddExecutable(executable.display().to_string()))?;
         }
     }
 
-    let output_stream = Output::new(opt.output.as_ref()).context(Error::CreateOutputFile)?;
+    let output_stream = Output::new(opt.output.as_ref())
+        .with_context(|| Error::CreateOutputFile(opt.output.display().to_string()))?;
     let mut output_stream = StreamingBuffer::new(BufWriter::new(output_stream));
     package
         .finish()
         .context(Error::Finish)?
         .emit(&mut output_stream)
         .context(Error::EmitOutputObject)?;
-    output_stream.result().context(Error::WriteBuffer)?;
-    output_stream.into_inner().flush().context(Error::FlushBufferedWriter)
+    output_stream.result().context(Error::EmitOutputObject)?;
+    output_stream.into_inner().flush().context(Error::EmitOutputObject)
 }
diff --git a/thorin/src/error.rs b/thorin/src/error.rs
@@ -163,12 +163,12 @@ impl fmt::Display for Error {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
             Error::ReadInput(_) => write!(f, "Failed to read input file"),
-            Error::ParseFileKind(_) => write!(f, "Failed to parse kind of input file"),
-            Error::ParseObjectFile(_) => write!(f, "Failed to parse object file"),
-            Error::ParseArchiveFile(_) => write!(f, "Failed to parse archive file"),
+            Error::ParseFileKind(_) => write!(f, "Failed to parse input file kind"),
+            Error::ParseObjectFile(_) => write!(f, "Failed to parse input object file"),
+            Error::ParseArchiveFile(_) => write!(f, "Failed to parse input archive file"),
             Error::ParseArchiveMember(_) => write!(f, "Failed to parse archive member"),
-            Error::InvalidInputKind => write!(f, "Input is not an archive or elf file"),
-            Error::DecompressData(_) => write!(f, "Failed to decompress data"),
+            Error::InvalidInputKind => write!(f, "Input is not an archive or elf object"),
+            Error::DecompressData(_) => write!(f, "Failed to decompress compressed section"),
             Error::NamelessSection(_, offset) => {
                 write!(f, "Section without name at offset 0x{:08x}", offset)
             }
@@ -188,13 +188,13 @@ impl fmt::Display for Error {
                 section, offset
             ),
             Error::MissingDwoName(id) => {
-                write!(f, "Missing path attribute to DWARF object 0x{:08x}", id)
+                write!(f, "Missing path attribute to DWARF object (0x{:08x})", id)
             }
             Error::NoCompilationUnits => {
-                write!(f, "Input DWARF object has no compilation units")
+                write!(f, "Input object has no compilation units")
             }
             Error::NoDie => {
-                write!(f, "No top-level debugging information entry in unit")
+                write!(f, "No top-level debugging information entry in compilation/type unit")
             }
             Error::TopLevelDieNotUnit => {
                 write!(f, "Top-level debugging information entry is not a compilation/type unit")
@@ -203,7 +203,7 @@ impl fmt::Display for Error {
                 write!(f, "Section name is not valid UTF-8")
             }
             Error::MissingRequiredSection(section) => {
-                write!(f, "Input DWARF object missing required section `{}`", section)
+                write!(f, "Input object missing required section `{}`", section)
             }
             Error::ParseUnitAbbreviations(_) => write!(f, "Failed to parse unit abbreviations"),
             Error::ParseUnitAttribute(_) => write!(f, "Failed to parse unit attribute"),
@@ -216,41 +216,39 @@ impl fmt::Display for Error {
                     section, actual, format
                 )
             }
-            Error::OffsetAtIndex(_, index) => write!(
-                f,
-                "Failed to read offset at index {} of `.debug_str_offsets.dwo` section",
-                index
-            ),
-            Error::StrAtOffset(_, offset) => write!(
-                f,
-                "Failed to read string at offset {:08x} of `.debug_str.dwo` section",
-                offset
-            ),
-            Error::ParseIndex(_, section) => write!(f, "Failed to parse `{}` section", section),
+            Error::OffsetAtIndex(_, index) => {
+                write!(f, "Read offset at index {} of `.debug_str_offsets.dwo` section", index)
+            }
+            Error::StrAtOffset(_, offset) => {
+                write!(f, "Read string at offset 0x{:08x} of `.debug_str.dwo` section", offset)
+            }
+            Error::ParseIndex(_, section) => {
+                write!(f, "Failed to parse `{}` index section", section)
+            }
             Error::UnitNotInIndex(unit) => {
-                write!(f, "Unit 0x{0:08x} from input DWARF package is not in its index", unit)
+                write!(f, "Unit 0x{0:08x} from input package is not in its index", unit)
             }
             Error::RowNotInIndex(_, row) => {
                 write!(f, "Row {0} found in index's hash table not present in index", row)
             }
             Error::SectionNotInRow => write!(f, "Section not found in unit's row in index"),
             Error::EmptyUnit(unit) => {
-                write!(f, "Unit `{}` in input DWARF object with no data", unit)
+                write!(f, "Unit 0x{:08x} in input DWARF object with no data", unit)
             }
             Error::MultipleDebugInfoSection => {
-                write!(f, "Found multiple `.debug_info.dwo` sections")
+                write!(f, "Multiple `.debug_info.dwo` sections")
             }
             Error::MultipleDebugTypesSection => {
-                write!(f, "Found multiple `.debug_types.dwo` sections in a DWARF package file")
+                write!(f, "Multiple `.debug_types.dwo` sections in a package")
             }
             Error::NotSplitUnit => {
-                write!(f, "Found regular compilation unit in DWARF object (missing DWO id)")
+                write!(f, "Regular compilation unit in object (missing dwo identifier)")
             }
             Error::DuplicateUnit(unit) => {
-                write!(f, "Found duplicate split compilation unit (0x{:08x})", unit)
+                write!(f, "Duplicate split compilation unit (0x{:08x})", unit)
             }
             Error::MissingReferencedUnit(unit) => {
-                write!(f, "Unit 0x{:08x} was referenced by executable but not found", unit)
+                write!(f, "Unit 0x{:08x} referenced by executable was not found", unit)
             }
             Error::NoOutputObjectCreated => write!(f, "No output object was created from inputs"),
             Error::MixedInputEncodings => write!(f, "Input objects haved mixed encodings"),
