Merge pull request #39474 from slavapestov/rqm-generating-conformances

RequirementMachine: Sketch out "generating conformances" algorithm

Author: slavapestov

lib/AST/CMakeLists.txt

@@ -75,6 +75,7 @@ add_swift_host_library(swiftAST STATIC
   RawComment.cpp
   RequirementEnvironment.cpp
   RequirementMachine/HomotopyReduction.cpp
+  RequirementMachine/GeneratingConformances.cpp
   RequirementMachine/GenericSignatureQueries.cpp
   RequirementMachine/PropertyMap.cpp
   RequirementMachine/ProtocolGraph.cpp

lib/AST/RequirementMachine/Debug.h

@@ -39,7 +39,10 @@ enum class DebugFlags : unsigned {
   ConcretizeNestedTypes = (1<<5),
 
   /// Print debug output from the homotopy reduction algorithm.
-  HomotopyReduction = (1<<6)
+  HomotopyReduction = (1<<6),
+
+  /// Print debug output from the generating conformances algorithm.
+  GeneratingConformances = (1<<7),
 };
 
 using DebugOptions = OptionSet<DebugFlags>;

lib/AST/RequirementMachine/GeneratingConformances.cpp

@@ -0,0 +1,368 @@
+//===--- GeneratingConformances.cpp - Reasoning about conformance rules ---===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2021 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 implements an algorithm to find a minimal set of "generating
+// conformances", which are rules (V1.[P1] => V1), ..., (Vn.[Pn] => Vn) such
+// that any valid term of the form T.[P] can be written as a product of terms
+// (Vi.[Pi]), where each Vi.[Pi] is a left hand side of a generating
+// conformance.
+//
+//===----------------------------------------------------------------------===//
+
+#include "swift/Basic/Defer.h"
+#include "swift/Basic/Range.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/DenseSet.h"
+#include "llvm/Support/Debug.h"
+#include "llvm/Support/raw_ostream.h"
+#include <algorithm>
+#include "RewriteSystem.h"
+
+using namespace swift;
+using namespace rewriting;
+
+void HomotopyGenerator::findProtocolConformanceRules(
+    SmallVectorImpl<unsigned> &notInContext,
+    SmallVectorImpl<std::pair<MutableTerm, unsigned>> &inContext,
+    const RewriteSystem &system) const {
+
+  MutableTerm term = Basepoint;
+
+  for (const auto &step : Path) {
+    switch (step.Kind) {
+    case RewriteStep::ApplyRewriteRule: {
+      const auto &rule = system.getRule(step.RuleID);
+      if (!rule.isProtocolConformanceRule())
+        break;
+
+      if (!step.isInContext()) {
+        assert(std::find(notInContext.begin(),
+                         notInContext.end(),
+                         step.RuleID) == notInContext.end() &&
+               "A conformance rule appears more than once without context?");
+        notInContext.push_back(step.RuleID);
+      } else if (step.EndOffset == 0) {
+        assert(step.StartOffset > 0);
+        MutableTerm prefix(term.begin(), term.begin() + step.StartOffset);
+        inContext.emplace_back(prefix, step.RuleID);
+      }
+      break;
+    }
+
+    case RewriteStep::AdjustConcreteType:
+      break;
+    }
+
+    step.apply(term, system);
+  }
+
+  assert(notInContext.empty() || !inContext.empty() &&
+         "A conformance rule not based on another conformance rule?");
+}
+
+/// Write the term as a product of left hand sides of protocol conformance
+/// rules.
+///
+/// The term should already be simplified, except for a protocol symbol
+/// at the end.
+void
+RewriteSystem::decomposeTermIntoConformanceRuleLeftHandSides(
+    MutableTerm term, SmallVectorImpl<unsigned> &result) const {
+  assert(term.back().getKind() == Symbol::Kind::Protocol);
+
+  // If T is canonical and T.[P] => T, then by confluence, T.[P]
+  // reduces to T in a single step, via a rule V.[P] => V, where
+  // T == U.V.
+  RewritePath steps;
+  bool simplified = simplify(term, &steps);
+  if (!simplified) {
+    llvm::errs() << "Term does not conform to protocol: " << term << "\n";
+    abort();
+  }
+
+  assert(steps.size() == 1 &&
+         "Canonical conformance term should simplify in one step");
+
+  const auto &step = *steps.begin();
+  assert(step.Kind == RewriteStep::ApplyRewriteRule);
+  assert(step.EndOffset == 0);
+  assert(!step.Inverse);
+
+  const auto &rule = getRule(step.RuleID);
+  assert(rule.isProtocolConformanceRule());
+
+  // If |U| > 0, recurse with the term U.[domain(V)]. Since T is
+  // canonical, we know that U is canonical as well.
+  if (step.StartOffset > 0) {
+    // Build the term U.
+    MutableTerm prefix(term.begin(), term.begin() + step.StartOffset);
+
+    // Compute domain(V).
+    const auto &lhs = rule.getLHS();
+    auto protocols = lhs[0].getProtocols();
+    assert(protocols.size() == 1);
+
+    // Build the term U.[domain(V)].
+    prefix.add(Symbol::forProtocol(protocols[0], Context));
+
+    decomposeTermIntoConformanceRuleLeftHandSides(prefix, result);
+  }
+
+  result.push_back(step.RuleID);
+}
+
+/// Use homotopy information to discover all ways of writing the left hand side
+/// of each conformance rule as a product of left hand sides of other conformance
+/// rules.
+///
+/// Each conformance rule (Vi.[P] => Vi) can always be written in terms of itself,
+/// so the first term of each disjunction is always (Vi.[P] => Vi).
+///
+/// Conformance rules can also be circular, so not every choice of disjunctions
+/// produces a valid result; for example, if you have these definitions:
+///
+///   protocol P {
+///     associatedtype T : P
+///   }
+///
+///   struct G<X, Y> where X : P, X.T == Y, Y : P, Y.T == X {}
+///
+/// We have three conformance rules:
+///
+///   [P:T].[P] => [P:T]
+///   <X>.[P] => <X>
+///   <Y>.[P] => <Y>
+///
+/// The first rule, <X>.[P] => <X> has an alternate conformance path:
+///
+///   (<Y>.[P]).([P:T].[P])
+///
+/// The second rule similarly has an alternate conformance path:
+///
+///   (<X>.[P]).([P:T].[P])
+///
+/// This gives us the following initial set of candidate conformance paths:
+///
+///   [P:T].[P] := ([P:T].[P])
+///   <X>.[P] := (<X>.[P]) ∨ (<Y>.[P]).([P:T].[P])
+///   <Y>.[P] := (<Y>.[P]) ∨ (<X>.[P]).([P:T].[P])
+///
+/// One valid solution is the following set of assignments:
+///
+///   [P:T].[P] := ([P:T].[P])
+///   <X>.[P] := (<X>.[P])
+///   <Y>.[P] := (<X>.[P]).([P:T].[P])
+///
+/// That is, we can choose to eliminate <X>.[P], but not <Y>.[P], or vice
+/// versa; but it is never valid to eliminate both.
+void RewriteSystem::computeCandidateConformancePaths(
+    llvm::MapVector<unsigned,
+                    std::vector<SmallVector<unsigned, 2>>> &conformancePaths) const {
+  for (const auto &loop : HomotopyGenerators) {
+    if (loop.isDeleted())
+      continue;
+
+    SmallVector<unsigned, 2> notInContext;
+    SmallVector<std::pair<MutableTerm, unsigned>, 2> inContext;
+
+    loop.findProtocolConformanceRules(notInContext, inContext, *this);
+
+    if (notInContext.empty())
+      continue;
+
+    // We must either have multiple conformance rules in empty context, or
+    // at least one conformance rule in non-empty context. Otherwise, we have
+    // a conformance rule which is written as a series of same-type rules,
+    // which doesn't make sense.
+    assert(inContext.size() > 0 || notInContext.size() > 1);
+
+    if (Debug.contains(DebugFlags::GeneratingConformances)) {
+      llvm::dbgs() << "Candidate homotopy generator: ";
+      loop.dump(llvm::dbgs(), *this);
+      llvm::dbgs() << "\n";
+
+      llvm::dbgs() << "* Conformance rules not in context:\n";
+      for (unsigned ruleID : notInContext) {
+        llvm::dbgs() << "- (#" << ruleID << ") " << getRule(ruleID) << "\n";
+      }
+
+      llvm::dbgs() << "* Conformance rules in context:\n";
+      for (auto pair : inContext) {
+        llvm::dbgs() << "- " << pair.first;
+        unsigned ruleID = pair.second;
+        llvm::dbgs() << " (#" << ruleID << ") " << getRule(ruleID) << "\n";
+      }
+    }
+
+    // Suppose a 3-cell contains a conformance rule (T.[P] => T) in an empty
+    // context, and a conformance rule (V.[P] => V) with a possibly non-empty
+    // left context U and empty right context.
+    //
+    // We can decompose U into a product of conformance rules:
+    //
+    //    (V1.[P1] => V1)...(Vn.[Pn] => Vn),
+    //
+    // Now, we can record a candidate decomposition of (T.[P] => T) as a
+    // product of conformance rules:
+    //
+    //    (T.[P] => T) := (V1.[P1] => V1)...(Vn.[Pn] => Vn).(V.[P] => V)
+    //
+    // Now if U is empty, this becomes the trivial candidate:
+    //
+    //    (T.[P] => T) := (V.[P] => V)
+    SmallVector<SmallVector<unsigned, 2>, 2> candidatePaths;
+    for (auto pair : inContext) {
+      // We have a term U, and a rule V.[P] => V.
+      const auto &rule = getRule(pair.second);
+      assert(rule.isProtocolConformanceRule());
+
+      SmallVector<unsigned, 2> conformancePath;
+
+      // Simplify U to get U'.
+      MutableTerm term = pair.first;
+      (void) simplify(term);
+
+      // Compute domain(V).
+      const auto &lhs = rule.getLHS();
+      auto protocols = lhs[0].getProtocols();
+      assert(protocols.size() == 1);
+
+      // Build the term U'.[domain(V)].
+      term.add(Symbol::forProtocol(protocols[0], Context));
+
+      // Write U'.[domain(V)] as a product of left hand sides of protocol
+      // conformance rules.
+      decomposeTermIntoConformanceRuleLeftHandSides(term, conformancePath);
+
+      // Add the rule V => V.[P].
+      conformancePath.push_back(pair.second);
+
+      candidatePaths.push_back(conformancePath);
+    }
+
+    for (unsigned candidateRuleID : notInContext) {
+      // If multiple conformance rules appear in an empty context, each one
+      // can be replaced with any other conformance rule.
+      for (unsigned otherRuleID : notInContext) {
+        if (otherRuleID == candidateRuleID)
+          continue;
+
+        SmallVector<unsigned, 2> path;
+        path.push_back(otherRuleID);
+        conformancePaths[candidateRuleID].push_back(path);
+      }
+
+      // If conformance rules appear in non-empty context, they define a
+      // conformance access path for each conformance rule in empty context.
+      for (const auto &path : candidatePaths) {
+        conformancePaths[candidateRuleID].push_back(path);
+      }
+    }
+  }
+}
+
+bool RewriteSystem::isValidConformancePath(
+    llvm::SmallDenseSet<unsigned, 4> &visited,
+    llvm::DenseSet<unsigned> &redundantConformances,
+    const llvm::SmallVectorImpl<unsigned> &path,
+    const llvm::MapVector<unsigned,
+                          std::vector<SmallVector<unsigned, 2>>>
+        &conformancePaths) const {
+  for (unsigned ruleID : path) {
+    if (visited.count(ruleID) > 0)
+      return false;
+
+    if (!redundantConformances.count(ruleID))
+      continue;
+
+    SWIFT_DEFER {
+      visited.erase(ruleID);
+    };
+    visited.insert(ruleID);
+
+    auto found = conformancePaths.find(ruleID);
+    assert(found != conformancePaths.end());
+
+    bool foundValidConformancePath = false;
+    for (const auto &otherPath : found->second) {
+      if (isValidConformancePath(visited, redundantConformances,
+                                 otherPath, conformancePaths)) {
+        foundValidConformancePath = true;
+        break;
+      }
+    }
+
+    if (!foundValidConformancePath)
+      return false;
+  }
+
+  return true;
+}
+
+void RewriteSystem::computeGeneratingConformances(
+    llvm::DenseSet<unsigned> &redundantConformances) {
+  llvm::MapVector<unsigned, std::vector<SmallVector<unsigned, 2>>> conformancePaths;
+
+  for (unsigned ruleID : indices(Rules)) {
+    const auto &rule = getRule(ruleID);
+    if (rule.isProtocolConformanceRule()) {
+      SmallVector<unsigned, 2> path;
+      path.push_back(ruleID);
+      conformancePaths[ruleID].push_back(path);
+    }
+  }
+
+  computeCandidateConformancePaths(conformancePaths);
+
+  if (Debug.contains(DebugFlags::GeneratingConformances)) {
+    llvm::dbgs() << "Initial set of equations:\n";
+    for (const auto &pair : conformancePaths) {
+      llvm::dbgs() << "- " << getRule(pair.first).getLHS() << " := ";
+
+      bool first = true;
+      for (const auto &path : pair.second) {
+        if (!first)
+          llvm::dbgs() << " ∨ ";
+        else
+          first = false;
+        for (unsigned ruleID : path)
+          llvm::dbgs() << "(" << getRule(ruleID).getLHS() << ")";
+      }
+
+      llvm::dbgs() << "\n";
+    }
+  }
+
+  for (const auto &pair : conformancePaths) {
+    for (const auto &path : pair.second) {
+      llvm::SmallDenseSet<unsigned, 4> visited;
+      visited.insert(pair.first);
+
+      if (isValidConformancePath(visited, redundantConformances,
+                                 path, conformancePaths)) {
+        redundantConformances.insert(pair.first);
+        break;
+      }
+    }
+  }
+
+  if (Debug.contains(DebugFlags::GeneratingConformances)) {
+    llvm::dbgs() << "Generating conformances:\n";
+
+    for (const auto &pair : conformancePaths) {
+      if (redundantConformances.count(pair.first) > 0)
+        continue;
+
+      llvm::dbgs() << "- " << getRule(pair.first) << "\n";
+    }
+  }
+}