1 /*
   2  * Copyright (c) 1997, 2017, 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 "classfile/javaClasses.inline.hpp"
  27 #include "code/codeCache.hpp"
  28 #include "code/debugInfoRec.hpp"
  29 #include "code/nmethod.hpp"
  30 #include "code/pcDesc.hpp"
  31 #include "code/scopeDesc.hpp"
  32 #include "interpreter/interpreter.hpp"
  33 #include "interpreter/oopMapCache.hpp"
  34 #include "oops/instanceKlass.hpp"
  35 #include "oops/oop.inline.hpp"
  36 #include "runtime/basicLock.hpp"
  37 #include "runtime/handles.inline.hpp"
  38 #include "runtime/monitorChunk.hpp"
  39 #include "runtime/signature.hpp"
  40 #include "runtime/stubRoutines.hpp"
  41 #include "runtime/vframeArray.hpp"
  42 #include "runtime/vframe_hp.hpp"
  43 #ifdef COMPILER2
  44 #include "opto/matcher.hpp"
  45 #endif
  46 
  47 
  48 // ------------- compiledVFrame --------------
  49 
  50 StackValueCollection* compiledVFrame::locals() const {
  51   // Natives has no scope
  52   if (scope() == NULL) return new StackValueCollection(0);
  53   GrowableArray<ScopeValue*>*  scv_list = scope()->locals();
  54   if (scv_list == NULL) return new StackValueCollection(0);
  55 
  56   // scv_list is the list of ScopeValues describing the JVM stack state.
  57   // There is one scv_list entry for every JVM stack state in use.
  58   int length = scv_list->length();
  59   StackValueCollection* result = new StackValueCollection(length);
  60   for (int i = 0; i < length; i++) {
  61     result->add(create_stack_value(scv_list->at(i)));
  62   }
  63 
  64   // Replace the original values with any stores that have been
  65   // performed through compiledVFrame::update_locals.
  66   GrowableArray<jvmtiDeferredLocalVariableSet*>* list = thread()->deferred_locals();
  67   if (list != NULL ) {
  68     // In real life this never happens or is typically a single element search
  69     for (int i = 0; i < list->length(); i++) {
  70       if (list->at(i)->matches(this)) {
  71         list->at(i)->update_locals(result);
  72         break;
  73       }
  74     }
  75   }
  76 
  77   return result;
  78 }
  79 
  80 
  81 void compiledVFrame::set_locals(StackValueCollection* values) const {
  82 
  83   fatal("Should use update_local for each local update");
  84 }
  85 
  86 void compiledVFrame::update_local(BasicType type, int index, jvalue value) {
  87   assert(index >= 0 && index < method()->max_locals(), "out of bounds");
  88   update_deferred_value(type, index, value);
  89 }
  90 
  91 void compiledVFrame::update_stack(BasicType type, int index, jvalue value) {
  92   assert(index >= 0 && index < method()->max_stack(), "out of bounds");
  93   update_deferred_value(type, index + method()->max_locals(), value);
  94 }
  95 
  96 void compiledVFrame::update_monitor(int index, MonitorInfo* val) {
  97   assert(index >= 0, "out of bounds");
  98   jvalue value;
  99   value.l = (jobject) val->owner();
 100   update_deferred_value(T_OBJECT, index + method()->max_locals() + method()->max_stack(), value);
 101 }
 102 
 103 void compiledVFrame::update_deferred_value(BasicType type, int index, jvalue value) {
 104   assert(fr().is_deoptimized_frame(), "frame must be scheduled for deoptimization");
 105   GrowableArray<jvmtiDeferredLocalVariableSet*>* deferred = thread()->deferred_locals();
 106   jvmtiDeferredLocalVariableSet* locals = NULL;
 107   if (deferred != NULL ) {
 108     // See if this vframe has already had locals with deferred writes
 109     for (int f = 0; f < deferred->length(); f++ ) {
 110       if (deferred->at(f)->matches(this)) {
 111         locals = deferred->at(f);
 112         break;
 113       }
 114     }
 115     // No matching vframe must push a new vframe
 116   } else {
 117     // No deferred updates pending for this thread.
 118     // allocate in C heap
 119     deferred =  new(ResourceObj::C_HEAP, mtCompiler) GrowableArray<jvmtiDeferredLocalVariableSet*> (1, true);
 120     thread()->set_deferred_locals(deferred);
 121   }
 122   if (locals == NULL) {
 123     locals = new jvmtiDeferredLocalVariableSet(method(), bci(), fr().id(), vframe_id());
 124     deferred->push(locals);
 125     assert(locals->id() == fr().id(), "Huh? Must match");
 126   }
 127   locals->set_value_at(index, type, value);
 128 }
 129 
 130 StackValueCollection* compiledVFrame::expressions() const {
 131   // Natives has no scope
 132   if (scope() == NULL) return new StackValueCollection(0);
 133   GrowableArray<ScopeValue*>*  scv_list = scope()->expressions();
 134   if (scv_list == NULL) return new StackValueCollection(0);
 135 
 136   // scv_list is the list of ScopeValues describing the JVM stack state.
 137   // There is one scv_list entry for every JVM stack state in use.
 138   int length = scv_list->length();
 139   StackValueCollection* result = new StackValueCollection(length);
 140   for (int i = 0; i < length; i++) {
 141     result->add(create_stack_value(scv_list->at(i)));
 142   }
 143 
 144   // Replace the original values with any stores that have been
 145   // performed through compiledVFrame::update_stack.
 146   GrowableArray<jvmtiDeferredLocalVariableSet*>* list = thread()->deferred_locals();
 147   if (list != NULL ) {
 148     // In real life this never happens or is typically a single element search
 149     for (int i = 0; i < list->length(); i++) {
 150       if (list->at(i)->matches(this)) {
 151         list->at(i)->update_stack(result);
 152         break;
 153       }
 154     }
 155   }
 156 
 157   return result;
 158 }
 159 
 160 
 161 // The implementation of the following two methods was factorized into the
 162 // class StackValue because it is also used from within deoptimization.cpp for
 163 // rematerialization and relocking of non-escaping objects.
 164 
 165 StackValue *compiledVFrame::create_stack_value(ScopeValue *sv) const {
 166   return StackValue::create_stack_value(&_fr, register_map(), sv);
 167 }
 168 
 169 BasicLock* compiledVFrame::resolve_monitor_lock(Location location) const {
 170   return StackValue::resolve_monitor_lock(&_fr, location);
 171 }
 172 
 173 
 174 GrowableArray<MonitorInfo*>* compiledVFrame::monitors() const {
 175   // Natives has no scope
 176   if (scope() == NULL) {
 177     CompiledMethod* nm = code();
 178     Method* method = nm->method();
 179     assert(method->is_native() || nm->is_aot(), "Expect a native method or precompiled method");
 180     if (!method->is_synchronized()) {
 181       return new GrowableArray<MonitorInfo*>(0);
 182     }
 183     // This monitor is really only needed for UseBiasedLocking, but
 184     // return it in all cases for now as it might be useful for stack
 185     // traces and tools as well
 186     GrowableArray<MonitorInfo*> *monitors = new GrowableArray<MonitorInfo*>(1);
 187     // Casting away const
 188     frame& fr = (frame&) _fr;
 189     MonitorInfo* info = new MonitorInfo(
 190         fr.get_native_receiver(), fr.get_native_monitor(), false, false);
 191     monitors->push(info);
 192     return monitors;
 193   }
 194   GrowableArray<MonitorValue*>* monitors = scope()->monitors();
 195   if (monitors == NULL) {
 196     return new GrowableArray<MonitorInfo*>(0);
 197   }
 198   GrowableArray<MonitorInfo*>* result = new GrowableArray<MonitorInfo*>(monitors->length());
 199   for (int index = 0; index < monitors->length(); index++) {
 200     MonitorValue* mv = monitors->at(index);
 201     ScopeValue*   ov = mv->owner();
 202     StackValue *owner_sv = create_stack_value(ov); // it is an oop
 203     if (ov->is_object() && owner_sv->obj_is_scalar_replaced()) { // The owner object was scalar replaced
 204       assert(mv->eliminated(), "monitor should be eliminated for scalar replaced object");
 205       // Put klass for scalar replaced object.
 206       ScopeValue* kv = ((ObjectValue *)ov)->klass();
 207       assert(kv->is_constant_oop(), "klass should be oop constant for scalar replaced object");
 208       Handle k(Thread::current(), ((ConstantOopReadValue*)kv)->value()());
 209       assert(java_lang_Class::is_instance(k()), "must be");
 210       result->push(new MonitorInfo(k(), resolve_monitor_lock(mv->basic_lock()),
 211                                    mv->eliminated(), true));
 212     } else {
 213       result->push(new MonitorInfo(owner_sv->get_obj()(), resolve_monitor_lock(mv->basic_lock()),
 214                                    mv->eliminated(), false));
 215     }
 216   }
 217 
 218   // Replace the original values with any stores that have been
 219   // performed through compiledVFrame::update_monitors.
 220   GrowableArray<jvmtiDeferredLocalVariableSet*>* list = thread()->deferred_locals();
 221   if (list != NULL ) {
 222     // In real life this never happens or is typically a single element search
 223     for (int i = 0; i < list->length(); i++) {
 224       if (list->at(i)->matches(this)) {
 225         list->at(i)->update_monitors(result);
 226         break;
 227       }
 228     }
 229   }
 230 
 231   return result;
 232 }
 233 
 234 
 235 compiledVFrame::compiledVFrame(const frame* fr, const RegisterMap* reg_map, JavaThread* thread, CompiledMethod* nm)
 236 : javaVFrame(fr, reg_map, thread) {
 237   _scope  = NULL;
 238   _vframe_id = 0;
 239   // Compiled method (native stub or Java code)
 240   // native wrappers have no scope data, it is implied
 241   if (!nm->is_compiled() || !nm->as_compiled_method()->is_native_method()) {
 242       _scope  = nm->scope_desc_at(_fr.pc());
 243   }
 244 }
 245 
 246 compiledVFrame::compiledVFrame(const frame* fr, const RegisterMap* reg_map, JavaThread* thread, ScopeDesc* scope, int vframe_id)
 247 : javaVFrame(fr, reg_map, thread) {
 248   _scope  = scope;
 249   _vframe_id = vframe_id;
 250   guarantee(_scope != NULL, "scope must be present");
 251 }
 252 
 253 
 254 bool compiledVFrame::is_top() const {
 255   // FIX IT: Remove this when new native stubs are in place
 256   if (scope() == NULL) return true;
 257   return scope()->is_top();
 258 }
 259 
 260 
 261 CompiledMethod* compiledVFrame::code() const {
 262   return CodeCache::find_compiled(_fr.pc());
 263 }
 264 
 265 
 266 Method* compiledVFrame::method() const {
 267   if (scope() == NULL) {
 268     // native nmethods have no scope the method is implied
 269     nmethod* nm = code()->as_nmethod();
 270     assert(nm->is_native_method(), "must be native");
 271     return nm->method();
 272   }
 273   return scope()->method();
 274 }
 275 
 276 
 277 int compiledVFrame::bci() const {
 278   int raw = raw_bci();
 279   return raw == SynchronizationEntryBCI ? 0 : raw;
 280 }
 281 
 282 
 283 int compiledVFrame::raw_bci() const {
 284   if (scope() == NULL) {
 285     // native nmethods have no scope the method/bci is implied
 286     nmethod* nm = code()->as_nmethod();
 287     assert(nm->is_native_method(), "must be native");
 288     return 0;
 289   }
 290   return scope()->bci();
 291 }
 292 
 293 bool compiledVFrame::should_reexecute() const {
 294   if (scope() == NULL) {
 295     // native nmethods have no scope the method/bci is implied
 296     nmethod* nm = code()->as_nmethod();
 297     assert(nm->is_native_method(), "must be native");
 298     return false;
 299   }
 300   return scope()->should_reexecute();
 301 }
 302 
 303 vframe* compiledVFrame::sender() const {
 304   const frame f = fr();
 305   if (scope() == NULL) {
 306     // native nmethods have no scope the method/bci is implied
 307     nmethod* nm = code()->as_nmethod();
 308     assert(nm->is_native_method(), "must be native");
 309     return vframe::sender();
 310   } else {
 311     return scope()->is_top()
 312       ? vframe::sender()
 313       : new compiledVFrame(&f, register_map(), thread(), scope()->sender(), vframe_id() + 1);
 314   }
 315 }
 316 
 317 jvmtiDeferredLocalVariableSet::jvmtiDeferredLocalVariableSet(Method* method, int bci, intptr_t* id, int vframe_id) {
 318   _method = method;
 319   _bci = bci;
 320   _id = id;
 321   _vframe_id = vframe_id;
 322   // Alway will need at least one, must be on C heap
 323   _locals = new(ResourceObj::C_HEAP, mtCompiler) GrowableArray<jvmtiDeferredLocalVariable*> (1, true);
 324 }
 325 
 326 jvmtiDeferredLocalVariableSet::~jvmtiDeferredLocalVariableSet() {
 327   for (int i = 0; i < _locals->length(); i++ ) {
 328     delete _locals->at(i);
 329   }
 330   // Free growableArray and c heap for elements
 331   delete _locals;
 332 }
 333 
 334 bool jvmtiDeferredLocalVariableSet::matches(const vframe* vf) {
 335   if (!vf->is_compiled_frame()) return false;
 336   compiledVFrame* cvf = (compiledVFrame*)vf;
 337   if (cvf->fr().id() == id() && cvf->vframe_id() == vframe_id()) {
 338     assert(cvf->method() == method() && cvf->bci() == bci(), "must agree");
 339     return true;
 340   }
 341   return false;
 342 }
 343 
 344 void jvmtiDeferredLocalVariableSet::set_value_at(int idx, BasicType type, jvalue val) {
 345   for (int i = 0; i < _locals->length(); i++) {
 346     if (_locals->at(i)->index() == idx) {
 347       assert(_locals->at(i)->type() == type, "Wrong type");
 348       _locals->at(i)->set_value(val);
 349       return;
 350     }
 351   }
 352   _locals->push(new jvmtiDeferredLocalVariable(idx, type, val));
 353 }
 354 
 355 void jvmtiDeferredLocalVariableSet::update_value(StackValueCollection* locals, BasicType type, int index, jvalue value) {
 356   switch (type) {
 357     case T_BOOLEAN:
 358       locals->set_int_at(index, value.z);
 359       break;
 360     case T_CHAR:
 361       locals->set_int_at(index, value.c);
 362       break;
 363     case T_FLOAT:
 364       locals->set_float_at(index, value.f);
 365       break;
 366     case T_DOUBLE:
 367       locals->set_double_at(index, value.d);
 368       break;
 369     case T_BYTE:
 370       locals->set_int_at(index, value.b);
 371       break;
 372     case T_SHORT:
 373       locals->set_int_at(index, value.s);
 374       break;
 375     case T_INT:
 376       locals->set_int_at(index, value.i);
 377       break;
 378     case T_LONG:
 379       locals->set_long_at(index, value.j);
 380       break;
 381     case T_OBJECT:
 382       {
 383         Handle obj(Thread::current(), (oop)value.l);
 384         locals->set_obj_at(index, obj);
 385       }
 386       break;
 387     default:
 388       ShouldNotReachHere();
 389   }
 390 }
 391 
 392 void jvmtiDeferredLocalVariableSet::update_locals(StackValueCollection* locals) {
 393   for (int l = 0; l < _locals->length(); l ++) {
 394     jvmtiDeferredLocalVariable* val = _locals->at(l);
 395     if (val->index() >= 0 && val->index() < method()->max_locals()) {
 396       update_value(locals, val->type(), val->index(), val->value());
 397     }
 398   }
 399 }
 400 
 401 
 402 void jvmtiDeferredLocalVariableSet::update_stack(StackValueCollection* expressions) {
 403   for (int l = 0; l < _locals->length(); l ++) {
 404     jvmtiDeferredLocalVariable* val = _locals->at(l);
 405     if (val->index() >= method()->max_locals() && val->index() < method()->max_locals() + method()->max_stack()) {
 406       update_value(expressions, val->type(), val->index() - method()->max_locals(), val->value());
 407     }
 408   }
 409 }
 410 
 411 
 412 void jvmtiDeferredLocalVariableSet::update_monitors(GrowableArray<MonitorInfo*>* monitors) {
 413   for (int l = 0; l < _locals->length(); l ++) {
 414     jvmtiDeferredLocalVariable* val = _locals->at(l);
 415     if (val->index() >= method()->max_locals() + method()->max_stack()) {
 416       int lock_index = val->index() - (method()->max_locals() + method()->max_stack());
 417       MonitorInfo* info = monitors->at(lock_index);
 418       MonitorInfo* new_info = new MonitorInfo((oopDesc*)val->value().l, info->lock(), info->eliminated(), info->owner_is_scalar_replaced());
 419       monitors->at_put(lock_index, new_info);
 420     }
 421   }
 422 }
 423 
 424 
 425 void jvmtiDeferredLocalVariableSet::oops_do(OopClosure* f) {
 426   // The Method* is on the stack so a live activation keeps it alive
 427   // either by mirror in interpreter or code in compiled code.
 428   for (int i = 0; i < _locals->length(); i++) {
 429     if (_locals->at(i)->type() == T_OBJECT) {
 430       f->do_oop(_locals->at(i)->oop_addr());
 431     }
 432   }
 433 }
 434 
 435 jvmtiDeferredLocalVariable::jvmtiDeferredLocalVariable(int index, BasicType type, jvalue value) {
 436   _index = index;
 437   _type = type;
 438   _value = value;
 439 }
 440 
 441 
 442 #ifndef PRODUCT
 443 void compiledVFrame::verify() const {
 444   Unimplemented();
 445 }
 446 #endif // PRODUCT