Merge pull request #72584 from gottesmm/release/6.0-region-iso

[region-isolation] Cherry-pick to swift 6

Author: gottesmm

include/swift/AST/ActorIsolation.h

@@ -192,6 +192,7 @@ class ActorIsolation {
   }
 
   NominalTypeDecl *getActor() const;
+  NominalTypeDecl *getActorOrNullPtr() const;
 
   VarDecl *getActorInstance() const;
 
@@ -244,10 +245,18 @@ class ActorIsolation {
     return !(lhs == rhs);
   }
 
+  void Profile(llvm::FoldingSetNodeID &id) {
+    id.AddInteger(getKind());
+    id.AddPointer(pointer);
+    id.AddBoolean(isolatedByPreconcurrency);
+    id.AddBoolean(silParsed);
+    id.AddInteger(parameterIndex);
+  }
+
   friend llvm::hash_code hash_value(const ActorIsolation &state) {
-    return llvm::hash_combine(
-        state.kind, state.pointer, state.isolatedByPreconcurrency,
-        state.parameterIndex);
+    return llvm::hash_combine(state.kind, state.pointer,
+                              state.isolatedByPreconcurrency, state.silParsed,
+                              state.parameterIndex);
   }
 
   void print(llvm::raw_ostream &os) const {
@@ -277,7 +286,15 @@ class ActorIsolation {
   void printForDiagnostics(llvm::raw_ostream &os,
                            StringRef openingQuotationMark = "'") const;
 
-  SWIFT_DEBUG_DUMP { print(llvm::dbgs()); }
+  SWIFT_DEBUG_DUMP {
+    print(llvm::dbgs());
+    llvm::dbgs() << '\n';
+  }
+
+  // Defined out of line to prevent linker errors since libswiftBasic would
+  // include this header exascerbating a layering violation where libswiftBasic
+  // depends on libswiftAST.
+  SWIFT_DEBUG_DUMPER(dumpForDiagnostics());
 };
 
 /// Determine how the given value declaration is isolated.

include/swift/AST/DiagnosticsSIL.def

@@ -932,7 +932,7 @@ NOTE(sil_referencebinding_inout_binding_here, none,
 //===----------------------------------------------------------------------===//
 
 NOTE(regionbasedisolation_maybe_race, none,
-     "access here could race", ())
+     "use here could race", ())
 ERROR(regionbasedisolation_unknown_pattern, none,
       "pattern that the region based isolation checker does not understand how to check. Please file a bug",
       ())
@@ -951,7 +951,7 @@ ERROR(regionbasedisolation_isolated_capture_yields_race, none,
       "%1 closure captures value of non-Sendable type %0 from %2 context; later accesses to value could race",
       (Type, ActorIsolation, ActorIsolation))
 ERROR(regionbasedisolation_transfer_yields_race_stronglytransferred_binding, none,
-      "binding of non-Sendable type %0 accessed after being transferred; later accesses could race",
+      "value of non-Sendable type %0 accessed after being transferred; later accesses could race",
       (Type))
 ERROR(regionbasedisolation_arg_transferred, none,
       "%0 value of type %1 transferred to %2 context; later accesses to value could race",
@@ -972,17 +972,23 @@ ERROR(regionbasedisolation_named_transfer_yields_race, none,
       (Identifier))
 
 NOTE(regionbasedisolation_named_info_transfer_yields_race, none,
-     "%0 is transferred from %1 caller to %2 callee. Later uses in caller could race with potential uses in callee",
-     (Identifier, ActorIsolation, ActorIsolation))
+     "transferring %1 %0 to %2 callee could cause races in between callee %2 and local %3 uses",
+     (Identifier, StringRef, ActorIsolation, ActorIsolation))
 NOTE(regionbasedisolation_named_transfer_non_transferrable, none,
       "transferring %1 %0 to %2 callee could cause races between %2 and %1 uses",
-      (Identifier, ActorIsolation, ActorIsolation))
+      (Identifier, StringRef, ActorIsolation))
 NOTE(regionbasedisolation_named_transfer_into_transferring_param, none,
      "%0 %1 is passed as a transferring parameter; Uses in callee may race with later %0 uses",
      (StringRef, Identifier))
 NOTE(regionbasedisolation_named_notransfer_transfer_into_result, none,
      "%0 %1 cannot be a transferring result. %0 uses may race with caller uses",
      (StringRef, Identifier))
