Sema: Use an xmacro to clean up some duplication in CSTrail.cpp

Author: slavapestov

include/swift/Sema/CSTrail.def

@@ -0,0 +1,61 @@
+//===--- CSTrail.def - Trail Change Kinds ---------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+///
+/// This file enumerates the kinds of SolverTrail::Change.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef CHANGE
+#define CHANGE(Name)
+#endif
+
+#ifndef LOCATOR_CHANGE
+#define LOCATOR_CHANGE(Name) CHANGE(Name)
+#endif
+
+#ifndef LAST_CHANGE
+#define LAST_CHANGE(Name)
+#endif
+
+LOCATOR_CHANGE(RecordedAppliedDisjunction)
+LOCATOR_CHANGE(RecordedMatchCallArgumentResult)
+LOCATOR_CHANGE(RecordedOpenedTypes)
+LOCATOR_CHANGE(RecordedOpenedExistentialType)
+LOCATOR_CHANGE(RecordedPackExpansionEnvironment)
+LOCATOR_CHANGE(RecordedDefaultedConstraint)
+
+CHANGE(AddedTypeVariable)
+CHANGE(AddedConstraint)
+CHANGE(RemovedConstraint)
+CHANGE(ExtendedEquivalenceClass)
+CHANGE(RelatedTypeVariables)
+CHANGE(InferredBindings)
+CHANGE(RetractedBindings)
+CHANGE(UpdatedTypeVariable)
+CHANGE(AddedConversionRestriction)
+CHANGE(AddedFix)
+CHANGE(AddedFixedRequirement)
+CHANGE(RecordedDisjunctionChoice)
+CHANGE(RecordedOpenedPackExpansionType)
+CHANGE(RecordedPackEnvironment)
+CHANGE(RecordedNodeType)
+CHANGE(RecordedKeyPathComponentType)
+CHANGE(DisabledConstraint)
+CHANGE(FavoredConstraint)
+CHANGE(RecordedResultBuilderTransform)
+CHANGE(AppliedPropertyWrapper)
+
+LAST_CHANGE(AppliedPropertyWrapper)
+
+#undef LOCATOR_CHANGE
+#undef LAST_CHANGE
+#undef CHANGE

include/swift/Sema/CSTrail.h

