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