1 /* 2 * Copyright (c) 2000, 2013, 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_OPTO_CALLGENERATOR_HPP 26 #define SHARE_VM_OPTO_CALLGENERATOR_HPP 27 28 #include "compiler/compileBroker.hpp" 29 #include "opto/callnode.hpp" 30 #include "opto/compile.hpp" 31 #include "opto/type.hpp" 32 #include "runtime/deoptimization.hpp" 33 34 class Parse; 35 36 //---------------------------CallGenerator------------------------------------- 37 // The subclasses of this class handle generation of ideal nodes for 38 // call sites and method entry points. 39 40 class CallGenerator : public ResourceObj { 41 public: 42 enum { 43 xxxunusedxxx 44 }; 45 46 private: 47 ciMethod* _method; // The method being called. 48 49 protected: 50 CallGenerator(ciMethod* method) : _method(method) {} 51 52 public: 53 // Accessors 54 ciMethod* method() const { return _method; } 55 56 // is_inline: At least some code implementing the method is copied here. 57 virtual bool is_inline() const { return false; } 58 // is_intrinsic: There's a method-specific way of generating the inline code. 59 virtual bool is_intrinsic() const { return false; } 60 // is_parse: Bytecodes implementing the specific method are copied here. 61 virtual bool is_parse() const { return false; } 62 // is_virtual: The call uses the receiver type to select or check the method. 63 virtual bool is_virtual() const { return false; } 64 // is_deferred: The decision whether to inline or not is deferred. 65 virtual bool is_deferred() const { return false; } 66 // is_predicted: Uses an explicit check against a predicted type. 67 virtual bool is_predicted() const { return false; } 68 // is_trap: Does not return to the caller. (E.g., uncommon trap.) 69 virtual bool is_trap() const { return false; } 70 // does_virtual_dispatch: Should try inlining as normal method first. 71 virtual bool does_virtual_dispatch() const { return false; } 72 73 // is_late_inline: supports conversion of call into an inline 74 virtual bool is_late_inline() const { return false; } 75 // same but for method handle calls 76 virtual bool is_mh_late_inline() const { return false; } 77 virtual bool is_string_late_inline() const{ return false; } 78 79 // for method handle calls: have we tried inlinining the call already? 80 virtual bool already_attempted() const { ShouldNotReachHere(); return false; } 81 82 // Replace the call with an inline version of the code 83 virtual void do_late_inline() { ShouldNotReachHere(); } 84 85 virtual CallStaticJavaNode* call_node() const { ShouldNotReachHere(); return NULL; } 86 87 // Note: It is possible for a CG to be both inline and virtual. 88 // (The hashCode intrinsic does a vtable check and an inlined fast path.) 89 90 // Utilities: 91 const TypeFunc* tf() const; 92 93 // The given jvms has state and arguments for a call to my method. 94 // Edges after jvms->argoff() carry all (pre-popped) argument values. 95 // 96 // Update the map with state and return values (if any) and return it. 97 // The return values (0, 1, or 2) must be pushed on the map's stack, 98 // and the sp of the jvms incremented accordingly. 99 // 100 // The jvms is returned on success. Alternatively, a copy of the 101 // given jvms, suitably updated, may be returned, in which case the 102 // caller should discard the original jvms. 103 // 104 // The non-Parm edges of the returned map will contain updated global state, 105 // and one or two edges before jvms->sp() will carry any return values. 106 // Other map edges may contain locals or monitors, and should not 107 // be changed in meaning. 108 // 109 // If the call traps, the returned map must have a control edge of top. 110 // If the call can throw, the returned map must report has_exceptions(). 111 // 112 // If the result is NULL, it means that this CallGenerator was unable 113 // to handle the given call, and another CallGenerator should be consulted. 114 virtual JVMState* generate(JVMState* jvms, Parse* parent_parser) = 0; 115 116 // How to generate a call site that is inlined: 117 static CallGenerator* for_inline(ciMethod* m, float expected_uses = -1); 118 // How to generate code for an on-stack replacement handler. 119 static CallGenerator* for_osr(ciMethod* m, int osr_bci); 120 121 // How to generate vanilla out-of-line call sites: 122 static CallGenerator* for_direct_call(ciMethod* m, bool separate_io_projs = false); // static, special 123 static CallGenerator* for_virtual_call(ciMethod* m, int vtable_index); // virtual, interface 124 static CallGenerator* for_dynamic_call(ciMethod* m); // invokedynamic 125 126 static CallGenerator* for_method_handle_call( JVMState* jvms, ciMethod* caller, ciMethod* callee, bool delayed_forbidden); 127 static CallGenerator* for_method_handle_inline(JVMState* jvms, ciMethod* caller, ciMethod* callee, bool& input_not_const); 128 129 // How to generate a replace a direct call with an inline version 130 static CallGenerator* for_late_inline(ciMethod* m, CallGenerator* inline_cg); 131 static CallGenerator* for_mh_late_inline(ciMethod* caller, ciMethod* callee, bool input_not_const); 132 static CallGenerator* for_string_late_inline(ciMethod* m, CallGenerator* inline_cg); 133 static CallGenerator* for_boxing_late_inline(ciMethod* m, CallGenerator* inline_cg); 134 135 // How to make a call but defer the decision whether to inline or not. 136 static CallGenerator* for_warm_call(WarmCallInfo* ci, 137 CallGenerator* if_cold, 138 CallGenerator* if_hot); 139 140 // How to make a call that optimistically assumes a receiver type: 141 static CallGenerator* for_predicted_call(ciKlass* predicted_receiver, 142 CallGenerator* if_missed, 143 CallGenerator* if_hit, 144 float hit_prob); 145 146 // How to make a call that optimistically assumes a MethodHandle target: 147 static CallGenerator* for_predicted_dynamic_call(ciMethodHandle* predicted_method_handle, 148 CallGenerator* if_missed, 149 CallGenerator* if_hit, 150 float hit_prob); 151 152 // How to make a call that gives up and goes back to the interpreter: 153 static CallGenerator* for_uncommon_trap(ciMethod* m, 154 Deoptimization::DeoptReason reason, 155 Deoptimization::DeoptAction action); 156 157 // Registry for intrinsics: 158 static CallGenerator* for_intrinsic(ciMethod* m); 159 static void register_intrinsic(ciMethod* m, CallGenerator* cg); 160 static CallGenerator* for_predicted_intrinsic(CallGenerator* intrinsic, 161 CallGenerator* cg); 162 virtual Node* generate_predicate(JVMState* jvms) { return NULL; }; 163 164 virtual void print_inlining_late(const char* msg) { ShouldNotReachHere(); } 165 166 static void print_inlining(Compile* C, ciMethod* callee, int inline_level, int bci, const char* msg) { 167 if (C->print_inlining()) { 168 C->print_inlining(callee, inline_level, bci, msg); 169 } 170 } 171 }; 172 173 174 //------------------------InlineCallGenerator---------------------------------- 175 class InlineCallGenerator : public CallGenerator { 176 protected: 177 InlineCallGenerator(ciMethod* method) : CallGenerator(method) {} 178 179 public: 180 virtual bool is_inline() const { return true; } 181 }; 182 183 184 //---------------------------WarmCallInfo-------------------------------------- 185 // A struct to collect information about a given call site. 186 // Helps sort call sites into "hot", "medium", and "cold". 187 // Participates in the queueing of "medium" call sites for possible inlining. 188 class WarmCallInfo : public ResourceObj { 189 private: 190 191 CallNode* _call; // The CallNode which may be inlined. 192 CallGenerator* _hot_cg;// CG for expanding the call node 193 194 // These are the metrics we use to evaluate call sites: 195 196 float _count; // How often do we expect to reach this site? 197 float _profit; // How much time do we expect to save by inlining? 198 float _work; // How long do we expect the average call to take? 199 float _size; // How big do we expect the inlined code to be? 200 201 float _heat; // Combined score inducing total order on call sites. 202 WarmCallInfo* _next; // Next cooler call info in pending queue. 203 204 // Count is the number of times this call site is expected to be executed. 205 // Large count is favorable for inlining, because the extra compilation 206 // work will be amortized more completely. 207 208 // Profit is a rough measure of the amount of time we expect to save 209 // per execution of this site if we inline it. (1.0 == call overhead) 210 // Large profit favors inlining. Negative profit disables inlining. 211 212 // Work is a rough measure of the amount of time a typical out-of-line 213 // call from this site is expected to take. (1.0 == call, no-op, return) 214 // Small work is somewhat favorable for inlining, since methods with 215 // short "hot" traces are more likely to inline smoothly. 216 217 // Size is the number of graph nodes we expect this method to produce, 218 // not counting the inlining of any further warm calls it may include. 219 // Small size favors inlining, since small methods are more likely to 220 // inline smoothly. The size is estimated by examining the native code 221 // if available. The method bytecodes are also examined, assuming 222 // empirically observed node counts for each kind of bytecode. 223 224 // Heat is the combined "goodness" of a site's inlining. If we were 225 // omniscient, it would be the difference of two sums of future execution 226 // times of code emitted for this site (amortized across multiple sites if 227 // sharing applies). The two sums are for versions of this call site with 228 // and without inlining. 229 230 // We approximate this mythical quantity by playing with averages, 231 // rough estimates, and assumptions that history repeats itself. 232 // The basic formula count * profit is heuristically adjusted 233 // by looking at the expected compilation and execution times of 234 // of the inlined call. 235 236 // Note: Some of these metrics may not be present in the final product, 237 // but exist in development builds to experiment with inline policy tuning. 238 239 // This heuristic framework does not model well the very significant 240 // effects of multiple-level inlining. It is possible to see no immediate 241 // profit from inlining X->Y, but to get great profit from a subsequent 242 // inlining X->Y->Z. 243 244 // This framework does not take well into account the problem of N**2 code 245 // size in a clique of mutually inlinable methods. 246 247 WarmCallInfo* next() const { return _next; } 248 void set_next(WarmCallInfo* n) { _next = n; } 249 250 static WarmCallInfo _always_hot; 251 static WarmCallInfo _always_cold; 252 253 // Constructor intitialization of always_hot and always_cold 254 WarmCallInfo(float c, float p, float w, float s) { 255 _call = NULL; 256 _hot_cg = NULL; 257 _next = NULL; 258 _count = c; 259 _profit = p; 260 _work = w; 261 _size = s; 262 _heat = 0; 263 } 264 265 public: 266 // Because WarmInfo objects live over the entire lifetime of the 267 // Compile object, they are allocated into the comp_arena, which 268 // does not get resource marked or reset during the compile process 269 void *operator new( size_t x, Compile* C ) throw() { return C->comp_arena()->Amalloc(x); } 270 void operator delete( void * ) { } // fast deallocation 271 272 static WarmCallInfo* always_hot(); 273 static WarmCallInfo* always_cold(); 274 275 WarmCallInfo() { 276 _call = NULL; 277 _hot_cg = NULL; 278 _next = NULL; 279 _count = _profit = _work = _size = _heat = 0; 280 } 281 282 CallNode* call() const { return _call; } 283 float count() const { return _count; } 284 float size() const { return _size; } 285 float work() const { return _work; } 286 float profit() const { return _profit; } 287 float heat() const { return _heat; } 288 289 void set_count(float x) { _count = x; } 290 void set_size(float x) { _size = x; } 291 void set_work(float x) { _work = x; } 292 void set_profit(float x) { _profit = x; } 293 void set_heat(float x) { _heat = x; } 294 295 // Load initial heuristics from profiles, etc. 296 // The heuristics can be tweaked further by the caller. 297 void init(JVMState* call_site, ciMethod* call_method, ciCallProfile& profile, float prof_factor); 298 299 static float MAX_VALUE() { return +1.0e10; } 300 static float MIN_VALUE() { return -1.0e10; } 301 302 float compute_heat() const; 303 304 void set_call(CallNode* call) { _call = call; } 305 void set_hot_cg(CallGenerator* cg) { _hot_cg = cg; } 306 307 // Do not queue very hot or very cold calls. 308 // Make very cold ones out of line immediately. 309 // Inline very hot ones immediately. 310 // These queries apply various tunable limits 311 // to the above metrics in a systematic way. 312 // Test for coldness before testing for hotness. 313 bool is_cold() const; 314 bool is_hot() const; 315 316 // Force a warm call to be hot. This worklists the call node for inlining. 317 void make_hot(); 318 319 // Force a warm call to be cold. This worklists the call node for out-of-lining. 320 void make_cold(); 321 322 // A reproducible total ordering, in which heat is the major key. 323 bool warmer_than(WarmCallInfo* that); 324 325 // List management. These methods are called with the list head, 326 // and return the new list head, inserting or removing the receiver. 327 WarmCallInfo* insert_into(WarmCallInfo* head); 328 WarmCallInfo* remove_from(WarmCallInfo* head); 329 330 #ifndef PRODUCT 331 void print() const; 332 void print_all() const; 333 int count_all() const; 334 #endif 335 }; 336 337 #endif // SHARE_VM_OPTO_CALLGENERATOR_HPP