undefect. CWE-407 — 63 sites patched across 27 ecosystems
Authors: russell@unturf.com · brackishbert@gmail.com · foxhop.net · TimeHexOn.com Patches, unit tests, benchmarks, whitepaper, and outreach briefs. Public domain — no copyright claimed. Use freely.
This commit is contained in:
commit
0a580b313d
70422 changed files with 17213626 additions and 0 deletions
|
|
@ -0,0 +1,435 @@
|
|||
/*
|
||||
* Copyright (c) 2015, 2024, 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.
|
||||
*/
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.lang.management.LockInfo;
|
||||
import java.lang.management.ManagementFactory;
|
||||
import java.lang.management.MonitorInfo;
|
||||
import java.lang.management.ThreadInfo;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.atomic.AtomicLong;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.LogManager;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
|
||||
/**
|
||||
* @test
|
||||
* @bug 8077846
|
||||
* @key randomness
|
||||
* @summary Test that using a reentrant configuration lock does not introduce
|
||||
* new synchronization issues in Logger and LogManager. This test
|
||||
* focuses more particularly on potential deadlock in
|
||||
* drainLoggerRefQueueBounded / readConfiguration / reset
|
||||
* todo: add at randomness
|
||||
* @modules java.logging
|
||||
* java.management
|
||||
* @run main/othervm TestConfigurationLock
|
||||
* @author danielfuchs
|
||||
*/
|
||||
// This test is a best effort to try & detect issues. The test itself will run
|
||||
// for 8secs. This might be unsufficient to detect issues.
|
||||
// To get a greater confidence it is recommended to run this test in a loop:
|
||||
// e.g. use something like:
|
||||
// $ while jtreg -jdk:$JDK -verbose:all \
|
||||
// test/java/util/logging/TestConfigurationLock.java ; \
|
||||
// do echo Running test again ; done
|
||||
// and let it run for a few hours...
|
||||
//
|
||||
public class TestConfigurationLock {
|
||||
|
||||
static volatile Exception thrown = null;
|
||||
static volatile boolean goOn = true;
|
||||
static volatile boolean deadlock = false;
|
||||
|
||||
static final double CONFSYNCTHRESHOLD = 0.3;
|
||||
static final double LOGSYNCTHRESHOLD = 0.3;
|
||||
static final int RESETERS = 0;
|
||||
static final int READERS = 3;
|
||||
static final int LOGGERS = 4;
|
||||
static final long TIME = 8 * 1000; // 8 sec.
|
||||
static final long STEP = 1 * 1000; // message every 1 sec.
|
||||
static final int LCOUNT = 50; // 50 loggers created in a row...
|
||||
static final AtomicLong nextLogger = new AtomicLong(0);
|
||||
static final AtomicLong resetCount = new AtomicLong(0);
|
||||
static final AtomicLong readCount = new AtomicLong(0);
|
||||
static final AtomicLong checkCount = new AtomicLong(0);
|
||||
|
||||
static final String BLAH = "blah";
|
||||
|
||||
static Object fakeConfExternalLock() {
|
||||
return LogManager.getLogManager();
|
||||
}
|
||||
|
||||
static Object fakeLogExternalLock() {
|
||||
return LogManager.getLogManager();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The test starts a number of threads that will call
|
||||
* LogManager.reset() concurrently (ResetConf), and a number of threads
|
||||
* that will call readConfiguration() (ReadConf), and then starts a
|
||||
* number of threads that will create new loggers concurrently
|
||||
* (AddLogger), and finally two additional threads:
|
||||
* - one (Stopper) that will stop the test after 4secs (TIME ms),
|
||||
* - and one DeadlockDetector that will attempt to detect deadlocks.
|
||||
* If after 4secs no deadlock was detected and no exception was thrown
|
||||
* then the test is considered a success and passes.
|
||||
*
|
||||
* Note that 4sec may not be enough to detect issues if there are some.
|
||||
* This is a best effort test.
|
||||
*
|
||||
* @param args the command line arguments
|
||||
* @throws java.lang.Exception if the test fails
|
||||
*/
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
File conf = new File(System.getProperty("test.src", "./src"),
|
||||
TestConfigurationLock.class.getSimpleName() + ".properties");
|
||||
if (!conf.canRead()) {
|
||||
throw new IOException("Can't read config file: " + conf.getAbsolutePath());
|
||||
}
|
||||
System.setProperty("java.util.logging.config.file", conf.getAbsolutePath());
|
||||
test();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Starts all threads, wait 4secs, then stops all threads.
|
||||
* @throws Exception if a deadlock was detected or an error occurred.
|
||||
*/
|
||||
public static void test() throws Exception {
|
||||
goOn = true;
|
||||
thrown = null;
|
||||
long sNextLogger = nextLogger.get();
|
||||
long sUpdateCount = resetCount.get();
|
||||
long sReadCount = readCount.get();
|
||||
long sCheckCount = checkCount.get();
|
||||
List<Thread> threads = new ArrayList<>();
|
||||
for (int i = 0; i<RESETERS; i++) {
|
||||
threads.add(new ResetConf());
|
||||
}
|
||||
for (int i = 0; i<READERS; i++) {
|
||||
threads.add(new ReadConf());
|
||||
}
|
||||
for (int i = 0; i<LOGGERS; i++) {
|
||||
threads.add(new AddLogger());
|
||||
}
|
||||
threads.add(0, new Stopper(TIME));
|
||||
threads.stream().forEach(Thread::start);
|
||||
|
||||
Thread deadLockDetector = new DeadlockDetector();
|
||||
deadLockDetector.start();
|
||||
deadLockDetector.join();
|
||||
|
||||
if (!deadlock) {
|
||||
threads.stream().forEach(TestConfigurationLock::join);
|
||||
} else {
|
||||
System.err.println("Deadlock found: exiting forcibly.");
|
||||
Runtime.getRuntime().halt(-1);
|
||||
}
|
||||
|
||||
if (thrown != null) {
|
||||
throw thrown;
|
||||
}
|
||||
System.out.println("Passed: " + (nextLogger.get() - sNextLogger)
|
||||
+ " loggers created by " + LOGGERS + " Thread(s),");
|
||||
System.out.println("\t LogManager.reset() called "
|
||||
+ (resetCount.get() - sUpdateCount) + " times by " + RESETERS
|
||||
+ " Thread(s).");
|
||||
System.out.println("\t LogManager.readConfiguration() called "
|
||||
+ (readCount.get() - sReadCount) + " times by " + READERS
|
||||
+ " Thread(s).");
|
||||
System.out.println("\t ThreadMXBean.findDeadlockedThreads called "
|
||||
+ (checkCount.get() -sCheckCount) + " times by 1 Thread.");
|
||||
|
||||
}
|
||||
|
||||
static void join(Thread t) {
|
||||
try {
|
||||
t.join();
|
||||
} catch (Exception x) {
|
||||
fail(x);
|
||||
}
|
||||
}
|
||||
|
||||
static final class ResetConf extends Thread {
|
||||
|
||||
public ResetConf() {
|
||||
setDaemon(true);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
while (goOn) {
|
||||
try {
|
||||
if (Math.random() > CONFSYNCTHRESHOLD) {
|
||||
// calling reset while holding a lock can increase
|
||||
// deadlock probability...
|
||||
synchronized(fakeConfExternalLock()) {
|
||||
LogManager.getLogManager().reset();
|
||||
}
|
||||
} else {
|
||||
LogManager.getLogManager().reset();
|
||||
}
|
||||
Logger blah = Logger.getLogger(BLAH);
|
||||
blah.setLevel(Level.FINEST);
|
||||
blah.fine(BLAH);
|
||||
resetCount.incrementAndGet();
|
||||
pause(1);
|
||||
} catch (Exception x) {
|
||||
fail(x);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static final class ReadConf extends Thread {
|
||||
|
||||
public ReadConf() {
|
||||
setDaemon(true);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
while (goOn) {
|
||||
try {
|
||||
if (Math.random() > CONFSYNCTHRESHOLD) {
|
||||
// calling readConfiguration while holding a lock can
|
||||
// increase deadlock probability...
|
||||
synchronized(fakeConfExternalLock()) {
|
||||
LogManager.getLogManager().readConfiguration();
|
||||
}
|
||||
} else {
|
||||
LogManager.getLogManager().readConfiguration();
|
||||
}
|
||||
Logger blah = Logger.getLogger(BLAH);
|
||||
blah.setLevel(Level.FINEST);
|
||||
blah.fine(BLAH);
|
||||
readCount.incrementAndGet();
|
||||
pause(1);
|
||||
} catch (Exception x) {
|
||||
fail(x);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static final class AddLogger extends Thread {
|
||||
|
||||
public AddLogger() {
|
||||
setDaemon(true);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
while (goOn) {
|
||||
Logger l;
|
||||
Logger foo = Logger.getLogger("foo");
|
||||
Logger bar = Logger.getLogger("foo.bar");
|
||||
for (int i=0; i < LCOUNT ; i++) {
|
||||
LogManager manager = LogManager.getLogManager();
|
||||
if (Math.random() > LOGSYNCTHRESHOLD) {
|
||||
synchronized(fakeLogExternalLock()) {
|
||||
l = Logger.getLogger("foo.bar.l"+nextLogger.incrementAndGet());
|
||||
}
|
||||
} else {
|
||||
l = Logger.getLogger("foo.bar.l"+nextLogger.incrementAndGet());
|
||||
}
|
||||
l.setLevel(Level.FINEST);
|
||||
l.fine("I'm fine");
|
||||
if (!goOn) break;
|
||||
pause(1);
|
||||
}
|
||||
}
|
||||
} catch (InterruptedException | RuntimeException x ) {
|
||||
fail(x);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static final class DeadlockDetector extends Thread {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
boolean deadlock = false;
|
||||
while(goOn) {
|
||||
try {
|
||||
long[] ids = ManagementFactory.getThreadMXBean().findDeadlockedThreads();
|
||||
checkCount.incrementAndGet();
|
||||
ids = ids == null ? new long[0] : ids;
|
||||
if (ids.length == 1) {
|
||||
throw new RuntimeException("Found 1 deadlocked thread: "+ids[0]);
|
||||
} else if (ids.length > 0) {
|
||||
deadlock = true;
|
||||
ThreadInfo[] infos = ManagementFactory.getThreadMXBean()
|
||||
.getThreadInfo(ids, true, true);
|
||||
System.err.println("Found "+ids.length+" deadlocked threads: ");
|
||||
for (ThreadInfo inf : infos) {
|
||||
System.err.println(asString(inf));
|
||||
}
|
||||
throw new RuntimeException("Found "+ids.length+" deadlocked threads");
|
||||
}
|
||||
pause(100);
|
||||
} catch(InterruptedException | RuntimeException x) {
|
||||
if (deadlock) deadlock(x);
|
||||
else fail(x);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static final class Stopper extends Thread {
|
||||
long start;
|
||||
long time;
|
||||
|
||||
Stopper(long time) {
|
||||
start = System.currentTimeMillis();
|
||||
this.time = time;
|
||||
setDaemon(true);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
long rest, previous;
|
||||
int msgCount = 0;
|
||||
previous = time;
|
||||
Logger logger = Logger.getLogger("remaining");
|
||||
while (goOn && (rest = start - System.currentTimeMillis() + time) > 0) {
|
||||
if (previous == time || previous - rest >= STEP) {
|
||||
logger.log(Level.INFO, "{0}ms remaining...", String.valueOf(rest));
|
||||
msgCount++;
|
||||
previous = rest == time ? rest -1 : rest;
|
||||
System.gc();
|
||||
}
|
||||
if (goOn == false) break;
|
||||
pause(Math.min(rest, 100));
|
||||
}
|
||||
System.err.println(this + ": " + msgCount + " messages.");
|
||||
System.err.flush();
|
||||
System.out.println(System.currentTimeMillis() - start
|
||||
+ " ms elapsed ("+time+ " requested)");
|
||||
goOn = false;
|
||||
} catch(InterruptedException | RuntimeException x) {
|
||||
fail(x);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// ThreadInfo.toString() only prints 8 frames...
|
||||
static String asString(ThreadInfo inf) {
|
||||
StringBuilder sb = new StringBuilder();
|
||||
sb.append("\"").append(inf.getThreadName()).append("\"")
|
||||
.append(inf.isDaemon() ? " daemon" : "")
|
||||
.append(" prio=").append(inf.getPriority())
|
||||
.append(" Id=").append(inf.getThreadId())
|
||||
.append(" ").append(inf.getThreadState());
|
||||
if (inf.getLockName() != null) {
|
||||
sb.append(" on ").append(inf.getLockName());
|
||||
}
|
||||
if (inf.getLockOwnerName() != null) {
|
||||
sb.append(" owned by \"").append(inf.getLockOwnerName())
|
||||
.append("\" Id=").append(inf.getLockOwnerId());
|
||||
}
|
||||
if (inf.isSuspended()) {
|
||||
sb.append(" (suspended)");
|
||||
}
|
||||
if (inf.isInNative()) {
|
||||
sb.append(" (in native)");
|
||||
}
|
||||
sb.append('\n');
|
||||
int i = 0;
|
||||
StackTraceElement[] stackTrace = inf.getStackTrace();
|
||||
for (; i < stackTrace.length; i++) {
|
||||
StackTraceElement ste = stackTrace[i];
|
||||
sb.append("\tat ").append(ste.toString());
|
||||
sb.append('\n');
|
||||
if (i == 0 && inf.getLockInfo() != null) {
|
||||
Thread.State ts = inf.getThreadState();
|
||||
switch (ts) {
|
||||
case BLOCKED:
|
||||
sb.append("\t- blocked on ").append(inf.getLockInfo());
|
||||
sb.append('\n');
|
||||
break;
|
||||
case WAITING:
|
||||
sb.append("\t- waiting on ").append(inf.getLockInfo());
|
||||
sb.append('\n');
|
||||
break;
|
||||
case TIMED_WAITING:
|
||||
sb.append("\t- waiting on ").append(inf.getLockInfo());
|
||||
sb.append('\n');
|
||||
break;
|
||||
default:
|
||||
}
|
||||
}
|
||||
|
||||
for (MonitorInfo mi : inf.getLockedMonitors()) {
|
||||
if (mi.getLockedStackDepth() == i) {
|
||||
sb.append("\t- locked ").append(mi);
|
||||
sb.append('\n');
|
||||
}
|
||||
}
|
||||
}
|
||||
if (i < stackTrace.length) {
|
||||
sb.append("\t...");
|
||||
sb.append('\n');
|
||||
}
|
||||
|
||||
LockInfo[] locks = inf.getLockedSynchronizers();
|
||||
if (locks.length > 0) {
|
||||
sb.append("\n\tNumber of locked synchronizers = ").append(locks.length);
|
||||
sb.append('\n');
|
||||
for (LockInfo li : locks) {
|
||||
sb.append("\t- ").append(li);
|
||||
sb.append('\n');
|
||||
}
|
||||
}
|
||||
sb.append('\n');
|
||||
return sb.toString();
|
||||
}
|
||||
|
||||
static void pause(long millis) throws InterruptedException {
|
||||
Thread.sleep(millis);
|
||||
}
|
||||
|
||||
static void fail(Exception x) {
|
||||
x.printStackTrace(System.err);
|
||||
if (thrown == null) {
|
||||
thrown = x;
|
||||
}
|
||||
goOn = false;
|
||||
}
|
||||
|
||||
static void deadlock(Exception x) {
|
||||
deadlock = true;
|
||||
System.out.flush();
|
||||
fail(x);
|
||||
System.err.flush();
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue