Function Structure Reference


                    
                    
                    Blocks

A collection of blocks with stable identities.

Declaration

Swift

public typealias Blocks = DoublyLinkedList<Block>

Show on GitHub


                    
                    
                    Instructions

A collection of instructions with stable identities.

Declaration

Swift

public typealias Instructions = DoublyLinkedList<Instruction>

Show on GitHub


                    
                    
                    isSubscript

true iff the function implements a subscript.

Declaration

Swift

public let isSubscript: Bool

Show on GitHub


                    
                    
                    site

The site in the source code to which the function corresponds..

Declaration

Swift

public let site: SourceRange

Show on GitHub


                    
                    
                    linkage

The linkage of the function.

Declaration

Swift

public let linkage: Linkage

Show on GitHub


                    
                    
                    genericParameters

The generic (a.k.a., compile-time) parameters of the function.

Declaration

Swift

public let genericParameters: [GenericParameterDecl.ID]

Show on GitHub


                    
                    
                    inputs

The run-time parameters of the function.

Declaration

Swift

public let inputs: [Parameter]

Show on GitHub


                    
                    
                    output

The type of the function’s output.

Declaration

Swift

public let output: AnyType

Show on GitHub


                    
                    
                    blocks

The basic blocks of the control flow graph.

Declaration

Swift

public var blocks: Blocks

Show on GitHub


                    
                    
                    instructions

The instructions in the function.

Declaration

Swift

public var instructions: Instructions

Show on GitHub


                    
                    
                    blockForInstruction

The block associated with each instruction.

Declaration

Swift

internal var blockForInstruction: [InstructionID : Block.ID]

Show on GitHub


                    
                    
                    uses

The def-use chains of the values in this module.

Declaration

Swift

public var uses: [Operand : [Use]]

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the basic block at address.

Requires

address must be a valid address in self.

Declaration

Swift

public subscript(address: Blocks.Address) -> Block { get set }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the block identified by b.

Declaration

Swift

public subscript(b: Block.ID) -> Block { get set }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the instruction identified by i.

Declaration

Swift

public subscript(i: InstructionID) -> Instruction { get set }

Show on GitHub


                    
                    
                    subscript(register:)

Accesses the instruction denoted by o if it is .register; returns nil otherwise.

Declaration

Swift

public subscript(register o: Operand) -> Instruction? { get }

Show on GitHub


                    
                    
                    entry

The entry of the function.

Declaration

Swift

public var entry: Block.ID? { get }

Show on GitHub


                    
                    
                    isGeneric

true iff the function takes generic parameters.

Declaration

Swift

public var isGeneric: Bool { get }

Show on GitHub


                    
                    
                    returnValue

Returns the identity of the return value.

Declaration

Swift

public var returnValue: Operand? { get }

Show on GitHub


                    
                    
                    blockIDs

The IDs of all basic blocks in the CFG, beginning with the entry point block.

The first element of the returned collection is the function’s entry; other elements are in no particular order.

Declaration

Swift

public var blockIDs: some RandomAccessCollection<Block.ID> { get }

Show on GitHub


                    
                    
                    instructionIdentities

The IDs of all instructions.

Declaration

Swift

public var instructionIdentities: some Collection<InstructionID> { get }

Show on GitHub


                    
                    
                    cfg()

Returns the control flow graph of self.

Declaration

Swift

func cfg() -> ControlFlowGraph

Show on GitHub


                    
                    
                    appendBlock(in:taking:)

Appends a basic block in scope, returning its address.

The first block appended becomes the entry point block. The first block takes the parameters of the function; other blocks take no parameters.

Declaration

Swift

mutating func appendBlock<T: ScopeID>(
  in scope: T, taking parameters: [IR.`Type`] = []
) -> Block.ID

Show on GitHub


                    
                    
                    remove(_:)

Removes block and updates def-use chains.

Requires

No instruction in block is used by an instruction outside of block.

Declaration

Swift

@discardableResult
mutating func remove(_ block: Block.ID) -> Block

Show on GitHub


                    
                    
                    replace(_:with:)

Replaces old with new.

The def-use chains are updated so that the uses formerly made by old are replaced by the uses made by new and all former uses of old refer to new. After the call, self[old] == new.

Requires

new produces results with the same types as old.

Declaration

Swift

