1 /*
  2  * Copyright (c) 1998, 2023, Oracle and/or its affiliates. All rights reserved.
  3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  4  *
  5  * This code is free software; you can redistribute it and/or modify it
  6  * under the terms of the GNU General Public License version 2 only, as
  7  * published by the Free Software Foundation.
  8  *
  9  * This code is distributed in the hope that it will be useful, but WITHOUT
 10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 12  * version 2 for more details (a copy is included in the LICENSE file that
 13  * accompanied this code).
 14  *
 15  * You should have received a copy of the GNU General Public License version
 16  * 2 along with this work; if not, write to the Free Software Foundation,
 17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 18  *
 19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 20  * or visit www.oracle.com if you need additional information or have any
 21  * questions.
 22  *
 23  */
 24 
 25 #include "precompiled.hpp"
 26 #include "compiler/compilationPolicy.hpp"
 27 #include "compiler/compileTask.hpp"
 28 #include "compiler/compileLog.hpp"
 29 #include "compiler/compileBroker.hpp"
 30 #include "compiler/compilerDirectives.hpp"
 31 #include "logging/log.hpp"
 32 #include "logging/logStream.hpp"
 33 #include "memory/resourceArea.hpp"
 34 #include "oops/klass.inline.hpp"
 35 #include "runtime/handles.inline.hpp"
 36 #include "runtime/jniHandles.hpp"
 37 #include "runtime/mutexLocker.hpp"
 38 
 39 CompileTask*  CompileTask::_task_free_list = nullptr;
 40 
 41 /**
 42  * Allocate a CompileTask, from the free list if possible.
 43  */
 44 CompileTask* CompileTask::allocate() {
 45   MutexLocker locker(CompileTaskAlloc_lock);
 46   CompileTask* task = nullptr;
 47 
 48   if (_task_free_list != nullptr) {
 49     task = _task_free_list;
 50     _task_free_list = task->next();
 51     task->set_next(nullptr);
 52   } else {
 53     task = new CompileTask();
 54     task->set_next(nullptr);
 55     task->set_is_free(true);
 56   }
 57   assert(task->is_free(), "Task must be free.");
 58   task->set_is_free(false);
 59   return task;
 60 }
 61 
 62 /**
 63 * Add a task to the free list.
 64 */
 65 void CompileTask::free(CompileTask* task) {
 66   MutexLocker locker(CompileTaskAlloc_lock);
 67   if (!task->is_free()) {
 68     assert(!task->lock()->is_locked(), "Should not be locked when freed");
 69     if ((task->_method_holder != nullptr && JNIHandles::is_weak_global_handle(task->_method_holder)) ||
 70         (task->_hot_method_holder != nullptr && JNIHandles::is_weak_global_handle(task->_hot_method_holder))) {
 71       JNIHandles::destroy_weak_global(task->_method_holder);
 72       JNIHandles::destroy_weak_global(task->_hot_method_holder);
 73     } else {
 74       JNIHandles::destroy_global(task->_method_holder);
 75       JNIHandles::destroy_global(task->_hot_method_holder);
 76     }
 77     if (task->_failure_reason_on_C_heap && task->_failure_reason != nullptr) {
 78       os::free((void*) task->_failure_reason);
 79     }
 80     task->_failure_reason = nullptr;
 81     task->_failure_reason_on_C_heap = false;
 82 
 83     task->set_is_free(true);
 84     task->set_next(_task_free_list);
 85     _task_free_list = task;
 86   }
 87 }
 88 
 89 void CompileTask::initialize(int compile_id,
 90                              const methodHandle& method,
 91                              int osr_bci,
 92                              int comp_level,
 93                              const methodHandle& hot_method,
 94                              int hot_count,
 95                              CompileTask::CompileReason compile_reason,
 96                              bool is_blocking) {
 97   assert(!_lock->is_locked(), "bad locking");
 98 
 99   Thread* thread = Thread::current();
100   _compile_id = compile_id;
101   _method = method();
102   _method_holder = JNIHandles::make_weak_global(Handle(thread, method->method_holder()->klass_holder()));
103   _osr_bci = osr_bci;
104   _is_blocking = is_blocking;
105   JVMCI_ONLY(_has_waiter = CompileBroker::compiler(comp_level)->is_jvmci();)
106   JVMCI_ONLY(_blocking_jvmci_compile_state = nullptr;)
107   _comp_level = comp_level;
108   _num_inlined_bytecodes = 0;
109 
110   _is_complete = false;
111   _is_success = false;
112 
113   _hot_method = nullptr;
114   _hot_method_holder = nullptr;
115   _hot_count = hot_count;
116   _time_queued = os::elapsed_counter();
117   _time_started = 0;
118   _compile_reason = compile_reason;
119   _nm_content_size = 0;
120   AbstractCompiler* comp = compiler();
121   _directive = DirectivesStack::getMatchingDirective(method, comp);
122   _nm_insts_size = 0;
123   _nm_total_size = 0;
124   _failure_reason = nullptr;
125   _failure_reason_on_C_heap = false;
126 
127   if (LogCompilation) {
128     if (hot_method.not_null()) {
129       if (hot_method == method) {
130         _hot_method = _method;
131       } else {
132         _hot_method = hot_method();
133         // only add loader or mirror if different from _method_holder
134         _hot_method_holder = JNIHandles::make_weak_global(Handle(thread, hot_method->method_holder()->klass_holder()));
135       }
136     }
137   }
138 
139   _next = nullptr;
140 }
141 
142 /**
143  * Returns the compiler for this task.
144  */
145 AbstractCompiler* CompileTask::compiler() const {
146   return CompileBroker::compiler(_comp_level);
147 }
148 
149 // Replace weak handles by strong handles to avoid unloading during compilation.
150 CompileTask* CompileTask::select_for_compilation() {
151   if (is_unloaded()) {
152     // Guard against concurrent class unloading
153     return nullptr;
154   }
155   Thread* thread = Thread::current();
156   assert(_method->method_holder()->is_loader_alive(), "should be alive");
157   Handle method_holder(thread, _method->method_holder()->klass_holder());
158   JNIHandles::destroy_weak_global(_method_holder);
159   JNIHandles::destroy_weak_global(_hot_method_holder);
160   _method_holder = JNIHandles::make_global(method_holder);
161   if (_hot_method != nullptr) {
162     _hot_method_holder = JNIHandles::make_global(Handle(thread, _hot_method->method_holder()->klass_holder()));
163   }
164   return this;
165 }
166 
167 void CompileTask::mark_on_stack() {
168   if (is_unloaded()) {
169     return;
170   }
171   // Mark these methods as something redefine classes cannot remove.
172   _method->set_on_stack(true);
173   if (_hot_method != nullptr) {
174     _hot_method->set_on_stack(true);
175   }
176 }
177 
178 bool CompileTask::is_unloaded() const {
179   return _method_holder != nullptr && JNIHandles::is_weak_global_handle(_method_holder) && JNIHandles::is_weak_global_cleared(_method_holder);
180 }
181 
182 // RedefineClasses support
183 void CompileTask::metadata_do(MetadataClosure* f) {
184   if (is_unloaded()) {
185     return;
186   }
187   f->do_metadata(method());
188   if (hot_method() != nullptr && hot_method() != method()) {
189     f->do_metadata(hot_method());
190   }
191 }
192 
193 // ------------------------------------------------------------------
194 // CompileTask::print_line_on_error
195 //
196 // This function is called by fatal error handler when the thread
197 // causing troubles is a compiler thread.
198 //
199 // Do not grab any lock, do not allocate memory.
200 //
201 // Otherwise it's the same as CompileTask::print_line()
202 //
203 void CompileTask::print_line_on_error(outputStream* st, char* buf, int buflen) {
204   // print compiler name
205   st->print("%s:", CompileBroker::compiler_name(comp_level()));
206   print(st);
207 }
208 
209 // ------------------------------------------------------------------
210 // CompileTask::print_tty
211 void CompileTask::print_tty() {
212   ttyLocker ttyl;  // keep the following output all in one block
213   print(tty);
214 }
215 
216 // ------------------------------------------------------------------
217 // CompileTask::print_impl
218 void CompileTask::print_impl(outputStream* st, Method* method, int compile_id, int comp_level,
219                              bool is_osr_method, int osr_bci, bool is_blocking,
220                              const char* msg, bool short_form, bool cr,
221                              jlong time_queued, jlong time_started) {
222   if (!short_form) {
223     // Print current time
224     st->print(UINT64_FORMAT " ", (uint64_t) tty->time_stamp().milliseconds());
225     if (Verbose && time_queued != 0) {
226       // Print time in queue and time being processed by compiler thread
227       jlong now = os::elapsed_counter();
228       st->print("%.0f ", TimeHelper::counter_to_millis(now-time_queued));
229       if (time_started != 0) {
230         st->print("%.0f ", TimeHelper::counter_to_millis(now-time_started));
231       }
232     }
233   }
234   // print compiler name if requested
235   if (CIPrintCompilerName) {
236     st->print("%s:", CompileBroker::compiler_name(comp_level));
237   }
238   st->print("%4d ", compile_id);    // print compilation number
239 
240   bool is_synchronized = false;
241   bool has_exception_handler = false;
242   bool is_native = false;
243   if (method != nullptr) {
244     is_synchronized       = method->is_synchronized();
245     has_exception_handler = method->has_exception_handler();
246     is_native             = method->is_native();
247   }
248   // method attributes
249   const char compile_type   = is_osr_method                   ? '%' : ' ';
250   const char sync_char      = is_synchronized                 ? 's' : ' ';
251   const char exception_char = has_exception_handler           ? '!' : ' ';
252   const char blocking_char  = is_blocking                     ? 'b' : ' ';
253   const char native_char    = is_native                       ? 'n' : ' ';
254 
255   // print method attributes
256   st->print("%c%c%c%c%c ", compile_type, sync_char, exception_char, blocking_char, native_char);
257 
258   if (TieredCompilation) {
259     if (comp_level != -1)  st->print("%d ", comp_level);
260     else                   st->print("- ");
261   }
262   st->print("     ");  // more indent
263 
264   if (method == nullptr) {
265     st->print("(method)");
266   } else {
267     method->print_short_name(st);
268     if (is_osr_method) {
269       st->print(" @ %d", osr_bci);
270     }
271     if (method->is_native())
272       st->print(" (native)");
273     else
274       st->print(" (%d bytes)", method->code_size());
275   }
276 
277   if (msg != nullptr) {
278     st->print("   %s", msg);
279   }
280   if (cr) {
281     st->cr();
282   }
283 }
284 
285 void CompileTask::print_inline_indent(int inline_level, outputStream* st) {
286   //         1234567
287   st->print("        ");     // print timestamp
288   //         1234
289   st->print("     ");        // print compilation number
290   //         %s!bn
291   st->print("      ");       // print method attributes
292   if (TieredCompilation) {
293     st->print("  ");
294   }
295   st->print("     ");        // more indent
296   st->print("    ");         // initial inlining indent
297   for (int i = 0; i < inline_level; i++)  st->print("  ");
298 }
299 
300 // ------------------------------------------------------------------
301 // CompileTask::print_compilation
302 void CompileTask::print(outputStream* st, const char* msg, bool short_form, bool cr) {
303   bool is_osr_method = osr_bci() != InvocationEntryBci;
304   print_impl(st, is_unloaded() ? nullptr : method(), compile_id(), comp_level(), is_osr_method, osr_bci(), is_blocking(), msg, short_form, cr, _time_queued, _time_started);
305 }
306 
307 // ------------------------------------------------------------------
308 // CompileTask::log_task
309 void CompileTask::log_task(xmlStream* log) {
310   Thread* thread = Thread::current();
311   methodHandle method(thread, this->method());
312   ResourceMark rm(thread);
313 
314   // <task id='9' method='M' osr_bci='X' level='1' blocking='1' stamp='1.234'>
315   log->print(" compile_id='%d'", _compile_id);
316   if (_osr_bci != CompileBroker::standard_entry_bci) {
317     log->print(" compile_kind='osr'");  // same as nmethod::compile_kind
318   } // else compile_kind='c2c'
319   if (!method.is_null())  log->method(method());
320   if (_osr_bci != CompileBroker::standard_entry_bci) {
321     log->print(" osr_bci='%d'", _osr_bci);
322   }
323   if (_comp_level != CompilationPolicy::highest_compile_level()) {
324     log->print(" level='%d'", _comp_level);
325   }
326   if (_is_blocking) {
327     log->print(" blocking='1'");
328   }
329   log->stamp();
330 }
331 
332 // ------------------------------------------------------------------
333 // CompileTask::log_task_queued
334 void CompileTask::log_task_queued() {
335   ttyLocker ttyl;
336   ResourceMark rm;
337   NoSafepointVerifier nsv;
338 
339   xtty->begin_elem("task_queued");
340   log_task(xtty);
341   assert(_compile_reason > CompileTask::Reason_None && _compile_reason < CompileTask::Reason_Count, "Valid values");
342   xtty->print(" comment='%s'", reason_name(_compile_reason));
343 
344   if (_hot_method != nullptr && _hot_method != _method) {
345     xtty->method(_hot_method);
346   }
347   if (_hot_count != 0) {
348     xtty->print(" hot_count='%d'", _hot_count);
349   }
350   xtty->end_elem();
351 }
352 
353 
354 // ------------------------------------------------------------------
355 // CompileTask::log_task_start
356 void CompileTask::log_task_start(CompileLog* log)   {
357   log->begin_head("task");
358   log_task(log);
359   log->end_head();
360 }
361 
362 
363 // ------------------------------------------------------------------
364 // CompileTask::log_task_done
365 void CompileTask::log_task_done(CompileLog* log) {
366   Thread* thread = Thread::current();
367   methodHandle method(thread, this->method());
368   ResourceMark rm(thread);
369 
370   if (!_is_success) {
371     assert(_failure_reason != nullptr, "missing");
372     const char* reason = _failure_reason != nullptr ? _failure_reason : "unknown";
373     log->begin_elem("failure reason='");
374     log->text("%s", reason);
375     log->print("'");
376     log->end_elem();
377   }
378 
379   // <task_done ... stamp='1.234'>  </task>
380   log->begin_elem("task_done success='%d' nmsize='%d' count='%d'",
381                   _is_success, _nm_content_size,
382                   method->invocation_count());
383   int bec = method->backedge_count();
384   if (bec != 0)  log->print(" backedge_count='%d'", bec);
385   // Note:  "_is_complete" is about to be set, but is not.
386   if (_num_inlined_bytecodes != 0) {
387     log->print(" inlined_bytes='%d'", _num_inlined_bytecodes);
388   }
389   log->stamp();
390   log->end_elem();
391   log->clear_identities();   // next task will have different CI
392   log->tail("task");
393   log->flush();
394   log->mark_file_end();
395 }
396 
397 // ------------------------------------------------------------------
398 // CompileTask::check_break_at_flags
399 bool CompileTask::check_break_at_flags() {
400   int compile_id = this->_compile_id;
401   bool is_osr = (_osr_bci != CompileBroker::standard_entry_bci);
402 
403   if (CICountOSR && is_osr && (compile_id == CIBreakAtOSR)) {
404     return true;
405   } else {
406     return (compile_id == CIBreakAt);
407   }
408 }
409 
410 // ------------------------------------------------------------------
411 // CompileTask::print_inlining
412 void CompileTask::print_inlining_inner(outputStream* st, ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg) {
413   //         1234567
414   st->print("        ");     // print timestamp
415   //         1234
416   st->print("     ");        // print compilation number
417 
418   // method attributes
419   if (method->is_loaded()) {
420     const char sync_char      = method->is_synchronized()        ? 's' : ' ';
421     const char exception_char = method->has_exception_handlers() ? '!' : ' ';
422     const char monitors_char  = method->has_monitor_bytecodes()  ? 'm' : ' ';
423 
424     // print method attributes
425     st->print(" %c%c%c  ", sync_char, exception_char, monitors_char);
426   } else {
427     //         %s!bn
428     st->print("      ");     // print method attributes
429   }
430 
431   if (TieredCompilation) {
432     st->print("  ");
433   }
434   st->print("     ");        // more indent
435   st->print("    ");         // initial inlining indent
436 
437   for (int i = 0; i < inline_level; i++)  st->print("  ");
438 
439   st->print("@ %d  ", bci);  // print bci
440   method->print_short_name(st);
441   if (method->is_loaded())
442     st->print(" (%d bytes)", method->code_size());
443   else
444     st->print(" (not loaded)");
445 
446   if (msg != nullptr) {
447     st->print("   %s%s", result == InliningResult::SUCCESS ? "" : "failed to inline: ", msg);
448   } else if (result == InliningResult::FAILURE) {
449     st->print("   %s", "failed to inline");
450   }
451   st->cr();
452 }
453 
454 void CompileTask::print_ul(const char* msg){
455   LogTarget(Debug, jit, compilation) lt;
456   if (lt.is_enabled()) {
457     LogStream ls(lt);
458     print(&ls, msg, /* short form */ true, /* cr */ true);
459   }
460 }
461 
462 void CompileTask::print_ul(const nmethod* nm, const char* msg) {
463   LogTarget(Debug, jit, compilation) lt;
464   if (lt.is_enabled()) {
465     LogStream ls(lt);
466     print_impl(&ls, nm->method(), nm->compile_id(),
467                nm->comp_level(), nm->is_osr_method(),
468                nm->is_osr_method() ? nm->osr_entry_bci() : -1,
469                /*is_blocking*/ false,
470                msg, /* short form */ true, /* cr */ true);
471   }
472 }
473 
474 void CompileTask::print_inlining_ul(ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg) {
475   LogTarget(Debug, jit, inlining) lt;
476   if (lt.is_enabled()) {
477     LogStream ls(lt);
478     print_inlining_inner(&ls, method, inline_level, bci, result, msg);
479   }
480 }
481