File: EscapeInfoDumper.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (161 lines) | stat: -rw-r--r-- 5,059 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
//===--- EscapeInfoDumper.swift - Dumps escape information ----------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2022 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
//
//===----------------------------------------------------------------------===//

import SIL

/// Dumps the results of escape analysis.
///
/// Dumps the EscapeInfo query results for all `alloc_stack` instructions in a function.
///
/// This pass is used for testing EscapeInfo.
let escapeInfoDumper = FunctionPass(name: "dump-escape-info") {
  (function: Function, context: FunctionPassContext) in

  print("Escape information for \(function.name):")
  
  struct Visitor : EscapeVisitorWithResult {
    var result: Set<String> =  Set()
    
    mutating func visitUse(operand: Operand, path: EscapePath) -> UseResult {
      if operand.instruction is ReturnInst {
        result.insert("return[\(path.projectionPath)]")
        return .ignore
      }
      return .continueWalk
    }
    
    mutating func visitDef(def: Value, path: EscapePath) -> DefResult {
      guard let arg = def as? FunctionArgument else {
        return .continueWalkUp
      }
      result.insert("arg\(arg.index)[\(path.projectionPath)]")
      return .walkDown
    }
  }
  
  
  for inst in function.instructions {
    if let allocRef = inst as? AllocRefInst {
      
      let resultStr: String
      if let result = allocRef.visit(using: Visitor(), context) {
        if result.isEmpty {
          resultStr = " -    "
        } else {
          resultStr = Array(result).sorted().joined(separator: ",")
        }
      } else {
        resultStr = "global"
      }
      print("\(resultStr): \(allocRef)")
    }
  }
  print("End function \(function.name)\n")
}

/// Dumps the results of address-related escape analysis.
///
/// Dumps the EscapeInfo query results for addresses escaping to function calls.
/// The `fix_lifetime` instruction is used as marker for addresses and values to query.
///
/// This pass is used for testing EscapeInfo.
let addressEscapeInfoDumper = FunctionPass(name: "dump-addr-escape-info") {
  (function: Function, context: FunctionPassContext) in

  print("Address escape information for \(function.name):")

  var valuesToCheck = [Value]()
  var applies = [Instruction]()
  
  for inst in function.instructions {
    switch inst {
      case let fli as FixLifetimeInst:
        valuesToCheck.append(fli.operand.value)
      case is FullApplySite:
        applies.append(inst)
      default:
        break
    }
  }
  
  struct Visitor : EscapeVisitor {
    let apply: Instruction
    mutating func visitUse(operand: Operand, path: EscapePath) -> UseResult {
      let user = operand.instruction
      if user == apply {
        return .abort
      }
      if user is ReturnInst {
        // Anything which is returned cannot escape to an instruction inside the function.
        return .ignore
      }
      return .continueWalk
    }

    var followTrivialTypes: Bool { true }
    var followLoads: Bool { false }
  }

  // test `isEscaping(addressesOf:)`
  for value in valuesToCheck {
    print("value:\(value)")
    for apply in applies {
      let path = AliasAnalysis.getPtrOrAddressPath(for: value)
      
      if value.at(path).isEscaping(using: Visitor(apply: apply), context) {
        print("  ==> \(apply)")
      } else {
        print("  -   \(apply)")
      }
    }
  }
  
  // test `canReferenceSameField` for each pair of `fix_lifetime`.
  if !valuesToCheck.isEmpty {
    for lhsIdx in 0..<(valuesToCheck.count - 1) {
      for rhsIdx in (lhsIdx + 1) ..< valuesToCheck.count {
        print("pair \(lhsIdx) - \(rhsIdx)")
        let lhs = valuesToCheck[lhsIdx]
        let rhs = valuesToCheck[rhsIdx]
        print(lhs)
        print(rhs)

        let projLhs = lhs.at(AliasAnalysis.getPtrOrAddressPath(for: lhs))
        let projRhs = rhs.at(AliasAnalysis.getPtrOrAddressPath(for: rhs))
        let mayAlias = projLhs.canAddressAlias(with: projRhs, context)
        if mayAlias != projRhs.canAddressAlias(with: projLhs, context) {
          fatalError("canAddressAlias(with:) must be symmetric")
        }

        let addrReachable: Bool
        if lhs.type.isAddress && !rhs.type.isAddress {
          let anythingReachableFromRhs = rhs.at(SmallProjectionPath(.anything))
          addrReachable = projLhs.canAddressAlias(with: anythingReachableFromRhs, context)
          if mayAlias && !addrReachable {
            fatalError("mayAlias implies addrReachable")
          }
        } else {
          addrReachable = false
        }
        if mayAlias {
          print("may alias")
        } else if addrReachable {
          print("address reachable but no alias")
        } else {
          print("no alias")
        }
      }
    }
  }
  
  print("End function \(function.name)\n")
}