From 5a29c9eed157af51a8d338b5a225b146881819e8 Mon Sep 17 00:00:00 2001 From: Gordon Henriksen Date: Sun, 17 Aug 2008 12:56:54 +0000 Subject: [PATCH] Factor GC metadata table assembly generation out of Collector in preparation for splitting AsmPrinter into its own library. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@54881 91177308-0d34-0410-b5e6-96231b3b80d8 --- .../{Collector.h => GCMedataPrinter.h} | 0 .../{CollectorMetadata.h => GCMetadata.h} | 0 include/llvm/CodeGen/GCStrategy.h | 167 ++++++++++++++++++ include/llvm/CodeGen/{Collectors.h => GCs.h} | 7 +- .../llvm/CodeGen/LinkAllCodegenComponents.h | 3 +- lib/CodeGen/AsmPrinter.cpp | 6 +- .../{CollectorMetadata.cpp => GCMetadata.cpp} | 6 +- lib/CodeGen/GCMetadataPrinter.cpp | 31 ++++ lib/CodeGen/{Collector.cpp => GCStrategy.cpp} | 20 +-- lib/CodeGen/{Collectors.cpp => GCs.cpp} | 2 +- lib/CodeGen/LLVMTargetMachine.cpp | 2 +- lib/CodeGen/OcamlGC.cpp | 46 +++++ ...{OcamlCollector.cpp => OcamlGCPrinter.cpp} | 25 +-- lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp | 2 +- ...owStackCollector.cpp => ShadowStackGC.cpp} | 4 +- 15 files changed, 268 insertions(+), 53 deletions(-) rename include/llvm/CodeGen/{Collector.h => GCMedataPrinter.h} (100%) rename include/llvm/CodeGen/{CollectorMetadata.h => GCMetadata.h} (100%) create mode 100644 include/llvm/CodeGen/GCStrategy.h rename include/llvm/CodeGen/{Collectors.h => GCs.h} (89%) rename lib/CodeGen/{CollectorMetadata.cpp => GCMetadata.cpp} (98%) create mode 100644 lib/CodeGen/GCMetadataPrinter.cpp rename lib/CodeGen/{Collector.cpp => GCStrategy.cpp} (95%) rename lib/CodeGen/{Collectors.cpp => GCs.cpp} (96%) create mode 100644 lib/CodeGen/OcamlGC.cpp rename lib/CodeGen/{OcamlCollector.cpp => OcamlGCPrinter.cpp} (91%) rename lib/CodeGen/{ShadowStackCollector.cpp => ShadowStackGC.cpp} (99%) diff --git a/include/llvm/CodeGen/Collector.h b/include/llvm/CodeGen/GCMedataPrinter.h similarity index 100% rename from include/llvm/CodeGen/Collector.h rename to include/llvm/CodeGen/GCMedataPrinter.h diff --git a/include/llvm/CodeGen/CollectorMetadata.h b/include/llvm/CodeGen/GCMetadata.h similarity index 100% rename from include/llvm/CodeGen/CollectorMetadata.h rename to include/llvm/CodeGen/GCMetadata.h diff --git a/include/llvm/CodeGen/GCStrategy.h b/include/llvm/CodeGen/GCStrategy.h new file mode 100644 index 00000000000..dea0785ef87 --- /dev/null +++ b/include/llvm/CodeGen/GCStrategy.h @@ -0,0 +1,167 @@ +//===-- llvm/CodeGen/Collector.h - Garbage collection -----------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// Collector records sufficient information about a machine function to enable +// accurate garbage collectors. Specifically: +// +// - Safe points +// Garbage collection is only possible at certain points in code. Code +// generators should record points: +// +// - At and after any call to a subroutine +// - Before returning from the current function +// - Before backwards branches (loops) +// +// - Roots +// When a reference to a GC-allocated object exists on the stack, it must be +// stored in an alloca registered with llvm.gcoot. +// +// This generic information should used by ABI-specific passes to emit support +// tables for the runtime garbage collector. +// +// MachineCodeAnalysis identifies the GC safe points in the machine code. (Roots +// are identified in SelectionDAGISel.) +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CODEGEN_COLLECTOR_H +#define LLVM_CODEGEN_COLLECTOR_H + +#include "llvm/CodeGen/GCMetadata.h" +#include +#include + +namespace llvm { + + /// Collector describes a garbage collector's code generation requirements, + /// and provides overridable hooks for those needs which cannot be abstractly + /// described. + class Collector { + public: + typedef std::vector list_type; + typedef list_type::iterator iterator; + + private: + friend class CollectorModuleMetadata; + const Module *M; + std::string Name; + + list_type Functions; + + protected: + unsigned NeededSafePoints; //< Bitmask of required safe points. + bool CustomReadBarriers; //< Default is to insert loads. + bool CustomWriteBarriers; //< Default is to insert stores. + bool CustomRoots; //< Default is to pass through to backend. + bool InitRoots; //< If set, roots are nulled during lowering. + bool UsesMetadata; //< If set, backend must emit metadata tables. + + public: + Collector(); + + virtual ~Collector(); + + + /// getName - The name of the collector, for debugging. + /// + const std::string &getName() const { return Name; } + + /// getModule - The module upon which the collector is operating. + /// + const Module &getModule() const { return *M; } + + /// True if this collector requires safe points of any kind. By default, + /// none are recorded. + bool needsSafePoints() const { return NeededSafePoints != 0; } + + /// True if the collector requires the given kind of safe point. By default, + /// none are recorded. + bool needsSafePoint(GC::PointKind Kind) const { + return (NeededSafePoints & 1 << Kind) != 0; + } + + /// By default, write barriers are replaced with simple store instructions. + /// If true, then addPassesToCustomLowerIntrinsics must instead process + /// them. + bool customWriteBarrier() const { return CustomWriteBarriers; } + + /// By default, read barriers are replaced with simple load instructions. + /// If true, then addPassesToCustomLowerIntrinsics must instead process + /// them. + bool customReadBarrier() const { return CustomReadBarriers; } + + /// By default, roots are left for the code generator. If Custom, then + /// addPassesToCustomLowerIntrinsics must add passes to delete them. + bool customRoots() const { return CustomRoots; } + + /// If set, gcroot intrinsics should initialize their allocas to null. This + /// is necessary for most collectors. + bool initializeRoots() const { return InitRoots; } + + /// If set, appropriate metadata tables must be emitted by the back-end + /// (assembler, JIT, or otherwise). + bool usesMetadata() const { return UsesMetadata; } + + /// begin/end - Iterators for function metadata. + /// + iterator begin() { return Functions.begin(); } + iterator end() { return Functions.end(); } + + /// insertFunctionMetadata - Creates metadata for a function. + /// + CollectorMetadata *insertFunctionMetadata(const Function &F); + + /// initializeCustomLowering/performCustomLowering - If any of the actions + /// are set to custom, performCustomLowering must be overriden to create a + /// transform to lower those actions to LLVM IR. initializeCustomLowering + /// is optional to override. These are the only Collector methods through + /// which the LLVM IR can be modified. + virtual bool initializeCustomLowering(Module &F); + virtual bool performCustomLowering(Function &F); + }; + + // GCMetadataPrinter - Emits GC metadata as assembly code. + class GCMetadataPrinter { + public: + typedef Collector::list_type list_type; + typedef Collector::iterator iterator; + + private: + Collector *Coll; + + friend class AsmPrinter; + + protected: + // May only be subclassed. + GCMetadataPrinter(); + + // Do not implement. + GCMetadataPrinter(const GCMetadataPrinter &); + GCMetadataPrinter &operator=(const GCMetadataPrinter &); + + public: + Collector &getCollector() { return *Coll; } + const Module &getModule() const { return Coll->getModule(); } + + iterator begin() { return Coll->begin(); } + iterator end() { return Coll->end(); } + + /// beginAssembly/finishAssembly - Emit module metadata as assembly code. + virtual void beginAssembly(std::ostream &OS, AsmPrinter &AP, + const TargetAsmInfo &TAI); + + virtual void finishAssembly(std::ostream &OS, AsmPrinter &AP, + const TargetAsmInfo &TAI); + + virtual ~GCMetadataPrinter(); + }; + +} + +#endif diff --git a/include/llvm/CodeGen/Collectors.h b/include/llvm/CodeGen/GCs.h similarity index 89% rename from include/llvm/CodeGen/Collectors.h rename to include/llvm/CodeGen/GCs.h index 1658da1489a..7850ddcd826 100644 --- a/include/llvm/CodeGen/Collectors.h +++ b/include/llvm/CodeGen/GCs.h @@ -12,8 +12,8 @@ // //===----------------------------------------------------------------------===// -#ifndef LLVM_CODEGEN_COLLECTORS_H -#define LLVM_CODEGEN_COLLECTORS_H +#ifndef LLVM_CODEGEN_GCS_H +#define LLVM_CODEGEN_GCS_H #include "llvm/Support/Registry.h" @@ -36,6 +36,9 @@ namespace llvm { /// Creates an ocaml-compatible garbage collector. Collector *createOcamlCollector(); + /// Creates an ocaml-compatible metadata printer. + GCMetadataPrinter *createOcamlMetadataPrinter(); + /// Creates a shadow stack garbage collector. This collector requires no code /// generator support. Collector *createShadowStackCollector(); diff --git a/include/llvm/CodeGen/LinkAllCodegenComponents.h b/include/llvm/CodeGen/LinkAllCodegenComponents.h index 39df7337baa..8f2e5c1ae80 100644 --- a/include/llvm/CodeGen/LinkAllCodegenComponents.h +++ b/include/llvm/CodeGen/LinkAllCodegenComponents.h @@ -17,7 +17,7 @@ #include "llvm/CodeGen/Passes.h" #include "llvm/CodeGen/ScheduleDAG.h" -#include "llvm/CodeGen/Collectors.h" +#include "llvm/CodeGen/GCs.h" namespace { struct ForceCodegenLinking { @@ -37,6 +37,7 @@ namespace { (void) llvm::createSimpleRegisterCoalescer(); (void) llvm::createOcamlCollector(); + (void) llvm::createOcamlMetadataPrinter(); (void) llvm::createShadowStackCollector(); (void) llvm::createBURRListDAGScheduler(NULL, NULL, NULL, false); diff --git a/lib/CodeGen/AsmPrinter.cpp b/lib/CodeGen/AsmPrinter.cpp index 3b2dcb31d29..de31840d703 100644 --- a/lib/CodeGen/AsmPrinter.cpp +++ b/lib/CodeGen/AsmPrinter.cpp @@ -16,9 +16,9 @@ #include "llvm/DerivedTypes.h" #include "llvm/Constants.h" #include "llvm/Module.h" -#include "llvm/CodeGen/Collector.h" -#include "llvm/CodeGen/CollectorMetadata.h" -#include "llvm/CodeGen/Collectors.h" +#include "llvm/CodeGen/GCStrategy.h" +#include "llvm/CodeGen/GCMetadata.h" +#include "llvm/CodeGen/GCs.h" #include "llvm/CodeGen/MachineConstantPool.h" #include "llvm/CodeGen/MachineJumpTableInfo.h" #include "llvm/CodeGen/MachineModuleInfo.h" diff --git a/lib/CodeGen/CollectorMetadata.cpp b/lib/CodeGen/GCMetadata.cpp similarity index 98% rename from lib/CodeGen/CollectorMetadata.cpp rename to lib/CodeGen/GCMetadata.cpp index 5b8c7c79996..c02a73b7080 100644 --- a/lib/CodeGen/CollectorMetadata.cpp +++ b/lib/CodeGen/GCMetadata.cpp @@ -12,9 +12,9 @@ // //===----------------------------------------------------------------------===// -#include "llvm/CodeGen/CollectorMetadata.h" -#include "llvm/CodeGen/Collector.h" -#include "llvm/CodeGen/Collectors.h" +#include "llvm/CodeGen/GCMetadata.h" +#include "llvm/CodeGen/GCStrategy.h" +#include "llvm/CodeGen/GCs.h" #include "llvm/CodeGen/MachineFrameInfo.h" #include "llvm/Pass.h" #include "llvm/CodeGen/Passes.h" diff --git a/lib/CodeGen/GCMetadataPrinter.cpp b/lib/CodeGen/GCMetadataPrinter.cpp new file mode 100644 index 00000000000..b16d873520a --- /dev/null +++ b/lib/CodeGen/GCMetadataPrinter.cpp @@ -0,0 +1,31 @@ +//===-- Collector.cpp - Garbage collection infrastructure -----------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// This file implements target- and collector-independent garbage collection +// infrastructure. +// +//===----------------------------------------------------------------------===// + +#include "llvm/CodeGen/GCStrategy.h" + +using namespace llvm; + +GCMetadataPrinter::GCMetadataPrinter() { } + +GCMetadataPrinter::~GCMetadataPrinter() { } + +void GCMetadataPrinter::beginAssembly(std::ostream &OS, AsmPrinter &AP, + const TargetAsmInfo &TAI) { + // Default is no action. +} + +void GCMetadataPrinter::finishAssembly(std::ostream &OS, AsmPrinter &AP, + const TargetAsmInfo &TAI) { + // Default is no action. +} diff --git a/lib/CodeGen/Collector.cpp b/lib/CodeGen/GCStrategy.cpp similarity index 95% rename from lib/CodeGen/Collector.cpp rename to lib/CodeGen/GCStrategy.cpp index 6fd018961a4..629a2e13dee 100644 --- a/lib/CodeGen/Collector.cpp +++ b/lib/CodeGen/GCStrategy.cpp @@ -12,12 +12,10 @@ // //===----------------------------------------------------------------------===// -#include "llvm/CodeGen/Collector.h" +#include "llvm/CodeGen/GCStrategy.h" #include "llvm/CodeGen/Passes.h" #include "llvm/IntrinsicInst.h" #include "llvm/Module.h" -#include "llvm/PassManager.h" -#include "llvm/ADT/SmallPtrSet.h" #include "llvm/CodeGen/MachineFrameInfo.h" #include "llvm/CodeGen/MachineFunctionPass.h" #include "llvm/CodeGen/MachineInstrBuilder.h" @@ -119,22 +117,6 @@ CollectorMetadata *Collector::insertFunctionMetadata(const Function &F) { // ----------------------------------------------------------------------------- -GCMetadataPrinter::GCMetadataPrinter() { } - -GCMetadataPrinter::~GCMetadataPrinter() { } - -void GCMetadataPrinter::beginAssembly(std::ostream &OS, AsmPrinter &AP, - const TargetAsmInfo &TAI) { - // Default is no action. -} - -void GCMetadataPrinter::finishAssembly(std::ostream &OS, AsmPrinter &AP, - const TargetAsmInfo &TAI) { - // Default is no action. -} - -// ----------------------------------------------------------------------------- - FunctionPass *llvm::createGCLoweringPass() { return new LowerIntrinsics(); } diff --git a/lib/CodeGen/Collectors.cpp b/lib/CodeGen/GCs.cpp similarity index 96% rename from lib/CodeGen/Collectors.cpp rename to lib/CodeGen/GCs.cpp index 3b0c554daf9..124725358e2 100644 --- a/lib/CodeGen/Collectors.cpp +++ b/lib/CodeGen/GCs.cpp @@ -11,7 +11,7 @@ // //===----------------------------------------------------------------------===// -#include "llvm/CodeGen/Collectors.h" +#include "llvm/CodeGen/GCs.h" using namespace llvm; diff --git a/lib/CodeGen/LLVMTargetMachine.cpp b/lib/CodeGen/LLVMTargetMachine.cpp index 97fe35c2f4b..d420ffb7d97 100644 --- a/lib/CodeGen/LLVMTargetMachine.cpp +++ b/lib/CodeGen/LLVMTargetMachine.cpp @@ -17,7 +17,7 @@ #include "llvm/Assembly/PrintModulePass.h" #include "llvm/Analysis/LoopPass.h" #include "llvm/CodeGen/Passes.h" -#include "llvm/CodeGen/Collector.h" +#include "llvm/CodeGen/GCStrategy.h" #include "llvm/Target/TargetOptions.h" #include "llvm/Target/TargetAsmInfo.h" #include "llvm/Transforms/Scalar.h" diff --git a/lib/CodeGen/OcamlGC.cpp b/lib/CodeGen/OcamlGC.cpp new file mode 100644 index 00000000000..88499cbd668 --- /dev/null +++ b/lib/CodeGen/OcamlGC.cpp @@ -0,0 +1,46 @@ +//===-- OcamlCollector.cpp - Ocaml frametable emitter ---------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// This file implements lowering for the llvm.gc* intrinsics compatible with +// Objective Caml 3.10.0, which uses a liveness-accurate static stack map. +// +//===----------------------------------------------------------------------===// + +#include "llvm/CodeGen/GCs.h" +#include "llvm/CodeGen/AsmPrinter.h" +#include "llvm/CodeGen/GCStrategy.h" +#include "llvm/Module.h" +#include "llvm/Target/TargetAsmInfo.h" +#include "llvm/Target/TargetData.h" +#include "llvm/Target/TargetMachine.h" + +using namespace llvm; + +namespace { + + class VISIBILITY_HIDDEN OcamlCollector : public Collector { + public: + OcamlCollector(); + }; + +} + +static CollectorRegistry::Add +X("ocaml", "ocaml 3.10-compatible collector"); + +// ----------------------------------------------------------------------------- + +Collector *llvm::createOcamlCollector() { + return new OcamlCollector(); +} + +OcamlCollector::OcamlCollector() { + NeededSafePoints = 1 << GC::PostCall; + UsesMetadata = true; +} diff --git a/lib/CodeGen/OcamlCollector.cpp b/lib/CodeGen/OcamlGCPrinter.cpp similarity index 91% rename from lib/CodeGen/OcamlCollector.cpp rename to lib/CodeGen/OcamlGCPrinter.cpp index 7f58f58c29b..efa7f672769 100644 --- a/lib/CodeGen/OcamlCollector.cpp +++ b/lib/CodeGen/OcamlGCPrinter.cpp @@ -12,9 +12,9 @@ // //===----------------------------------------------------------------------===// -#include "llvm/CodeGen/Collectors.h" +#include "llvm/CodeGen/GCs.h" #include "llvm/CodeGen/AsmPrinter.h" -#include "llvm/CodeGen/Collector.h" +#include "llvm/CodeGen/GCStrategy.h" #include "llvm/Module.h" #include "llvm/Target/TargetAsmInfo.h" #include "llvm/Target/TargetData.h" @@ -24,11 +24,6 @@ using namespace llvm; namespace { - class VISIBILITY_HIDDEN OcamlCollector : public Collector { - public: - OcamlCollector(); - }; - class VISIBILITY_HIDDEN OcamlGCMetadataPrinter : public GCMetadataPrinter { public: void beginAssembly(std::ostream &OS, AsmPrinter &AP, @@ -40,13 +35,12 @@ namespace { } -static CollectorRegistry::Add -X("ocaml", "ocaml 3.10-compatible collector"); - static GCMetadataPrinterRegistry::Add Y("ocaml", "ocaml 3.10-compatible collector"); -// ----------------------------------------------------------------------------- +GCMetadataPrinter *llvm::createOcamlMetadataPrinter() { + return new OcamlGCMetadataPrinter(); +} static void EmitCamlGlobal(const Module &M, std::ostream &OS, AsmPrinter &AP, const TargetAsmInfo &TAI, const char *Id) { @@ -68,15 +62,6 @@ static void EmitCamlGlobal(const Module &M, std::ostream &OS, AsmPrinter &AP, OS << Mangled << ":\n"; } -Collector *llvm::createOcamlCollector() { - return new OcamlCollector(); -} - -OcamlCollector::OcamlCollector() { - NeededSafePoints = 1 << GC::PostCall; - UsesMetadata = true; -} - void OcamlGCMetadataPrinter::beginAssembly(std::ostream &OS, AsmPrinter &AP, const TargetAsmInfo &TAI) { AP.SwitchToTextSection(TAI.getTextSection()); diff --git a/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp b/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp index 815fdb7cc74..012e7d0992a 100644 --- a/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp +++ b/lib/CodeGen/SelectionDAG/SelectionDAGISel.cpp @@ -26,7 +26,7 @@ #include "llvm/Intrinsics.h" #include "llvm/IntrinsicInst.h" #include "llvm/ParameterAttributes.h" -#include "llvm/CodeGen/Collector.h" +#include "llvm/CodeGen/GCStrategy.h" #include "llvm/CodeGen/MachineFunction.h" #include "llvm/CodeGen/MachineFrameInfo.h" #include "llvm/CodeGen/MachineInstrBuilder.h" diff --git a/lib/CodeGen/ShadowStackCollector.cpp b/lib/CodeGen/ShadowStackGC.cpp similarity index 99% rename from lib/CodeGen/ShadowStackCollector.cpp rename to lib/CodeGen/ShadowStackGC.cpp index 4d275a6eb91..850c00542ce 100644 --- a/lib/CodeGen/ShadowStackCollector.cpp +++ b/lib/CodeGen/ShadowStackGC.cpp @@ -26,9 +26,9 @@ //===----------------------------------------------------------------------===// #define DEBUG_TYPE "shadowstackgc" -#include "llvm/CodeGen/Collectors.h" +#include "llvm/CodeGen/GCs.h" #include "llvm/ADT/StringExtras.h" -#include "llvm/CodeGen/Collector.h" +#include "llvm/CodeGen/GCStrategy.h" #include "llvm/IntrinsicInst.h" #include "llvm/Module.h" #include "llvm/Support/IRBuilder.h" -- 2.34.1