|
| 1 | +/* |
| 2 | + * Copyright (c) 2013, 2021, 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 | +package org.openjdk.bench.util; |
| 25 | + |
| 26 | +import java.io.ByteArrayOutputStream; |
| 27 | +import java.io.IOException; |
| 28 | +import java.io.OutputStream; |
| 29 | + |
| 30 | +import java.net.URI; |
| 31 | +import java.util.ArrayList; |
| 32 | +import java.util.Arrays; |
| 33 | +import java.util.List; |
| 34 | + |
| 35 | +import javax.tools.ForwardingJavaFileManager; |
| 36 | +import javax.tools.FileObject; |
| 37 | +import javax.tools.JavaCompiler; |
| 38 | +import javax.tools.JavaCompiler.CompilationTask; |
| 39 | +import javax.tools.JavaFileManager; |
| 40 | +import javax.tools.JavaFileObject; |
| 41 | +import javax.tools.JavaFileObject.Kind; |
| 42 | +import javax.tools.SimpleJavaFileObject; |
| 43 | +import javax.tools.StandardLocation; |
| 44 | +import javax.tools.ToolProvider; |
| 45 | + |
| 46 | +/** |
| 47 | + * {@code InMemoryJavaCompiler} can be used for compiling a {@link |
| 48 | + * CharSequence} to a {@code byte[]}. |
| 49 | + * |
| 50 | + * The compiler will not use the file system at all, instead using a {@link |
| 51 | + * ByteArrayOutputStream} for storing the byte code. For the source code, any |
| 52 | + * kind of {@link CharSequence} can be used, e.g. {@link String}, {@link |
| 53 | + * StringBuffer} or {@link StringBuilder}. |
| 54 | + * |
| 55 | + * The {@code InMemoryCompiler} can easily be used together with a {@code |
| 56 | + * ByteClassLoader} to easily compile and load source code in a {@link String}: |
| 57 | + * |
| 58 | + * <pre> |
| 59 | + * {@code |
| 60 | + * import jdk.test.lib.compiler.InMemoryJavaCompiler; |
| 61 | + * import jdk.test.lib.ByteClassLoader; |
| 62 | + * |
| 63 | + * class Example { |
| 64 | + * public static void main(String[] args) { |
| 65 | + * String className = "Foo"; |
| 66 | + * String sourceCode = "public class " + className + " {" + |
| 67 | + * " public void bar() {" + |
| 68 | + * " System.out.println("Hello from bar!");" + |
| 69 | + * " }" + |
| 70 | + * "}"; |
| 71 | + * byte[] byteCode = InMemoryJavaCompiler.compile(className, sourceCode); |
| 72 | + * Class fooClass = ByteClassLoader.load(className, byteCode); |
| 73 | + * } |
| 74 | + * } |
| 75 | + * } |
| 76 | + * </pre> |
| 77 | + */ |
| 78 | +public class InMemoryJavaCompiler { |
| 79 | + private static class MemoryJavaFileObject extends SimpleJavaFileObject { |
| 80 | + private final String className; |
| 81 | + private final CharSequence sourceCode; |
| 82 | + private final ByteArrayOutputStream byteCode; |
| 83 | + |
| 84 | + public MemoryJavaFileObject(String className, CharSequence sourceCode) { |
| 85 | + super(URI.create("string:///" + className.replace('.','/') + Kind.SOURCE.extension), Kind.SOURCE); |
| 86 | + this.className = className; |
| 87 | + this.sourceCode = sourceCode; |
| 88 | + this.byteCode = new ByteArrayOutputStream(); |
| 89 | + } |
| 90 | + |
| 91 | + @Override |
| 92 | + public CharSequence getCharContent(boolean ignoreEncodingErrors) { |
| 93 | + return sourceCode; |
| 94 | + } |
| 95 | + |
| 96 | + @Override |
| 97 | + public OutputStream openOutputStream() throws IOException { |
| 98 | + return byteCode; |
| 99 | + } |
| 100 | + |
| 101 | + public byte[] getByteCode() { |
| 102 | + return byteCode.toByteArray(); |
| 103 | + } |
| 104 | + |
| 105 | + public String getClassName() { |
| 106 | + return className; |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + private static class FileManagerWrapper extends ForwardingJavaFileManager<JavaFileManager> { |
| 111 | + private static final Location PATCH_LOCATION = new Location() { |
| 112 | + @Override |
| 113 | + public String getName() { |
| 114 | + return "patch module location"; |
| 115 | + } |
| 116 | + |
| 117 | + @Override |
| 118 | + public boolean isOutputLocation() { |
| 119 | + return false; |
| 120 | + } |
| 121 | + }; |
| 122 | + private final MemoryJavaFileObject file; |
| 123 | + private final String moduleOverride; |
| 124 | + |
| 125 | + public FileManagerWrapper(MemoryJavaFileObject file, String moduleOverride) { |
| 126 | + super(getCompiler().getStandardFileManager(null, null, null)); |
| 127 | + this.file = file; |
| 128 | + this.moduleOverride = moduleOverride; |
| 129 | + } |
| 130 | + |
| 131 | + @Override |
| 132 | + public JavaFileObject getJavaFileForOutput(Location location, String className, |
| 133 | + Kind kind, FileObject sibling) |
| 134 | + throws IOException { |
| 135 | + if (!file.getClassName().equals(className)) { |
| 136 | + throw new IOException("Expected class with name " + file.getClassName() + |
| 137 | + ", but got " + className); |
| 138 | + } |
| 139 | + return file; |
| 140 | + } |
| 141 | + |
| 142 | + @Override |
| 143 | + public Location getLocationForModule(Location location, JavaFileObject fo) throws IOException { |
| 144 | + if (fo == file && moduleOverride != null) { |
| 145 | + return PATCH_LOCATION; |
| 146 | + } |
| 147 | + return super.getLocationForModule(location, fo); |
| 148 | + } |
| 149 | + |
| 150 | + @Override |
| 151 | + public String inferModuleName(Location location) throws IOException { |
| 152 | + if (location == PATCH_LOCATION) { |
| 153 | + return moduleOverride; |
| 154 | + } |
| 155 | + return super.inferModuleName(location); |
| 156 | + } |
| 157 | + |
| 158 | + @Override |
| 159 | + public boolean hasLocation(Location location) { |
| 160 | + return super.hasLocation(location) || location == StandardLocation.PATCH_MODULE_PATH; |
| 161 | + } |
| 162 | + |
| 163 | + } |
| 164 | + |
| 165 | + /** |
| 166 | + * Compiles the class with the given name and source code. |
| 167 | + * |
| 168 | + * @param className The name of the class |
| 169 | + * @param sourceCode The source code for the class with name {@code className} |
| 170 | + * @param options additional command line options |
| 171 | + * @throws RuntimeException if the compilation did not succeed |
| 172 | + * @return The resulting byte code from the compilation |
| 173 | + */ |
| 174 | + public static byte[] compile(String className, CharSequence sourceCode, String... options) { |
| 175 | + MemoryJavaFileObject file = new MemoryJavaFileObject(className, sourceCode); |
| 176 | + CompilationTask task = getCompilationTask(file, options); |
| 177 | + |
| 178 | + if(!task.call()) { |
| 179 | + throw new RuntimeException("Could not compile " + className + " with source code " + sourceCode); |
| 180 | + } |
| 181 | + |
| 182 | + return file.getByteCode(); |
| 183 | + } |
| 184 | + |
| 185 | + private static JavaCompiler getCompiler() { |
| 186 | + return ToolProvider.getSystemJavaCompiler(); |
| 187 | + } |
| 188 | + |
| 189 | + private static CompilationTask getCompilationTask(MemoryJavaFileObject file, String... options) { |
| 190 | + List<String> opts = new ArrayList<>(); |
| 191 | + String moduleOverride = null; |
| 192 | + for (String opt : options) { |
| 193 | + if (opt.startsWith("--patch-module=")) { |
| 194 | + moduleOverride = opt.substring("--patch-module=".length()); |
| 195 | + } else { |
| 196 | + opts.add(opt); |
| 197 | + } |
| 198 | + } |
| 199 | + return getCompiler().getTask(null, new FileManagerWrapper(file, moduleOverride), null, opts, null, Arrays.asList(file)); |
| 200 | + } |
| 201 | +} |
0 commit comments