1 /*
   2  * Copyright (c) 1999, 2014, 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_COMPILER_ABSTRACTCOMPILER_HPP
  26 #define SHARE_VM_COMPILER_ABSTRACTCOMPILER_HPP
  27 
  28 #include "ci/compilerInterface.hpp"
  29 
  30 class AbstractCompiler : public CHeapObj<mtCompiler> {
  31  private:
  32   volatile int _num_compiler_threads;
  33 
  34  protected:
  35   volatile int _compiler_state;
  36   // Used for tracking global state of compiler runtime initialization
  37   enum { uninitialized, initializing, initialized, failed, shut_down };
  38 
  39   // This method returns true for the first compiler thread that reaches that methods.
  40   // This thread will initialize the compiler runtime.
  41   bool should_perform_init();
  42 
  43   // The (closed set) of concrete compiler classes.
  44   enum Type {
  45     none,
  46     c1,
  47     c2,
  48     shark
  49   };
  50 
  51  private:
  52   Type _type;
  53 
  54  public:
  55   AbstractCompiler(Type type) : _type(type), _compiler_state(uninitialized), _num_compiler_threads(0) {}
  56 
  57   // This function determines the compiler thread that will perform the
  58   // shutdown of the corresponding compiler runtime.
  59   bool should_perform_shutdown();
  60 
  61   // Name of this compiler
  62   virtual const char* name() = 0;
  63 
  64   // Missing feature tests
  65   virtual bool supports_native()                 { return true; }
  66   virtual bool supports_osr   ()                 { return true; }
  67   virtual bool can_compile_method(methodHandle method)  { return true; }
  68 
  69   // Determine if the current compiler provides an intrinsic
  70   // for method 'method'. An intrinsic is available if:
  71   //  - the intrinsic is enabled (by using the appropriate command-line flag) and
  72   //  - the platform on which the VM is running supports the intrinsic
  73   //    (i.e., the platform provides the instructions necessary for the compiler
  74   //    to generate the intrinsic code).
  75   //
  76   // The second parameter, 'compilation_context', is needed to implement functionality
  77   // related to the DisableIntrinsic command-line flag. The DisableIntrinsic flag can
  78   // be used to prohibit the compilers to use an intrinsic. There are three ways to
  79   // disable an intrinsic using the DisableIntrinsic flag:
  80   //
  81   // (1) -XX:DisableIntrinsic=_hashCode,_getClass
  82   //     Disables intrinsification of _hashCode and _getClass globally
  83   //     (i.e., the intrinsified version the methods will not be used at all).
  84   // (2) -XX:CompileCommand=option,aClass::aMethod,ccstr,DisableIntrinsic,_hashCode
  85   //     Disables intrinsification of _hashCode if it is called from
  86   //     aClass::aMethod (but not for any other call site of _hashCode)
  87   // (3) -XX:CompileCommand=option,java.lang.ref.Reference::get,ccstr,DisableIntrinsic,_Reference_get
  88   //     Some methods are not compiled by C2. Instead, the C2 compiler
  89   //     returns directly the intrinsified version of these methods.
  90   //     The command above forces C2 to compile _Reference_get, but
  91   //     allows using the intrinsified version of _Reference_get at all
  92   //     other call sites.
  93   //
  94   // From the modes above, (1) disable intrinsics globally, (2) and (3)
  95   // disable intrinsics on a per-method basis. In cases (2) and (3) the
  96   // compilation context is aClass::aMethod and java.lang.ref.Reference::get,
  97   // respectively.
  98   virtual bool is_intrinsic_available(methodHandle method, DirectiveSet* dirset) {
  99     return is_intrinsic_supported(method) &&
 100            dirset->is_intrinsic_disabled(method) &&
 101            !vmIntrinsics::is_disabled_by_flags(method);
 102   }
 103 
 104   // Determines if an intrinsic is supported by the compiler, that is,
 105   // the compiler provides the instructions necessary to generate
 106   // the intrinsic code for method 'method'.
 107   //
 108   // The 'is_intrinsic_supported' method is a white list, that is,
 109   // by default no intrinsics are supported by a compiler except
 110   // the ones listed in the method. Overriding methods should conform
 111   // to this behavior.
 112   virtual bool is_intrinsic_supported(methodHandle method) {
 113     return false;
 114   }
 115 
 116   // Compiler type queries.
 117   bool is_c1()                                   { return _type == c1; }
 118   bool is_c2()                                   { return _type == c2; }
 119   bool is_shark()                                { return _type == shark; }
 120 
 121   // Customization
 122   virtual void initialize () = 0;
 123 
 124   void set_num_compiler_threads(int num) { _num_compiler_threads = num;  }
 125   int num_compiler_threads()             { return _num_compiler_threads; }
 126 
 127   // Get/set state of compiler objects
 128   bool is_initialized()           { return _compiler_state == initialized; }
 129   bool is_failed     ()           { return _compiler_state == failed;}
 130   void set_state     (int state);
 131   void set_shut_down ()           { set_state(shut_down); }
 132   // Compilation entry point for methods
 133   virtual void compile_method(ciEnv* env, ciMethod* target, int entry_bci) {
 134     ShouldNotReachHere();
 135   }
 136 
 137 
 138   // Print compilation timers and statistics
 139   virtual void print_timers() {
 140     ShouldNotReachHere();
 141   }
 142 };
 143 
 144 #endif // SHARE_VM_COMPILER_ABSTRACTCOMPILER_HPP