1 /* 2 * Copyright (c) 2013, 2018, 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 */ 23 24 25 package org.graalvm.compiler.code; 26 27 import jdk.vm.ci.code.CodeCacheProvider; 28 import jdk.vm.ci.code.InstalledCode; 29 30 /** 31 * Interface providing capability for disassembling machine code. 32 */ 33 public interface DisassemblerProvider { 34 35 /** 36 * Gets a textual disassembly of a given compilation result. 37 * 38 * @param codeCache the object used for code {@link CodeCacheProvider#addCode code installation} 39 * @param compResult a compilation result 40 * @return a non-zero length string containing a disassembly of {@code compResult} or null it 41 * could not be disassembled 42 */ 43 default String disassembleCompiledCode(CodeCacheProvider codeCache, CompilationResult compResult) { 44 return null; 45 } 46 47 /** 48 * Gets a textual disassembly of a given installed code. 49 * 50 * @param codeCache the object used for code {@link CodeCacheProvider#addCode code installation} 51 * @param compResult a compiled code that was installed to produce {@code installedCode}. This 52 * will be null if not available. 53 * @param installedCode 54 * @return a non-zero length string containing a disassembly of {@code installedCode} or null if 55 * {@code installedCode} is {@link InstalledCode#isValid() invalid} or it could not be 56 * disassembled for some other reason 57 */ 58 default String disassembleInstalledCode(CodeCacheProvider codeCache, CompilationResult compResult, InstalledCode installedCode) { 59 return null; 60 } 61 62 /** 63 * Gets the name denoting the format of the disassembly returned by this object. 64 */ 65 String getName(); 66 }