1 /*
   2  * Copyright (c) 2011, 2018, 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 #include "precompiled.hpp"
  26 #include "jni.h"
  27 #include "classfile/javaClasses.inline.hpp"
  28 #include "classfile/symbolTable.hpp"
  29 #include "memory/oopFactory.hpp"
  30 #include "memory/resourceArea.hpp"
  31 #include "oops/objArrayOop.inline.hpp"
  32 #include "prims/whitebox.inline.hpp"
  33 #include "prims/wbtestmethods/parserTests.hpp"
  34 #include "runtime/interfaceSupport.inline.hpp"
  35 #include "runtime/jniHandles.inline.hpp"
  36 #include "services/diagnosticArgument.hpp"
  37 #include "services/diagnosticFramework.hpp"
  38 
  39 //There's no way of beforeahnd knowing an upper size
  40 //Of the length of a string representation of
  41 //the value of an argument.
  42 #define VALUE_MAXLEN 256
  43 
  44 // DiagnosticFramework test utility methods
  45 
  46 /*
  47  * The DiagnosticArgumentType class contains an enum that says which type
  48  * this argument represents. (JLONG, BOOLEAN etc).
  49  * This method Returns a char* representation of that enum value.
  50  */
  51 static const char* lookup_diagnosticArgumentEnum(const char* field_name, oop object) {
  52   Thread* THREAD = Thread::current();
  53   const char* enum_sig = "Lsun/hotspot/parser/DiagnosticCommand$DiagnosticArgumentType;";
  54   TempNewSymbol enumSigSymbol = SymbolTable::lookup(enum_sig, (int) strlen(enum_sig), THREAD);
  55   int offset = WhiteBox::offset_for_field(field_name, object, enumSigSymbol);
  56   oop enumOop = object->obj_field(offset);
  57 
  58   const char* ret = WhiteBox::lookup_jstring("name", enumOop);
  59   return ret;
  60 }
  61 
  62 /*
  63  * Takes an oop to a DiagnosticArgumentType-instance and
  64  * reads the fields from it. Fills an native DCmdParser with
  65  * this info.
  66  */
  67 static void fill_in_parser(DCmdParser* parser, oop argument)
  68 {
  69   const char* name = WhiteBox::lookup_jstring("name", argument);
  70   const char* desc = WhiteBox::lookup_jstring("desc", argument);
  71   const char* default_value = WhiteBox::lookup_jstring("defaultValue", argument);
  72   bool mandatory = WhiteBox::lookup_bool("mandatory", argument);
  73   bool isarg = WhiteBox::lookup_bool("argument", argument);
  74   const char*  type = lookup_diagnosticArgumentEnum("type", argument);
  75 
  76    if (strcmp(type, "STRING") == 0) {
  77      DCmdArgument<char*>* argument = new DCmdArgument<char*>(
  78      name, desc,
  79      "STRING", mandatory, default_value);
  80      if (isarg) {
  81       parser->add_dcmd_argument(argument);
  82      } else {
  83       parser->add_dcmd_option(argument);
  84      }
  85    } else if (strcmp(type, "NANOTIME") == 0) {
  86      DCmdArgument<NanoTimeArgument>* argument = new DCmdArgument<NanoTimeArgument>(
  87      name, desc,
  88      "NANOTIME", mandatory, default_value);
  89      if (isarg) {
  90       parser->add_dcmd_argument(argument);
  91      } else {
  92       parser->add_dcmd_option(argument);
  93      }
  94    } else if (strcmp(type, "JLONG") == 0) {
  95      DCmdArgument<jlong>* argument = new DCmdArgument<jlong>(
  96      name, desc,
  97      "JLONG", mandatory, default_value);
  98      if (isarg) {
  99       parser->add_dcmd_argument(argument);
 100      } else {
 101       parser->add_dcmd_option(argument);
 102      }
 103    } else if (strcmp(type, "BOOLEAN") == 0) {
 104      DCmdArgument<bool>* argument = new DCmdArgument<bool>(
 105      name, desc,
 106      "BOOLEAN", mandatory, default_value);
 107      if (isarg) {
 108       parser->add_dcmd_argument(argument);
 109      } else {
 110       parser->add_dcmd_option(argument);
 111      }
 112    } else if (strcmp(type, "MEMORYSIZE") == 0) {
 113      DCmdArgument<MemorySizeArgument>* argument = new DCmdArgument<MemorySizeArgument>(
 114      name, desc,
 115      "MEMORY SIZE", mandatory, default_value);
 116      if (isarg) {
 117       parser->add_dcmd_argument(argument);
 118      } else {
 119       parser->add_dcmd_option(argument);
 120      }
 121    } else if (strcmp(type, "STRINGARRAY") == 0) {
 122      DCmdArgument<StringArrayArgument*>* argument = new DCmdArgument<StringArrayArgument*>(
 123      name, desc,
 124      "STRING SET", mandatory);
 125      if (isarg) {
 126       parser->add_dcmd_argument(argument);
 127      } else {
 128       parser->add_dcmd_option(argument);
 129      }
 130    }
 131 }
 132 
 133 /*
 134  * Will Fill in a java object array with alternating names of parsed command line options and
 135  * the value that has been parsed for it:
 136  * { name, value, name, value ... }
 137  * This can then be checked from java.
 138  */
 139 WB_ENTRY(jobjectArray, WB_ParseCommandLine(JNIEnv* env, jobject o, jstring j_cmdline, jchar j_delim, jobjectArray arguments))
 140   ResourceMark rm;
 141   DCmdParser parser;
 142 
 143   const char* c_cmdline = java_lang_String::as_utf8_string(JNIHandles::resolve(j_cmdline));
 144   const char c_delim = j_delim & 0xff;
 145   objArrayOop argumentArray = objArrayOop(JNIHandles::resolve_non_null(arguments));
 146   objArrayHandle argumentArray_ah(THREAD, argumentArray);
 147 
 148   int length = argumentArray_ah->length();
 149 
 150   for (int i = 0; i < length; i++) {
 151     oop argument_oop = argumentArray_ah->obj_at(i);
 152     fill_in_parser(&parser, argument_oop);
 153   }
 154 
 155   CmdLine cmdline(c_cmdline, strlen(c_cmdline), true);
 156   parser.parse(&cmdline,c_delim,CHECK_NULL);
 157 
 158   Klass* k = SystemDictionary::Object_klass();
 159   objArrayOop returnvalue_array = oopFactory::new_objArray(k, parser.num_arguments() * 2, CHECK_NULL);
 160   objArrayHandle returnvalue_array_ah(THREAD, returnvalue_array);
 161 
 162   GrowableArray<const char *>*parsedArgNames = parser.argument_name_array();
 163   GenDCmdArgument* arglist = parser.arguments_list();
 164 
 165   for (int i = 0; i < parser.num_arguments(); i++) {
 166     oop parsedName = java_lang_String::create_oop_from_str(parsedArgNames->at(i), CHECK_NULL);
 167     returnvalue_array_ah->obj_at_put(i*2, parsedName);
 168     GenDCmdArgument* arg = parser.lookup_dcmd_option(parsedArgNames->at(i), strlen(parsedArgNames->at(i)));
 169     if (!arg) {
 170       arg = arglist;
 171       arglist = arglist->next();
 172     }
 173     char buf[VALUE_MAXLEN];
 174     if (arg) {
 175       arg->value_as_str(buf, sizeof(buf));
 176     } else {
 177       sprintf(buf, "<null>");
 178     }
 179     oop parsedValue = java_lang_String::create_oop_from_str(buf, CHECK_NULL);
 180     returnvalue_array_ah->obj_at_put(i*2+1, parsedValue);
 181   }
 182 
 183   return (jobjectArray) JNIHandles::make_local(returnvalue_array_ah());
 184 
 185 WB_END