Use cl::opt<std::optional<bool>> for preserve-{bc,ll}-uselistorder options

Author: Enna1

llvm/include/llvm/IR/UseListOrder.h

@@ -14,6 +14,7 @@
 #ifndef LLVM_IR_USELISTORDER_H
 #define LLVM_IR_USELISTORDER_H
 
+#include "llvm/Support/CommandLine.h"
 #include <cstddef>
 #include <vector>
 
@@ -38,6 +39,27 @@ struct UseListOrder {
 
 using UseListOrderStack = std::vector<UseListOrder>;
 
+class PreserveUseListOrderOptionParser
+    : public cl::parser<std::optional<bool>> {
+public:
+  PreserveUseListOrderOptionParser(cl::Option &O)
+      : cl::parser<std::optional<bool>>(O) {}
+
+  bool parse(cl::Option &O, StringRef ArgName, StringRef Arg,
+             std::optional<bool> &V) {
+    if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
+        Arg == "1") {
+      V = true;
+      return false;
+    }
+    if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
+      V = false;
+      return false;
+    }
+    return O.error("Invalid argument '" + Arg + "',  Try 0 or 1");
+  }
+};
+
 } // end namespace llvm
 
 #endif // LLVM_IR_USELISTORDER_H

llvm/lib/Bitcode/Writer/BitcodeWriter.cpp

@@ -118,10 +118,12 @@ static cl::opt<bool>
 #endif
                                 cl::desc(""));
 
-static cl::opt<bool> PreserveBitcodeUseListOrder(
-    "preserve-bc-uselistorder",
-    cl::desc("Preserve use-list order when writing LLVM bitcode."),
-    cl::init(false), cl::Hidden);
+static cl::opt<std::optional<bool>, /*ExternalStorage=*/false,
+               PreserveUseListOrderOptionParser>
+    PreserveBitcodeUseListOrder(
+        "preserve-bc-uselistorder",
+        cl::desc("Preserve use-list order when writing LLVM bitcode."),
+        cl::init(std::nullopt), cl::Hidden, cl::ValueOptional);
 
 namespace llvm {
 extern FunctionSummary::ForceSummaryHotnessType ForceSummaryEdgesCold;
@@ -222,7 +224,7 @@ class ModuleBitcodeWriterBase : public BitcodeWriterBase {
                           bool ShouldPreserveUseListOrder,
                           const ModuleSummaryIndex *Index)
       : BitcodeWriterBase(Stream, StrtabBuilder), M(M),
-        VE(M, ShouldPreserveUseListOrder || PreserveBitcodeUseListOrder),
+        VE(M, PreserveBitcodeUseListOrder.value_or(ShouldPreserveUseListOrder)),
         Index(Index) {
     // Assign ValueIds to any callee values in the index that came from
     // indirect call profiles and were recorded as a GUID not a Value*

llvm/lib/IR/AsmWriter.cpp

@@ -63,6 +63,7 @@
 #include "llvm/IR/TypeFinder.h"
 #include "llvm/IR/TypedPointerType.h"
 #include "llvm/IR/Use.h"
+#include "llvm/IR/UseListOrder.h"
 #include "llvm/IR/User.h"
 #include "llvm/IR/Value.h"
 #include "llvm/Support/AtomicOrdering.h"
@@ -102,10 +103,12 @@ static cl::opt<bool> PrintProfData(
     "print-prof-data", cl::Hidden,
     cl::desc("Pretty print perf data (branch weights, etc) when dumping"));
 
-static cl::opt<bool> PreserveAssemblyUseListOrder(
-    "preserve-ll-uselistorder",
-    cl::desc("Preserve use-list order when writing LLVM assembly."),
-    cl::init(false), cl::Hidden);
+static cl::opt<std::optional<bool>, /*ExternalStorage=*/false,
+               PreserveUseListOrderOptionParser>
+    PreserveAssemblyUseListOrder(
+        "preserve-ll-uselistorder",
+        cl::desc("Preserve use-list order when writing LLVM assembly."),
+        cl::init(std::nullopt), cl::Hidden, cl::ValueOptional);
 
 // Make virtual table appear in this compilation unit.
 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() = default;
@@ -2938,8 +2941,8 @@ AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
                                bool IsForDebug, bool ShouldPreserveUseListOrder)
     : Out(o), TheModule(M), Machine(Mac), TypePrinter(M), AnnotationWriter(AAW),
       IsForDebug(IsForDebug),
-      ShouldPreserveUseListOrder(ShouldPreserveUseListOrder ||
-                                 PreserveAssemblyUseListOrder) {
+      ShouldPreserveUseListOrder(
+          PreserveAssemblyUseListOrder.value_or(ShouldPreserveUseListOrder)) {
   if (!TheModule)
     return;
   for (const GlobalObject &GO : TheModule->global_objects())
@@ -2951,7 +2954,8 @@ AssemblyWriter::AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
                                const ModuleSummaryIndex *Index, bool IsForDebug)
     : Out(o), TheIndex(Index), Machine(Mac), TypePrinter(/*Module=*/nullptr),
       IsForDebug(IsForDebug),
-      ShouldPreserveUseListOrder(PreserveAssemblyUseListOrder) {}
+      ShouldPreserveUseListOrder(PreserveAssemblyUseListOrder.value_or(false)) {
+}
 
 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
   if (!Operand) {