1 /*
2 * Copyright (c) 2000, 2017, 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_VM_RUNTIME_COMPILATIONPOLICY_HPP
26 #define SHARE_VM_RUNTIME_COMPILATIONPOLICY_HPP
27
28 #include "code/nmethod.hpp"
29 #include "compiler/compileBroker.hpp"
30 #include "memory/allocation.hpp"
31 #include "runtime/vmOperations.hpp"
32 #include "utilities/growableArray.hpp"
33
34 // The CompilationPolicy selects which method (if any) should be compiled.
35 // It also decides which methods must always be compiled (i.e., are never
36 // interpreted).
37 class CompileTask;
38 class CompileQueue;
39
40 class CompilationPolicy : public CHeapObj<mtCompiler> {
41 static CompilationPolicy* _policy;
42 // Accumulated time
43 static elapsedTimer _accumulated_time;
44
45 static bool _in_vm_startup;
46
47 // m must be compiled before executing it
48 static bool must_be_compiled(const methodHandle& m, int comp_level = CompLevel_all);
49
50 public:
51 static void set_in_vm_startup(bool in_vm_startup) { _in_vm_startup = in_vm_startup; }
52 static void completed_vm_startup();
53 static bool delay_compilation_during_startup() { return _in_vm_startup; }
54
55 // If m must_be_compiled then request a compilation from the CompileBroker.
56 // This supports the -Xcomp option.
57 static void compile_if_required(const methodHandle& m, TRAPS);
58
59 // m is allowed to be compiled
60 static bool can_be_compiled(const methodHandle& m, int comp_level = CompLevel_all);
61 // m is allowed to be osr compiled
62 static bool can_be_osr_compiled(const methodHandle& m, int comp_level = CompLevel_all);
63 static bool is_compilation_enabled();
64 static void set_policy(CompilationPolicy* policy) { _policy = policy; }
65 static CompilationPolicy* policy() { return _policy; }
66
67 static CompileTask* select_task_helper(CompileQueue* compile_queue);
68
69 // Profiling
70 elapsedTimer* accumulated_time() { return &_accumulated_time; }
71 void print_time() PRODUCT_RETURN;
72 // Return initial compile level that is used with Xcomp
73 virtual CompLevel initial_compile_level() = 0;
74 virtual int compiler_count(CompLevel comp_level) = 0;
75 // main notification entry, return a pointer to an nmethod if the OSR is required,
76 // returns NULL otherwise.
77 virtual nmethod* event(const methodHandle& method, const methodHandle& inlinee, int branch_bci, int bci, CompLevel comp_level, CompiledMethod* nm, JavaThread* thread) = 0;
78 // safepoint() is called at the end of the safepoint
79 virtual void do_safepoint_work() = 0;
80 // reprofile request
81 virtual void reprofile(ScopeDesc* trap_scope, bool is_osr) = 0;
82 // delay_compilation(method) can be called by any component of the runtime to notify the policy
83 // that it's recommended to delay the compilation of this method.
84 virtual void delay_compilation(Method* method) = 0;
85 // disable_compilation() is called whenever the runtime decides to disable compilation of the
86 // specified method.
87 virtual void disable_compilation(Method* method) = 0;
88 // Select task is called by CompileBroker. The queue is guaranteed to have at least one
89 // element and is locked. The function should select one and return it.
90 virtual CompileTask* select_task(CompileQueue* compile_queue) = 0;
91 // Tell the runtime if we think a given method is adequately profiled.
92 virtual bool is_mature(Method* method) = 0;
93 // Do policy initialization
94 virtual void initialize() = 0;
95 virtual bool should_not_inline(ciEnv* env, ciMethod* method) { return false; }
96 };
97
98 // A base class for baseline policies.
99 class NonTieredCompPolicy : public CompilationPolicy {
100 int _compiler_count;
101 protected:
102 static void trace_frequency_counter_overflow(const methodHandle& m, int branch_bci, int bci);
103 static void trace_osr_request(const methodHandle& method, nmethod* osr, int bci);
104 static void trace_osr_completion(nmethod* osr_nm);
105 void reset_counter_for_invocation_event(const methodHandle& method);
106 void reset_counter_for_back_branch_event(const methodHandle& method);
107 public:
108 NonTieredCompPolicy() : _compiler_count(0) { }
109 virtual CompLevel initial_compile_level() { return CompLevel_highest_tier; }
110 virtual int compiler_count(CompLevel comp_level);
111 virtual void do_safepoint_work();
112 virtual void reprofile(ScopeDesc* trap_scope, bool is_osr);
113 virtual void delay_compilation(Method* method);
114 virtual void disable_compilation(Method* method);
115 virtual bool is_mature(Method* method);
116 virtual void initialize();
117 virtual CompileTask* select_task(CompileQueue* compile_queue);
118 virtual nmethod* event(const methodHandle& method, const methodHandle& inlinee, int branch_bci, int bci, CompLevel comp_level, CompiledMethod* nm, JavaThread* thread);
119 virtual void method_invocation_event(const methodHandle& m, JavaThread* thread) = 0;
120 virtual void method_back_branch_event(const methodHandle& m, int bci, JavaThread* thread) = 0;
121 };
122
123 class SimpleCompPolicy : public NonTieredCompPolicy {
124 public:
125 virtual void method_invocation_event(const methodHandle& m, JavaThread* thread);
126 virtual void method_back_branch_event(const methodHandle& m, int bci, JavaThread* thread);
127 };
128
129 // StackWalkCompPolicy - existing C2 policy
130
131 #ifdef COMPILER2
132 class StackWalkCompPolicy : public NonTieredCompPolicy {
133 public:
134 virtual void method_invocation_event(const methodHandle& m, JavaThread* thread);
135 virtual void method_back_branch_event(const methodHandle& m, int bci, JavaThread* thread);
136
137 private:
138 RFrame* findTopInlinableFrame(GrowableArray<RFrame*>* stack);
139 RFrame* senderOf(RFrame* rf, GrowableArray<RFrame*>* stack);
140
141 // the following variables hold values computed by the last inlining decision
142 // they are used for performance debugging only (print better messages)
143 static const char* _msg; // reason for not inlining
144
145 static const char* shouldInline (const methodHandle& callee, float frequency, int cnt);
146 // positive filter: should send be inlined? returns NULL (--> yes) or rejection msg
147 static const char* shouldNotInline(const methodHandle& callee);
148 // negative filter: should send NOT be inlined? returns NULL (--> inline) or rejection msg
149
150 };
151 #endif
152
153 #endif // SHARE_VM_RUNTIME_COMPILATIONPOLICY_HPP