@@ -40,59 +40,11 @@ class SolverTrail {
 
   /// The kind of change made to the graph.
   enum class ChangeKind: unsigned {
-    /// Added a new vertex to the constraint graph.
-    AddedTypeVariable,
-    /// Added a new constraint to the constraint graph.
-    AddedConstraint,
-    /// Removed an existing constraint from the constraint graph.
-    RemovedConstraint,
-    /// Extended the equivalence class of a type variable in the constraint graph.
-    ExtendedEquivalenceClass,
-    /// Added a new edge in the constraint graph.
-    RelatedTypeVariables,
-    /// Inferred potential bindings from a constraint.
-    InferredBindings,
-    /// Retracted potential bindings from a constraint.
-    RetractedBindings,
-    /// Set the fixed type or parent and flags for a type variable.
-    UpdatedTypeVariable,
-    /// Recorded a conversion restriction kind.
-    AddedConversionRestriction,
-    /// Recorded a fix.
-    AddedFix,
-    /// Recorded a fixed requirement.
-    AddedFixedRequirement,
-    /// Recorded a disjunction choice.
-    RecordedDisjunctionChoice,
-    /// Recorded an applied disjunction.
-    RecordedAppliedDisjunction,
-    /// Recorded an argument matching choice.
-    RecordedMatchCallArgumentResult,
-    /// Recorded a list of opened types at a locator.
-    RecordedOpenedTypes,
-    /// Recorded the opening of an existential type at a locator.
-    RecordedOpenedExistentialType,
-    /// Recorded the opening of a pack existential type.
-    RecordedOpenedPackExpansionType,
-    /// Recorded the creation of a generic environment for a pack expansion expression.
-    RecordedPackExpansionEnvironment,
-    /// Recorded the mapping from a pack element expression to its parent
-    /// pack expansion expression.
-    RecordedPackEnvironment,
-    /// Recorded a defaulted constraint at a locator.
-    RecordedDefaultedConstraint,
-    /// Recorded an assignment of a type to an AST node.
-    RecordedNodeType,
-    /// Recorded an assignment of a type to a keypath component.
-    RecordedKeyPathComponentType,
-    /// Disabled a constraint.
-    DisabledConstraint,
-    /// Favored a constraint.
-    FavoredConstraint,
-    /// Recorded a result builder transform.
-    RecordedResultBuilderTransform,
-    /// Applied a property wrapper.
-    AppliedPropertyWrapper,
+#define CHANGE(Name) Name,
+#define LAST_CHANGE(Name) Last = Name
+#include "CSTrail.def"
+#undef CHANGE
+#undef LAST_CHANGE
   };
 
   /// A change made to the constraint system.
@@ -176,97 +128,82 @@ class SolverTrail {
 
     Change() : Kind(ChangeKind::AddedTypeVariable), TypeVar(nullptr) { }
 
+#define LOCATOR_CHANGE(Name) static Change Name(ConstraintLocator *locator);
+#include "swift/Sema/CSTrail.def"
+
     /// Create a change that added a type variable.
-    static Change addedTypeVariable(TypeVariableType *typeVar);
+    static Change AddedTypeVariable(TypeVariableType *typeVar);
 
     /// Create a change that added a constraint.
-    static Change addedConstraint(TypeVariableType *typeVar, Constraint *constraint);
+    static Change AddedConstraint(TypeVariableType *typeVar, Constraint *constraint);
 
     /// Create a change that removed a constraint.
-    static Change removedConstraint(TypeVariableType *typeVar, Constraint *constraint);
+    static Change RemovedConstraint(TypeVariableType *typeVar, Constraint *constraint);
 
     /// Create a change that extended an equivalence class.
-    static Change extendedEquivalenceClass(TypeVariableType *typeVar,
+    static Change ExtendedEquivalenceClass(TypeVariableType *typeVar,
                                            unsigned prevSize);
 
     /// Create a change that updated the references/referenced by sets of
     /// a type variable pair.
-    static Change relatedTypeVariables(TypeVariableType *typeVar,
+    static Change RelatedTypeVariables(TypeVariableType *typeVar,
                                        TypeVariableType *otherTypeVar);
 
     /// Create a change that inferred bindings from a constraint.
-    static Change inferredBindings(TypeVariableType *typeVar,
+    static Change InferredBindings(TypeVariableType *typeVar,
                                    Constraint *constraint);
 
     /// Create a change that retracted bindings from a constraint.
-    static Change retractedBindings(TypeVariableType *typeVar,
+    static Change RetractedBindings(TypeVariableType *typeVar,
                                     Constraint *constraint);
 
     /// Create a change that updated a type variable.
-    static Change updatedTypeVariable(
+    static Change UpdatedTypeVariable(
                TypeVariableType *typeVar,
                llvm::PointerUnion<TypeVariableType *, TypeBase *> parentOrFixed,
                unsigned options);
 
     /// Create a change that recorded a restriction.
-    static Change addedConversionRestriction(Type srcType, Type dstType);
+    static Change AddedConversionRestriction(Type srcType, Type dstType);
 
     /// Create a change that recorded a fix.
-    static Change addedFix(ConstraintFix *fix);
+    static Change AddedFix(ConstraintFix *fix);
 
     /// Create a change that recorded a fixed requirement.
-    static Change addedFixedRequirement(GenericTypeParamType *GP,
+    static Change AddedFixedRequirement(GenericTypeParamType *GP,
                                         unsigned reqKind,
                                         Type requirementTy);
 
     /// Create a change that recorded a disjunction choice.
-    static Change recordedDisjunctionChoice(ConstraintLocator *locator,
+    static Change RecordedDisjunctionChoice(ConstraintLocator *locator,
                                             unsigned index);
 
-    /// Create a change that recorded an applied disjunction.
-    static Change recordedAppliedDisjunction(ConstraintLocator *locator);
-
-    /// Create a change that recorded an applied disjunction.
-    static Change recordedMatchCallArgumentResult(ConstraintLocator *locator);
-
-    /// Create a change that recorded a list of opened types.
-    static Change recordedOpenedTypes(ConstraintLocator *locator);
-
-    /// Create a change that recorded the opening of an existential type.
-    static Change recordedOpenedExistentialType(ConstraintLocator *locator);
-
     /// Create a change that recorded the opening of a pack expansion type.
-    static Change recordedOpenedPackExpansionType(PackExpansionType *expansion);
-
-    /// Create a change that recorded the opening of a pack expansion type.
-    static Change recordedPackExpansionEnvironment(ConstraintLocator *locator);
+    static Change RecordedOpenedPackExpansionType(PackExpansionType *expansion);
 
     /// Create a change that recorded a mapping from a pack element expression
     /// to its parent expansion expression.
-    static Change recordedPackEnvironment(PackElementExpr *packElement);
-
-    /// Create a change that recorded a defaulted constraint at a locator.
-    static Change recordedDefaultedConstraint(ConstraintLocator *locator);
+    static Change RecordedPackEnvironment(PackElementExpr *packElement);
 
     /// Create a change that recorded an assignment of a type to an AST node.
-    static Change recordedNodeType(ASTNode node, Type oldType);
+    static Change RecordedNodeType(ASTNode node, Type oldType);
 
     /// Create a change that recorded an assignment of a type to an AST node.
-    static Change recordedKeyPathComponentType(const KeyPathExpr *expr,
+    static Change RecordedKeyPathComponentType(const KeyPathExpr *expr,
                                                unsigned component,
                                                Type oldType);
 
     /// Create a change that disabled a constraint.
-    static Change disabledConstraint(Constraint *constraint);
+    static Change DisabledConstraint(Constraint *constraint);
 
     /// Create a change that favored a constraint.
-    static Change favoredConstraint(Constraint *constraint);
+    static Change FavoredConstraint(Constraint *constraint);
 
     /// Create a change that recorded a result builder transform.
-    static Change recordedResultBuilderTransform(AnyFunctionRef fn);
+    static Change RecordedResultBuilderTransform(AnyFunctionRef fn);
 
     /// Create a change that recorded a result builder transform.
-    static Change appliedPropertyWrapper(Expr *anchor);
+    static Change AppliedPropertyWrapper(Expr *anchor);
 
     /// Undo this change, reverting the constraint graph to the state it
     /// had prior to this change.
@@ -278,7 +215,7 @@ class SolverTrail {
               unsigned indent = 0) const;
   };
 
-  SolverTrail(ConstraintSystem &cs) : CS(cs) {}
+  SolverTrail(ConstraintSystem &cs);
 
   ~SolverTrail();
 
@@ -305,6 +242,8 @@ class SolverTrail {
   /// The list of changes made to this constraint system.
   std::vector<Change> Changes;
 
+  uint64_t Profile[unsigned(ChangeKind::Last) + 1];
+
   bool UndoActive = false;
   unsigned Total = 0;
   unsigned Max = 0;

include/swift/Sema/ConstraintSystem.h

@@ -435,7 +435,7 @@ class TypeVariableType::Implementation {
 
   /// Record the current type-variable binding.
   void recordBinding(constraints::SolverTrail &trail) {
-    trail.recordChange(constraints::SolverTrail::Change::updatedTypeVariable(
+    trail.recordChange(constraints::SolverTrail::Change::UpdatedTypeVariable(
         getTypeVariable(), ParentOrFixed, getRawOptions()));
   }
 
@@ -2413,7 +2413,7 @@ class ConstraintSystem {
     bool inserted = DefaultedConstraints.insert(locator).second;
     if (inserted) {
       if (solverState)
-        recordChange(SolverTrail::Change::recordedDefaultedConstraint(locator));
+        recordChange(SolverTrail::Change::RecordedDefaultedConstraint(locator));
     }
   }
 
@@ -2643,7 +2643,7 @@ class ConstraintSystem {
     void disableConstraint(Constraint *constraint) {
       ASSERT(!constraint->isDisabled());
       constraint->setDisabled();
-      Trail.recordChange(SolverTrail::Change::disabledConstraint(constraint));
+      Trail.recordChange(SolverTrail::Change::DisabledConstraint(constraint));
     }
 
     /// Favor the given constraint; this change will be rolled back
@@ -2652,7 +2652,7 @@ class ConstraintSystem {
       assert(!constraint->isFavored());
 
       constraint->setFavored();
-      Trail.recordChange(SolverTrail::Change::favoredConstraint(constraint));
+      Trail.recordChange(SolverTrail::Change::FavoredConstraint(constraint));
     }
 
   private:
@@ -3172,7 +3172,7 @@ class ConstraintSystem {
     if (oldType.getPointer() != type.getPointer()) {
       // Record the fact that we assigned a type to this node.
       if (solverState)
-        recordChange(SolverTrail::Change::recordedNodeType(node, oldType));
+        recordChange(SolverTrail::Change::RecordedNodeType(node, oldType));
     }
   }
 
@@ -3211,7 +3211,7 @@ class ConstraintSystem {
     if (oldType.getPointer() != T.getPointer()) {
       if (solverState) {
         recordChange(
-          SolverTrail::Change::recordedKeyPathComponentType(
+          SolverTrail::Change::RecordedKeyPathComponentType(
             KP, I, oldType));
       }
     }

lib/Sema/BuilderTransform.cpp

@@ -1226,7 +1226,7 @@ void ConstraintSystem::recordResultBuilderTransform(AnyFunctionRef fn,
   ASSERT(inserted);
 
   if (solverState)
-    recordChange(SolverTrail::Change::recordedResultBuilderTransform(fn));
+    recordChange(SolverTrail::Change::RecordedResultBuilderTransform(fn));
 }
 
 /// Undo the above change.

lib/Sema/CSBindings.cpp

@@ -1777,7 +1777,7 @@ void PotentialBindings::infer(Constraint *constraint) {
 
   // Record the change, if there are active scopes.
   if (CS.isRecordingChanges())
-    CS.recordChange(SolverTrail::Change::inferredBindings(TypeVar, constraint));
+    CS.recordChange(SolverTrail::Change::InferredBindings(TypeVar, constraint));
 
   switch (constraint->getKind()) {
   case ConstraintKind::Bind:
@@ -1952,7 +1952,7 @@ void PotentialBindings::retract(Constraint *constraint) {
 
   // Record the change, if there are active scopes.
   if (CS.isRecordingChanges())
-    CS.recordChange(SolverTrail::Change::retractedBindings(TypeVar, constraint));
+    CS.recordChange(SolverTrail::Change::RetractedBindings(TypeVar, constraint));
 
   LLVM_DEBUG(
     llvm::dbgs() << Constraints.size() << " " << Bindings.size() << " "

lib/Sema/CSGen.cpp

@@ -5051,7 +5051,7 @@ void ConstraintSystem::applyPropertyWrapper(
   appliedPropertyWrappers[anchor].push_back(applied);
 
   if (solverState)
-    recordChange(SolverTrail::Change::appliedPropertyWrapper(anchor));
+    recordChange(SolverTrail::Change::AppliedPropertyWrapper(anchor));
 }
 
 void ConstraintSystem::removePropertyWrapper(Expr *anchor) {

lib/Sema/CSSimplify.cpp

@@ -14930,7 +14930,7 @@ void ConstraintSystem::recordMatchCallArgumentResult(
   ASSERT(inserted);
 
   if (solverState)
-    recordChange(SolverTrail::Change::recordedMatchCallArgumentResult(locator));
+    recordChange(SolverTrail::Change::RecordedMatchCallArgumentResult(locator));
 }
 
 void ConstraintSystem::recordCallAsFunction(UnresolvedDotExpr *root,