More command line options clean up (#732)

This is a follow up PR from #692 that moves all command line options into the
_3COptions structure, moves all of 3C's command line options into the same
category so that all options are shown by -help (fixes #393), and reformats some
of the code around creating command line options.

It also removes the the option -enable-itypeprop which was not referenced
anywhere in the code.

Author: john-h-kastner

clang/include/clang/3C/3CGlobalOptions.h

@@ -21,54 +21,40 @@
 // NOLINTNEXTLINE(readability-identifier-naming)
 struct _3COptions {
   bool DumpIntermediate;
-
   bool Verbose;
-
   std::string OutputPostfix;
   std::string OutputDir;
-
   std::string ConstraintOutputJson;
-
   bool DumpStats;
-
   std::string StatsOutputJson;
-
   std::string WildPtrInfoJson;
-
   std::string PerWildPtrInfoJson;
-
   std::vector<std::string> AllocatorFunctions;
-
   bool HandleVARARGS;
-
-  bool EnablePropThruIType;
-
   std::string BaseDir;
   bool AllowSourcesOutsideBaseDir;
-
   bool AllTypes;
-
   bool AddCheckedRegions;
-
   bool EnableCCTypeChecker;
-
   bool WarnRootCause;
-
   bool WarnAllRootCause;
-
-#ifdef FIVE_C
-  bool RemoveItypes;
-  bool ForceItypes;
-#endif
-
   bool DumpUnwritableChanges;
   bool AllowUnwritableChanges;
-
   bool AllowRewriteFailures;
-
   bool ItypesForExtern;
-
   bool InferTypesForUndefs;
+  bool DebugSolver;
+  bool OnlyGreatestSol;
+  bool OnlyLeastSol;
+  bool DisableRDs;
+  bool DisableFunctionEdges;
+  bool DisableInfDecls;
+  bool DisableArrH;
+  bool DebugArrSolver;
+#ifdef FIVE_C
+  bool RemoveItypes;
+  bool ForceItypes;
+#endif
 };
 
 // NOLINTNEXTLINE(readability-identifier-naming)

clang/lib/3C/3C.cpp

@@ -32,12 +32,6 @@ using namespace llvm;
 #define BEFORE_SOLVING_SUFFIX "_before_solving_"
 #define AFTER_SUBTYPING_SUFFIX "_after_subtyping_"
 
-cl::OptionCategory ArrBoundsInferCat("Array bounds inference options");
-static cl::opt<bool>
-    DebugArrSolver("debug-arr-solver",
-                   cl::desc("Dump array bounds inference graph"),
-                   cl::init(false), cl::cat(ArrBoundsInferCat));
-
 std::set<std::string> FilePaths;
 
 struct _3COptions _3COpts;
@@ -586,7 +580,7 @@ bool _3CInterface::solveConstraints() {
     GlobalProgramInfo.getABoundsInfo().addConstantArrayBounds(
       GlobalProgramInfo);
 
-    if (DebugArrSolver)
+    if (_3COpts.DebugArrSolver)
       GlobalProgramInfo.getABoundsInfo().dumpAVarGraph(
           "arr_bounds_initial.dot");
 
@@ -670,7 +664,7 @@ bool _3CInterface::writeAllConvertedFilesToDisk() {
 }
 
 bool _3CInterface::dumpStats() {
-  if (_3COpts.AllTypes && DebugArrSolver) {
+  if (_3COpts.AllTypes && _3COpts.DebugArrSolver) {
     GlobalProgramInfo.getABoundsInfo().dumpAVarGraph("arr_bounds_final.dot");
   }
 

clang/lib/3C/AVarBoundsInfo.cpp

@@ -13,18 +13,12 @@
 #include "clang/3C/AVarBoundsInfo.h"
 #include "clang/3C/ConstraintResolver.h"
 #include "clang/3C/ProgramInfo.h"
+#include "clang/3C/3CGlobalOptions.h"
 #include <sstream>
 
 std::vector<BoundsPriority> AVarBoundsInfo::PrioList{Declared, Allocator,
                                                      FlowInferred, Heuristics};
 
-extern cl::OptionCategory ArrBoundsInferCat;
-static cl::opt<bool> DisableInfDecls("disable-arr-missd",
-                                     cl::desc("Disable ignoring of missed "
-                                              "bounds from declarations."),
-                                     cl::init(false),
-                                     cl::cat(ArrBoundsInferCat));
-
 void AVarBoundsStats::print(llvm::raw_ostream &O,
                             const std::set<BoundsKey> *InSrcArrs,
                             bool JsonFormat) const {
@@ -412,7 +406,7 @@ bool AvarBoundsInference::predictBounds(BoundsKey K,
         } else {
           bool IsDeclaredB = areDeclaredBounds(NBK, NKBChoice);
 
-          if (!IsDeclaredB || DisableInfDecls) {
+          if (!IsDeclaredB || _3COpts.DisableInfDecls) {
             // Oh, there are bounds for neighbour NBK but no bounds
             // can be inferred for K from it.
             InferredNBnds.clear();

clang/lib/3C/ConstraintVariables.cpp

@@ -14,24 +14,12 @@
 #include "clang/3C/ProgramInfo.h"
 #include "clang/Lex/Lexer.h"
 #include "llvm/ADT/StringSwitch.h"
-#include "llvm/Support/CommandLine.h"
 #include <sstream>
 
 using namespace clang;
 // Macro for boolean implication.
 #define IMPLIES(a, b) ((a) ? (b) : true)
 
-static llvm::cl::OptionCategory OptimizationCategory("Optimization category");
-static llvm::cl::opt<bool>
-    DisableRDs("disable-rds",
-               llvm::cl::desc("Disable reverse edges for Checked Constraints."),
-               llvm::cl::init(false), llvm::cl::cat(OptimizationCategory));
-
-static llvm::cl::opt<bool> DisableFunctionEdges(
-    "disable-fnedgs",
-    llvm::cl::desc("Disable reverse edges for external functions."),
-    llvm::cl::init(false), llvm::cl::cat(OptimizationCategory));
-
 std::string ConstraintVariable::getRewritableOriginalTy() const {
   std::string OrigTyString = getOriginalTy();
   std::string SpaceStr = " ";
@@ -1734,7 +1722,7 @@ static void createAtomGeq(Constraints &CS, Atom *L, Atom *R,
       }
       break;
     case Wild_to_Safe:
-      if (!DisableRDs) {
+      if (!_3COpts.DisableRDs) {
         // Note: reversal.
         CS.addConstraint(CS.createGeq(R, L, Rsn, true));
       } else {
@@ -1763,7 +1751,7 @@ static void createAtomGeq(Constraints &CS, Atom *L, Atom *R,
           CS.addConstraint(CS.createGeq(R, L, Rsn, true));
         break;
       case Wild_to_Safe:
-        if (!DisableRDs) {
+        if (!_3COpts.DisableRDs) {
           // Note: reversal.
           CS.addConstraint(CS.createGeq(R, L, Rsn, true));
         } else {
@@ -2313,8 +2301,8 @@ void FVComponentVariable::linkInternalExternal(ProgramInfo &I,
         // level. This is because CheckedC does not allow assignment from e.g.
         // a function return of type `int ** : itype(_Ptr<_Ptr<int>>)` to a
         // variable with type `int **`.
-        if (DisableFunctionEdges || DisableRDs || EquateChecked ||
-            (ExternalConstraint->getName() == RETVAR && J > 0))
+        if (_3COpts.DisableFunctionEdges || _3COpts.DisableRDs ||
+            EquateChecked || (ExternalConstraint->getName() == RETVAR && J > 0))
           CS.addConstraint(CS.createGeq(ExternalA, InternalA,
                                         LinkReason, true));
       }

clang/lib/3C/Constraints.cpp

@@ -13,26 +13,11 @@
 #include "clang/3C/3CGlobalOptions.h"
 #include "clang/3C/ConstraintVariables.h"
 #include "clang/3C/ConstraintsGraph.h"
-#include "llvm/Support/CommandLine.h"
 #include <iostream>
 #include <set>
 
 using namespace llvm;
 
-static cl::OptionCategory SolverCategory("solver options");
-static cl::opt<bool> DebugSolver("debug-solver",
-                                 cl::desc("Dump intermediate solver state"),
-                                 cl::init(false), cl::cat(SolverCategory));
-static cl::opt<bool> OnlyGreatestSol(
-    "only-g-sol",
-    cl::desc("Perform only greatest solution for Pty Constrains."),
-    cl::init(false), cl::cat(SolverCategory));
-
-static cl::opt<bool>
-    OnlyLeastSol("only-l-sol",
-                 cl::desc("Perform only least solution for Pty Constrains."),
-                 cl::init(false), cl::cat(SolverCategory));
-
 // Remove the constraint from the global constraint set.
 bool Constraints::removeConstraint(Constraint *C) {
   bool RetVal = false;
@@ -339,7 +324,7 @@ bool Constraints::graphBasedSolve() {
     }
   }
 
-  if (DebugSolver)
+  if (_3COpts.DebugSolver)
     GraphVizOutputGraph::dumpConstraintGraphs("initial_constraints_graph.dot",
                                               SolChkCG, SolPtrTypCG);
 
@@ -351,9 +336,9 @@ bool Constraints::graphBasedSolve() {
   // Now solve PtrType constraints
   if (Res && _3COpts.AllTypes) {
     Env.doCheckedSolve(false);
-    bool RegularSolve = !(OnlyGreatestSol || OnlyLeastSol);
+    bool RegularSolve = !(_3COpts.OnlyGreatestSol || _3COpts.OnlyLeastSol);
 
-    if (OnlyLeastSol) {
+    if (_3COpts.OnlyLeastSol) {
       // Do only least solution.
       // First reset ptr solution to NTArr.
       Env.resetSolution(
@@ -363,7 +348,7 @@ bool Constraints::graphBasedSolve() {
           },
           getNTArr());
       Res = doSolve(SolPtrTypCG, Env, this, true, nullptr, Conflicts);
-    } else if (OnlyGreatestSol) {
+    } else if (_3COpts.OnlyGreatestSol) {
       // Do only greatest solution
       Res = doSolve(SolPtrTypCG, Env, this, false, nullptr, Conflicts);
     } else {
@@ -481,13 +466,13 @@ bool Constraints::graphBasedSolve() {
 // an empty. If the system could not be solved, the constraints in conflict
 // are returned in the first position.
 void Constraints::solve() {
-  if (DebugSolver) {
+  if (_3COpts.DebugSolver) {
     errs() << "constraints beginning solve\n";
     dump();
   }
   graphBasedSolve();
 
-  if (DebugSolver) {
+  if (_3COpts.DebugSolver) {
     errs() << "solution, when done solving\n";
     Environment.dump();
   }

clang/lib/3C/IntermediateToolHook.cpp

@@ -10,21 +10,16 @@
 
 #include "clang/3C/IntermediateToolHook.h"
 #include "clang/3C/ArrayBoundsInferenceConsumer.h"
+#include "clang/3C/3CGlobalOptions.h"
 #include "clang/AST/RecursiveASTVisitor.h"
 
 using namespace llvm;
 using namespace clang;
 
-extern cl::OptionCategory ArrBoundsInferCat;
-static cl::opt<bool>
-    DisableArrH("disable-arr-hu",
-                cl::desc("Disable Array Bounds Inference Heuristics."),
-                cl::init(false), cl::cat(ArrBoundsInferCat));
-
 void IntermediateToolHook::HandleTranslationUnit(ASTContext &Context) {
   Info.enterCompilationUnit(Context);
   Info.getPerfStats().startArrayBoundsInferenceTime();
-  handleArrayVariablesBoundsDetection(&Context, Info, !DisableArrH);
+  handleArrayVariablesBoundsDetection(&Context, Info, !_3COpts.DisableArrH);
   Info.getPerfStats().endArrayBoundsInferenceTime();
   Info.exitCompilationUnit();
 }

clang/lib/3C/ProgramInfo.cpp

@@ -237,7 +237,6 @@ void ProgramInfo::printAggregateStats(const std::set<std::string> &F,
 void ProgramInfo::printStats(const std::set<std::string> &F, raw_ostream &O,
                              bool OnlySummary, bool JsonFormat) {
   if (!OnlySummary && !JsonFormat) {
-    O << "Enable itype propagation:" << _3COpts.EnablePropThruIType << "\n";
     O << "Sound handling of var args functions:" << _3COpts.HandleVARARGS
       << "\n";
   }