[llvm][SystemZ] Set comment stream in SystemZDisassembler::getInstruction #148614
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion This is done by other backends at the start of this function, for example AArch64Disassembler::getInstruction. Not setting it means you hit asserts in MCDisassembler::tryAddingSymbolicOperand and MCDisassembler::tryAddingPcLoadReferenceComment when there is a symbolizer set. Which I found while debugging a SystemZ program using LLDB. As the only good way to hit this path is from C++, I've copied X86's disassembler unit tests and added just enough to hit an assert, were it not for the changes in this PR.
|
@llvm/pr-subscribers-backend-systemz Author: David Spickett (DavidSpickett) ChangesThis is done by other backends at the start of this function, for example AArch64Disassembler::getInstruction. Not setting it means you hit asserts in MCDisassembler::tryAddingSymbolicOperand and MCDisassembler::tryAddingPcLoadReferenceComment when there is a symbolizer set. Which happened to me while debugging a SystemZ program using LLDB. As the only good way to hit this path is from C++, I've copied X86's disassembler unit tests and added just enough to hit an assert if the comment stream is not set. Full diff: https://github.com/llvm/llvm-project/pull/148614.diff 3 Files Affected:
diff --git a/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp b/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp
index 6ae529e974186..31b4f1196392c 100644
--- a/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp
+++ b/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp
@@ -327,6 +327,8 @@ DecodeStatus SystemZDisassembler::getInstruction(MCInst &MI, uint64_t &Size,
ArrayRef<uint8_t> Bytes,
uint64_t Address,
raw_ostream &CS) const {
+ CommentStream = &CS;
+
// Get the first two bytes of the instruction.
Size = 0;
if (Bytes.size() < 2)
diff --git a/llvm/unittests/MC/SystemZ/CMakeLists.txt b/llvm/unittests/MC/SystemZ/CMakeLists.txt
index 3b7af4a3bbea3..a972ef27ddd8a 100644
--- a/llvm/unittests/MC/SystemZ/CMakeLists.txt
+++ b/llvm/unittests/MC/SystemZ/CMakeLists.txt
@@ -10,6 +10,8 @@ set(LLVM_LINK_COMPONENTS
TargetParser
)
-add_llvm_unittest(SystemZAsmLexerTests
+add_llvm_unittest(SystemZMCTests
SystemZAsmLexerTest.cpp
+ SystemZMCDisassemblerTest.cpp
)
+
diff --git a/llvm/unittests/MC/SystemZ/SystemZMCDisassemblerTest.cpp b/llvm/unittests/MC/SystemZ/SystemZMCDisassemblerTest.cpp
new file mode 100644
index 0000000000000..df59fcb402e21
--- /dev/null
+++ b/llvm/unittests/MC/SystemZ/SystemZMCDisassemblerTest.cpp
@@ -0,0 +1,103 @@
+//===- SystemZMCDisassemblerTest.cpp - Tests for SystemZ MCDisassembler ---===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/MC/MCAsmInfo.h"
+#include "llvm/MC/MCContext.h"
+#include "llvm/MC/MCDisassembler/MCDisassembler.h"
+#include "llvm/MC/MCDisassembler/MCSymbolizer.h"
+#include "llvm/MC/MCInst.h"
+#include "llvm/MC/MCRegisterInfo.h"
+#include "llvm/MC/MCSubtargetInfo.h"
+#include "llvm/MC/MCTargetOptions.h"
+#include "llvm/MC/TargetRegistry.h"
+#include "llvm/Support/TargetSelect.h"
+#include "gtest/gtest.h"
+
+using namespace llvm;
+
+namespace {
+
+struct Context {
+ const char *TripleName = "systemz-unknown";
+ std::unique_ptr<MCRegisterInfo> MRI;
+ std::unique_ptr<MCAsmInfo> MAI;
+ std::unique_ptr<MCContext> Ctx;
+ std::unique_ptr<MCSubtargetInfo> STI;
+ std::unique_ptr<MCDisassembler> DisAsm;
+
+ Context() {
+ LLVMInitializeSystemZTargetInfo();
+ LLVMInitializeSystemZTargetMC();
+ LLVMInitializeSystemZDisassembler();
+
+ // If we didn't build SystemZ, do not run the test.
+ std::string Error;
+ const Target *TheTarget = TargetRegistry::lookupTarget(TripleName, Error);
+ if (!TheTarget)
+ return;
+
+ MRI.reset(TheTarget->createMCRegInfo(TripleName));
+ MAI.reset(TheTarget->createMCAsmInfo(*MRI, TripleName, MCTargetOptions()));
+ STI.reset(TheTarget->createMCSubtargetInfo(TripleName, "", ""));
+ Ctx = std::make_unique<MCContext>(Triple(TripleName), MAI.get(), MRI.get(),
+ STI.get());
+
+ DisAsm.reset(TheTarget->createMCDisassembler(*STI, *Ctx));
+ }
+
+ operator MCContext &() { return *Ctx; };
+};
+
+Context &getContext() {
+ static Context Ctxt;
+ return Ctxt;
+}
+
+class SystemZMCSymbolizerTest : public MCSymbolizer {
+public:
+ SystemZMCSymbolizerTest(MCContext &MC) : MCSymbolizer(MC, nullptr) {}
+ ~SystemZMCSymbolizerTest() {}
+
+ bool tryAddingSymbolicOperand([[maybe_unused]] MCInst &Inst,
+ [[maybe_unused]] raw_ostream &CStream,
+ [[maybe_unused]] int64_t Value,
+ [[maybe_unused]] uint64_t Address,
+ [[maybe_unused]] bool IsBranch,
+ [[maybe_unused]] uint64_t Offset,
+ [[maybe_unused]] uint64_t OpSize,
+ [[maybe_unused]] uint64_t InstSize) override {
+ return true;
+ }
+
+ void
+ tryAddingPcLoadReferenceComment([[maybe_unused]] raw_ostream &cStream,
+ [[maybe_unused]] int64_t Value,
+ [[maybe_unused]] uint64_t Address) override {}
+};
+
+} // namespace
+
+TEST(SystemZDisassembler, SystemZMCSymbolizerTest) {
+ SystemZMCSymbolizerTest *TestSymbolizer =
+ new SystemZMCSymbolizerTest(getContext());
+ getContext().DisAsm->setSymbolizer(
+ std::unique_ptr<MCSymbolizer>(TestSymbolizer));
+
+ MCInst Inst;
+ uint64_t InstSize;
+
+ // Check that the SystemZ disassembler sets the comment stream before calling
+ // MCDisassembler::tryAddingSymbolicOperand. This will fail an assert if it
+ // does not do that.
+ MCDisassembler::DecodeStatus Status = getContext().DisAsm->getInstruction(
+ Inst, InstSize,
+ // lgrl %r1, 0x1234
+ {0xc4, 0x18, 0x00, 0x00, 0x9a, 0x1a}, 0, nulls());
+ ASSERT_TRUE(Status == MCDisassembler::Success);
+ EXPECT_EQ(InstSize, uint64_t{6});
+}
|
|
@llvm/pr-subscribers-mc Author: David Spickett (DavidSpickett) ChangesThis is done by other backends at the start of this function, for example AArch64Disassembler::getInstruction. Not setting it means you hit asserts in MCDisassembler::tryAddingSymbolicOperand and MCDisassembler::tryAddingPcLoadReferenceComment when there is a symbolizer set. Which happened to me while debugging a SystemZ program using LLDB. As the only good way to hit this path is from C++, I've copied X86's disassembler unit tests and added just enough to hit an assert if the comment stream is not set. Full diff: https://github.com/llvm/llvm-project/pull/148614.diff 3 Files Affected:
diff --git a/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp b/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp
index 6ae529e974186..31b4f1196392c 100644
--- a/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp
+++ b/llvm/lib/Target/SystemZ/Disassembler/SystemZDisassembler.cpp
@@ -327,6 +327,8 @@ DecodeStatus SystemZDisassembler::getInstruction(MCInst &MI, uint64_t &Size,
ArrayRef<uint8_t> Bytes,
uint64_t Address,
raw_ostream &CS) const {
+ CommentStream = &CS;
+
// Get the first two bytes of the instruction.
Size = 0;
if (Bytes.size() < 2)
diff --git a/llvm/unittests/MC/SystemZ/CMakeLists.txt b/llvm/unittests/MC/SystemZ/CMakeLists.txt
index 3b7af4a3bbea3..a972ef27ddd8a 100644
--- a/llvm/unittests/MC/SystemZ/CMakeLists.txt
+++ b/llvm/unittests/MC/SystemZ/CMakeLists.txt
@@ -10,6 +10,8 @@ set(LLVM_LINK_COMPONENTS
TargetParser
)
-add_llvm_unittest(SystemZAsmLexerTests
+add_llvm_unittest(SystemZMCTests
SystemZAsmLexerTest.cpp
+ SystemZMCDisassemblerTest.cpp
)
+
diff --git a/llvm/unittests/MC/SystemZ/SystemZMCDisassemblerTest.cpp b/llvm/unittests/MC/SystemZ/SystemZMCDisassemblerTest.cpp
new file mode 100644
index 0000000000000..df59fcb402e21
--- /dev/null
+++ b/llvm/unittests/MC/SystemZ/SystemZMCDisassemblerTest.cpp
@@ -0,0 +1,103 @@
+//===- SystemZMCDisassemblerTest.cpp - Tests for SystemZ MCDisassembler ---===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/MC/MCAsmInfo.h"
+#include "llvm/MC/MCContext.h"
+#include "llvm/MC/MCDisassembler/MCDisassembler.h"
+#include "llvm/MC/MCDisassembler/MCSymbolizer.h"
+#include "llvm/MC/MCInst.h"
+#include "llvm/MC/MCRegisterInfo.h"
+#include "llvm/MC/MCSubtargetInfo.h"
+#include "llvm/MC/MCTargetOptions.h"
+#include "llvm/MC/TargetRegistry.h"
+#include "llvm/Support/TargetSelect.h"
+#include "gtest/gtest.h"
+
+using namespace llvm;
+
+namespace {
+
+struct Context {
+ const char *TripleName = "systemz-unknown";
+ std::unique_ptr<MCRegisterInfo> MRI;
+ std::unique_ptr<MCAsmInfo> MAI;
+ std::unique_ptr<MCContext> Ctx;
+ std::unique_ptr<MCSubtargetInfo> STI;
+ std::unique_ptr<MCDisassembler> DisAsm;
+
+ Context() {
+ LLVMInitializeSystemZTargetInfo();
+ LLVMInitializeSystemZTargetMC();
+ LLVMInitializeSystemZDisassembler();
+
+ // If we didn't build SystemZ, do not run the test.
+ std::string Error;
+ const Target *TheTarget = TargetRegistry::lookupTarget(TripleName, Error);
+ if (!TheTarget)
+ return;
+
+ MRI.reset(TheTarget->createMCRegInfo(TripleName));
+ MAI.reset(TheTarget->createMCAsmInfo(*MRI, TripleName, MCTargetOptions()));
+ STI.reset(TheTarget->createMCSubtargetInfo(TripleName, "", ""));
+ Ctx = std::make_unique<MCContext>(Triple(TripleName), MAI.get(), MRI.get(),
+ STI.get());
+
+ DisAsm.reset(TheTarget->createMCDisassembler(*STI, *Ctx));
+ }
+
+ operator MCContext &() { return *Ctx; };
+};
+
+Context &getContext() {
+ static Context Ctxt;
+ return Ctxt;
+}
+
+class SystemZMCSymbolizerTest : public MCSymbolizer {
+public:
+ SystemZMCSymbolizerTest(MCContext &MC) : MCSymbolizer(MC, nullptr) {}
+ ~SystemZMCSymbolizerTest() {}
+
+ bool tryAddingSymbolicOperand([[maybe_unused]] MCInst &Inst,
+ [[maybe_unused]] raw_ostream &CStream,
+ [[maybe_unused]] int64_t Value,
+ [[maybe_unused]] uint64_t Address,
+ [[maybe_unused]] bool IsBranch,
+ [[maybe_unused]] uint64_t Offset,
+ [[maybe_unused]] uint64_t OpSize,
+ [[maybe_unused]] uint64_t InstSize) override {
+ return true;
+ }
+
+ void
+ tryAddingPcLoadReferenceComment([[maybe_unused]] raw_ostream &cStream,
+ [[maybe_unused]] int64_t Value,
+ [[maybe_unused]] uint64_t Address) override {}
+};
+
+} // namespace
+
+TEST(SystemZDisassembler, SystemZMCSymbolizerTest) {
+ SystemZMCSymbolizerTest *TestSymbolizer =
+ new SystemZMCSymbolizerTest(getContext());
+ getContext().DisAsm->setSymbolizer(
+ std::unique_ptr<MCSymbolizer>(TestSymbolizer));
+
+ MCInst Inst;
+ uint64_t InstSize;
+
+ // Check that the SystemZ disassembler sets the comment stream before calling
+ // MCDisassembler::tryAddingSymbolicOperand. This will fail an assert if it
+ // does not do that.
+ MCDisassembler::DecodeStatus Status = getContext().DisAsm->getInstruction(
+ Inst, InstSize,
+ // lgrl %r1, 0x1234
+ {0xc4, 0x18, 0x00, 0x00, 0x9a, 0x1a}, 0, nulls());
+ ASSERT_TRUE(Status == MCDisassembler::Success);
+ EXPECT_EQ(InstSize, uint64_t{6});
+}
|
DavidSpickett
commented
Jul 14, 2025
| SystemZMCSymbolizerTest(MCContext &MC) : MCSymbolizer(MC, nullptr) {} | ||
| ~SystemZMCSymbolizerTest() {} | ||
|
|
||
| bool tryAddingSymbolicOperand([[maybe_unused]] MCInst &Inst, |
There was a problem hiding this comment.
I could have left these parameters anonymous which saves some noise, but means the next person to extend this will have to go look up all the names again.
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/153/builds/37981 Here is the relevant piece of the build log for the reference |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/76/builds/11262 Here is the relevant piece of the build log for the reference |
DavidSpickett
added a commit
that referenced
this pull request
Jul 14, 2025
…tInstruction" (#148639) Reverts #148614 Has some missing library dependencies - https://lab.llvm.org/buildbot/#/builders/76/builds/11262/steps/11/logs/stdio.
llvm-sync bot
pushed a commit
to arm/arm-toolchain
that referenced
this pull request
Jul 14, 2025
…sembler::getInstruction" (#148639) Reverts llvm/llvm-project#148614 Has some missing library dependencies - https://lab.llvm.org/buildbot/#/builders/76/builds/11262/steps/11/logs/stdio.
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/145/builds/8359 Here is the relevant piece of the build log for the reference |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/161/builds/7045 Here is the relevant piece of the build log for the reference |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is done by other backends at the start of this function, for example AArch64Disassembler::getInstruction. Not setting it means you hit asserts in MCDisassembler::tryAddingSymbolicOperand and MCDisassembler::tryAddingPcLoadReferenceComment when there is a symbolizer set.
Which happened to me while debugging a SystemZ program using LLDB.
As the only good way to hit this path is from C++, I've copied X86's disassembler unit tests and added just enough to hit an assert if the comment stream is not set.