1 /*
2 * Copyright (c) 1999, 2015, 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 #include "precompiled.hpp"
26 #include "opto/addnode.hpp"
27 #include "opto/callnode.hpp"
28 #include "opto/cfgnode.hpp"
29 #include "opto/compile.hpp"
30 #include "opto/convertnode.hpp"
31 #include "opto/locknode.hpp"
32 #include "opto/memnode.hpp"
33 #include "opto/mulnode.hpp"
34 #include "opto/node.hpp"
35 #include "opto/parse.hpp"
36 #include "opto/phaseX.hpp"
37 #include "opto/rootnode.hpp"
38 #include "opto/runtime.hpp"
39 #include "opto/type.hpp"
40
41 //--------------------gen_stub-------------------------------
42 void GraphKit::gen_stub(address C_function,
43 const char *name,
44 int is_fancy_jump,
45 bool pass_tls,
46 bool return_pc) {
47 ResourceMark rm;
48
49 const TypeTuple *jdomain = C->tf()->domain();
50 const TypeTuple *jrange = C->tf()->range();
51
52 // The procedure start
53 StartNode* start = new StartNode(root(), jdomain);
54 _gvn.set_type_bottom(start);
55
56 // Make a map, with JVM state
57 uint parm_cnt = jdomain->cnt();
58 uint max_map = MAX2(2*parm_cnt+1, jrange->cnt());
59 // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
60 assert(SynchronizationEntryBCI == InvocationEntryBci, "");
61 JVMState* jvms = new (C) JVMState(0);
62 jvms->set_bci(InvocationEntryBci);
63 jvms->set_monoff(max_map);
64 jvms->set_scloff(max_map);
65 jvms->set_endoff(max_map);
66 {
67 SafePointNode *map = new SafePointNode( max_map, jvms );
68 jvms->set_map(map);
69 set_jvms(jvms);
70 assert(map == this->map(), "kit.map is set");
71 }
72
73 // Make up the parameters
74 uint i;
75 for (i = 0; i < parm_cnt; i++) {
76 map()->init_req(i, _gvn.transform(new ParmNode(start, i)));
77 }
78 for ( ; i<map()->req(); i++) {
79 map()->init_req(i, top()); // For nicer debugging
80 }
81
82 // GraphKit requires memory to be a MergeMemNode:
83 set_all_memory(map()->memory());
84
85 // Get base of thread-local storage area
86 Node* thread = _gvn.transform(new ThreadLocalNode());
87
88 const int NoAlias = Compile::AliasIdxBot;
89
90 Node* adr_last_Java_pc = basic_plus_adr(top(),
91 thread,
92 in_bytes(JavaThread::frame_anchor_offset()) +
93 in_bytes(JavaFrameAnchor::last_Java_pc_offset()));
94 #if defined(SPARC)
95 Node* adr_flags = basic_plus_adr(top(),
96 thread,
97 in_bytes(JavaThread::frame_anchor_offset()) +
98 in_bytes(JavaFrameAnchor::flags_offset()));
99 #endif /* defined(SPARC) */
100
101
102 // Drop in the last_Java_sp. last_Java_fp is not touched.
103 // Always do this after the other "last_Java_frame" fields are set since
104 // as soon as last_Java_sp != NULL the has_last_Java_frame is true and
105 // users will look at the other fields.
106 //
107 Node *adr_sp = basic_plus_adr(top(), thread, in_bytes(JavaThread::last_Java_sp_offset()));
108 Node *last_sp = basic_plus_adr(top(), frameptr(), (intptr_t) STACK_BIAS);
109 store_to_memory(NULL, adr_sp, last_sp, T_ADDRESS, NoAlias, MemNode::unordered);
110
111 // Set _thread_in_native
112 // The order of stores into TLS is critical! Setting _thread_in_native MUST
113 // be last, because a GC is allowed at any time after setting it and the GC
114 // will require last_Java_pc and last_Java_sp.
115
116 //-----------------------------
117 // Compute signature for C call. Varies from the Java signature!
118
119 const Type **fields = TypeTuple::fields(2*parm_cnt+2);
120 uint cnt = TypeFunc::Parms;
121 // The C routines gets the base of thread-local storage passed in as an
122 // extra argument. Not all calls need it, but it is cheap to add here.
123 for (uint pcnt = cnt; pcnt < parm_cnt; pcnt++, cnt++) {
124 const Type *f = jdomain->field_at(pcnt);
125 if (CCallingConventionRequiresIntsAsLongs && f->isa_int()) {
126 fields[cnt++] = TypeLong::LONG;
127 fields[cnt] = Type::HALF; // Must add an additional half for a long.
128 } else {
129 fields[cnt] = f;
130 }
131 }
132 fields[cnt++] = TypeRawPtr::BOTTOM; // Thread-local storage
133 // Also pass in the caller's PC, if asked for.
134 if (return_pc) {
135 fields[cnt++] = TypeRawPtr::BOTTOM; // Return PC
136 }
137 const TypeTuple* domain = TypeTuple::make(cnt, fields);
138
139 // The C routine we are about to call cannot return an oop; it can block on
140 // exit and a GC will trash the oop while it sits in C-land. Instead, we
141 // return the oop through TLS for runtime calls.
142 // Also, C routines returning integer subword values leave the high
143 // order bits dirty; these must be cleaned up by explicit sign extension.
144 const Type* retval = (jrange->cnt() == TypeFunc::Parms) ? Type::TOP : jrange->field_at(TypeFunc::Parms);
145 // Make a private copy of jrange->fields();
146 const Type **rfields = TypeTuple::fields(jrange->cnt() - TypeFunc::Parms);
147 // Fixup oop returns
148 int retval_ptr = retval->isa_oop_ptr();
149 if (retval_ptr) {
150 assert( pass_tls, "Oop must be returned thru TLS" );
151 // Fancy-jumps return address; others return void
152 rfields[TypeFunc::Parms] = is_fancy_jump ? TypeRawPtr::BOTTOM : Type::TOP;
153
154 } else if (retval->isa_int()) { // Returning any integer subtype?
155 // "Fatten" byte, char & short return types to 'int' to show that
156 // the native C code can return values with junk high order bits.
157 // We'll sign-extend it below later.
158 rfields[TypeFunc::Parms] = TypeInt::INT; // It's "dirty" and needs sign-ext
159
160 } else if (jrange->cnt() >= TypeFunc::Parms+1) { // Else copy other types
161 rfields[TypeFunc::Parms] = jrange->field_at(TypeFunc::Parms);
162 if (jrange->cnt() == TypeFunc::Parms+2) {
163 rfields[TypeFunc::Parms+1] = jrange->field_at(TypeFunc::Parms+1);
164 }
165 }
166 const TypeTuple* range = TypeTuple::make(jrange->cnt(), rfields);
167
168 // Final C signature
169 const TypeFunc *c_sig = TypeFunc::make(domain, range);
170
171 //-----------------------------
172 // Make the call node.
173 CallRuntimeNode *call = new CallRuntimeNode(c_sig, C_function, name, TypePtr::BOTTOM);
174 //-----------------------------
175
176 // Fix-up the debug info for the call.
177 call->set_jvms(new (C) JVMState(0));
178 call->jvms()->set_bci(0);
179 call->jvms()->set_offsets(cnt);
180
181 // Set fixed predefined input arguments.
182 cnt = 0;
183 for (i = 0; i < TypeFunc::Parms; i++) {
184 call->init_req(cnt++, map()->in(i));
185 }
186 // A little too aggressive on the parm copy; return address is not an input.
187 call->set_req(TypeFunc::ReturnAdr, top());
188 for (; i < parm_cnt; i++) { // Regular input arguments.
189 const Type *f = jdomain->field_at(i);
190 if (CCallingConventionRequiresIntsAsLongs && f->isa_int()) {
191 call->init_req(cnt++, _gvn.transform(new ConvI2LNode(map()->in(i))));
192 call->init_req(cnt++, top());
193 } else {
194 call->init_req(cnt++, map()->in(i));
195 }
196 }
197 call->init_req(cnt++, thread);
198 if (return_pc) { // Return PC, if asked for.
199 call->init_req(cnt++, returnadr());
200 }
201
202 _gvn.transform_no_reclaim(call);
203
204 //-----------------------------
205 // Now set up the return results
206 set_control( _gvn.transform( new ProjNode(call,TypeFunc::Control)) );
207 set_i_o( _gvn.transform( new ProjNode(call,TypeFunc::I_O )) );
208 set_all_memory_call(call);
209 if (range->cnt() > TypeFunc::Parms) {
210 Node* retnode = _gvn.transform( new ProjNode(call,TypeFunc::Parms) );
211 // C-land is allowed to return sub-word values. Convert to integer type.
212 assert( retval != Type::TOP, "" );
213 if (retval == TypeInt::BOOL) {
214 retnode = _gvn.transform( new AndINode(retnode, intcon(0xFF)) );
215 } else if (retval == TypeInt::CHAR) {
216 retnode = _gvn.transform( new AndINode(retnode, intcon(0xFFFF)) );
217 } else if (retval == TypeInt::BYTE) {
218 retnode = _gvn.transform( new LShiftINode(retnode, intcon(24)) );
219 retnode = _gvn.transform( new RShiftINode(retnode, intcon(24)) );
220 } else if (retval == TypeInt::SHORT) {
221 retnode = _gvn.transform( new LShiftINode(retnode, intcon(16)) );
222 retnode = _gvn.transform( new RShiftINode(retnode, intcon(16)) );
223 }
224 map()->set_req( TypeFunc::Parms, retnode );
225 }
226
227 //-----------------------------
228
229 // Clear last_Java_sp
230 store_to_memory(NULL, adr_sp, null(), T_ADDRESS, NoAlias, MemNode::unordered);
231 // Clear last_Java_pc and (optionally)_flags
232 store_to_memory(NULL, adr_last_Java_pc, null(), T_ADDRESS, NoAlias, MemNode::unordered);
233 #if defined(SPARC)
234 store_to_memory(NULL, adr_flags, intcon(0), T_INT, NoAlias, MemNode::unordered);
235 #endif /* defined(SPARC) */
236 #if (defined(IA64) && !defined(AIX))
237 Node* adr_last_Java_fp = basic_plus_adr(top(), thread, in_bytes(JavaThread::last_Java_fp_offset()));
238 store_to_memory(NULL, adr_last_Java_fp, null(), T_ADDRESS, NoAlias, MemNode::unordered);
239 #endif
240
241 // For is-fancy-jump, the C-return value is also the branch target
242 Node* target = map()->in(TypeFunc::Parms);
243 // Runtime call returning oop in TLS? Fetch it out
244 if( pass_tls ) {
245 Node* adr = basic_plus_adr(top(), thread, in_bytes(JavaThread::vm_result_offset()));
246 Node* vm_result = make_load(NULL, adr, TypeOopPtr::BOTTOM, T_OBJECT, NoAlias, MemNode::unordered);
247 map()->set_req(TypeFunc::Parms, vm_result); // vm_result passed as result
248 // clear thread-local-storage(tls)
249 store_to_memory(NULL, adr, null(), T_ADDRESS, NoAlias, MemNode::unordered);
250 }
251
252 //-----------------------------
253 // check exception
254 Node* adr = basic_plus_adr(top(), thread, in_bytes(Thread::pending_exception_offset()));
255 Node* pending = make_load(NULL, adr, TypeOopPtr::BOTTOM, T_OBJECT, NoAlias, MemNode::unordered);
256
257 Node* exit_memory = reset_memory();
258
259 Node* cmp = _gvn.transform( new CmpPNode(pending, null()) );
260 Node* bo = _gvn.transform( new BoolNode(cmp, BoolTest::ne) );
261 IfNode *iff = create_and_map_if(control(), bo, PROB_MIN, COUNT_UNKNOWN);
262
263 Node* if_null = _gvn.transform( new IfFalseNode(iff) );
264 Node* if_not_null = _gvn.transform( new IfTrueNode(iff) );
265
266 assert (StubRoutines::forward_exception_entry() != NULL, "must be generated before");
267 Node *exc_target = makecon(TypeRawPtr::make( StubRoutines::forward_exception_entry() ));
268 Node *to_exc = new TailCallNode(if_not_null,
269 i_o(),
270 exit_memory,
271 frameptr(),
272 returnadr(),
273 exc_target, null());
274 root()->add_req(_gvn.transform(to_exc)); // bind to root to keep live
275 C->init_start(start);
276
277 //-----------------------------
278 // If this is a normal subroutine return, issue the return and be done.
279 Node *ret = NULL;
280 switch( is_fancy_jump ) {
281 case 0: // Make a return instruction
282 // Return to caller, free any space for return address
283 ret = new ReturnNode(TypeFunc::Parms, if_null,
284 i_o(),
285 exit_memory,
286 frameptr(),
287 returnadr());
288 if (C->tf()->range()->cnt() > TypeFunc::Parms)
289 ret->add_req( map()->in(TypeFunc::Parms) );
290 break;
291 case 1: // This is a fancy tail-call jump. Jump to computed address.
292 // Jump to new callee; leave old return address alone.
293 ret = new TailCallNode(if_null,
294 i_o(),
295 exit_memory,
296 frameptr(),
297 returnadr(),
298 target, map()->in(TypeFunc::Parms));
299 break;
300 case 2: // Pop return address & jump
301 // Throw away old return address; jump to new computed address
302 //assert(C_function == CAST_FROM_FN_PTR(address, OptoRuntime::rethrow_C), "fancy_jump==2 only for rethrow");
303 ret = new TailJumpNode(if_null,
304 i_o(),
305 exit_memory,
306 frameptr(),
307 target, map()->in(TypeFunc::Parms));
308 break;
309 default:
310 ShouldNotReachHere();
311 }
312 root()->add_req(_gvn.transform(ret));
313 }