1 /*
2 * Copyright (c) 2014, 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 import java.io.File;
26 import java.io.FileOutputStream;
27 import jdk.test.lib.process.OutputAnalyzer;
28 import java.nio.file.Files;
29
30 import java.util.*;
31 import jdk.internal.org.objectweb.asm.*;
32
33 /**
34 * The testsets contained in this class are executed by ./VerifierTest_*.java, so that
35 * individual testsets can be executed in parallel to shorten the total time required.
36 */
37 public class VerifierTest implements Opcodes {
38 // Test verification settings for dumping & runtime
39 static final String VFY_ALL = "-Xverify:all";
40 static final String VFY_REMOTE = "-Xverify:remote"; // default
41 static final String VFY_NONE = "-Xverify:none";
42
43 static final String ERR =
44 "ERROR: class VerifierTestC was loaded unexpectedly";
45 static final String MAP_FAIL =
46 "shared archive file was created with less restrictive verification setting";
47 static final String VFY_ERR = "java.lang.VerifyError";
48 static final String PASS_RESULT = "Hi, how are you?";
49 static final String VFY_INFO_MESSAGE =
50 "All non-system classes will be verified (-Xverify:remote) during CDS dump time.";
51 static final String CDS_LOGGING = "-Xlog:cds,cds+hashtables";
52
53 enum Testset1Part {
54 A, B
55 }
56
57 public static void main(String[] args) throws Exception {
58 String subCaseId = args[0];
59 String jarName_verifier_test_tmp = "verifier_test_tmp" + "_" + subCaseId;
60 String jarName_verifier_test = "verifier_test" + "_" + subCaseId;
61 String jarName_greet = "greet" + "_" + subCaseId;
62 String jarName_hi = "hi" + "_" + subCaseId;
63
64
65 JarBuilder.build(jarName_verifier_test_tmp, "VerifierTest0", "VerifierTestA",
66 "VerifierTestB", "VerifierTestC", "VerifierTestD", "VerifierTestE",
67 "UnverifiableBase", "UnverifiableIntf", "UnverifiableIntfSub");
68 JarBuilder.build(jarName_greet, "Greet");
69 JarBuilder.build(jarName_hi, "Hi", "Hi$MyClass");
70
71 File dir = new File(System.getProperty("test.classes", "."));
72 File jarSrcFile = new File(dir, jarName_verifier_test_tmp + ".jar");
73 File jarFile = new File(dir, jarName_verifier_test + ".jar");
74 String jar = jarFile.getPath();
75
76 if (!jarFile.exists() || jarFile.lastModified() < jarSrcFile.lastModified()) {
77 createTestJarFile(jarSrcFile, jarFile);
78 } else {
79 System.out.println("Already up-to-date: " + jarFile);
80 }
81
82 String noAppClasses[] = TestCommon.list("");
83 String appClasses[] = TestCommon.list("UnverifiableBase",
84 "UnverifiableIntf",
85 "UnverifiableIntfSub",
86 "VerifierTestA",
87 "VerifierTestB",
88 "VerifierTestC",
89 "VerifierTestD",
90 "VerifierTestE",
91 "VerifierTest0");
92
93
94 switch (subCaseId) {
95 case "0": testset_0(jar, noAppClasses, appClasses); return;
96 case "1A": testset_1(jar, noAppClasses, appClasses, Testset1Part.A); return;
97 case "1B": testset_1(jar, noAppClasses, appClasses, Testset1Part.B); return;
98 case "2": testset_2(jarName_greet, jarName_hi); return;
99 default:
100 throw new RuntimeException("Unknown option: " + subCaseId);
101 }
102 }
103
104 static void testset_0(String jar, String[] noAppClasses, String[] appClasses) throws Exception {
105 // Dumping should fail if the IgnoreUnverifiableClassesDuringDump
106 // option is not enabled.
107 OutputAnalyzer output = TestCommon.dump(jar, appClasses,
108 CDS_LOGGING,
109 "-XX:+UnlockDiagnosticVMOptions",
110 "-XX:-IgnoreUnverifiableClassesDuringDump");
111 output.shouldContain("Please remove the unverifiable classes");
112 output.shouldHaveExitValue(1);
113
114 // By default, bad classes should be ignored during dumping.
115 TestCommon.testDump(jar, appClasses);
116 }
117
118 static void checkRuntimeOutput(OutputAnalyzer output, String expected) throws Exception {
119 output.shouldContain(expected);
120 if (expected.equals(PASS_RESULT) ||
121 expected.equals(VFY_ERR)) {
122 output.shouldHaveExitValue(0);
123 } else {
124 output.shouldNotHaveExitValue(0);
125 }
126 }
127
128 static void testset_1(String jar, String[] noAppClasses, String[] appClasses, Testset1Part part)
129 throws Exception
130 {
131 String config[][] = {
132 // {dump_list, dumptime_verification_setting,
133 // runtime_verification_setting, expected_output_str},
134
135 // Dump app/ext with -Xverify:remote
136 {"app", VFY_REMOTE, VFY_REMOTE, VFY_ERR},
137 {"app", VFY_REMOTE, VFY_ALL, MAP_FAIL},
138 {"app", VFY_REMOTE, VFY_NONE, ERR },
139 // Dump app/ext with -Xverify:all
140 {"app", VFY_ALL, VFY_REMOTE, VFY_ERR },
141 {"app", VFY_ALL, VFY_ALL, VFY_ERR },
142 {"app", VFY_ALL, VFY_NONE, ERR },
143 // Dump app/ext with -Xverify:none
144 {"app", VFY_NONE, VFY_REMOTE, VFY_ERR},
145 {"app", VFY_NONE, VFY_ALL, MAP_FAIL},
146 {"app", VFY_NONE, VFY_NONE, ERR },
147 // Dump sys only with -Xverify:remote
148 {"noApp", VFY_REMOTE, VFY_REMOTE, VFY_ERR},
149 {"noApp", VFY_REMOTE, VFY_ALL, VFY_ERR},
150 {"noApp", VFY_REMOTE, VFY_NONE, ERR},
151 // Dump sys only with -Xverify:all
152 {"noApp", VFY_ALL, VFY_REMOTE, VFY_ERR},
153 {"noApp", VFY_ALL, VFY_ALL, VFY_ERR},
154 {"noApp", VFY_ALL, VFY_NONE, ERR},
155 // Dump sys only with -Xverify:none
156 {"noApp", VFY_NONE, VFY_REMOTE, VFY_ERR},
157 {"noApp", VFY_NONE, VFY_ALL, VFY_ERR},
158 {"noApp", VFY_NONE, VFY_NONE, ERR},
159 };
160
161 int loop_start, loop_stop;
162
163 // Further break down testset_1 into two parts (to be invoked from VerifierTest_1A.java
164 // and VerifierTest_1B.java) to improve parallel test execution time.
165 switch (part) {
166 case A:
167 loop_start = 0;
168 loop_stop = 9;
169 break;
170 case B:
171 default:
172 assert part == Testset1Part.B;
173 loop_start = 9;
174 loop_stop = config.length;
175 break;
176 }
177
178 String prev_dump_setting = "";
179 for (int i = loop_start; i < loop_stop; i ++) {
180 String dump_list[] = config[i][0].equals("app") ? appClasses :
181 noAppClasses;
182 String dump_setting = config[i][1];
183 String runtime_setting = config[i][2];
184 String expected_output_str = config[i][3];
185 System.out.println("Test case [" + i + "]: dumping " + config[i][0] +
186 " with " + dump_setting +
187 ", run with " + runtime_setting);
188 if (!dump_setting.equals(prev_dump_setting)) {
189 OutputAnalyzer dumpOutput = TestCommon.dump(
190 jar, dump_list, dump_setting,
191 CDS_LOGGING,
192 // FIXME: the following options are for working around a GC
193 // issue - assert failure when dumping archive with the -Xverify:all
194 "-Xms256m",
195 "-Xmx256m");
196 if (dump_setting.equals(VFY_NONE) &&
197 runtime_setting.equals(VFY_REMOTE)) {
198 dumpOutput.shouldContain(VFY_INFO_MESSAGE);
199 }
200 }
201 TestCommon.run("-cp", jar,
202 runtime_setting,
203 "VerifierTest0")
204 .ifNoMappingFailure(output -> checkRuntimeOutput(output, expected_output_str));
205 prev_dump_setting = dump_setting;
206 }
207 }
208
209 static void testset_2(String jarName_greet, String jarName_hi) throws Exception {
210 String appClasses[];
211 String jar;
212
213 // The following section is for testing the scenarios where
214 // the classes are verifiable during dump time.
215 appClasses = TestCommon.list("Hi",
216 "Greet",
217 "Hi$MyClass");
218 jar = TestCommon.getTestJar(jarName_hi + ".jar") + File.pathSeparator +
219 TestCommon.getTestJar(jarName_greet + ".jar");
220 String config2[][] = {
221 // {dump_list, dumptime_verification_setting,
222 // runtime_verification_setting, expected_output_str},
223
224 // Dump app/ext with -Xverify:remote
225 {"app", VFY_REMOTE, VFY_REMOTE, PASS_RESULT},
226 {"app", VFY_REMOTE, VFY_ALL, MAP_FAIL},
227 {"app", VFY_REMOTE, VFY_NONE, PASS_RESULT },
228 // Dump app/ext with -Xverify:all
229 {"app", VFY_ALL, VFY_REMOTE, PASS_RESULT },
230 {"app", VFY_ALL, VFY_ALL, PASS_RESULT },
231 {"app", VFY_ALL, VFY_NONE, PASS_RESULT },
232 // Dump app/ext with -Xverify:none
233 {"app", VFY_NONE, VFY_REMOTE, PASS_RESULT},
234 {"app", VFY_NONE, VFY_ALL, MAP_FAIL},
235 {"app", VFY_NONE, VFY_NONE, PASS_RESULT },
236 };
237 String prev_dump_setting = "";
238 for (int i = 0; i < config2.length; i ++) {
239 // config2[i][0] is always set to "app" in this test
240 String dump_setting = config2[i][1];
241 String runtime_setting = config2[i][2];
242 String expected_output_str = config2[i][3];
243 System.out.println("Test case [" + i + "]: dumping " + config2[i][0] +
244 " with " + dump_setting +
245 ", run with " + runtime_setting);
246 if (!dump_setting.equals(prev_dump_setting)) {
247 OutputAnalyzer dumpOutput = TestCommon.dump(
248 jar, appClasses, dump_setting,
249 CDS_LOGGING,
250 // FIXME: the following options are for working around a GC
251 // issue - assert failure when dumping archive with the -Xverify:all
252 "-Xms256m",
253 "-Xmx256m");
254 if (dump_setting.equals(VFY_NONE) &&
255 runtime_setting.equals(VFY_REMOTE)) {
256 dumpOutput.shouldContain(VFY_INFO_MESSAGE);
257 }
258 }
259 TestCommon.run("-cp", jar,
260 runtime_setting,
261 "Hi")
262 .ifNoMappingFailure(output -> checkRuntimeOutput(output, expected_output_str));
263 prev_dump_setting = dump_setting;
264 }
265 }
266
267 static void createTestJarFile(File jarSrcFile, File jarFile) throws Exception {
268 jarFile.delete();
269 Files.copy(jarSrcFile.toPath(), jarFile.toPath());
270
271 File dir = new File(System.getProperty("test.classes", "."));
272 File outdir = new File(dir, "verifier_test_classes");
273 outdir.mkdir();
274
275 writeClassFile(new File(outdir, "UnverifiableBase.class"), makeUnverifiableBase());
276 writeClassFile(new File(outdir, "UnverifiableIntf.class"), makeUnverifiableIntf());
277
278 JarBuilder.update(jarFile.getPath(), outdir.getPath());
279 }
280
281 static void writeClassFile(File file, byte bytecodes[]) throws Exception {
282 try (FileOutputStream fos = new FileOutputStream(file)) {
283 fos.write(bytecodes);
284 }
285 }
286
287 // This was obtained using JDK8: java jdk.internal.org.objectweb.asm.util.ASMifier tmpclasses/UnverifiableBase.class
288 static byte[] makeUnverifiableBase() throws Exception {
289 ClassWriter cw = new ClassWriter(0);
290 FieldVisitor fv;
291 MethodVisitor mv;
292 AnnotationVisitor av0;
293
294 cw.visit(V1_8, ACC_SUPER, "UnverifiableBase", null, "java/lang/Object", null);
295 {
296 fv = cw.visitField(ACC_FINAL + ACC_STATIC, "x", "LVerifierTest;", null, null);
297 fv.visitEnd();
298 }
299 {
300 mv = cw.visitMethod(0, "<init>", "()V", null, null);
301 mv.visitCode();
302 mv.visitVarInsn(ALOAD, 0);
303 mv.visitMethodInsn(INVOKESPECIAL, "java/lang/Object", "<init>", "()V", false);
304 mv.visitInsn(RETURN);
305 mv.visitMaxs(1, 1);
306 mv.visitEnd();
307 }
308 {
309 mv = cw.visitMethod(ACC_STATIC, "<clinit>", "()V", null, null);
310 mv.visitCode();
311 mv.visitTypeInsn(NEW, "VerifierTest0");
312 mv.visitInsn(DUP);
313 mv.visitMethodInsn(INVOKESPECIAL, "VerifierTest0", "<init>", "()V", false);
314 mv.visitFieldInsn(PUTSTATIC, "UnverifiableBase", "x", "LVerifierTest;");
315 mv.visitInsn(RETURN);
316 mv.visitMaxs(2, 0);
317 mv.visitEnd();
318 }
319 addBadMethod(cw);
320 cw.visitEnd();
321
322 return cw.toByteArray();
323 }
324
325 // This was obtained using JDK8: java jdk.internal.org.objectweb.asm.util.ASMifier tmpclasses/UnverifiableIntf.class
326 static byte[] makeUnverifiableIntf() throws Exception {
327 ClassWriter cw = new ClassWriter(0);
328 FieldVisitor fv;
329 MethodVisitor mv;
330 AnnotationVisitor av0;
331
332 cw.visit(V1_8, ACC_ABSTRACT + ACC_INTERFACE, "UnverifiableIntf", null, "java/lang/Object", null);
333
334 {
335 fv = cw.visitField(ACC_PUBLIC + ACC_FINAL + ACC_STATIC, "x", "LVerifierTest0;", null, null);
336 fv.visitEnd();
337 }
338 {
339 mv = cw.visitMethod(ACC_STATIC, "<clinit>", "()V", null, null);
340 mv.visitCode();
341 mv.visitTypeInsn(NEW, "VerifierTest0");
342 mv.visitInsn(DUP);
343 mv.visitMethodInsn(INVOKESPECIAL, "VerifierTest0", "<init>", "()V", false);
344 mv.visitFieldInsn(PUTSTATIC, "UnverifiableIntf", "x", "LVerifierTest0;");
345 mv.visitInsn(RETURN);
346 mv.visitMaxs(2, 0);
347 mv.visitEnd();
348 }
349 addBadMethod(cw);
350 cw.visitEnd();
351
352 return cw.toByteArray();
353 }
354
355 // Add a bad method to make the class fail verification.
356 static void addBadMethod(ClassWriter cw) throws Exception {
357 MethodVisitor mv = cw.visitMethod(ACC_PUBLIC, "bad", "()V", null, null);
358 mv.visitCode();
359 mv.visitInsn(ARETURN); // java.lang.VerifyError: Operand stack underflow
360 mv.visitMaxs(2, 2);
361 mv.visitEnd();
362 }
363 }