Merge pull request #84924 from meg-gupta/borrowandmutateupdate

Minor update to borrow and mutate accessors

Author: meg-gupta

SwiftCompilerSources/Sources/Optimizer/FunctionPasses/ComputeSideEffects.swift

@@ -255,7 +255,7 @@ private struct CollectedEffects {
       addEffects(.destroy, to: inst.operands[0].value, fromInitialPath: SmallProjectionPath(.anyValueFields))
 
     case is ReturnInst:
-      if inst.parentFunction.convention.hasGuaranteedAddressResult {
+      if inst.parentFunction.convention.hasAddressResult {
         addEffects(.read, to: inst.operands[0].value)
       }
 

SwiftCompilerSources/Sources/SIL/ApplySite.swift

@@ -303,10 +303,6 @@ extension ApplySite {
   public var hasGuaranteedResult: Bool {
     functionConvention.hasGuaranteedResult
   }
-
-  public var hasGuaranteedAddressResult: Bool {
-    functionConvention.hasGuaranteedAddressResult
-  }
 }
 
 extension ApplySite {

SwiftCompilerSources/Sources/SIL/Argument.swift

@@ -488,8 +488,8 @@ public enum ArgumentConvention : CustomStringConvertible {
       self = .directUnowned
     case .pack:
       self = .packOut
-    case .guaranteed, .guaranteedAddress:
-      fatalError("Result conventions @guaranteed and @guaranteed_addr are always returned directly")
+    case .guaranteed, .guaranteedAddress, .inout:
+      fatalError("Result conventions @guaranteed, @guaranteed_address and @inout are always returned directly")
     }
   }
 

SwiftCompilerSources/Sources/SIL/FunctionConvention.swift

@@ -102,14 +102,20 @@ public struct FunctionConvention : CustomStringConvertible {
     if results.count != 1 {
       return false
     }
-    return results[0].convention == .guaranteed
+    if hasLoweredAddresses {
+      return results[0].convention == .guaranteed
+    }
+    return results[0].convention == .guaranteed || results[0].convention == .guaranteedAddress
   }
 
-  public var hasGuaranteedAddressResult: Bool {
+  public var hasAddressResult: Bool {
     if results.count != 1 {
       return false
     }
-    return results[0].convention == .guaranteedAddress
+    if hasLoweredAddresses {
+      return results[0].convention == .guaranteedAddress || results[0].convention == .inout
+    }
+    return results[0].convention == .inout
   }
 
   public var description: String {
@@ -147,7 +153,7 @@ public struct ResultInfo : CustomStringConvertible {
       return hasLoweredAddresses || type.isExistentialArchetypeWithError()
     case .pack:
       return true
-    case .owned, .unowned, .unownedInnerPointer, .autoreleased, .guaranteed, .guaranteedAddress:
+    case .owned, .unowned, .unownedInnerPointer, .autoreleased, .guaranteed, .guaranteedAddress, .inout:
       return false
     }
   }
@@ -373,13 +379,17 @@ public enum ResultConvention : CustomStringConvertible {
   case owned
 
   /// The caller is responsible for using the returned address within a valid
-  /// scope. This is valid only for borrow and mutate accessors.
+  /// scope. This is valid only for borrow accessors.
   case guaranteedAddress
 
   /// The caller is responsible for using the returned value within a valid
   /// scope. This is valid only for borrow accessors.
   case guaranteed
 
+  /// The caller is responsible for mutating the returned address within a valid
+  /// scope. This is valid only for mutate accessors.
+  case `inout`
+
   /// The caller is not responsible for destroying this return value.  Its type may be trivial, or it may simply be offered unsafely.  It is valid at the instant of the return, but further operations may invalidate it.
   case unowned
 
@@ -423,6 +433,8 @@ public enum ResultConvention : CustomStringConvertible {
       return "guaranteed"
     case .guaranteedAddress:
       return "guaranteedAddress"
+    case .inout:
+      return "inout"      
     }
   }
 }
@@ -456,6 +468,7 @@ extension ResultConvention {
       case .Pack:                self = .pack
       case .Guaranteed:          self = .guaranteed
       case .GuaranteedAddress:   self = .guaranteedAddress
+      case .Inout:               self = .inout
       default:
         fatalError("unsupported result convention")
     }

docs/ABI/Mangling.rst

@@ -925,6 +925,9 @@ mangled in to disambiguate.
   RESULT-CONVENTION ::= 'u'                  // unowned inner pointer
   RESULT-CONVENTION ::= 'a'                  // auto-released
   RESULT-CONVENTION ::= 'k'                  // pack
+  RESULT-CONVENTION ::= 'l'                  // guaranteed address
+  RESULT-CONVENTION ::= 'g'                  // guaranteed
+  RESULT-CONVENTION ::= 'm'                  // inout
 
   RESULT-DIFFERENTIABILITY ::= 'w'            // @noDerivative
 

include/swift/AST/TypeAttr.def

@@ -95,7 +95,7 @@ SIMPLE_SIL_TYPE_ATTR(pack_out, PackOut)
 SIMPLE_SIL_TYPE_ATTR(owned, Owned)
 SIMPLE_SIL_TYPE_ATTR(unowned_inner_pointer, UnownedInnerPointer)
 SIMPLE_SIL_TYPE_ATTR(guaranteed, Guaranteed)
-SIMPLE_SIL_TYPE_ATTR(guaranteed_addr, GuaranteedAddress)
+SIMPLE_SIL_TYPE_ATTR(guaranteed_address, GuaranteedAddress)
 SIMPLE_SIL_TYPE_ATTR(autoreleased, Autoreleased)
 SIMPLE_SIL_TYPE_ATTR(callee_owned, CalleeOwned)
 SIMPLE_SIL_TYPE_ATTR(callee_guaranteed, CalleeGuaranteed)

include/swift/AST/Types.h

@@ -4814,12 +4814,16 @@ enum class ResultConvention : uint8_t {
   Pack,
 
   /// The caller is responsible for using the returned address within a valid
-  /// scope. This is valid only for borrow and mutate accessors.
+  /// scope. This is valid only for borrow accessors.
   GuaranteedAddress,
 
   /// The caller is responsible for using the returned value within a valid
   /// scope. This is valid only for borrow accessors.
   Guaranteed,
+
+  /// The caller is responsible for mutating the returned address within a valid
+  /// scope. This is valid only for mutate accessors.
+  Inout,
 };
 
 // Does this result require indirect storage for the purpose of reabstraction?
@@ -4976,12 +4980,20 @@ class SILResultInfo {
     return getConvention() == ResultConvention::Pack;
   }
 
-  bool isGuaranteedAddressResult() const {
-    return getConvention() == ResultConvention::GuaranteedAddress;
+  bool isAddressResult(bool loweredAddresses) const {
+    if (loweredAddresses) {
+      return getConvention() == ResultConvention::GuaranteedAddress ||
+             getConvention() == ResultConvention::Inout;
+    }
+    return getConvention() == ResultConvention::Inout;
   }
 
-  bool isGuaranteedResult() const {
-    return getConvention() == ResultConvention::Guaranteed;
+  bool isGuaranteedResult(bool loweredAddresses) const {
+    if (loweredAddresses) {
+      return getConvention() == ResultConvention::Guaranteed;
+    }
+    return getConvention() == ResultConvention::Guaranteed ||
+           getConvention() == ResultConvention::GuaranteedAddress;
   }
 
   /// Transform this SILResultInfo by applying the user-provided
@@ -5424,18 +5436,18 @@ class SILFunctionType final
     return hasErrorResult() && getErrorResult().isFormalIndirect();
   }
 
-  bool hasGuaranteedResult() const {
+  bool hasGuaranteedResult(bool loweredAddresses) const {
     if (getNumResults() != 1) {
       return false;
     }
-    return getResults()[0].isGuaranteedResult();
+    return getResults()[0].isGuaranteedResult(loweredAddresses);
   }
 
-  bool hasGuaranteedAddressResult() const {
+  bool hasAddressResult(bool loweredAddresses) const {
     if (getNumResults() != 1) {
       return false;
     }
-    return getResults()[0].isGuaranteedAddressResult();
+    return getResults()[0].isAddressResult(loweredAddresses);
   }
 
   struct IndirectFormalResultFilter {

include/swift/SIL/MemAccessUtils.h

@@ -169,7 +169,7 @@ inline bool isGuaranteedAddressReturn(SILValue value) {
   if (!defInst) {
     return false;
   }
-  return defInst->hasGuaranteedAddressResult();
+  return defInst->hasAddressResult();
 }
 
 /// Return the source address after stripping as many access projections as

include/swift/SIL/SILBridging.h

@@ -110,6 +110,7 @@ enum class BridgedResultConvention {
   Pack,
   GuaranteedAddress,
   Guaranteed,
+  Inout
 };
 
 struct BridgedResultInfo {

include/swift/SIL/SILFunctionConventions.h

@@ -212,6 +212,13 @@ class SILFunctionConventions {
     if (silConv.loweredAddresses)
       return funcTy->getDirectFormalResultsType(silConv.getModule(), context);
 
+    if (funcTy->hasAddressResult(silConv.loweredAddresses)) {
+      assert(funcTy->getNumDirectFormalResults() == 1);
+      return SILType::getPrimitiveAddressType(
+          funcTy->getSingleDirectFormalResult().getReturnValueType(
+              silConv.getModule(), funcTy, context));
+    }
+
     return funcTy->getAllResultsSubstType(silConv.getModule(), context);
   }
 
@@ -322,16 +329,24 @@ class SILFunctionConventions {
     if (funcTy->getNumResults() != 1) {
       return false;
     }
-    return funcTy->getResults()[0].getConvention() ==
-           ResultConvention::Guaranteed;
+    auto resultConvention = funcTy->getResults()[0].getConvention();
+    if (silConv.loweredAddresses) {
+      return resultConvention == ResultConvention::Guaranteed;
+    }
+    return resultConvention == ResultConvention::Guaranteed ||
+           resultConvention == ResultConvention::GuaranteedAddress;
   }
 
-  bool hasGuaranteedAddressResult() const {
+  bool hasAddressResult() const {
     if (funcTy->getNumResults() != 1) {
       return false;
     }
-    return funcTy->getResults()[0].getConvention() ==
-           ResultConvention::GuaranteedAddress;
+    auto resultConvention = funcTy->getResults()[0].getConvention();
+    if (silConv.loweredAddresses) {
+      return resultConvention == ResultConvention::GuaranteedAddress ||
+             resultConvention == ResultConvention::Inout;
+    }
+    return resultConvention == ResultConvention::Inout;
   }
 
   struct SILResultTypeFunc;
@@ -675,6 +690,7 @@ inline bool SILModuleConventions::isIndirectSILResult(SILResultInfo result,
   case ResultConvention::Autoreleased:
   case ResultConvention::GuaranteedAddress:
   case ResultConvention::Guaranteed:
+  case ResultConvention::Inout:
     return false;
   }
 
@@ -699,7 +715,7 @@ inline SILType
 SILModuleConventions::getSILResultInterfaceType(SILResultInfo result,
                                                 bool loweredAddresses) {
   return SILModuleConventions::isIndirectSILResult(result, loweredAddresses) ||
-                 result.isGuaranteedAddressResult()
+                 result.isAddressResult(loweredAddresses)
              ? SILType::getPrimitiveAddressType(result.getInterfaceType())
              : SILType::getPrimitiveObjectType(result.getInterfaceType());
 }