001/*
002 * Copyright (c) 2013, 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.code;
024
025import jdk.internal.jvmci.code.*;
026
027/**
028 * Interface providing capability for disassembling machine code.
029 */
030public interface DisassemblerProvider {
031
032    /**
033     * Gets a textual disassembly of a given compilation result.
034     *
035     * @param codeCache the object used for code {@link CodeCacheProvider#addMethod code
036     *            installation}
037     * @param compResult a compilation result
038     * @return a non-zero length string containing a disassembly of {@code compResult} or null it
039     *         could not be disassembled
040     */
041    default String disassembleCompiledCode(CodeCacheProvider codeCache, CompilationResult compResult) {
042        return null;
043    }
044
045    /**
046     * Gets a textual disassembly of a given installed code.
047     *
048     * @param codeCache the object used for code {@link CodeCacheProvider#addMethod code
049     *            installation}
050     * @param compResult a compiled code that was installed to produce {@code installedCode}. This
051     *            will be null if not available.
052     * @param installedCode
053     * @return a non-zero length string containing a disassembly of {@code code} or null if
054     *         {@code code} is {@link InstalledCode#isValid() invalid} or it could not be
055     *         disassembled for some other reason
056     */
057    default String disassembleInstalledCode(CodeCacheProvider codeCache, CompilationResult compResult, InstalledCode installedCode) {
058        return null;
059    }
060
061    /**
062     * Gets the name denoting the format of the disassmembly return by this object.
063     */
064    String getName();
065}