/*

 * Copyright (c) 1997, 2018, 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 "memory/allocation.inline.hpp"

#include "runtime/arguments.hpp"

#include "runtime/flags/jvmFlag.hpp"

#include "runtime/flags/jvmFlagConstraintList.hpp"

#include "runtime/flags/jvmFlagWriteableList.hpp"

#include "runtime/flags/jvmFlagRangeList.hpp"

#include "runtime/globals_extension.hpp"

#include "trace/tracing.hpp"

#include "utilities/defaultStream.hpp"

#include "utilities/stringUtils.hpp"

#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* JVMFlag::get_int_default_range_str() {

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

}

const char* JVMFlag::get_uint_default_range_str() {

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

}

const char* JVMFlag::get_intx_default_range_str() {

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

}

const char* JVMFlag::get_uintx_default_range_str() {

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

}

const char* JVMFlag::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* JVMFlag::get_size_t_default_range_str() {

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

}

const char* JVMFlag::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

}

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

  if (is_constant_in_binary()) {

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

  }

  JVMFlag::Error error = JVMFlag::SUCCESS;

  if (changed) {

    JVMFlagWriteable* writeable = JVMFlagWriteableList::find(_name);

    if (writeable) {

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

        switch (writeable->type())

        {

          case JVMFlagWriteable::Once:

            error = JVMFlag::SET_ONLY_ONCE;

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

            break;

          case JVMFlagWriteable::CommandLineOnly:

            error = JVMFlag::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 JVMFlag::is_bool() const {

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

}

bool JVMFlag::get_bool() const {

  return *((bool*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((bool*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_int() const {

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

}

int JVMFlag::get_int() const {

  return *((int*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((int*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_uint() const {

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

}

uint JVMFlag::get_uint() const {

  return *((uint*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((uint*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_intx() const {

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

}

intx JVMFlag::get_intx() const {

  return *((intx*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((intx*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_uintx() const {

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

}

uintx JVMFlag::get_uintx() const {

  return *((uintx*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((uintx*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_uint64_t() const {

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

}

uint64_t JVMFlag::get_uint64_t() const {

  return *((uint64_t*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((uint64_t*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_size_t() const {

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

}

size_t JVMFlag::get_size_t() const {

  return *((size_t*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((size_t*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_double() const {

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

}

double JVMFlag::get_double() const {

  return *((double*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((double*) _addr) = value;

  }

  return error;

}

bool JVMFlag::is_ccstr() const {

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

}

bool JVMFlag::ccstr_accumulates() const {

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

}

ccstr JVMFlag::get_ccstr() const {

  return *((ccstr*) _addr);

}

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

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

  if (error == JVMFlag::SUCCESS) {

    *((ccstr*) _addr) = value;

  }

  return error;

}

JVMFlag::Flags JVMFlag::get_origin() {

  return Flags(_flags & VALUE_ORIGIN_MASK);

}

void JVMFlag::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 JVMFlag::is_default() {

  return (get_origin() == DEFAULT);

}

bool JVMFlag::is_ergonomic() {

  return (get_origin() == ERGONOMIC);

}

bool JVMFlag::is_command_line() {

  return (_flags & ORIG_COMMAND_LINE) != 0;

}

void JVMFlag::set_command_line() {

  _flags = Flags(_flags | ORIG_COMMAND_LINE);

}

bool JVMFlag::is_product() const {

  return (_flags & KIND_PRODUCT) != 0;

}

bool JVMFlag::is_manageable() const {

  return (_flags & KIND_MANAGEABLE) != 0;

}

bool JVMFlag::is_diagnostic() const {

  return (_flags & KIND_DIAGNOSTIC) != 0;

}

bool JVMFlag::is_experimental() const {

  return (_flags & KIND_EXPERIMENTAL) != 0;

}

bool JVMFlag::is_notproduct() const {

  return (_flags & KIND_NOT_PRODUCT) != 0;

}

bool JVMFlag::is_develop() const {

  return (_flags & KIND_DEVELOP) != 0;

}

bool JVMFlag::is_read_write() const {

  return (_flags & KIND_READ_WRITE) != 0;

}

bool JVMFlag::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 JVMFlag::is_constant_in_binary() const {

#ifdef PRODUCT

  return is_notproduct() || is_develop();

#else

  return false;

#endif

}

bool JVMFlag::is_unlocker() const {

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

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

  is_unlocker_ext();

}

bool JVMFlag::is_unlocked() const {

  if (is_diagnostic()) {

    return UnlockDiagnosticVMOptions;

  }

  if (is_experimental()) {

    return UnlockExperimentalVMOptions;

  }

  return is_unlocked_ext();

}

void JVMFlag::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.

JVMFlag::MsgType JVMFlag::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 JVMFlag::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 JVMFlag::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 JVMFlag::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 JVMFlag::NOTPRODUCT_FLAG_BUT_PRODUCT_BUILD;

  }

  return get_locked_message_ext(buf, buflen);

}

bool JVMFlag::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 JVMFlag::is_external() const {

  return is_manageable() || is_external_ext();

}

// Helper function for JVMFlag::print_on().

// Fills current line up to requested position.

// Should the current position already be past the requested position,

// one separator blank is enforced.

void fill_to_pos(outputStream* st, unsigned int req_pos) {

  if ((unsigned int)st->position() < req_pos) {

    st->fill_to(req_pos);  // need to fill with blanks to reach req_pos

  } else {

    st->print(" ");        // enforce blank separation. Previous field too long.

  }

}

void JVMFlag::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) {

    // The command line options -XX:+PrintFlags* cause this function to be called

    // for each existing flag to print information pertinent to this flag. The data

    // is displayed in columnar form, with the following layout:

    //  col1 - data type, right-justified

    //  col2 - name,      left-justified

    //  col3 - ' ='       double-char, leading space to align with possible '+='

    //  col4 - value      left-justified

    //  col5 - kind       right-justified

    //  col6 - origin     left-justified

    //  col7 - comments   left-justified

    //

    //  The column widths are fixed. They are defined such that, for most cases,

    //  an eye-pleasing tabular output is created.

    //

    //  Sample output:

    //       bool CMSScavengeBeforeRemark                  = false                                     {product} {default}

    //      uintx CMSScheduleRemarkEdenPenetration         = 50                                        {product} {default}

    //     size_t CMSScheduleRemarkEdenSizeThreshold       = 2097152                                   {product} {default}

    //      uintx CMSScheduleRemarkSamplingRatio           = 5                                         {product} {default}

    //     double CMSSmallCoalSurplusPercent               = 1.050000                                  {product} {default}

    //      ccstr CompileCommandFile                       = MyFile.cmd                                {product} {command line}

    //  ccstrlist CompileOnly                              = Method1

    //            CompileOnly                             += Method2                                   {product} {command line}

    //  |         |                                       |  |                              |                    |               |

    //  |         |                                       |  |                              |                    |               +-- col7

    //  |         |                                       |  |                              |                    +-- col6

    //  |         |                                       |  |                              +-- col5

    //  |         |                                       |  +-- col4

    //  |         |                                       +-- col3

    //  |         +-- col2

    //  +-- col1

    const unsigned int col_spacing = 1;

    const unsigned int col1_pos    = 0;

    const unsigned int col1_width  = 9;

    const unsigned int col2_pos    = col1_pos + col1_width + col_spacing;

    const unsigned int col2_width  = 39;

    const unsigned int col3_pos    = col2_pos + col2_width + col_spacing;

    const unsigned int col3_width  = 2;

    const unsigned int col4_pos    = col3_pos + col3_width + col_spacing;

    const unsigned int col4_width  = 30;

    const unsigned int col5_pos    = col4_pos + col4_width + col_spacing;

    const unsigned int col5_width  = 20;

    const unsigned int col6_pos    = col5_pos + col5_width + col_spacing;

    const unsigned int col6_width  = 15;

    const unsigned int col7_pos    = col6_pos + col6_width + col_spacing;

    const unsigned int col7_width  = 1;

    st->fill_to(col1_pos);

    st->print("%*s", col1_width, _type);  // right-justified, therefore width is required.

    fill_to_pos(st, col2_pos);

    st->print("%s", _name);

    fill_to_pos(st, col3_pos);

    st->print(" =");  // use " =" for proper alignment with multiline ccstr output.

    fill_to_pos(st, col4_pos);

    if (is_bool()) {

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

    } else if (is_int()) {

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

    } else if (is_uint()) {

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

    } else if (is_intx()) {

      st->print(INTX_FORMAT, get_intx());

    } else if (is_uintx()) {

      st->print(UINTX_FORMAT, get_uintx());

    } else if (is_uint64_t()) {

      st->print(UINT64_FORMAT, get_uint64_t());

    } else if (is_size_t()) {

      st->print(SIZE_FORMAT, get_size_t());

    } else if (is_double()) {

      st->print("%f", get_double());

    } else if (is_ccstr()) {

      // Honor <newline> characters in ccstr: print multiple lines.

      const char* cp = get_ccstr();

      if (cp != NULL) {

        const char* eol;

        while ((eol = strchr(cp, '\n')) != NULL) {

          size_t llen = pointer_delta(eol, cp, sizeof(char));

          st->print("%.*s", (int)llen, cp);

          st->cr();

          cp = eol+1;

          fill_to_pos(st, col2_pos);

          st->print("%s", _name);

          fill_to_pos(st, col3_pos);

          st->print("+=");

          fill_to_pos(st, col4_pos);

        }

        st->print("%s", cp);

      }

    } else {

      st->print("unhandled  type %s", _type);

      st->cr();

      return;

    }

    fill_to_pos(st, col5_pos);

    print_kind(st, col5_width);