[GOFF] Wrap debug output with LLVM_DEBUG

[redstar]

The content of a GOFF record is always dumped if NDEBUG is not defined,
which produces rather confusing output. This changes wrap the dumping
code in LLVM_DEBUG, so the dump is only done when debug output of this
module is requested.

[llvmbot]

@llvm/pr-subscribers-llvm-binary-utilities

Author: Kai Nacke (redstar)

Changes

The content of a GOFF record is always dumped if NDEBUG is not defined,
which produces rather confusing output. This changes wrap the dumping
code in LLVM_DEBUG, so the dump is only done when debug output of this
module is requested.

---

Full diff: https://github.com/llvm/llvm-project/pull/87252.diff

1 Files Affected:

• (modified) llvm/lib/Object/GOFFObjectFile.cpp (+3-6)

diff --git a/llvm/lib/Object/GOFFObjectFile.cpp b/llvm/lib/Object/GOFFObjectFile.cpp
index 76a13559ebfe35..d3dfd5d1540cfe 100644
--- a/llvm/lib/Object/GOFFObjectFile.cpp
+++ b/llvm/lib/Object/GOFFObjectFile.cpp
@@ -104,16 +104,13 @@ GOFFObjectFile::GOFFObjectFile(MemoryBufferRef Object, Error &Err)
       PrevContinuationBits = I[1] & 0x03;
       continue;
     }
-
-#ifndef NDEBUG
-    for (size_t J = 0; J < GOFF::RecordLength; ++J) {
+    LLVM_DEBUG(for (size_t J = 0; J < GOFF::RecordLength; ++J) {
       const uint8_t *P = I + J;
       if (J % 8 == 0)
         dbgs() << "  ";
-
       dbgs() << format("%02hhX", *P);
-    }
-#endif
+    });
+
     switch (RecordType) {
     case GOFF::RT_ESD: {
       // Save ESD record.

[perry-ca]

looks good. It might be helpful to but a tag at the beginning of the output so people know this is the GOFF record and a new line at the end.

[abhina-sree]

LGTM

[redstar]

looks good. It might be helpful to but a tag at the beginning of the output so people know this is the GOFF record and a new line at the end.

I agree that the formatting of the output could be better. (The user must request --debug-only=goff so there is no need to tag the output.) I leave this to a later change, since my main point is to remove the debug output in normal operation.