1 /*
   2  * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright 2008, 2009 Red Hat, Inc.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef SHARE_VM_SHARK_SHARKSTATESCANNER_HPP
  27 #define SHARE_VM_SHARK_SHARKSTATESCANNER_HPP
  28 
  29 #include "memory/allocation.hpp"
  30 #include "shark/llvmHeaders.hpp"
  31 #include "shark/sharkFunction.hpp"
  32 #include "shark/sharkInvariants.hpp"
  33 
  34 class SharkState;
  35 
  36 class SharkStateScanner : public SharkTargetInvariants {
  37  protected:
  38   SharkStateScanner(SharkFunction* function)
  39     : SharkTargetInvariants(function), _stack(function->stack()) {}
  40 
  41  private:
  42   SharkStack* _stack;
  43 
  44  protected:
  45   SharkStack* stack() const {
  46     return _stack;
  47   }
  48 
  49   // Scan the frame
  50  public:
  51   void scan(SharkState* state);
  52 
  53   // Callbacks
  54   // Note that the offsets supplied to the various process_* callbacks
  55   // are specified in wordSize words from the frame's unextended_sp.
  56  protected:
  57   virtual void start_frame()                                                 {}
  58 
  59   virtual void start_stack(int stack_depth)                                  {}
  60   virtual void process_stack_slot(int index, SharkValue** value, int offset) {}
  61   virtual void end_stack()                                                   {}
  62 
  63   virtual void start_monitors(int num_monitors)                              {}
  64   virtual void process_monitor(int index, int box_offset, int obj_offset)    {}
  65   virtual void end_monitors()                                                {}
  66 
  67   virtual void start_frame_header()                                          {}
  68   virtual void process_oop_tmp_slot(llvm::Value** value, int offset)         {}
  69   virtual void process_method_slot(llvm::Value** value, int offset)          {}
  70   virtual void process_pc_slot(int offset)                                   {}
  71   virtual void end_frame_header()                                            {}
  72 
  73   virtual void start_locals()                                                {}
  74   virtual void process_local_slot(int index, SharkValue** value, int offset) {}
  75   virtual void end_locals()                                                  {}
  76 
  77   virtual void end_frame()                                                   {}
  78 
  79   // Integrity checks
  80  private:
  81   void stack_integrity_checks(SharkState* state) PRODUCT_RETURN;
  82   void locals_integrity_checks(SharkState* state) PRODUCT_RETURN;
  83 };
  84 
  85 #endif // SHARE_VM_SHARK_SHARKSTATESCANNER_HPP