File: StreamHandlerLockingTest.java

package info (click to toggle)
openjdk-25 25.0.1%2B8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 825,408 kB
  • sloc: java: 5,585,680; cpp: 1,333,948; xml: 1,321,242; ansic: 488,034; asm: 404,003; objc: 21,088; sh: 15,106; javascript: 13,265; python: 8,319; makefile: 2,518; perl: 357; awk: 351; pascal: 103; exp: 83; sed: 72; jsp: 24
file content (105 lines) | stat: -rw-r--r-- 3,920 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright (c) 2025, Oracle and/or its affiliates. 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.
 */

/*
 * @test
 * @bug     8349206
 * @summary j.u.l.Handler classes create deadlock risk via synchronized publish() method.
 * @modules java.base/sun.util.logging
 *          java.logging
 * @build java.logging/java.util.logging.TestStreamHandler
 * @run main/othervm StreamHandlerLockingTest
 */

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.TestStreamHandler;

public class StreamHandlerLockingTest {
    static class TestFormatter extends Formatter {
        final Handler handler;

        TestFormatter(Handler handler) {
            this.handler = handler;
        }

        @Override
        public String format(LogRecord record) {
            if (Thread.holdsLock(handler)) {
                throw new AssertionError("format() was called with handler locked (bad).");
            }
            return record.getMessage() + "\n";
        }

        @Override
        public String getHead(Handler h) {
            // This is currently true, and not easy to make unsynchronized.
            if (!Thread.holdsLock(handler)) {
                throw new AssertionError("getHead() expected to be called with handler locked.");
            }
            return "--HEAD--\n";
        }

        @Override
        public String getTail(Handler h) {
            // This is currently true, and not easy to make unsynchronized.
            if (!Thread.holdsLock(handler)) {
                throw new AssertionError("getTail() expected to be called with handler locked.");
            }
            return "--TAIL--\n";
        }
    }

    private static final String EXPECTED_LOG =
            String.join("\n", "--HEAD--", "Hello World", "Some more logging...", "And we're done!", "--TAIL--", "");

    public static void main(String[] args) throws IOException {
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        TestStreamHandler handler = new TestStreamHandler(out);
        TestFormatter formatter = new TestFormatter(handler);
        handler.setFormatter(formatter);

        handler.publish(log("Hello World"));
        handler.publish(log("Some more logging..."));
        handler.publish(log("And we're done!"));
        handler.close();

        // Post write callback should have happened once per publish call (with lock held).
        if (handler.callbackCount != 3) {
            throw new AssertionError("Unexpected callback count: " + handler.callbackCount);
        }

        String logged = out.toString("UTF-8");
        if (!EXPECTED_LOG.equals(logged)) {
            throw new AssertionError("Unexpected log contents: " + logged);
        }
    }

    static LogRecord log(String msg) {
        return new LogRecord(Level.INFO, msg);
    }
}