/*

 * Copyright (c) 1997, 2017, 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.

 *

 */

#include "precompiled.hpp"

#include "jvm.h"

#include "memory/allocation.inline.hpp"

#include "oops/oop.inline.hpp"

#include "runtime/arguments.hpp"

#include "runtime/globals.hpp"

#include "runtime/globals_extension.hpp"

#include "runtime/commandLineFlagConstraintList.hpp"

#include "runtime/commandLineFlagWriteableList.hpp"

#include "runtime/commandLineFlagRangeList.hpp"

#include "runtime/os.hpp"

#include "runtime/sharedRuntime.hpp"

#include "trace/tracing.hpp"

#include "utilities/defaultStream.hpp"

#include "utilities/macros.hpp"

#include "utilities/ostream.hpp"

#if INCLUDE_ALL_GCS

#include "gc/g1/g1_globals.hpp"

#include "gc/epsilon/epsilon_globals.hpp"

#endif // INCLUDE_ALL_GCS

#ifdef COMPILER1

#include "c1/c1_globals.hpp"

#endif

#if INCLUDE_JVMCI

#include "jvmci/jvmci_globals.hpp"

#endif

#ifdef COMPILER2

#include "opto/c2_globals.hpp"

#endif

RUNTIME_FLAGS(MATERIALIZE_DEVELOPER_FLAG, \

              MATERIALIZE_PD_DEVELOPER_FLAG, \

              MATERIALIZE_PRODUCT_FLAG, \

              MATERIALIZE_PD_PRODUCT_FLAG, \

              MATERIALIZE_DIAGNOSTIC_FLAG, \

              MATERIALIZE_PD_DIAGNOSTIC_FLAG, \

              MATERIALIZE_EXPERIMENTAL_FLAG, \

              MATERIALIZE_NOTPRODUCT_FLAG, \

              MATERIALIZE_MANAGEABLE_FLAG, \

              MATERIALIZE_PRODUCT_RW_FLAG, \

              MATERIALIZE_LP64_PRODUCT_FLAG, \

              IGNORE_RANGE, \

              IGNORE_CONSTRAINT, \

              IGNORE_WRITEABLE)

RUNTIME_OS_FLAGS(MATERIALIZE_DEVELOPER_FLAG, \

                 MATERIALIZE_PD_DEVELOPER_FLAG, \

                 MATERIALIZE_PRODUCT_FLAG, \

                 MATERIALIZE_PD_PRODUCT_FLAG, \

                 MATERIALIZE_DIAGNOSTIC_FLAG, \

                 MATERIALIZE_PD_DIAGNOSTIC_FLAG, \

                 MATERIALIZE_NOTPRODUCT_FLAG, \

                 IGNORE_RANGE, \

                 IGNORE_CONSTRAINT, \

                 IGNORE_WRITEABLE)

ARCH_FLAGS(MATERIALIZE_DEVELOPER_FLAG, \

           MATERIALIZE_PRODUCT_FLAG, \

           MATERIALIZE_DIAGNOSTIC_FLAG, \

           MATERIALIZE_EXPERIMENTAL_FLAG, \

           MATERIALIZE_NOTPRODUCT_FLAG, \

           IGNORE_RANGE, \

           IGNORE_CONSTRAINT, \

           IGNORE_WRITEABLE)

MATERIALIZE_FLAGS_EXT

#define DEFAULT_RANGE_STR_CHUNK_SIZE 64

static char* create_range_str(const char *fmt, ...) {

  static size_t string_length = DEFAULT_RANGE_STR_CHUNK_SIZE;

  static char* range_string = NEW_C_HEAP_ARRAY(char, string_length, mtLogging);

  int size_needed = 0;

  do {

    va_list args;

    va_start(args, fmt);

    size_needed = jio_vsnprintf(range_string, string_length, fmt, args);

    va_end(args);

    if (size_needed < 0) {

      string_length += DEFAULT_RANGE_STR_CHUNK_SIZE;

      range_string = REALLOC_C_HEAP_ARRAY(char, range_string, string_length, mtLogging);

      guarantee(range_string != NULL, "create_range_str string should not be NULL");

    }

  } while (size_needed < 0);

  return range_string;

}

