jpountz commented on a change in pull request #439: URL: https://github.com/apache/lucene/pull/439#discussion_r777675004
########## File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/ZstdDictCompressionMode.java ########## @@ -0,0 +1,195 @@ +/* + * 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.customcompression; + +import com.github.luben.zstd.*; +import java.io.IOException; +import org.apache.lucene.codecs.compressing.CompressionMode; +import org.apache.lucene.codecs.compressing.Compressor; +import org.apache.lucene.codecs.compressing.Decompressor; +import org.apache.lucene.store.DataInput; +import org.apache.lucene.store.DataOutput; +import org.apache.lucene.util.ArrayUtil; +import org.apache.lucene.util.BytesRef; + +/** Zstandard Compression Mode */ +public class ZstdDictCompressionMode extends CompressionMode { + private static final int NUM_SUB_BLOCKS = 10; + private final int level; + public static final int defaultLevel = 3; + private static final int DICT_SIZE_FACTOR = 2; Review comment: Let's do 6 like for BEST_COMPRESSION? ```suggestion private static final int DICT_SIZE_FACTOR = 6; ``` ########## File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java ########## @@ -0,0 +1,103 @@ +/* + * 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.customcompression; + +import java.io.IOException; +import java.util.Objects; +import org.apache.lucene.codecs.StoredFieldsFormat; +import org.apache.lucene.codecs.StoredFieldsReader; +import org.apache.lucene.codecs.StoredFieldsWriter; +import org.apache.lucene.codecs.compressing.CompressionMode; +import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat; +import org.apache.lucene.index.FieldInfos; +import org.apache.lucene.index.SegmentInfo; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.IOContext; + +/** Stored field format used by plugaable codec */ +public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat { + // chunk size for zstandard + private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024; Review comment: Let's use bigger blocks, like for BEST_COMPRESSION. ```suggestion private static final int ZSTD_BLOCK_LENGTH = 10 * 48 * 1024; ``` ########## File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java ########## @@ -0,0 +1,103 @@ +/* + * 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.customcompression; + +import java.io.IOException; +import java.util.Objects; +import org.apache.lucene.codecs.StoredFieldsFormat; +import org.apache.lucene.codecs.StoredFieldsReader; +import org.apache.lucene.codecs.StoredFieldsWriter; +import org.apache.lucene.codecs.compressing.CompressionMode; +import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat; +import org.apache.lucene.index.FieldInfos; +import org.apache.lucene.index.SegmentInfo; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.IOContext; + +/** Stored field format used by plugaable codec */ +public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat { + // chunk size for zstandard + private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024; + + public static final String MODE_KEY = + Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode"; + + final Lucene90CustomCompressionCodec.Mode mode; + + private static int compressionLevel; + + /** default constructor */ + public Lucene90CustomCompressionStoredFieldsFormat() { + this( + Lucene90CustomCompressionCodec.Mode.ZSTD_DICT, + Lucene90CustomCompressionCodec.defaultCompressionLevel); + } + + /** Stored fields format with specified compression algo. */ + public Lucene90CustomCompressionStoredFieldsFormat( + Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) { + this.mode = Objects.requireNonNull(mode); + Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel; + } + + @Override + public StoredFieldsReader fieldsReader( + Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException { + String value = si.getAttribute(MODE_KEY); + if (value == null) { + throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name); + } + Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value); + return impl(mode).fieldsReader(directory, si, fn, context); + } + + @Override + public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context) + throws IOException { + String previous = si.putAttribute(MODE_KEY, mode.name()); + if (previous != null && previous.equals(mode.name()) == false) { + throw new IllegalStateException( + "found existing value for " + + MODE_KEY + + " for segment: " + + si.name + + "old=" + + previous + + ", new=" + + mode.name()); + } + return impl(mode).fieldsWriter(directory, si, context); + } + + StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) { + switch (mode) { + case ZSTD: + return new Lucene90CompressingStoredFieldsFormat( + "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10); Review comment: 4096 docs per chunk at most, like for BEST_COMPRESSION ```suggestion "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 4096, 10); ``` ########## File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java ########## @@ -0,0 +1,103 @@ +/* + * 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.customcompression; + +import java.io.IOException; +import java.util.Objects; +import org.apache.lucene.codecs.StoredFieldsFormat; +import org.apache.lucene.codecs.StoredFieldsReader; +import org.apache.lucene.codecs.StoredFieldsWriter; +import org.apache.lucene.codecs.compressing.CompressionMode; +import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat; +import org.apache.lucene.index.FieldInfos; +import org.apache.lucene.index.SegmentInfo; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.IOContext; + +/** Stored field format used by plugaable codec */ +public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat { + // chunk size for zstandard + private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024; + + public static final String MODE_KEY = + Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode"; + + final Lucene90CustomCompressionCodec.Mode mode; + + private static int compressionLevel; + + /** default constructor */ + public Lucene90CustomCompressionStoredFieldsFormat() { + this( + Lucene90CustomCompressionCodec.Mode.ZSTD_DICT, + Lucene90CustomCompressionCodec.defaultCompressionLevel); + } + + /** Stored fields format with specified compression algo. */ + public Lucene90CustomCompressionStoredFieldsFormat( + Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) { + this.mode = Objects.requireNonNull(mode); + Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel; + } + + @Override + public StoredFieldsReader fieldsReader( + Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException { + String value = si.getAttribute(MODE_KEY); + if (value == null) { + throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name); + } + Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value); + return impl(mode).fieldsReader(directory, si, fn, context); + } + + @Override + public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context) + throws IOException { + String previous = si.putAttribute(MODE_KEY, mode.name()); + if (previous != null && previous.equals(mode.name()) == false) { + throw new IllegalStateException( + "found existing value for " + + MODE_KEY + + " for segment: " + + si.name + + "old=" + + previous + + ", new=" + + mode.name()); + } + return impl(mode).fieldsWriter(directory, si, context); + } + + StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) { + switch (mode) { + case ZSTD: + return new Lucene90CompressingStoredFieldsFormat( + "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10); + + case ZSTD_DICT: + return new Lucene90CompressingStoredFieldsFormat( + "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_DICT, ZSTD_BLOCK_LENGTH, 1024, 10); Review comment: ```suggestion "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_DICT, ZSTD_BLOCK_LENGTH, 4096, 10); ``` ########## File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java ########## @@ -0,0 +1,103 @@ +/* + * 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.customcompression; + +import java.io.IOException; +import java.util.Objects; +import org.apache.lucene.codecs.StoredFieldsFormat; +import org.apache.lucene.codecs.StoredFieldsReader; +import org.apache.lucene.codecs.StoredFieldsWriter; +import org.apache.lucene.codecs.compressing.CompressionMode; +import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat; +import org.apache.lucene.index.FieldInfos; +import org.apache.lucene.index.SegmentInfo; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.IOContext; + +/** Stored field format used by plugaable codec */ +public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat { + // chunk size for zstandard + private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024; + + public static final String MODE_KEY = + Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode"; + + final Lucene90CustomCompressionCodec.Mode mode; + + private static int compressionLevel; Review comment: Let's not make it static? -- 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. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