mutating func replace<I>(_ old: InstructionID, with new: I) where I : Instruction

Show on GitHub


                    
                    
                    replaceUses(of:with:)

Replaces all uses of old with new and updates the def-use chains.

The def-use chains are updated so that the uses formerly made by old are replaced by the uses made by new and all former uses of old refer to new.

Requires

new as the same type as old.

Declaration

Swift

mutating func replaceUses(of old: Operand, with new: Operand)

Show on GitHub


                    
                    
                    insert(_:at:)

Inserts newInstruction at boundary and returns its identity.

Declaration

Swift

@discardableResult
mutating func insert(
  _ newInstruction: Instruction, at boundary: InsertionPoint
) -> InstructionID

Show on GitHub


                    
                    
                    prepend(_:to:)

Adds newInstruction at the start of block and returns its identity.

Declaration

Swift

@discardableResult
private mutating func prepend(_ newInstruction: Instruction, to block: Block.ID) -> InstructionID

Show on GitHub


                    
                    
                    append(_:to:)

Adds newInstruction at the end of block and returns its identity.

Declaration

Swift

@discardableResult
private mutating func append(_ newInstruction: Instruction, to block: Block.ID) -> InstructionID

Show on GitHub


                    
                    
                    insert(_:before:)

Inserts newInstruction before successor and returns its identity.

Declaration

Swift

@discardableResult
private mutating func insert(
  _ newInstruction: Instruction, before successor: InstructionID
) -> InstructionID

Show on GitHub


                    
                    
                    insert(_:after:)

Inserts newInstruction after predecessor and returns its identity.

Declaration

Swift

@discardableResult
private mutating func insert(
  _ newInstruction: Instruction, after predecessor: InstructionID
) -> InstructionID

Show on GitHub


                    
                    
                    remove(_:)

Removes instruction i and updates def-use chains.

Requires

The result of i have no users.

Declaration

Swift

mutating func remove(_ i: InstructionID)

Show on GitHub


                    
                    
                    removeFromBlock(_:)

Removes i from its corresponding block.

Declaration

Swift

private mutating func removeFromBlock(_ i: InstructionID)

Show on GitHub


                    
                    
                    removeAllInstructions(after:)

Removes all instructions after i in its containing block and updates def-use chains.

Requires

Let S be the set of removed instructions, all users of a result of j in S are also in S.

Declaration

Swift

mutating func removeAllInstructions(after i: InstructionID)

Show on GitHub


                    
                    
                    addUses(for:with:)

Keep track of uses for instruction identified by id.

Declaration

Swift

private mutating func addUses(for instruction: Instruction, with id: InstructionID)

Show on GitHub


                    
                    
                    removeUsesMadeBy(_:)

Removes i from the def-use chains of its operands.

Declaration

Swift

private mutating func removeUsesMadeBy(_ i: InstructionID)

Show on GitHub


                    
                    
                    instructions(in:)

Returns the IDs of the instructions in b, in order.

Declaration

Swift

public func instructions(
  in b: Block.ID
) -> some Sequence<InstructionID>

Show on GitHub


                    
                    
                    firstInstruction(in:)

Returns the ID of the first instruction in b, if any.

Declaration

Swift

public func firstInstruction(in b: Block.ID) -> InstructionID?

Show on GitHub


                    
                    
                    instruction(before:)

Returns the ID the instruction before i.

Note: this may cross block boundaries.

Declaration

Swift

func instruction(before i: InstructionID) -> InstructionID?

Show on GitHub


                    
                    
                    instruction(before:in:)

Returns the ID the instruction before i.

Declaration

Swift

func instruction(before i: InstructionID, in b: Block.ID) -> InstructionID?

Show on GitHub


                    
                    
                    instruction(after:)

Returns the ID the instruction after i.

Note: this may cross block boundaries.

Declaration

Swift

func instruction(after i: InstructionID) -> InstructionID?

Show on GitHub


                    
                    
                    instruction(after:in:)

Returns the ID the instruction after i, in block b.

Declaration

Swift

public func instruction(after i: InstructionID, in b: Block.ID) -> InstructionID?

Show on GitHub


                    
                    
                    block(of:)

Returns the block corresponding to i.

Declaration

Swift

public func block(of i: InstructionID) -> Block.ID

Show on GitHub


                    
                    
                    block(of:)

