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