Module Structure Reference

ID

Unique identifier of a module within a program.

Declaration

Swift

public typealias ID = ModuleDecl.ID

Show on GitHub


                    
                    
                    program

The program defining the functions in self.

Declaration

Swift

public let program: TypedProgram

Show on GitHub

id

The module’s identifier.

Declaration

Swift

public let id: ID

Show on GitHub


                    
                    
                    uses

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

Declaration

Swift

public private(set) var uses: [Operand : [Use]] { get }

Show on GitHub


                    
                    
                    productTypes

The nominal product types defined in the module.

Declaration

Swift

public private(set) var productTypes: [ProductType] { get }

Show on GitHub


                    
                    
                    traits

The traits defined in the module.

Declaration

Swift

public private(set) var traits: [TraitType] { get }

Show on GitHub


                    
                    
                    allocations

The static allocations defined in the module.

Declaration

Swift

public private(set) var allocations: [StaticStorage] { get }

Show on GitHub


                    
                    
                    functions

The functions in the module.

Declaration

Swift

public private(set) var functions: [Function.ID : Function] { get }

Show on GitHub


                    
                    
                    entryFunction

The module’s entry function, if any.

An entry function is the lowered form of a program’s entry point, that is the main function of a Hylo program. A module with an entry function is called an entry module. There can be only one entry module in a program.

Declaration

Swift

public private(set) var entryFunction: Function.ID? { get }

Show on GitHub


                    
                    
                    init(lowering:in:reportingDiagnosticsTo:)

Creates an instance lowering m in p, reporting errors and warnings to log.

Requires

m is a valid ID in p.

Throws

Diagnostics if lowering fails.

Declaration

Swift

public init(
  lowering m: ModuleDecl.ID, in p: TypedProgram,
  reportingDiagnosticsTo log: inout DiagnosticSet
) throws

Show on GitHub


                    
                    
                    name

The module’s name.

Declaration

Swift

public var name: String { get }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the given function.

Declaration

Swift

public subscript(f: Function.ID) -> Function { get set }

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the given block.

Declaration

Swift

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

Show on GitHub


                    
                    
                    subscript(_:)

Accesses the given instruction.

Declaration

Swift

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

Show on GitHub


                    
                    
                    subscript(_:)

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

Declaration

Swift

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

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 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:of:)

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

Declaration

Swift

public func passingConvention(parameter i: Int, of f: Function.ID) -> AccessEffect

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


                    
                    
                    blocks(in:)

Returns the IDs of the blocks in f.

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

Declaration

Swift

public func blocks(
  in f: Function.ID
) -> LazyMapSequence<Function.Blocks.Indices, Block.ID>

Show on GitHub


                    
                    
                    instructions(in:)

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

Declaration

Swift

public func instructions(
  in b: Block.ID
) -> LazyMapSequence<Block.Instructions.Indices, InstructionID>

Show on GitHub


                    
                    
                    instruction(before:)

Returns the ID the instruction before i.

Declaration

Swift

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

Show on GitHub


                    
                    
                    instruction(after:)

Returns the ID the instruction after i.

Declaration

Swift

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

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 asssigned by i, if any.

Declaration

Swift

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

Show on GitHub


                    
                    
                    dominates(_:_:)

Returns true iff lhs is sequenced before rhs.

Declaration

Swift

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

Show on GitHub


                    
                    
                    isDeinit(_:)

Returns true if i is a deinitializer.

Declaration

Swift

public func isDeinit(_ i: Function.ID) -> Bool

Show on GitHub


                    
                    
                    isWellFormed()

Returns whether the IR in self is well-formed.

Use this method as a sanity check to verify the module’s invariants.

Declaration

Swift

public func isWellFormed() -> Bool

Show on GitHub


                    
                    
                    isWellFormed(function:)

Returns whether f is well-formed.

Use this method as a sanity check to verify the function’s invariants.

Declaration

Swift

public func isWellFormed(function f: Function.ID) -> Bool

Show on GitHub


                    
                    
                    applyMandatoryPasses(reportingDiagnosticsTo:)

Applies all mandatory passes in this module, accumulating diagnostics in log and throwing if a pass reports an error.

Declaration

Swift

public mutating func applyMandatoryPasses(
  reportingDiagnosticsTo log: inout DiagnosticSet
) throws

Show on GitHub


                    
                    
                    generateSyntheticImplementations(reportingDiagnosticsTo:)

Inserts the IR for the synthesized declarations defined in this module, reporting diagnostics to log and throwing if a an error occurred.

Declaration

Swift

private mutating func generateSyntheticImplementations(
  reportingDiagnosticsTo log: inout DiagnosticSet
) throws

Show on GitHub


                    
                    
                    addProductType(_:)

Adds t to the set of nominal product types defined in self.

Declaration

Swift

mutating func addProductType(_ t: ProductType)

Show on GitHub


                    
                    
                    addTrait(_:)

Adds t to the set of traits defined in self.

Declaration

Swift

mutating func addTrait(_ t: TraitType)

Show on GitHub


                    
                    
                    addStaticStorage(_:)

Adds d to the set of static allocations in self.

Declaration

Swift

mutating func addStaticStorage(_ s: StaticStorage)

Show on GitHub


                    
                    
                    addFunction(_:for:)

Assigns identity to value in self.

Requires

identity is not already assigned.

Declaration

Swift

mutating func addFunction(_ value: Function, for identity: Function.ID)

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identity of the IR function corresponding to i.

Declaration

Swift

