001/*
002 * Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.lir.stackslotalloc;
024
025import jdk.internal.jvmci.code.*;
026import com.oracle.graal.debug.*;
027
028import com.oracle.graal.lir.framemap.*;
029import com.oracle.graal.lir.gen.*;
030
031/**
032 * A {@link StackSlotAllocator} is responsible for translating {@link VirtualStackSlot virtual}
033 * stack slots into {@link StackSlot real} stack slots. This includes changing all occurrences of
034 * {@link VirtualStackSlot} in the {@link LIRGenerationResult#getLIR() LIR} to {@link StackSlot}.
035 */
036public interface StackSlotAllocator {
037    /**
038     * The number of allocated stack slots.
039     */
040    DebugMetric allocatedSlots = Debug.metric("StackSlotAllocator[allocatedSlots]");
041    /**
042     * The number of reused stack slots.
043     */
044    DebugMetric reusedSlots = Debug.metric("StackSlotAllocator[reusedSlots]");
045    /**
046     * The size (in bytes) required for all allocated stack slots. Note that this number corresponds
047     * to the actual frame size and might include alignment.
048     */
049    DebugMetric allocatedFramesize = Debug.metric("StackSlotAllocator[AllocatedFramesize]");
050    /** The size (in bytes) required for all virtual stack slots. */
051    DebugMetric virtualFramesize = Debug.metric("StackSlotAllocator[VirtualFramesize]");
052
053    void allocateStackSlots(FrameMapBuilderTool builder, LIRGenerationResult res);
054}