File: ReadOnlyGlobalVariables.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 (73 lines) | stat: -rw-r--r-- 2,362 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
//===--- ReadOnlyGlobalVariables.swift ------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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

/// Marks global `var` variables as `let` if they are never written.
///
/// Note that this pass relies on the initialize-static-globals pass which converts lazily
/// initialized globals to statically initialized globals.
/// This pass does not mark lazily initialized globals as `let`, because such globals _are_
/// written: in their initializers.
///
let readOnlyGlobalVariablesPass = ModulePass(name: "read-only-global-variables") {
  (moduleContext: ModulePassContext) in

  var writtenGlobals = Set<GlobalVariable>()

  for f in moduleContext.functions {
    for inst in f.instructions {
      if let gAddr = inst as? GlobalAddrInst {
        if findWrites(toAddress: gAddr) {
          writtenGlobals.insert(gAddr.global)
        }
      }
    }
  }

  for g in moduleContext.globalVariables {
    if !g.isAvailableExternally,
       !g.isPossiblyUsedExternally,
       !g.isLet,
       !writtenGlobals.contains(g) {
      g.setIsLet(to: true, moduleContext)
    }
  }
}

private func findWrites(toAddress: Value) -> Bool {
  var walker = FindWrites()
  return walker.walkDownUses(ofAddress: toAddress, path: UnusedWalkingPath()) == .abortWalk
}

private struct FindWrites : AddressDefUseWalker {
  mutating func leafUse(address: Operand, path: UnusedWalkingPath) -> WalkResult {
    switch address.instruction {
    case is LoadInst, is LoadBorrowInst:
      return .continueWalk

    case let ca as CopyAddrInst:
      return address == ca.sourceOperand ? .continueWalk : .abortWalk

    case let apply as FullApplySite:
      if let calleeArgIdx = apply.calleeArgumentIndex(of: address) {
        let convention = apply.calleeArgumentConventions[calleeArgIdx]
        if convention.isIndirectIn {
          return .continueWalk
        }
      }
      return .abortWalk
    default:
      return .abortWalk
    }
  }
}