[llvm] [BOLT] Properly propagate Cursor errors (PR #84378)

[Maksim Panchenko via llvm-commits]

https://github.com/maksfb created https://github.com/llvm/llvm-project/pull/84378

Handle out-of-bounds reading errors correctly in LinuxKernelRewriter.

>From 28699fdaa6ee33b1e88ac8a2c668cc7091fb5cb1 Mon Sep 17 00:00:00 2001
From: Maksim Panchenko <maks at fb.com>
Date: Thu, 7 Mar 2024 11:49:47 -0800
Subject: [PATCH] [BOLT] Properly propagate Cursor errors

Handle out-of-bounds reading errors correctly in LinuxKernelRewriter.
---
 bolt/lib/Rewrite/LinuxKernelRewriter.cpp | 30 ++++++++++++++++--------
 bolt/test/X86/linux-alt-instruction.s    |  5 ++++
 2 files changed, 25 insertions(+), 10 deletions(-)

diff --git a/bolt/lib/Rewrite/LinuxKernelRewriter.cpp b/bolt/lib/Rewrite/LinuxKernelRewriter.cpp
index ecfbea3cb51185..331a61e7c3c2cd 100644
--- a/bolt/lib/Rewrite/LinuxKernelRewriter.cpp
+++ b/bolt/lib/Rewrite/LinuxKernelRewriter.cpp
@@ -500,7 +500,8 @@ Error LinuxKernelRewriter::readORCTables() {
     // Consume the status of the cursor.
     if (!IPCursor)
       return createStringError(errc::executable_format_error,
-                               "out of bounds while reading ORC IP table");
+                               "out of bounds while reading ORC IP table: %s",
+                               toString(IPCursor.takeError()).c_str());
 
     if (IP < PrevIP && opts::Verbosity)
       BC.errs() << "BOLT-WARNING: out of order IP 0x" << Twine::utohexstr(IP)
@@ -522,7 +523,8 @@ Error LinuxKernelRewriter::readORCTables() {
     // Consume the status of the cursor.
     if (!ORCCursor)
       return createStringError(errc::executable_format_error,
-                               "out of bounds while reading ORC");
+                               "out of bounds while reading ORC: %s",
+                               toString(ORCCursor.takeError()).c_str());
 
     if (Entry.ORC == NullORC)
       continue;
@@ -843,7 +845,8 @@ Error LinuxKernelRewriter::readStaticCalls() {
     // Consume the status of the cursor.
     if (!Cursor)
       return createStringError(errc::executable_format_error,
-                               "out of bounds while reading static calls");
+                               "out of bounds while reading static calls: %s",
+                               toString(Cursor.takeError()).c_str());
 
     ++EntryID;
 
@@ -954,8 +957,10 @@ Error LinuxKernelRewriter::readExceptionTable() {
 
     // Consume the status of the cursor.
     if (!Cursor)
-      return createStringError(errc::executable_format_error,
-                               "out of bounds while reading exception table");
+      return createStringError(
+          errc::executable_format_error,
+          "out of bounds while reading exception table: %s",
+          toString(Cursor.takeError()).c_str());
 
     ++EntryID;
 
@@ -1061,8 +1066,10 @@ Error LinuxKernelRewriter::readParaInstructions() {
     const uint8_t Len = DE.getU8(Cursor);
 
     if (!Cursor)
-      return createStringError(errc::executable_format_error,
-                               "out of bounds while reading .parainstructions");
+      return createStringError(
+          errc::executable_format_error,
+          "out of bounds while reading .parainstructions: %s",
+          toString(Cursor.takeError()).c_str());
 
     ++EntryID;
 
@@ -1129,7 +1136,8 @@ Error LinuxKernelRewriter::readBugTable() {
 
     if (!Cursor)
       return createStringError(errc::executable_format_error,
-                               "out of bounds while reading __bug_table");
+                               "out of bounds while reading __bug_table: %s",
+                               toString(Cursor.takeError()).c_str());
 
     ++EntryID;
 
@@ -1196,8 +1204,10 @@ Error LinuxKernelRewriter::readAltInstructions() {
     const uint8_t PadLen = opts::AltInstHasPadLen ? DE.getU8(Cursor) : 0;
 
     if (!Cursor)
-      return createStringError(errc::executable_format_error,
-                               "out of bounds while reading .altinstructions");
+      return createStringError(
+          errc::executable_format_error,
+          "out of bounds while reading .altinstructions: %s",
+          toString(Cursor.takeError()).c_str());
 
     ++EntryID;
 
diff --git a/bolt/test/X86/linux-alt-instruction.s b/bolt/test/X86/linux-alt-instruction.s
index 96e77545b654bc..5dcc6fe3ab0c81 100644
--- a/bolt/test/X86/linux-alt-instruction.s
+++ b/bolt/test/X86/linux-alt-instruction.s
@@ -27,6 +27,11 @@
 # RUN: llvm-bolt %t.exe --print-normalized --keep-nops \
 # RUN:   --alt-inst-feature-size=4 -o %t.out | FileCheck %s
 
+## Check that out-of-bounds read is handled properly.
+
+# RUN: not llvm-bolt %t.exe --print-normalized --keep-nops \
+# RUN:   --alt-inst-feature-size=2 -o %t.out
+
 # CHECK:      BOLT-INFO: Linux kernel binary detected
 # CHECK:      BOLT-INFO: parsed 2 alternative instruction entries