1 /*
   2  * Copyright (c) 2015, 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_DIRECTIVESPARSER_HPP
  26 #define SHARE_VM_COMPILER_DIRECTIVESPARSER_HPP
  27 
  28 #include "utilities/json.hpp"
  29 #include "compiler/compilerDirectives.hpp"
  30 
  31 enum FlagType {
  32   boolFlag,
  33   intxFlag,
  34   doubleFlag,
  35   ccstrFlag,
  36   ccstrlistFlag,
  37   UnknownFlagType
  38 };
  39 
  40 static const char* flag_type_names[] = {
  41     "bool",
  42     "int",
  43     "double",
  44     "string",
  45     "string list",
  46     "unknown"
  47 };
  48 
  49 class DirectivesParser : public JSON {
  50 public:
  51   static bool has_file();
  52   static bool parse_from_flag();
  53   static bool parse_from_file(const char* filename, outputStream* st);
  54   static int  parse_string(const char* string, outputStream* st);
  55   int install_directives();
  56 
  57 private:
  58   DirectivesParser(const char* text, outputStream* st);
  59   ~DirectivesParser();
  60 
  61   bool callback(JSON_TYPE t, JSON_VAL* v, uint level);
  62   static bool parse_from_file_inner(const char* filename, outputStream* st);
  63 
  64   // types of "keys". i.e recognized <key>:<value> pairs in our JSON syntax
  65   typedef enum {
  66      type_c1,
  67      type_c2,
  68      type_enable,
  69      type_preset,
  70      type_match,
  71      type_inline,
  72 
  73      // After here, there is no correlation between
  74      // keytype and keys array
  75      //type_strategy,
  76      type_flag,
  77      //type_dir,
  78 
  79      // Synthetic.
  80      type_dir_array,
  81      type_directives,
  82      type_value_array
  83   } keytype;
  84 
  85   // name, type, dtd info and maybe a setter
  86   // this is how we map key-values
  87   typedef struct {
  88      const char *name;
  89      keytype     type;
  90      uint    allow_array_value : 1;
  91      uint    allowedmask;
  92      void (DirectiveSet::*set)(void* arg);
  93      FlagType flag_type;
  94   } key;
  95 
  96   // Array with valid keys for the directive file
  97   static const key keys[];
  98   // Marker for outermost moosewings/array
  99   static const key dir_array_key;
 100   // Marker for a directives set (these are "implicit" objects, as in not named)
 101   static const key dir_key;
 102   // Marker for a multi value
 103   static const key value_array_key;
 104 
 105   // A compiler directive shouldn't be able to use more than 5 stack slots.
 106   // Example of max stack usage:
 107   // depth 1: type_dir_array  [
 108   // depth 2: type_directives   {
 109   // depth 3: type_c1             c1: {
 110   // depth 4: type_inline           inline:
 111   // depth 5: type_value_array      [ ...
 112   static const uint MAX_DEPTH = 5;
 113   const key* stack[MAX_DEPTH];
 114   uint depth;
 115 
 116   bool push_key(const char* str, size_t len);
 117   bool push_key(const key* k);
 118   const key* current_key();
 119   const key* pop_key();
 120   static const key* lookup_key(const char* s, size_t len);
 121 
 122   bool set_option(JSON_TYPE t, JSON_VAL* v);
 123   bool set_option_flag(JSON_TYPE t, JSON_VAL* v, const key* option_key, DirectiveSet* set);
 124 
 125   CompilerDirectives* current_directive;
 126   DirectiveSet*       current_directiveset;
 127 
 128   void push_tmp(CompilerDirectives* dir);
 129   void clean_tmp();
 130   CompilerDirectives* pop_tmp();
 131   CompilerDirectives* _tmp_top; // temporary storage for dirs while parsing
 132   int _tmp_depth;               // Number of directives that has been parsed but not installed.
 133 
 134   static uint mask(keytype kt);
 135 
 136 #ifndef PRODUCT
 137   static void test(const char* json, bool valid);
 138 public:
 139   static void test();
 140 #endif
 141 };
 142 
 143 #endif // SHARE_VM_COMPILER_DIRECTIVESPARSER_HPP