001/*
002 * Copyright (c) 2014, 2014, 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.gen;
024
025import com.oracle.graal.lir.*;
026import com.oracle.graal.lir.framemap.*;
027import com.oracle.graal.lir.stackslotalloc.*;
028
029public interface LIRGenerationResult {
030
031    /**
032     * Returns the {@link FrameMapBuilder} for collecting the information to build a
033     * {@link FrameMap}.
034     *
035     * This method can only be used prior calling {@link #buildFrameMap}.
036     */
037    FrameMapBuilder getFrameMapBuilder();
038
039    /**
040     * Creates a {@link FrameMap} out of the {@link FrameMapBuilder}. This method should only be
041     * called once. After calling it, {@link #getFrameMapBuilder()} can no longer be used.
042     *
043     * @see FrameMapBuilder#buildFrameMap
044     */
045    void buildFrameMap(StackSlotAllocator allocator);
046
047    /**
048     * Returns the {@link FrameMap} associated with this {@link LIRGenerationResult}.
049     *
050     * This method can only be called after {@link #buildFrameMap}.
051     */
052    FrameMap getFrameMap();
053
054    LIR getLIR();
055
056    boolean hasForeignCall();
057
058    void setForeignCall(boolean b);
059
060    String getCompilationUnitName();
061}