const char* Flag::get_int_default_range_str() {

  return create_range_str("[ " INT32_FORMAT_W(-25) " ... " INT32_FORMAT_W(25) " ]", INT_MIN, INT_MAX);

}

const char* Flag::get_uint_default_range_str() {

  return create_range_str("[ " UINT32_FORMAT_W(-25) " ... " UINT32_FORMAT_W(25) " ]", 0, UINT_MAX);

}

const char* Flag::get_intx_default_range_str() {

  return create_range_str("[ " INTX_FORMAT_W(-25) " ... " INTX_FORMAT_W(25) " ]", min_intx, max_intx);

}

const char* Flag::get_uintx_default_range_str() {

  return create_range_str("[ " UINTX_FORMAT_W(-25) " ... " UINTX_FORMAT_W(25) " ]", 0, max_uintx);

}

const char* Flag::get_uint64_t_default_range_str() {

  return create_range_str("[ " UINT64_FORMAT_W(-25) " ... " UINT64_FORMAT_W(25) " ]", 0, uint64_t(max_juint));

}

const char* Flag::get_size_t_default_range_str() {

  return create_range_str("[ " SIZE_FORMAT_W(-25) " ... " SIZE_FORMAT_W(25) " ]", 0, SIZE_MAX);

}

const char* Flag::get_double_default_range_str() {

  return create_range_str("[ %-25.3f ... %25.3f ]", DBL_MIN, DBL_MAX);

}

static bool is_product_build() {

#ifdef PRODUCT

  return true;

#else

  return false;

#endif

}

Flag::Error Flag::check_writable(bool changed) {

  if (is_constant_in_binary()) {

    fatal("flag is constant: %s", _name);

  }

  Flag::Error error = Flag::SUCCESS;

  if (changed) {

    CommandLineFlagWriteable* writeable = CommandLineFlagWriteableList::find(_name);

    if (writeable) {

      if (writeable->is_writeable() == false) {

        switch (writeable->type())

        {

          case CommandLineFlagWriteable::Once:

            error = Flag::SET_ONLY_ONCE;

            jio_fprintf(defaultStream::error_stream(), "Error: %s may not be set more than once\n", _name);

            break;

          case CommandLineFlagWriteable::CommandLineOnly:

            error = Flag::COMMAND_LINE_ONLY;

            jio_fprintf(defaultStream::error_stream(), "Error: %s may be modified only from commad line\n", _name);

            break;

          default:

            ShouldNotReachHere();

            break;

        }

      }

      writeable->mark_once();

    }

  }

  return error;

}

bool Flag::is_bool() const {

  return strcmp(_type, "bool") == 0;

}

bool Flag::get_bool() const {

  return *((bool*) _addr);

}

Flag::Error Flag::set_bool(bool value) {

  Flag::Error error = check_writable(value!=get_bool());

  if (error == Flag::SUCCESS) {

    *((bool*) _addr) = value;

  }

  return error;

}

bool Flag::is_int() const {

  return strcmp(_type, "int")  == 0;

}

int Flag::get_int() const {

  return *((int*) _addr);

}

Flag::Error Flag::set_int(int value) {

  Flag::Error error = check_writable(value!=get_int());

  if (error == Flag::SUCCESS) {

    *((int*) _addr) = value;

  }

  return error;

}

bool Flag::is_uint() const {

  return strcmp(_type, "uint")  == 0;

}

uint Flag::get_uint() const {

  return *((uint*) _addr);

}

Flag::Error Flag::set_uint(uint value) {

  Flag::Error error = check_writable(value!=get_uint());

  if (error == Flag::SUCCESS) {

    *((uint*) _addr) = value;

  }

  return error;

}

bool Flag::is_intx() const {

  return strcmp(_type, "intx")  == 0;

}

intx Flag::get_intx() const {

  return *((intx*) _addr);

}

Flag::Error Flag::set_intx(intx value) {

  Flag::Error error = check_writable(value!=get_intx());

  if (error == Flag::SUCCESS) {

    *((intx*) _addr) = value;

  }

  return error;

}

