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