1berry/openjdk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

8282648: Weaken the InflaterInputStream specification in order to allow faster Zip implementations

Browse Source 
Reviewed-by: lancea, alanb, jpai, mr, darcy
This commit is contained in:
Volker Simonis 2022-09-05 12:50:52 +00:00
parent e31c537f05
commit 2c61efe3de
7 changed files with 82 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/java.base/share/classes/java/net/URLConnection.java
View File

@ -840,6 +840,12 @@ public abstract class URLConnection {
* returned input stream if the read timeout expires before data
* is available for read.
*
* @apiNote The {@code InputStream} returned by this method can wrap an
* {@link java.util.zip.InflaterInputStream InflaterInputStream}, whose
* {@link java.util.zip.InflaterInputStream#read(byte[], int, int)
* read(byte[], int, int)} method can modify any element of the output
* buffer.
*
* @return an input stream that reads from this open connection.
* @throws IOException if an I/O error occurs while
* creating the input stream.

7
src/java.base/share/classes/java/util/jar/JarFile.java
View File

@ -822,6 +822,13 @@ public class JarFile extends ZipFile {
/**
* Returns an input stream for reading the contents of the specified
* zip file entry.
*
* @apiNote The {@code InputStream} returned by this method can wrap an
* {@link java.util.zip.InflaterInputStream InflaterInputStream}, whose
* {@link java.util.zip.InflaterInputStream#read(byte[], int, int)
* read(byte[], int, int)} method can modify any element of the output
* buffer.
*
* @param ze the zip file entry
* @return an input stream for reading the contents of the specified
* zip file entry or null if the zip file entry does not exist

19
src/java.base/share/classes/java/util/jar/JarInputStream.java
View File

@ -167,10 +167,21 @@ public class JarInputStream extends ZipInputStream {
}
/**
* Reads from the current JAR file entry into an array of bytes.
* If {@code len} is not zero, the method
* blocks until some input is available; otherwise, no
* bytes are read and {@code 0} is returned.
* Reads from the current JAR entry into an array of bytes, returning the number of
* inflated bytes. If {@code len} is not zero, the method blocks until some input is
* available; otherwise, no bytes are read and {@code 0} is returned.
* <p>
* If the current entry is compressed and this method returns a nonzero
* integer <i>n</i> then {@code buf[off]}
* through {@code buf[off+}<i>n</i>{@code -1]} contain the uncompressed
* data. The content of elements {@code buf[off+}<i>n</i>{@code ]} through
* {@code buf[off+}<i>len</i>{@code -1]} is undefined, contrary to the
* specification of the {@link java.io.InputStream InputStream} superclass,
* so an implementation is free to modify these elements during the inflate
* operation. If this method returns {@code -1} or throws an exception then
* the content of {@code buf[off]} through {@code buf[off+}<i>len</i>{@code
* -1]} is undefined.
* <p>
* If verification has been enabled, any invalid signature
* on the current entry will be reported at some point before the
* end of the entry is reached.

23
src/java.base/share/classes/java/util/zip/GZIPInputStream.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2022, 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
@ -92,13 +92,24 @@ public class GZIPInputStream extends InflaterInputStream {
}
/**
* Reads uncompressed data into an array of bytes. If {@code len} is not
* zero, the method will block until some input can be decompressed; otherwise,
* no bytes are read and {@code 0} is returned.
* Reads uncompressed data into an array of bytes, returning the number of inflated
* bytes. If {@code len} is not zero, the method will block until some input can be
* decompressed; otherwise, no bytes are read and {@code 0} is returned.
* <p>
* If this method returns a nonzero integer <i>n</i> then {@code buf[off]}
* through {@code buf[off+}<i>n</i>{@code -1]} contain the uncompressed
* data. The content of elements {@code buf[off+}<i>n</i>{@code ]} through
* {@code buf[off+}<i>len</i>{@code -1]} is undefined, contrary to the
* specification of the {@link java.io.InputStream InputStream} superclass,
* so an implementation is free to modify these elements during the inflate
* operation. If this method returns {@code -1} or throws an exception then
* the content of {@code buf[off]} through {@code buf[off+}<i>len</i>{@code
* -1]} is undefined.
*
* @param buf the buffer into which the data is read
* @param off the start offset in the destination array {@code b}
* @param off the start offset in the destination array {@code buf}
* @param len the maximum number of bytes read
* @return the actual number of bytes read, or -1 if the end of the
* @return the actual number of bytes inflated, or -1 if the end of the
* compressed input stream is reached
*
* @throws NullPointerException If {@code buf} is {@code null}.

19
src/java.base/share/classes/java/util/zip/InflaterInputStream.java
View File

@ -124,13 +124,24 @@ public class InflaterInputStream extends FilterInputStream {
}
/**
* Reads uncompressed data into an array of bytes. If {@code len} is not
* zero, the method will block until some input can be decompressed; otherwise,
* no bytes are read and {@code 0} is returned.
* Reads uncompressed data into an array of bytes, returning the number of inflated
* bytes. If {@code len} is not zero, the method will block until some input can be
* decompressed; otherwise, no bytes are read and {@code 0} is returned.
* <p>
* If this method returns a nonzero integer <i>n</i> then {@code buf[off]}
* through {@code buf[off+}<i>n</i>{@code -1]} contain the uncompressed
* data. The content of elements {@code buf[off+}<i>n</i>{@code ]} through
* {@code buf[off+}<i>len</i>{@code -1]} is undefined, contrary to the
* specification of the {@link java.io.InputStream InputStream} superclass,
* so an implementation is free to modify these elements during the inflate
* operation. If this method returns {@code -1} or throws an exception then
* the content of {@code buf[off]} through {@code buf[off+}<i>len</i>{@code
* -1]} is undefined.
*
* @param b the buffer into which the data is read
* @param off the start offset in the destination array {@code b}
* @param len the maximum number of bytes read
* @return the actual number of bytes read, or -1 if the end of the
* @return the actual number of bytes inflated, or -1 if the end of the
* compressed input is reached or a preset dictionary is needed
* @throws NullPointerException If {@code b} is {@code null}.
* @throws IndexOutOfBoundsException If {@code off} is negative,

6
src/java.base/share/classes/java/util/zip/ZipFile.java
View File

@ -343,6 +343,12 @@ public class ZipFile implements ZipConstants, Closeable {
* Closing this ZIP file will, in turn, close all input streams that
* have been returned by invocations of this method.
*
* @apiNote The {@code InputStream} returned by this method can wrap an
* {@link java.util.zip.InflaterInputStream InflaterInputStream}, whose
* {@link java.util.zip.InflaterInputStream#read(byte[], int, int)
* read(byte[], int, int)} method can modify any element of the output
* buffer.
*
* @param entry the zip file entry
* @return the input stream for reading the contents of the specified
* zip file entry or null if the zip file entry does not exist

21
src/java.base/share/classes/java/util/zip/ZipInputStream.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2022, 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
@ -165,10 +165,21 @@ public class ZipInputStream extends InflaterInputStream implements ZipConstants
}
/**
* Reads from the current ZIP entry into an array of bytes.
* If {@code len} is not zero, the method
* blocks until some input is available; otherwise, no
* bytes are read and {@code 0} is returned.
* Reads from the current ZIP entry into an array of bytes, returning the number of
* inflated bytes. If {@code len} is not zero, the method blocks until some input is
* available; otherwise, no bytes are read and {@code 0} is returned.
* <p>
* If the current entry is compressed and this method returns a nonzero
* integer <i>n</i> then {@code buf[off]}
* through {@code buf[off+}<i>n</i>{@code -1]} contain the uncompressed
* data. The content of elements {@code buf[off+}<i>n</i>{@code ]} through
* {@code buf[off+}<i>len</i>{@code -1]} is undefined, contrary to the
* specification of the {@link java.io.InputStream InputStream} superclass,
* so an implementation is free to modify these elements during the inflate
* operation. If this method returns {@code -1} or throws an exception then
* the content of {@code buf[off]} through {@code buf[off+}<i>len</i>{@code
* -1]} is undefined.
*
* @param b the buffer into which the data is read
* @param off the start offset in the destination array {@code b}
* @param len the maximum number of bytes read