1 /*
   2  * Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef CPU_X86_STUBROUTINES_X86_HPP
  26 #define CPU_X86_STUBROUTINES_X86_HPP
  27 
  28 // This file holds the platform specific parts of the StubRoutines
  29 // definition. See stubRoutines.hpp for a description on how to
  30 // extend it.
  31 
  32 static bool returns_to_call_stub(address return_pc) { return return_pc == _call_stub_return_address; }
  33 
  34 enum platform_dependent_constants {
  35   code_size1 = 20000 LP64_ONLY(+10000),         // simply increase if too small (assembler will crash if too small)
  36   code_size2 = 35300 LP64_ONLY(+11400)          // simply increase if too small (assembler will crash if too small)
  37 };
  38 
  39 class x86 {
  40  friend class StubGenerator;
  41  friend class VMStructs;
  42 
  43 #ifdef _LP64
  44  private:
  45   static address _get_previous_fp_entry;
  46   static address _get_previous_sp_entry;
  47 
  48   static address _f2i_fixup;
  49   static address _f2l_fixup;
  50   static address _d2i_fixup;
  51   static address _d2l_fixup;
  52 
  53   static address _float_sign_mask;
  54   static address _float_sign_flip;
  55   static address _double_sign_mask;
  56   static address _double_sign_flip;
  57 
  58  public:
  59 
  60   static address get_previous_fp_entry() {
  61     return _get_previous_fp_entry;
  62   }
  63 
  64   static address get_previous_sp_entry() {
  65     return _get_previous_sp_entry;
  66   }
  67 
  68   static address f2i_fixup() {
  69     return _f2i_fixup;
  70   }
  71 
  72   static address f2l_fixup() {
  73     return _f2l_fixup;
  74   }
  75 
  76   static address d2i_fixup() {
  77     return _d2i_fixup;
  78   }
  79 
  80   static address d2l_fixup() {
  81     return _d2l_fixup;
  82   }
  83 
  84   static address float_sign_mask() {
  85     return _float_sign_mask;
  86   }
  87 
  88   static address float_sign_flip() {
  89     return _float_sign_flip;
  90   }
  91 
  92   static address double_sign_mask() {
  93     return _double_sign_mask;
  94   }
  95 
  96   static address double_sign_flip() {
  97     return _double_sign_flip;
  98   }
  99 
 100 #else // !LP64
 101 
 102  private:
 103   static address _verify_fpu_cntrl_wrd_entry;
 104 
 105  public:
 106   static address verify_fpu_cntrl_wrd_entry() { return _verify_fpu_cntrl_wrd_entry; }
 107 
 108 #endif // !LP64
 109 
 110  private:
 111   static address _verify_mxcsr_entry;
 112   // shuffle mask for fixing up 128-bit words consisting of big-endian 32-bit integers
 113   static address _key_shuffle_mask_addr;
 114 
 115   //shuffle mask for big-endian 128-bit integers
 116   static address _counter_shuffle_mask_addr;
 117 
 118   static address _method_entry_barrier;
 119 
 120   // masks and table for CRC32
 121   static uint64_t _crc_by128_masks[];
 122   static juint    _crc_table[];
 123 #ifdef _LP64
 124   static juint    _crc_by128_masks_avx512[];
 125   static juint    _crc_table_avx512[];
 126   static juint    _shuf_table_crc32_avx512[];
 127 #endif // _LP64
 128   // table for CRC32C
 129   static juint* _crc32c_table;
 130   // swap mask for ghash
 131   static address _ghash_long_swap_mask_addr;
 132   static address _ghash_byte_swap_mask_addr;
 133   static address _ghash_poly_addr;
 134   static address _ghash_shuffmask_addr;
 135 
 136   // upper word mask for sha1
 137   static address _upper_word_mask_addr;
 138   // byte flip mask for sha1
 139   static address _shuffle_byte_flip_mask_addr;
 140 
 141   //k256 table for sha256
 142   static juint _k256[];
 143   static address _k256_adr;
 144   static address _vector_short_to_byte_mask;
 145   static address _vector_float_sign_mask;
 146   static address _vector_float_sign_flip;
 147   static address _vector_double_sign_mask;
 148   static address _vector_double_sign_flip;
 149   static address _vector_byte_perm_mask;
 150   static address _vector_long_sign_mask;
 151 #ifdef _LP64
 152   static juint _k256_W[];
 153   static address _k256_W_adr;
 154   static julong _k512_W[];
 155   static address _k512_W_addr;
 156   // byte flip mask for sha512
 157   static address _pshuffle_byte_flip_mask_addr_sha512;
 158   static address _counter_mask_addr;
 159   // Masks for base64
 160   static address _base64_charset;
 161   static address _bswap_mask;
 162   static address _gather_mask;
 163   static address _right_shift_mask;
 164   static address _left_shift_mask;
 165   static address _and_mask;
 166   static address _url_charset;
 167 #endif
 168   // byte flip mask for sha256
 169   static address _pshuffle_byte_flip_mask_addr;
 170 
 171   //tables common for LIBM sin and cos
 172   static juint _ONEHALF[];
 173   static address _ONEHALF_adr;
 174   static juint _P_2[];
 175   static address _P_2_adr;
 176   static juint _SC_4[];
 177   static address _SC_4_adr;
 178   static juint _Ctable[];
 179   static address _Ctable_adr;
 180   static juint _SC_2[];
 181   static address _SC_2_adr;
 182   static juint _SC_3[];
 183   static address _SC_3_adr;
 184   static juint _SC_1[];
 185   static address _SC_1_adr;
 186   static juint _PI_INV_TABLE[];
 187   static address _PI_INV_TABLE_adr;
 188   static juint _PI_4[];
 189   static address _PI_4_adr;
 190   static juint _PI32INV[];
 191   static address _PI32INV_adr;
 192   static juint _SIGN_MASK[];
 193   static address _SIGN_MASK_adr;
 194   static juint _P_1[];
 195   static address _P_1_adr;
 196   static juint _P_3[];
 197   static address _P_3_adr;
 198   static juint _NEG_ZERO[];
 199   static address _NEG_ZERO_adr;
 200 
 201   //tables common for LIBM sincos and tancot
 202   static juint _L_2il0floatpacket_0[];
 203   static address _L_2il0floatpacket_0_adr;
 204   static juint _Pi4Inv[];
 205   static address _Pi4Inv_adr;
 206   static juint _Pi4x3[];
 207   static address _Pi4x3_adr;
 208   static juint _Pi4x4[];
 209   static address _Pi4x4_adr;
 210   static juint _ones[];
 211   static address _ones_adr;
 212 
 213  public:
 214   static address verify_mxcsr_entry()    { return _verify_mxcsr_entry; }
 215   static address key_shuffle_mask_addr() { return _key_shuffle_mask_addr; }
 216   static address counter_shuffle_mask_addr() { return _counter_shuffle_mask_addr; }
 217   static address crc_by128_masks_addr()  { return (address)_crc_by128_masks; }
 218 #ifdef _LP64
 219   static address crc_by128_masks_avx512_addr()  { return (address)_crc_by128_masks_avx512; }
 220   static address shuf_table_crc32_avx512_addr()  { return (address)_shuf_table_crc32_avx512; }
 221   static address crc_table_avx512_addr()  { return (address)_crc_table_avx512; }
 222 #endif // _LP64
 223   static address ghash_long_swap_mask_addr() { return _ghash_long_swap_mask_addr; }
 224   static address ghash_byte_swap_mask_addr() { return _ghash_byte_swap_mask_addr; }
 225   static address ghash_shufflemask_addr() { return _ghash_shuffmask_addr; }
 226   static address ghash_polynomial_addr() { return _ghash_poly_addr; }
 227   static address upper_word_mask_addr() { return _upper_word_mask_addr; }
 228   static address shuffle_byte_flip_mask_addr() { return _shuffle_byte_flip_mask_addr; }
 229   static address k256_addr()      { return _k256_adr; }
 230   static address method_entry_barrier() { return _method_entry_barrier; }
 231 
 232   static address vector_short_to_byte_mask() {
 233     return _vector_short_to_byte_mask;
 234   }
 235   static address vector_float_sign_mask() {
 236     return _vector_float_sign_mask;
 237   }
 238 
 239   static address vector_float_sign_flip() {
 240     return _vector_float_sign_flip;
 241   }
 242 
 243   static address vector_double_sign_mask() {
 244     return _vector_double_sign_mask;
 245   }
 246 
 247   static address vector_double_sign_flip() {
 248     return _vector_double_sign_flip;
 249   }
 250 
 251   static address vector_byte_perm_mask() {
 252     return _vector_byte_perm_mask;
 253   }
 254 
 255   static address vector_long_sign_mask() {
 256     return _vector_long_sign_mask;
 257   }
 258 #ifdef _LP64
 259   static address k256_W_addr()    { return _k256_W_adr; }
 260   static address k512_W_addr()    { return _k512_W_addr; }
 261   static address pshuffle_byte_flip_mask_addr_sha512() { return _pshuffle_byte_flip_mask_addr_sha512; }
 262   static address base64_charset_addr() { return _base64_charset; }
 263   static address base64url_charset_addr() { return _url_charset; }
 264   static address base64_bswap_mask_addr() { return _bswap_mask; }
 265   static address base64_gather_mask_addr() { return _gather_mask; }
 266   static address base64_right_shift_mask_addr() { return _right_shift_mask; }
 267   static address base64_left_shift_mask_addr() { return _left_shift_mask; }
 268   static address base64_and_mask_addr() { return _and_mask; }
 269   static address counter_mask_addr() { return _counter_mask_addr; }
 270 #endif
 271   static address pshuffle_byte_flip_mask_addr() { return _pshuffle_byte_flip_mask_addr; }
 272   static void generate_CRC32C_table(bool is_pclmulqdq_supported);
 273   static address _ONEHALF_addr()      { return _ONEHALF_adr; }
 274   static address _P_2_addr()      { return _P_2_adr; }
 275   static address _SC_4_addr()      { return _SC_4_adr; }
 276   static address _Ctable_addr()      { return _Ctable_adr; }
 277   static address _SC_2_addr()      { return _SC_2_adr; }
 278   static address _SC_3_addr()      { return _SC_3_adr; }
 279   static address _SC_1_addr()      { return _SC_1_adr; }
 280   static address _PI_INV_TABLE_addr()      { return _PI_INV_TABLE_adr; }
 281   static address _PI_4_addr()      { return _PI_4_adr; }
 282   static address _PI32INV_addr()      { return _PI32INV_adr; }
 283   static address _SIGN_MASK_addr()      { return _SIGN_MASK_adr; }
 284   static address _P_1_addr()      { return _P_1_adr; }
 285   static address _P_3_addr()      { return _P_3_adr; }
 286   static address _NEG_ZERO_addr()      { return _NEG_ZERO_adr; }
 287   static address _L_2il0floatpacket_0_addr()      { return _L_2il0floatpacket_0_adr; }
 288   static address _Pi4Inv_addr()      { return _Pi4Inv_adr; }
 289   static address _Pi4x3_addr()      { return _Pi4x3_adr; }
 290   static address _Pi4x4_addr()      { return _Pi4x4_adr; }
 291   static address _ones_addr()      { return _ones_adr; }
 292 
 293 };
 294 
 295 #endif // CPU_X86_STUBROUTINES_X86_HPP