1 /*
   2  * Copyright (c) 2008, 2018, 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 CPU_ARM_VM_FRAME_ARM_HPP
  26 #define CPU_ARM_VM_FRAME_ARM_HPP
  27 
  28 #include "runtime/synchronizer.hpp"
  29 
  30  public:
  31   enum {
  32     pc_return_offset                                 =  0,
  33     // All frames
  34     link_offset                                      =  0,
  35     return_addr_offset                               =  1,
  36     // non-interpreter frames
  37     sender_sp_offset                                 =  2,
  38 
  39     // Interpreter frames
  40 #ifdef AARCH64
  41     interpreter_frame_gp_saved_result_offset         =  4, // for native calls only
  42     interpreter_frame_fp_saved_result_offset         =  3, // for native calls only
  43 #endif
  44     interpreter_frame_oop_temp_offset                =  2, // for native calls only
  45 
  46     interpreter_frame_sender_sp_offset               = -1,
  47 #ifdef AARCH64
  48     interpreter_frame_stack_top_offset               = interpreter_frame_sender_sp_offset - 1,
  49     interpreter_frame_extended_sp_offset             = interpreter_frame_stack_top_offset - 1,
  50     interpreter_frame_method_offset                  = interpreter_frame_extended_sp_offset - 1,
  51 #else
  52     // outgoing sp before a call to an invoked method
  53     interpreter_frame_last_sp_offset                 = interpreter_frame_sender_sp_offset - 1,
  54     interpreter_frame_method_offset                  = interpreter_frame_last_sp_offset - 1,
  55 #endif // AARCH64
  56     interpreter_frame_mirror_offset                  = interpreter_frame_method_offset - 1,
  57     interpreter_frame_mdp_offset                     = interpreter_frame_mirror_offset - 1,
  58     interpreter_frame_cache_offset                   = interpreter_frame_mdp_offset - 1,
  59     interpreter_frame_locals_offset                  = interpreter_frame_cache_offset - 1,
  60     interpreter_frame_bcp_offset                     = interpreter_frame_locals_offset - 1,
  61     interpreter_frame_initial_sp_offset              = interpreter_frame_bcp_offset - 1,
  62 
  63     interpreter_frame_monitor_block_top_offset       = interpreter_frame_initial_sp_offset,
  64     interpreter_frame_monitor_block_bottom_offset    = interpreter_frame_initial_sp_offset,
  65 
  66     // Entry frames
  67     entry_frame_call_wrapper_offset                  =  AARCH64_ONLY(2) NOT_AARCH64(0)
  68   };
  69 
  70   intptr_t ptr_at(int offset) const {
  71     return *ptr_at_addr(offset);
  72   }
  73 
  74   void ptr_at_put(int offset, intptr_t value) {
  75     *ptr_at_addr(offset) = value;
  76   }
  77 
  78  private:
  79   // an additional field beyond _sp and _pc:
  80   intptr_t* _fp; // frame pointer
  81   // The interpreter and adapters will extend the frame of the caller.
  82   // Since oopMaps are based on the sp of the caller before extension
  83   // we need to know that value. However in order to compute the address
  84   // of the return address we need the real "raw" sp. Since sparc already
  85   // uses sp() to mean "raw" sp and unextended_sp() to mean the caller's
  86   // original sp we use that convention.
  87 
  88   intptr_t* _unextended_sp;
  89   void adjust_unextended_sp();
  90 
  91   intptr_t* ptr_at_addr(int offset) const {
  92     return (intptr_t*) addr_at(offset);
  93   }
  94 
  95 #ifdef ASSERT
  96   // Used in frame::sender_for_{interpreter,compiled}_frame
  97   static void verify_deopt_original_pc(   CompiledMethod* nm, intptr_t* unextended_sp, bool is_method_handle_return = false);
  98   static void verify_deopt_mh_original_pc(CompiledMethod* nm, intptr_t* unextended_sp) {
  99     verify_deopt_original_pc(nm, unextended_sp, true);
 100   }
 101 #endif
 102 
 103  public:
 104   // Constructors
 105 
 106   frame(intptr_t* sp, intptr_t* fp, address pc);
 107 
 108   frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc);
 109 
 110 #ifndef AARCH64
 111   frame(intptr_t* sp, intptr_t* fp);
 112 #endif // !AARCH64
 113 
 114   void init(intptr_t* sp, intptr_t* fp, address pc);
 115 
 116   // accessors for the instance variables
 117   // Note: not necessarily the real 'frame pointer' (see real_fp)
 118   intptr_t* fp() const { return _fp; }
 119 
 120   inline address* sender_pc_addr() const;
 121 
 122 #ifdef AARCH64
 123   // Used by template based interpreter deoptimization
 124   void interpreter_frame_set_stack_top(intptr_t* stack_top);
 125   void interpreter_frame_set_extended_sp(intptr_t* sp);
 126 
 127 #else
 128   // expression stack tos if we are nested in a java call
 129   intptr_t* interpreter_frame_last_sp() const;
 130 
 131   // deoptimization support
 132   void interpreter_frame_set_last_sp(intptr_t* sp);
 133 #endif // AARCH64
 134 
 135   // helper to update a map with callee-saved FP
 136   static void update_map_with_saved_link(RegisterMap* map, intptr_t** link_addr);
 137 
 138   static jint interpreter_frame_expression_stack_direction() { return -1; }
 139 
 140 #endif // CPU_ARM_VM_FRAME_ARM_HPP