mutating func demandDeclaration(lowering i: FrontEnd.Conformance.Implementation) -> Function.ID

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identity of the IR function corresponding to d, or nil if d can’t be lowered to an IR function.

Declaration

Swift

mutating func demandDeclaration(lowering d: AnyDeclID) -> Function.ID?

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identity of the IR function corresponding to d.

Declaration

Swift

mutating func demandDeclaration(lowering d: FunctionDecl.ID) -> Function.ID

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identity of the IR function corresponding to d.

Declaration

Swift

mutating func demandDeclaration(lowering d: MethodImpl.ID) -> Function.ID

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identity of the IR function corresponding to d.

Declaration

Swift

mutating func demandDeclaration(lowering d: SubscriptImpl.ID) -> Function.ID

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identifier of the IR initializer corresponding to d.

Declaration

Swift

mutating func demandDeclaration(lowering d: InitializerDecl.ID) -> Function.ID

Show on GitHub


                    
                    
                    demandDeclaration(lowering:)

Returns the identity of the IR function corresponding to d.

Declaration

Swift

mutating func demandDeclaration(lowering d: SynthesizedFunctionDecl) -> Function.ID

Show on GitHub


                    
                    
                    demandImplementation(of:for:)

Returns the implementation of the requirement named r in witness.

Requires

r identifies a function or subscript requirement in the trait for which witness has been established.

Declaration

Swift

mutating func demandImplementation<T: Decl>(
  of r: T.ID, for witness: FrontEnd.Conformance
) -> Function.ID

Show on GitHub


                    
                    
                    demandDeinitDeclaration(from:)

Returns the IR function implementing the deinitializer defined in c.

Declaration

Swift

mutating func demandDeinitDeclaration(
  from c: FrontEnd.Conformance
) -> Function.ID

Show on GitHub


                    
                    
                    demandTakeValueDeclaration(_:definedBy:)

Returns the IR function implementing the k variant move-operation defined by conformanceToMovable.

Declaration

Swift

mutating func demandTakeValueDeclaration(
  _ k: AccessEffect, definedBy conformanceToMovable: FrontEnd.Conformance
) -> Function.ID

Parameters

`k`	The semantics of a move operation. It must be either `.set` or `.inout`.
`conformanceToMovable`	A conformance to `Movable`.

Show on GitHub


                    
                    
                    demandCopyDeclaration(definedBy:)

Returns the IR function implementing the copy operation defined in conformanceToCopyable.

Declaration

Swift

mutating func demandCopyDeclaration(
  definedBy conformanceToCopyable: FrontEnd.Conformance
) -> Function.ID

Parameters


                                conformanceToCopyable

A conformance to Copyable.

Show on GitHub


                    
                    
                    demandEqualDeclaration(definedBy:)

Returns the IR function implementing the operator defined in conformanceToEquatable.

Declaration

Swift

mutating func demandEqualDeclaration(
  definedBy conformanceToEquatable: FrontEnd.Conformance
) -> Function.ID

Parameters


                                conformanceToEquatable

A conformance to Equatable.

Show on GitHub


                    
                    
                    reference(toImplementationOf:for:)

Returns a function reference to the implementation of the requirement r in witness.

Requires

r identifies a function or subscript requirement in the trait for which witness has been established.

Declaration

Swift

mutating func reference<T: Decl>(
  toImplementationOf r: T.ID, for witness: FrontEnd.Conformance
) -> FunctionReference

Show on GitHub


                    
                    
                    reference(to:implementedFor:)

Returns a function reference to d, which is an implementation that’s part of witness.

Declaration

Swift

func reference(
  to d: Function.ID, implementedFor witness: FrontEnd.Conformance
) -> FunctionReference

Show on GitHub


                    
                    
                    memberCallee(referringTo:memberOf:accessedWith:specializedBy:usedIn:)

Returns a member reference to d, which is member of receiver accessed with capabilities k, specializing d‘s type for a in scopeOfUse.

Declaration

Swift

mutating func memberCallee(
  referringTo d: AnyDeclID, memberOf receiver: AnyType, accessedWith k: AccessEffectSet,
  specializedBy a: GenericArguments, usedIn scopeOfUse: AnyScopeID
) -> Callee

Show on GitHub


                    
                    
                    loweredParameters(of:)

Returns the lowered declarations of d‘s parameters.

Declaration

Swift

private func loweredParameters(of d: FunctionDecl.ID) -> [Parameter]

Show on GitHub


                    
                    
                    loweredParameters(of:)

Returns the lowered declarations of d‘s parameters.

Declaration

Swift

private func loweredParameters(of d: MethodImpl.ID) -> [Parameter]

Show on GitHub


                    
                    
                    loweredParameters(of:)

Returns the lowered declarations of d‘s parameters.

d’s receiver comes first and is followed by d’s formal parameters, from left to right.

Declaration

Swift

private func loweredParameters(of d: InitializerDecl.ID) -> [Parameter]

Show on GitHub


                    
                    
                    loweredParameters(of:)

Returns the lowered declarations of d‘s parameters.

Declaration

Swift

private func loweredParameters(of d: SubscriptImpl.ID) -> [Parameter]

Show on GitHub


                    
                    
                    pairedWithLoweredType(parameter:)

Returns d, which declares a parameter, paired with its lowered type.

Declaration

Swift

private func pairedWithLoweredType(parameter d: ParameterDecl.ID) -> Parameter

Show on GitHub


                    
                    
                    appendCaptures(_:passed:to:canonicalizedIn:)

