8059767: FileHandler should allow 'long' limits and handle overflow of MeteredStream.written.
Summary: FileHandler now uses 'long' for limit and MeteredStream.written. It also reads a long for limit from the configuration, and has a new constructor allowing to pass a 'long' for limit.
Reviewed-by: alanb, igerasim, mchung
--- a/jdk/src/java.logging/share/classes/java/util/logging/FileHandler.java Wed Oct 22 10:41:07 2014 +0100
+++ b/jdk/src/java.logging/share/classes/java/util/logging/FileHandler.java Wed Oct 22 17:23:14 2014 +0200
@@ -150,7 +150,7 @@
public class FileHandler extends StreamHandler {
private MeteredStream meter;
private boolean append;
- private int limit; // zero => no limit.
+ private long limit; // zero => no limit.
private int count;
private String pattern;
private String lockFileName;
@@ -164,11 +164,11 @@
* (a) forwards all its output to a target stream
* (b) keeps track of how many bytes have been written
*/
- private class MeteredStream extends OutputStream {
+ private static final class MeteredStream extends OutputStream {
final OutputStream out;
- int written;
+ long written;
- MeteredStream(OutputStream out, int written) {
+ MeteredStream(OutputStream out, long written) {
this.out = out;
this.written = written;
}
@@ -203,9 +203,9 @@
}
private void open(File fname, boolean append) throws IOException {
- int len = 0;
+ long len = 0;
if (append) {
- len = (int)fname.length();
+ len = fname.length();
}
FileOutputStream fout = new FileOutputStream(fname.toString(), append);
BufferedOutputStream bout = new BufferedOutputStream(fout);
@@ -223,7 +223,7 @@
String cname = getClass().getName();
pattern = manager.getStringProperty(cname + ".pattern", "%h/java%u.log");
- limit = manager.getIntProperty(cname + ".limit", 0);
+ limit = manager.getLongProperty(cname + ".limit", 0);
if (limit < 0) {
limit = 0;
}
@@ -395,6 +395,39 @@
*/
public FileHandler(String pattern, int limit, int count, boolean append)
throws IOException, SecurityException {
+ this(pattern, (long)limit, count, append);
+ }
+
+ /**
+ * Initialize a {@code FileHandler} to write to a set of files
+ * with optional append. When (approximately) the given limit has
+ * been written to one file, another file will be opened. The
+ * output will cycle through a set of count files.
+ * <p>
+ * The {@code FileHandler} is configured based on {@code LogManager}
+ * properties (or their default values) except that the given pattern
+ * argument is used as the filename pattern, the file limit is
+ * set to the limit argument, and the file count is set to the
+ * given count argument, and the append mode is set to the given
+ * {@code append} argument.
+ * <p>
+ * The count must be at least 1.
+ *
+ * @param pattern the pattern for naming the output file
+ * @param limit the maximum number of bytes to write to any one file
+ * @param count the number of files to use
+ * @param append specifies append mode
+ * @exception IOException if there are IO problems opening the files.
+ * @exception SecurityException if a security manager exists and if
+ * the caller does not have {@code LoggingPermission("control")}.
+ * @exception IllegalArgumentException if {@code limit < 0}, or {@code count < 1}.
+ * @exception IllegalArgumentException if pattern is an empty string
+ *
+ * @since 1.9
+ *
+ */
+ public FileHandler(String pattern, long limit, int count, boolean append)
+ throws IOException {
if (limit < 0 || count < 1 || pattern.length() < 1) {
throw new IllegalArgumentException();
}
@@ -690,7 +723,7 @@
}
super.publish(record);
flush();
- if (limit > 0 && meter.written >= limit) {
+ if (limit > 0 && (meter.written >= limit || meter.written < 0)) {
// We performed access checks in the "init" method to make sure
// we are only initialized from trusted code. So we assume
// it is OK to write the target files, even if we are
--- a/jdk/src/java.logging/share/classes/java/util/logging/LogManager.java Wed Oct 22 10:41:07 2014 +0100
+++ b/jdk/src/java.logging/share/classes/java/util/logging/LogManager.java Wed Oct 22 17:23:14 2014 +0200
@@ -1387,6 +1387,21 @@
}
}
+ // Package private method to get a long property.
+ // If the property is not defined or cannot be parsed
+ // we return the given default value.
+ long getLongProperty(String name, long defaultValue) {
+ String val = getProperty(name);
+ if (val == null) {
+ return defaultValue;
+ }
+ try {
+ return Long.parseLong(val.trim());
+ } catch (Exception ex) {
+ return defaultValue;
+ }
+ }
+
// Package private method to get a boolean property.
// If the property is not defined or cannot be parsed
// we return the given default value.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/test/java/util/logging/FileHandlerLongLimit.java Wed Oct 22 17:23:14 2014 +0200
@@ -0,0 +1,504 @@
+/*
+ * Copyright (c) 2014, 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.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.FilePermission;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.lang.reflect.Field;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.security.CodeSource;
+import java.security.Permission;
+import java.security.PermissionCollection;
+import java.security.Permissions;
+import java.security.Policy;
+import java.security.ProtectionDomain;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.Properties;
+import java.util.UUID;
+import java.util.concurrent.Callable;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.logging.FileHandler;
+import java.util.logging.Level;
+import java.util.logging.LogManager;
+import java.util.logging.LogRecord;
+import java.util.logging.LoggingPermission;
+
+/**
+ * @test
+ * @bug 8059767
+ * @summary tests that FileHandler can accept a long limit.
+ * @run main/othervm FileHandlerLongLimit UNSECURE
+ * @run main/othervm FileHandlerLongLimit SECURE
+ * @author danielfuchs
+ */
+public class FileHandlerLongLimit {
+
+ /**
+ * We will test handling of limit and overflow of MeteredStream.written in
+ * two configurations.
+ * UNSECURE: No security manager.
+ * SECURE: With the security manager present - and the required
+ * permissions granted.
+ */
+ public static enum TestCase {
+ UNSECURE, SECURE;
+ public void run(Properties propertyFile) throws Exception {
+ System.out.println("Running test case: " + name());
+ Configure.setUp(this, propertyFile);
+ test(this.name() + " " + propertyFile.getProperty("test.name"), propertyFile,
+ Long.parseLong(propertyFile.getProperty(FileHandler.class.getName()+".limit")));
+ }
+ }
+
+
+ private static final String PREFIX =
+ "FileHandler-" + UUID.randomUUID() + ".log";
+ private static final String userDir = System.getProperty("user.dir", ".");
+ private static final boolean userDirWritable = Files.isWritable(Paths.get(userDir));
+ private static final Field limitField;
+ private static final Field meterField;
+ private static final Field writtenField;
+ private static final Field outField;
+
+ private static final List<Properties> properties;
+ static {
+ Properties props1 = new Properties();
+ Properties props2 = new Properties();
+ Properties props3 = new Properties();
+ props1.setProperty("test.name", "with limit=Integer.MAX_VALUE");
+ props1.setProperty(FileHandler.class.getName() + ".pattern", PREFIX);
+ props1.setProperty(FileHandler.class.getName() + ".limit", String.valueOf(Integer.MAX_VALUE));
+ props2.setProperty("test.name", "with limit=Integer.MAX_VALUE*4");
+ props2.setProperty(FileHandler.class.getName() + ".pattern", PREFIX);
+ props2.setProperty(FileHandler.class.getName() + ".limit", String.valueOf(((long)Integer.MAX_VALUE)*4));
+ props3.setProperty("test.name", "with limit=Long.MAX_VALUE - 1024");
+ props3.setProperty(FileHandler.class.getName() + ".pattern", PREFIX);
+ props3.setProperty(FileHandler.class.getName() + ".limit", String.valueOf(Long.MAX_VALUE - 1024));
+ properties = Collections.unmodifiableList(Arrays.asList(
+ props1,
+ props2,
+ props3));
+ try {
+ Class<?> metteredStreamClass = Class.forName(FileHandler.class.getName()+"$MeteredStream");
+ limitField = FileHandler.class.getDeclaredField("limit");
+ limitField.setAccessible(true);
+ meterField = FileHandler.class.getDeclaredField("meter");
+ meterField.setAccessible(true);
+ writtenField = metteredStreamClass.getDeclaredField("written");
+ writtenField.setAccessible(true);
+ outField = metteredStreamClass.getDeclaredField("out");
+ outField.setAccessible(true);
+
+ } catch (NoSuchFieldException | ClassNotFoundException x) {
+ throw new ExceptionInInitializerError(x);
+ }
+ }
+
+ private static class TestOutputStream extends OutputStream {
+ final OutputStream delegate;
+ TestOutputStream(OutputStream delegate) {
+ this.delegate = delegate;
+ }
+ @Override
+ public void write(int b) throws IOException {
+ // do nothing - we only pretend to write something...
+ }
+ @Override
+ public void close() throws IOException {
+ delegate.close();
+ }
+
+ @Override
+ public void flush() throws IOException {
+ delegate.flush();
+ }
+
+ }
+
+ public static void main(String... args) throws Exception {
+
+
+ if (args == null || args.length == 0) {
+ args = new String[] {
+ TestCase.UNSECURE.name(),
+ TestCase.SECURE.name(),
+ };
+ }
+
+ try {
+ for (String testName : args) {
+ for (Properties propertyFile : properties) {
+ TestCase test = TestCase.valueOf(testName);
+ test.run(propertyFile);
+ }
+ }
+ } finally {
+ if (userDirWritable) {
+ Configure.doPrivileged(() -> {
+ // cleanup - delete files that have been created
+ try {
+ Files.list(Paths.get(userDir))
+ .filter((f) -> f.toString().contains(PREFIX))
+ .forEach((f) -> {
+ try {
+ System.out.println("deleting " + f);
+ Files.delete(f);
+ } catch(Throwable t) {
+ System.err.println("Failed to delete " + f + ": " + t);
+ }
+ });
+ } catch(Throwable t) {
+ System.err.println("Cleanup failed to list files: " + t);
+ t.printStackTrace();
+ }
+ });
+ }
+ }
+ }
+
+ static class Configure {
+ static Policy policy = null;
+ static final AtomicBoolean allowAll = new AtomicBoolean(false);
+ static void setUp(TestCase test, Properties propertyFile) {
+ switch (test) {
+ case SECURE:
+ if (policy == null && System.getSecurityManager() != null) {
+ throw new IllegalStateException("SecurityManager already set");
+ } else if (policy == null) {
+ policy = new SimplePolicy(TestCase.SECURE, allowAll);
+ Policy.setPolicy(policy);
+ System.setSecurityManager(new SecurityManager());
+ }
+ if (System.getSecurityManager() == null) {
+ throw new IllegalStateException("No SecurityManager.");
+ }
+ if (policy == null) {
+ throw new IllegalStateException("policy not configured");
+ }
+ break;
+ case UNSECURE:
+ if (System.getSecurityManager() != null) {
+ throw new IllegalStateException("SecurityManager already set");
+ }
+ break;
+ default:
+ new InternalError("No such testcase: " + test);
+ }
+ doPrivileged(() -> {
+ try {
+ ByteArrayOutputStream bytes = new ByteArrayOutputStream();
+ propertyFile.store(bytes, propertyFile.getProperty("test.name"));
+ ByteArrayInputStream bais = new ByteArrayInputStream(bytes.toByteArray());
+ LogManager.getLogManager().readConfiguration(bais);
+ } catch (IOException ex) {
+ throw new RuntimeException(ex);
+ }
+ });
+ }
+ static void doPrivileged(Runnable run) {
+ allowAll.set(true);
+ try {
+ run.run();
+ } finally {
+ allowAll.set(false);
+ }
+ }
+ static <T> T callPrivileged(Callable<T> call) throws Exception {
+ allowAll.set(true);
+ try {
+ return call.call();
+ } finally {
+ allowAll.set(false);
+ }
+ }
+ }
+
+ @FunctionalInterface
+ public static interface FileHandlerSupplier {
+ public FileHandler test() throws Exception;
+ }
+
+ private static void checkException(Class<? extends Exception> type, FileHandlerSupplier test) {
+ Throwable t = null;
+ FileHandler f = null;
+ try {
+ f = test.test();
+ } catch (Throwable x) {
+ t = x;
+ }
+ try {
+ if (type != null && t == null) {
+ throw new RuntimeException("Expected " + type.getName() + " not thrown");
+ } else if (type != null && t != null) {
+ if (type.isInstance(t)) {
+ System.out.println("Recieved expected exception: " + t);
+ } else {
+ throw new RuntimeException("Exception type mismatch: "
+ + type.getName() + " expected, "
+ + t.getClass().getName() + " received.", t);
+ }
+ } else if (t != null) {
+ throw new RuntimeException("Unexpected exception received: " + t, t);
+ }
+ } finally {
+ if (f != null) {
+ // f should always be null when an exception is expected,
+ // but in case the test doesn't behave as expected we will
+ // want to close f.
+ try { f.close(); } catch (Throwable x) {};
+ }
+ }
+ }
+
+ static final class TestAssertException extends RuntimeException {
+ TestAssertException(String msg) {
+ super(msg);
+ }
+ }
+
+ private static void assertEquals(long expected, long received, String msg) {
+ if (expected != received) {
+ throw new TestAssertException("Unexpected result for " + msg
+ + ".\n\texpected: " + expected
+ + "\n\tactual: " + received);
+ } else {
+ System.out.println("Got expected " + msg + ": " + received);
+ }
+ }
+
+ private static long getLimit(FileHandler handler) throws Exception {
+ return Configure.callPrivileged((Callable<Long>)() -> {
+ return limitField.getLong(handler);
+ });
+ }
+ private static OutputStream getMeteredOutput(FileHandler handler) throws Exception {
+ return Configure.callPrivileged((Callable<OutputStream>)() -> {
+ final OutputStream metered = OutputStream.class.cast(meterField.get(handler));
+ return metered;
+ });
+ }
+ private static TestOutputStream setTestOutputStream(OutputStream metered) throws Exception {
+ return Configure.callPrivileged((Callable<TestOutputStream>)() -> {
+ outField.set(metered, new TestOutputStream(OutputStream.class.cast(outField.get(metered))));
+ return TestOutputStream.class.cast(outField.get(metered));
+ });
+ }
+ private static long getWritten(OutputStream metered) throws Exception {
+ return Configure.callPrivileged((Callable<Long>)() -> {
+ return writtenField.getLong(metered);
+ });
+ }
+
+ private static long setWritten(OutputStream metered, long newValue) throws Exception {
+ return Configure.callPrivileged((Callable<Long>)() -> {
+ writtenField.setLong(metered, newValue);
+ return writtenField.getLong(metered);
+ });
+ }
+
+ public static FileHandler testFileHandlerLimit(FileHandlerSupplier supplier,
+ long limit) throws Exception {
+ Configure.doPrivileged(() -> {
+ try {
+ Files.deleteIfExists(Paths.get(PREFIX));
+ } catch (IOException x) {
+ throw new RuntimeException(x);
+ }
+ });
+ final FileHandler fh = supplier.test();
+ try {
+ // verify we have the expected limit
+ assertEquals(limit, getLimit(fh), "limit");
+
+ // get the metered output stream
+ OutputStream metered = getMeteredOutput(fh);
+
+ // we don't want to actually write to the file, so let's
+ // redirect the metered to our own TestOutputStream.
+ setTestOutputStream(metered);
+
+ // check that fh.meter.written is 0
+ assertEquals(0, getWritten(metered), "written");
+
+ // now we're going to publish a series of log records
+ String msg = "this is at least 10 chars long";
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+ long w = getWritten(metered);
+ long offset = getWritten(metered);
+ System.out.println("first offset is: " + offset);
+
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+ offset = getWritten(metered) - w;
+ w = getWritten(metered);
+ System.out.println("second offset is: " + offset);
+
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+ offset = getWritten(metered) - w;
+ w = getWritten(metered);
+ System.out.println("third offset is: " + offset);
+
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+ offset = getWritten(metered) - w;
+ System.out.println("fourth offset is: " + offset);
+
+ // Now set fh.meter.written to something close to the limit,
+ // so that we can trigger log file rotation.
+ assertEquals(limit-2*offset+10, setWritten(metered, limit-2*offset+10), "written");
+ w = getWritten(metered);
+
+ // publish one more log record. we should still be just beneath
+ // the limit
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+ assertEquals(w+offset, getWritten(metered), "written");
+
+ // check that fh still has the same MeteredStream - indicating
+ // that the file hasn't rotated.
+ if (getMeteredOutput(fh) != metered) {
+ throw new RuntimeException("Log should not have rotated");
+ }
+
+ // Now publish two log record. The spec is a bit vague about when
+ // exactly the log will be rotated - it could happen just after
+ // writing the first log record or just before writing the next
+ // one. We publich two - so we're sure that the log must have
+ // rotated.
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+ fh.publish(new LogRecord(Level.SEVERE, msg));
+ fh.flush();
+
+ // Check that fh.meter is a different instance of MeteredStream.
+ if (getMeteredOutput(fh) == metered) {
+ throw new RuntimeException("Log should have rotated");
+ }
+ // success!
+ return fh;
+ } catch (Error | Exception x) {
+ // if we get an exception we need to close fh.
+ // if we don't get an exception, fh will be closed by the caller.
+ // (and that's why we dont use try-with-resources/finally here).
+ try { fh.close(); } catch(Throwable t) {t.printStackTrace();}
+ throw x;
+ }
+ }
+
+ public static void test(String name, Properties props, long limit) throws Exception {
+ System.out.println("Testing: " + name);
+ Class<? extends Exception> expectedException = null;
+
+ if (userDirWritable || expectedException != null) {
+ // These calls will create files in user.dir.
+ // The file name contain a random UUID (PREFIX) which identifies them
+ // and allow us to remove them cleanly at the end (see finally block
+ // in main()).
+ checkException(expectedException, () -> new FileHandler());
+ checkException(expectedException, () -> {
+ final FileHandler fh = new FileHandler();
+ assertEquals(limit, getLimit(fh), "limit");
+ return fh;
+ });
+ checkException(expectedException, () -> testFileHandlerLimit(
+ () -> new FileHandler(),
+ limit));
+ checkException(expectedException, () -> testFileHandlerLimit(
+ () -> new FileHandler(PREFIX, Long.MAX_VALUE, 1, true),
+ Long.MAX_VALUE));
+ }
+ }
+
+
+ final static class PermissionsBuilder {
+ final Permissions perms;
+ public PermissionsBuilder() {
+ this(new Permissions());
+ }
+ public PermissionsBuilder(Permissions perms) {
+ this.perms = perms;
+ }
+ public PermissionsBuilder add(Permission p) {
+ perms.add(p);
+ return this;
+ }
+ public PermissionsBuilder addAll(PermissionCollection col) {
+ if (col != null) {
+ for (Enumeration<Permission> e = col.elements(); e.hasMoreElements(); ) {
+ perms.add(e.nextElement());
+ }
+ }
+ return this;
+ }
+ public Permissions toPermissions() {
+ final PermissionsBuilder builder = new PermissionsBuilder();
+ builder.addAll(perms);
+ return builder.perms;
+ }
+ }
+
+ public static class SimplePolicy extends Policy {
+
+ final Permissions permissions;
+ final Permissions allPermissions;
+ final AtomicBoolean allowAll;
+ public SimplePolicy(TestCase test, AtomicBoolean allowAll) {
+ this.allowAll = allowAll;
+ permissions = new Permissions();
+ permissions.add(new LoggingPermission("control", null));
+ permissions.add(new FilePermission(PREFIX+".lck", "read,write,delete"));
+ permissions.add(new FilePermission(PREFIX, "read,write"));
+
+ // these are used for configuring the test itself...
+ allPermissions = new Permissions();
+ allPermissions.add(new java.security.AllPermission());
+
+ }
+
+ @Override
+ public boolean implies(ProtectionDomain domain, Permission permission) {
+ if (allowAll.get()) return allPermissions.implies(permission);
+ return permissions.implies(permission);
+ }
+
+ @Override
+ public PermissionCollection getPermissions(CodeSource codesource) {
+ return new PermissionsBuilder().addAll(allowAll.get()
+ ? allPermissions : permissions).toPermissions();
+ }
+
+ @Override
+ public PermissionCollection getPermissions(ProtectionDomain domain) {
+ return new PermissionsBuilder().addAll(allowAll.get()
+ ? allPermissions : permissions).toPermissions();
+ }
+ }
+
+}