/*
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.max.graal.hotspot.ri;

import com.oracle.max.cri.ri.*;

/**
 * Interface for accessor objects that encapsulate the logic for accessing the different kinds of data in a HotSpot methodDataOop.
 * This interface is similar to the interface {@link RiProfilingInfo}, but most methods require a MethodDataObject and the
 * exact position within the methodData.
 */
public interface HotSpotMethodDataAccessor {
    /**
     * Returns the tag stored in the LayoutData header.
     * @return An integer >= 0 or -1 if not supported.
     */
    int getTag();

    /**
     * Returns the BCI stored in the LayoutData header.
     * @return An integer >= 0 and <= Short.MAX_VALUE, or -1 if not supported.
     */
    int getBCI(HotSpotMethodData data, int position);

    /**
     * Computes the size for the specific data at the given position.
     * @return An integer > 0.
     */
    int getSize(HotSpotMethodData data, int position);

    RiTypeProfile getTypeProfile(HotSpotMethodData data, int position);
    double getBranchTakenProbability(HotSpotMethodData data, int position);
    double[] getSwitchProbabilities(HotSpotMethodData data, int position);
    RiExceptionSeen getExceptionSeen(HotSpotMethodData data, int position);
    int getExecutionCount(HotSpotMethodData data, int position);
}