mirror of
https://github.com/RPCS3/llvm.git
synced 2025-05-15 09:56:02 +00:00

to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@351636 91177308-0d34-0410-b5e6-96231b3b80d8
106 lines
3.5 KiB
C++
106 lines
3.5 KiB
C++
//===- CoroInternal.h - Internal Coroutine interfaces ---------*- C++ -*---===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
// Common definitions/declarations used internally by coroutine lowering passes.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_LIB_TRANSFORMS_COROUTINES_COROINTERNAL_H
|
|
#define LLVM_LIB_TRANSFORMS_COROUTINES_COROINTERNAL_H
|
|
|
|
#include "CoroInstr.h"
|
|
#include "llvm/Transforms/Coroutines.h"
|
|
|
|
namespace llvm {
|
|
|
|
class CallGraph;
|
|
class CallGraphSCC;
|
|
class PassRegistry;
|
|
|
|
void initializeCoroEarlyPass(PassRegistry &);
|
|
void initializeCoroSplitPass(PassRegistry &);
|
|
void initializeCoroElidePass(PassRegistry &);
|
|
void initializeCoroCleanupPass(PassRegistry &);
|
|
|
|
// CoroEarly pass marks every function that has coro.begin with a string
|
|
// attribute "coroutine.presplit"="0". CoroSplit pass processes the coroutine
|
|
// twice. First, it lets it go through complete IPO optimization pipeline as a
|
|
// single function. It forces restart of the pipeline by inserting an indirect
|
|
// call to an empty function "coro.devirt.trigger" which is devirtualized by
|
|
// CoroElide pass that triggers a restart of the pipeline by CGPassManager.
|
|
// When CoroSplit pass sees the same coroutine the second time, it splits it up,
|
|
// adds coroutine subfunctions to the SCC to be processed by IPO pipeline.
|
|
|
|
#define CORO_PRESPLIT_ATTR "coroutine.presplit"
|
|
#define UNPREPARED_FOR_SPLIT "0"
|
|
#define PREPARED_FOR_SPLIT "1"
|
|
|
|
#define CORO_DEVIRT_TRIGGER_FN "coro.devirt.trigger"
|
|
|
|
namespace coro {
|
|
|
|
bool declaresIntrinsics(Module &M, std::initializer_list<StringRef>);
|
|
void replaceAllCoroAllocs(CoroBeginInst *CB, bool Replacement);
|
|
void replaceAllCoroFrees(CoroBeginInst *CB, Value *Replacement);
|
|
void replaceCoroFree(CoroIdInst *CoroId, bool Elide);
|
|
void updateCallGraph(Function &Caller, ArrayRef<Function *> Funcs,
|
|
CallGraph &CG, CallGraphSCC &SCC);
|
|
|
|
// Keeps data and helper functions for lowering coroutine intrinsics.
|
|
struct LowererBase {
|
|
Module &TheModule;
|
|
LLVMContext &Context;
|
|
PointerType *const Int8Ptr;
|
|
FunctionType *const ResumeFnType;
|
|
ConstantPointerNull *const NullPtr;
|
|
|
|
LowererBase(Module &M);
|
|
Value *makeSubFnCall(Value *Arg, int Index, Instruction *InsertPt);
|
|
};
|
|
|
|
// Holds structural Coroutine Intrinsics for a particular function and other
|
|
// values used during CoroSplit pass.
|
|
struct LLVM_LIBRARY_VISIBILITY Shape {
|
|
CoroBeginInst *CoroBegin;
|
|
SmallVector<CoroEndInst *, 4> CoroEnds;
|
|
SmallVector<CoroSizeInst *, 2> CoroSizes;
|
|
SmallVector<CoroSuspendInst *, 4> CoroSuspends;
|
|
|
|
// Field Indexes for known coroutine frame fields.
|
|
enum {
|
|
ResumeField,
|
|
DestroyField,
|
|
PromiseField,
|
|
IndexField,
|
|
};
|
|
|
|
StructType *FrameTy;
|
|
Instruction *FramePtr;
|
|
BasicBlock *AllocaSpillBlock;
|
|
SwitchInst *ResumeSwitch;
|
|
AllocaInst *PromiseAlloca;
|
|
bool HasFinalSuspend;
|
|
|
|
IntegerType *getIndexType() const {
|
|
assert(FrameTy && "frame type not assigned");
|
|
return cast<IntegerType>(FrameTy->getElementType(IndexField));
|
|
}
|
|
ConstantInt *getIndex(uint64_t Value) const {
|
|
return ConstantInt::get(getIndexType(), Value);
|
|
}
|
|
|
|
Shape() = default;
|
|
explicit Shape(Function &F) { buildFrom(F); }
|
|
void buildFrom(Function &F);
|
|
};
|
|
|
|
void buildCoroutineFrame(Function &F, Shape &Shape);
|
|
|
|
} // End namespace coro.
|
|
} // End namespace llvm
|
|
|
|
#endif
|