/*
 * Copyright (c) 2020, 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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 org.graalvm.compiler.core.common;

import jdk.vm.ci.meta.ResolvedJavaMethod;

A profiling service that consumes compilation related events. The Java Flight Recorder (JFR) is
an example of such a service that can be exposed via this interface.
/**
 * A profiling service that consumes compilation related events. The Java Flight Recorder (JFR) is
 * an example of such a service that can be exposed via this interface.
 */
public interface CompilerProfiler {

    
Get current value of the profiler's time counter.
Returns:
the number of profile-defined time units that have elapsed/**
     * Get current value of the profiler's time counter.
     *
     * @return the number of profile-defined time units that have elapsed
     */
    long getTicks();

    
Notifies JFR when a compiler phase ends.
Params:
compileId – current computation unit id
startTime – when the phase started
name – name of the phase
nestingLevel – how many ancestor phases there are of the phase/**
     * Notifies JFR when a compiler phase ends.
     *
     * @param compileId current computation unit id
     * @param startTime when the phase started
     * @param name name of the phase
     * @param nestingLevel how many ancestor phases there are of the phase
     */
    void notifyCompilerPhaseEvent(int compileId, long startTime, String name, int nestingLevel);

    
Notifies JFR when the compiler considers inlining callee into caller. 
Params:
compileId – current computation unit id
caller – caller method
callee – callee method considered for inlining into caller
succeeded – true if callee was inlined into caller
message – extra information about inlining decision
bci – byte code index of call site/**
     * Notifies JFR when the compiler considers inlining {@code callee} into {@code caller}.
     *
     * @param compileId current computation unit id
     * @param caller caller method
     * @param callee callee method considered for inlining into {@code caller}
     * @param succeeded true if {@code callee} was inlined into {@code caller}
     * @param message extra information about inlining decision
     * @param bci byte code index of call site
     */
    void notifyCompilerInlingEvent(int compileId, ResolvedJavaMethod caller, ResolvedJavaMethod callee, boolean succeeded, String message, int bci);
}