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