Returns the block corresponding to p.

Declaration

Swift

internal func block(of p: InsertionPoint) -> Block.ID?

Show on GitHub


                    
                    
                    scope(containing:)

Returns the scope in which i is used.

Declaration

Swift

public func scope(containing i: InstructionID) -> AnyScopeID

Show on GitHub


                    
                    
                    precedes(_:_:)

Returns true iff lhs is sequenced before rhs in the block of lhs. Returns false if the two instructions are not in the same block.

Declaration

Swift

public func precedes(_ lhs: InstructionID, _ rhs: InstructionID) -> Bool

Show on GitHub


                    
                    
                    dominates(_:_:)

Returns true iff lhs is sequenced before rhs on all paths leading to rhs.

Declaration

Swift

func dominates(_ lhs: InstructionID, _ rhs: InstructionID) -> Bool

Show on GitHub


                    
                    
                    terminator(of:)

Returns the global identity of block‘s terminator, if it exists.

Declaration

Swift

func terminator(of block: Block.ID) -> InstructionID?

Show on GitHub


                    
                    
                    result(of:)

Returns the register assigned by i, if any.

Declaration

Swift

func result(of i: InstructionID) -> Operand?

Show on GitHub


                    
                    
                    type(of:)

Returns the type of operand.

Declaration

Swift

public func type(of operand: Operand) -> IR.Type

Show on GitHub


                    
                    
                    isBoundImmutably(_:)

Returns true iff p cannot be used to modify or update a value.

Declaration

Swift

public func isBoundImmutably(_ p: Operand) -> Bool

Show on GitHub


                    
                    
                    isBoundImmutably(register:)

Returns true iff the result of i cannot be used to modify or update a value.

Declaration

Swift

public func isBoundImmutably(register i: InstructionID) -> Bool

Show on GitHub


                    
                    
                    passingConvention(of:)

If p is a function parameter, returns its passing convention. Otherwise, returns nil.

Declaration

Swift

public func passingConvention(of p: Operand) -> AccessEffect?

Show on GitHub


                    
                    
                    passingConvention(parameter:)

Returns the passing convention of the i-th parameter of self.

Declaration

Swift

public func passingConvention(parameter i: Int) -> AccessEffect

Show on GitHub


                    
                    
                    allUses(of:)

Returns the uses of all the registers assigned by i.

Declaration

Swift

func allUses(of i: InstructionID) -> [Use]

Show on GitHub


                    
                    
                    provenances(_:)

Returns the operands from which the address denoted by a derives.

The (static) provenances of an address denote the original operands from which it derives. They form a set because an address computed by a projection depends on that projection’s arguments and because an address defined as a parameter of a basic block with multiple predecessors depends on that bock’s arguments.

Declaration

Swift

func provenances(_ a: Operand) -> Set<Operand>

Show on GitHub


                    
                    
                    isSink(_:)

Returns true if o can be sunken.

Declaration

Swift

func isSink(_ o: Operand) -> Bool

Show on GitHub


                    
                    
                    isBorrowSet(_:)

Returns true iff o is an access [set] instruction.

Declaration

Swift

func isBorrowSet(_ o: Operand) -> Bool

Show on GitHub


                    
                    
                    checkYieldCoherence(reportingDiagnosticsTo:)

Check if projection self is well-formed, raising diagnostics to log as needed, and returns the relevant information for expanding projections.

Declaration

Swift

fileprivate func checkYieldCoherence(
  reportingDiagnosticsTo log: inout DiagnosticSet
) throws -> ProjectionSkeleton

Show on GitHub


                    
                    
                    yieldBlockForSlide(_:cfg:yieldBlocks:)

Returns the block containing a yield that has b as a slide block, if any.

Complexity

O(n) in the number of blocks in the CFG.

Declaration

Swift

private func yieldBlockForSlide(_ b: Block.ID, cfg: ControlFlowGraph, yieldBlocks: [Block.ID]) -> Block.ID?

Show on GitHub


                    
                    
                    yieldForBlock(_:)

Returns the first yield instruction in block b.

Declaration

Swift

private func yieldForBlock(_ b: Block.ID) -> InstructionID?

Show on GitHub

ID

The global identity of an IR function.

Declaration

Swift

public struct ID : Hashable, Sendable

extension Function.ID: CustomStringConvertible

Show on GitHub