001/*
002 * Copyright (c) 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 jdk.internal.jvmci.code.stack;
024
025import jdk.internal.jvmci.meta.*;
026
027public interface StackIntrospection {
028
029    /**
030     * Accesses the current stack, providing {@link InspectedFrame}s to the visitor that can be used
031     * to inspect the stack frames' contents. Iteration continues as long as
032     * {@link InspectedFrameVisitor#visitFrame}, which is invoked for every {@link InspectedFrame},
033     * returns null. Any non-null result of the visitor indicates that frame iteration should stop.
034     *
035     * @param initialMethods if this is non-{@code null}, then the stack trace will start at these
036     *            methods
037     * @param matchingMethods if this is non-{@code null}, then only matching stack frames are
038     *            returned
039     * @param initialSkip the number of matching methods to skip (including the initial method)
040     * @param visitor the visitor that is called for every matching method
041     * @return the last result returned by the visitor (which is non-null to indicate that iteration
042     *         should stop), or null if the whole stack was iterated.
043     */
044    <T> T iterateFrames(ResolvedJavaMethod[] initialMethods, ResolvedJavaMethod[] matchingMethods, int initialSkip, InspectedFrameVisitor<T> visitor);
045}