1 /*
   2  * Copyright (c) 2012, 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 org.graalvm.compiler.lir.asm;
  24 
  25 /**
  26  * Code for managing a method's native frame.
  27  */
  28 public interface FrameContext {
  29 
  30     /**
  31      * Emits code common to all entry points of a method. This may include:
  32      * <ul>
  33      * <li>setting up the stack frame</li>
  34      * <li>saving callee-saved registers</li>
  35      * <li>stack overflow checking</li>
  36      * </ul>
  37      */
  38     void enter(CompilationResultBuilder crb);
  39 
  40     /**
  41      * Emits code to be executed just prior to returning from a method. This may include:
  42      * <ul>
  43      * <li>restoring callee-saved registers</li>
  44      * <li>performing a safepoint</li>
  45      * <li>destroying the stack frame</li>
  46      * </ul>
  47      */
  48     void leave(CompilationResultBuilder crb);
  49 
  50     /**
  51      * Determines if a frame is set up and torn down by this object.
  52      */
  53     boolean hasFrame();
  54 }