1 /*
   2  * Copyright (c) 1998, 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_COMPILERDIRECTIVES_HPP
  26 #define SHARE_VM_COMPILER_COMPILERDIRECTIVES_HPP
  27 
  28 #include "ci/ciMetadata.hpp"
  29 #include "ci/ciMethod.hpp"
  30 #include "ci/ciUtilities.hpp"
  31 #include "compiler/methodMatcher.hpp"
  32 #include "compiler/compilerOracle.hpp"
  33 #include "oops/oop.inline.hpp"
  34 #include "utilities/exceptions.hpp"
  35 
  36   //      Directives flag name,    type, default value, compile command name
  37   #define compilerdirectives_common_flags(cflags) \
  38     cflags(Enable,                  bool, false, X) \
  39     cflags(Exclude,                 bool, false, X) \
  40     cflags(BreakAtExecute,          bool, false, X) \
  41     cflags(BreakAtCompile,          bool, false, X) \
  42     cflags(Log,                     bool, false, X) \
  43     cflags(PrintAssembly,           bool, PrintAssembly, PrintAssembly) \
  44     cflags(PrintInlining,           bool, PrintInlining, PrintInlining) \
  45     cflags(PrintNMethods,           bool, PrintNMethods, PrintNMethods) \
  46     cflags(ReplayInline,            bool, false, ReplayInline) \
  47     cflags(DumpReplay,              bool, false, DumpReplay) \
  48     cflags(DumpInline,              bool, false, DumpInline) \
  49     cflags(CompilerDirectivesIgnoreCompileCommands, bool, CompilerDirectivesIgnoreCompileCommands, X) \
  50     cflags(DisableIntrinsic,        ccstr, DisableIntrinsic, DisableIntrinsic)
  51 
  52 #ifdef COMPILER1
  53   #define compilerdirectives_c1_flags(cflags)
  54 #else
  55   #define compilerdirectives_c1_flags(cflags)
  56 #endif
  57 
  58 #ifdef COMPILER2
  59   #define compilerdirectives_c2_flags(cflags) \
  60     cflags(BlockLayoutByFrequency,  bool, BlockLayoutByFrequency,  BlockLayoutByFrequency) \
  61     cflags(PrintOptoAssembly,       bool, PrintOptoAssembly, PrintOptoAssembly) \
  62     cflags(PrintIntrinsics,         bool, PrintIntrinsics, PrintIntrinsics) \
  63     cflags(TraceOptoPipelining,     bool, false, TraceOptoPipelining) \
  64     cflags(TraceOptoOutput,         bool, false, TraceOptoOutput) \
  65     cflags(TraceSpilling,           bool, TraceSpilling, TraceSpilling) \
  66     cflags(Vectorize,               bool, false, Vectorize) \
  67     cflags(VectorizeDebug,          bool, false, VectorizeDebug) \
  68     cflags(CloneMapDebug,           bool, false, CloneMapDebug) \
  69     cflags(DoReserveCopyInSuperWordDebug, bool, false, DoReserveCopyInSuperWordDebug) \
  70     NOT_PRODUCT( cflags(IGVPrintLevel, intx, PrintIdealGraphLevel, IGVPrintLevel)) \
  71     cflags(MaxNodeLimit,            intx, MaxNodeLimit, MaxNodeLimit)
  72 #else
  73   #define compilerdirectives_c2_flags(cflags)
  74 #endif
  75 
  76 class CompilerDirectives;
  77 class DirectiveSet;
  78 
  79 class DirectivesStack : AllStatic {
  80 private:
  81   static CompilerDirectives* _top;
  82   static CompilerDirectives* _bottom;
  83   static int _depth;
  84 
  85   static void pop_inner(); // no lock version of pop
  86 public:
  87   static void init();
  88   static DirectiveSet* getMatchingDirective(methodHandle mh, AbstractCompiler* comp);
  89   static DirectiveSet* getDefaultDirective(AbstractCompiler* comp);
  90   static void push(CompilerDirectives* directive);
  91   static void pop();
  92   static void clear();
  93   static void print(outputStream* st);
  94   static void release(DirectiveSet* set);
  95   static void release(CompilerDirectives* dir);
  96 };
  97 
  98 class DirectiveSet : public CHeapObj<mtCompiler> {
  99 private:
 100   InlineMatcher* _inlinematchers;
 101   CompilerDirectives* _directive;
 102 
 103 public:
 104   DirectiveSet(CompilerDirectives* directive);
 105   ~DirectiveSet();
 106   CompilerDirectives* directive();
 107   bool parse_and_add_inline(char* str, const char*& error_msg);
 108   void append_inline(InlineMatcher* m);
 109   bool should_inline(ciMethod* inlinee);
 110   bool should_not_inline(ciMethod* inlinee);
 111   void print_inline(outputStream* st);
 112   DirectiveSet* compilecommand_compatibility_init(methodHandle method);
 113   bool is_exclusive_copy() { return _directive == NULL; }
 114   bool matches_inline(methodHandle method, int inline_action);
 115   static DirectiveSet* clone(DirectiveSet const* src);
 116   bool is_intrinsic_disabled(methodHandle method);
 117   void finalize();
 118 
 119   typedef enum {
 120 #define enum_of_flags(name, type, dvalue, cc_flag) name##Index,
 121     compilerdirectives_common_flags(enum_of_flags)
 122     compilerdirectives_c2_flags(enum_of_flags)
 123     compilerdirectives_c1_flags(enum_of_flags)
 124     number_of_flags
 125   } flags;
 126 
 127   bool _modified[number_of_flags];
 128 
 129 #define flag_store_definition(name, type, dvalue, cc_flag) type name##Option;
 130   compilerdirectives_common_flags(flag_store_definition)
 131   compilerdirectives_c2_flags(flag_store_definition)
 132   compilerdirectives_c1_flags(flag_store_definition)
 133 
 134 // Casting to get the same function signature for all setters. Used from parser.
 135 #define set_function_definition(name, type, dvalue, cc_flag) void set_##name(void* value) { type val = *(type*)value; name##Option = val; _modified[name##Index] = 1; }
 136   compilerdirectives_common_flags(set_function_definition)
 137   compilerdirectives_c2_flags(set_function_definition)
 138   compilerdirectives_c1_flags(set_function_definition)
 139 
 140   void print_intx(outputStream* st, ccstr n, intx v, bool mod) { if (mod) { st->print("%s:" INTX_FORMAT " ", n, v); } }
 141   void print_bool(outputStream* st, ccstr n, bool v, bool mod) { if (mod) { st->print("%s:%s ", n, v ? "true" : "false"); } }
 142   void print_double(outputStream* st, ccstr n, double v, bool mod) { if (mod) { st->print("%s:%f ", n, v); } }
 143   void print_ccstr(outputStream* st, ccstr n, ccstr v, bool mod) { if (mod) { st->print("%s:%s ", n, v); } }
 144 
 145 void print(outputStream* st) {
 146     print_inline(st);
 147     st->print("  ");
 148 #define print_function_definition(name, type, dvalue, cc_flag) print_##type(st, #name, this->name##Option, true);//(bool)_modified[name##Index]);
 149     compilerdirectives_common_flags(print_function_definition)
 150     compilerdirectives_c2_flags(print_function_definition)
 151     compilerdirectives_c1_flags(print_function_definition)
 152     st->cr();
 153   }
 154 };
 155 
 156 class CompilerDirectives : public CHeapObj<mtCompiler> {
 157 private:
 158   CompilerDirectives* _next;
 159   BasicMatcher* _match;
 160   int _ref_count;
 161 
 162 public:
 163 
 164   CompilerDirectives();
 165   ~CompilerDirectives();
 166 
 167   CompilerDirectives* next();
 168   void set_next(CompilerDirectives* next) {_next = next; }
 169 
 170   bool match(methodHandle method);
 171   BasicMatcher* match() { return _match; }
 172   bool add_match(char* str, const char*& error_msg);
 173   DirectiveSet* get_for(AbstractCompiler *comp);
 174   void print(outputStream* st);
 175   bool is_default_directive() { return _next == NULL; }
 176   void finalize();
 177 
 178   void inc_refcount();
 179   void dec_refcount();
 180   int refcount();
 181 
 182   DirectiveSet* _c1_store;
 183   DirectiveSet* _c2_store;
 184 };
 185 
 186 #endif // SHARE_VM_COMPILER_COMPILERDIRECTIVES_HPP