1 /*
  2  * Copyright (c) 2015, 2021, 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_CODE_COMPILEDMETHOD_HPP
 26 #define SHARE_CODE_COMPILEDMETHOD_HPP
 27 
 28 #include "code/codeBlob.hpp"
 29 #include "code/pcDesc.hpp"
 30 #include "oops/metadata.hpp"
 31 #include "oops/method.hpp"
 32 
 33 class Dependencies;
 34 class ExceptionHandlerTable;
 35 class ImplicitExceptionTable;
 36 class AbstractCompiler;
 37 class xmlStream;
 38 class CompiledStaticCall;
 39 class NativeCallWrapper;
 40 class ScopeDesc;
 41 class CompiledIC;
 42 class MetadataClosure;
 43 
 44 // This class is used internally by nmethods, to cache
 45 // exception/pc/handler information.
 46 
 47 class ExceptionCache : public CHeapObj<mtCode> {
 48   friend class VMStructs;
 49  private:
 50   enum { cache_size = 16 };
 51   Klass*   _exception_type;
 52   address  _pc[cache_size];
 53   address  _handler[cache_size];
 54   volatile int _count;
 55   ExceptionCache* volatile _next;
 56   ExceptionCache* _purge_list_next;
 57 
 58   inline address pc_at(int index);
 59   void set_pc_at(int index, address a)      { assert(index >= 0 && index < cache_size,""); _pc[index] = a; }
 60 
 61   inline address handler_at(int index);
 62   void set_handler_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _handler[index] = a; }
 63 
 64   inline int count();
 65   // increment_count is only called under lock, but there may be concurrent readers.
 66   void increment_count();
 67 
 68  public:
 69 
 70   ExceptionCache(Handle exception, address pc, address handler);
 71 
 72   Klass*    exception_type()                { return _exception_type; }
 73   ExceptionCache* next();
 74   void      set_next(ExceptionCache *ec);
 75   ExceptionCache* purge_list_next()                 { return _purge_list_next; }
 76   void      set_purge_list_next(ExceptionCache *ec) { _purge_list_next = ec; }
 77 
 78   address match(Handle exception, address pc);
 79   bool    match_exception_with_space(Handle exception) ;
 80   address test_address(address addr);
 81   bool    add_address_and_handler(address addr, address handler) ;
 82 };
 83 
 84 class nmethod;
 85 
 86 // cache pc descs found in earlier inquiries
 87 class PcDescCache {
 88   friend class VMStructs;
 89  private:
 90   enum { cache_size = 4 };
 91   // The array elements MUST be volatile! Several threads may modify
 92   // and read from the cache concurrently. find_pc_desc_internal has
 93   // returned wrong results. C++ compiler (namely xlC12) may duplicate
 94   // C++ field accesses if the elements are not volatile.
 95   typedef PcDesc* PcDescPtr;
 96   volatile PcDescPtr _pc_descs[cache_size]; // last cache_size pc_descs found
 97  public:
 98   PcDescCache() { debug_only(_pc_descs[0] = NULL); }
 99   void    reset_to(PcDesc* initial_pc_desc);
100   PcDesc* find_pc_desc(int pc_offset, bool approximate);
101   void    add_pc_desc(PcDesc* pc_desc);
102   PcDesc* last_pc_desc() { return _pc_descs[0]; }
103 };
104 
105 class PcDescSearch {
106 private:
107   address _code_begin;
108   PcDesc* _lower;
109   PcDesc* _upper;
110 public:
111   PcDescSearch(address code, PcDesc* lower, PcDesc* upper) :
112     _code_begin(code), _lower(lower), _upper(upper)
113   {
114   }
115 
116   address code_begin() const { return _code_begin; }
117   PcDesc* scopes_pcs_begin() const { return _lower; }
118   PcDesc* scopes_pcs_end() const { return _upper; }
119 };
120 
121 class PcDescContainer {
122 private:
123   PcDescCache _pc_desc_cache;
124 public:
125   PcDescContainer() {}
126 
127   PcDesc* find_pc_desc_internal(address pc, bool approximate, const PcDescSearch& search);
128   void    reset_to(PcDesc* initial_pc_desc) { _pc_desc_cache.reset_to(initial_pc_desc); }
129 
130   PcDesc* find_pc_desc(address pc, bool approximate, const PcDescSearch& search) {
131     address base_address = search.code_begin();
132     PcDesc* desc = _pc_desc_cache.last_pc_desc();
133     if (desc != NULL && desc->pc_offset() == pc - base_address) {
134       return desc;
135     }
136     return find_pc_desc_internal(pc, approximate, search);
137   }
138 };
139 
140 
141 class CompiledMethod : public CodeBlob {
142   friend class VMStructs;
143   friend class NMethodSweeper;
144 
145   void init_defaults();
146 protected:
147   enum MarkForDeoptimizationStatus : u1 {
148     not_marked,
149     deoptimize,
150     deoptimize_noupdate,
151     deoptimize_done
152   };
153 
154   MarkForDeoptimizationStatus _mark_for_deoptimization_status; // Used for stack deoptimization
155 
156   // set during construction
157   unsigned int _has_unsafe_access:1;         // May fault due to unsafe access.
158   unsigned int _has_method_handle_invokes:1; // Has this method MethodHandle invokes?
159   unsigned int _has_wide_vectors:1;          // Preserve wide vectors at safepoints
160   unsigned int _has_monitors:1;              // Fastpath monitor detection for continuations
161 
162   Method*   _method;
163   address _scopes_data_begin;
164   // All deoptee's will resume execution at this location described by
165   // this address.
166   address _deopt_handler_begin;
167   // All deoptee's at a MethodHandle call site will resume execution
168   // at this location described by this offset.
169   address _deopt_mh_handler_begin;
170 
171   PcDescContainer _pc_desc_container;
172   ExceptionCache * volatile _exception_cache;
173 
174   void* _gc_data;
175 
176   virtual void flush() = 0;
177 
178 protected:
179   CompiledMethod(Method* method, const char* name, CompilerType type, const CodeBlobLayout& layout, int frame_complete_offset, int frame_size, ImmutableOopMapSet* oop_maps, bool caller_must_gc_arguments, bool compiled);
180   CompiledMethod(Method* method, const char* name, CompilerType type, int size, int header_size, CodeBuffer* cb, int frame_complete_offset, int frame_size, OopMapSet* oop_maps, bool caller_must_gc_arguments, bool compiled);
181 
182 public:
183   // Only used by unit test.
184   CompiledMethod() {}
185 
186   template<typename T>
187   T* gc_data() const                              { return reinterpret_cast<T*>(_gc_data); }
188   template<typename T>
189   void set_gc_data(T* gc_data)                    { _gc_data = reinterpret_cast<void*>(gc_data); }
190 
191   bool  has_unsafe_access() const                 { return _has_unsafe_access; }
192   void  set_has_unsafe_access(bool z)             { _has_unsafe_access = z; }
193 
194   bool  has_monitors() const                      { return _has_monitors; }
195   void  set_has_monitors(bool z)                  { _has_monitors = z; }
196 
197   bool  has_method_handle_invokes() const         { return _has_method_handle_invokes; }
198   void  set_has_method_handle_invokes(bool z)     { _has_method_handle_invokes = z; }
199 
200   bool  has_wide_vectors() const                  { return _has_wide_vectors; }
201   void  set_has_wide_vectors(bool z)              { _has_wide_vectors = z; }
202 
203   enum { not_installed = -1, // in construction, only the owner doing the construction is
204                              // allowed to advance state
205          in_use        = 0,  // executable nmethod
206          not_used      = 1,  // not entrant, but revivable
207          not_entrant   = 2,  // marked for deoptimization but activations may still exist,
208                              // will be transformed to zombie when all activations are gone
209          unloaded      = 3,  // there should be no activations, should not be called, will be
210                              // transformed to zombie by the sweeper, when not "locked in vm".
211          zombie        = 4   // no activations exist, nmethod is ready for purge
212   };
213 
214   virtual bool  is_in_use() const = 0;
215   virtual int   comp_level() const = 0;
216   virtual int   compile_id() const = 0;
217 
218   virtual address verified_entry_point() const = 0;
219   virtual void log_identity(xmlStream* log) const = 0;
220   virtual void log_state_change() const = 0;
221   virtual bool make_not_used() = 0;
222   virtual bool make_not_entrant() = 0;
223   virtual bool make_entrant() = 0;
224   virtual address entry_point() const = 0;
225   virtual bool make_zombie() = 0;
226   virtual bool is_osr_method() const = 0;
227   virtual int osr_entry_bci() const = 0;
228   Method* method() const                          { return _method; }
229   virtual void print_pcs() = 0;
230   bool is_native_method() const { return _method != NULL && _method->is_native(); }
231   bool is_java_method() const { return _method != NULL && !_method->is_native(); }
232 
233   // ScopeDesc retrieval operation
234   PcDesc* pc_desc_at(address pc)   { return find_pc_desc(pc, false); }
235   // pc_desc_near returns the first PcDesc at or after the given pc.
236   PcDesc* pc_desc_near(address pc) { return find_pc_desc(pc, true); }
237 
238   // ScopeDesc for an instruction
239   ScopeDesc* scope_desc_at(address pc);
240   ScopeDesc* scope_desc_near(address pc);
241 
242   bool is_at_poll_return(address pc);
243   bool is_at_poll_or_poll_return(address pc);
244 
245   bool  is_marked_for_deoptimization() const { return _mark_for_deoptimization_status != not_marked; }
246   void  mark_for_deoptimization(bool inc_recompile_counts = true);
247 
248   bool  has_been_deoptimized() const { return _mark_for_deoptimization_status == deoptimize_done; }
249   void  mark_deoptimized() { _mark_for_deoptimization_status = deoptimize_done; }
250 
251   virtual void  make_deoptimized() { assert(false, "not supported"); };
252 
253   bool update_recompile_counts() const {
254     // Update recompile counts when either the update is explicitly requested (deoptimize)
255     // or the nmethod is not marked for deoptimization at all (not_marked).
256     // The latter happens during uncommon traps when deoptimized nmethod is made not entrant.
257     return _mark_for_deoptimization_status != deoptimize_noupdate &&
258            _mark_for_deoptimization_status != deoptimize_done;
259   }
260 
261   // tells whether frames described by this nmethod can be deoptimized
262   // note: native wrappers cannot be deoptimized.
263   bool can_be_deoptimized() const { return is_java_method(); }
264 
265   virtual oop oop_at(int index) const = 0;
266   virtual Metadata* metadata_at(int index) const = 0;
267 
268   address scopes_data_begin() const { return _scopes_data_begin; }
269   virtual address scopes_data_end() const = 0;
270   int scopes_data_size() const { return scopes_data_end() - scopes_data_begin(); }
271 
272   virtual PcDesc* scopes_pcs_begin() const = 0;
273   virtual PcDesc* scopes_pcs_end() const = 0;
274   int scopes_pcs_size() const { return (intptr_t) scopes_pcs_end() - (intptr_t) scopes_pcs_begin(); }
275 
276   address insts_begin() const { return code_begin(); }
277   address insts_end() const { return stub_begin(); }
278   // Returns true if a given address is in the 'insts' section. The method
279   // insts_contains_inclusive() is end-inclusive.
280   bool insts_contains(address addr) const { return insts_begin() <= addr && addr < insts_end(); }
281   bool insts_contains_inclusive(address addr) const { return insts_begin() <= addr && addr <= insts_end(); }
282 
283   int insts_size() const { return insts_end() - insts_begin(); }
284 
285   virtual address consts_begin() const = 0;
286   virtual address consts_end() const = 0;
287   bool consts_contains(address addr) const { return consts_begin() <= addr && addr < consts_end(); }
288   int consts_size() const { return consts_end() - consts_begin(); }
289 
290   virtual address stub_begin() const = 0;
291   virtual address stub_end() const = 0;
292   bool stub_contains(address addr) const { return stub_begin() <= addr && addr < stub_end(); }
293   int stub_size() const { return stub_end() - stub_begin(); }
294 
295   virtual address handler_table_begin() const = 0;
296   virtual address handler_table_end() const = 0;
297   bool handler_table_contains(address addr) const { return handler_table_begin() <= addr && addr < handler_table_end(); }
298   int handler_table_size() const { return handler_table_end() - handler_table_begin(); }
299 
300   virtual address exception_begin() const = 0;
301 
302   virtual address nul_chk_table_begin() const = 0;
303   virtual address nul_chk_table_end() const = 0;
304   bool nul_chk_table_contains(address addr) const { return nul_chk_table_begin() <= addr && addr < nul_chk_table_end(); }
305   int nul_chk_table_size() const { return nul_chk_table_end() - nul_chk_table_begin(); }
306 
307   virtual oop* oop_addr_at(int index) const = 0;
308   virtual Metadata** metadata_addr_at(int index) const = 0;
309 
310 protected:
311   // Exception cache support
312   // Note: _exception_cache may be read and cleaned concurrently.
313   ExceptionCache* exception_cache() const         { return _exception_cache; }
314   ExceptionCache* exception_cache_acquire() const;
315   void set_exception_cache(ExceptionCache *ec)    { _exception_cache = ec; }
316 
317 public:
318   address handler_for_exception_and_pc(Handle exception, address pc);
319   void add_handler_for_exception_and_pc(Handle exception, address pc, address handler);
320   void clean_exception_cache();
321 
322   void add_exception_cache_entry(ExceptionCache* new_entry);
323   ExceptionCache* exception_cache_entry_for_exception(Handle exception);
324 
325   // MethodHandle
326   bool is_method_handle_return(address return_pc);
327   address deopt_mh_handler_begin() const  { return _deopt_mh_handler_begin; }
328 
329   address deopt_handler_begin() const { return _deopt_handler_begin; }
330   address* deopt_handler_begin_addr()        { return &_deopt_handler_begin; }
331   // Deopt
332   // Return true is the PC is one would expect if the frame is being deopted.
333   inline bool is_deopt_pc(address pc);
334   inline bool is_deopt_mh_entry(address pc);
335   inline bool is_deopt_entry(address pc);
336 
337   // Accessor/mutator for the original pc of a frame before a frame was deopted.
338   address get_original_pc(const frame* fr) { return *orig_pc_addr(fr); }
339   void    set_original_pc(const frame* fr, address pc) { *orig_pc_addr(fr) = pc; }
340 
341   virtual int orig_pc_offset() = 0;
342 private:
343   address* orig_pc_addr(const frame* fr);
344 
345 public:
346   virtual bool can_convert_to_zombie() = 0;
347   virtual const char* compile_kind() const = 0;
348   virtual int get_state() const = 0;
349 
350   const char* state() const;
351 
352   bool inlinecache_check_contains(address addr) const {
353     return (addr >= code_begin() && addr < verified_entry_point());
354   }
355 
356   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f);
357 
358   // implicit exceptions support
359   address continuation_for_implicit_div0_exception(address pc) { return continuation_for_implicit_exception(pc, true); }
360   address continuation_for_implicit_null_exception(address pc) { return continuation_for_implicit_exception(pc, false); }
361 
362   static address get_deopt_original_pc(const frame* fr);
363 
364   // Inline cache support for class unloading and nmethod unloading
365  private:
366   bool cleanup_inline_caches_impl(bool unloading_occurred, bool clean_all);
367 
368   address continuation_for_implicit_exception(address pc, bool for_div0_check);
369 
370  public:
371   // Serial version used by sweeper and whitebox test
372   void cleanup_inline_caches(bool clean_all);
373 
374   virtual void clear_inline_caches();
375   void clear_ic_callsites();
376 
377   // Execute nmethod barrier code, as if entering through nmethod call.
378   void run_nmethod_entry_barrier();
379 
380   // Verify and count cached icholder relocations.
381   int  verify_icholder_relocations();
382   void verify_oop_relocations();
383 
384   bool has_evol_metadata();
385 
386   // Fast breakpoint support. Tells if this compiled method is
387   // dependent on the given method. Returns true if this nmethod
388   // corresponds to the given method as well.
389   virtual bool is_dependent_on_method(Method* dependee) = 0;
390 
391   virtual NativeCallWrapper* call_wrapper_at(address call) const = 0;
392   virtual NativeCallWrapper* call_wrapper_before(address return_pc) const = 0;
393   virtual address call_instruction_address(address pc) const = 0;
394 
395   virtual CompiledStaticCall* compiledStaticCall_at(Relocation* call_site) const = 0;
396   virtual CompiledStaticCall* compiledStaticCall_at(address addr) const = 0;
397   virtual CompiledStaticCall* compiledStaticCall_before(address addr) const = 0;
398 
399   Method* attached_method(address call_pc);
400   Method* attached_method_before_pc(address pc);
401 
402   virtual void metadata_do(MetadataClosure* f) = 0;
403 
404   // GC support
405  protected:
406   address oops_reloc_begin() const;
407 
408  private:
409   bool static clean_ic_if_metadata_is_dead(CompiledIC *ic);
410 
411  public:
412   // GC unloading support
413   // Cleans unloaded klasses and unloaded nmethods in inline caches
414 
415   virtual bool is_unloading() = 0;
416 
417   bool unload_nmethod_caches(bool class_unloading_occurred);
418   virtual void do_unloading(bool unloading_occurred) = 0;
419 
420 private:
421   PcDesc* find_pc_desc(address pc, bool approximate) {
422     return _pc_desc_container.find_pc_desc(pc, approximate, PcDescSearch(code_begin(), scopes_pcs_begin(), scopes_pcs_end()));
423   }
424 };
425 
426 #endif // SHARE_CODE_COMPILEDMETHOD_HPP