1 /*
  2  * Copyright (c) 2013, 2021, 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(+32000)          // 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_sp_entry;
 46 
 47   static address _f2i_fixup;
 48   static address _f2l_fixup;
 49   static address _d2i_fixup;
 50   static address _d2l_fixup;
 51 
 52   static address _float_sign_mask;
 53   static address _float_sign_flip;
 54   static address _double_sign_mask;
 55   static address _double_sign_flip;
 56 
 57  public:
 58 
 59   static address get_previous_sp_entry() {
 60     return _get_previous_sp_entry;
 61   }
 62 
 63   static address f2i_fixup() {
 64     return _f2i_fixup;
 65   }
 66 
 67   static address f2l_fixup() {
 68     return _f2l_fixup;
 69   }
 70 
 71   static address d2i_fixup() {
 72     return _d2i_fixup;
 73   }
 74 
 75   static address d2l_fixup() {
 76     return _d2l_fixup;
 77   }
 78 
 79   static address float_sign_mask() {
 80     return _float_sign_mask;
 81   }
 82 
 83   static address float_sign_flip() {
 84     return _float_sign_flip;
 85   }
 86 
 87   static address double_sign_mask() {
 88     return _double_sign_mask;
 89   }
 90 
 91   static address double_sign_flip() {
 92     return _double_sign_flip;
 93   }
 94 
 95 #else // !LP64
 96 
 97  private:
 98   static address _verify_fpu_cntrl_wrd_entry;
 99   static address _d2i_wrapper;
100   static address _d2l_wrapper;
101 
102   static jint    _fpu_cntrl_wrd_std;
103   static jint    _fpu_cntrl_wrd_24;
104   static jint    _fpu_cntrl_wrd_trunc;
105 
106   static jint    _fpu_subnormal_bias1[3];
107   static jint    _fpu_subnormal_bias2[3];
108 
109  public:
110   static address verify_fpu_cntrl_wrd_entry() { return _verify_fpu_cntrl_wrd_entry; }
111   static address d2i_wrapper()                { return _d2i_wrapper; }
112   static address d2l_wrapper()                { return _d2l_wrapper; }
113   static address addr_fpu_cntrl_wrd_std()     { return (address)&_fpu_cntrl_wrd_std;   }
114   static address addr_fpu_cntrl_wrd_24()      { return (address)&_fpu_cntrl_wrd_24;    }
115   static address addr_fpu_cntrl_wrd_trunc()   { return (address)&_fpu_cntrl_wrd_trunc; }
116   static address addr_fpu_subnormal_bias1()   { return (address)&_fpu_subnormal_bias1; }
117   static address addr_fpu_subnormal_bias2()   { return (address)&_fpu_subnormal_bias2; }
118 
119   static jint    fpu_cntrl_wrd_std()          { return _fpu_cntrl_wrd_std; }
120 #endif // !LP64
121 
122  private:
123   static jint    _mxcsr_std;
124 
125   static address _verify_mxcsr_entry;
126   // shuffle mask for fixing up 128-bit words consisting of big-endian 32-bit integers
127   static address _key_shuffle_mask_addr;
128 
129   //shuffle mask for big-endian 128-bit integers
130   static address _counter_shuffle_mask_addr;
131 
132   static address _method_entry_barrier;
133 
134   // masks and table for CRC32
135   static uint64_t _crc_by128_masks[];
136   static juint    _crc_table[];
137 #ifdef _LP64
138   static juint    _crc_by128_masks_avx512[];
139   static juint    _crc_table_avx512[];
140   static juint    _shuf_table_crc32_avx512[];
141   static juint    _adler32_shuf0_table[];
142   static juint    _adler32_shuf1_table[];
143   static juint    _adler32_ascale_table[];
144 #endif // _LP64
145   // table for CRC32C
146   static juint* _crc32c_table;
147   // swap mask for ghash
148   static address _ghash_long_swap_mask_addr;
149   static address _ghash_byte_swap_mask_addr;
150   static address _ghash_poly_addr;
151   static address _ghash_shuffmask_addr;
152 
153   // upper word mask for sha1
154   static address _upper_word_mask_addr;
155   // byte flip mask for sha1
156   static address _shuffle_byte_flip_mask_addr;
157 
158   //k256 table for sha256
159   static juint _k256[];
160   static address _k256_adr;
161   static address _vector_short_to_byte_mask;
162   static address _vector_float_sign_mask;
163   static address _vector_float_sign_flip;
164   static address _vector_double_sign_mask;
165   static address _vector_double_sign_flip;
166   static address _vector_long_sign_mask;
167   static address _vector_all_bits_set;
168   static address _vector_byte_perm_mask;
169   static address _vector_int_to_byte_mask;
170   static address _vector_int_to_short_mask;
171   static address _vector_32_bit_mask;
172   static address _vector_64_bit_mask;
173   static address _vector_int_shuffle_mask;
174   static address _vector_byte_shuffle_mask;
175   static address _vector_short_shuffle_mask;
176   static address _vector_long_shuffle_mask;
177   static address _vector_iota_indices;
178 #ifdef _LP64
179   static juint _k256_W[];
180   static address _k256_W_adr;
181   static julong _k512_W[];
182   static address _k512_W_addr;
183   // byte flip mask for sha512
184   static address _pshuffle_byte_flip_mask_addr_sha512;
185   static address _counter_mask_addr;
186   // Masks for base64
187   static address _encoding_table_base64;
188   static address _shuffle_base64;
189   static address _avx2_shuffle_base64;
190   static address _avx2_input_mask_base64;
191   static address _avx2_lut_base64;
192   static address _lookup_lo_base64;
193   static address _lookup_hi_base64;
194   static address _lookup_lo_base64url;
195   static address _lookup_hi_base64url;
196   static address _pack_vec_base64;
197   static address _join_0_1_base64;
198   static address _join_1_2_base64;
199   static address _join_2_3_base64;
200   static address _decoding_table_base64;
201   static address _ghash_poly512_addr;
202 #endif
203   // byte flip mask for sha256
204   static address _pshuffle_byte_flip_mask_addr;
205 
206   //tables common for LIBM sin and cos
207   static juint _ONEHALF[];
208   static address _ONEHALF_adr;
209   static juint _P_2[];
210   static address _P_2_adr;
211   static juint _SC_4[];
212   static address _SC_4_adr;
213   static juint _Ctable[];
214   static address _Ctable_adr;
215   static juint _SC_2[];
216   static address _SC_2_adr;
217   static juint _SC_3[];
218   static address _SC_3_adr;
219   static juint _SC_1[];
220   static address _SC_1_adr;
221   static juint _PI_INV_TABLE[];
222   static address _PI_INV_TABLE_adr;
223   static juint _PI_4[];
224   static address _PI_4_adr;
225   static juint _PI32INV[];
226   static address _PI32INV_adr;
227   static juint _SIGN_MASK[];
228   static address _SIGN_MASK_adr;
229   static juint _P_1[];
230   static address _P_1_adr;
231   static juint _P_3[];
232   static address _P_3_adr;
233   static juint _NEG_ZERO[];
234   static address _NEG_ZERO_adr;
235 
236   //tables common for LIBM sincos and tancot
237   static juint _L_2il0floatpacket_0[];
238   static address _L_2il0floatpacket_0_adr;
239   static juint _Pi4Inv[];
240   static address _Pi4Inv_adr;
241   static juint _Pi4x3[];
242   static address _Pi4x3_adr;
243   static juint _Pi4x4[];
244   static address _Pi4x4_adr;
245   static juint _ones[];
246   static address _ones_adr;
247 
248  public:
249   static address addr_mxcsr_std()        { return (address)&_mxcsr_std; }
250   static address verify_mxcsr_entry()    { return _verify_mxcsr_entry; }
251   static address key_shuffle_mask_addr() { return _key_shuffle_mask_addr; }
252   static address counter_shuffle_mask_addr() { return _counter_shuffle_mask_addr; }
253   static address crc_by128_masks_addr()  { return (address)_crc_by128_masks; }
254 #ifdef _LP64
255   static address crc_by128_masks_avx512_addr()  { return (address)_crc_by128_masks_avx512; }
256   static address shuf_table_crc32_avx512_addr()  { return (address)_shuf_table_crc32_avx512; }
257   static address crc_table_avx512_addr()  { return (address)_crc_table_avx512; }
258   static address ghash_polynomial512_addr() { return _ghash_poly512_addr; }
259 #endif // _LP64
260   static address ghash_long_swap_mask_addr() { return _ghash_long_swap_mask_addr; }
261   static address ghash_byte_swap_mask_addr() { return _ghash_byte_swap_mask_addr; }
262   static address ghash_shufflemask_addr() { return _ghash_shuffmask_addr; }
263   static address ghash_polynomial_addr() { return _ghash_poly_addr; }
264   static address upper_word_mask_addr() { return _upper_word_mask_addr; }
265   static address shuffle_byte_flip_mask_addr() { return _shuffle_byte_flip_mask_addr; }
266   static address k256_addr()      { return _k256_adr; }
267   static address method_entry_barrier() { return _method_entry_barrier; }
268 
269   static address vector_short_to_byte_mask() {
270     return _vector_short_to_byte_mask;
271   }
272   static address vector_float_sign_mask() {
273     return _vector_float_sign_mask;
274   }
275 
276   static address vector_float_sign_flip() {
277     return _vector_float_sign_flip;
278   }
279 
280   static address vector_double_sign_mask() {
281     return _vector_double_sign_mask;
282   }
283 
284   static address vector_double_sign_flip() {
285     return _vector_double_sign_flip;
286   }
287 
288   static address vector_all_bits_set() {
289     return _vector_all_bits_set;
290   }
291 
292   static address vector_byte_perm_mask() {
293     return _vector_byte_perm_mask;
294   }
295 
296   static address vector_int_to_byte_mask() {
297     return _vector_int_to_byte_mask;
298   }
299 
300   static address vector_int_to_short_mask() {
301     return _vector_int_to_short_mask;
302   }
303 
304   static address vector_32_bit_mask() {
305     return _vector_32_bit_mask;
306   }
307 
308   static address vector_64_bit_mask() {
309     return _vector_64_bit_mask;
310   }
311 
312   static address vector_int_shuffle_mask() {
313     return _vector_int_shuffle_mask;
314   }
315 
316   static address vector_byte_shuffle_mask() {
317     return _vector_byte_shuffle_mask;
318   }
319 
320   static address vector_short_shuffle_mask() {
321     return _vector_short_shuffle_mask;
322   }
323 
324   static address vector_long_shuffle_mask() {
325     return _vector_long_shuffle_mask;
326   }
327 
328   static address vector_long_sign_mask() {
329     return _vector_long_sign_mask;
330   }
331 
332   static address vector_iota_indices() {
333     return _vector_iota_indices;
334   }
335 
336 #ifdef _LP64
337   static address k256_W_addr()    { return _k256_W_adr; }
338   static address k512_W_addr()    { return _k512_W_addr; }
339   static address pshuffle_byte_flip_mask_addr_sha512() { return _pshuffle_byte_flip_mask_addr_sha512; }
340   static address base64_encoding_table_addr() { return _encoding_table_base64; }
341   static address base64_shuffle_addr() { return _shuffle_base64; }
342   static address base64_avx2_shuffle_addr() { return _avx2_shuffle_base64; }
343   static address base64_avx2_input_mask_addr() { return _avx2_input_mask_base64; }
344   static address base64_avx2_lut_addr() { return _avx2_lut_base64; }
345   static address counter_mask_addr() { return _counter_mask_addr; }
346   static address base64_vbmi_lookup_lo_addr() { return _lookup_lo_base64; }
347   static address base64_vbmi_lookup_hi_addr() { return _lookup_hi_base64; }
348   static address base64_vbmi_lookup_lo_url_addr() { return _lookup_lo_base64url; }
349   static address base64_vbmi_lookup_hi_url_addr() { return _lookup_hi_base64url; }
350   static address base64_vbmi_pack_vec_addr() { return _pack_vec_base64; }
351   static address base64_vbmi_join_0_1_addr() { return _join_0_1_base64; }
352   static address base64_vbmi_join_1_2_addr() { return _join_1_2_base64; }
353   static address base64_vbmi_join_2_3_addr() { return _join_2_3_base64; }
354   static address base64_decoding_table_addr() { return _decoding_table_base64; }
355 #endif
356   static address pshuffle_byte_flip_mask_addr() { return _pshuffle_byte_flip_mask_addr; }
357   static void generate_CRC32C_table(bool is_pclmulqdq_supported);
358   static address _ONEHALF_addr()      { return _ONEHALF_adr; }
359   static address _P_2_addr()      { return _P_2_adr; }
360   static address _SC_4_addr()      { return _SC_4_adr; }
361   static address _Ctable_addr()      { return _Ctable_adr; }
362   static address _SC_2_addr()      { return _SC_2_adr; }
363   static address _SC_3_addr()      { return _SC_3_adr; }
364   static address _SC_1_addr()      { return _SC_1_adr; }
365   static address _PI_INV_TABLE_addr()      { return _PI_INV_TABLE_adr; }
366   static address _PI_4_addr()      { return _PI_4_adr; }
367   static address _PI32INV_addr()      { return _PI32INV_adr; }
368   static address _SIGN_MASK_addr()      { return _SIGN_MASK_adr; }
369   static address _P_1_addr()      { return _P_1_adr; }
370   static address _P_3_addr()      { return _P_3_adr; }
371   static address _NEG_ZERO_addr()      { return _NEG_ZERO_adr; }
372   static address _L_2il0floatpacket_0_addr()      { return _L_2il0floatpacket_0_adr; }
373   static address _Pi4Inv_addr()      { return _Pi4Inv_adr; }
374   static address _Pi4x3_addr()      { return _Pi4x3_adr; }
375   static address _Pi4x4_addr()      { return _Pi4x4_adr; }
376   static address _ones_addr()      { return _ones_adr; }
377 
378 };
379 
380 #endif // CPU_X86_STUBROUTINES_X86_HPP