src/hotspot/share/c1/c1_Compilation.hpp
changeset 47216 71c04702a3d5
parent 46526 519f1fbec7af
child 53244 9807daeb47c4
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/hotspot/share/c1/c1_Compilation.hpp	Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,350 @@
+/*
+ * Copyright (c) 1999, 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ *
+ */
+
+#ifndef SHARE_VM_C1_C1_COMPILATION_HPP
+#define SHARE_VM_C1_C1_COMPILATION_HPP
+
+#include "ci/ciEnv.hpp"
+#include "ci/ciMethodData.hpp"
+#include "code/exceptionHandlerTable.hpp"
+#include "compiler/compilerDirectives.hpp"
+#include "memory/resourceArea.hpp"
+#include "runtime/deoptimization.hpp"
+
+class CompilationResourceObj;
+class XHandlers;
+class ExceptionInfo;
+class DebugInformationRecorder;
+class FrameMap;
+class IR;
+class IRScope;
+class Instruction;
+class LinearScan;
+class OopMap;
+class LIR_Emitter;
+class LIR_Assembler;
+class CodeEmitInfo;
+class ciEnv;
+class ciMethod;
+class ValueStack;
+class LIR_OprDesc;
+class C1_MacroAssembler;
+class CFGPrinter;
+class CFGPrinterOutput;
+typedef LIR_OprDesc* LIR_Opr;
+
+typedef GrowableArray<BasicType> BasicTypeArray;
+typedef GrowableArray<BasicType> BasicTypeList;
+typedef GrowableArray<ExceptionInfo*> ExceptionInfoList;
+
+class Compilation: public StackObj {
+  friend class CompilationResourceObj;
+ private:
+  // compilation specifics
+  Arena* _arena;
+  int _next_id;
+  int _next_block_id;
+  AbstractCompiler*  _compiler;
+  DirectiveSet*      _directive;
+  ciEnv*             _env;
+  CompileLog*        _log;
+  ciMethod*          _method;
+  int                _osr_bci;
+  IR*                _hir;
+  int                _max_spills;
+  FrameMap*          _frame_map;
+  C1_MacroAssembler* _masm;
+  bool               _has_exception_handlers;
+  bool               _has_fpu_code;
+  bool               _has_unsafe_access;
+  bool               _would_profile;
+  bool               _has_method_handle_invokes;  // True if this method has MethodHandle invokes.
+  bool               _has_reserved_stack_access;
+  const char*        _bailout_msg;
+  ExceptionInfoList* _exception_info_list;
+  ExceptionHandlerTable _exception_handler_table;
+  ImplicitExceptionTable _implicit_exception_table;
+  LinearScan*        _allocator;
+  CodeOffsets        _offsets;
+  CodeBuffer         _code;
+  bool               _has_access_indexed;
+  int                _interpreter_frame_size; // Stack space needed in case of a deoptimization
+
+  // compilation helpers
+  void initialize();
+  void build_hir();
+  void emit_lir();
+
+  void emit_code_epilog(LIR_Assembler* assembler);
+  int  emit_code_body();
+
+  int  compile_java_method();
+  void install_code(int frame_size);
+  void compile_method();
+
+  void generate_exception_handler_table();
+
+  ExceptionInfoList* exception_info_list() const { return _exception_info_list; }
+  ExceptionHandlerTable* exception_handler_table() { return &_exception_handler_table; }
+
+  LinearScan* allocator()                          { return _allocator;      }
+  void        set_allocator(LinearScan* allocator) { _allocator = allocator; }
+
+  Instruction*       _current_instruction;       // the instruction currently being processed
+#ifndef PRODUCT
+  Instruction*       _last_instruction_printed;  // the last instruction printed during traversal
+  CFGPrinterOutput*  _cfg_printer_output;
+#endif // PRODUCT
+
+ public:
+  // creation
+  Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method,
+              int osr_bci, BufferBlob* buffer_blob, DirectiveSet* directive);
+  ~Compilation();
+
+
+  static Compilation* current() {
+    return (Compilation*) ciEnv::current()->compiler_data();
+  }
+
+  // accessors
+  ciEnv* env() const                             { return _env; }
+  DirectiveSet* directive() const                { return _directive; }
+  CompileLog* log() const                        { return _log; }
+  AbstractCompiler* compiler() const             { return _compiler; }
+  bool has_exception_handlers() const            { return _has_exception_handlers; }
+  bool has_fpu_code() const                      { return _has_fpu_code; }
+  bool has_unsafe_access() const                 { return _has_unsafe_access; }
+  int max_vector_size() const                    { return 0; }
+  ciMethod* method() const                       { return _method; }
+  int osr_bci() const                            { return _osr_bci; }
+  bool is_osr_compile() const                    { return osr_bci() >= 0; }
+  IR* hir() const                                { return _hir; }
+  int max_spills() const                         { return _max_spills; }
+  FrameMap* frame_map() const                    { return _frame_map; }
+  CodeBuffer* code()                             { return &_code; }
+  C1_MacroAssembler* masm() const                { return _masm; }
+  CodeOffsets* offsets()                         { return &_offsets; }
+  Arena* arena()                                 { return _arena; }
+  bool has_access_indexed()                      { return _has_access_indexed; }
+
+  // Instruction ids
+  int get_next_id()                              { return _next_id++; }
+  int number_of_instructions() const             { return _next_id; }
+
+  // BlockBegin ids
+  int get_next_block_id()                        { return _next_block_id++; }
+  int number_of_blocks() const                   { return _next_block_id; }
+
+  // setters
+  void set_has_exception_handlers(bool f)        { _has_exception_handlers = f; }
+  void set_has_fpu_code(bool f)                  { _has_fpu_code = f; }
+  void set_has_unsafe_access(bool f)             { _has_unsafe_access = f; }
+  void set_would_profile(bool f)                 { _would_profile = f; }
+  void set_has_access_indexed(bool f)            { _has_access_indexed = f; }
+  // Add a set of exception handlers covering the given PC offset
+  void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
+  // Statistics gathering
+  void notice_inlined_method(ciMethod* method);
+
+  // JSR 292
+  bool     has_method_handle_invokes() const { return _has_method_handle_invokes;     }
+  void set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }
+
+  bool     has_reserved_stack_access() const { return _has_reserved_stack_access; }
+  void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
+
+  DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
+  Dependencies* dependency_recorder() const; // = _env->dependencies()
+  ImplicitExceptionTable* implicit_exception_table()     { return &_implicit_exception_table; }
+
+  Instruction* current_instruction() const       { return _current_instruction; }
+  Instruction* set_current_instruction(Instruction* instr) {
+    Instruction* previous = _current_instruction;
+    _current_instruction = instr;
+    return previous;
+  }
+
+#ifndef PRODUCT
+  void maybe_print_current_instruction();
+  CFGPrinterOutput* cfg_printer_output() {
+    guarantee(_cfg_printer_output != NULL, "CFG printer output not initialized");
+    return _cfg_printer_output;
+  }
+#endif // PRODUCT
+
+  // error handling
+  void bailout(const char* msg);
+  bool bailed_out() const                        { return _bailout_msg != NULL; }
+  const char* bailout_msg() const                { return _bailout_msg; }
+
+  static int desired_max_code_buffer_size() {
+    return (int)NMethodSizeLimit;  // default 64K
+  }
+  static int desired_max_constant_size() {
+    return desired_max_code_buffer_size() / 10;
+  }
+
+  static bool setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
+
+  // timers
+  static void print_timers();
+
+#ifndef PRODUCT
+  // debugging support.
+  // produces a file named c1compileonly in the current directory with
+  // directives to compile only the current method and it's inlines.
+  // The file can be passed to the command line option -XX:Flags=<filename>
+  void compile_only_this_method();
+  void compile_only_this_scope(outputStream* st, IRScope* scope);
+  void exclude_this_method();
+#endif // PRODUCT
+
+  bool is_profiling() {
+    return env()->comp_level() == CompLevel_full_profile ||
+           env()->comp_level() == CompLevel_limited_profile;
+  }
+  bool count_invocations() { return is_profiling(); }
+  bool count_backedges()   { return is_profiling(); }
+
+  // Helpers for generation of profile information
+  bool profile_branches() {
+    return env()->comp_level() == CompLevel_full_profile &&
+      C1UpdateMethodData && C1ProfileBranches;
+  }
+  bool profile_calls() {
+    return env()->comp_level() == CompLevel_full_profile &&
+      C1UpdateMethodData && C1ProfileCalls;
+  }
+  bool profile_inlined_calls() {
+    return profile_calls() && C1ProfileInlinedCalls;
+  }
+  bool profile_checkcasts() {
+    return env()->comp_level() == CompLevel_full_profile &&
+      C1UpdateMethodData && C1ProfileCheckcasts;
+  }
+  bool profile_parameters() {
+    return env()->comp_level() == CompLevel_full_profile &&
+      C1UpdateMethodData && MethodData::profile_parameters();
+  }
+  bool profile_arguments() {
+    return env()->comp_level() == CompLevel_full_profile &&
+      C1UpdateMethodData && MethodData::profile_arguments();
+  }
+  bool profile_return() {
+    return env()->comp_level() == CompLevel_full_profile &&
+      C1UpdateMethodData && MethodData::profile_return();
+  }
+  bool age_code() const {
+    return _method->profile_aging();
+  }
+
+  // will compilation make optimistic assumptions that might lead to
+  // deoptimization and that the runtime will account for?
+  bool is_optimistic() const                             {
+    return !TieredCompilation &&
+      (RangeCheckElimination || UseLoopInvariantCodeMotion) &&
+      method()->method_data()->trap_count(Deoptimization::Reason_none) == 0;
+  }
+
+  ciKlass* cha_exact_type(ciType* type);
+
+  // Dump inlining replay data to the stream.
+  void dump_inline_data(outputStream* out) { /* do nothing now */ }
+
+  // How much stack space would the interpreter need in case of a
+  // deoptimization (worst case)
+  void update_interpreter_frame_size(int size) {
+    if (_interpreter_frame_size < size) {
+      _interpreter_frame_size = size;
+    }
+  }
+
+  int interpreter_frame_size() const {
+    return _interpreter_frame_size;
+  }
+};
+
+
+// Macro definitions for unified bailout-support
+// The methods bailout() and bailed_out() are present in all classes
+// that might bailout, but forward all calls to Compilation
+#define BAILOUT(msg)               { bailout(msg); return;              }
+#define BAILOUT_(msg, res)         { bailout(msg); return res;          }
+
+#define CHECK_BAILOUT()            { if (bailed_out()) return;          }
+#define CHECK_BAILOUT_(res)        { if (bailed_out()) return res;      }
+
+
+class InstructionMark: public StackObj {
+ private:
+  Compilation* _compilation;
+  Instruction*  _previous;
+
+ public:
+  InstructionMark(Compilation* compilation, Instruction* instr) {
+    _compilation = compilation;
+    _previous = _compilation->set_current_instruction(instr);
+  }
+  ~InstructionMark() {
+    _compilation->set_current_instruction(_previous);
+  }
+};
+
+
+//----------------------------------------------------------------------
+// Base class for objects allocated by the compiler in the compilation arena
+class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC {
+ public:
+  void* operator new(size_t size) throw() { return Compilation::current()->arena()->Amalloc(size); }
+  void* operator new(size_t size, Arena* arena) throw() {
+    return arena->Amalloc(size);
+  }
+  void  operator delete(void* p) {} // nothing to do
+};
+
+
+//----------------------------------------------------------------------
+// Class for aggregating exception handler information.
+
+// Effectively extends XHandlers class with PC offset of
+// potentially exception-throwing instruction.
+// This class is used at the end of the compilation to build the
+// ExceptionHandlerTable.
+class ExceptionInfo: public CompilationResourceObj {
+ private:
+  int             _pco;                // PC of potentially exception-throwing instruction
+  XHandlers*      _exception_handlers; // flat list of exception handlers covering this PC
+
+ public:
+  ExceptionInfo(int pco, XHandlers* exception_handlers)
+    : _pco(pco)
+    , _exception_handlers(exception_handlers)
+  { }
+
+  int pco()                                      { return _pco; }
+  XHandlers* exception_handlers()                { return _exception_handlers; }
+};
+
+#endif // SHARE_VM_C1_C1_COMPILATION_HPP