1 /*
2  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
3  * Copyright (c) 2016 SAP SE. All rights reserved.
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This code is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License version 2 only, as
8  * published by the Free Software Foundation.
9  *
10  * This code is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13  * version 2 for more details (a copy is included in the LICENSE file that
14  * accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License version
17  * 2 along with this work; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19  *
20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21  * or visit www.oracle.com if you need additional information or have any
22  * questions.
23  *
24  */
25 
26 #include "precompiled.hpp"
27 #include "c1/c1_FrameMap.hpp"
28 #include "c1/c1_LIR.hpp"
29 #include "runtime/sharedRuntime.hpp"
30 #include "vmreg_s390.inline.hpp"
31 
32 
33 const int FrameMap::pd_c_runtime_reserved_arg_size = 7;
34 
map_to_opr(BasicType type,VMRegPair * reg,bool outgoing)35 LIR_Opr FrameMap::map_to_opr(BasicType type, VMRegPair* reg, bool outgoing) {
36   LIR_Opr opr = LIR_OprFact::illegalOpr;
37   VMReg r_1 = reg->first();
38   VMReg r_2 = reg->second();
39   if (r_1->is_stack()) {
40     // Convert stack slot to an SP offset.
41     // The calling convention does not count the SharedRuntime::out_preserve_stack_slots() value
42     // so we must add it in here.
43     int st_off = (r_1->reg2stack() + SharedRuntime::out_preserve_stack_slots()) * VMRegImpl::stack_slot_size;
44     opr = LIR_OprFact::address(new LIR_Address(Z_SP_opr, st_off, type));
45   } else if (r_1->is_Register()) {
46     Register reg = r_1->as_Register();
47     if (r_2->is_Register() && (type == T_LONG || type == T_DOUBLE)) {
48       opr = as_long_opr(reg);
49     } else if (type == T_OBJECT || type == T_ARRAY) {
50       opr = as_oop_opr(reg);
51     } else if (type == T_METADATA) {
52       opr = as_metadata_opr(reg);
53     } else if (type == T_ADDRESS) {
54       opr = as_address_opr(reg);
55     } else {
56       opr = as_opr(reg);
57     }
58   } else if (r_1->is_FloatRegister()) {
59     assert(type == T_DOUBLE || type == T_FLOAT, "wrong type");
60     FloatRegister f = r_1->as_FloatRegister();
61     if (type == T_FLOAT) {
62       opr = as_float_opr(f);
63     } else {
64       opr = as_double_opr(f);
65     }
66   } else {
67     ShouldNotReachHere();
68   }
69   return opr;
70 }
71 
72 //               FrameMap
73 //--------------------------------------------------------
74 
75 FloatRegister FrameMap::_fpu_rnr2reg [FrameMap::nof_fpu_regs]; // mapping c1 regnr. -> FloatRegister
76 int           FrameMap::_fpu_reg2rnr [FrameMap::nof_fpu_regs]; // mapping assembler encoding -> c1 regnr.
77 
78 // Some useful constant RInfo's:
79 LIR_Opr FrameMap::Z_R0_opr;
80 LIR_Opr FrameMap::Z_R1_opr;
81 LIR_Opr FrameMap::Z_R2_opr;
82 LIR_Opr FrameMap::Z_R3_opr;
83 LIR_Opr FrameMap::Z_R4_opr;
84 LIR_Opr FrameMap::Z_R5_opr;
85 LIR_Opr FrameMap::Z_R6_opr;
86 LIR_Opr FrameMap::Z_R7_opr;
87 LIR_Opr FrameMap::Z_R8_opr;
88 LIR_Opr FrameMap::Z_R9_opr;
89 LIR_Opr FrameMap::Z_R10_opr;
90 LIR_Opr FrameMap::Z_R11_opr;
91 LIR_Opr FrameMap::Z_R12_opr;
92 LIR_Opr FrameMap::Z_R13_opr;
93 LIR_Opr FrameMap::Z_R14_opr;
94 LIR_Opr FrameMap::Z_R15_opr;
95 
96 LIR_Opr FrameMap::Z_R0_oop_opr;
97 LIR_Opr FrameMap::Z_R1_oop_opr;
98 LIR_Opr FrameMap::Z_R2_oop_opr;
99 LIR_Opr FrameMap::Z_R3_oop_opr;
100 LIR_Opr FrameMap::Z_R4_oop_opr;
101 LIR_Opr FrameMap::Z_R5_oop_opr;
102 LIR_Opr FrameMap::Z_R6_oop_opr;
103 LIR_Opr FrameMap::Z_R7_oop_opr;
104 LIR_Opr FrameMap::Z_R8_oop_opr;
105 LIR_Opr FrameMap::Z_R9_oop_opr;
106 LIR_Opr FrameMap::Z_R10_oop_opr;
107 LIR_Opr FrameMap::Z_R11_oop_opr;
108 LIR_Opr FrameMap::Z_R12_oop_opr;
109 LIR_Opr FrameMap::Z_R13_oop_opr;
110 LIR_Opr FrameMap::Z_R14_oop_opr;
111 LIR_Opr FrameMap::Z_R15_oop_opr;
112 
113 LIR_Opr FrameMap::Z_R0_metadata_opr;
114 LIR_Opr FrameMap::Z_R1_metadata_opr;
115 LIR_Opr FrameMap::Z_R2_metadata_opr;
116 LIR_Opr FrameMap::Z_R3_metadata_opr;
117 LIR_Opr FrameMap::Z_R4_metadata_opr;
118 LIR_Opr FrameMap::Z_R5_metadata_opr;
119 LIR_Opr FrameMap::Z_R6_metadata_opr;
120 LIR_Opr FrameMap::Z_R7_metadata_opr;
121 LIR_Opr FrameMap::Z_R8_metadata_opr;
122 LIR_Opr FrameMap::Z_R9_metadata_opr;
123 LIR_Opr FrameMap::Z_R10_metadata_opr;
124 LIR_Opr FrameMap::Z_R11_metadata_opr;
125 LIR_Opr FrameMap::Z_R12_metadata_opr;
126 LIR_Opr FrameMap::Z_R13_metadata_opr;
127 LIR_Opr FrameMap::Z_R14_metadata_opr;
128 LIR_Opr FrameMap::Z_R15_metadata_opr;
129 
130 LIR_Opr FrameMap::Z_SP_opr;
131 LIR_Opr FrameMap::Z_FP_opr;
132 
133 LIR_Opr FrameMap::Z_R2_long_opr;
134 LIR_Opr FrameMap::Z_R10_long_opr;
135 LIR_Opr FrameMap::Z_R11_long_opr;
136 
137 LIR_Opr FrameMap::Z_F0_opr;
138 LIR_Opr FrameMap::Z_F0_double_opr;
139 
140 
141 LIR_Opr FrameMap::_caller_save_cpu_regs[] = { 0, };
142 LIR_Opr FrameMap::_caller_save_fpu_regs[] = { 0, };
143 
144 
145 // c1 rnr -> FloatRegister
nr2floatreg(int rnr)146 FloatRegister FrameMap::nr2floatreg (int rnr) {
147   assert(_init_done, "tables not initialized");
148   debug_only(fpu_range_check(rnr);)
149   return _fpu_rnr2reg[rnr];
150 }
151 
map_float_register(int rnr,FloatRegister reg)152 void FrameMap::map_float_register(int rnr, FloatRegister reg) {
153   debug_only(fpu_range_check(rnr);)
154   debug_only(fpu_range_check(reg->encoding());)
155   _fpu_rnr2reg[rnr] = reg;              // mapping c1 regnr. -> FloatRegister
156   _fpu_reg2rnr[reg->encoding()] = rnr;  // mapping assembler encoding -> c1 regnr.
157 }
158 
initialize()159 void FrameMap::initialize() {
160   assert(!_init_done, "once");
161 
162   DEBUG_ONLY(int allocated   = 0;)
163   DEBUG_ONLY(int unallocated = 0;)
164 
165   // Register usage:
166   // Z_thread (Z_R8)
167   // Z_fp     (Z_R9)
168   // Z_SP     (Z_R15)
169   DEBUG_ONLY(allocated++); map_register(0, Z_R2);
170   DEBUG_ONLY(allocated++); map_register(1, Z_R3);
171   DEBUG_ONLY(allocated++); map_register(2, Z_R4);
172   DEBUG_ONLY(allocated++); map_register(3, Z_R5);
173   DEBUG_ONLY(allocated++); map_register(4, Z_R6);
174   DEBUG_ONLY(allocated++); map_register(5, Z_R7);
175   DEBUG_ONLY(allocated++); map_register(6, Z_R10);
176   DEBUG_ONLY(allocated++); map_register(7, Z_R11);
177   DEBUG_ONLY(allocated++); map_register(8, Z_R12);
178   DEBUG_ONLY(allocated++); map_register(9, Z_R13);     // <- last register visible in RegAlloc
179   DEBUG_ONLY(unallocated++); map_register(11, Z_R0);   // Z_R0_scratch
180   DEBUG_ONLY(unallocated++); map_register(12, Z_R1);   // Z_R1_scratch
181   DEBUG_ONLY(unallocated++); map_register(10, Z_R14);  // return pc; TODO: Try to let c1/c2 allocate R14.
182 
183   // The following registers are usually unavailable.
184   DEBUG_ONLY(unallocated++); map_register(13, Z_R8);
185   DEBUG_ONLY(unallocated++); map_register(14, Z_R9);
186   DEBUG_ONLY(unallocated++); map_register(15, Z_R15);
187   assert(allocated-1 == pd_last_cpu_reg, "wrong number/mapping of allocated CPU registers");
188   assert(unallocated == pd_nof_cpu_regs_unallocated, "wrong number of unallocated CPU registers");
189   assert(nof_cpu_regs == allocated+unallocated, "wrong number of CPU registers");
190 
191   int j = 0;
192   for (int i = 0; i < nof_fpu_regs; i++) {
193     if (as_FloatRegister(i) == Z_fscratch_1) continue; // unallocated
194     map_float_register(j++, as_FloatRegister(i));
195   }
196   assert(j == nof_fpu_regs-1, "missed one fpu reg?");
197   map_float_register(j++, Z_fscratch_1);
198 
199   _init_done = true;
200 
201   Z_R0_opr = as_opr(Z_R0);
202   Z_R1_opr = as_opr(Z_R1);
203   Z_R2_opr = as_opr(Z_R2);
204   Z_R3_opr = as_opr(Z_R3);
205   Z_R4_opr = as_opr(Z_R4);
206   Z_R5_opr = as_opr(Z_R5);
207   Z_R6_opr = as_opr(Z_R6);
208   Z_R7_opr = as_opr(Z_R7);
209   Z_R8_opr = as_opr(Z_R8);
210   Z_R9_opr = as_opr(Z_R9);
211   Z_R10_opr = as_opr(Z_R10);
212   Z_R11_opr = as_opr(Z_R11);
213   Z_R12_opr = as_opr(Z_R12);
214   Z_R13_opr = as_opr(Z_R13);
215   Z_R14_opr = as_opr(Z_R14);
216   Z_R15_opr = as_opr(Z_R15);
217 
218   Z_R0_oop_opr = as_oop_opr(Z_R0);
219   Z_R1_oop_opr = as_oop_opr(Z_R1);
220   Z_R2_oop_opr = as_oop_opr(Z_R2);
221   Z_R3_oop_opr = as_oop_opr(Z_R3);
222   Z_R4_oop_opr = as_oop_opr(Z_R4);
223   Z_R5_oop_opr = as_oop_opr(Z_R5);
224   Z_R6_oop_opr = as_oop_opr(Z_R6);
225   Z_R7_oop_opr = as_oop_opr(Z_R7);
226   Z_R8_oop_opr = as_oop_opr(Z_R8);
227   Z_R9_oop_opr = as_oop_opr(Z_R9);
228   Z_R10_oop_opr = as_oop_opr(Z_R10);
229   Z_R11_oop_opr = as_oop_opr(Z_R11);
230   Z_R12_oop_opr = as_oop_opr(Z_R12);
231   Z_R13_oop_opr = as_oop_opr(Z_R13);
232   Z_R14_oop_opr = as_oop_opr(Z_R14);
233   Z_R15_oop_opr = as_oop_opr(Z_R15);
234 
235   Z_R0_metadata_opr = as_metadata_opr(Z_R0);
236   Z_R1_metadata_opr = as_metadata_opr(Z_R1);
237   Z_R2_metadata_opr = as_metadata_opr(Z_R2);
238   Z_R3_metadata_opr = as_metadata_opr(Z_R3);
239   Z_R4_metadata_opr = as_metadata_opr(Z_R4);
240   Z_R5_metadata_opr = as_metadata_opr(Z_R5);
241   Z_R6_metadata_opr = as_metadata_opr(Z_R6);
242   Z_R7_metadata_opr = as_metadata_opr(Z_R7);
243   Z_R8_metadata_opr = as_metadata_opr(Z_R8);
244   Z_R9_metadata_opr = as_metadata_opr(Z_R9);
245   Z_R10_metadata_opr = as_metadata_opr(Z_R10);
246   Z_R11_metadata_opr = as_metadata_opr(Z_R11);
247   Z_R12_metadata_opr = as_metadata_opr(Z_R12);
248   Z_R13_metadata_opr = as_metadata_opr(Z_R13);
249   Z_R14_metadata_opr = as_metadata_opr(Z_R14);
250   Z_R15_metadata_opr = as_metadata_opr(Z_R15);
251 
252   // TODO: needed? Or can we make Z_R9 available for linear scan allocation.
253   Z_FP_opr = as_pointer_opr(Z_fp);
254   Z_SP_opr = as_pointer_opr(Z_SP);
255 
256   Z_R2_long_opr = LIR_OprFact::double_cpu(cpu_reg2rnr(Z_R2), cpu_reg2rnr(Z_R2));
257   Z_R10_long_opr = LIR_OprFact::double_cpu(cpu_reg2rnr(Z_R10), cpu_reg2rnr(Z_R10));
258   Z_R11_long_opr = LIR_OprFact::double_cpu(cpu_reg2rnr(Z_R11), cpu_reg2rnr(Z_R11));
259 
260   Z_F0_opr = as_float_opr(Z_F0);
261   Z_F0_double_opr = as_double_opr(Z_F0);
262 
263   // All allocated cpu regs are caller saved.
264   for (int c1rnr = 0; c1rnr < max_nof_caller_save_cpu_regs; c1rnr++) {
265     _caller_save_cpu_regs[c1rnr] = as_opr(cpu_rnr2reg(c1rnr));
266   }
267 
268   // All allocated fpu regs are caller saved.
269   for (int c1rnr = 0; c1rnr < nof_caller_save_fpu_regs; c1rnr++) {
270     _caller_save_fpu_regs[c1rnr] = as_float_opr(nr2floatreg(c1rnr));
271   }
272 }
273 
make_new_address(ByteSize sp_offset) const274 Address FrameMap::make_new_address(ByteSize sp_offset) const {
275   return Address(Z_SP, sp_offset);
276 }
277 
fpu_regname(int n)278 VMReg FrameMap::fpu_regname (int n) {
279   return nr2floatreg(n)->as_VMReg();
280 }
281 
stack_pointer()282 LIR_Opr FrameMap::stack_pointer() {
283   return Z_SP_opr;
284 }
285 
286 // JSR 292
287 // On ZARCH_64, there is no need to save the SP, because neither
288 // method handle intrinsics nor compiled lambda forms modify it.
method_handle_invoke_SP_save_opr()289 LIR_Opr FrameMap::method_handle_invoke_SP_save_opr() {
290   return LIR_OprFact::illegalOpr;
291 }
292 
validate_frame()293 bool FrameMap::validate_frame() {
294   return true;
295 }
296