1 /*
   2  * Copyright (c) 1998, 2016, 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 "utilities/exceptions.hpp"
  34 
  35   //      Directives flag name,    type, default value, compile command name
  36   #define compilerdirectives_common_flags(cflags) \
  37     cflags(Enable,                  bool, false, X) \
  38     cflags(Exclude,                 bool, false, X) \
  39     cflags(BreakAtExecute,          bool, false, X) \
  40     cflags(BreakAtCompile,          bool, false, X) \
  41     cflags(Log,                     bool, LogCompilation, X) \
  42     cflags(PrintAssembly,           bool, PrintAssembly, PrintAssembly) \
  43     cflags(PrintInlining,           bool, PrintInlining, PrintInlining) \
  44     cflags(PrintNMethods,           bool, PrintNMethods, PrintNMethods) \
  45     cflags(BackgroundCompilation,   bool, BackgroundCompilation, BackgroundCompilation) \
  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,        ccstrlist, 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     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(int count);
  92   static bool check_capacity(int request_size, outputStream* st);
  93   static void clear();
  94   static void print(outputStream* st);
  95   static void release(DirectiveSet* set);
  96   static void release(CompilerDirectives* dir);
  97 };
  98 
  99 class DirectiveSet : public CHeapObj<mtCompiler> {
 100 private:
 101   InlineMatcher* _inlinematchers;
 102   CompilerDirectives* _directive;
 103 
 104 public:
 105   DirectiveSet(CompilerDirectives* directive);
 106   ~DirectiveSet();
 107   CompilerDirectives* directive();
 108   bool parse_and_add_inline(char* str, const char*& error_msg);
 109   void append_inline(InlineMatcher* m);
 110   bool should_inline(ciMethod* inlinee);
 111   bool should_not_inline(ciMethod* inlinee);
 112   void print_inline(outputStream* st);
 113   DirectiveSet* compilecommand_compatibility_init(methodHandle method);
 114   bool is_exclusive_copy() { return _directive == NULL; }
 115   bool matches_inline(methodHandle method, int inline_action);
 116   static DirectiveSet* clone(DirectiveSet const* src);
 117   bool is_intrinsic_disabled(methodHandle method);
 118   static ccstrlist canonicalize_disableintrinsic(ccstrlist option_value);
 119   void finalize(outputStream* st);
 120 
 121   typedef enum {
 122 #define enum_of_flags(name, type, dvalue, cc_flag) name##Index,
 123     compilerdirectives_common_flags(enum_of_flags)
 124     compilerdirectives_c2_flags(enum_of_flags)
 125     compilerdirectives_c1_flags(enum_of_flags)
 126     number_of_flags
 127   } flags;
 128 
 129   bool _modified[number_of_flags];
 130 
 131 #define flag_store_definition(name, type, dvalue, cc_flag) type name##Option;
 132   compilerdirectives_common_flags(flag_store_definition)
 133   compilerdirectives_c2_flags(flag_store_definition)
 134   compilerdirectives_c1_flags(flag_store_definition)
 135 
 136 // Casting to get the same function signature for all setters. Used from parser.
 137 #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; }
 138   compilerdirectives_common_flags(set_function_definition)
 139   compilerdirectives_c2_flags(set_function_definition)
 140   compilerdirectives_c1_flags(set_function_definition)
 141 
 142   void print_intx(outputStream* st, ccstr n, intx v, bool mod) { if (mod) { st->print("%s:" INTX_FORMAT " ", n, v); } }
 143   void print_bool(outputStream* st, ccstr n, bool v, bool mod) { if (mod) { st->print("%s:%s ", n, v ? "true" : "false"); } }
 144   void print_double(outputStream* st, ccstr n, double v, bool mod) { if (mod) { st->print("%s:%f ", n, v); } }
 145   void print_ccstr(outputStream* st, ccstr n, ccstr v, bool mod) { if (mod) { st->print("%s:%s ", n, v); } }
 146   void print_ccstrlist(outputStream* st, ccstr n, ccstr v, bool mod) { print_ccstr(st, n, v, mod); }
 147 
 148 void print(outputStream* st) {
 149     print_inline(st);
 150     st->print("  ");
 151 #define print_function_definition(name, type, dvalue, cc_flag) print_##type(st, #name, this->name##Option, true);//(bool)_modified[name##Index]);
 152     compilerdirectives_common_flags(print_function_definition)
 153     compilerdirectives_c2_flags(print_function_definition)
 154     compilerdirectives_c1_flags(print_function_definition)
 155     st->cr();
 156   }
 157 };
 158 
 159 class CompilerDirectives : public CHeapObj<mtCompiler> {
 160 private:
 161   CompilerDirectives* _next;
 162   BasicMatcher* _match;
 163   int _ref_count;
 164 
 165 public:
 166 
 167   CompilerDirectives();
 168   ~CompilerDirectives();
 169 
 170   CompilerDirectives* next();
 171   void set_next(CompilerDirectives* next) {_next = next; }
 172 
 173   bool match(methodHandle method);
 174   BasicMatcher* match() { return _match; }
 175   bool add_match(char* str, const char*& error_msg);
 176   DirectiveSet* get_for(AbstractCompiler *comp);
 177   void print(outputStream* st);
 178   bool is_default_directive() { return _next == NULL; }
 179   void finalize(outputStream* st);
 180 
 181   void inc_refcount();
 182   void dec_refcount();
 183   int refcount();
 184 
 185   DirectiveSet* _c1_store;
 186   DirectiveSet* _c2_store;
 187 };
 188 
 189 #endif // SHARE_VM_COMPILER_COMPILERDIRECTIVES_HPP