1 /*
   2  * Copyright 1999-2010 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 // An XHandler is a C1 internal description for an exception handler
  26 
  27 class XHandler: public CompilationResourceObj {
  28  private:
  29   ciExceptionHandler* _desc;
  30 
  31   BlockBegin*         _entry_block;  // Entry block of xhandler
  32   LIR_List*           _entry_code;   // LIR-operations that must be executed before jumping to entry_block
  33   int                 _entry_pco;    // pco where entry_code (or entry_block if no entry_code) starts
  34   int                 _phi_operand;  // For resolving of phi functions at begin of entry_block
  35   int                 _scope_count;  // for filling ExceptionRangeEntry::scope_count
  36 
  37 #ifdef ASSERT
  38   int                 _lir_op_id;    // op_id of the LIR-operation throwing to this handler
  39 #endif
  40 
  41  public:
  42   // creation
  43   XHandler(ciExceptionHandler* desc)
  44     : _desc(desc)
  45     , _entry_block(NULL)
  46     , _entry_code(NULL)
  47     , _entry_pco(-1)
  48     , _phi_operand(-1)
  49     , _scope_count(-1)
  50 #ifdef ASSERT
  51     , _lir_op_id(-1)
  52 #endif
  53   { }
  54 
  55   XHandler(XHandler* other)
  56     : _desc(other->_desc)
  57     , _entry_block(other->_entry_block)
  58     , _entry_code(other->_entry_code)
  59     , _entry_pco(other->_entry_pco)
  60     , _phi_operand(other->_phi_operand)
  61     , _scope_count(other->_scope_count)
  62 #ifdef ASSERT
  63     , _lir_op_id(other->_lir_op_id)
  64 #endif
  65   { }
  66 
  67   // accessors for data of ciExceptionHandler
  68   int  beg_bci() const                           { return _desc->start(); }
  69   int  end_bci() const                           { return _desc->limit(); }
  70   int  handler_bci() const                       { return _desc->handler_bci(); }
  71   bool is_catch_all() const                      { return _desc->is_catch_all(); }
  72   int  catch_type() const                        { return _desc->catch_klass_index(); }
  73   ciInstanceKlass* catch_klass() const           { return _desc->catch_klass(); }
  74   bool covers(int bci) const                     { return beg_bci() <= bci && bci < end_bci(); }
  75 
  76   // accessors for additional fields
  77   BlockBegin* entry_block() const                { return _entry_block; }
  78   LIR_List*   entry_code() const                 { return _entry_code; }
  79   int         entry_pco() const                  { return _entry_pco; }
  80   int         phi_operand() const                { assert(_phi_operand != -1, "not set"); return _phi_operand; }
  81   int         scope_count() const                { assert(_scope_count != -1, "not set"); return _scope_count; }
  82   DEBUG_ONLY(int lir_op_id() const               { return _lir_op_id; });
  83 
  84   void set_entry_block(BlockBegin* entry_block) {
  85     assert(entry_block->is_set(BlockBegin::exception_entry_flag), "must be an exception handler entry");
  86     assert(entry_block->bci() == handler_bci(), "bci's must correspond");
  87     _entry_block = entry_block;
  88   }
  89   void set_entry_code(LIR_List* entry_code)      { _entry_code = entry_code; }
  90   void set_entry_pco(int entry_pco)              { _entry_pco = entry_pco; }
  91   void set_phi_operand(int phi_operand)          { _phi_operand = phi_operand; }
  92   void set_scope_count(int scope_count)          { _scope_count = scope_count; }
  93   DEBUG_ONLY(void set_lir_op_id(int lir_op_id)   { _lir_op_id = lir_op_id; });
  94 
  95   bool equals(XHandler* other) const;
  96 };
  97 
  98 define_array(_XHandlerArray, XHandler*)
  99 define_stack(_XHandlerList, _XHandlerArray)
 100 
 101 
 102 // XHandlers is the C1 internal list of exception handlers for a method
 103 class XHandlers: public CompilationResourceObj {
 104  private:
 105   _XHandlerList    _list;
 106 
 107  public:
 108   // creation
 109   XHandlers() : _list()                          { }
 110   XHandlers(ciMethod* method);
 111   XHandlers(XHandlers* other);
 112 
 113   // accessors
 114   int       length() const                       { return _list.length(); }
 115   XHandler* handler_at(int i) const              { return _list.at(i); }
 116   bool      has_handlers() const                 { return _list.length() > 0; }
 117   void      append(XHandler* h)                  { _list.append(h); }
 118   XHandler* remove_last()                        { return _list.pop(); }
 119 
 120   bool      could_catch(ciInstanceKlass* klass, bool type_is_exact) const;
 121   bool      equals(XHandlers* others) const;
 122 };
 123 
 124 
 125 class IRScope;
 126 define_array(IRScopeArray, IRScope*)
 127 define_stack(IRScopeList, IRScopeArray)
 128 
 129 class Compilation;
 130 class IRScope: public CompilationResourceObj {
 131  private:
 132   // hierarchy
 133   Compilation*  _compilation;                    // the current compilation
 134   IRScope*      _caller;                         // the caller scope, or NULL
 135   int           _caller_bci;                     // the caller bci of the corresponding (inlined) invoke, or < 0
 136   ValueStack*   _caller_state;                   // the caller state, or NULL
 137   int           _level;                          // the inlining level
 138   ciMethod*     _method;                         // the corresponding method
 139   IRScopeList   _callees;                        // the inlined method scopes
 140 
 141   // graph
 142   XHandlers*    _xhandlers;                      // the exception handlers
 143   int           _number_of_locks;                // the number of monitor lock slots needed
 144   bool          _monitor_pairing_ok;             // the monitor pairing info
 145   BlockBegin*   _start;                          // the start block, successsors are method entries
 146 
 147   // lock stack management
 148   int           _lock_stack_size;                // number of expression stack elements which, if present,
 149                                                  // must be spilled to the stack because of exception
 150                                                  // handling inside inlined methods
 151 
 152   BitMap        _requires_phi_function;          // bit is set if phi functions at loop headers are necessary for a local variable
 153 
 154   // helper functions
 155   BlockBegin* header_block(BlockBegin* entry, BlockBegin::Flag f, ValueStack* state);
 156   BlockBegin* build_graph(Compilation* compilation, int osr_bci);
 157 
 158  public:
 159   // creation
 160   IRScope(Compilation* compilation, IRScope* caller, int caller_bci, ciMethod* method, int osr_bci, bool create_graph = false);
 161 
 162   // accessors
 163   Compilation*  compilation() const              { return _compilation; }
 164   IRScope*      caller() const                   { return _caller; }
 165   int           caller_bci() const               { return _caller_bci; }
 166   ValueStack*   caller_state() const             { return _caller_state; }
 167   int           level() const                    { return _level; }
 168   ciMethod*     method() const                   { return _method; }
 169   int           max_stack() const;               // NOTE: expensive
 170   int           lock_stack_size() const          {
 171     assert(_lock_stack_size != -1, "uninitialized");
 172     return _lock_stack_size;
 173   }
 174   BitMap&       requires_phi_function()          { return _requires_phi_function; }
 175 
 176   // mutators
 177   // Needed because caller state is not ready at time of IRScope construction
 178   void          set_caller_state(ValueStack* state) { _caller_state = state; }
 179   // Needed because caller state changes after IRScope construction.
 180   // Computes number of expression stack elements whose state must be
 181   // preserved in the case of an exception; these may be seen by
 182   // caller scopes. Zero when inlining of methods containing exception
 183   // handlers is disabled, otherwise a conservative approximation.
 184   void          compute_lock_stack_size();
 185 
 186   // hierarchy
 187   bool          is_top_scope() const             { return _caller == NULL; }
 188   void          add_callee(IRScope* callee)      { _callees.append(callee); }
 189   int           number_of_callees() const        { return _callees.length(); }
 190   IRScope*      callee_no(int i) const           { return _callees.at(i); }
 191   int           top_scope_bci() const;
 192 
 193   // accessors, graph
 194   bool          is_valid() const                 { return start() != NULL; }
 195   XHandlers*    xhandlers() const                { return _xhandlers; }
 196   int           number_of_locks() const          { return _number_of_locks; }
 197   void          set_min_number_of_locks(int n)   { if (n > _number_of_locks) _number_of_locks = n; }
 198   bool          monitor_pairing_ok() const       { return _monitor_pairing_ok; }
 199   BlockBegin*   start() const                    { return _start; }
 200 };
 201 
 202 
 203 //
 204 // IRScopeDebugInfo records the debug information for a particular IRScope
 205 // in a particular CodeEmitInfo.  This allows the information to be computed
 206 // once early enough for the OopMap to be available to the LIR and also to be
 207 // reemited for different pcs using the same CodeEmitInfo without recomputing
 208 // everything.
 209 //
 210 
 211 class IRScopeDebugInfo: public CompilationResourceObj {
 212  private:
 213   IRScope*                      _scope;
 214   int                           _bci;
 215   GrowableArray<ScopeValue*>*   _locals;
 216   GrowableArray<ScopeValue*>*   _expressions;
 217   GrowableArray<MonitorValue*>* _monitors;
 218   IRScopeDebugInfo*             _caller;
 219 
 220  public:
 221   IRScopeDebugInfo(IRScope*                      scope,
 222                    int                           bci,
 223                    GrowableArray<ScopeValue*>*   locals,
 224                    GrowableArray<ScopeValue*>*   expressions,
 225                    GrowableArray<MonitorValue*>* monitors,
 226                    IRScopeDebugInfo*             caller):
 227       _scope(scope)
 228     , _locals(locals)
 229     , _bci(bci)
 230     , _expressions(expressions)
 231     , _monitors(monitors)
 232     , _caller(caller) {}
 233 
 234 
 235   IRScope*                      scope()       { return _scope;       }
 236   int                           bci()         { return _bci;         }
 237   GrowableArray<ScopeValue*>*   locals()      { return _locals;      }
 238   GrowableArray<ScopeValue*>*   expressions() { return _expressions; }
 239   GrowableArray<MonitorValue*>* monitors()    { return _monitors;    }
 240   IRScopeDebugInfo*             caller()      { return _caller;      }
 241 
 242   //Whether we should reexecute this bytecode for deopt
 243   bool should_reexecute();
 244 
 245   void record_debug_info(DebugInformationRecorder* recorder, int pc_offset, bool topmost, bool is_method_handle_invoke = false) {
 246     if (caller() != NULL) {
 247       // Order is significant:  Must record caller first.
 248       caller()->record_debug_info(recorder, pc_offset, false/*topmost*/);
 249     }
 250     DebugToken* locvals = recorder->create_scope_values(locals());
 251     DebugToken* expvals = recorder->create_scope_values(expressions());
 252     DebugToken* monvals = recorder->create_monitor_values(monitors());
 253     // reexecute allowed only for the topmost frame
 254     bool reexecute = topmost ? should_reexecute() : false;
 255     bool return_oop = false; // This flag will be ignored since it used only for C2 with escape analysis.
 256     recorder->describe_scope(pc_offset, scope()->method(), bci(), reexecute, is_method_handle_invoke, return_oop, locvals, expvals, monvals);
 257   }
 258 };
 259 
 260 
 261 class CodeEmitInfo: public CompilationResourceObj {
 262   friend class LinearScan;
 263  private:
 264   IRScopeDebugInfo* _scope_debug_info;
 265   IRScope*          _scope;
 266   XHandlers*        _exception_handlers;
 267   OopMap*           _oop_map;
 268   ValueStack*       _stack;                      // used by deoptimization (contains also monitors
 269   int               _bci;
 270   CodeEmitInfo*     _next;
 271   int               _id;
 272   bool              _is_method_handle_invoke;    // true if the associated call site is a MethodHandle call site.
 273 
 274   FrameMap*     frame_map() const                { return scope()->compilation()->frame_map(); }
 275   Compilation*  compilation() const              { return scope()->compilation(); }
 276 
 277  public:
 278 
 279   // use scope from ValueStack
 280   CodeEmitInfo(int bci, ValueStack* stack, XHandlers* exception_handlers);
 281 
 282   // used by natives
 283   CodeEmitInfo(IRScope* scope, int bci)
 284     : _scope(scope)
 285     , _bci(bci)
 286     , _oop_map(NULL)
 287     , _scope_debug_info(NULL)
 288     , _stack(NULL)
 289     , _exception_handlers(NULL)
 290     , _next(NULL)
 291     , _id(-1)
 292     , _is_method_handle_invoke(false) {
 293   }
 294 
 295   // make a copy
 296   CodeEmitInfo(CodeEmitInfo* info, bool lock_stack_only = false);
 297 
 298   // accessors
 299   OopMap* oop_map()                              { return _oop_map; }
 300   ciMethod* method() const                       { return _scope->method(); }
 301   IRScope* scope() const                         { return _scope; }
 302   XHandlers* exception_handlers() const          { return _exception_handlers; }
 303   ValueStack* stack() const                      { return _stack; }
 304   int bci() const                                { return _bci; }
 305 
 306   void add_register_oop(LIR_Opr opr);
 307   void record_debug_info(DebugInformationRecorder* recorder, int pc_offset);
 308 
 309   CodeEmitInfo* next() const        { return _next; }
 310   void set_next(CodeEmitInfo* next) { _next = next; }
 311 
 312   int id() const      { return _id; }
 313   void set_id(int id) { _id = id; }
 314 
 315   bool     is_method_handle_invoke() const { return _is_method_handle_invoke;     }
 316   void set_is_method_handle_invoke(bool x) {        _is_method_handle_invoke = x; }
 317 };
 318 
 319 
 320 class IR: public CompilationResourceObj {
 321  private:
 322   Compilation*     _compilation;                 // the current compilation
 323   IRScope*         _top_scope;                   // the root of the scope hierarchy
 324   WordSize         _locals_size;                 // the space required for all locals
 325   int              _num_loops;                   // Total number of loops
 326   BlockList*       _code;                        // the blocks in code generation order w/ use counts
 327 
 328  public:
 329   // creation
 330   IR(Compilation* compilation, ciMethod* method, int osr_bci);
 331 
 332   // accessors
 333   bool             is_valid() const              { return top_scope()->is_valid(); }
 334   Compilation*     compilation() const           { return _compilation; }
 335   IRScope*         top_scope() const             { return _top_scope; }
 336   int              number_of_locks() const       { return top_scope()->number_of_locks(); }
 337   ciMethod*        method() const                { return top_scope()->method(); }
 338   BlockBegin*      start() const                 { return top_scope()->start(); }
 339   BlockBegin*      std_entry() const             { return start()->end()->as_Base()->std_entry(); }
 340   BlockBegin*      osr_entry() const             { return start()->end()->as_Base()->osr_entry(); }
 341   WordSize         locals_size() const           { return _locals_size; }
 342   int              locals_size_in_words() const  { return in_words(_locals_size); }
 343   BlockList*       code() const                  { return _code; }
 344   int              num_loops() const             { return _num_loops; }
 345   int              max_stack() const             { return top_scope()->max_stack(); } // expensive
 346 
 347   // ir manipulation
 348   void optimize();
 349   void compute_predecessors();
 350   void split_critical_edges();
 351   void compute_code();
 352   void compute_use_counts();
 353 
 354   // The linear-scan order and the code emission order are equal, but
 355   // this may change in future
 356   BlockList* linear_scan_order() {  assert(_code != NULL, "not computed"); return _code; }
 357 
 358   // iteration
 359   void iterate_preorder   (BlockClosure* closure);
 360   void iterate_postorder  (BlockClosure* closure);
 361   void iterate_linear_scan_order(BlockClosure* closure);
 362 
 363   // debugging
 364   static void print(BlockBegin* start, bool cfg_only, bool live_only = false) PRODUCT_RETURN;
 365   void print(bool cfg_only, bool live_only = false)                           PRODUCT_RETURN;
 366   void verify()                                                               PRODUCT_RETURN;
 367 };
 368 
 369 
 370 // Globally do instruction substitution and remove substituted
 371 // instructions from the instruction list.
 372 //
 373 
 374 class SubstitutionResolver: public BlockClosure {
 375   static void substitute(Value* v);
 376 
 377  public:
 378   SubstitutionResolver(IR* hir) {
 379     hir->iterate_preorder(this);
 380   }
 381 
 382   SubstitutionResolver(BlockBegin* block) {
 383     block->iterate_preorder(this);
 384   }
 385 
 386   virtual void block_do(BlockBegin* block);
 387 };
--- EOF ---