Merge pull request swiftlang#61395 from atrick/rename-bitcast

Rename SILBuilder::createUncheckedBitCast

Author: swift-ci

include/swift/SIL/SILBuilder.h

@@ -2118,13 +2118,20 @@ class SILBuilder {
   SingleValueInstruction *
   createUncheckedReinterpretCast(SILLocation Loc, SILValue Op, SILType Ty);
 
-  /// Create an appropriate cast instruction based on result type.
+  /// Create an appropriate cast instruction based on result type. This cast
+  /// forwards ownership from the operand to the result.
   ///
-  /// NOTE: This assumes that the input and the result cast are layout
-  /// compatible. Reduces to createUncheckedReinterpretCast when ownership is
-  /// disabled.
-  SingleValueInstruction *createUncheckedBitCast(SILLocation Loc, SILValue Op,
-                                                 SILType Ty);
+  /// WARNING: Because it forwards ownership, this cast is only valid with the
+  /// source and destination types are layout equivalent. The destination type
+  /// must include all the same references in the same positions.
+  ///
+  /// Note: Forwarding casts do not exist outside of OSSA. When ownership is
+  /// disabled, this reduces to createUncheckedReinterpretCast, which may
+  /// fall-back to unchecked_bitwise_cast. It is the caller's responsibility to
+  /// emit the correct retains and releases.
+  SingleValueInstruction *createUncheckedForwardingCast(SILLocation Loc,
+                                                        SILValue Op,
+                                                        SILType Ty);
 
   //===--------------------------------------------------------------------===//
   // Runtime failure

lib/SIL/IR/SILBuilder.cpp

@@ -174,7 +174,8 @@ SILBuilder::createUncheckedReinterpretCast(SILLocation Loc, SILValue Op,
 
 // Create the appropriate cast instruction based on result type.
 SingleValueInstruction *
-SILBuilder::createUncheckedBitCast(SILLocation Loc, SILValue Op, SILType Ty) {
+SILBuilder::createUncheckedForwardingCast(SILLocation Loc, SILValue Op,
+                                          SILType Ty) {
   // Without ownership, delegate to unchecked reinterpret cast.
   if (!hasOwnership())
     return createUncheckedReinterpretCast(Loc, Op, Ty);

lib/SILOptimizer/SILCombiner/SILCombinerApplyVisitors.cpp

@@ -169,7 +169,7 @@ SILCombiner::optimizeApplyOfConvertFunctionInst(FullApplySite AI,
       Args.push_back(UAC);
     } else if (OldOpType.getASTType() != NewOpType.getASTType()) {
       auto URC =
-          Builder.createUncheckedBitCast(AI.getLoc(), Op, NewOpType);
+          Builder.createUncheckedForwardingCast(AI.getLoc(), Op, NewOpType);
       Args.push_back(URC);
     } else {
       Args.push_back(Op);
@@ -221,8 +221,8 @@ SILCombiner::optimizeApplyOfConvertFunctionInst(FullApplySite AI,
       for (auto e = newOpResultTypes.end(); newRetI != e;
            ++oldRetI, ++newRetI, ++origArgI) {
         auto arg = normalBB->createPhiArgument(*newRetI, (*origArgI)->getOwnershipKind());
-        auto converted = Builder.createUncheckedBitCast(AI.getLoc(),
-                                                                arg, *oldRetI);
+        auto converted =
+          Builder.createUncheckedForwardingCast(AI.getLoc(), arg, *oldRetI);
         branchArgs.push_back(converted);
       }
 
@@ -246,7 +246,8 @@ SILCombiner::optimizeApplyOfConvertFunctionInst(FullApplySite AI,
   SILInstruction *result = NAI;
 
   if (oldResultTy != newResultTy) {
-    result = Builder.createUncheckedBitCast(AI.getLoc(), NAI, oldResultTy);
+    result =
+      Builder.createUncheckedForwardingCast(AI.getLoc(), NAI, oldResultTy);
   }
 
   return result;

lib/SILOptimizer/Transforms/EagerSpecializer.cpp

@@ -438,7 +438,7 @@ void EagerDispatch::emitDispatchTo(SILFunction *NewFunc) {
     auto GenResultTy = GenericFunc->mapTypeIntoContext(resultTy);
 
     SILValue CastResult =
-        Builder.createUncheckedBitCast(Loc, Result, GenResultTy);
+        Builder.createUncheckedForwardingCast(Loc, Result, GenResultTy);
 
     addReturnValue(Builder.getInsertionBB(), OldReturnBB, CastResult);
   }
@@ -640,7 +640,7 @@ SILValue EagerDispatch::emitArgumentCast(CanSILFunctionType CalleeSubstFnTy,
   if (CastTy.isAddress())
     return Builder.createUncheckedAddrCast(Loc, OrigArg, CastTy);
 
-  return Builder.createUncheckedBitCast(Loc, OrigArg, CastTy);
+  return Builder.createUncheckedForwardingCast(Loc, OrigArg, CastTy);
 }
 
 /// Converts each generic function argument into a SILValue that can be passed