/*

 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#ifndef SHARE_RUNTIME_ARGUMENTS_HPP

#define SHARE_RUNTIME_ARGUMENTS_HPP

#include "logging/logLevel.hpp"

#include "logging/logTag.hpp"

#include "memory/allocation.hpp"

#include "runtime/flags/jvmFlag.hpp"

#include "runtime/java.hpp"

#include "runtime/os.hpp"

#include "runtime/perfData.hpp"

#include "utilities/debug.hpp"

// Arguments parses the command line and recognizes options

// Invocation API hook typedefs (these should really be defined in jni.h)

extern "C" {

  typedef void (JNICALL *abort_hook_t)(void);

  typedef void (JNICALL *exit_hook_t)(jint code);

  typedef jint (JNICALL *vfprintf_hook_t)(FILE *fp, const char *format, va_list args)  ATTRIBUTE_PRINTF(2, 0);

}

// Obsolete or deprecated -XX flag.

struct SpecialFlag {

  const char* name;

  JDK_Version deprecated_in; // When the deprecation warning started (or "undefined").

  JDK_Version obsolete_in;   // When the obsolete warning started (or "undefined").

  JDK_Version expired_in;    // When the option expires (or "undefined").

};

// PathString is used as:

//  - the underlying value for a SystemProperty

//  - the path portion of an --patch-module module/path pair

//  - the string that represents the system boot class path, Arguments::_system_boot_class_path.

class PathString : public CHeapObj<mtArguments> {

 protected:

  char* _value;

 public:

  char* value() const { return _value; }

  bool set_value(const char *value);

  void append_value(const char *value);

  PathString(const char* value);

  ~PathString();

};

// ModulePatchPath records the module/path pair as specified to --patch-module.

class ModulePatchPath : public CHeapObj<mtInternal> {

private:

  char* _module_name;

  PathString* _path;

public:

  ModulePatchPath(const char* module_name, const char* path);

  ~ModulePatchPath();

  inline void set_path(const char* path) { _path->set_value(path); }

  inline const char* module_name() const { return _module_name; }

  inline char* path_string() const { return _path->value(); }

};

// Element describing System and User (-Dkey=value flags) defined property.

//

// An internal SystemProperty is one that has been removed in

// jdk.internal.VM.saveAndRemoveProperties, like jdk.boot.class.path.append.

//

class SystemProperty : public PathString {

 private:

  char*           _key;

  SystemProperty* _next;

  bool            _internal;

  bool            _writeable;

  bool writeable() { return _writeable; }

 public:

  // Accessors

  char* value() const                 { return PathString::value(); }

  const char* key() const             { return _key; }

  bool internal() const               { return _internal; }

  SystemProperty* next() const        { return _next; }

  void set_next(SystemProperty* next) { _next = next; }

  bool is_readable() const {

    return !_internal || strcmp(_key, "jdk.boot.class.path.append") == 0;

  }

  // A system property should only have its value set

  // via an external interface if it is a writeable property.

  // The internal, non-writeable property jdk.boot.class.path.append

  // is the only exception to this rule.  It can be set externally

  // via -Xbootclasspath/a or JVMTI OnLoad phase call to AddToBootstrapClassLoaderSearch.

  // In those cases for jdk.boot.class.path.append, the base class

  // set_value and append_value methods are called directly.

  bool set_writeable_value(const char *value) {

    if (writeable()) {

      return set_value(value);

    }

    return false;

  }

  // Constructor

  SystemProperty(const char* key, const char* value, bool writeable, bool internal = false);

};

// For use by -agentlib, -agentpath and -Xrun

class AgentLibrary : public CHeapObj<mtArguments> {

  friend class AgentLibraryList;

public:

  // Is this library valid or not. Don't rely on os_lib == NULL as statically

  // linked lib could have handle of RTLD_DEFAULT which == 0 on some platforms

  enum AgentState {

    agent_invalid = 0,

    agent_valid   = 1

  };

 private:

  char*           _name;

  char*           _options;

  void*           _os_lib;

  bool            _is_absolute_path;

  bool            _is_static_lib;

  bool            _is_instrument_lib;

  AgentState      _state;

  AgentLibrary*   _next;

 public:

  // Accessors

  const char* name() const                  { return _name; }

  char* options() const                     { return _options; }

  bool is_absolute_path() const             { return _is_absolute_path; }

  void* os_lib() const                      { return _os_lib; }

  void set_os_lib(void* os_lib)             { _os_lib = os_lib; }

  AgentLibrary* next() const                { return _next; }

  bool is_static_lib() const                { return _is_static_lib; }

  bool is_instrument_lib() const            { return _is_instrument_lib; }

  void set_static_lib(bool is_static_lib)   { _is_static_lib = is_static_lib; }

  bool valid()                              { return (_state == agent_valid); }

  void set_valid()                          { _state = agent_valid; }

  void set_invalid()                        { _state = agent_invalid; }

  // Constructor

  AgentLibrary(const char* name, const char* options, bool is_absolute_path,

               void* os_lib, bool instrument_lib=false);

};

// maintain an order of entry list of AgentLibrary

class AgentLibraryList {

 private:

  AgentLibrary*   _first;

  AgentLibrary*   _last;

 public:

  bool is_empty() const                     { return _first == NULL; }

  AgentLibrary* first() const               { return _first; }

  // add to the end of the list

  void add(AgentLibrary* lib) {

    if (is_empty()) {

      _first = _last = lib;

    } else {

      _last->_next = lib;

      _last = lib;

    }

    lib->_next = NULL;

  }

  // search for and remove a library known to be in the list

  void remove(AgentLibrary* lib) {

    AgentLibrary* curr;

    AgentLibrary* prev = NULL;

    for (curr = first(); curr != NULL; prev = curr, curr = curr->next()) {

      if (curr == lib) {

        break;

      }

    }

    assert(curr != NULL, "always should be found");

    if (curr != NULL) {

      // it was found, by-pass this library

      if (prev == NULL) {

        _first = curr->_next;

      } else {

        prev->_next = curr->_next;

      }

      if (curr == _last) {

        _last = prev;

      }

      curr->_next = NULL;

    }

  }

  AgentLibraryList() {

    _first = NULL;

    _last = NULL;

  }

};

// Helper class for controlling the lifetime of JavaVMInitArgs objects.

class ScopedVMInitArgs;

// Most logging functions require 5 tags. Some of them may be _NO_TAG.

typedef struct {

  const char* alias_name;

  LogLevelType level;

  bool exactMatch;

  LogTagType tag0;

  LogTagType tag1;

  LogTagType tag2;

  LogTagType tag3;

  LogTagType tag4;

  LogTagType tag5;

} AliasedLoggingFlag;

class Arguments : AllStatic {

  friend class VMStructs;

  friend class JvmtiExport;

  friend class CodeCacheExtensions;

  friend class ArgumentsTest;

 public:

  // Operation modi

  enum Mode {

    _int,       // corresponds to -Xint

    _mixed,     // corresponds to -Xmixed

    _comp       // corresponds to -Xcomp

  };

  enum ArgsRange {

    arg_unreadable = -3,

    arg_too_small  = -2,

    arg_too_big    = -1,

    arg_in_range   = 0

  };

  enum PropertyAppendable {

    AppendProperty,

    AddProperty

  };

  enum PropertyWriteable {

    WriteableProperty,

    UnwriteableProperty

  };

  enum PropertyInternal {

    InternalProperty,

    ExternalProperty

  };

 private:

  // a pointer to the flags file name if it is specified

  static char*  _jvm_flags_file;

  // an array containing all flags specified in the .hotspotrc file

  static char** _jvm_flags_array;

  static int    _num_jvm_flags;

  // an array containing all jvm arguments specified in the command line

  static char** _jvm_args_array;

  static int    _num_jvm_args;

  // string containing all java command (class/jarfile name and app args)

  static char* _java_command;

  // Property list

  static SystemProperty* _system_properties;

  // Quick accessor to System properties in the list:

  static SystemProperty *_sun_boot_library_path;

  static SystemProperty *_java_library_path;

  static SystemProperty *_java_home;

  static SystemProperty *_java_class_path;

  static SystemProperty *_jdk_boot_class_path_append;

  static SystemProperty *_vm_info;

  // --patch-module=module=<file>(<pathsep><file>)*

  // Each element contains the associated module name, path

  // string pair as specified to --patch-module.

  static GrowableArray<ModulePatchPath*>* _patch_mod_prefix;

  // The constructed value of the system class path after

  // argument processing and JVMTI OnLoad additions via

  // calls to AddToBootstrapClassLoaderSearch.  This is the

  // final form before ClassLoader::setup_bootstrap_search().

  // Note: since --patch-module is a module name/path pair, the

  // system boot class path string no longer contains the "prefix"

  // to the boot class path base piece as it did when

  // -Xbootclasspath/p was supported.

  static PathString *_system_boot_class_path;

  // Set if a modular java runtime image is present vs. a build with exploded modules

  static bool _has_jimage;

  // temporary: to emit warning if the default ext dirs are not empty.

  // remove this variable when the warning is no longer needed.

  static char* _ext_dirs;

  // java.vendor.url.bug, bug reporting URL for fatal errors.

  static const char* _java_vendor_url_bug;

  // sun.java.launcher, private property to provide information about

  // java launcher

  static const char* _sun_java_launcher;

  // was this VM created via the -XXaltjvm=<path> option

  static bool   _sun_java_launcher_is_altjvm;

  // Option flags

  static const char*  _gc_log_filename;

  // Value of the conservative maximum heap alignment needed

  static size_t  _conservative_max_heap_alignment;

  // -Xrun arguments

  static AgentLibraryList _libraryList;

  static void add_init_library(const char* name, char* options);

  // -agentlib and -agentpath arguments

  static AgentLibraryList _agentList;

  static void add_init_agent(const char* name, char* options, bool absolute_path);

  static void add_instrument_agent(const char* name, char* options, bool absolute_path);

  // Late-binding agents not started via arguments

  static void add_loaded_agent(AgentLibrary *agentLib);

  // Operation modi

  static Mode _mode;

  static void set_mode_flags(Mode mode);

  static bool _java_compiler;

  static void set_java_compiler(bool arg) { _java_compiler = arg; }

  static bool java_compiler()   { return _java_compiler; }

  // -Xdebug flag

  static bool _xdebug_mode;

  static void set_xdebug_mode(bool arg) { _xdebug_mode = arg; }

  static bool xdebug_mode()             { return _xdebug_mode; }

  // preview features

  static bool _enable_preview;

  // Used to save default settings

  static bool _AlwaysCompileLoopMethods;

  static bool _UseOnStackReplacement;

  static bool _BackgroundCompilation;

  static bool _ClipInlining;

  static intx _Tier3InvokeNotifyFreqLog;

  static intx _Tier4InvocationThreshold;

  // GC ergonomics

  static void set_conservative_max_heap_alignment();

  static void set_use_compressed_oops();

  static void set_use_compressed_klass_ptrs();

  static jint set_ergonomics_flags();

  static void set_shared_spaces_flags();

  // limits the given memory size by the maximum amount of memory this process is

  // currently allowed to allocate or reserve.

  static julong limit_by_allocatable_memory(julong size);

  // Setup heap size

  static void set_heap_size();

  // Bytecode rewriting

  static void set_bytecode_flags();

  // Invocation API hooks

  static abort_hook_t     _abort_hook;

  static exit_hook_t      _exit_hook;

  static vfprintf_hook_t  _vfprintf_hook;

  // System properties

  static bool add_property(const char* prop, PropertyWriteable writeable=WriteableProperty,

                           PropertyInternal internal=ExternalProperty);

  static bool create_property(const char* prop_name, const char* prop_value, PropertyInternal internal);

  static bool create_numbered_property(const char* prop_base_name, const char* prop_value, unsigned int count);

  static int process_patch_mod_option(const char* patch_mod_tail, bool* patch_mod_javabase);

  // Aggressive optimization flags.

  static jint set_aggressive_opts_flags();

  static jint set_aggressive_heap_flags();

  // Argument parsing

  static void do_pd_flag_adjustments();

  static bool parse_argument(const char* arg, JVMFlag::Flags origin);

  static bool process_argument(const char* arg, jboolean ignore_unrecognized, JVMFlag::Flags origin);

  static void process_java_launcher_argument(const char*, void*);

  static void process_java_compiler_argument(const char* arg);

  static jint parse_options_environment_variable(const char* name, ScopedVMInitArgs* vm_args);

  static jint parse_java_tool_options_environment_variable(ScopedVMInitArgs* vm_args);

  static jint parse_java_options_environment_variable(ScopedVMInitArgs* vm_args);

  static jint parse_vm_options_file(const char* file_name, ScopedVMInitArgs* vm_args);

  static jint parse_options_buffer(const char* name, char* buffer, const size_t buf_len, ScopedVMInitArgs* vm_args);

  static jint parse_xss(const JavaVMOption* option, const char* tail, intx* out_ThreadStackSize);

  static jint insert_vm_options_file(const JavaVMInitArgs* args,

                                     const char* vm_options_file,

                                     const int vm_options_file_pos,

                                     ScopedVMInitArgs* vm_options_file_args,

                                     ScopedVMInitArgs* args_out);

  static bool args_contains_vm_options_file_arg(const JavaVMInitArgs* args);

  static jint expand_vm_options_as_needed(const JavaVMInitArgs* args_in,

                                          ScopedVMInitArgs* mod_args,

                                          JavaVMInitArgs** args_out);

  static jint match_special_option_and_act(const JavaVMInitArgs* args,

                                           ScopedVMInitArgs* args_out);

  static bool handle_deprecated_print_gc_flags();

  static void handle_extra_cms_flags(const char* msg);

  static jint parse_vm_init_args(const JavaVMInitArgs *java_tool_options_args,

                                 const JavaVMInitArgs *java_options_args,

                                 const JavaVMInitArgs *cmd_line_args);

  static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, bool* patch_mod_javabase, JVMFlag::Flags origin);

  static jint finalize_vm_init_args(bool patch_mod_javabase);

  static bool is_bad_option(const JavaVMOption* option, jboolean ignore, const char* option_type);

  static bool is_bad_option(const JavaVMOption* option, jboolean ignore) {

    return is_bad_option(option, ignore, NULL);

  }

  static void describe_range_error(ArgsRange errcode);

  static ArgsRange check_memory_size(julong size, julong min_size, julong max_size);

  static ArgsRange parse_memory_size(const char* s, julong* long_arg,

                                     julong min_size, julong max_size = max_uintx);

  // Parse a string for a unsigned integer.  Returns true if value

  // is an unsigned integer greater than or equal to the minimum

  // parameter passed and returns the value in uintx_arg.  Returns

  // false otherwise, with uintx_arg undefined.

  static bool parse_uintx(const char* value, uintx* uintx_arg,

                          uintx min_size);

  // methods to build strings from individual args

  static void build_jvm_args(const char* arg);

  static void build_jvm_flags(const char* arg);

  static void add_string(char*** bldarray, int* count, const char* arg);

  static const char* build_resource_string(char** args, int count);

  // Returns true if the flag is obsolete (and not yet expired).

  // In this case the 'version' buffer is filled in with

  // the version number when the flag became obsolete.

  static bool is_obsolete_flag(const char* flag_name, JDK_Version* version);

#ifndef PRODUCT

  static const char* removed_develop_logging_flag_name(const char* name);

#endif // PRODUCT

  // Returns 1 if the flag is deprecated (and not yet obsolete or expired).

  //     In this case the 'version' buffer is filled in with the version number when

  //     the flag became deprecated.

  // Returns -1 if the flag is expired or obsolete.

  // Returns 0 otherwise.

  static int is_deprecated_flag(const char* flag_name, JDK_Version* version);

  // Return the real name for the flag passed on the command line (either an alias name or "flag_name").

  static const char* real_flag_name(const char *flag_name);

  // Return the "real" name for option arg if arg is an alias, and print a warning if arg is deprecated.

  // Return NULL if the arg has expired.

  static const char* handle_aliases_and_deprecation(const char* arg, bool warn);

  static bool lookup_logging_aliases(const char* arg, char* buffer);

  static AliasedLoggingFlag catch_logging_aliases(const char* name, bool on);

  static char*  SharedArchivePath;

  static char*  SharedDynamicArchivePath;

  static int num_archives(const char* archive_path) NOT_CDS_RETURN_(0);

  static void extract_shared_archive_paths(const char* archive_path,

                                         char** base_archive_path,

                                         char** top_archive_path) NOT_CDS_RETURN;

 public:

  // Parses the arguments, first phase

  static jint parse(const JavaVMInitArgs* args);

  // Apply ergonomics

  static jint apply_ergo();

  // Adjusts the arguments after the OS have adjusted the arguments

  static jint adjust_after_os();

  // Check for consistency in the selection of the garbage collector.