bool Flag::is_uintx() const {

  return strcmp(_type, "uintx") == 0;

}

uintx Flag::get_uintx() const {

  return *((uintx*) _addr);

}

Flag::Error Flag::set_uintx(uintx value) {

  Flag::Error error = check_writable(value!=get_uintx());

  if (error == Flag::SUCCESS) {

    *((uintx*) _addr) = value;

  }

  return error;

}

bool Flag::is_uint64_t() const {

  return strcmp(_type, "uint64_t") == 0;

}

uint64_t Flag::get_uint64_t() const {

  return *((uint64_t*) _addr);

}

Flag::Error Flag::set_uint64_t(uint64_t value) {

  Flag::Error error = check_writable(value!=get_uint64_t());

  if (error == Flag::SUCCESS) {

    *((uint64_t*) _addr) = value;

  }

  return error;

}

bool Flag::is_size_t() const {

  return strcmp(_type, "size_t") == 0;

}

size_t Flag::get_size_t() const {

  return *((size_t*) _addr);

}

Flag::Error Flag::set_size_t(size_t value) {

  Flag::Error error = check_writable(value!=get_size_t());

  if (error == Flag::SUCCESS) {

    *((size_t*) _addr) = value;

  }

  return error;

}

bool Flag::is_double() const {

  return strcmp(_type, "double") == 0;

}

double Flag::get_double() const {

  return *((double*) _addr);

}

Flag::Error Flag::set_double(double value) {

  Flag::Error error = check_writable(value!=get_double());

  if (error == Flag::SUCCESS) {

    *((double*) _addr) = value;

  }

  return error;

}

bool Flag::is_ccstr() const {

  return strcmp(_type, "ccstr") == 0 || strcmp(_type, "ccstrlist") == 0;

}

bool Flag::ccstr_accumulates() const {

  return strcmp(_type, "ccstrlist") == 0;

}

ccstr Flag::get_ccstr() const {

  return *((ccstr*) _addr);

}

Flag::Error Flag::set_ccstr(ccstr value) {

  Flag::Error error = check_writable(value!=get_ccstr());

  if (error == Flag::SUCCESS) {

    *((ccstr*) _addr) = value;

  }

  return error;

}

Flag::Flags Flag::get_origin() {

  return Flags(_flags & VALUE_ORIGIN_MASK);

}

void Flag::set_origin(Flags origin) {

  assert((origin & VALUE_ORIGIN_MASK) == origin, "sanity");

  Flags new_origin = Flags((origin == COMMAND_LINE) ? Flags(origin | ORIG_COMMAND_LINE) : origin);

  _flags = Flags((_flags & ~VALUE_ORIGIN_MASK) | new_origin);

}

bool Flag::is_default() {

  return (get_origin() == DEFAULT);

}

bool Flag::is_ergonomic() {

  return (get_origin() == ERGONOMIC);

}

bool Flag::is_command_line() {

  return (_flags & ORIG_COMMAND_LINE) != 0;

}

void Flag::set_command_line() {

  _flags = Flags(_flags | ORIG_COMMAND_LINE);

}

bool Flag::is_product() const {

  return (_flags & KIND_PRODUCT) != 0;

}

bool Flag::is_manageable() const {

  return (_flags & KIND_MANAGEABLE) != 0;

}

bool Flag::is_diagnostic() const {

  return (_flags & KIND_DIAGNOSTIC) != 0;

}

bool Flag::is_experimental() const {

  return (_flags & KIND_EXPERIMENTAL) != 0;

}

bool Flag::is_notproduct() const {

  return (_flags & KIND_NOT_PRODUCT) != 0;

}

bool Flag::is_develop() const {

  return (_flags & KIND_DEVELOP) != 0;

}

bool Flag::is_read_write() const {

  return (_flags & KIND_READ_WRITE) != 0;

}

bool Flag::is_commercial() const {

  return (_flags & KIND_COMMERCIAL) != 0;

}

