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