DisassemblerProvider.java revision 12651:6ef01bd40ce2 
1/*
2 * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23package org.graalvm.compiler.code;
24
25import jdk.vm.ci.code.CodeCacheProvider;
26import jdk.vm.ci.code.InstalledCode;
27
28/**
29 * Interface providing capability for disassembling machine code.
30 */
31public interface DisassemblerProvider {
32
33    /**
34     * Gets a textual disassembly of a given compilation result.
35     *
36     * @param codeCache the object used for code {@link CodeCacheProvider#addCode code installation}
37     * @param compResult a compilation result
38     * @return a non-zero length string containing a disassembly of {@code compResult} or null it
39     *         could not be disassembled
40     */
41    default String disassembleCompiledCode(CodeCacheProvider codeCache, CompilationResult compResult) {
42        return null;
43    }
44
45    /**
46     * Gets a textual disassembly of a given installed code.
47     *
48     * @param codeCache the object used for code {@link CodeCacheProvider#addCode code installation}
49     * @param compResult a compiled code that was installed to produce {@code installedCode}. This
50     *            will be null if not available.
51     * @param installedCode
52     * @return a non-zero length string containing a disassembly of {@code installedCode} or null if
53     *         {@code installedCode} is {@link InstalledCode#isValid() invalid} or it could not be
54     *         disassembled for some other reason
55     */
56    default String disassembleInstalledCode(CodeCacheProvider codeCache, CompilationResult compResult, InstalledCode installedCode) {
57        return null;
58    }
59
60    /**
61     * Gets the name denoting the format of the disassmembly return by this object.
62     */
63    String getName();
64}
65