Compiler.h revision 5b7f52aff2030d520ee2ac6d3ac7d917f38d550c 
1/*
2 * Copyright 2010-2012, The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef BCC_COMPILER_H
18#define BCC_COMPILER_H
19
20namespace llvm {
21
22class raw_ostream;
23class PassManager;
24class DataLayout;
25class TargetMachine;
26
27} // end namespace llvm
28
29namespace bcc {
30
31class CompilerConfig;
32class OutputFile;
33class Script;
34
35//===----------------------------------------------------------------------===//
36// Design of Compiler
37//===----------------------------------------------------------------------===//
38// 1. A compiler instance can be constructed provided an "initial config."
39// 2. A compiler can later be re-configured using config().
40// 3. Once config() is invoked, it'll re-create TargetMachine instance (i.e.,
41//    mTarget) according to the configuration supplied. TargetMachine instance
42//    is *shared* across the different calls to compile() before the next call
43//    to config().
44// 4. Once a compiler instance is created, you can use the compile() service
45//    to compile the file over and over again. Each call uses TargetMachine
46//    instance to construct the compilation passes.
47class Compiler {
48public:
49  enum ErrorCode {
50    kSuccess,
51
52    kInvalidConfigNoTarget,
53    kErrCreateTargetMachine,
54    kErrSwitchTargetMachine,
55    kErrNoTargetMachine,
56    kErrDataLayoutNoMemory,
57    kErrMaterialization,
58    kErrInvalidOutputFileState,
59    kErrPrepareOutput,
60    kPrepareCodeGenPass,
61
62    kErrHookBeforeAddLTOPasses,
63    kErrHookAfterAddLTOPasses,
64    kErrHookBeforeExecuteLTOPasses,
65    kErrHookAfterExecuteLTOPasses,
66
67    kErrHookBeforeAddCodeGenPasses,
68    kErrHookAfterAddCodeGenPasses,
69    kErrHookBeforeExecuteCodeGenPasses,
70    kErrHookAfterExecuteCodeGenPasses,
71
72    kErrInvalidSource
73  };
74
75  static const char *GetErrorString(enum ErrorCode pErrCode);
76
77private:
78  llvm::TargetMachine *mTarget;
79  // LTO is enabled by default.
80  bool mEnableLTO;
81
82  enum ErrorCode runLTO(Script &pScript);
83  enum ErrorCode runCodeGen(Script &pScript, llvm::raw_ostream &pResult);
84
85public:
86  Compiler();
87  Compiler(const CompilerConfig &pConfig);
88
89  enum ErrorCode config(const CompilerConfig &pConfig);
90
91  // Compile a script and output the result to a LLVM stream.
92  //
93  // @param IRStream If not NULL, the LLVM-IR that is fed to code generation
94  //                 will be written to IRStream.
95  enum ErrorCode compile(Script &pScript, llvm::raw_ostream &pResult,
96                         llvm::raw_ostream *IRStream);
97
98  // Compile a script and output the result to a file.
99  enum ErrorCode compile(Script &pScript, OutputFile &pResult,
100                         llvm::raw_ostream *IRStream = 0);
101
102  const llvm::TargetMachine& getTargetMachine() const
103  { return *mTarget; }
104
105  void enableLTO(bool pEnable = true)
106  { mEnableLTO = pEnable; }
107
108  virtual ~Compiler();
109
110protected:
111  //===--------------------------------------------------------------------===//
112  // Plugin callbacks for sub-class.
113  //===--------------------------------------------------------------------===//
114  // Called before adding first pass to code-generation passes.
115  virtual bool beforeAddLTOPasses(Script &pScript, llvm::PassManager &pPM)
116  { return true; }
117
118  // Called after adding last pass to code-generation passes.
119  virtual bool afterAddLTOPasses(Script &pScript, llvm::PassManager &pPM)
120  { return true; }
121
122  // Called before executing code-generation passes.
123  virtual bool beforeExecuteLTOPasses(Script &pScript,
124                                          llvm::PassManager &pPM)
125  { return true; }
126
127  // Called after executing code-generation passes.
128  virtual bool afterExecuteLTOPasses(Script &pScript)
129  { return true; }
130
131  // Called before adding first pass to code-generation passes.
132  virtual bool beforeAddCodeGenPasses(Script &pScript, llvm::PassManager &pPM)
133  { return true; }
134
135  // Called after adding last pass to code-generation passes.
136  virtual bool afterAddCodeGenPasses(Script &pScript, llvm::PassManager &pPM)
137  { return true; }
138
139  // Called before executing code-generation passes.
140  virtual bool beforeExecuteCodeGenPasses(Script &pScript,
141                                          llvm::PassManager &pPM)
142  { return true; }
143
144  // Called after executing code-generation passes.
145  virtual bool afterExecuteCodeGenPasses(Script &pScript)
146  { return true; }
147};
148
149} // end namespace bcc
150
151#endif // BCC_COMPILER_H
152