swift-mirror/include/swift/SILOptimizer/OptimizerBridging.h

//===--- OptimizerBridging.h - header for the OptimizerBridging module ----===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2021 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
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_SILOPTIMIZER_OPTIMIZERBRIDGING_H
#define SWIFT_SILOPTIMIZER_OPTIMIZERBRIDGING_H

#include "swift/SIL/SILBridging.h"

SWIFT_BEGIN_NULLABILITY_ANNOTATIONS

typedef struct {
  BridgedFunction function;
  BridgedPassContext passContext;
} BridgedFunctionPassCtxt;

typedef struct {
  BridgedInstruction instruction;
  BridgedPassContext passContext;
} BridgedInstructionPassCtxt;

typedef struct {
  const BridgedVTable * _Nullable vTables;
  size_t count;
} BridgedVTableArray;

typedef struct {
  const void * _Nonnull aliasAnalysis;
} BridgedAliasAnalysis;

typedef struct {
  void * _Nullable bca;
} BridgedCalleeAnalysis;

typedef bool (* _Nonnull InstructionIsDeinitBarrierFn)(BridgedInstruction, BridgedCalleeAnalysis bca);
typedef BridgedMemoryBehavior(* _Nonnull CalleeAnalysisGetMemBehvaiorFn)(
      BridgedPassContext context, BridgedInstruction apply, bool observeRetains);

void CalleeAnalysis_register(InstructionIsDeinitBarrierFn isDeinitBarrierFn,
                             CalleeAnalysisGetMemBehvaiorFn getEffectsFn);

typedef struct {
  void * _Nullable dea;
} BridgedDeadEndBlocksAnalysis;

typedef struct {
  void * _Nullable dt;
} BridgedDomTree;

typedef struct {
  void * _Nullable pdt;
} BridgedPostDomTree;

typedef struct {
  void * _Nonnull opaquePtr;
  unsigned char kind;
  unsigned char incomplete;
} BridgedCalleeList;

typedef struct {
  void * _Nullable bbs;
} BridgedBasicBlockSet;

typedef struct {
  void * _Nullable nds;
} BridgedNodeSet;

typedef struct {
  void * _Nullable data;
} BridgedSlab;

enum {
  BridgedSlabCapacity = 64 * sizeof(uintptr_t)
};

typedef void (* _Nonnull BridgedModulePassRunFn)(BridgedPassContext);
typedef void (* _Nonnull BridgedFunctionPassRunFn)(BridgedFunctionPassCtxt);
typedef void (* _Nonnull BridgedInstructionPassRunFn)(BridgedInstructionPassCtxt);

void SILPassManager_registerModulePass(llvm::StringRef name,
                                       BridgedModulePassRunFn runFn);
void SILPassManager_registerFunctionPass(llvm::StringRef name,
                                         BridgedFunctionPassRunFn runFn);
void SILCombine_registerInstructionPass(llvm::StringRef instClassName,
                                        BridgedInstructionPassRunFn runFn);

BridgedAliasAnalysis PassContext_getAliasAnalysis(BridgedPassContext context);

BridgedMemoryBehavior AliasAnalysis_getMemBehavior(BridgedAliasAnalysis aa,
                                                   BridgedInstruction inst,
                                                   BridgedValue addr);

BridgedCalleeAnalysis PassContext_getCalleeAnalysis(BridgedPassContext context);

BridgedCalleeList CalleeAnalysis_getCallees(BridgedCalleeAnalysis calleeAnalysis,
                                            BridgedValue callee);
BridgedCalleeList CalleeAnalysis_getDestructors(BridgedCalleeAnalysis calleeAnalysis,
                                                BridgedType type,
                                                SwiftInt isExactType);
SwiftInt BridgedFunctionArray_size(BridgedCalleeList callees);
BridgedFunction BridgedFunctionArray_get(BridgedCalleeList callees,
                                         SwiftInt index);

BridgedDeadEndBlocksAnalysis
PassContext_getDeadEndBlocksAnalysis(BridgedPassContext context);

SwiftInt DeadEndBlocksAnalysis_isDeadEnd(BridgedDeadEndBlocksAnalysis debAnalysis,
                                         BridgedBasicBlock);

BridgedDomTree PassContext_getDomTree(BridgedPassContext context);

SwiftInt DominatorTree_dominates(BridgedDomTree domTree,
                                 BridgedBasicBlock dominating,
                                 BridgedBasicBlock dominated);

BridgedPostDomTree PassContext_getPostDomTree(BridgedPassContext context);

SwiftInt PostDominatorTree_postDominates(BridgedPostDomTree pdomTree,
                                         BridgedBasicBlock dominating,
                                         BridgedBasicBlock dominated);

