File: HsErrFileUtils.java

package info (click to toggle)
openjdk-21 21.0.10~4ea-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 823,260 kB
  • sloc: java: 5,638,490; xml: 1,643,607; cpp: 1,298,236; ansic: 421,374; asm: 404,850; objc: 21,018; sh: 15,085; javascript: 11,217; python: 6,895; makefile: 2,368; perl: 357; awk: 351; sed: 172; jsp: 24
file content (199 lines) | stat: -rw-r--r-- 9,901 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
 * Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2022, 2024 SAP SE. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

import jdk.test.lib.process.OutputAnalyzer;

import java.io.*;
import java.util.*;
import java.util.regex.Pattern;

public class HsErrFileUtils {

    /**
     * Given the output of a java VM that crashed, extract the name of the hs-err file from the output
     */
    public static String extractHsErrFileNameFromOutput(OutputAnalyzer output) {
        output.shouldMatch("# A fatal error has been detected.*");

        // extract hs-err file
        String hs_err_file = output.firstMatch("# *(\\S*hs_err_pid\\d+\\.log)", 1);
        if (hs_err_file == null) {
            throw new RuntimeException("Did not find hs-err file in output.\n");
        }

        return hs_err_file;
    }

    /**
     * Given the output of a java VM that crashed, extract the name of the hs-err file from the output,
     * open that file and return its File.
     */
    public static File openHsErrFileFromOutput(OutputAnalyzer output) {
        String name = extractHsErrFileNameFromOutput(output);
        File f = new File(name);
        if (!f.exists()) {
            throw new RuntimeException("Cannot find hs-err file at " + f.getAbsolutePath());
        }
        return f;
    }

    /**
     * Given an open hs-err file, read it line by line and check for existence of a set of patterns. Will fail
     * if patterns are missing, or if the END marker is missing.
     * @param f Input file
     * @param patterns An array of patterns that need to match, in that order
     * @param verbose If true, the content of the hs-err file is printed while matching. If false, only the matched patterns
     *                are printed.
     * @throws RuntimeException, {@link IOException}
     */
    public static void checkHsErrFileContent(File f, Pattern[] patterns, boolean verbose) throws IOException {
        checkHsErrFileContent(f, patterns, null, true, verbose, false);
    }

    /**
     * Given an open hs-err file, read it line by line and check for various conditions.
     * @param f input file
     * @param positivePatterns Optional array of patterns that need to appear, in given order, in the file. Missing
     *                        patterns cause the test to fail.
     * @param negativePatterns Optional array of patterns that must not appear in the file; test fails if they do.
     *                        Order is irrelevant.
     * @param checkEndMarker If true, we check for the final "END" in an hs-err file; if it is missing it indicates
     *                        that hs-err file printing did not complete successfully.
     * @param verbose If true, the content of the hs-err file is printed while matching. If false, only the matched patterns
     *                are printed.
     * @throws RuntimeException, {@link IOException}
     */
    public static void checkHsErrFileContent(File f, Pattern[] positivePatterns, Pattern[] negativePatterns, boolean checkEndMarker, boolean verbose) throws IOException {
        checkHsErrFileContent(f, positivePatterns, negativePatterns, checkEndMarker, verbose, false);
    }

    /**
     * Given an open hs-err file, read it line by line and check for existence of a set of patterns. Will fail
     * if patterns are missing, or if the END marker is missing.
     * @param f Input file
     * @param patterns An array of patterns that need to match, in that order
     * @param verbose If true, the content of the hs-err file is printed while matching. If false, only the matched patterns
     *                are printed.
     * @param printHserrOnError If true, the content of the hs-err file is printed in case of a failing check
     * @throws RuntimeException, {@link IOException}
     */
    public static void checkHsErrFileContent(File f, Pattern[] patterns, boolean verbose, boolean printHserrOnError) throws IOException {
        checkHsErrFileContent(f, patterns, null, true, verbose, printHserrOnError);
    }

    /**
     * Given an open hs-err file, read it line by line and check for various conditions.
     * @param f input file
     * @param positivePatterns Optional array of patterns that need to appear, in given order, in the file. Missing
     *                        patterns cause the test to fail.
     * @param negativePatterns Optional array of patterns that must not appear in the file; test fails if they do.
     *                        Order is irrelevant.
     * @param checkEndMarker If true, we check for the final "END" in an hs-err file; if it is missing it indicates
     *                        that hs-err file printing did not complete successfully.
     * @param verbose If true, the content of the hs-err file is printed while matching. If false, only the matched patterns
     *                are printed.
     * @param printHserrOnError If true, the content of the hs-err file is printed in case of a failing check
     * @throws RuntimeException, {@link IOException}
     */
    public static void checkHsErrFileContent(File f, Pattern[] positivePatterns, Pattern[] negativePatterns, boolean checkEndMarker, boolean verbose, boolean printHserrOnError) throws IOException {
        try (
                FileInputStream fis = new FileInputStream(f);
                BufferedReader br = new BufferedReader(new InputStreamReader(fis));
        ) {
            String line = null;
            String lastLine = null;
            int lineNo = 0;

            Deque<Pattern> positivePatternStack = new ArrayDeque<Pattern>();
            if (positivePatterns != null) {
                Collections.addAll(positivePatternStack, positivePatterns);
            }
            Pattern currentPositivePattern = positivePatternStack.pollFirst();

            while ((line = br.readLine()) != null) {
                if (verbose) {
                    System.out.println(line);
                }
                if (currentPositivePattern != null) {
                    if (currentPositivePattern.matcher(line).matches()) {
                        if (!verbose) {
                            System.out.println(line);
                        }
                        System.out.println("^^^ Matches " + currentPositivePattern + " at line " + lineNo + "^^^");
                        currentPositivePattern = positivePatternStack.pollFirst();
                        if (currentPositivePattern == null && negativePatterns == null && checkEndMarker == false) {
                            System.out.println("Lazily skipping the rest of the hs-err file...");
                            break; // Shortcut. Nothing to do.
                        }
                    }
                }
                if (negativePatterns != null) {
                    for (Pattern negativePattern : negativePatterns) {
                        if (negativePattern.matcher(line).matches()) {
                            if (!verbose) {
                                System.out.println(line);
                            }
                            System.out.println("^^^ Forbidden pattern found at line " + lineNo + ": " + negativePattern + "^^^");
                            if (printHserrOnError) {
                                printHsErrFile(f);
                            }
                            throw new RuntimeException("Forbidden pattern found at line " + lineNo + ": " + negativePattern);
                        }
                    }
                }
                lastLine = line;
                lineNo++;
            }
            // If the current pattern is not null then it didn't match
            if (currentPositivePattern != null) {
                if (printHserrOnError) {
                    printHsErrFile(f);
                }
                throw new RuntimeException("hs-err file incomplete (first missing pattern: " + currentPositivePattern.pattern() + ")");
            }
            if (checkEndMarker && !lastLine.equals("END.")) {
                if (printHserrOnError) {
                    printHsErrFile(f);
                }
                throw new RuntimeException("hs-err file incomplete (missing END marker.)");
            }
            System.out.println("hs-err file " + f.getAbsolutePath() + " scanned successfully.");
        }
    }

    private static void printHsErrFile(File f) throws IOException {
        try (
                FileInputStream fis = new FileInputStream(f);
                BufferedReader br = new BufferedReader(new InputStreamReader(fis));
        ) {
            String line;
            System.out.println("------------------------ hs-err file ------------------------");
            while ((line = br.readLine()) != null) {
                System.out.println(line);
            }
            System.out.println("-------------------------------------------------------------");
        }
    }

}