Appends to inputs the parameters corresponding to the given captures passed effect, canonicalizing theirs type in scopeOfUse.

Declaration

Swift

private func appendCaptures(
  _ captures: [TupleType.Element], passed effect: AccessEffect, to inputs: inout [Parameter],
  canonicalizedIn scopeOfUse: AnyScopeID
)

Show on GitHub


                    
                    
                    appendParameters(_:to:canonicalizedIn:)

Appends parameters to inputs, canonicalizing their types in scopeOfUse.

Declaration

Swift

private func appendParameters(
  _ parameters: [CallableTypeParameter], to inputs: inout [Parameter],
  canonicalizedIn scopeOfUse: AnyScopeID
)

Show on GitHub


                    
                    
                    demandWitnessTable(_:in:)

Returns a pointer to the witness table of t used in scopeOfUse.

Declaration

Swift

mutating func demandWitnessTable(_ t: AnyType, in scopeOfUse: AnyScopeID) -> WitnessTable

Show on GitHub


                    
                    
                    loweredConformances(of:exposedTo:)

Returns the lowered conformances of model that are exposed to useScope.

Declaration

Swift

private mutating func loweredConformances(
  of model: AnyType, exposedTo useScope: AnyScopeID
) -> Set<IR.Conformance>

Show on GitHub


                    
                    
                    loweredConformance(_:)

Returns the lowered form of c.

Declaration

Swift

private mutating func loweredConformance(_ c: FrontEnd.Conformance) -> IR.Conformance

Show on GitHub


                    
                    
                    specialization(in:)

Returns a map from f‘s generic arguments to their skolemized form.

Requires

f is declared in self.

Declaration

Swift

public func specialization(in f: Function.ID) -> GenericArguments

Show on GitHub


                    
                    
                    entry(of:)

Returns the entry of f.

Requires

f is declared in self.

Declaration

Swift

public func entry(of f: Function.ID) -> Block.ID?

Show on GitHub


                    
                    
                    returnValue(of:)

Returns the operand representing the return value of f.

Requires

f is declared in self.

Declaration

Swift

public func returnValue(of f: Function.ID) -> Operand?

Show on GitHub


                    
                    
                    appendEntry(in:to:)

Appends to f an entry block that is in scope, returning its identifier.

Requires

f is declared in self and doesn’t have an entry block.

Declaration

Swift

@discardableResult
mutating func appendEntry<T>(in scope: T, to f: Function.ID) -> Block.ID where T : ScopeID

Show on GitHub


                    
                    
                    appendBlock(in:taking:to:)

Appends to f a basic block that is in scope and accepts parameters to f, returning its identifier.

Requires

f is declared in self.

Declaration

Swift

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

Show on GitHub


                    
                    
                    removeBlock(_:)

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 removeBlock(_ block: Block.ID) -> Block

Show on GitHub


                    
                    
                    replace(_:with:)

Swaps old by new.

old is removed and the def-use chains are updated so that the uses made by old are replaced by the uses made by new and all 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:in:)

Swaps all uses of old in f by new and updates the def-use chains.

Requires

new as the same type as old. f is in self.

Declaration

Swift

mutating func replaceUses(of old: Operand, with new: Operand, in f: Function.ID)

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
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
mutating func append(_ newInstruction: Instruction, to block: Block.ID) -> InstructionID

Show on GitHub


                    
                    
                    insert(_:at:)

Inserts newInstruction at position and returns its identity.

The instruction is inserted before the instruction currently at position. You can pass a “past the end” position to append at the end of a block.

Declaration

Swift

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

Show on GitHub


                    
                    
                    insert(_:before:)

Inserts newInstruction before successor and returns its identity.

Declaration

Swift

@discardableResult
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
mutating func insert(
  _ newInstruction: Instruction, after predecessor: InstructionID
) -> InstructionID

Show on GitHub


                    
                    
                    insert(_:with:)

Inserts newInstruction with impl and returns its identity.

Declaration

Swift

private mutating func insert(
  _ newInstruction: Instruction, with impl: (inout Self, Instruction) -> InstructionID
) -> InstructionID

Show on GitHub


                    
                    
                    removeInstruction(_:)

Removes instruction i and updates def-use chains.

Requires

The result of i have no users.

Declaration

Swift

