001/*
002 * Copyright (c) 2012, 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.asm;
024
025/**
026 * Code for managing a method's native frame.
027 */
028public interface FrameContext {
029
030    /**
031     * Emits code common to all entry points of a method. This may include:
032     * <ul>
033     * <li>setting up the stack frame</li>
034     * <li>saving callee-saved registers</li>
035     * <li>stack overflow checking</li>
036     * </ul>
037     */
038    void enter(CompilationResultBuilder crb);
039
040    /**
041     * Emits code to be executed just prior to returning from a method. This may include:
042     * <ul>
043     * <li>restoring callee-saved registers</li>
044     * <li>performing a safepoint</li>
045     * <li>destroying the stack frame</li>
046     * </ul>
047     */
048    void leave(CompilationResultBuilder crb);
049
050    /**
051     * Determines if a frame is set up and torn down by this object.
052     */
053    boolean hasFrame();
054}