1 /*
   2  * Copyright (c) 2009, 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 package jdk.vm.ci.code;
  24 
  25 import java.util.Objects;
  26 
  27 /**
  28  * Represents the debugging information for a particular point of execution. This information
  29  * includes:
  30  * <ul>
  31  * <li>a {@linkplain #getBytecodePosition() bytecode position}</li>
  32  * <li>a reference map for registers and stack slots in the current frame</li>
  33  * <li>a map from bytecode locals and operand stack slots to their values or locations from which
  34  * their values can be read</li>
  35  * <li>a map from the registers (in the caller's frame) to the slots where they are saved in the
  36  * current frame</li>
  37  * </ul>
  38  */
  39 public final class DebugInfo {
  40 
  41     private final BytecodePosition bytecodePosition;
  42     private ReferenceMap referenceMap;
  43     @SuppressWarnings("unused") private final VirtualObject[] virtualObjectMapping;
  44     private RegisterSaveLayout calleeSaveInfo;
  45 
  46     /**
  47      * Creates a new {@link DebugInfo} from the given values.
  48      *
  49      * @param codePos the {@linkplain BytecodePosition code position} or {@linkplain BytecodeFrame
  50      *            frame} info
  51      * @param virtualObjectMapping the mapping of {@link VirtualObject}s to their real values. This
  52      *            array is now owned by this object and must not be mutated by the caller.
  53      */
  54     @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "caller transfers ownership of `virtualObjectMapping`")
  55     public DebugInfo(BytecodePosition codePos, VirtualObject[] virtualObjectMapping) {
  56         this.bytecodePosition = codePos;
  57         this.virtualObjectMapping = virtualObjectMapping;
  58     }
  59 
  60     public DebugInfo(BytecodePosition codePos) {
  61         this(codePos, null);
  62     }
  63 
  64     public void setReferenceMap(ReferenceMap referenceMap) {
  65         this.referenceMap = referenceMap;
  66     }
  67 
  68     /**
  69      * @return {@code true} if this debug information has a frame
  70      */
  71     public boolean hasFrame() {
  72         return getBytecodePosition() instanceof BytecodeFrame;
  73     }
  74 
  75     /**
  76      * Gets the deoptimization information for each inlined frame (if available).
  77      *
  78      * @return {@code null} if no frame de-opt info is {@linkplain #hasFrame() available}
  79      */
  80     public BytecodeFrame frame() {
  81         if (hasFrame()) {
  82             return (BytecodeFrame) getBytecodePosition();
  83         }
  84         return null;
  85     }
  86 
  87     @Override
  88     public String toString() {
  89         return CodeUtil.append(new StringBuilder(100), this, null).toString();
  90     }
  91 
  92     /**
  93      * @return The code position (including all inlined methods) of this debug info. If this is a
  94      *         {@link BytecodeFrame} instance, then it is also the deoptimization information for
  95      *         each inlined frame.
  96      */
  97     public BytecodePosition getBytecodePosition() {
  98         return bytecodePosition;
  99     }
 100 
 101     public ReferenceMap getReferenceMap() {
 102         return referenceMap;
 103     }
 104 
 105     /**
 106      * Sets the map from the registers (in the caller's frame) to the slots where they are saved in
 107      * the current frame.
 108      */
 109     public void setCalleeSaveInfo(RegisterSaveLayout calleeSaveInfo) {
 110         this.calleeSaveInfo = calleeSaveInfo;
 111     }
 112 
 113     /**
 114      * Gets the map from the registers (in the caller's frame) to the slots where they are saved in
 115      * the current frame. If no such information is available, {@code null} is returned.
 116      */
 117     public RegisterSaveLayout getCalleeSaveInfo() {
 118         return calleeSaveInfo;
 119     }
 120 
 121     @Override
 122     public int hashCode() {
 123         throw new UnsupportedOperationException("hashCode");
 124     }
 125 
 126     @Override
 127     public boolean equals(Object obj) {
 128         if (this == obj) {
 129             return true;
 130         }
 131         if (obj instanceof DebugInfo) {
 132             DebugInfo that = (DebugInfo) obj;
 133             if (Objects.equals(this.bytecodePosition, that.bytecodePosition) && Objects.equals(this.calleeSaveInfo, that.calleeSaveInfo) && Objects.equals(this.referenceMap, that.referenceMap)) {
 134                 return true;
 135             }
 136         }
 137         return false;
 138     }
 139 }