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 #include "code/SCCache.hpp"
 39 
 40 CompileTask*  CompileTask::_task_free_list = nullptr;
 41 
 42 /**
 43  * Allocate a CompileTask, from the free list if possible.
 44  */
 45 CompileTask* CompileTask::allocate() {
 46   MutexLocker locker(CompileTaskAlloc_lock);
 47   CompileTask* task = nullptr;
 48 
 49   if (_task_free_list != nullptr) {
 50     task = _task_free_list;
 51     _task_free_list = task->next();
 52     task->set_next(nullptr);
 53   } else {
 54     task = new CompileTask();
 55     task->set_next(nullptr);
 56     task->set_is_free(true);
 57   }
 58   assert(task->is_free(), "Task must be free.");
 59   task->set_is_free(false);
 60   return task;
 61 }
 62 
 63 /**
 64 * Add a task to the free list.
 65 */
 66 void CompileTask::free(CompileTask* task) {
 67   MutexLocker locker(CompileTaskAlloc_lock);
 68   if (!task->is_free()) {
 69     assert(!task->lock()->is_locked(), "Should not be locked when freed");
 70     if ((task->_method_holder != nullptr && JNIHandles::is_weak_global_handle(task->_method_holder)) ||
 71         (task->_hot_method_holder != nullptr && JNIHandles::is_weak_global_handle(task->_hot_method_holder))) {
 72       JNIHandles::destroy_weak_global(task->_method_holder);
 73       JNIHandles::destroy_weak_global(task->_hot_method_holder);
 74     } else {
 75       JNIHandles::destroy_global(task->_method_holder);
 76       JNIHandles::destroy_global(task->_hot_method_holder);
 77     }
 78     if (task->_failure_reason_on_C_heap && task->_failure_reason != nullptr) {
 79       os::free((void*) task->_failure_reason);
 80     }
 81     task->_failure_reason = nullptr;
 82     task->_failure_reason_on_C_heap = false;
 83 
 84     task->set_is_free(true);
 85     task->set_next(_task_free_list);
 86     _task_free_list = task;
 87   }
 88 }
 89 
 90 void CompileTask::initialize(int compile_id,
 91                              const methodHandle& method,
 92                              int osr_bci,
 93                              int comp_level,
 94                              const methodHandle& hot_method,
 95                              int hot_count,
 96                              SCCEntry* scc_entry,
 97                              CompileTask::CompileReason compile_reason,
 98                              CompileQueue* compile_queue,
 99                              bool requires_online_compilation,
100                              bool is_blocking) {
101   assert(!_lock->is_locked(), "bad locking");
102 
103   Thread* thread = Thread::current();
104   _compile_id = compile_id;
105   _method = method();
106   _method_holder = JNIHandles::make_weak_global(Handle(thread, method->method_holder()->klass_holder()));
107   _osr_bci = osr_bci;
108   _requires_online_compilation = requires_online_compilation;
109   _is_blocking = is_blocking;
110   _comp_level = comp_level;
111   _num_inlined_bytecodes = 0;
112 
113   _is_complete = false;
114   _is_success = false;
115 
116   _next = nullptr;
117   _prev = nullptr;
118 
119   _hot_method = nullptr;
120   _hot_method_holder = nullptr;
121   _hot_count = hot_count;
122   _time_created = os::elapsed_counter();
123   _time_queued = 0;
124   _time_started = 0;
125   _compile_reason = compile_reason;
126   _nm_content_size = 0;
127   _nm_insts_size = 0;
128   _nm_total_size = 0;
129   _failure_reason = nullptr;
130   _failure_reason_on_C_heap = false;
131   _training_data = nullptr;
132   _scc_entry = scc_entry;
133   _compile_queue = compile_queue;
134 
135   AbstractCompiler* comp = CompileBroker::compiler(comp_level);
136 #if INCLUDE_JVMCI
137   if (comp->is_jvmci() && CompileBroker::compiler3() != nullptr) {
138     assert(_method != nullptr, "sanity");
139     if (((JVMCICompiler*)comp)->force_comp_at_level_simple(method)) {
140       comp = CompileBroker::compiler3();
141     }
142   }
143 #endif
144   _compiler = comp;
145   _directive = DirectivesStack::getMatchingDirective(method, comp);
146 
147   JVMCI_ONLY(_has_waiter = comp->is_jvmci();)
148   JVMCI_ONLY(_blocking_jvmci_compile_state = nullptr;)
149 
150   if (LogCompilation) {
151     if (hot_method.not_null()) {
152       if (hot_method == method) {
153         _hot_method = _method;
154       } else {
155         _hot_method = hot_method();
156         // only add loader or mirror if different from _method_holder
157         _hot_method_holder = JNIHandles::make_weak_global(Handle(thread, hot_method->method_holder()->klass_holder()));
158       }
159     }
160   }
161 
162   _next = nullptr;
163 }
164 
165 /**
166  * Returns the compiler for this task.
167  */
168 AbstractCompiler* CompileTask::compiler() const {
169   assert(_compiler != nullptr, "should be set");
170   return _compiler;
171 }
172 
173 // Replace weak handles by strong handles to avoid unloading during compilation.
174 CompileTask* CompileTask::select_for_compilation() {
175   if (_compile_reason == Reason_Preload) {
176     return this;
177   }
178   if (is_unloaded()) {
179     // Guard against concurrent class unloading
180     return nullptr;
181   }
182   Thread* thread = Thread::current();
183   assert(_method->method_holder()->is_loader_alive(), "should be alive");
184   Handle method_holder(thread, _method->method_holder()->klass_holder());
185   JNIHandles::destroy_weak_global(_method_holder);
186   JNIHandles::destroy_weak_global(_hot_method_holder);
187   _method_holder = JNIHandles::make_global(method_holder);
188   if (_hot_method != nullptr) {
189     _hot_method_holder = JNIHandles::make_global(Handle(thread, _hot_method->method_holder()->klass_holder()));
190   }
191   return this;
192 }
193 
194 void CompileTask::mark_on_stack() {
195   if (is_unloaded()) {
196     return;
197   }
198   // Mark these methods as something redefine classes cannot remove.
199   _method->set_on_stack(true);
200   if (_hot_method != nullptr) {
201     _hot_method->set_on_stack(true);
202   }
203 }
204 
205 bool CompileTask::is_unloaded() const {
206   if (preload()) return false;
207   return _method_holder != nullptr && JNIHandles::is_weak_global_handle(_method_holder) && JNIHandles::is_weak_global_cleared(_method_holder);
208 }
209 
210 // RedefineClasses support
211 void CompileTask::metadata_do(MetadataClosure* f) {
212   if (is_unloaded()) {
213     return;
214   }
215   f->do_metadata(method());
216   if (hot_method() != nullptr && hot_method() != method()) {
217     f->do_metadata(hot_method());
218   }
219 }
220 
221 // ------------------------------------------------------------------
222 // CompileTask::print_line_on_error
223 //
224 // This function is called by fatal error handler when the thread
225 // causing troubles is a compiler thread.
226 //
227 // Do not grab any lock, do not allocate memory.
228 //
229 // Otherwise it's the same as CompileTask::print_line()
230 //
231 void CompileTask::print_line_on_error(outputStream* st, char* buf, int buflen) {
232   // print compiler name
233   st->print("%s:", compiler()->name());
234   print(st);
235 }
236 
237 // ------------------------------------------------------------------
238 // CompileTask::print_tty
239 void CompileTask::print_tty() {
240   ttyLocker ttyl;  // keep the following output all in one block
241   print(tty);
242 }
243 
244 // ------------------------------------------------------------------
245 // CompileTask::print_impl
246 void CompileTask::print_impl(outputStream* st, Method* method, int compile_id, int comp_level,
247                              bool is_osr_method, int osr_bci, bool is_blocking, bool is_scc, bool is_preload,
248                              const char* compiler_name,
249                              const char* msg, bool short_form, bool cr,
250                              jlong time_created, jlong time_queued, jlong time_started) {
251   if (!short_form) {
252     // Print current time
253     stringStream ss;
254     ss.print("%c" UINT64_FORMAT, (time_started != 0 ? 'F' : 'S'), (uint64_t)tty->time_stamp().milliseconds());
255     st->print("%7s ", ss.freeze());
256     if (time_created != 0) {
257       // Print time in queue and time being processed by compiler thread
258       jlong now = os::elapsed_counter();
259       st->print("C%d ", (int) TimeHelper::counter_to_millis((time_queued != 0 ? time_queued : now) - time_created));
260       if (time_queued != 0) {
261         st->print("Q%d ", (int) TimeHelper::counter_to_millis((time_started != 0 ? time_started : now) - time_queued));
262         if (time_started != 0) {
263           st->print("S%d ", (int) TimeHelper::counter_to_millis(now - time_started));
264         }
265       }
266     }
267   }
268   // print compiler name if requested
269   if (CIPrintCompilerName) {
270     st->print("%s:", compiler_name);
271   }
272   st->print("%4d ", compile_id);    // print compilation number
273 
274   bool is_synchronized = false;
275   bool has_exception_handler = false;
276   bool is_native = false;
277   if (method != nullptr) {
278     is_synchronized       = method->is_synchronized();
279     has_exception_handler = method->has_exception_handler();
280     is_native             = method->is_native();
281   }
282   // method attributes
283   const char compile_type   = is_osr_method                   ? '%' : ' ';
284   const char sync_char      = is_synchronized                 ? 's' : ' ';
285   const char exception_char = has_exception_handler           ? '!' : ' ';
286   const char blocking_char  = is_blocking                     ? 'b' : ' ';
287   const char native_char    = is_native                       ? 'n' : ' ';
288   const char scc_char       = is_scc                          ? 'A' : ' ';
289   const char preload_char   = is_preload                      ? 'P' : ' ';
290 
291   // print method attributes
292   st->print("%c%c%c%c%c%c%c ", compile_type, sync_char, exception_char, blocking_char, native_char, scc_char, preload_char);
293 
294   if (TieredCompilation) {
295     if (comp_level != -1)  st->print("%d ", comp_level);
296     else                   st->print("- ");
297   }
298   st->print("     ");  // more indent
299 
300   if (method == nullptr) {
301     st->print("(method)");
302   } else {
303     method->print_short_name(st);
304     if (is_osr_method) {
305       st->print(" @ %d", osr_bci);
306     }
307     if (method->is_native())
308       st->print(" (native)");
309     else
310       st->print(" (%d bytes)", method->code_size());
311   }
312 
313   if (msg != nullptr) {
314     st->print("   %s", msg);
315   }
316   if (cr) {
317     st->cr();
318   }
319 }
320 
321 void CompileTask::print_inline_indent(int inline_level, outputStream* st) {
322   //         1234567
323   st->print("        ");     // print timestamp
324   //         1234
325   st->print("     ");        // print compilation number
326   //         %s!bn
327   st->print("      ");       // print method attributes
328   if (TieredCompilation) {
329     st->print("  ");
330   }
331   st->print("     ");        // more indent
332   st->print("    ");         // initial inlining indent
333   for (int i = 0; i < inline_level; i++)  st->print("  ");
334 }
335 
336 // ------------------------------------------------------------------
337 // CompileTask::print_compilation
338 void CompileTask::print(outputStream* st, const char* msg, bool short_form, bool cr) {
339   bool is_osr_method = osr_bci() != InvocationEntryBci;
340   print_impl(st, is_unloaded() ? nullptr : method(), compile_id(), comp_level(), is_osr_method, osr_bci(), is_blocking(), is_scc(), preload(),
341              compiler()->name(), msg, short_form, cr, _time_created, _time_queued, _time_started);
342 }
343 
344 // ------------------------------------------------------------------
345 // CompileTask::log_task
346 void CompileTask::log_task(xmlStream* log) {
347   Thread* thread = Thread::current();
348   methodHandle method(thread, this->method());
349   ResourceMark rm(thread);
350 
351   // <task id='9' method='M' osr_bci='X' level='1' blocking='1' stamp='1.234'>
352   log->print(" compile_id='%d'", _compile_id);
353   if (_osr_bci != CompileBroker::standard_entry_bci) {
354     log->print(" compile_kind='osr'");  // same as nmethod::compile_kind
355   } // else compile_kind='c2c'
356   if (!method.is_null())  log->method(method());
357   if (_osr_bci != CompileBroker::standard_entry_bci) {
358     log->print(" osr_bci='%d'", _osr_bci);
359   }
360   if (_comp_level != CompilationPolicy::highest_compile_level()) {
361     log->print(" level='%d'", _comp_level);
362   }
363   if (_is_blocking) {
364     log->print(" blocking='1'");
365   }
366 }
367 
368 // ------------------------------------------------------------------
369 // CompileTask::log_task_queued
370 void CompileTask::log_task_queued() {
371   ttyLocker ttyl;
372   ResourceMark rm;
373   NoSafepointVerifier nsv;
374 
375   xtty->begin_elem("task_queued");
376   log_task(xtty);
377   assert(_compile_reason > CompileTask::Reason_None && _compile_reason < CompileTask::Reason_Count, "Valid values");
378   xtty->print(" comment='%s'", reason_name(_compile_reason));
379 
380   if (_hot_method != nullptr && _hot_method != _method) {
381     xtty->method(_hot_method, "hot_");
382   }
383   if (_hot_count != 0) {
384     xtty->print(" hot_count='%d'", _hot_count);
385   }
386   xtty->stamp();
387   xtty->end_elem();
388 }
389 
390 
391 // ------------------------------------------------------------------
392 // CompileTask::log_task_start
393 void CompileTask::log_task_start(CompileLog* log) {
394   log->begin_head("task");
395   log_task(log);
396   log->stamp();
397   log->end_head();
398 }
399 
400 
401 // ------------------------------------------------------------------
402 // CompileTask::log_task_done
403 void CompileTask::log_task_done(CompileLog* log) {
404   Thread* thread = Thread::current();
405   methodHandle method(thread, this->method());
406   ResourceMark rm(thread);
407 
408   if (!_is_success) {
409     assert(_failure_reason != nullptr, "missing");
410     const char* reason = _failure_reason != nullptr ? _failure_reason : "unknown";
411     log->begin_elem("failure reason='");
412     log->text("%s", reason);
413     log->print("'");
414     log->end_elem();
415   }
416 
417   // <task_done ... stamp='1.234'>  </task>
418   log->begin_elem("task_done success='%d' nmsize='%d' count='%d'",
419                   _is_success, _nm_content_size,
420                   method->invocation_count());
421   int bec = method->backedge_count();
422   if (bec != 0)  log->print(" backedge_count='%d'", bec);
423   // Note:  "_is_complete" is about to be set, but is not.
424   if (_num_inlined_bytecodes != 0) {
425     log->print(" inlined_bytes='%d'", _num_inlined_bytecodes);
426   }
427   log->stamp();
428   log->end_elem();
429   log->clear_identities();   // next task will have different CI
430   log->tail("task");
431   log->flush();
432   log->mark_file_end();
433 }
434 
435 // ------------------------------------------------------------------
436 // CompileTask::check_break_at_flags
437 bool CompileTask::check_break_at_flags() {
438   int compile_id = this->_compile_id;
439   bool is_osr = (_osr_bci != CompileBroker::standard_entry_bci);
440 
441   if (CICountOSR && is_osr && (compile_id == CIBreakAtOSR)) {
442     return true;
443   } else {
444     return (compile_id == CIBreakAt);
445   }
446 }
447 
448 // ------------------------------------------------------------------
449 // CompileTask::print_inlining
450 void CompileTask::print_inlining_inner(outputStream* st, ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg) {
451   //         1234567
452   st->print("        ");     // print timestamp
453   //         1234
454   st->print("     ");        // print compilation number
455 
456   // method attributes
457   if (method->is_loaded()) {
458     const char sync_char      = method->is_synchronized()        ? 's' : ' ';
459     const char exception_char = method->has_exception_handlers() ? '!' : ' ';
460     const char monitors_char  = method->has_monitor_bytecodes()  ? 'm' : ' ';
461 
462     // print method attributes
463     st->print(" %c%c%c  ", sync_char, exception_char, monitors_char);
464   } else {
465     //         %s!bn
466     st->print("      ");     // print method attributes
467   }
468 
469   if (TieredCompilation) {
470     st->print("  ");
471   }
472   st->print("     ");        // more indent
473   st->print("    ");         // initial inlining indent
474 
475   for (int i = 0; i < inline_level; i++)  st->print("  ");
476 
477   st->print("@ %d  ", bci);  // print bci
478   method->print_short_name(st);
479   if (method->is_loaded())
480     st->print(" (%d bytes)", method->code_size());
481   else
482     st->print(" (not loaded)");
483 
484   if (msg != nullptr) {
485     st->print("   %s%s", result == InliningResult::SUCCESS ? "" : "failed to inline: ", msg);
486   } else if (result == InliningResult::FAILURE) {
487     st->print("   %s", "failed to inline");
488   }
489   st->cr();
490 }
491 
492 void CompileTask::print_ul(const char* msg){
493   LogTarget(Debug, jit, compilation) lt;
494   if (lt.is_enabled()) {
495     LogStream ls(lt);
496     print(&ls, msg, /* short form */ true, /* cr */ true);
497   }
498 }
499 
500 void CompileTask::print_ul(const nmethod* nm, const char* msg) {
501   LogTarget(Debug, jit, compilation) lt;
502   if (lt.is_enabled()) {
503     LogStream ls(lt);
504     print_impl(&ls, nm->method(), nm->compile_id(),
505                nm->comp_level(), nm->is_osr_method(),
506                nm->is_osr_method() ? nm->osr_entry_bci() : -1,
507                /*is_blocking*/ false, nm->scc_entry() != nullptr,
508                nm->preloaded(), nm->compiler_name(),
509                msg, /* short form */ true, /* cr */ true);
510   }
511 }
512 
513 void CompileTask::print_inlining_ul(ciMethod* method, int inline_level, int bci, InliningResult result, const char* msg) {
514   LogTarget(Debug, jit, inlining) lt;
515   if (lt.is_enabled()) {
516     LogStream ls(lt);
517     print_inlining_inner(&ls, method, inline_level, bci, result, msg);
518   }
519 }
520