1 /* 2 * Copyright (c) 1999, 2019, 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 #ifndef SHARE_COMPILER_COMPILEBROKER_HPP 26 #define SHARE_COMPILER_COMPILEBROKER_HPP 27 28 #include "ci/compilerInterface.hpp" 29 #include "compiler/abstractCompiler.hpp" 30 #include "compiler/compileTask.hpp" 31 #include "compiler/compilerDirectives.hpp" 32 #include "runtime/atomic.hpp" 33 #include "runtime/perfData.hpp" 34 #include "utilities/stack.hpp" 35 #if INCLUDE_JVMCI 36 #include "jvmci/jvmciCompiler.hpp" 37 #endif 38 39 class nmethod; 40 class nmethodLocker; 41 42 // CompilerCounters 43 // 44 // Per Compiler Performance Counters. 45 // 46 class CompilerCounters : public CHeapObj<mtCompiler> { 47 48 public: 49 enum { 50 cmname_buffer_length = 160 51 }; 52 53 private: 54 55 char _current_method[cmname_buffer_length]; 56 int _compile_type; 57 58 public: 59 CompilerCounters(); 60 61 // these methods should be called in a thread safe context 62 63 void set_current_method(const char* method) { 64 strncpy(_current_method, method, (size_t)cmname_buffer_length-1); 65 _current_method[cmname_buffer_length-1] = '\0'; 66 } 67 68 char* current_method() { return _current_method; } 69 70 void set_compile_type(int compile_type) { 71 _compile_type = compile_type; 72 } 73 74 int compile_type() { return _compile_type; } 75 76 }; 77 78 // CompileQueue 79 // 80 // A list of CompileTasks. 81 class CompileQueue : public CHeapObj<mtCompiler> { 82 private: 83 const char* _name; 84 85 CompileTask* _first; 86 CompileTask* _last; 87 88 CompileTask* _first_stale; 89 90 int _size; 91 92 void purge_stale_tasks(); 93 public: 94 CompileQueue(const char* name) { 95 _name = name; 96 _first = NULL; 97 _last = NULL; 98 _size = 0; 99 _first_stale = NULL; 100 } 101 102 const char* name() const { return _name; } 103 104 void add(CompileTask* task); 105 void remove(CompileTask* task); 106 void remove_and_mark_stale(CompileTask* task); 107 CompileTask* first() { return _first; } 108 CompileTask* last() { return _last; } 109 110 CompileTask* get(); 111 112 bool is_empty() const { return _first == NULL; } 113 int size() const { return _size; } 114 115 116 // Redefine Classes support 117 void mark_on_stack(); 118 void free_all(); 119 void print_tty(); 120 void print(outputStream* st = tty); 121 122 ~CompileQueue() { 123 assert (is_empty(), " Compile Queue must be empty"); 124 } 125 }; 126 127 // CompileTaskWrapper 128 // 129 // Assign this task to the current thread. Deallocate the task 130 // when the compilation is complete. 131 class CompileTaskWrapper : StackObj { 132 public: 133 CompileTaskWrapper(CompileTask* task); 134 ~CompileTaskWrapper(); 135 }; 136 137 // Compilation 138 // 139 // The broker for all compilation requests. 140 class CompileBroker: AllStatic { 141 friend class Threads; 142 friend class CompileTaskWrapper; 143 144 public: 145 enum { 146 name_buffer_length = 100 147 }; 148 149 // Compile type Information for print_last_compile() and CompilerCounters 150 enum { no_compile, normal_compile, osr_compile, native_compile }; 151 static int assign_compile_id (const methodHandle& method, int osr_bci); 152 153 154 private: 155 static bool _initialized; 156 static volatile bool _should_block; 157 158 // This flag can be used to stop compilation or turn it back on 159 static volatile jint _should_compile_new_jobs; 160 161 // The installed compiler(s) 162 static AbstractCompiler* _compilers[2]; 163 164 // The maximum numbers of compiler threads to be determined during startup. 165 static int _c1_count, _c2_count; 166 167 // An array of compiler thread Java objects 168 static jobject *_compiler1_objects, *_compiler2_objects; 169 170 // An array of compiler logs 171 static CompileLog **_compiler1_logs, **_compiler2_logs; 172 173 // These counters are used for assigning id's to each compilation 174 static volatile jint _compilation_id; 175 static volatile jint _osr_compilation_id; 176 177 static CompileQueue* _c2_compile_queue; 178 static CompileQueue* _c1_compile_queue; 179 180 // performance counters 181 static PerfCounter* _perf_total_compilation; 182 static PerfCounter* _perf_native_compilation; 183 static PerfCounter* _perf_osr_compilation; 184 static PerfCounter* _perf_standard_compilation; 185 186 static PerfCounter* _perf_total_bailout_count; 187 static PerfCounter* _perf_total_invalidated_count; 188 static PerfCounter* _perf_total_compile_count; 189 static PerfCounter* _perf_total_native_compile_count; 190 static PerfCounter* _perf_total_osr_compile_count; 191 static PerfCounter* _perf_total_standard_compile_count; 192 193 static PerfCounter* _perf_sum_osr_bytes_compiled; 194 static PerfCounter* _perf_sum_standard_bytes_compiled; 195 static PerfCounter* _perf_sum_nmethod_size; 196 static PerfCounter* _perf_sum_nmethod_code_size; 197 198 static PerfStringVariable* _perf_last_method; 199 static PerfStringVariable* _perf_last_failed_method; 200 static PerfStringVariable* _perf_last_invalidated_method; 201 static PerfVariable* _perf_last_compile_type; 202 static PerfVariable* _perf_last_compile_size; 203 static PerfVariable* _perf_last_failed_type; 204 static PerfVariable* _perf_last_invalidated_type; 205 206 // Timers and counters for generating statistics 207 static elapsedTimer _t_total_compilation; 208 static elapsedTimer _t_osr_compilation; 209 static elapsedTimer _t_standard_compilation; 210 static elapsedTimer _t_invalidated_compilation; 211 static elapsedTimer _t_bailedout_compilation; 212 213 static int _total_compile_count; 214 static int _total_bailout_count; 215 static int _total_invalidated_count; 216 static int _total_native_compile_count; 217 static int _total_osr_compile_count; 218 static int _total_standard_compile_count; 219 static int _total_compiler_stopped_count; 220 static int _total_compiler_restarted_count; 221 static int _sum_osr_bytes_compiled; 222 static int _sum_standard_bytes_compiled; 223 static int _sum_nmethod_size; 224 static int _sum_nmethod_code_size; 225 static long _peak_compilation_time; 226 227 static CompilerStatistics _stats_per_level[]; 228 229 static volatile int _print_compilation_warning; 230 231 static Handle create_thread_oop(const char* name, TRAPS); 232 static JavaThread* make_thread(jobject thread_oop, CompileQueue* queue, AbstractCompiler* comp, Thread* THREAD); 233 static void init_compiler_sweeper_threads(); 234 static void possibly_add_compiler_threads(Thread* THREAD); 235 static bool compilation_is_prohibited(const methodHandle& method, int osr_bci, int comp_level, bool excluded); 236 237 static CompileTask* create_compile_task(CompileQueue* queue, 238 int compile_id, 239 const methodHandle& method, 240 int osr_bci, 241 int comp_level, 242 const methodHandle& hot_method, 243 int hot_count, 244 CompileTask::CompileReason compile_reason, 245 bool blocking); 246 static void wait_for_completion(CompileTask* task); 247 #if INCLUDE_JVMCI 248 static bool wait_for_jvmci_completion(JVMCICompiler* comp, CompileTask* task, JavaThread* thread); 249 #endif 250 251 static void invoke_compiler_on_method(CompileTask* task); 252 static void post_compile(CompilerThread* thread, CompileTask* task, bool success, ciEnv* ci_env, 253 int compilable, const char* failure_reason); 254 static void update_compile_perf_data(CompilerThread *thread, const methodHandle& method, bool is_osr); 255 256 static void push_jni_handle_block(); 257 static void pop_jni_handle_block(); 258 static void collect_statistics(CompilerThread* thread, elapsedTimer time, CompileTask* task); 259 260 static void compile_method_base(const methodHandle& method, 261 int osr_bci, 262 int comp_level, 263 const methodHandle& hot_method, 264 int hot_count, 265 CompileTask::CompileReason compile_reason, 266 bool blocking, 267 Thread* thread); 268 269 static CompileQueue* compile_queue(int comp_level); 270 static bool init_compiler_runtime(); 271 static void shutdown_compiler_runtime(AbstractCompiler* comp, CompilerThread* thread); 272 273 public: 274 275 static DirectivesStack* dirstack(); 276 static void set_dirstack(DirectivesStack* stack); 277 278 enum { 279 // The entry bci used for non-OSR compilations. 280 standard_entry_bci = InvocationEntryBci 281 }; 282 283 static AbstractCompiler* compiler(int comp_level) { 284 if (is_c2_compile(comp_level)) return _compilers[1]; // C2 285 if (is_c1_compile(comp_level)) return _compilers[0]; // C1 286 return NULL; 287 } 288 289 static bool compilation_is_complete(const methodHandle& method, int osr_bci, int comp_level); 290 static bool compilation_is_in_queue(const methodHandle& method); 291 static void print_compile_queues(outputStream* st); 292 static void print_directives(outputStream* st); 293 static int queue_size(int comp_level) { 294 CompileQueue *q = compile_queue(comp_level); 295 return q != NULL ? q->size() : 0; 296 } 297 static void compilation_init_phase1(Thread* THREAD); 298 static void compilation_init_phase2(); 299 static void init_compiler_thread_log(); 300 static nmethod* compile_method(const methodHandle& method, 301 int osr_bci, 302 int comp_level, 303 const methodHandle& hot_method, 304 int hot_count, 305 CompileTask::CompileReason compile_reason, 306 Thread* thread); 307 308 static nmethod* compile_method(const methodHandle& method, 309 int osr_bci, 310 int comp_level, 311 const methodHandle& hot_method, 312 int hot_count, 313 CompileTask::CompileReason compile_reason, 314 DirectiveSet* directive, 315 Thread* thread); 316 317 // Acquire any needed locks and assign a compile id 318 static uint assign_compile_id_unlocked(Thread* thread, const methodHandle& method, int osr_bci); 319 320 static void compiler_thread_loop(); 321 static uint get_compilation_id() { return _compilation_id; } 322 323 // Set _should_block. 324 // Call this from the VM, with Threads_lock held and a safepoint requested. 325 static void set_should_block(); 326 327 // Call this from the compiler at convenient points, to poll for _should_block. 328 static void maybe_block(); 329 330 enum CompilerActivity { 331 // Flags for toggling compiler activity 332 stop_compilation = 0, 333 run_compilation = 1, 334 shutdown_compilation = 2 335 }; 336 337 static jint get_compilation_activity_mode() { return _should_compile_new_jobs; } 338 static bool should_compile_new_jobs() { return UseCompiler && (_should_compile_new_jobs == run_compilation); } 339 static bool set_should_compile_new_jobs(jint new_state) { 340 // Return success if the current caller set it 341 jint old = Atomic::cmpxchg(&_should_compile_new_jobs, 1-new_state, new_state); 342 bool success = (old == (1-new_state)); 343 if (success) { 344 if (new_state == run_compilation) { 345 _total_compiler_restarted_count++; 346 } else { 347 _total_compiler_stopped_count++; 348 } 349 } 350 return success; 351 } 352 353 static void disable_compilation_forever() { 354 UseCompiler = false; 355 AlwaysCompileLoopMethods = false; 356 Atomic::xchg(&_should_compile_new_jobs, jint(shutdown_compilation)); 357 } 358 359 static bool is_compilation_disabled_forever() { 360 return _should_compile_new_jobs == shutdown_compilation; 361 } 362 static void handle_full_code_cache(int code_blob_type); 363 // Ensures that warning is only printed once. 364 static bool should_print_compiler_warning() { 365 jint old = Atomic::cmpxchg(&_print_compilation_warning, 0, 1); 366 return old == 0; 367 } 368 // Return total compilation ticks 369 static jlong total_compilation_ticks() { 370 return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0; 371 } 372 373 // Redefine Classes support 374 static void mark_on_stack(); 375 376 // Print curent compilation time stats for a given compiler 377 static void print_times(const char* name, CompilerStatistics* stats); 378 379 // Print a detailed accounting of compilation time 380 static void print_times(bool per_compiler = true, bool aggregate = true); 381 382 // compiler name for debugging 383 static const char* compiler_name(int comp_level); 384 385 // Provide access to compiler thread Java objects 386 static jobject compiler1_object(int idx) { 387 assert(_compiler1_objects != NULL, "must be initialized"); 388 assert(idx < _c1_count, "oob"); 389 return _compiler1_objects[idx]; 390 } 391 392 static jobject compiler2_object(int idx) { 393 assert(_compiler2_objects != NULL, "must be initialized"); 394 assert(idx < _c2_count, "oob"); 395 return _compiler2_objects[idx]; 396 } 397 398 static AbstractCompiler* compiler1() { return _compilers[0]; } 399 static AbstractCompiler* compiler2() { return _compilers[1]; } 400 401 static bool can_remove(CompilerThread *ct, bool do_it); 402 403 static CompileLog* get_log(CompilerThread* ct); 404 405 static int get_total_compile_count() { return _total_compile_count; } 406 static int get_total_bailout_count() { return _total_bailout_count; } 407 static int get_total_invalidated_count() { return _total_invalidated_count; } 408 static int get_total_native_compile_count() { return _total_native_compile_count; } 409 static int get_total_osr_compile_count() { return _total_osr_compile_count; } 410 static int get_total_standard_compile_count() { return _total_standard_compile_count; } 411 static int get_total_compiler_stopped_count() { return _total_compiler_stopped_count; } 412 static int get_total_compiler_restarted_count() { return _total_compiler_restarted_count; } 413 static int get_sum_osr_bytes_compiled() { return _sum_osr_bytes_compiled; } 414 static int get_sum_standard_bytes_compiled() { return _sum_standard_bytes_compiled; } 415 static int get_sum_nmethod_size() { return _sum_nmethod_size;} 416 static int get_sum_nmethod_code_size() { return _sum_nmethod_code_size; } 417 static long get_peak_compilation_time() { return _peak_compilation_time; } 418 static long get_total_compilation_time() { return _t_total_compilation.milliseconds(); } 419 420 // Log that compilation profiling is skipped because metaspace is full. 421 static void log_metaspace_failure(); 422 423 // CodeHeap State Analytics. 424 static void print_info(outputStream *out); 425 static void print_heapinfo(outputStream *out, const char* function, size_t granularity); 426 }; 427 428 #endif // SHARE_COMPILER_COMPILEBROKER_HPP