typedef BridgedMemoryBehavior (* _Nonnull AliasAnalysisGetMemEffectFn)(
      BridgedPassContext context, BridgedValue, BridgedInstruction);
typedef bool (* _Nonnull AliasAnalysisEscaping2InstFn)(
      BridgedPassContext context, BridgedValue, BridgedInstruction);
typedef bool (* _Nonnull AliasAnalysisEscaping2ValFn)(
      BridgedPassContext context, BridgedValue, BridgedValue);

void AliasAnalysis_register(AliasAnalysisGetMemEffectFn getMemEffectsFn,
                            AliasAnalysisEscaping2InstFn isObjReleasedFn,
                            AliasAnalysisEscaping2ValFn isAddrVisibleFromObjFn,
                            AliasAnalysisEscaping2ValFn mayPointToSameAddrFn);

BridgedSlab PassContext_getNextSlab(BridgedSlab slab);
BridgedSlab PassContext_getPreviousSlab(BridgedSlab slab);
BridgedSlab PassContext_allocSlab(BridgedPassContext passContext,
                                  BridgedSlab afterSlab);
BridgedSlab PassContext_freeSlab(BridgedPassContext passContext,
                                 BridgedSlab slab);

bool PassContext_tryDeleteDeadClosure(BridgedPassContext context, BridgedInstruction closure);

void PassContext_notifyInvalidatedStackNesting(BridgedPassContext context);
bool PassContext_getNeedFixStackNesting(BridgedPassContext context);
void PassContext_fixStackNesting(BridgedPassContext context,
                                 BridgedFunction function);

BridgedBasicBlockSet PassContext_allocBasicBlockSet(BridgedPassContext context);
void PassContext_freeBasicBlockSet(BridgedPassContext context,
                                   BridgedBasicBlockSet set);
SwiftInt BasicBlockSet_contains(BridgedBasicBlockSet set, BridgedBasicBlock block);
SwiftInt BasicBlockSet_insert(BridgedBasicBlockSet set, BridgedBasicBlock block);
void BasicBlockSet_erase(BridgedBasicBlockSet set, BridgedBasicBlock block);
BridgedFunction BasicBlockSet_getFunction(BridgedBasicBlockSet set);

BridgedNodeSet PassContext_allocNodeSet(BridgedPassContext context);
void PassContext_freeNodeSet(BridgedPassContext context,
                             BridgedNodeSet set);
SwiftInt NodeSet_containsValue(BridgedNodeSet set, BridgedValue value);
SwiftInt NodeSet_insertValue(BridgedNodeSet set, BridgedValue value);
void NodeSet_eraseValue(BridgedNodeSet set, BridgedValue value);
SwiftInt NodeSet_containsInstruction(BridgedNodeSet set, BridgedInstruction inst);
SwiftInt NodeSet_insertInstruction(BridgedNodeSet set, BridgedInstruction inst);
void NodeSet_eraseInstruction(BridgedNodeSet set, BridgedInstruction inst);
BridgedFunction NodeSet_getFunction(BridgedNodeSet set);

void AllocRefInstBase_setIsStackAllocatable(BridgedInstruction arb);

void TermInst_replaceBranchTarget(BridgedInstruction term, BridgedBasicBlock from,
                                  BridgedBasicBlock to);

swift::SubstitutionMap
PassContext_getContextSubstitutionMap(BridgedPassContext context,
                                      BridgedType bridgedType);

void PassContext_beginTransformFunction(BridgedFunction function,
                                        BridgedPassContext ctxt);
void PassContext_endTransformFunction(BridgedPassContext ctxt);

OptionalBridgedFunction
PassContext_firstFunctionInModule(BridgedPassContext context);
OptionalBridgedFunction
PassContext_nextFunctionInModule(BridgedFunction function);
BridgedVTableArray PassContext_getVTables(BridgedPassContext context);
OptionalBridgedWitnessTable
PassContext_firstWitnessTableInModule(BridgedPassContext context);
OptionalBridgedWitnessTable
PassContext_nextWitnessTableInModule(BridgedWitnessTable table);
OptionalBridgedDefaultWitnessTable
PassContext_firstDefaultWitnessTableInModule(BridgedPassContext context);
OptionalBridgedDefaultWitnessTable
PassContext_nextDefaultWitnessTableInModule(BridgedDefaultWitnessTable table);

OptionalBridgedFunction
PassContext_loadFunction(BridgedPassContext context, llvm::StringRef name);

SwiftInt SILOptions_enableStackProtection(BridgedPassContext context);
SwiftInt SILOptions_enableMoveInoutStackProtection(BridgedPassContext context);
bool SILOptions_enableSimplificationFor(BridgedInstruction inst);

BridgedValue SILUndef_get(BridgedType type, BridgedPassContext context);

SWIFT_END_NULLABILITY_ANNOTATIONS

#endif