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