GCMetadataPrinter.h

Go to the documentation of this file.

1//===- llvm/CodeGen/GCMetadataPrinter.h - Prints asm GC tables --*- C++ -*-===//

2//

3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

4// See https://llvm.org/LICENSE.txt for license information.

5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

6//

7//===----------------------------------------------------------------------===//

8//

9// The abstract base class GCMetadataPrinter supports writing GC metadata tables

10// as assembly code. This is a separate class from GCStrategy in order to allow

11// users of the LLVM JIT to avoid linking with the AsmWriter.

12//

13// Subclasses of GCMetadataPrinter must be registered using the

14// GCMetadataPrinterRegistry. This is separate from the GCStrategy itself

15// because these subclasses are logically plugins for the AsmWriter.

16//

17//===----------------------------------------------------------------------===//

18

19#ifndef LLVM_CODEGEN_GCMETADATAPRINTER_H

20#define LLVM_CODEGEN_GCMETADATAPRINTER_H

21

22#include "llvm/Support/Registry.h"

23

24namespace llvm {

25

26class AsmPrinter;

27class GCMetadataPrinter;

28class GCModuleInfo;

29class GCStrategy;

30class Module;

31class StackMaps;

32

33/// GCMetadataPrinterRegistry - The GC assembly printer registry uses all the

34/// defaults from Registry.

35 using GCMetadataPrinterRegistry = Registry<GCMetadataPrinter>;

36

37extern template class LLVM_TEMPLATE_ABI Registry<GCMetadataPrinter>;

38

39/// GCMetadataPrinter - Emits GC metadata as assembly code. Instances are

40/// created, managed, and owned by the AsmPrinter.

41 class GCMetadataPrinter {

42private:

43 friend class AsmPrinter;

44

45 GCStrategy *S;

46

47protected:

48 // May only be subclassed.

49 GCMetadataPrinter();

50

51public:

52 GCMetadataPrinter(const GCMetadataPrinter &) = delete;

53 GCMetadataPrinter &operator=(const GCMetadataPrinter &) = delete;

54 virtual ~GCMetadataPrinter();

55

56 GCStrategy &getStrategy() { return *S; }

57

58 /// Called before the assembly for the module is generated by

59 /// the AsmPrinter (but after target specific hooks.)

60 virtual void beginAssembly(Module &M, GCModuleInfo &Info, AsmPrinter &AP) {}

61

62 /// Called after the assembly for the module is generated by

63 /// the AsmPrinter (but before target specific hooks)

64 virtual void finishAssembly(Module &M, GCModuleInfo &Info, AsmPrinter &AP) {}

65

66 /// Called when the stack maps are generated. Return true if

67 /// stack maps with a custom format are generated. Otherwise

68 /// returns false and the default format will be used.

69 virtual bool emitStackMaps(StackMaps &SM, AsmPrinter &AP) { return false; }

70};

71

72} // end namespace llvm

73

74#endif // LLVM_CODEGEN_GCMETADATAPRINTER_H

Info

Analysis containing CSE Info

Definition CSEInfo.cpp:27

LLVM_TEMPLATE_ABI

#define LLVM_TEMPLATE_ABI

Definition Compiler.h:214

Registry.h

llvm::AsmPrinter

This class is intended to be used as a driving class for all asm writers.

Definition AsmPrinter.h:96

llvm::GCMetadataPrinter

GCMetadataPrinter - Emits GC metadata as assembly code.

Definition GCMetadataPrinter.h:41

llvm::GCMetadataPrinter::getStrategy

GCStrategy & getStrategy()

Definition GCMetadataPrinter.h:56

llvm::GCMetadataPrinter::~GCMetadataPrinter

virtual ~GCMetadataPrinter()

llvm::GCMetadataPrinter::finishAssembly

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...

Definition GCMetadataPrinter.h:64

llvm::GCMetadataPrinter::beginAssembly

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...

Definition GCMetadataPrinter.h:60

llvm::GCMetadataPrinter::AsmPrinter

friend class AsmPrinter

Definition GCMetadataPrinter.h:43

llvm::GCMetadataPrinter::GCMetadataPrinter

GCMetadataPrinter(const GCMetadataPrinter &)=delete

llvm::GCMetadataPrinter::emitStackMaps

virtual bool emitStackMaps(StackMaps &SM, AsmPrinter &AP)

Called when the stack maps are generated.

Definition GCMetadataPrinter.h:69

llvm::GCMetadataPrinter::operator=

GCMetadataPrinter & operator=(const GCMetadataPrinter &)=delete

llvm::GCMetadataPrinter::GCMetadataPrinter

GCMetadataPrinter()

llvm::GCModuleInfo

An analysis pass which caches information about the entire Module.

Definition GCMetadata.h:237

llvm::GCStrategy

GCStrategy describes a garbage collector algorithm's code generation requirements,...

Definition GCStrategy.h:64

llvm::Module

A Module instance is used to store all the information related to an LLVM module.

Definition Module.h:67

llvm::Registry

A global registry used in conjunction with static constructors to make pluggable components (like tar...

Definition Registry.h:44

llvm::StackMaps

Definition StackMaps.h:260

llvm

This is an optimization pass for GlobalISel generic memory operations.

Definition AddressRanges.h:18

llvm::GCMetadataPrinterRegistry

Registry< GCMetadataPrinter > GCMetadataPrinterRegistry

GCMetadataPrinterRegistry - The GC assembly printer registry uses all the defaults from Registry.

Definition GCMetadataPrinter.h:35

Generated on for LLVM by doxygen 1.14.0

LLVM: include/llvm/CodeGen/GCMetadataPrinter.h Source File