clang 18.0.0git
CodeGenAction.h
Go to the documentation of this file.
1//===--- CodeGenAction.h - LLVM Code Generation Frontend Action -*- 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#ifndef LLVM_CLANG_CODEGEN_CODEGENACTION_H
10#define LLVM_CLANG_CODEGEN_CODEGENACTION_H
11
13#include <memory>
14
15namespace llvm {
16 class LLVMContext;
17 class Module;
18}
19
20namespace clang {
21class BackendConsumer;
22class CodeGenerator;
23
25private:
26 // Let BackendConsumer access LinkModule.
27 friend class BackendConsumer;
28
29 /// Info about module to link into a module we're generating.
30 struct LinkModule {
31 /// The module to link in.
32 std::unique_ptr<llvm::Module> Module;
33
34 /// If true, we set attributes on Module's functions according to our
35 /// CodeGenOptions and LangOptions, as though we were generating the
36 /// function ourselves.
37 bool PropagateAttrs;
38
39 /// If true, we use LLVM module internalizer.
40 bool Internalize;
41
42 /// Bitwise combination of llvm::LinkerFlags used when we link the module.
43 unsigned LinkFlags;
44 };
45
46 unsigned Act;
47 std::unique_ptr<llvm::Module> TheModule;
48
49 /// Bitcode modules to link in to our module.
51 llvm::LLVMContext *VMContext;
52 bool OwnsVMContext;
53
54 std::unique_ptr<llvm::Module> loadModule(llvm::MemoryBufferRef MBRef);
55
56 /// Load bitcode modules to link into our module from the options.
57 bool loadLinkModules(CompilerInstance &CI);
58
59protected:
60 /// Create a new code generation action. If the optional \p _VMContext
61 /// parameter is supplied, the action uses it without taking ownership,
62 /// otherwise it creates a fresh LLVM context and takes ownership.
63 CodeGenAction(unsigned _Act, llvm::LLVMContext *_VMContext = nullptr);
64
65 bool hasIRSupport() const override;
66
67 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
68 StringRef InFile) override;
69
70 void ExecuteAction() override;
71
72 void EndSourceFileAction() override;
73
74public:
75 ~CodeGenAction() override;
76
77 /// Take the generated LLVM module, for use after the action has been run.
78 /// The result may be null on failure.
79 std::unique_ptr<llvm::Module> takeModule();
80
81 /// Take the LLVM context used by this action.
82 llvm::LLVMContext *takeLLVMContext();
83
85
87};
88
90 virtual void anchor();
91public:
92 EmitAssemblyAction(llvm::LLVMContext *_VMContext = nullptr);
93};
94
96 virtual void anchor();
97public:
98 EmitBCAction(llvm::LLVMContext *_VMContext = nullptr);
99};
100
102 virtual void anchor();
103public:
104 EmitLLVMAction(llvm::LLVMContext *_VMContext = nullptr);
105};
106
108 virtual void anchor();
109public:
110 EmitLLVMOnlyAction(llvm::LLVMContext *_VMContext = nullptr);
111};
112
114 virtual void anchor();
115public:
116 EmitCodeGenOnlyAction(llvm::LLVMContext *_VMContext = nullptr);
117};
118
120 virtual void anchor();
121public:
122 EmitObjAction(llvm::LLVMContext *_VMContext = nullptr);
123};
124
125}
126
127#endif
Defines the clang::FrontendAction interface and various convenience abstract classes (clang::ASTFront...
Abstract base class to use for AST consumer-based frontend actions.
std::unique_ptr< ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
CodeGenerator * getCodeGenerator() const
void EndSourceFileAction() override
Callback at the end of processing a single input.
llvm::LLVMContext * takeLLVMContext()
Take the LLVM context used by this action.
BackendConsumer * BEConsumer
Definition: CodeGenAction.h:86
bool hasIRSupport() const override
Does this action support use with IR files?
void ExecuteAction() override
Callback to run the program action, using the initialized compiler instance.
std::unique_ptr< llvm::Module > takeModule()
Take the generated LLVM module, for use after the action has been run.
The primary public interface to the Clang code generator.
Definition: ModuleBuilder.h:48
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
Describes a module or submodule.
Definition: Module.h:104
YAML serialization mapping.
Definition: Dominators.h:30