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