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