1 /*
2 * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
3 * Copyright 2008, 2009, 2010, 2011 Red Hat, Inc.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #include "precompiled.hpp"
27 #include "ci/ciEnv.hpp"
28 #include "ci/ciMethod.hpp"
29 #include "code/debugInfoRec.hpp"
30 #include "code/dependencies.hpp"
31 #include "code/exceptionHandlerTable.hpp"
32 #include "code/oopRecorder.hpp"
33 #include "compiler/abstractCompiler.hpp"
34 #include "compiler/oopMap.hpp"
35 #include "shark/llvmHeaders.hpp"
36 #include "shark/sharkBuilder.hpp"
37 #include "shark/sharkCodeBuffer.hpp"
38 #include "shark/sharkCompiler.hpp"
39 #include "shark/sharkContext.hpp"
40 #include "shark/sharkEntry.hpp"
41 #include "shark/sharkFunction.hpp"
42 #include "shark/sharkMemoryManager.hpp"
43 #include "shark/sharkNativeWrapper.hpp"
44 #include "shark/shark_globals.hpp"
45 #include "utilities/debug.hpp"
46
47 #include <fnmatch.h>
48
49 using namespace llvm;
50
51 namespace {
52 cl::opt<std::string>
53 MCPU("mcpu");
54
55 cl::list<std::string>
56 MAttrs("mattr",
57 cl::CommaSeparated);
58 }
59
60 SharkCompiler::SharkCompiler()
61 : AbstractCompiler() {
62 // Create the lock to protect the memory manager and execution engine
63 _execution_engine_lock = new Monitor(Mutex::leaf, "SharkExecutionEngineLock");
64 MutexLocker locker(execution_engine_lock());
65
66 // Make LLVM safe for multithreading
67 if (!llvm_start_multithreaded())
68 fatal("llvm_start_multithreaded() failed");
69
70 // Initialize the native target
71 InitializeNativeTarget();
72
73 // MCJIT require a native AsmPrinter
74 InitializeNativeTargetAsmPrinter();
75
76 // Create the two contexts which we'll use
77 _normal_context = new SharkContext("normal");
78 _native_context = new SharkContext("native");
79
80 // Create the memory manager
81 _memory_manager = new SharkMemoryManager();
82
83 // Finetune LLVM for the current host CPU.
84 StringMap<bool> Features;
85 bool gotCpuFeatures = llvm::sys::getHostCPUFeatures(Features);
86 std::string cpu("-mcpu=" + llvm::sys::getHostCPUName());
87
88 std::vector<const char*> args;
89 args.push_back(""); // program name
90 args.push_back(cpu.c_str());
91
92 std::string mattr("-mattr=");
93 if(gotCpuFeatures){
94 for(StringMap<bool>::iterator I = Features.begin(),
95 E = Features.end(); I != E; ++I){
96 if(I->second){
97 std::string attr(I->first());
98 mattr+="+"+attr+",";
99 }
100 }
101 args.push_back(mattr.c_str());
102 }
103
104 args.push_back(0); // terminator
105 cl::ParseCommandLineOptions(args.size() - 1, (char **) &args[0]);
106
107 // Create the JIT
108 std::string ErrorMsg;
109
110 EngineBuilder builder(_normal_context->module());
111 builder.setMCPU(MCPU);
112 builder.setMAttrs(MAttrs);
113 builder.setJITMemoryManager(memory_manager());
114 builder.setEngineKind(EngineKind::JIT);
115 builder.setErrorStr(&ErrorMsg);
116 _execution_engine = builder.create();
117
118 if (!execution_engine()) {
119 if (!ErrorMsg.empty())
120 printf("Error while creating Shark JIT: %s\n",ErrorMsg.c_str());
121 else
122 printf("Unknown error while creating Shark JIT\n");
123 exit(1);
124 }
125
126 execution_engine()->addModule(
127 _native_context->module());
128
129 // All done
130 mark_initialized();
131 }
132
133 void SharkCompiler::initialize() {
134 ShouldNotCallThis();
135 }
136
137 void SharkCompiler::compile_method(ciEnv* env,
138 ciMethod* target,
139 int entry_bci) {
140 assert(is_initialized(), "should be");
141 ResourceMark rm;
142 const char *name = methodname(
143 target->holder()->name()->as_utf8(), target->name()->as_utf8());
144
145 // Do the typeflow analysis
146 ciTypeFlow *flow;
147 if (entry_bci == InvocationEntryBci)
148 flow = target->get_flow_analysis();
149 else
150 flow = target->get_osr_flow_analysis(entry_bci);
151 if (flow->failing())
152 return;
153 if (SharkPrintTypeflowOf != NULL) {
154 if (!fnmatch(SharkPrintTypeflowOf, name, 0))
155 flow->print_on(tty);
156 }
157
158 // Create the recorders
159 Arena arena;
160 env->set_oop_recorder(new OopRecorder(&arena));
161 OopMapSet oopmaps;
162 env->set_debug_info(new DebugInformationRecorder(env->oop_recorder()));
163 env->debug_info()->set_oopmaps(&oopmaps);
164 env->set_dependencies(new Dependencies(env));
165
166 // Create the code buffer and builder
167 CodeBuffer hscb("Shark", 256 * K, 64 * K);
168 hscb.initialize_oop_recorder(env->oop_recorder());
169 MacroAssembler *masm = new MacroAssembler(&hscb);
170 SharkCodeBuffer cb(masm);
171 SharkBuilder builder(&cb);
172
173 // Emit the entry point
174 SharkEntry *entry = (SharkEntry *) cb.malloc(sizeof(SharkEntry));
175
176 // Build the LLVM IR for the method
177 Function *function = SharkFunction::build(env, &builder, flow, name);
178 if (SharkVerifyFunctions) {
179 verifyFunction(*function);
180 }
181
182 // Generate native code. It's unpleasant that we have to drop into
183 // the VM to do this -- it blocks safepoints -- but I can't see any
184 // other way to handle the locking.
185 {
186 ThreadInVMfromNative tiv(JavaThread::current());
187 generate_native_code(entry, function, name);
188 }
189
190 // Install the method into the VM
191 CodeOffsets offsets;
192 offsets.set_value(CodeOffsets::Deopt, 0);
193 offsets.set_value(CodeOffsets::Exceptions, 0);
194 offsets.set_value(CodeOffsets::Verified_Entry,
195 target->is_static() ? 0 : wordSize);
196
197 ExceptionHandlerTable handler_table;
198 ImplicitExceptionTable inc_table;
199
200 env->register_method(target,
201 entry_bci,
202 &offsets,
203 0,
204 &hscb,
205 0,
206 &oopmaps,
207 &handler_table,
208 &inc_table,
209 this,
210 env->comp_level(),
211 false,
212 false);
213 }
214
215 nmethod* SharkCompiler::generate_native_wrapper(MacroAssembler* masm,
216 methodHandle target,
217 int compile_id,
218 BasicType* arg_types,
219 BasicType return_type) {
220 assert(is_initialized(), "should be");
221 ResourceMark rm;
222 const char *name = methodname(
223 target->klass_name()->as_utf8(), target->name()->as_utf8());
224
225 // Create the code buffer and builder
226 SharkCodeBuffer cb(masm);
227 SharkBuilder builder(&cb);
228
229 // Emit the entry point
230 SharkEntry *entry = (SharkEntry *) cb.malloc(sizeof(SharkEntry));
231
232 // Build the LLVM IR for the method
233 SharkNativeWrapper *wrapper = SharkNativeWrapper::build(
234 &builder, target, name, arg_types, return_type);
235
236 // Generate native code
237 generate_native_code(entry, wrapper->function(), name);
238
239 // Return the nmethod for installation in the VM
240 return nmethod::new_native_nmethod(target,
241 compile_id,
242 masm->code(),
243 0,
244 0,
245 wrapper->frame_size(),
246 wrapper->receiver_offset(),
247 wrapper->lock_offset(),
248 wrapper->oop_maps());
249 }
250
251 void SharkCompiler::generate_native_code(SharkEntry* entry,
252 Function* function,
253 const char* name) {
254 // Print the LLVM bitcode, if requested
255 if (SharkPrintBitcodeOf != NULL) {
256 if (!fnmatch(SharkPrintBitcodeOf, name, 0))
257 function->dump();
258 }
259
260 // Compile to native code
261 address code = NULL;
262 context()->add_function(function);
263 {
264 MutexLocker locker(execution_engine_lock());
265 free_queued_methods();
266
267 if (SharkPrintAsmOf != NULL) {
268 #ifndef NDEBUG
269 if (!fnmatch(SharkPrintAsmOf, name, 0)) {
270 llvm::SetCurrentDebugType(X86_ONLY("x86-emitter") NOT_X86("jit"));
271 llvm::DebugFlag = true;
272 }
273 else {
274 llvm::SetCurrentDebugType("");
275 llvm::DebugFlag = false;
276 }
277 #endif // !NDEBUG
278 }
279 memory_manager()->set_entry_for_function(function, entry);
280 code = (address) execution_engine()->getPointerToFunction(function);
281 }
282 assert(code != NULL, "code must be != NULL");
283 entry->set_entry_point(code);
284 entry->set_function(function);
285 entry->set_context(context());
286 address code_start = entry->code_start();
287 address code_limit = entry->code_limit();
288
289 // Register generated code for profiling, etc
290 if (JvmtiExport::should_post_dynamic_code_generated())
291 JvmtiExport::post_dynamic_code_generated(name, code_start, code_limit);
292
293 // Print debug information, if requested
294 if (SharkTraceInstalls) {
295 tty->print_cr(
296 " [%p-%p): %s (%d bytes code)",
297 code_start, code_limit, name, code_limit - code_start);
298 }
299 }
300
301 void SharkCompiler::free_compiled_method(address code) {
302 // This method may only be called when the VM is at a safepoint.
303 // All _thread_in_vm threads will be waiting for the safepoint to
304 // finish with the exception of the VM thread, so we can consider
305 // ourself the owner of the execution engine lock even though we
306 // can't actually acquire it at this time.
307 assert(Thread::current()->is_Compiler_thread(), "must be called by compiler thread");
308 assert_locked_or_safepoint(CodeCache_lock);
309
310 SharkEntry *entry = (SharkEntry *) code;
311 entry->context()->push_to_free_queue(entry->function());
312 }
313
314 void SharkCompiler::free_queued_methods() {
315 // The free queue is protected by the execution engine lock
316 assert(execution_engine_lock()->owned_by_self(), "should be");
317
318 while (true) {
319 Function *function = context()->pop_from_free_queue();
320 if (function == NULL)
321 break;
322
323 execution_engine()->freeMachineCodeForFunction(function);
324 function->eraseFromParent();
325 }
326 }
327
328 const char* SharkCompiler::methodname(const char* klass, const char* method) {
329 char *buf = NEW_RESOURCE_ARRAY(char, strlen(klass) + 2 + strlen(method) + 1);
330
331 char *dst = buf;
332 for (const char *c = klass; *c; c++) {
333 if (*c == '/')
334 *(dst++) = '.';
335 else
336 *(dst++) = *c;
337 }
338 *(dst++) = ':';
339 *(dst++) = ':';
340 for (const char *c = method; *c; c++) {
341 *(dst++) = *c;
342 }
343 *(dst++) = '\0';
344 return buf;
345 }