You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2020/09/03 13:06:40 UTC
[GitHub] [lucene-solr] jpountz commented on a change in pull request #1824: LUCENE-9500: Separate the Deflater hack from the Lucene code to a subclass of java.util.zip.Deflater
jpountz commented on a change in pull request #1824:
URL: https://github.com/apache/lucene-solr/pull/1824#discussion_r482960153
##########
File path: lucene/core/src/java/org/apache/lucene/codecs/lucene87/BugfixDeflater_JDK8252739.java
##########
@@ -0,0 +1,102 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.lucene87;
+
+import java.util.Arrays;
+import java.util.zip.DataFormatException;
+import java.util.zip.Deflater;
+import java.util.zip.Inflater;
+
+/**
+ * This class is a workaround for JDK bug
+ * <a href="https://bugs.openjdk.java.net/browse/JDK-8252739">JDK-8252739</a>.
+ */
+final class BugfixDeflater_JDK8252739 extends Deflater {
+
+ private final byte[] dictBytesScratch;
+
+ private BugfixDeflater_JDK8252739(int level, boolean nowrap, int dictLength) {
+ super(level, nowrap);
+ this.dictBytesScratch = new byte[dictLength];
+ }
+
+ @Override
+ public void setDictionary(byte[] dictBytes, int off, int len) {
+ if (off > 0) {
+ System.arraycopy(dictBytes, off, dictBytesScratch, 0, len);
+ super.setDictionary(dictBytesScratch, 0, len);
+ } else {
+ super.setDictionary(dictBytes, off, len);
+ }
+ }
+
+ public static Deflater createDeflaterInstance(int level, boolean nowrap, int dictLength) {
+ if (dictLength < 0) {
+ throw new IllegalArgumentException("dictLength must be >= 0");
+ }
+ if (IS_BUGGY_JDK) {
+ return new BugfixDeflater_JDK8252739(level, nowrap, dictLength);
+ } else {
+ return new Deflater(level, nowrap);
+ }
+ }
+
+ private static boolean detectBuggyJDK() {
+ final byte[] testData = new byte[] { 1, 2, 3, 4, 5, 6, 7, 8 };
+ final byte[] compressed = new byte[32]; // way enough space
+ final Deflater deflater = new Deflater(6, true);
+ try {
+ deflater.reset();
+ deflater.setDictionary(testData, 4, 4);
+ deflater.setInput(testData);
+ deflater.finish();
+ deflater.deflate(compressed, 0, compressed.length, Deflater.FULL_FLUSH);
+ } finally {
+ deflater.end();
+ }
+
+ final Inflater inflater = new Inflater(true);
+ final byte[] restored = new byte[testData.length];
+ try {
+ inflater.reset();
+ inflater.setDictionary(testData, 4, 4);
+ inflater.setInput(compressed);
+ final int restoredLength = inflater.inflate(restored);
+ if (restoredLength != testData.length) {
+ return true;
+ }
+ } catch (DataFormatException e) {
+ return true;
+ } finally {
+ inflater.end();
+ }
+
+ if (Arrays.equals(testData, restored) == false) {
+ return true;
+ }
+
+ // all fine
+ return false;
+ }
+
+ public static final boolean IS_BUGGY_JDK = detectBuggyJDK();
+
+ static {
+ System.err.println("JDK is buggy: " + IS_BUGGY_JDK);
Review comment:
Did you only mean to use this for debugging?
##########
File path: lucene/core/src/java/org/apache/lucene/codecs/lucene87/BugfixDeflater_JDK8252739.java
##########
@@ -0,0 +1,102 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.lucene87;
+
+import java.util.Arrays;
+import java.util.zip.DataFormatException;
+import java.util.zip.Deflater;
+import java.util.zip.Inflater;
+
+/**
+ * This class is a workaround for JDK bug
+ * <a href="https://bugs.openjdk.java.net/browse/JDK-8252739">JDK-8252739</a>.
+ */
+final class BugfixDeflater_JDK8252739 extends Deflater {
+
+ private final byte[] dictBytesScratch;
+
+ private BugfixDeflater_JDK8252739(int level, boolean nowrap, int dictLength) {
+ super(level, nowrap);
+ this.dictBytesScratch = new byte[dictLength];
+ }
+
+ @Override
+ public void setDictionary(byte[] dictBytes, int off, int len) {
+ if (off > 0) {
+ System.arraycopy(dictBytes, off, dictBytesScratch, 0, len);
+ super.setDictionary(dictBytesScratch, 0, len);
+ } else {
+ super.setDictionary(dictBytes, off, len);
+ }
+ }
+
+ public static Deflater createDeflaterInstance(int level, boolean nowrap, int dictLength) {
+ if (dictLength < 0) {
+ throw new IllegalArgumentException("dictLength must be >= 0");
+ }
+ if (IS_BUGGY_JDK) {
+ return new BugfixDeflater_JDK8252739(level, nowrap, dictLength);
+ } else {
+ return new Deflater(level, nowrap);
+ }
+ }
+
+ private static boolean detectBuggyJDK() {
+ final byte[] testData = new byte[] { 1, 2, 3, 4, 5, 6, 7, 8 };
+ final byte[] compressed = new byte[32]; // way enough space
+ final Deflater deflater = new Deflater(6, true);
+ try {
+ deflater.reset();
+ deflater.setDictionary(testData, 4, 4);
+ deflater.setInput(testData);
+ deflater.finish();
+ deflater.deflate(compressed, 0, compressed.length, Deflater.FULL_FLUSH);
+ } finally {
+ deflater.end();
+ }
+
+ final Inflater inflater = new Inflater(true);
+ final byte[] restored = new byte[testData.length];
+ try {
+ inflater.reset();
+ inflater.setDictionary(testData, 4, 4);
+ inflater.setInput(compressed);
+ final int restoredLength = inflater.inflate(restored);
+ if (restoredLength != testData.length) {
+ return true;
+ }
+ } catch (DataFormatException e) {
+ return true;
+ } finally {
+ inflater.end();
+ }
+
+ if (Arrays.equals(testData, restored) == false) {
+ return true;
+ }
+
+ // all fine
+ return false;
+ }
Review comment:
If you confirmed that this fails on at least one buggy JVM, this detection code LGTM.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org