+NOTE(regionbasedisolation_named_stronglytransferred_binding, none,
+      "%0 used after being passed as a transferring parameter; Later uses could race",
+      (Identifier))
+NOTE(regionbasedisolation_named_isolated_closure_yields_race, none,
+      "%0 %1 is captured by a %2 closure. %2 uses in closure may race against later %3 uses",
+      (StringRef, Identifier, ActorIsolation, ActorIsolation))
 
 // Misc Error.
 ERROR(regionbasedisolation_task_or_actor_isolated_transferred, none,

include/swift/Basic/ImmutablePointerSet.h

@@ -250,6 +250,55 @@ class ImmutablePointerSetFactory {
     return NewNode;
   }
 
+  template <typename U, typename... Args>
+  struct IsTrivialTypedPointerAndHasProfile {
+    constexpr static bool hasProfile =
+        std::is_same_v<decltype(std::remove_pointer<U>::type::Profile(
+                           std::declval<Args>()...)),
+                       void>;
+    constexpr static bool value =
+        hasProfile && std::is_trivial_v<U> && std::is_pointer_v<U>;
+  };
+
+  /// Emplace a new value with \p args if we do not yet have one. We allocate
+  /// the object with our bump ptr allocator, so we require that the type be
+  /// trivial.
+  template <typename... Args>
+  typename std::enable_if_t<IsTrivialTypedPointerAndHasProfile<
+                                T, llvm::FoldingSetNodeID &, Args...>::value,
+                            PtrSet> *
+  emplace(Args... args) {
+    llvm::FoldingSetNodeID ID;
+    using NoPointerTy = typename std::remove_pointer<T>::type;
+    NoPointerTy::Profile(ID, std::forward<Args>(args)...);
+
+    void *InsertPt;
+    if (auto *PSet = Set.FindNodeOrInsertPos(ID, InsertPt)) {
+      return PSet;
+    }
+
+    size_t NumElts = 1;
+    size_t MemSize = sizeof(PtrSet) + sizeof(NoPointerTy);
+
+    // Allocate the memory.
+    auto *Mem =
+        reinterpret_cast<PtrSet *>(Allocator.Allocate(MemSize, AllocAlignment));
+
+    // Copy in the pointers into the tail allocated memory. We do not need to do
+    // any sorting/uniquing ourselves since we assume that our users perform
+    // this task for us.
+    llvm::MutableArrayRef<NoPointerTy *> DataMem(
+        reinterpret_cast<NoPointerTy **>(&Mem[1]), NumElts);
+    NoPointerTy *type =
+        new (Allocator) NoPointerTy(std::forward<Args>(args)...);
+    DataMem[0] = type;
+
+    // Allocate the new node and insert it into the Set.
+    auto *NewNode = new (Mem) PtrSet(this, DataMem);
+    Set.InsertNode(NewNode, InsertPt);
+    return NewNode;
+  }
+
   PtrSet *get(T value) {
     llvm::FoldingSetNodeID ID;
     ID.AddPointer(PtrTraits::getAsVoidPointer(value));

include/swift/SIL/SILFunction.h

@@ -347,6 +347,9 @@ class SILFunction
   /// block indices.
   unsigned BlockListChangeIdx = 0;
 
+  /// The isolation of this function.
+  std::optional<ActorIsolation> actorIsolation;
+
   /// The function's bare attribute. Bare means that the function is SIL-only
   /// and does not require debug info.
   unsigned Bare : 1;
@@ -1367,6 +1370,14 @@ class SILFunction
     return false;
   }
 
+  void setActorIsolation(ActorIsolation newActorIsolation) {
+    actorIsolation = newActorIsolation;
+  }
+
+  std::optional<ActorIsolation> getActorIsolation() const {
+    return actorIsolation;
+  }
+
   //===--------------------------------------------------------------------===//
   // Block List Access
   //===--------------------------------------------------------------------===//