[BOLT] Ensure remember and restore CFIs are in the same list

[Asher8118]

In addCFIInstruction, we split the CFI information between CFIInstrMapType CIEFrameInstructions and CFIInstrMapType FrameInstructions. In some cases we can end up with the remember CFI in CIEFrameInstructions and the restore CFI in FrameInstructions. This patch adds a check to make sure we do not split remember and restore states and fixes #133501.

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-bolt

Author: Ash Dobrescu (Rin18)

Changes

In addCFIInstruction, we split the CFI information between CFIInstrMapType CIEFrameInstructions and CFIInstrMapType FrameInstructions. In some cases we can end up with the remember CFI in CIEFrameInstructions and the restore CFI in FrameInstructions. This patch adds a check to make sure we do not split remember and restore states and fixes #133501.

---

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

1 Files Affected:

• (modified) bolt/include/bolt/Core/BinaryFunction.h (+1-1)

diff --git a/bolt/include/bolt/Core/BinaryFunction.h b/bolt/include/bolt/Core/BinaryFunction.h
index ca8b786f4ab69..828c56d818b09 100644
--- a/bolt/include/bolt/Core/BinaryFunction.h
+++ b/bolt/include/bolt/Core/BinaryFunction.h
@@ -1663,7 +1663,7 @@ class BinaryFunction {
       Offset = I->first;
     }
     assert(I->first == Offset && "CFI pointing to unknown instruction");
-    if (I == Instructions.begin()) {
+    if (I == Instructions.begin() && Inst.getOperation() != MCCFIInstruction::OpRememberState) {
       CIEFrameInstructions.emplace_back(std::forward<MCCFIInstruction>(Inst));
       return;
     }

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[paschalis-mpeis]

Hey Ash,

Thanks for improving Bolt! Looks good with a couple of nits below.

Can you also give it a couple of days in case someone has further feedback?

[Asher8118]

The patch should be ready to merge now. I'll give it another day or so before I merge it.

[github-actions]

@Asher8118 Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!