1 /*
  2  * Copyright (c) 1999, 2022, 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_CI_CIENV_HPP
 26 #define SHARE_CI_CIENV_HPP
 27 
 28 #include "ci/ciClassList.hpp"
 29 #include "ci/ciObjectFactory.hpp"
 30 #include "ci/ciReplay.hpp"
 31 #include "classfile/vmClassMacros.hpp"
 32 #include "code/debugInfoRec.hpp"
 33 #include "code/dependencies.hpp"
 34 #include "code/exceptionHandlerTable.hpp"
 35 #include "compiler/compilerThread.hpp"
 36 #include "oops/methodData.hpp"
 37 #include "runtime/thread.hpp"
 38 
 39 class CompileTask;
 40 class OopMapSet;
 41 
 42 // ciEnv
 43 //
 44 // This class is the top level broker for requests from the compiler
 45 // to the VM.
 46 class ciEnv : StackObj {
 47   CI_PACKAGE_ACCESS_TO
 48   friend class CompileBroker;
 49   friend class Dependencies;  // for get_object, during logging
 50   friend class RecordLocation;
 51   friend class PrepareExtraDataClosure;
 52 
 53 private:
 54   Arena*           _arena;       // Alias for _ciEnv_arena except in init_shared_objects()
 55   Arena            _ciEnv_arena;
 56   ciObjectFactory* _factory;
 57   OopRecorder*     _oop_recorder;
 58   DebugInformationRecorder* _debug_info;
 59   Dependencies*    _dependencies;
 60   const char*      _failure_reason;
 61   bool             _inc_decompile_count_on_failure;
 62   int              _compilable;
 63   bool             _break_at_compile;
 64   int              _num_inlined_bytecodes;
 65   CompileTask*     _task;           // faster access to CompilerThread::task
 66   CompileLog*      _log;            // faster access to CompilerThread::log
 67   void*            _compiler_data;  // compiler-specific stuff, if any
 68 
 69   char* _name_buffer;
 70   int   _name_buffer_len;
 71 
 72   // Cache Jvmti state
 73   uint64_t _jvmti_redefinition_count;
 74   bool  _jvmti_can_hotswap_or_post_breakpoint;
 75   bool  _jvmti_can_access_local_variables;
 76   bool  _jvmti_can_post_on_exceptions;
 77   bool  _jvmti_can_pop_frame;
 78   bool  _jvmti_can_get_owned_monitor_info; // includes can_get_owned_monitor_stack_depth_info
 79   bool  _jvmti_can_walk_any_space;
 80 
 81   // Cache DTrace flags
 82   bool  _dtrace_extended_probes;
 83   bool  _dtrace_method_probes;
 84   bool  _dtrace_alloc_probes;
 85 
 86   // Distinguished instances of certain ciObjects..
 87   static ciObject*              _null_object_instance;
 88 
 89 #define VM_CLASS_DECL(name, ignore_s) static ciInstanceKlass* _##name;
 90   VM_CLASSES_DO(VM_CLASS_DECL)
 91 #undef VM_CLASS_DECL
 92 
 93   static ciSymbol*        _unloaded_cisymbol;
 94   static ciInstanceKlass* _unloaded_ciinstance_klass;
 95   static ciObjArrayKlass* _unloaded_ciobjarrayklass;
 96 
 97   static jobject _ArrayIndexOutOfBoundsException_handle;
 98   static jobject _ArrayStoreException_handle;
 99   static jobject _ClassCastException_handle;
100 
101   ciInstance* _NullPointerException_instance;
102   ciInstance* _ArithmeticException_instance;
103   ciInstance* _ArrayIndexOutOfBoundsException_instance;
104   ciInstance* _ArrayStoreException_instance;
105   ciInstance* _ClassCastException_instance;
106 
107   ciInstance* _the_null_string;      // The Java string "null"
108   ciInstance* _the_min_jint_string; // The Java string "-2147483648"
109 
110   // Look up a klass by name from a particular class loader (the accessor's).
111   // If require_local, result must be defined in that class loader, or NULL.
112   // If !require_local, a result from remote class loader may be reported,
113   // if sufficient class loader constraints exist such that initiating
114   // a class loading request from the given loader is bound to return
115   // the class defined in the remote loader (or throw an error).
116   //
117   // Return an unloaded klass if !require_local and no class at all is found.
118   //
119   // The CI treats a klass as loaded if it is consistently defined in
120   // another loader, even if it hasn't yet been loaded in all loaders
121   // that could potentially see it via delegation.
122   ciKlass* get_klass_by_name(ciKlass* accessing_klass,
123                              ciSymbol* klass_name,
124                              bool require_local);
125 
126   // Constant pool access.
127   ciKlass*   get_klass_by_index(const constantPoolHandle& cpool,
128                                 int klass_index,
129                                 bool& is_accessible,
130                                 ciInstanceKlass* loading_klass);
131   ciConstant get_constant_by_index(const constantPoolHandle& cpool,
132                                    int pool_index, int cache_index,
133                                    ciInstanceKlass* accessor);
134   ciField*   get_field_by_index(ciInstanceKlass* loading_klass,
135                                 int field_index);
136   ciMethod*  get_method_by_index(const constantPoolHandle& cpool,
137                                  int method_index, Bytecodes::Code bc,
138                                  ciInstanceKlass* loading_klass);
139 
140   // Implementation methods for loading and constant pool access.
141   ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
142                                   const constantPoolHandle& cpool,
143                                   ciSymbol* klass_name,
144                                   bool require_local);
145   ciKlass*   get_klass_by_index_impl(const constantPoolHandle& cpool,
146                                      int klass_index,
147                                      bool& is_accessible,
148                                      ciInstanceKlass* loading_klass);
149   ciConstant get_constant_by_index_impl(const constantPoolHandle& cpool,
150                                         int pool_index, int cache_index,
151                                         ciInstanceKlass* loading_klass);
152   ciField*   get_field_by_index_impl(ciInstanceKlass* loading_klass,
153                                      int field_index);
154   ciMethod*  get_method_by_index_impl(const constantPoolHandle& cpool,
155                                       int method_index, Bytecodes::Code bc,
156                                       ciInstanceKlass* loading_klass);
157 
158   // Helper methods
159   bool       check_klass_accessibility(ciKlass* accessing_klass,
160                                       Klass* resolved_klass);
161   Method*    lookup_method(ciInstanceKlass* accessor,
162                            ciKlass*         holder,
163                            Symbol*          name,
164                            Symbol*          sig,
165                            Bytecodes::Code  bc,
166                            constantTag      tag);
167 
168   ciConstant unbox_primitive_value(ciObject* cibox, BasicType expected_bt = T_ILLEGAL);
169   ciConstant get_resolved_constant(const constantPoolHandle& cpool, int obj_index);
170 
171   // Get a ciObject from the object factory.  Ensures uniqueness
172   // of ciObjects.
173   ciObject* get_object(oop o) {
174     if (o == NULL) {
175       return _null_object_instance;
176     } else {
177       return _factory->get(o);
178     }
179   }
180 
181   ciSymbol* get_symbol(Symbol* o) {
182     if (o == NULL) {
183       ShouldNotReachHere();
184       return NULL;
185     } else {
186       return _factory->get_symbol(o);
187     }
188   }
189 
190   ciMetadata* get_metadata(Metadata* o) {
191     if (o == NULL) {
192       return NULL;
193     } else {
194 #ifndef PRODUCT
195       if (ReplayCompiles && o->is_klass()) {
196         Klass* k = (Klass*)o;
197         if (k->is_instance_klass() && ciReplay::is_klass_unresolved((InstanceKlass*)k)) {
198           // Klass was unresolved at replay dump time. Simulate this case.
199           return ciEnv::_unloaded_ciinstance_klass;
200         }
201       }
202 #endif
203       return _factory->get_metadata(o);
204     }
205   }
206 
207   ciMetadata* cached_metadata(Metadata* o) {
208     return _factory->cached_metadata(o);
209   }
210 
211   ciInstance* get_instance(oop o) {
212     if (o == NULL) return NULL;
213     return get_object(o)->as_instance();
214   }
215   ciObjArrayKlass* get_obj_array_klass(Klass* o) {
216     if (o == NULL) return NULL;
217     return get_metadata(o)->as_obj_array_klass();
218   }
219   ciTypeArrayKlass* get_type_array_klass(Klass* o) {
220     if (o == NULL) return NULL;
221     return get_metadata(o)->as_type_array_klass();
222   }
223   ciKlass* get_klass(Klass* o) {
224     if (o == NULL) return NULL;
225     return get_metadata(o)->as_klass();
226   }
227   ciInstanceKlass* get_instance_klass(Klass* o) {
228     if (o == NULL) return NULL;
229     return get_metadata(o)->as_instance_klass();
230   }
231   ciMethod* get_method(Method* o) {
232     if (o == NULL) return NULL;
233     return get_metadata(o)->as_method();
234   }
235   ciMethodData* get_method_data(MethodData* o) {
236     if (o == NULL) return NULL;
237     return get_metadata(o)->as_method_data();
238   }
239 
240   ciMethod* get_method_from_handle(Method* method);
241 
242   ciInstance* get_or_create_exception(jobject& handle, Symbol* name);
243 
244   // Get a ciMethod representing either an unfound method or
245   // a method with an unloaded holder.  Ensures uniqueness of
246   // the result.
247   ciMethod* get_unloaded_method(ciKlass*         holder,
248                                 ciSymbol*        name,
249                                 ciSymbol*        signature,
250                                 ciInstanceKlass* accessor) {
251     ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
252     return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
253   }
254 
255   // Get a ciKlass representing an unloaded klass.
256   // Ensures uniqueness of the result.
257   ciKlass* get_unloaded_klass(ciKlass*  accessing_klass,
258                               ciSymbol* name) {
259     return _factory->get_unloaded_klass(accessing_klass, name, true);
260   }
261 
262   // Get a ciKlass representing an unloaded klass mirror.
263   // Result is not necessarily unique, but will be unloaded.
264   ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
265     return _factory->get_unloaded_klass_mirror(type);
266   }
267 
268   // Get a ciInstance representing an unresolved method handle constant.
269   ciInstance* get_unloaded_method_handle_constant(ciKlass*  holder,
270                                                   ciSymbol* name,
271                                                   ciSymbol* signature,
272                                                   int       ref_kind) {
273     return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
274   }
275 
276   // Get a ciInstance representing an unresolved method type constant.
277   ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
278     return _factory->get_unloaded_method_type_constant(signature);
279   }
280 
281   // See if we already have an unloaded klass for the given name
282   // or return NULL if not.
283   ciKlass *check_get_unloaded_klass(ciKlass*  accessing_klass, ciSymbol* name) {
284     return _factory->get_unloaded_klass(accessing_klass, name, false);
285   }
286 
287   // Get a ciReturnAddress corresponding to the given bci.
288   // Ensures uniqueness of the result.
289   ciReturnAddress* get_return_address(int bci) {
290     return _factory->get_return_address(bci);
291   }
292 
293   // Get a ciMethodData representing the methodData for a method
294   // with none.
295   ciMethodData* get_empty_methodData() {
296     return _factory->get_empty_methodData();
297   }
298 
299   // General utility : get a buffer of some required length.
300   // Used in symbol creation.
301   char* name_buffer(int req_len);
302 
303   // Is this thread currently in the VM state?
304   static bool is_in_vm();
305 
306   // Helper routine for determining the validity of a compilation with
307   // respect to method dependencies (e.g. concurrent class loading).
308   void validate_compile_task_dependencies(ciMethod* target);
309 public:
310   enum {
311     MethodCompilable,
312     MethodCompilable_not_at_tier,
313     MethodCompilable_never
314   };
315 
316   ciEnv(CompileTask* task);
317   // Used only during initialization of the ci
318   ciEnv(Arena* arena);
319   ~ciEnv();
320 
321   OopRecorder* oop_recorder() { return _oop_recorder; }
322   void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
323 
324   DebugInformationRecorder* debug_info() { return _debug_info; }
325   void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
326 
327   Dependencies* dependencies() { return _dependencies; }
328   void set_dependencies(Dependencies* d) { _dependencies = d; }
329 
330   // This is true if the compilation is not going to produce code.
331   // (It is reasonable to retry failed compilations.)
332   bool failing() { return _failure_reason != NULL; }
333 
334   // Reason this compilation is failing, such as "too many basic blocks".
335   const char* failure_reason() { return _failure_reason; }
336 
337   // Return state of appropriate compatibility
338   int compilable() { return _compilable; }
339 
340   const char* retry_message() const {
341     switch (_compilable) {
342       case ciEnv::MethodCompilable_not_at_tier:
343         return "retry at different tier";
344       case ciEnv::MethodCompilable_never:
345         return "not retryable";
346       case ciEnv::MethodCompilable:
347         return NULL;
348       default:
349         ShouldNotReachHere();
350         return NULL;
351     }
352   }
353 
354   bool break_at_compile() { return _break_at_compile; }
355   void set_break_at_compile(bool z) { _break_at_compile = z; }
356 
357   // Cache Jvmti state
358   bool  cache_jvmti_state();
359   bool  jvmti_state_changed() const;
360   bool  should_retain_local_variables() const {
361     return _jvmti_can_access_local_variables || _jvmti_can_pop_frame;
362   }
363   bool  jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
364   bool  jvmti_can_post_on_exceptions()         const { return _jvmti_can_post_on_exceptions; }
365   bool  jvmti_can_get_owned_monitor_info()     const { return _jvmti_can_get_owned_monitor_info; }
366   bool  jvmti_can_walk_any_space()             const { return _jvmti_can_walk_any_space; }
367 
368   // Cache DTrace flags
369   void  cache_dtrace_flags();
370   bool  dtrace_extended_probes() const { return _dtrace_extended_probes; }
371   bool  dtrace_method_probes()   const { return _dtrace_method_probes; }
372   bool  dtrace_alloc_probes()    const { return _dtrace_alloc_probes; }
373 
374   // The compiler task which has created this env.
375   // May be useful to find out compile_id, comp_level, etc.
376   CompileTask* task() { return _task; }
377 
378   // Handy forwards to the task:
379   int comp_level();   // task()->comp_level()
380   uint compile_id();  // task()->compile_id()
381 
382   // Register the result of a compilation.
383   void register_method(ciMethod*                 target,
384                        int                       entry_bci,
385                        CodeOffsets*              offsets,
386                        int                       orig_pc_offset,
387                        CodeBuffer*               code_buffer,
388                        int                       frame_words,
389                        OopMapSet*                oop_map_set,
390                        ExceptionHandlerTable*    handler_table,
391                        ImplicitExceptionTable*   inc_table,
392                        AbstractCompiler*         compiler,
393                        bool                      has_unsafe_access,
394                        bool                      has_wide_vectors,
395                        RTMState                  rtm_state = NoRTM,
396                        const GrowableArrayView<RuntimeStub*>& native_invokers = GrowableArrayView<RuntimeStub*>::EMPTY);
397 
398 
399   // Access to certain well known ciObjects.
400 #define VM_CLASS_FUNC(name, ignore_s) \
401   ciInstanceKlass* name() { \
402     return _##name;\
403   }
404   VM_CLASSES_DO(VM_CLASS_FUNC)
405 #undef VM_CLASS_FUNC
406 
407   ciInstance* NullPointerException_instance() {
408     assert(_NullPointerException_instance != NULL, "initialization problem");
409     return _NullPointerException_instance;
410   }
411   ciInstance* ArithmeticException_instance() {
412     assert(_ArithmeticException_instance != NULL, "initialization problem");
413     return _ArithmeticException_instance;
414   }
415 
416   // Lazy constructors:
417   ciInstance* ArrayIndexOutOfBoundsException_instance();
418   ciInstance* ArrayStoreException_instance();
419   ciInstance* ClassCastException_instance();
420 
421   ciInstance* the_null_string();
422   ciInstance* the_min_jint_string();
423 
424   static ciSymbol* unloaded_cisymbol() {
425     return _unloaded_cisymbol;
426   }
427   static ciObjArrayKlass* unloaded_ciobjarrayklass() {
428     return _unloaded_ciobjarrayklass;
429   }
430   static ciInstanceKlass* unloaded_ciinstance_klass() {
431     return _unloaded_ciinstance_klass;
432   }
433   ciInstance* unloaded_ciinstance();
434 
435   ciInstanceKlass* get_box_klass_for_primitive_type(BasicType type);
436 
437   // Note:  To find a class from its name string, use ciSymbol::make,
438   // but consider adding to vmSymbols.hpp instead.
439 
440   // converts the ciKlass* representing the holder of a method into a
441   // ciInstanceKlass*.  This is needed since the holder of a method in
442   // the bytecodes could be an array type.  Basically this converts
443   // array types into java/lang/Object and other types stay as they are.
444   static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
445 
446   // Access to the compile-lifetime allocation arena.
447   Arena*    arena() { return _arena; }
448 
449   // What is the current compilation environment?
450   static ciEnv* current() { return CompilerThread::current()->env(); }
451 
452   // Overload with current thread argument
453   static ciEnv* current(CompilerThread *thread) { return thread->env(); }
454 
455   // Per-compiler data.  (Used by C2 to publish the Compile* pointer.)
456   void* compiler_data() { return _compiler_data; }
457   void set_compiler_data(void* x) { _compiler_data = x; }
458 
459   // Notice that a method has been inlined in the current compile;
460   // used only for statistics.
461   void notice_inlined_method(ciMethod* method);
462 
463   // Total number of bytecodes in inlined methods in this compile
464   int num_inlined_bytecodes() const;
465 
466   // Output stream for logging compilation info.
467   CompileLog* log() { return _log; }
468   void set_log(CompileLog* log) { _log = log; }
469 
470   void record_failure(const char* reason);      // Record failure and report later
471   void report_failure(const char* reason);      // Report failure immediately
472   void record_method_not_compilable(const char* reason, bool all_tiers = false);
473   void record_out_of_memory_failure();
474 
475   // RedefineClasses support
476   void metadata_do(MetadataClosure* f) { _factory->metadata_do(f); }
477 
478   // Replay support
479 private:
480   static int klass_compare(const InstanceKlass* const &ik1, const InstanceKlass* const &ik2) {
481     if (ik1 > ik2) {
482       return 1;
483     } else if (ik1 < ik2) {
484       return -1;
485     } else {
486       return 0;
487     }
488   }
489   bool dyno_loc(const InstanceKlass* ik, const char *&loc) const;
490   void set_dyno_loc(const InstanceKlass* ik);
491   void record_best_dyno_loc(const InstanceKlass* ik);
492   bool print_dyno_loc(outputStream* out, const InstanceKlass* ik) const;
493 
494   GrowableArray<const InstanceKlass*>* _dyno_klasses;
495   GrowableArray<const char *>*         _dyno_locs;
496 
497 #define MAX_DYNO_NAME_LENGTH 1024
498   char _dyno_name[MAX_DYNO_NAME_LENGTH+1];
499 
500 public:
501   // Dump the compilation replay data for the ciEnv to the stream.
502   void dump_replay_data(int compile_id);
503   void dump_inline_data(int compile_id);
504   void dump_replay_data(outputStream* out);
505   void dump_replay_data_unsafe(outputStream* out);
506   void dump_replay_data_helper(outputStream* out);
507   void dump_compile_data(outputStream* out);
508 
509   const char *dyno_name(const InstanceKlass* ik) const;
510   const char *replay_name(const InstanceKlass* ik) const;
511   const char *replay_name(ciKlass* i) const;
512 
513   void record_lambdaform(Thread* thread, oop obj);
514   void record_member(Thread* thread, oop obj);
515   void record_mh(Thread* thread, oop obj);
516   void record_call_site_obj(Thread* thread, oop obj);
517   void record_call_site_method(Thread* thread, Method* adapter);
518   void process_invokedynamic(const constantPoolHandle &cp, int index, JavaThread* thread);
519   void process_invokehandle(const constantPoolHandle &cp, int index, JavaThread* thread);
520   void find_dynamic_call_sites();
521 };
522 
523 #endif // SHARE_CI_CIENV_HPP