Print a warning for note segments and note sections in segments

igorkudrin · igorkudrin · commit 56950965c937 · 2025-01-16T15:17:27.000-08:00
diff --git a/llvm/include/llvm/ObjCopy/ELF/ELFObjcopy.h b/llvm/include/llvm/ObjCopy/ELF/ELFObjcopy.h
@@ -9,10 +9,13 @@
 #ifndef LLVM_OBJCOPY_ELF_ELFOBJCOPY_H
 #define LLVM_OBJCOPY_ELF_ELFOBJCOPY_H
 
+#include "llvm/ADT/STLFunctionalExtras.h"
+
 namespace llvm {
 class Error;
 class MemoryBuffer;
 class raw_ostream;
+class Twine;
 
 namespace object {
 class ELFObjectFileBase;
@@ -25,26 +28,29 @@ struct ELFConfig;
 namespace elf {
 /// Apply the transformations described by \p Config and \p ELFConfig to
 /// \p In, which must represent an IHex file, and writes the result
-/// into \p Out.
+/// into \p Out. Warnings can be printed via \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnIHex(const CommonConfig &Config,
                            const ELFConfig &ELFConfig, MemoryBuffer &In,
-                           raw_ostream &Out);
+                           raw_ostream &Out,
+                           function_ref<void(const Twine &)> WarningCallback);
 
 /// Apply the transformations described by \p Config and \p ELFConfig to
 /// \p In, which is treated as a raw binary input, and writes the result
-/// into \p Out.
+/// into \p Out. Warnings can be printed via \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
-Error executeObjcopyOnRawBinary(const CommonConfig &Config,
-                                const ELFConfig &ELFConfig, MemoryBuffer &In,
-                                raw_ostream &Out);
+Error executeObjcopyOnRawBinary(
+    const CommonConfig &Config, const ELFConfig &ELFConfig, MemoryBuffer &In,
+    raw_ostream &Out, function_ref<void(const Twine &)> WarningCallback);
 
 /// Apply the transformations described by \p Config and \p ELFConfig to
-/// \p In and writes the result into \p Out.
+/// \p In and writes the result into \p Out. Warnings can be printed via
+/// \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const CommonConfig &Config,
                              const ELFConfig &ELFConfig,
-                             object::ELFObjectFileBase &In, raw_ostream &Out);
+                             object::ELFObjectFileBase &In, raw_ostream &Out,
+                             function_ref<void(const Twine &)> WarningCallback);
 
 } // end namespace elf
 } // end namespace objcopy
diff --git a/llvm/include/llvm/ObjCopy/MachO/MachOObjcopy.h b/llvm/include/llvm/ObjCopy/MachO/MachOObjcopy.h
@@ -9,9 +9,12 @@
 #ifndef LLVM_OBJCOPY_MACHO_MACHOOBJCOPY_H
 #define LLVM_OBJCOPY_MACHO_MACHOOBJCOPY_H
 
+#include "llvm/ADT/STLFunctionalExtras.h"
+
 namespace llvm {
 class Error;
 class raw_ostream;
+class Twine;
 
 namespace object {
 class MachOObjectFile;
@@ -26,17 +29,20 @@ class MultiFormatConfig;
 namespace macho {
 /// Apply the transformations described by \p Config and \p MachOConfig to
 /// \p In and writes the result into \p Out.
+/// Warnings can be printed via \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const CommonConfig &Config,
                              const MachOConfig &MachOConfig,
-                             object::MachOObjectFile &In, raw_ostream &Out);
+                             object::MachOObjectFile &In, raw_ostream &Out,
+                             function_ref<void(const Twine &)> WarningCallback);
 
 /// Apply the transformations described by \p Config and \p MachOConfig to
 /// \p In and writes the result into \p Out.
+/// Warnings can be printed via \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnMachOUniversalBinary(
     const MultiFormatConfig &Config, const object::MachOUniversalBinary &In,
-    raw_ostream &Out);
+    raw_ostream &Out, function_ref<void(const Twine &)> WarningCallback);
 
 } // end namespace macho
 } // end namespace objcopy
