SIL: improve some Location APIs

* rename `var autoGenerated` -> `var asAutoGenerated`
* add `var asCleanup`
* add `func withScope`

Author: eeckstein

SwiftCompilerSources/Sources/Optimizer/FunctionPasses/LifetimeDependenceScopeFixup.swift

@@ -842,7 +842,7 @@ extension ExtendableScope {
     }
     defer { unusedEnds.deinitialize() }
     for end in range.ends {
-      let location = end.location.autoGenerated
+      let location = end.location.asAutoGenerated
       switch end {
       case is BranchInst:
         assert(end.parentBlock.singleSuccessor!.terminator is ReturnInst,
@@ -868,7 +868,7 @@ extension ExtendableScope {
       }
     }
     for exitInst in range.exits {
-      let location = exitInst.location.autoGenerated
+      let location = exitInst.location.asAutoGenerated
       let builder = Builder(before: exitInst, location: location, context)
       range.insert(createEndInstruction(builder, context))
     }

SwiftCompilerSources/Sources/Optimizer/ModulePasses/StackProtection.swift

@@ -332,7 +332,7 @@ private struct StackProtectionOptimization {
 
     let function = argument.parentFunction
     let entryBlock = function.entryBlock
-    let loc = entryBlock.instructions.first!.location.autoGenerated
+    let loc = entryBlock.instructions.first!.location.asAutoGenerated
     let builder = Builder(atBeginOf: entryBlock, location: loc, context)
     let temporary = builder.createAllocStack(argument.type)
     argument.uses.replaceAll(with: temporary, context)
@@ -342,7 +342,7 @@ private struct StackProtectionOptimization {
     for block in function.blocks {
       let terminator = block.terminator
       if terminator.isFunctionExiting {
-        let exitBuilder = Builder(before: terminator, location: terminator.location.autoGenerated, context)
+        let exitBuilder = Builder(before: terminator, location: terminator.location.asAutoGenerated, context)
         exitBuilder.createCopyAddr(from: temporary, to: argument, takeSource: true, initializeDest: true)
         exitBuilder.createDeallocStack(temporary)
       }
@@ -362,13 +362,13 @@ private struct StackProtectionOptimization {
       return
     }
 
-    let builder = Builder(after: beginAccess, location: beginAccess.location.autoGenerated, context)
+    let builder = Builder(after: beginAccess, location: beginAccess.location.asAutoGenerated, context)
     let temporary = builder.createAllocStack(beginAccess.type)
 
     beginAccess.uses.ignoreUsers(ofType: EndAccessInst.self).replaceAll(with: temporary, context)
 
     for endAccess in beginAccess.endInstructions {
-      let endBuilder = Builder(before: endAccess, location: endAccess.location.autoGenerated, context)
+      let endBuilder = Builder(before: endAccess, location: endAccess.location.asAutoGenerated, context)
       endBuilder.createCopyAddr(from: temporary, to: beginAccess, takeSource: true, initializeDest: true)
       endBuilder.createDeallocStack(temporary)
     }

SwiftCompilerSources/Sources/Optimizer/Utilities/FunctionSignatureTransforms.swift

@@ -88,7 +88,7 @@ private func createSpecializedFunction(
     hasSelfParameter: hasSelfParameter,
     fromOriginal: originalFunction)
 
-  let thunkLoc = originalFunction.entryBlock.instructions.first!.location.autoGenerated
+  let thunkLoc = originalFunction.entryBlock.instructions.first!.location.asAutoGenerated
 
   context.moveFunctionBody(from: originalFunction, to: specializedFunction)
   // originalFunction is now empty and used as the thunk.

SwiftCompilerSources/Sources/SIL/Location.swift

@@ -58,10 +58,18 @@ public struct Location: ProvidingSourceLocation, Equatable, CustomStringConverti
   }
 
   /// Keeps the debug scope but marks it as auto-generated.
-  public var autoGenerated: Location {
+  public var asAutoGenerated: Location {
     Location(bridged: bridged.getAutogeneratedLocation())
   }
 
+  public var asCleanup: Location {
+    Location(bridged: bridged.getCleanupLocation())
+  }
+
+  public func withScope(of other: Location) -> Location {
+    Location(bridged: bridged.withScopeOf(other.bridged))
+  }
+
   public var hasValidLineNumber: Bool { bridged.hasValidLineNumber() }
   public var isAutoGenerated: Bool { bridged.isAutoGenerated() }
   public var isInlined: Bool { bridged.isInlined() }

include/swift/SIL/SILBridging.h

@@ -404,6 +404,8 @@ struct BridgedLocation {
 
   BridgedOwnedString getDebugDescription() const;
   SWIFT_IMPORT_UNSAFE BRIDGED_INLINE BridgedLocation getAutogeneratedLocation() const;
+  SWIFT_IMPORT_UNSAFE BRIDGED_INLINE BridgedLocation getCleanupLocation() const;
+  SWIFT_IMPORT_UNSAFE BRIDGED_INLINE BridgedLocation withScopeOf(BridgedLocation other) const;
   BRIDGED_INLINE bool hasValidLineNumber() const;
   BRIDGED_INLINE bool isAutoGenerated() const;
   BRIDGED_INLINE bool isInlined() const;

include/swift/SIL/SILBridgingImpl.h

@@ -621,6 +621,12 @@ const swift::SILDebugLocation &BridgedLocation::getLoc() const {
 BridgedLocation BridgedLocation::getAutogeneratedLocation() const {
   return getLoc().getAutogeneratedLocation();
 }
+BridgedLocation BridgedLocation::getCleanupLocation() const {
+  return getLoc().getCleanupLocation();
+}
+BridgedLocation BridgedLocation::withScopeOf(BridgedLocation other) const {
+  return swift::SILDebugLocation(getLoc().getLocation(), other.getLoc().getScope());
+}
 bool BridgedLocation::hasValidLineNumber() const {
   return getLoc().hasValidLineNumber();
 }

include/swift/SIL/SILLocation.h

@@ -776,6 +776,11 @@ class SILDebugLocation {
     return autoGenLoc;
   }
 
+  SILDebugLocation getCleanupLocation() const {
+    SILDebugLocation cleanupLoc(CleanupLocation(location), getScope());
+    return cleanupLoc;
+  }
+
   bool isEqualTo(SILDebugLocation rhs) const {
     return getLocation() == rhs.getLocation() && getScope() == rhs.getScope();
   }