/**

 * Returns if this flag is a constant in the binary.  Right now this is

 * true for notproduct and develop flags in product builds.

 */

bool Flag::is_constant_in_binary() const {

#ifdef PRODUCT

    return is_notproduct() || is_develop();

#else

    return false;

#endif

}

bool Flag::is_unlocker() const {

  return strcmp(_name, "UnlockDiagnosticVMOptions") == 0     ||

         strcmp(_name, "UnlockExperimentalVMOptions") == 0   ||

         is_unlocker_ext();

}

bool Flag::is_unlocked() const {

  if (is_diagnostic()) {

    return UnlockDiagnosticVMOptions;

  }

  if (is_experimental()) {

    return UnlockExperimentalVMOptions;

  }

  return is_unlocked_ext();

}

void Flag::clear_diagnostic() {

  assert(is_diagnostic(), "sanity");

  _flags = Flags(_flags & ~KIND_DIAGNOSTIC);

  assert(!is_diagnostic(), "sanity");

}

// Get custom message for this locked flag, or NULL if

// none is available. Returns message type produced.

Flag::MsgType Flag::get_locked_message(char* buf, int buflen) const {

  buf[0] = '\0';

  if (is_diagnostic() && !is_unlocked()) {

    jio_snprintf(buf, buflen,

                 "Error: VM option '%s' is diagnostic and must be enabled via -XX:+UnlockDiagnosticVMOptions.\n"

                 "Error: The unlock option must precede '%s'.\n",

                 _name, _name);

    return Flag::DIAGNOSTIC_FLAG_BUT_LOCKED;

  }

  if (is_experimental() && !is_unlocked()) {

    jio_snprintf(buf, buflen,

                 "Error: VM option '%s' is experimental and must be enabled via -XX:+UnlockExperimentalVMOptions.\n"

                 "Error: The unlock option must precede '%s'.\n",

                 _name, _name);

    return Flag::EXPERIMENTAL_FLAG_BUT_LOCKED;

  }

  if (is_develop() && is_product_build()) {

    jio_snprintf(buf, buflen, "Error: VM option '%s' is develop and is available only in debug version of VM.\n",

                 _name);

    return Flag::DEVELOPER_FLAG_BUT_PRODUCT_BUILD;

  }

  if (is_notproduct() && is_product_build()) {

    jio_snprintf(buf, buflen, "Error: VM option '%s' is notproduct and is available only in debug version of VM.\n",

                 _name);

    return Flag::NOTPRODUCT_FLAG_BUT_PRODUCT_BUILD;

  }

  get_locked_message_ext(buf, buflen);

  return Flag::NONE;

}

bool Flag::is_writeable() const {

  return is_manageable() || (is_product() && is_read_write()) || is_writeable_ext();

}

// All flags except "manageable" are assumed to be internal flags.

// Long term, we need to define a mechanism to specify which flags

// are external/stable and change this function accordingly.

bool Flag::is_external() const {

  return is_manageable() || is_external_ext();

}

void Flag::print_on(outputStream* st, bool withComments, bool printRanges) {

  // Don't print notproduct and develop flags in a product build.

  if (is_constant_in_binary()) {

    return;

  }

  if (!printRanges) {

    // Use some named constants to make code more readable.

    const unsigned int nSpaces    = 10;

    const unsigned int maxFlagLen = 40 + nSpaces;

    // The print below assumes that the flag name is 40 characters or less.

    // This works for most flags, but there are exceptions. Our longest flag

    // name right now is UseAdaptiveGenerationSizePolicyAtMajorCollection and

    // its minor collection buddy. These are 48 characters. We use a buffer of

    // nSpaces spaces below to adjust the space between the flag value and the

    // column of flag type and origin that is printed in the end of the line.

    char spaces[nSpaces + 1] = "          ";

    st->print("%9s %-*s = ", _type, maxFlagLen-nSpaces, _name);

    if (is_bool()) {

      st->print("%-20s", get_bool() ? "true" : "false");

    } else if (is_int()) {

      st->print("%-20d", get_int());

    } else if (is_uint()) {

      st->print("%-20u", get_uint());