diff --git a/llvm/include/llvm/ObjCopy/ObjCopy.h b/llvm/include/llvm/ObjCopy/ObjCopy.h
@@ -9,10 +9,12 @@
 #ifndef LLVM_OBJCOPY_OBJCOPY_H
 #define LLVM_OBJCOPY_OBJCOPY_H
 
+#include "llvm/ADT/STLFunctionalExtras.h"
 #include "llvm/Support/Error.h"
 
 namespace llvm {
 class raw_ostream;
+class Twine;
 
 namespace object {
 class Archive;
@@ -25,16 +27,20 @@ class MultiFormatConfig;
 /// Applies the transformations described by \p Config to
 /// each member in archive \p Ar.
 /// Writes a result in a file specified by \p Config.OutputFilename.
+/// Warnings can be printed via \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
-Error executeObjcopyOnArchive(const MultiFormatConfig &Config,
-                              const object::Archive &Ar);
+Error executeObjcopyOnArchive(
+    const MultiFormatConfig &Config, const object::Archive &Ar,
+    function_ref<void(const Twine &)> WarningCallback);
 
 /// Applies the transformations described by \p Config to \p In and writes
 /// the result into \p Out. This function does the dispatch based on the
 /// format of the input binary (COFF, ELF, MachO or wasm).
+/// Warnings can be printed via \p WarningCallback.
 /// \returns any Error encountered whilst performing the operation.
 Error executeObjcopyOnBinary(const MultiFormatConfig &Config,
-                             object::Binary &In, raw_ostream &Out);
+                             object::Binary &In, raw_ostream &Out,
+                             function_ref<void(const Twine &)> WarningCallback);
 
 } // end namespace objcopy
 } // end namespace llvm
