/*

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

 * Copyright (c) 2012, 2018, SAP SE. 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 "asm/assembler.inline.hpp"

#include "asm/macroAssembler.inline.hpp"

#include "compiler/disassembler.hpp"

#include "memory/resourceArea.hpp"

#include "runtime/java.hpp"

#include "runtime/os.hpp"

#include "runtime/stubCodeGenerator.hpp"

#include "utilities/align.hpp"

#include "utilities/defaultStream.hpp"

#include "utilities/globalDefinitions.hpp"

#include "vm_version_ppc.hpp"

#include <sys/sysinfo.h>

#if defined(LINUX) && defined(VM_LITTLE_ENDIAN)

#include <sys/auxv.h>

#ifndef PPC_FEATURE2_HTM_NOSC

#define PPC_FEATURE2_HTM_NOSC (1 << 24)

#endif

#endif

bool VM_Version::_is_determine_features_test_running = false;

uint64_t VM_Version::_dscr_val = 0;

#define MSG(flag)   \

  if (flag && !FLAG_IS_DEFAULT(flag))                                  \

      jio_fprintf(defaultStream::error_stream(),                       \

                  "warning: -XX:+" #flag " requires -XX:+UseSIGTRAP\n" \

                  "         -XX:+" #flag " will be disabled!\n");

void VM_Version::initialize() {

  // Test which instructions are supported and measure cache line size.

  determine_features();

  // If PowerArchitecturePPC64 hasn't been specified explicitly determine from features.

  if (FLAG_IS_DEFAULT(PowerArchitecturePPC64)) {

    if (VM_Version::has_darn()) {

      FLAG_SET_ERGO(uintx, PowerArchitecturePPC64, 9);

    } else if (VM_Version::has_lqarx()) {

      FLAG_SET_ERGO(uintx, PowerArchitecturePPC64, 8);

    } else if (VM_Version::has_popcntw()) {

      FLAG_SET_ERGO(uintx, PowerArchitecturePPC64, 7);

    } else if (VM_Version::has_cmpb()) {

      FLAG_SET_ERGO(uintx, PowerArchitecturePPC64, 6);

    } else if (VM_Version::has_popcntb()) {

      FLAG_SET_ERGO(uintx, PowerArchitecturePPC64, 5);

    } else {

      FLAG_SET_ERGO(uintx, PowerArchitecturePPC64, 0);

    }

  }

  bool PowerArchitecturePPC64_ok = false;

  switch (PowerArchitecturePPC64) {

    case 9: if (!VM_Version::has_darn()   ) break;

    case 8: if (!VM_Version::has_lqarx()  ) break;

    case 7: if (!VM_Version::has_popcntw()) break;

    case 6: if (!VM_Version::has_cmpb()   ) break;

    case 5: if (!VM_Version::has_popcntb()) break;

    case 0: PowerArchitecturePPC64_ok = true; break;

    default: break;

  }

  guarantee(PowerArchitecturePPC64_ok, "PowerArchitecturePPC64 cannot be set to "

            UINTX_FORMAT " on this machine", PowerArchitecturePPC64);

  // Power 8: Configure Data Stream Control Register.

  if (PowerArchitecturePPC64 >= 8 && has_mfdscr()) {

    config_dscr();

  }

  if (!UseSIGTRAP) {

    MSG(TrapBasedICMissChecks);

    MSG(TrapBasedNotEntrantChecks);

    MSG(TrapBasedNullChecks);

    FLAG_SET_ERGO(bool, TrapBasedNotEntrantChecks, false);

    FLAG_SET_ERGO(bool, TrapBasedNullChecks,       false);

    FLAG_SET_ERGO(bool, TrapBasedICMissChecks,     false);

  }

#ifdef COMPILER2

  if (!UseSIGTRAP) {

    MSG(TrapBasedRangeChecks);

    FLAG_SET_ERGO(bool, TrapBasedRangeChecks, false);

  }

  // On Power6 test for section size.

  if (PowerArchitecturePPC64 == 6) {

    determine_section_size();

  // TODO: PPC port } else {

  // TODO: PPC port PdScheduling::power6SectorSize = 0x20;

  }

  if (PowerArchitecturePPC64 >= 8) {

    if (FLAG_IS_DEFAULT(SuperwordUseVSX)) {

      FLAG_SET_ERGO(bool, SuperwordUseVSX, true);

    }

  } else {

    if (SuperwordUseVSX) {

      warning("SuperwordUseVSX specified, but needs at least Power8.");

      FLAG_SET_DEFAULT(SuperwordUseVSX, false);

    }

  }

  MaxVectorSize = SuperwordUseVSX ? 16 : 8;

  if (PowerArchitecturePPC64 >= 9) {

    if (FLAG_IS_DEFAULT(UseCountTrailingZerosInstructionsPPC64)) {

      FLAG_SET_ERGO(bool, UseCountTrailingZerosInstructionsPPC64, true);

    }

    if (FLAG_IS_DEFAULT(UseCharacterCompareIntrinsics)) {

      FLAG_SET_ERGO(bool, UseCharacterCompareIntrinsics, true);

    }

  } else {

    if (UseCountTrailingZerosInstructionsPPC64) {

      warning("UseCountTrailingZerosInstructionsPPC64 specified, but needs at least Power9.");

      FLAG_SET_DEFAULT(UseCountTrailingZerosInstructionsPPC64, false);

    }

    if (UseCharacterCompareIntrinsics) {

      warning("UseCharacterCompareIntrinsics specified, but needs at least Power9.");

      FLAG_SET_DEFAULT(UseCharacterCompareIntrinsics, false);

    }

  }

#endif

  // Create and print feature-string.

  char buf[(num_features+1) * 16]; // Max 16 chars per feature.

  jio_snprintf(buf, sizeof(buf),

               "ppc64%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s",

               (has_fsqrt()   ? " fsqrt"   : ""),

               (has_isel()    ? " isel"    : ""),

               (has_lxarxeh() ? " lxarxeh" : ""),

               (has_cmpb()    ? " cmpb"    : ""),

               (has_popcntb() ? " popcntb" : ""),

               (has_popcntw() ? " popcntw" : ""),

               (has_fcfids()  ? " fcfids"  : ""),

               (has_vand()    ? " vand"    : ""),

               (has_lqarx()   ? " lqarx"   : ""),

               (has_vcipher() ? " aes"     : ""),

               (has_vpmsumb() ? " vpmsumb" : ""),

               (has_mfdscr()  ? " mfdscr"  : ""),

               (has_vsx()     ? " vsx"     : ""),

               (has_ldbrx()   ? " ldbrx"   : ""),

               (has_stdbrx()  ? " stdbrx"  : ""),

               (has_vshasig() ? " sha"     : ""),

               (has_tm()      ? " rtm"     : ""),

               (has_darn()    ? " darn"    : "")

               // Make sure number of %s matches num_features!

              );

  _features_string = os::strdup(buf);

  if (Verbose) {

    print_features();

  }

  // PPC64 supports 8-byte compare-exchange operations (see Atomic::cmpxchg)

  // and 'atomic long memory ops' (see Unsafe_GetLongVolatile).

  _supports_cx8 = true;

  // Used by C1.

  _supports_atomic_getset4 = true;

  _supports_atomic_getadd4 = true;

  _supports_atomic_getset8 = true;

  _supports_atomic_getadd8 = true;

  UseSSE = 0; // Only on x86 and x64

  intx cache_line_size = L1_data_cache_line_size();

  if (FLAG_IS_DEFAULT(AllocatePrefetchStyle)) AllocatePrefetchStyle = 1;

  if (AllocatePrefetchStyle == 4) {

    AllocatePrefetchStepSize = cache_line_size; // Need exact value.

    if (FLAG_IS_DEFAULT(AllocatePrefetchLines)) AllocatePrefetchLines = 12; // Use larger blocks by default.

    if (AllocatePrefetchDistance < 0) AllocatePrefetchDistance = 2*cache_line_size; // Default is not defined?

  } else {

    if (cache_line_size > AllocatePrefetchStepSize) AllocatePrefetchStepSize = cache_line_size;

    if (FLAG_IS_DEFAULT(AllocatePrefetchLines)) AllocatePrefetchLines = 3; // Optimistic value.

    if (AllocatePrefetchDistance < 0) AllocatePrefetchDistance = 3*cache_line_size; // Default is not defined?

  }

  assert(AllocatePrefetchLines > 0, "invalid value");

  if (AllocatePrefetchLines < 1) { // Set valid value in product VM.

    AllocatePrefetchLines = 1; // Conservative value.

  }

  if (AllocatePrefetchStyle == 3 && AllocatePrefetchDistance < cache_line_size) {

    AllocatePrefetchStyle = 1; // Fall back if inappropriate.

  }

  assert(AllocatePrefetchStyle >= 0, "AllocatePrefetchStyle should be positive");

  // If running on Power8 or newer hardware, the implementation uses the available vector instructions.

  // In all other cases, the implementation uses only generally available instructions.

  if (!UseCRC32Intrinsics) {

    if (FLAG_IS_DEFAULT(UseCRC32Intrinsics)) {

      FLAG_SET_DEFAULT(UseCRC32Intrinsics, true);

    }

  }

  // Implementation does not use any of the vector instructions available with Power8.

  // Their exploitation is still pending (aka "work in progress").

  if (!UseCRC32CIntrinsics) {

    if (FLAG_IS_DEFAULT(UseCRC32CIntrinsics)) {

      FLAG_SET_DEFAULT(UseCRC32CIntrinsics, true);

    }

  }

  // TODO: Provide implementation.

  if (UseAdler32Intrinsics) {

    warning("Adler32Intrinsics not available on this CPU.");

    FLAG_SET_DEFAULT(UseAdler32Intrinsics, false);

  }

  // The AES intrinsic stubs require AES instruction support.

  if (has_vcipher()) {

    if (FLAG_IS_DEFAULT(UseAES)) {

      UseAES = true;

    }

  } else if (UseAES) {

    if (!FLAG_IS_DEFAULT(UseAES))

      warning("AES instructions are not available on this CPU");

    FLAG_SET_DEFAULT(UseAES, false);

  }

  if (UseAES && has_vcipher()) {

    if (FLAG_IS_DEFAULT(UseAESIntrinsics)) {

      UseAESIntrinsics = true;

    }

  } else if (UseAESIntrinsics) {

    if (!FLAG_IS_DEFAULT(UseAESIntrinsics))

      warning("AES intrinsics are not available on this CPU");

    FLAG_SET_DEFAULT(UseAESIntrinsics, false);

  }

  if (UseAESCTRIntrinsics) {

    warning("AES/CTR intrinsics are not available on this CPU");

    FLAG_SET_DEFAULT(UseAESCTRIntrinsics, false);

  }

  if (UseGHASHIntrinsics) {

    warning("GHASH intrinsics are not available on this CPU");

    FLAG_SET_DEFAULT(UseGHASHIntrinsics, false);

  }

  if (FLAG_IS_DEFAULT(UseFMA)) {

    FLAG_SET_DEFAULT(UseFMA, true);

  }

  if (has_vshasig()) {

    if (FLAG_IS_DEFAULT(UseSHA)) {

      UseSHA = true;

    }

  } else if (UseSHA) {

    if (!FLAG_IS_DEFAULT(UseSHA))

      warning("SHA instructions are not available on this CPU");

    FLAG_SET_DEFAULT(UseSHA, false);

  }

  if (UseSHA1Intrinsics) {

    warning("Intrinsics for SHA-1 crypto hash functions not available on this CPU.");

    FLAG_SET_DEFAULT(UseSHA1Intrinsics, false);

  }

  if (UseSHA && has_vshasig()) {

    if (FLAG_IS_DEFAULT(UseSHA256Intrinsics)) {

      FLAG_SET_DEFAULT(UseSHA256Intrinsics, true);

    }

  } else if (UseSHA256Intrinsics) {

    warning("Intrinsics for SHA-224 and SHA-256 crypto hash functions not available on this CPU.");

    FLAG_SET_DEFAULT(UseSHA256Intrinsics, false);

  }

  if (UseSHA && has_vshasig()) {

    if (FLAG_IS_DEFAULT(UseSHA512Intrinsics)) {

      FLAG_SET_DEFAULT(UseSHA512Intrinsics, true);

    }

  } else if (UseSHA512Intrinsics) {

    warning("Intrinsics for SHA-384 and SHA-512 crypto hash functions not available on this CPU.");

    FLAG_SET_DEFAULT(UseSHA512Intrinsics, false);

  }

  if (!(UseSHA1Intrinsics || UseSHA256Intrinsics || UseSHA512Intrinsics)) {

    FLAG_SET_DEFAULT(UseSHA, false);

  }

  if (FLAG_IS_DEFAULT(UseSquareToLenIntrinsic)) {

    UseSquareToLenIntrinsic = true;

  }

  if (FLAG_IS_DEFAULT(UseMulAddIntrinsic)) {

    UseMulAddIntrinsic = true;

  }

  if (FLAG_IS_DEFAULT(UseMultiplyToLenIntrinsic)) {

    UseMultiplyToLenIntrinsic = true;

  }

  if (FLAG_IS_DEFAULT(UseMontgomeryMultiplyIntrinsic)) {

    UseMontgomeryMultiplyIntrinsic = true;

  }

  if (FLAG_IS_DEFAULT(UseMontgomerySquareIntrinsic)) {

    UseMontgomerySquareIntrinsic = true;

  }

  if (UseVectorizedMismatchIntrinsic) {

    warning("UseVectorizedMismatchIntrinsic specified, but not available on this CPU.");

    FLAG_SET_DEFAULT(UseVectorizedMismatchIntrinsic, false);

  }

  // Adjust RTM (Restricted Transactional Memory) flags.

  if (UseRTMLocking) {

    // If CPU or OS do not support TM:

    // Can't continue because UseRTMLocking affects UseBiasedLocking flag

    // setting during arguments processing. See use_biased_locking().

    // VM_Version_init() is executed after UseBiasedLocking is used

    // in Thread::allocate().

    if (PowerArchitecturePPC64 < 8) {

      vm_exit_during_initialization("RTM instructions are not available on this CPU.");

    }

    if (!has_tm()) {

      vm_exit_during_initialization("RTM is not supported on this OS version.");

    }

  }

  if (UseRTMLocking) {

#if INCLUDE_RTM_OPT

    if (!FLAG_IS_CMDLINE(UseRTMLocking)) {

      // RTM locking should be used only for applications with

      // high lock contention. For now we do not use it by default.

      vm_exit_during_initialization("UseRTMLocking flag should be only set on command line");

    }

#else

    // Only C2 does RTM locking optimization.

    // Can't continue because UseRTMLocking affects UseBiasedLocking flag

    // setting during arguments processing. See use_biased_locking().

    vm_exit_during_initialization("RTM locking optimization is not supported in this VM");

#endif

  } else { // !UseRTMLocking

    if (UseRTMForStackLocks) {

      if (!FLAG_IS_DEFAULT(UseRTMForStackLocks)) {

        warning("UseRTMForStackLocks flag should be off when UseRTMLocking flag is off");

      }

      FLAG_SET_DEFAULT(UseRTMForStackLocks, false);

    }

    if (UseRTMDeopt) {

      FLAG_SET_DEFAULT(UseRTMDeopt, false);

    }

    if (PrintPreciseRTMLockingStatistics) {

      FLAG_SET_DEFAULT(PrintPreciseRTMLockingStatistics, false);

    }

  }

  // This machine allows unaligned memory accesses

  if (FLAG_IS_DEFAULT(UseUnalignedAccesses)) {

    FLAG_SET_DEFAULT(UseUnalignedAccesses, true);

  }

}

void VM_Version::print_platform_virtualization_info(outputStream* st) {

  const char* info_file = "/proc/ppc64/lparcfg";

  const char* kw[] = { "system_type=", // qemu indicates PowerKVM

                       "partition_entitled_capacity=", // entitled processor capacity percentage

                       "partition_max_entitled_capacity=",

                       "capacity_weight=", // partition CPU weight

                       "partition_active_processors=",

                       "partition_potential_processors=",

                       "entitled_proc_capacity_available=",

                       "capped=", // 0 - uncapped, 1 - vcpus capped at entitled processor capacity percentage

                       "shared_processor_mode=", // (non)dedicated partition

                       "system_potential_processors=",

                       "pool=", // CPU-pool number

                       "pool_capacity=",

                       "NumLpars=", // on non-KVM machines, NumLpars is not found for full partition mode machines

                       NULL };

  if (!print_matching_lines_from_file(info_file, st, kw)) {

    st->print_cr("  <%s Not Available>", info_file);

  }

}

bool VM_Version::use_biased_locking() {

#if INCLUDE_RTM_OPT

  // RTM locking is most useful when there is high lock contention and

  // low data contention. With high lock contention the lock is usually

  // inflated and biased locking is not suitable for that case.

  // RTM locking code requires that biased locking is off.

  // Note: we can't switch off UseBiasedLocking in get_processor_features()

  // because it is used by Thread::allocate() which is called before

  // VM_Version::initialize().

  if (UseRTMLocking && UseBiasedLocking) {

    if (FLAG_IS_DEFAULT(UseBiasedLocking)) {

      FLAG_SET_DEFAULT(UseBiasedLocking, false);

    } else {

      warning("Biased locking is not supported with RTM locking; ignoring UseBiasedLocking flag." );

      UseBiasedLocking = false;

    }

  }

#endif

  return UseBiasedLocking;

}

void VM_Version::print_features() {

  tty->print_cr("Version: %s L1_data_cache_line_size=%d", features_string(), L1_data_cache_line_size());

}

#ifdef COMPILER2

// Determine section size on power6: If section size is 8 instructions,

// there should be a difference between the two testloops of ~15 %. If

// no difference is detected the section is assumed to be 32 instructions.

void VM_Version::determine_section_size() {

  int unroll = 80;

  const int code_size = (2* unroll * 32 + 100)*BytesPerInstWord;