/*
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.max.cri.ci;

import com.oracle.max.cri.ri.*;

public interface CiCompiler {

    /**
     * Denotes the level of debug info for safepoints that should be generated by a compilation.
     */
    enum DebugInfoLevel {
        /**
         * Only ref maps are required.
         */
        REF_MAPS,

        /**
         * Code positions and ref maps are required.
         */
        CODE_POS_AND_REF_MAPS,

        /**
         * Frame info, code positions and ref maps are required.
         * Only a compilation with level can make speculative optimizations.
         */
        FULL
    }

    /**
     * Compile the specified method.
     *
     * @param method the method to compile
     * @param osrBCI the bytecode index of the entrypoint for an on-stack-replacement or {@code -1} if this is not an
     *            on-stack-replacement compilation
     * @param debugInfoLevel TODO
     */
    CiResult compileMethod(RiResolvedMethod method, int osrBCI, CiStatistics stats, DebugInfoLevel debugInfoLevel);
}