diff --git a/llvm/lib/ObjCopy/Archive.cpp b/llvm/lib/ObjCopy/Archive.cpp
@@ -20,7 +20,8 @@ namespace objcopy {
 using namespace llvm::object;
 
 Expected<std::vector<NewArchiveMember>>
-createNewArchiveMembers(const MultiFormatConfig &Config, const Archive &Ar) {
+createNewArchiveMembers(const MultiFormatConfig &Config, const Archive &Ar,
+                        function_ref<void(const Twine &)> WarningCallback) {
   std::vector<NewArchiveMember> NewArchiveMembers;
   Error Err = Error::success();
   for (const Archive::Child &Child : Ar.children(Err)) {
@@ -36,7 +37,8 @@ createNewArchiveMembers(const MultiFormatConfig &Config, const Archive &Ar) {
     SmallVector<char, 0> Buffer;
     raw_svector_ostream MemStream(Buffer);
 
-    if (Error E = executeObjcopyOnBinary(Config, *ChildOrErr->get(), MemStream))
+    if (Error E = executeObjcopyOnBinary(Config, *ChildOrErr->get(), MemStream,
+                                         WarningCallback))
       return std::move(E);
 
     Expected<NewArchiveMember> Member = NewArchiveMember::getOldMember(
@@ -94,10 +96,11 @@ static Error deepWriteArchive(StringRef ArcName,
   return Error::success();
 }
 
-Error executeObjcopyOnArchive(const MultiFormatConfig &Config,
-                              const object::Archive &Ar) {
+Error executeObjcopyOnArchive(
+    const MultiFormatConfig &Config, const object::Archive &Ar,
+    function_ref<void(const Twine &)> WarningCallback) {
   Expected<std::vector<NewArchiveMember>> NewArchiveMembersOrErr =
-      createNewArchiveMembers(Config, Ar);
+      createNewArchiveMembers(Config, Ar, WarningCallback);
   if (!NewArchiveMembersOrErr)
     return NewArchiveMembersOrErr.takeError();
   const CommonConfig &CommonConfig = Config.getCommonConfig();
diff --git a/llvm/lib/ObjCopy/Archive.h b/llvm/lib/ObjCopy/Archive.h
@@ -20,10 +20,12 @@ class MultiFormatConfig;
 
 /// Applies the transformations described by \p Config to
 /// each member in archive \p Ar.
+/// Warnings can be printed via \p WarningCallback.
 /// \returns Vector of transformed archive members.
 Expected<std::vector<NewArchiveMember>>
 createNewArchiveMembers(const MultiFormatConfig &Config,
-                        const object::Archive &Ar);
+                        const object::Archive &Ar,
+                        function_ref<void(const Twine &)> WarningCallback);
 
 } // end namespace objcopy
 } // end namespace llvm
diff --git a/llvm/lib/ObjCopy/ELF/ELFObjcopy.cpp b/llvm/lib/ObjCopy/ELF/ELFObjcopy.cpp
@@ -671,11 +671,24 @@ RemoveNoteDetail::updateData(ArrayRef<uint8_t> OldData,
 }
 
 static Error removeNote(Object &Obj, endianness Endianness,
-                        ArrayRef<RemoveNoteInfo> NotesToRemove) {
+                        ArrayRef<RemoveNoteInfo> NotesToRemove,
+                        function_ref<void(const Twine &)> WarningCallback) {
+  // TODO: Support note segments.
+  for (Segment &Seg : Obj.segments()) {
+    if (Seg.Type == PT_NOTE) {
+      WarningCallback("note segments are not supported");
+      break;
+    }
+  }
   for (auto &Sec : Obj.sections()) {
-    // TODO: Support note sections in segments
-    if (Sec.Type != SHT_NOTE || Sec.ParentSegment || !Sec.hasContents())
+    if (Sec.Type != SHT_NOTE || !Sec.hasContents())
       continue;
+    // TODO: Support note sections in segments.
+    if (Sec.ParentSegment) {
+      WarningCallback("cannot remove note(s) from " + Sec.Name +
+                      ": sections in segments are not supported");
+      continue;
+    }
     ArrayRef<uint8_t> OldData = Sec.getContents();
     size_t Align = std::max<size_t>(4, Sec.Align);
     // Note: notes for both 32-bit and 64-bit ELF files use 4-byte words in the
@@ -759,7 +772,8 @@ static Error verifyNoteSection(StringRef Name, endianness Endianness,
 // depend a) on the order the options occur in or b) on some opaque priority
 // system. The only priority is that keeps/copies overrule removes.
 static Error handleArgs(const CommonConfig &Config, const ELFConfig &ELFConfig,
-                        ElfType OutputElfType, Object &Obj) {
+                        ElfType OutputElfType, Object &Obj,
+                        function_ref<void(const Twine &)> WarningCallback) {
   if (Config.OutputArch) {
     Obj.Machine = Config.OutputArch->EMachine;
     Obj.OSABI = Config.OutputArch->OSABI;
@@ -885,7 +899,8 @@ static Error handleArgs(const CommonConfig &Config, const ELFConfig &ELFConfig,
                      : endianness::big;
 
   if (!ELFConfig.NotesToRemove.empty()) {
-    if (Error Err = removeNote(Obj, E, ELFConfig.NotesToRemove))
+    if (Error Err =
+            removeNote(Obj, E, ELFConfig.NotesToRemove, WarningCallback))
       return Err;
   }
 
@@ -1020,25 +1035,25 @@ static Error writeOutput(const CommonConfig &Config, Object &Obj,
   return Writer->write();
 }
 
-Error objcopy::elf::executeObjcopyOnIHex(const CommonConfig &Config,
-                                         const ELFConfig &ELFConfig,
-                                         MemoryBuffer &In, raw_ostream &Out) {
+Error objcopy::elf::executeObjcopyOnIHex(
+    const CommonConfig &Config, const ELFConfig &ELFConfig, MemoryBuffer &In,
+    raw_ostream &Out, function_ref<void(const Twine &)> WarningCallback) {
   IHexReader Reader(&In);
   Expected<std::unique_ptr<Object>> Obj = Reader.create(true);
   if (!Obj)
     return Obj.takeError();
 
   const ElfType OutputElfType =
       getOutputElfType(Config.OutputArch.value_or(MachineInfo()));
-  if (Error E = handleArgs(Config, ELFConfig, OutputElfType, **Obj))
+  if (Error E =
+          handleArgs(Config, ELFConfig, OutputElfType, **Obj, WarningCallback))
     return E;
   return writeOutput(Config, **Obj, Out, OutputElfType);
 }
 
-Error objcopy::elf::executeObjcopyOnRawBinary(const CommonConfig &Config,
-                                              const ELFConfig &ELFConfig,
-                                              MemoryBuffer &In,
-                                              raw_ostream &Out) {
+Error objcopy::elf::executeObjcopyOnRawBinary(
+    const CommonConfig &Config, const ELFConfig &ELFConfig, MemoryBuffer &In,
+    raw_ostream &Out, function_ref<void(const Twine &)> WarningCallback) {
   BinaryReader Reader(&In, ELFConfig.NewSymbolVisibility);
   Expected<std::unique_ptr<Object>> Obj = Reader.create(true);
   if (!Obj)
@@ -1048,15 +1063,16 @@ Error objcopy::elf::executeObjcopyOnRawBinary(const CommonConfig &Config,
   // (-B<arch>).
   const ElfType OutputElfType =
       getOutputElfType(Config.OutputArch.value_or(MachineInfo()));
-  if (Error E = handleArgs(Config, ELFConfig, OutputElfType, **Obj))
+  if (Error E =
+          handleArgs(Config, ELFConfig, OutputElfType, **Obj, WarningCallback))
     return E;
   return writeOutput(Config, **Obj, Out, OutputElfType);
 }
 
-Error objcopy::elf::executeObjcopyOnBinary(const CommonConfig &Config,
-                                           const ELFConfig &ELFConfig,
-                                           object::ELFObjectFileBase &In,
-                                           raw_ostream &Out) {
+Error objcopy::elf::executeObjcopyOnBinary(
+    const CommonConfig &Config, const ELFConfig &ELFConfig,
+    object::ELFObjectFileBase &In, raw_ostream &Out,
+    function_ref<void(const Twine &)> WarningCallback) {
   ELFReader Reader(&In, Config.ExtractPartition);
   Expected<std::unique_ptr<Object>> Obj =
       Reader.create(!Config.SymbolsToAdd.empty());
@@ -1067,7 +1083,8 @@ Error objcopy::elf::executeObjcopyOnBinary(const CommonConfig &Config,
                                     ? getOutputElfType(*Config.OutputArch)
                                     : getOutputElfType(In);
 
-  if (Error E = handleArgs(Config, ELFConfig, OutputElfType, **Obj))
+  if (Error E =
+          handleArgs(Config, ELFConfig, OutputElfType, **Obj, WarningCallback))
     return createFileError(Config.InputFilename, std::move(E));
 
   if (Error E = writeOutput(Config, **Obj, Out, OutputElfType))
diff --git a/llvm/lib/ObjCopy/MachO/MachOObjcopy.cpp b/llvm/lib/ObjCopy/MachO/MachOObjcopy.cpp
@@ -445,10 +445,10 @@ static Error handleArgs(const CommonConfig &Config,
   return Error::success();
 }
 
-Error objcopy::macho::executeObjcopyOnBinary(const CommonConfig &Config,
-                                             const MachOConfig &MachOConfig,
-                                             object::MachOObjectFile &In,
-                                             raw_ostream &Out) {
+Error objcopy::macho::executeObjcopyOnBinary(
+    const CommonConfig &Config, const MachOConfig &MachOConfig,
+    object::MachOObjectFile &In, raw_ostream &Out,
+    function_ref<void(const Twine &)> WarningCallback) {
   MachOReader Reader(In);
   Expected<std::unique_ptr<Object>> O = Reader.create();
   if (!O)
@@ -484,14 +484,14 @@ Error objcopy::macho::executeObjcopyOnBinary(const CommonConfig &Config,
 
 Error objcopy::macho::executeObjcopyOnMachOUniversalBinary(
     const MultiFormatConfig &Config, const MachOUniversalBinary &In,
-    raw_ostream &Out) {
+    raw_ostream &Out, function_ref<void(const Twine &)> WarningCallback) {
   SmallVector<OwningBinary<Binary>, 2> Binaries;
   SmallVector<Slice, 2> Slices;
   for (const auto &O : In.objects()) {
     Expected<std::unique_ptr<Archive>> ArOrErr = O.getAsArchive();
     if (ArOrErr) {
       Expected<std::vector<NewArchiveMember>> NewArchiveMembersOrErr =
-          createNewArchiveMembers(Config, **ArOrErr);
+          createNewArchiveMembers(Config, **ArOrErr, WarningCallback);
       if (!NewArchiveMembersOrErr)
         return NewArchiveMembersOrErr.takeError();
       auto Kind = (*ArOrErr)->kind();
@@ -542,8 +542,9 @@ Error objcopy::macho::executeObjcopyOnMachOUniversalBinary(
     if (!MachO)
       return MachO.takeError();
 
-    if (Error E = executeObjcopyOnBinary(Config.getCommonConfig(), *MachO,
-                                         **ObjOrErr, MemStream))
+    if (Error E =
+            executeObjcopyOnBinary(Config.getCommonConfig(), *MachO, **ObjOrErr,
+                                   MemStream, WarningCallback))
       return E;
 
     auto MB = std::make_unique<SmallVectorMemoryBuffer>(
diff --git a/llvm/lib/ObjCopy/ObjCopy.cpp b/llvm/lib/ObjCopy/ObjCopy.cpp
@@ -33,15 +33,16 @@ using namespace llvm::object;
 
 /// The function executeObjcopyOnBinary does the dispatch based on the format
 /// of the input binary (ELF, MachO or COFF).
-Error executeObjcopyOnBinary(const MultiFormatConfig &Config,
-                             object::Binary &In, raw_ostream &Out) {
+Error executeObjcopyOnBinary(
+    const MultiFormatConfig &Config, object::Binary &In, raw_ostream &Out,
+    function_ref<void(const Twine &)> WarningCallback) {
   if (auto *ELFBinary = dyn_cast<object::ELFObjectFileBase>(&In)) {
     Expected<const ELFConfig &> ELFConfig = Config.getELFConfig();
     if (!ELFConfig)
       return ELFConfig.takeError();
 
     return elf::executeObjcopyOnBinary(Config.getCommonConfig(), *ELFConfig,
-                                       *ELFBinary, Out);
+                                       *ELFBinary, Out, WarningCallback);
   }
   if (auto *COFFBinary = dyn_cast<object::COFFObjectFile>(&In)) {
     Expected<const COFFConfig &> COFFConfig = Config.getCOFFConfig();
@@ -57,12 +58,12 @@ Error executeObjcopyOnBinary(const MultiFormatConfig &Config,
       return MachOConfig.takeError();
 
     return macho::executeObjcopyOnBinary(Config.getCommonConfig(), *MachOConfig,
-                                         *MachOBinary, Out);
+                                         *MachOBinary, Out, WarningCallback);
   }
   if (auto *MachOUniversalBinary =
           dyn_cast<object::MachOUniversalBinary>(&In)) {
     return macho::executeObjcopyOnMachOUniversalBinary(
-        Config, *MachOUniversalBinary, Out);
+        Config, *MachOUniversalBinary, Out, WarningCallback);
   }
   if (auto *WasmBinary = dyn_cast<object::WasmObjectFile>(&In)) {
     Expected<const WasmConfig &> WasmConfig = Config.getWasmConfig();
diff --git a/llvm/test/tools/llvm-objcopy/ELF/remove-note-unsupported.test b/llvm/test/tools/llvm-objcopy/ELF/remove-note-unsupported.test
diff --git a/llvm/tools/llvm-dwarfutil/llvm-dwarfutil.cpp b/llvm/tools/llvm-dwarfutil/llvm-dwarfutil.cpp
diff --git a/llvm/tools/llvm-objcopy/llvm-objcopy.cpp b/llvm/tools/llvm-objcopy/llvm-objcopy.cpp
diff --git a/llvm/unittests/ObjCopy/ObjCopyTest.cpp b/llvm/unittests/ObjCopy/ObjCopyTest.cpp
