/*

 * Copyright (c) 1997, 2014, 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 CPU_X86_VM_VM_VERSION_X86_HPP

#define CPU_X86_VM_VM_VERSION_X86_HPP

#include "runtime/globals_extension.hpp"

#include "runtime/vm_version.hpp"

class VM_Version : public Abstract_VM_Version {

public:

  // cpuid result register layouts.  These are all unions of a uint32_t

  // (in case anyone wants access to the register as a whole) and a bitfield.

  union StdCpuid1Eax {

    uint32_t value;

    struct {

      uint32_t stepping   : 4,

               model      : 4,

               family     : 4,

               proc_type  : 2,

                          : 2,

               ext_model  : 4,

               ext_family : 8,

                          : 4;

    } bits;

  };

  union StdCpuid1Ebx { // example, unused

    uint32_t value;

    struct {

      uint32_t brand_id         : 8,

               clflush_size     : 8,

               threads_per_cpu  : 8,

               apic_id          : 8;

    } bits;

  };

  union StdCpuid1Ecx {

    uint32_t value;

    struct {

      uint32_t sse3     : 1,

               clmul    : 1,

                        : 1,

               monitor  : 1,

                        : 1,

               vmx      : 1,

                        : 1,

               est      : 1,

                        : 1,

               ssse3    : 1,

               cid      : 1,

                        : 2,

               cmpxchg16: 1,

                        : 4,

               dca      : 1,

               sse4_1   : 1,

               sse4_2   : 1,

                        : 2,

               popcnt   : 1,

                        : 1,

               aes      : 1,

                        : 1,

               osxsave  : 1,

               avx      : 1,

                        : 3;

    } bits;

  };

  union StdCpuid1Edx {

    uint32_t value;

    struct {

      uint32_t          : 4,

               tsc      : 1,

                        : 3,

               cmpxchg8 : 1,

                        : 6,

               cmov     : 1,

                        : 3,

               clflush  : 1,

                        : 3,

               mmx      : 1,

               fxsr     : 1,

               sse      : 1,

               sse2     : 1,

                        : 1,

               ht       : 1,

                        : 3;

    } bits;

  };

  union DcpCpuid4Eax {

    uint32_t value;

    struct {

      uint32_t cache_type    : 5,

                             : 21,

               cores_per_cpu : 6;

    } bits;

  };

  union DcpCpuid4Ebx {

    uint32_t value;

    struct {

      uint32_t L1_line_size  : 12,

               partitions    : 10,

               associativity : 10;

    } bits;

  };

  union TplCpuidBEbx {

    uint32_t value;

    struct {

      uint32_t logical_cpus : 16,

                            : 16;

    } bits;

  };

  union ExtCpuid1Ecx {

    uint32_t value;

    struct {

      uint32_t LahfSahf     : 1,

               CmpLegacy    : 1,

                            : 3,

               lzcnt_intel  : 1,

               lzcnt        : 1,

               sse4a        : 1,

               misalignsse  : 1,

               prefetchw    : 1,

                            : 22;

    } bits;

  };

  union ExtCpuid1Edx {

    uint32_t value;

    struct {

      uint32_t           : 22,

               mmx_amd   : 1,

               mmx       : 1,

               fxsr      : 1,

                         : 4,

               long_mode : 1,

               tdnow2    : 1,

               tdnow     : 1;

    } bits;

  };

  union ExtCpuid5Ex {

    uint32_t value;

    struct {

      uint32_t L1_line_size : 8,

               L1_tag_lines : 8,

               L1_assoc     : 8,

               L1_size      : 8;

    } bits;

  };

  union ExtCpuid7Edx {

    uint32_t value;

    struct {

      uint32_t               : 8,

              tsc_invariance : 1,

                             : 23;

    } bits;

  };

  union ExtCpuid8Ecx {

    uint32_t value;

    struct {

      uint32_t cores_per_cpu : 8,

                             : 24;

    } bits;

  };

  union SefCpuid7Eax {

    uint32_t value;

  };

  union SefCpuid7Ebx {

    uint32_t value;

    struct {

      uint32_t fsgsbase : 1,

                        : 2,

                   bmi1 : 1,

                        : 1,

                   avx2 : 1,

                        : 2,

                   bmi2 : 1,

                   erms : 1,

                        : 1,

                   rtm  : 1,

    } bits;

  };

  union XemXcr0Eax {

    uint32_t value;

    struct {

      uint32_t x87 : 1,

               sse : 1,

               ymm : 1,

                   : 29;

    } bits;

  };

protected:

  static int _cpu;

  static int _model;

  static int _stepping;

  static int _cpuFeatures;     // features returned by the "cpuid" instruction

                               // 0 if this instruction is not available

  static const char* _features_str;

  static address   _cpuinfo_segv_addr; // address of instruction which causes SEGV

  static address   _cpuinfo_cont_addr; // address of instruction after the one which causes SEGV

  enum {

    CPU_CX8    = (1 << 0), // next bits are from cpuid 1 (EDX)

    CPU_CMOV   = (1 << 1),

    CPU_FXSR   = (1 << 2),

    CPU_HT     = (1 << 3),

    CPU_MMX    = (1 << 4),

    CPU_3DNOW_PREFETCH  = (1 << 5), // Processor supports 3dnow prefetch and prefetchw instructions

                                    // may not necessarily support other 3dnow instructions

    CPU_SSE    = (1 << 6),

    CPU_SSE2   = (1 << 7),

    CPU_SSE3   = (1 << 8), // SSE3 comes from cpuid 1 (ECX)

    CPU_SSSE3  = (1 << 9),

    CPU_SSE4A  = (1 << 10),

    CPU_SSE4_1 = (1 << 11),

    CPU_SSE4_2 = (1 << 12),

    CPU_POPCNT = (1 << 13),

    CPU_LZCNT  = (1 << 14),

    CPU_TSC    = (1 << 15),

    CPU_TSCINV = (1 << 16),

    CPU_AVX    = (1 << 17),

    CPU_AVX2   = (1 << 18),

    CPU_AES    = (1 << 19),

    CPU_ERMS   = (1 << 20), // enhanced 'rep movsb/stosb' instructions

    CPU_CLMUL  = (1 << 21), // carryless multiply for CRC

    CPU_BMI1   = (1 << 22),

    CPU_BMI2   = (1 << 23),

  } cpuFeatureFlags;

  enum {

    // AMD

    CPU_FAMILY_AMD_11H       = 0x11,

    // Intel

    CPU_FAMILY_INTEL_CORE    = 6,

    CPU_MODEL_NEHALEM        = 0x1e,

    CPU_MODEL_NEHALEM_EP     = 0x1a,

    CPU_MODEL_NEHALEM_EX     = 0x2e,

    CPU_MODEL_WESTMERE       = 0x25,

    CPU_MODEL_WESTMERE_EP    = 0x2c,

    CPU_MODEL_WESTMERE_EX    = 0x2f,

    CPU_MODEL_SANDYBRIDGE    = 0x2a,

    CPU_MODEL_SANDYBRIDGE_EP = 0x2d,

    CPU_MODEL_IVYBRIDGE_EP   = 0x3a,

    CPU_MODEL_HASWELL_E3     = 0x3c,

    CPU_MODEL_HASWELL_E7     = 0x3f,

    CPU_MODEL_BROADWELL      = 0x3d

  } cpuExtendedFamily;

  // cpuid information block.  All info derived from executing cpuid with

  // various function numbers is stored here.  Intel and AMD info is

  // merged in this block: accessor methods disentangle it.

  //

  // The info block is laid out in subblocks of 4 dwords corresponding to

  // eax, ebx, ecx and edx, whether or not they contain anything useful.

  struct CpuidInfo {

    // cpuid function 0

    uint32_t std_max_function;

    uint32_t std_vendor_name_0;

    uint32_t std_vendor_name_1;

    uint32_t std_vendor_name_2;

    // cpuid function 1

    StdCpuid1Eax std_cpuid1_eax;

    StdCpuid1Ebx std_cpuid1_ebx;

    StdCpuid1Ecx std_cpuid1_ecx;

    StdCpuid1Edx std_cpuid1_edx;

    // cpuid function 4 (deterministic cache parameters)

    DcpCpuid4Eax dcp_cpuid4_eax;

    DcpCpuid4Ebx dcp_cpuid4_ebx;

    uint32_t     dcp_cpuid4_ecx; // unused currently

    uint32_t     dcp_cpuid4_edx; // unused currently

    // cpuid function 7 (structured extended features)

    SefCpuid7Eax sef_cpuid7_eax;

    SefCpuid7Ebx sef_cpuid7_ebx;

    uint32_t     sef_cpuid7_ecx; // unused currently

    uint32_t     sef_cpuid7_edx; // unused currently

    // cpuid function 0xB (processor topology)

    // ecx = 0

    uint32_t     tpl_cpuidB0_eax;

    TplCpuidBEbx tpl_cpuidB0_ebx;

    uint32_t     tpl_cpuidB0_ecx; // unused currently

    uint32_t     tpl_cpuidB0_edx; // unused currently

    // ecx = 1

    uint32_t     tpl_cpuidB1_eax;

    TplCpuidBEbx tpl_cpuidB1_ebx;

    uint32_t     tpl_cpuidB1_ecx; // unused currently

    uint32_t     tpl_cpuidB1_edx; // unused currently

    // ecx = 2

    uint32_t     tpl_cpuidB2_eax;

    TplCpuidBEbx tpl_cpuidB2_ebx;

    uint32_t     tpl_cpuidB2_ecx; // unused currently

    uint32_t     tpl_cpuidB2_edx; // unused currently

    // cpuid function 0x80000000 // example, unused

    uint32_t ext_max_function;

    uint32_t ext_vendor_name_0;

    uint32_t ext_vendor_name_1;

    uint32_t ext_vendor_name_2;

    // cpuid function 0x80000001

    uint32_t     ext_cpuid1_eax; // reserved

    uint32_t     ext_cpuid1_ebx; // reserved

    ExtCpuid1Ecx ext_cpuid1_ecx;

    ExtCpuid1Edx ext_cpuid1_edx;

    // cpuid functions 0x80000002 thru 0x80000004: example, unused

    uint32_t proc_name_0, proc_name_1, proc_name_2, proc_name_3;

    uint32_t proc_name_4, proc_name_5, proc_name_6, proc_name_7;

    uint32_t proc_name_8, proc_name_9, proc_name_10,proc_name_11;

    // cpuid function 0x80000005 // AMD L1, Intel reserved

    uint32_t     ext_cpuid5_eax; // unused currently

    uint32_t     ext_cpuid5_ebx; // reserved

    ExtCpuid5Ex  ext_cpuid5_ecx; // L1 data cache info (AMD)

    ExtCpuid5Ex  ext_cpuid5_edx; // L1 instruction cache info (AMD)

    // cpuid function 0x80000007

    uint32_t     ext_cpuid7_eax; // reserved

    uint32_t     ext_cpuid7_ebx; // reserved

    uint32_t     ext_cpuid7_ecx; // reserved

    ExtCpuid7Edx ext_cpuid7_edx; // tscinv

    // cpuid function 0x80000008

    uint32_t     ext_cpuid8_eax; // unused currently

    uint32_t     ext_cpuid8_ebx; // reserved

    ExtCpuid8Ecx ext_cpuid8_ecx;

    uint32_t     ext_cpuid8_edx; // reserved

    // extended control register XCR0 (the XFEATURE_ENABLED_MASK register)

    XemXcr0Eax   xem_xcr0_eax;

    uint32_t     xem_xcr0_edx; // reserved

    // Space to save ymm registers after signal handle

    int          ymm_save[8*4]; // Save ymm0, ymm7, ymm8, ymm15

  };

  // The actual cpuid info block

  static CpuidInfo _cpuid_info;

  // Extractors and predicates

  static uint32_t extended_cpu_family() {

    uint32_t result = _cpuid_info.std_cpuid1_eax.bits.family;

    result += _cpuid_info.std_cpuid1_eax.bits.ext_family;

    return result;

  }

  static uint32_t extended_cpu_model() {

    uint32_t result = _cpuid_info.std_cpuid1_eax.bits.model;

    result |= _cpuid_info.std_cpuid1_eax.bits.ext_model << 4;

    return result;

  }

  static uint32_t cpu_stepping() {

    uint32_t result = _cpuid_info.std_cpuid1_eax.bits.stepping;

    return result;

  }

  static uint logical_processor_count() {

    uint result = threads_per_core();

    return result;

  }

  static uint32_t feature_flags() {

    uint32_t result = 0;

    if (_cpuid_info.std_cpuid1_edx.bits.cmpxchg8 != 0)

      result |= CPU_CX8;

    if (_cpuid_info.std_cpuid1_edx.bits.cmov != 0)

      result |= CPU_CMOV;

    if (_cpuid_info.std_cpuid1_edx.bits.fxsr != 0 || (is_amd() &&

        _cpuid_info.ext_cpuid1_edx.bits.fxsr != 0))

      result |= CPU_FXSR;

    // HT flag is set for multi-core processors also.

    if (threads_per_core() > 1)

      result |= CPU_HT;

    if (_cpuid_info.std_cpuid1_edx.bits.mmx != 0 || (is_amd() &&

        _cpuid_info.ext_cpuid1_edx.bits.mmx != 0))

      result |= CPU_MMX;

    if (_cpuid_info.std_cpuid1_edx.bits.sse != 0)

      result |= CPU_SSE;

    if (_cpuid_info.std_cpuid1_edx.bits.sse2 != 0)

      result |= CPU_SSE2;

    if (_cpuid_info.std_cpuid1_ecx.bits.sse3 != 0)

      result |= CPU_SSE3;

    if (_cpuid_info.std_cpuid1_ecx.bits.ssse3 != 0)

      result |= CPU_SSSE3;

    if (_cpuid_info.std_cpuid1_ecx.bits.sse4_1 != 0)

      result |= CPU_SSE4_1;

    if (_cpuid_info.std_cpuid1_ecx.bits.sse4_2 != 0)

      result |= CPU_SSE4_2;

    if (_cpuid_info.std_cpuid1_ecx.bits.popcnt != 0)

      result |= CPU_POPCNT;

    if (_cpuid_info.std_cpuid1_ecx.bits.avx != 0 &&

        _cpuid_info.std_cpuid1_ecx.bits.osxsave != 0 &&

        _cpuid_info.xem_xcr0_eax.bits.sse != 0 &&

        _cpuid_info.xem_xcr0_eax.bits.ymm != 0) {

      result |= CPU_AVX;

      if (_cpuid_info.sef_cpuid7_ebx.bits.avx2 != 0)

        result |= CPU_AVX2;

    }

    if(_cpuid_info.sef_cpuid7_ebx.bits.bmi1 != 0)

      result |= CPU_BMI1;

    if (_cpuid_info.std_cpuid1_edx.bits.tsc != 0)

      result |= CPU_TSC;

    if (_cpuid_info.ext_cpuid7_edx.bits.tsc_invariance != 0)

      result |= CPU_TSCINV;

    if (_cpuid_info.std_cpuid1_ecx.bits.aes != 0)

      result |= CPU_AES;

    if (_cpuid_info.sef_cpuid7_ebx.bits.erms != 0)

      result |= CPU_ERMS;

    if (_cpuid_info.std_cpuid1_ecx.bits.clmul != 0)

      result |= CPU_CLMUL;

    if (_cpuid_info.sef_cpuid7_ebx.bits.rtm != 0)

      result |= CPU_RTM;

    // AMD features.

    if (is_amd()) {

      if ((_cpuid_info.ext_cpuid1_edx.bits.tdnow != 0) ||

          (_cpuid_info.ext_cpuid1_ecx.bits.prefetchw != 0))

        result |= CPU_3DNOW_PREFETCH;

      if (_cpuid_info.ext_cpuid1_ecx.bits.lzcnt != 0)

        result |= CPU_LZCNT;

      if (_cpuid_info.ext_cpuid1_ecx.bits.sse4a != 0)

        result |= CPU_SSE4A;

    }

    // Intel features.

    if(is_intel()) {

      if(_cpuid_info.sef_cpuid7_ebx.bits.bmi2 != 0)

        result |= CPU_BMI2;

      if(_cpuid_info.ext_cpuid1_ecx.bits.lzcnt_intel != 0)

        result |= CPU_LZCNT;

    }

    return result;

  }

  static bool os_supports_avx_vectors() {

    if (!supports_avx()) {

      return false;

    }

    // Verify that OS save/restore all bits of AVX registers

    // during signal processing.

    int nreg = 2 LP64_ONLY(+2);

    for (int i = 0; i < 8 * nreg; i++) { // 32 bytes per ymm register

      if (_cpuid_info.ymm_save[i] != ymm_test_value()) {

        return false;

      }

    }

    return true;

  }

  static void get_processor_features();

public:

  // Offsets for cpuid asm stub

  static ByteSize std_cpuid0_offset() { return byte_offset_of(CpuidInfo, std_max_function); }

  static ByteSize std_cpuid1_offset() { return byte_offset_of(CpuidInfo, std_cpuid1_eax); }