mutating func removeInstruction(_ 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


                    
                    
                    allUses(of:)

Returns the uses of all the registers assigned by i.

Declaration

Swift

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

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


                    
                    
                    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


                    
                    
                    liveRange(of:definedIn:)

Given operand is an instruction or block parameter, returns its live-range.

The live-range L of an operand x in a function f is the minimal lifetime such that for for all instructions i in f, if i uses x then i is in L.

Declaration

Swift

func liveRange(of operand: Operand, definedIn site: Block.ID) -> Lifetime

Show on GitHub


                    
                    
                    extend(lifetime:toInclude:)

Returns l in which i has been inserted.

Requires

The definition of l dominates u.

Declaration

Swift

func extend(lifetime l: Lifetime, toInclude u: Use) -> Lifetime

Show on GitHub


                    
                    
                    extend(lifetime:toCover:)

Returns left extended to cover the instructions in right.

Requires

left and right are defined in the same function, which is in self. The operand for which right is defined must be in left.

Declaration

Swift

func extend(lifetime left: Lifetime, toCover right: Lifetime) -> Lifetime

Show on GitHub


                    
                    
                    lastUse(of:in:)

Returns the last use of operand in block.

Declaration

Swift

private func lastUse(of operand: Operand, in block: Block.ID) -> Use?

Show on GitHub


                    
                    
                    last(_:_:)

Returns the use that executes last.

Declaration

Swift

private func last(_ lhs: Use?, _ rhs: Use?) -> Use?

Show on GitHub


                    
                    
                    reifyAccesses(in:diagnostics:)

Replace uses of instructions requesting multiple capabilities by one requesting the weakest actually required, reporting errors and warnings to diagnostics.

Requires

f is in self.

Declaration

Swift

public mutating func reifyAccesses(in f: Function.ID, diagnostics: inout DiagnosticSet)

Show on GitHub


                    
                    
                    requests(_:)

Undocumented

Declaration

Swift

private func requests(_ u: Use) -> AccessEffectSet

Show on GitHub


                    
                    
                    requests(projectBundle:)

Undocumented

Declaration

Swift

private func requests(projectBundle u: Use) -> AccessEffectSet

Show on GitHub


                    
                    
                    forEachClient(of:_:)

Calls action on the uses of a capability of the access at the origin of i.

Declaration

Swift

private func forEachClient(of i: InstructionID, _ action: (Use) -> Void)

Show on GitHub


                    
                    
                    reify(_:as:)

Replaces the uses of i with uses of an instruction providing the same access but only with capability k.

Declaration

Swift

private mutating func reify(_ i: InstructionID, as k: AccessEffect)

Show on GitHub


                    
                    
                    reify(access:as:)

Narrows the capabilities requested by i, which is an access instruction, to just k.

Declaration

Swift

private mutating func reify(access i: InstructionID, as k: AccessEffect)

Show on GitHub


                    
                    
                    reify(projectBundle:as:)

Undocumented

Declaration

Swift

private mutating func reify(projectBundle i: InstructionID, as k: AccessEffect)

Show on GitHub


                    
                    
                    reifyCallsToBundles(in:diagnostics:)

Replace occurrences of call_bundle by call depending on the uses of their first operands, reporting errors and warnings to diagnostics.

Requires

f is in self.

Declaration

Swift

public mutating func reifyCallsToBundles(in f: Function.ID, diagnostics: inout DiagnosticSet)

Show on GitHub


                    
                    
                    reify(callBundle:)

Undocumented

Declaration

Swift

private mutating func reify(callBundle i: InstructionID)

Show on GitHub


                    
                    
                    closeBorrows(in:diagnostics:)

Inserts end_borrow instructions after the last use of each access instruction in f, reporting errors and warnings to diagnostics.

Requires

self is has gone through access reification. f is in self.

Declaration

Swift

public mutating func closeBorrows(in f: Function.ID, diagnostics: inout DiagnosticSet)

Show on GitHub


                    
                    
                    close(_:in:reportingDiagnosticsTo:)

If i is access or project, make sure it is post-dominated by respectively end_borrow or end_project, inserting new instructions as necessary; does nothing otherwise.

Declaration

Swift

private mutating func close(
  _ i: InstructionID, in f: Function.ID, reportingDiagnosticsTo log: inout DiagnosticSet
)

Show on GitHub


                    
                    
                    insertClose(_:atBoundariesOf:makingInstructionWith:)

Closes the access formed by i at the boundaries of region, calling make to create the appropriate lifetiem closer instruction.

No instruction is inserted at after already existing lifetime closers for i.

Declaration

Swift

private mutating func insertClose<T: LifetimeCloser>(
  _ i: InstructionID, atBoundariesOf region: Lifetime,
  makingInstructionWith make: (inout Self, SourceRange) -> T
)

Show on GitHub


                    
                    
                    extendedLiveRange(of:)

Returns the extended live-range of definition.

A definition is live over an instruction if it is is used by that instruction or may be used by another instruction in the future. The live-range of a definition d is the region of a function containing all instructions over which d is live. The extended live-range of d is its live-range merged with the extended live-ranges of the definitions extending d.

Note

The definition of an operand o isn’t part of o‘s lifetime.

Declaration

Swift

private func extendedLiveRange(of definition: Operand) -> Lifetime

Show on GitHub


                    
                    
                    removeDeadCode(in:diagnostics:)

Removes unreachable code from f, reporting errors and warnings to diagnostics.

Requires

f is in self.

Declaration

Swift

public mutating func removeDeadCode(in f: Function.ID, diagnostics: inout DiagnosticSet)

Show on GitHub


                    
                    
                    removeUnusedDefinitions(from:)

Removes the instructions if f that have no user.

Declaration

Swift

private mutating func removeUnusedDefinitions(from f: Function.ID)

Show on GitHub


                    
                    
                    removeUnused(_:keepingTrackIn:)

Removes the instructions in definitions that have no user, accumulating the IDs of removed elements in removed.

Declaration

Swift

private mutating func removeUnused<S: Sequence<InstructionID>>(
  _ definitions: S, keepingTrackIn removed: inout Set<InstructionID>
)

Show on GitHub


                    
                    
                    removeUnreachableBlocks(from:)

Removes the basic blocks that have no predecessor from f, except its entry.

Declaration

Swift

private mutating func removeUnreachableBlocks(from f: Function.ID)

Show on GitHub


                    
                    
                    removeCodeAfterCallsReturningNever(from:)

Removes the code after calls returning Never from f.

Declaration

Swift

private mutating func removeCodeAfterCallsReturningNever(from f: Function.ID)

Show on GitHub


                    
                    
                    returnsNever(_:)

Returns true iff i never returns control flow.

Declaration

Swift

private func returnsNever(_ i: InstructionID) -> Bool

Show on GitHub


                    
                    
                    isRemovableWhenUnused(_:)

Returns true iff i can be removed if it has no use.

Declaration

Swift

private func isRemovableWhenUnused(_ i: InstructionID) -> Bool

Show on GitHub


                    
                    
                    defineGenericValueArguments(_:in:)

Allocates and initializes storage for each generic value argument in specialization in the entry of monomorphized, returning a map from a generic value parameter to its corresponding allocation that preserves the order of specialization.

Declaration

Swift

fileprivate mutating func defineGenericValueArguments(
  _ specialization: GenericArguments,
  in monomorphized: Function.ID
) -> OrderedDictionary<GenericParameterDecl.ID, InstructionID>

Show on GitHub

PC

A “program counter” in the abstract machine.

Declaration

Swift

private typealias PC = Block.Instructions.Address

Show on GitHub


                    
                    
                    normalizeObjectStates(in:diagnostics:)

Ensures that objects in f are initialized before use and deinitialized after last use, reporting errors and warnings to diagnostics.

Requires

Borrows in self have been closed. f is in self.

Declaration

Swift

public mutating func normalizeObjectStates(in f: Function.ID, diagnostics: inout DiagnosticSet)

Show on GitHub


                    
                    
                    entryContext(of:)

Returns the initial context in which f should be interpreted.

Declaration

Swift

private func entryContext(of f: Function.ID) -> Context

Show on GitHub


                    
                    
                    addParameter(_:of:at:in:)

Configure in context the initial state of the parameter at position in entry, which has type t.

Declaration

Swift

private func addParameter(
  _ t: ParameterType, of entry: Block.ID, at position: Int,
  in context: inout Context
)

Show on GitHub


                    
                    
                    addParameter(_:_:of:at:in:)

Configure in context the initial state of the parameter at position in entry, which has type t passed with capability k.

Declaration

Swift

private func addParameter(
  _ k: AccessEffect, _ t: AnyType, of entry: Block.ID, at position: Int,
  in context: inout Context
)

Show on GitHub


                    
                    
                    initializeRegister(createdBy:in:)

Assigns a fully initialized object to the virtual register defined by i in context.

Declaration

Swift

private func initializeRegister(createdBy i: InstructionID, in context: inout Context)

Show on GitHub


                    
                    
                    initializeRegister(createdBy:projecting:in:)

Assigns the virtual register defined by i to the location of the storage projected by i, using t to set the initial state of that storage.

Declaration

Swift

private func initializeRegister(
  createdBy i: InstructionID, projecting t: RemoteType, in context: inout Context
)

Show on GitHub


                    
                    
                    insertDeinit(_:at:before:anchoringInstructionsTo:reportingDiagnosticsTo:)

Inserts IR for the deinitialization of root at given initializedSubfields before instruction i, anchoring instructions to site.

Declaration

Swift

private mutating func insertDeinit(
  _ root: Operand, at initializedSubfields: [RecordPath], before i: InstructionID,
  anchoringInstructionsTo site: SourceRange,
  reportingDiagnosticsTo log: inout DiagnosticSet
)

Show on GitHub


                    
                    
                    insertDeinitParts(of:before:anchoringInstructionsTo:reportingDiagnosticsTo:)

Inserts ID for the deinitialization of whole‘s parts before instruction i, anchoring new instructions to site.

Declaration

Swift

private mutating func insertDeinitParts(
  of whole: Operand, before i: InstructionID,
  anchoringInstructionsTo site: SourceRange,
  reportingDiagnosticsTo log: inout DiagnosticSet
)

Show on GitHub


                    
                    
                    diagnosticSite(for:in:)

Returns the site at which diagnostics related to the parameter p should be reported in f.

Declaration

Swift

private func diagnosticSite(for p: Parameter, in f: Function.ID) -> SourceRange

Show on GitHub


                    
                    
                    ensureExclusivity(in:diagnostics:)

Ensures the Law of Exclusivity is satisfied in f, reporting errors and warnings to diagnostics.

Requires

f is in self.

Declaration

Swift

public func ensureExclusivity(in f: Function.ID, diagnostics: inout DiagnosticSet)

Show on GitHub


                    
                    
                    entryContext(of:)

Returns the initial context in which f should be interpreted.

Declaration

Swift

private func entryContext(of f: Function.ID) -> Context

Show on GitHub


                    
                    
                    addParameter(_:of:at:in:)

Configure in context the initial state of the parameter at position in entry, which has type t.

Declaration

Swift

private func addParameter(
  _ t: ParameterType, of entry: Block.ID, at position: Int,
  in context: inout Context
)

Show on GitHub


                    
                    
                    addParameter(_:_:of:at:in:)

Configure in context the initial state of the parameter at position in entry, which has type t passed with capability k.

Declaration

Swift

private func addParameter(
  _ k: AccessEffect, _ t: AnyType, of entry: Block.ID, at position: Int,
  in context: inout Context
)

Show on GitHub


                    
                    
                    initializeRegister(createdBy:projecting:in:)

Assigns the virtual register defined by i to the location of the storage projected by i, using t to set the initial state of that storage.

Declaration

Swift

private func initializeRegister(
  createdBy i: InstructionID, projecting t: RemoteType, in context: inout Context
)

Show on GitHub


                    
                    
                    reborrowedSource(_:)

Returns the borrowed instruction from which b reborrows, if any.

Declaration

Swift

private func reborrowedSource(_ b: Access) -> InstructionID?

Show on GitHub


                    
                    
                    accessSource(_:)

Returns the source of the access denoted by o.

Requires

o denotes a location.

Declaration

Swift

private func accessSource(_ o: Operand) -> Operand

Show on GitHub


                    
                    
                    simplify(_:)

Eliminates redundant instructions and fold address computations in f.

Declaration

Swift

public mutating func simplify(_ f: Function.ID)

Show on GitHub


                    
                    
                    eliminateRedundantAccess(_:)

Replaces uses of i by its source if i is redundant.

An access is redundant if its source is another access requesting the same capability. When that occurs, instructions closing the redundant access can be removed and uses be replaced by uses of its source.

Declaration

Swift

private mutating func eliminateRedundantAccess(_ i: InstructionID) -> InstructionID?

Show on GitHub


                    
                    
                    description

Declaration

Swift

public var description: String { get }

Show on GitHub


                    
                    
                    write(to:)

Writes a textual representation of this instance into output.

Declaration

Swift

public func write<Target>(to output: inout Target) where Target : TextOutputStream

Show on GitHub


                    
                    
                    describe(function:)

Returns a textual representation of the specified function.

Declaration

Swift

public func describe(function f: Function.ID) -> String

Show on GitHub


                    
                    
                    write(function:to:)

Writes a textual representation of the specified function into output.

Declaration

Swift

public func write<Target>(function f: Function.ID, to output: inout Target) where Target : TextOutputStream

Show on GitHub


                    
                    
                    debugDescription(_:)

Returns a textual description of f suitable for debugging.

Declaration

Swift

func debugDescription(_ f: Function.ID) -> String

Show on GitHub


                    
                    
                    debugDescription(_:)

Returns a textual description of d suitable for debugging.

Declaration

Swift

func debugDescription(_ f: SynthesizedFunctionDecl) -> String

Show on GitHub


                    
                    
                    makeAccess(_:from:correspondingTo:at:)

Creates an access anchored at site that may take any of capabilities from source, optionally associated with a variable declaration in the AST.

Declaration

Swift

func makeAccess(
  _ capabilities: AccessEffectSet, from source: Operand,
  correspondingTo binding: VarDecl.ID? = nil,
  at site: SourceRange
) -> Access

Show on GitHub


                    
                    
                    makeAddressToPointer(_:at:)

Creates an address_to_pointer anchored at site that converts source to a built-in pointer value.

Declaration

Swift

func makeAddressToPointer(_ source: Operand, at site: SourceRange) -> AddressToPointer

Show on GitHub


                    
                    
                    makeAdvancedByBytes(source:offset:at:)

Creates an advanced by bytes instruction anchored at site computing the source address value advanced by offset bytes.

Declaration

Swift

func makeAdvancedByBytes(
  source: Operand, offset: Operand, at site: SourceRange
) -> AdvancedByBytes

Show on GitHub


                    
                    
                    makeAdvanced(_:byStrides:at:)

Creates an advanced by strides instruction anchored at site computing the source address advanced by n strides of its referred type.

Declaration

Swift

func makeAdvanced(
  _ source: Operand, byStrides n: Int, at site: SourceRange
) -> AdvancedByStrides

Show on GitHub


                    
                    
                    sourceType(_:)

Returns the AST type of source iff it is the address of a buffer.

Declaration

Swift

private func sourceType(_ source: Operand) -> BufferType?

Show on GitHub


                    
                    
                    makeAllocStack(_:at:)

Creates an alloc_stack anchored at site that allocates storage of type t.

Requires

t is canonical.

Declaration

Swift

func makeAllocStack(_ t: AnyType, at site: SourceRange) -> AllocStack

Show on GitHub


                    
                    
                    makeBranch(to:at:)

Creates a branch anchored at site that unconditionally jumps at the start of a block.

Declaration

Swift

func makeBranch(to target: Block.ID, at anchor: SourceRange) -> Branch

Parameters


                                target

The block in which control flow jumps.

Show on GitHub


                    
                    
                    makeCall(applying:to:writingResultTo:at:)

Creates a call anchored at site that applies callee on arguments and writes its result to output.

Declaration

Swift

func makeCall(
  applying callee: Operand, to arguments: [Operand], writingResultTo output: Operand,
  at site: SourceRange
) -> Call

Parameters

`callee`	The function to call.
`output`	The location at which the result of `callee` is stored.
`arguments`	The arguments of the call; one for each input of `callee`‘s type.

Show on GitHub


                    
                    
                    makeCallBuiltin(applying:to:at:)

Creates an instruction anchored at site that applies f to operands.

Declaration

Swift

func makeCallBuiltin(
  applying s: BuiltinFunction, to operands: [Operand], at site: SourceRange
) -> CallBuiltinFunction

Parameters

`f`	A built-in function.
`operands`	A collection of built-in objects.

Show on GitHub


                    
                    
                    makeCallBundle(applying:to:writingResultTo:at:canonicalizingTypesIn:)

Creates a call_bundle anchored at site that applies one of the variants defined in m to arguments a, canonicalizing types in scopeOfUse.

Declaration

Swift

mutating func makeCallBundle(
  applying m: BundleReference<MethodDecl>, to a: [Operand],
  writingResultTo o: Operand,
  at site: SourceRange,
  canonicalizingTypesIn scopeOfUse: AnyScopeID
) -> CallBundle

Show on GitHub


                    
                    
                    makeCallFFI(returning:applying:to:at:)

Creates a call_ffi anchored at site that applies callee on arguments using to return and returns a value of returnType.

Declaration

Swift

func makeCallFFI(
  returning returnType: IR.`Type`, applying callee: String, to arguments: [Operand],
  at site: SourceRange
) -> CallFFI

Parameters

`returnType`	The return type of the callee.
`callee`	The name of the foreign function to call
`arguments`	The arguments of the call.

Show on GitHub


                    
                    
                    makeCapture(_:in:at:)

Creates a capture ... in anchored at site that captures source, which is an access, and stores it in target.

Declaration

Swift

func makeCapture(_ source: Operand, in target: Operand, at site: SourceRange) -> CaptureIn

Show on GitHub


                    
                    
                    makeCloseCapture(_:at:)

Creates a close_capture anchored at site that ends the exposition of a captured access.

Declaration

Swift

func makeCloseCapture(_ start: Operand, at site: SourceRange) -> CloseCapture

Show on GitHub


                    
                    
                    makeCloseUnion(_:at:)

Creates an close_union anchored at site that ends an access to the payload of a union opened previously by start.

Declaration

Swift

func makeCloseUnion(_ start: Operand, at site: SourceRange) -> CloseUnion

Show on GitHub


                    
                    
                    makeCondBranch(if:then:else:at:)

Creates a cond_branch anchored at site that jumps to targetIfTrue if condition is true or targetIfFalse otherwise.

Declaration

Swift

func makeCondBranch(
  if condition: Operand,
  then targetIfTrue: Block.ID,
  else targetIfFalse: Block.ID,
  at site: SourceRange
) -> CondBranch

Parameters

`condition`	The condition tested to select the jump destination. Must a built-in `i1` object.
`targetIfTrue`	The block in which control flow jumps if `condition` is true.
`targetIfFalse`	The block in which control flow jumps if `condition` is false.

Show on GitHub


                    
                    
                    makeConstantString(utf8:at:)

Creates a constant_string anchored at site that returns a string with given value, encoded in UTF8.

Declaration

Swift

func makeConstantString(utf8 value: Data, at site: SourceRange) -> ConstantString

Show on GitHub


                    
                    
                    makeDeallocStack(for:at:)

Creates a dealloc_stack anchored at site that deallocates memory allocated by alloc.

Declaration

Swift

func makeDeallocStack(for alloc: Operand, at site: SourceRange) -> DeallocStack

Parameters


                                alloc

The address of the memory to deallocate. Must be the result of alloc.

Show on GitHub


                    
                    
                    makeEndAccess(_:at:)

Creates an end_access anchored at site that ends the projection created by start.

Declaration

Swift

func makeEndAccess(_ start: Operand, at site: SourceRange) -> EndAccess

Show on GitHub


                    
                    
                    makeEndProject(_:at:)

Creates an end_project anchored at site that ends the projection created by start.

Declaration

Swift

func makeEndProject(_ start: Operand, at site: SourceRange) -> EndProject

Show on GitHub


                    
                    
                    makeGenericParameter(passedTo:at:)

Creates an generic_parameter anchored at site that returns the address of the generic argument passed to p.

Declaration

Swift

func makeGenericParameter(
  passedTo p: GenericParameterDecl.ID, at site: SourceRange
) -> GenericParameter

Show on GitHub


                    
                    
                    makeGlobalAddr(of:at:)

Creates an global_addr anchored at site that returns the address of binding.

Declaration

Swift

func makeGlobalAddr(of binding: BindingDecl.ID, at anchor: SourceRange) -> GlobalAddr

Show on GitHub


                    
                    
                    makeLoad(_:at:)

Creates a load anchored at site that loads the object at source.

Declaration

Swift

func makeLoad(_ source: Operand, at site: SourceRange) -> Load

Parameters


                                source

The location from which the object is loaded. Must be the result of an access instruction requesting a sink capability.

Show on GitHub


                    
                    
                    makeMarkState(_:initialized:at:)

Creates a mark_state instruction anchored at site that marks storage has being fully initialized if initialized is true or fully uninitialized otherwise.

Declaration

Swift

func makeMarkState(_ storage: Operand, initialized: Bool, at site: SourceRange) -> MarkState

Show on GitHub


                    
                    
                    makeMemoryCopy(_:_:at:)

Creates an memory_copy anchored at site that copies the memory representation of the value stored at source to target.

Requires

source is a let-capable access and target is a set-capable access. source and target have the same type.

Declaration

Swift

func makeMemoryCopy(_ source: Operand, _ target: Operand, at site: SourceRange) -> MemoryCopy

Show on GitHub


                    
                    
                    makeMove(_:to:usingConformance:at:)

Creates a move anchored at site that moves value into storage using the move operations defined by movable.

This instruction is replaced during IR transformation by either the initialization or assignment of storage, depending on its initialization state.

Declaration

Swift

func makeMove(
  _ value: Operand, to storage: Operand, usingConformance movable: FrontEnd.Conformance,
  at site: SourceRange
) -> Move

Parameters

`value`	The object to move. Must have an address type.
`storage`	The location to initialize or assign. Must have an address type.

Show on GitHub


                    
                    
                    makeOpenCapture(_:at:)

Creates an open_capture anchored at site that loads the address stored at source.

Declaration

Swift

func makeOpenCapture(_ source: Operand, at site: SourceRange) -> OpenCapture

Show on GitHub


                    
                    
                    makeOpenUnion(_:as:forInitialization:at:)

Creates an open_union anchored at site that projects the address of container‘s payload viewed as an instance of payload.

If the bits of the union’s discriminator are hidden in its storage, this function removes them before projecting the address unless isUsedForInitialization is true.

Declaration

Swift

func makeOpenUnion(
  _ container: Operand, as payload: AnyType,
  forInitialization isUsedForInitialization: Bool = false,
  at site: SourceRange
) -> OpenUnion

Show on GitHub


                    
                    
                    makePointerToAddress(_:to:at:)

Creates a pointer_to_address anchored at site that converts source, which is a built-in pointer value, to an address of type target.

Declaration

Swift

func makePointerToAddress(
  _ source: Operand, to target: RemoteType, at site: SourceRange
) -> PointerToAddress

Show on GitHub


                    
                    
                    makeProject(_:applying:to:at:)

Creates a project anchored at site that projects a value of type t by applying s, which is a reference to a lowered subscript, on arguments.

Declaration

Swift

func makeProject(
  _ t: RemoteType, applying s: FunctionReference, to arguments: [Operand], at site: SourceRange
) -> Project

Show on GitHub


                    
                    
                    makeProject(_:applying:specializedBy:to:at:)

Creates a project anchored at site that projects a value of type t by applying s, which is a lowered subscript, specialized by z, on arguments.

Declaration

Swift

func makeProject(
  _ t: RemoteType, applying s: Function.ID, specializedBy z: GenericArguments,
  to arguments: [Operand], at site: SourceRange
) -> Project

Show on GitHub


                    
                    
                    makeProjectBundle(applying:to:at:canonicalizingTypesIn:)

Creates a project_bundle anchored at site that applies one of the variants defined in m to arguments a, canonicalizing types in scopeOfUse.

Declaration

Swift

mutating func makeProjectBundle(
  applying m: BundleReference<SubscriptDecl>, to a: [Operand],
  at site: SourceRange,
  canonicalizingTypesIn scopeOfUse: AnyScopeID
) -> ProjectBundle

Show on GitHub


                    
                    
                    makeRegionExit(_:at:)

Creates a region exit anchored at site marking an exit of the regions started by start.

Declaration

Swift

func makeRegionExit<Entry: RegionEntry>(
  _ start: Operand, at anchor: SourceRange
) -> RegionExit<Entry>

Show on GitHub


                    
                    
                    makeReleaseCapture(_:at:)

Creates a release_capture anchored at site that releases the accesses previously captured in container.

Declaration

Swift

func makeReleaseCapture(_ container: Operand, at site: SourceRange) -> ReleaseCaptures

Show on GitHub


                    
                    
                    makeReturn(at:)

Creates a return anchored at site.

Declaration

Swift

func makeReturn(at site: SourceRange) -> Return

Show on GitHub


                    
                    
                    makeStore(_:at:at:)

Creates a record anchored at site that stores object at `target.

Declaration

Swift

func makeStore(_ object: Operand, at target: Operand, at site: SourceRange) -> Store

Parameters

`object`	The object to store. Must have an object type.
`target`	The location at which `object` is stored. Must have an address type.

Show on GitHub


                    
                    
                    makeSubfieldView(of:subfield:at:)

Creates a subfield_view anchored at site computing the address of the given subfield of some record at recordAddress.

Note

base is returned unchanged if elementPath is empty.

Declaration

Swift

func makeSubfieldView(
  of recordAddress: Operand, subfield elementPath: RecordPath, at site: SourceRange
) -> SubfieldView

Show on GitHub


                    
                    
                    makeSwitch(on:toOneOf:at:)

Creates a switch anchored at site that jumps to successors[i].

Requires

i is a valid index in successors, expressed as a built-in integer, and successors is not empty.

Declaration

Swift

func makeSwitch(
  on index: Operand, toOneOf successors: [Block.ID], at site: SourceRange
) -> Switch

Show on GitHub


                    
                    
                    makeUnionDiscriminator(_:at:)

Creates a union_discriminator anchored at site that returns the discriminator of the element stored in container.

Declaration

Swift

func makeUnionDiscriminator(
  _ container: Operand, at site: SourceRange
) -> UnionDiscriminator

Show on GitHub


                    
                    
                    makeUnionSwitch(over:of:toOneOf:at:)

Creates a union_switch anchored at site that switches over discriminator, which is the discriminator of a container of type union, jumping to corresponding block in target.

If union is generic, discriminator should be the result of union_discriminator rather than a constant.

Requires

targets has a key defined for each of union.

Declaration

Swift

func makeUnionSwitch(
  over discriminator: Operand, of union: UnionType, toOneOf targets: UnionSwitch.Targets,
  at site: SourceRange
) -> UnionSwitch

Show on GitHub


                    
                    
                    makeUnreachable(at:)

Creates an unreachable anchored at site that marks the execution path unreachable.

Declaration

Swift

func makeUnreachable(at site: SourceRange) -> Unreachable

Show on GitHub


                    
                    
                    makeWrapExistentialAddr(_:_:as:at:)

Creates a wrap_existential_addr anchored at site that creates an existential container of type interface wrapping witness and table.

Declaration

Swift

func makeWrapExistentialAddr(
  _ witness: Operand, _ table: Operand, as interface: ExistentialType,
  at site: SourceRange
) -> WrapExistentialAddr

Parameters

`witness`	The address of the object wrapped in the container.
`interface`	The type of the container.
`table`	The witness table of the wrapped value. Must be a pointer to a witness table.

Show on GitHub


                    
                    
                    makeYield(_:_:at:)

Creates a yield anchored at site that projects a with capability c.

Declaration

Swift

func makeYield(_ c: AccessEffect, _ a: Operand, at site: SourceRange) -> Yield

Show on GitHub