LLVM  8.0.0svn
GCMetadataPrinter.h
Go to the documentation of this file.
1 //===- llvm/CodeGen/GCMetadataPrinter.h - Prints asm GC tables --*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // The abstract base class GCMetadataPrinter supports writing GC metadata tables
11 // as assembly code. This is a separate class from GCStrategy in order to allow
12 // users of the LLVM JIT to avoid linking with the AsmWriter.
13 //
14 // Subclasses of GCMetadataPrinter must be registered using the
15 // GCMetadataPrinterRegistry. This is separate from the GCStrategy itself
16 // because these subclasses are logically plugins for the AsmWriter.
17 //
18 //===----------------------------------------------------------------------===//
19 
20 #ifndef LLVM_CODEGEN_GCMETADATAPRINTER_H
21 #define LLVM_CODEGEN_GCMETADATAPRINTER_H
22 
23 #include "llvm/Support/Registry.h"
24 
25 namespace llvm {
26 
27 class AsmPrinter;
28 class GCMetadataPrinter;
29 class GCModuleInfo;
30 class GCStrategy;
31 class Module;
32 class StackMaps;
33 
34 /// GCMetadataPrinterRegistry - The GC assembly printer registry uses all the
35 /// defaults from Registry.
37 
38 /// GCMetadataPrinter - Emits GC metadata as assembly code. Instances are
39 /// created, managed, and owned by the AsmPrinter.
41 private:
42  friend class AsmPrinter;
43 
44  GCStrategy *S;
45 
46 protected:
47  // May only be subclassed.
49 
50 public:
51  GCMetadataPrinter(const GCMetadataPrinter &) = delete;
53  virtual ~GCMetadataPrinter();
54 
55  GCStrategy &getStrategy() { return *S; }
56 
57  /// Called before the assembly for the module is generated by
58  /// the AsmPrinter (but after target specific hooks.)
59  virtual void beginAssembly(Module &M, GCModuleInfo &Info, AsmPrinter &AP) {}
60 
61  /// Called after the assembly for the module is generated by
62  /// the AsmPrinter (but before target specific hooks)
63  virtual void finishAssembly(Module &M, GCModuleInfo &Info, AsmPrinter &AP) {}
64 
65  /// Called when the stack maps are generated. Return true if
66  /// stack maps with a custom format are generated. Otherwise
67  /// returns false and the default format will be used.
68  virtual bool emitStackMaps(StackMaps &SM, AsmPrinter &AP) { return false; }
69 };
70 
71 } // end namespace llvm
72 
73 #endif // LLVM_CODEGEN_GCMETADATAPRINTER_H
GCMetadataPrinter & operator=(const GCMetadataPrinter &)=delete
This class represents lattice values for constants.
Definition: AllocatorList.h:24
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
A global registry used in conjunction with static constructors to make pluggable components (like tar...
Definition: Registry.h:45
An analysis pass which caches information about the entire Module.
Definition: GCMetadata.h:153
virtual void finishAssembly(Module &M, GCModuleInfo &Info, AsmPrinter &AP)
Called after the assembly for the module is generated by the AsmPrinter (but before target specific h...
virtual bool emitStackMaps(StackMaps &SM, AsmPrinter &AP)
Called when the stack maps are generated.
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:79
GCStrategy describes a garbage collector algorithm's code generation requirements, and provides overridable hooks for those needs which cannot be abstractly described.
Definition: GCStrategy.h:67
virtual void beginAssembly(Module &M, GCModuleInfo &Info, AsmPrinter &AP)
Called before the assembly for the module is generated by the AsmPrinter (but after target specific h...
GCMetadataPrinter - Emits GC metadata as assembly code.