1 /*
   2  * Copyright (c) 2002, 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 #ifndef SHARE_VM_RUNTIME_JAVAFRAMEANCHOR_HPP
  26 #define SHARE_VM_RUNTIME_JAVAFRAMEANCHOR_HPP
  27 
  28 #include "utilities/globalDefinitions.hpp"
  29 #include "runtime/orderAccess.inline.hpp"
  30 
  31 //
  32 // An object for encapsulating the machine/os dependent part of a JavaThread frame state
  33 //
  34 class JavaThread;
  35 
  36 class JavaFrameAnchor VALUE_OBJ_CLASS_SPEC {
  37 // Too many friends...
  38 friend class CallNativeDirectNode;
  39 friend class OptoRuntime;
  40 friend class Runtime1;
  41 friend class StubAssembler;
  42 friend class CallRuntimeDirectNode;
  43 friend class MacroAssembler;
  44 friend class LIR_Assembler;
  45 friend class GraphKit;
  46 friend class StubGenerator;
  47 friend class JavaThread;
  48 friend class frame;
  49 friend class VMStructs;
  50 friend class JVMCIVMStructs;
  51 friend class BytecodeInterpreter;
  52 friend class JavaCallWrapper;
  53 
  54  private:
  55   //
  56   // Whenever _last_Java_sp != NULL other anchor fields MUST be valid!
  57   // The stack may not be walkable [check with walkable() ] but the values must be valid.
  58   // The profiler apparently depends on this.
  59   //
  60   intptr_t* volatile _last_Java_sp;
  61 
  62   // Whenever we call from Java to native we can not be assured that the return
  63   // address that composes the last_Java_frame will be in an accessible location
  64   // so calls from Java to native store that pc (or one good enough to locate
  65   // the oopmap) in the frame anchor. Since the frames that call from Java to
  66   // native are never deoptimized we never need to patch the pc and so this
  67   // is acceptable.
  68   volatile  address _last_Java_pc;
  69 
  70   // tells whether the last Java frame is set
  71   // It is important that when last_Java_sp != NULL that the rest of the frame
  72   // anchor (including platform specific) all be valid.
  73 
  74   bool has_last_Java_frame() const                   { return _last_Java_sp != NULL; }
  75   // This is very dangerous unless sp == NULL
  76   // Invalidate the anchor so that has_last_frame is false
  77   // and no one should look at the other fields.
  78   void zap(void)                                     { _last_Java_sp = NULL; }
  79 
  80 #ifdef TARGET_ARCH_x86
  81 # include "javaFrameAnchor_x86.hpp"
  82 #endif
  83 #ifdef TARGET_ARCH_sparc
  84 # include "javaFrameAnchor_sparc.hpp"
  85 #endif
  86 #ifdef TARGET_ARCH_zero
  87 # include "javaFrameAnchor_zero.hpp"
  88 #endif
  89 #ifdef TARGET_ARCH_arm
  90 # include "javaFrameAnchor_arm.hpp"
  91 #endif
  92 #ifdef TARGET_ARCH_ppc
  93 # include "javaFrameAnchor_ppc.hpp"
  94 #endif
  95 #ifdef TARGET_ARCH_aarch64
  96 # include "javaFrameAnchor_aarch64.hpp"
  97 #endif
  98 
  99 
 100 public:
 101   JavaFrameAnchor()                              { clear(); }
 102   JavaFrameAnchor(JavaFrameAnchor *src)          { copy(src); }
 103 
 104   void set_last_Java_pc(address pc)              { _last_Java_pc = pc; }
 105 
 106   // Assembly stub generation helpers
 107 
 108   static ByteSize last_Java_sp_offset()          { return byte_offset_of(JavaFrameAnchor, _last_Java_sp); }
 109   static ByteSize last_Java_pc_offset()          { return byte_offset_of(JavaFrameAnchor, _last_Java_pc); }
 110 
 111 };
 112 
 113 #endif // SHARE_VM_RUNTIME_JAVAFRAMEANCHOR_HPP