7109837: Provide a mechanism for computing an Adler32 checksum for the contents of a ByteBuffer

Added methods Adler32/CRC32.update(ByteBuffer)

Reviewed-by: alanb

jdk/make/java/zip/mapfile-vers

@@ -30,8 +30,10 @@ SUNWprivate_1.1 {
 		Java_java_util_jar_JarFile_getMetaInfEntryNames;
 		Java_java_util_zip_Adler32_update;
 		Java_java_util_zip_Adler32_updateBytes;
+		Java_java_util_zip_Adler32_updateByteBuffer;
 		Java_java_util_zip_CRC32_update;
 		Java_java_util_zip_CRC32_updateBytes;
+		Java_java_util_zip_CRC32_updateByteBuffer;
 		Java_java_util_zip_Deflater_deflateBytes;
 		Java_java_util_zip_Deflater_end;
 		Java_java_util_zip_Deflater_getAdler;

jdk/src/share/classes/java/util/zip/Adler32.java

@@ -25,16 +25,23 @@
 
 package java.util.zip;
 
+import java.nio.ByteBuffer;
+import sun.nio.ch.DirectBuffer;
+
 /**
  * A class that can be used to compute the Adler-32 checksum of a data
  * stream. An Adler-32 checksum is almost as reliable as a CRC-32 but
  * can be computed much faster.
  *
+ * <p> Passing a {@code null} argument to a method in this class will cause
+ * a {@link NullPointerException} to be thrown.
+ *
  * @see         Checksum
  * @author      David Connelly
  */
 public
 class Adler32 implements Checksum {
+
     private int adler = 1;
 
     /**
@@ -75,6 +82,39 @@ class Adler32 implements Checksum {
         adler = updateBytes(adler, b, 0, b.length);
     }
 
+
+    /**
+     * Updates the checksum with the bytes from the specified buffer.
+     *
+     * The checksum is updated using
+     * buffer.{@link java.nio.Buffer#remaining() remaining()}
+     * bytes starting at
+     * buffer.{@link java.nio.Buffer#position() position()}
+     * Upon return, the buffer's position will be updated to its
+     * limit; its limit will not have been changed.
+     *
+     * @param buffer the ByteBuffer to update the checksum with
+     * @since 1.8
+     */
+    public void update(ByteBuffer buffer) {
+        int pos = buffer.position();
+        int limit = buffer.limit();
+        assert (pos <= limit);
+        int rem = limit - pos;
+        if (rem <= 0)
+            return;
+        if (buffer instanceof DirectBuffer) {
+            adler = updateByteBuffer(adler, ((DirectBuffer)buffer).address(), pos, rem);
+        } else if (buffer.hasArray()) {
+            adler = updateBytes(adler, buffer.array(), pos + buffer.arrayOffset(), rem);
+        } else {
+            byte[] b = new byte[rem];
+            buffer.get(b);
+            adler = updateBytes(adler, b, 0, b.length);
+        }
+        buffer.position(limit);
+    }
+
     /**
      * Resets the checksum to initial value.
      */
@@ -92,4 +132,6 @@ class Adler32 implements Checksum {
     private native static int update(int adler, int b);
     private native static int updateBytes(int adler, byte[] b, int off,
                                           int len);
+    private native static int updateByteBuffer(int adler, long addr,
+                                               int off, int len);
 }

jdk/src/share/classes/java/util/zip/CRC32.java

@@ -25,9 +25,15 @@
 
 package java.util.zip;
 
+import java.nio.ByteBuffer;
+import sun.nio.ch.DirectBuffer;
+
 /**
  * A class that can be used to compute the CRC-32 of a data stream.
  *
+ * <p> Passing a {@code null} argument to a method in this class will cause
+ * a {@link NullPointerException} to be thrown.
+ *
  * @see         Checksum
  * @author      David Connelly
  */
@@ -74,6 +80,38 @@ class CRC32 implements Checksum {
         crc = updateBytes(crc, b, 0, b.length);
     }
 
+    /**
+     * Updates the checksum with the bytes from the specified buffer.
+     *
+     * The checksum is updated using
+     * buffer.{@link java.nio.Buffer#remaining() remaining()}
+     * bytes starting at
+     * buffer.{@link java.nio.Buffer#position() position()}
+     * Upon return, the buffer's position will
+     * be updated to its limit; its limit will not have been changed.
+     *
+     * @param buffer the ByteBuffer to update the checksum with
+     * @since 1.8
+     */
+    public void update(ByteBuffer buffer) {
+        int pos = buffer.position();
+        int limit = buffer.limit();
+        assert (pos <= limit);
+        int rem = limit - pos;
+        if (rem <= 0)
+            return;
+        if (buffer instanceof DirectBuffer) {
+            crc = updateByteBuffer(crc, ((DirectBuffer)buffer).address(), pos, rem);
+        } else if (buffer.hasArray()) {
+            crc = updateBytes(crc, buffer.array(), pos + buffer.arrayOffset(), rem);
+        } else {
+            byte[] b = new byte[rem];
+            buffer.get(b);
+            crc = updateBytes(crc, b, 0, b.length);
+        }
+        buffer.position(limit);
+    }
+
     /**
      * Resets CRC-32 to initial value.
      */
@@ -90,4 +128,7 @@ class CRC32 implements Checksum {
 
     private native static int update(int crc, int b);
     private native static int updateBytes(int crc, byte[] b, int off, int len);
+
+    private native static int updateByteBuffer(int adler, long addr,
+                                               int off, int len);
 }

jdk/src/share/native/java/util/zip/Adler32.c

@@ -30,6 +30,7 @@
 #include "jni.h"
 #include "jni_util.h"
 #include "zlib.h"
+#include "jlong.h"
 
 #include "java_util_zip_Adler32.h"
 
@@ -53,3 +54,17 @@ Java_java_util_zip_Adler32_updateBytes(JNIEnv *env, jclass cls, jint adler,
     }
     return adler;
 }
+
+
+JNIEXPORT jint JNICALL
+Java_java_util_zip_Adler32_updateByteBuffer(JNIEnv *env, jclass cls, jint adler,
+                                       jlong address, jint off, jint len)
+{
+    Bytef *buf = (Bytef *)jlong_to_ptr(address);
+    if (buf) {
+        adler = adler32(adler, buf + off, len);
+    }
+    return adler;
+}
+
+

jdk/src/share/native/java/util/zip/CRC32.c

@@ -58,3 +58,14 @@ JNIEXPORT jint ZIP_CRC32(jint crc, const jbyte *buf, jint len)
 {
     return crc32(crc, (Bytef*)buf, len);
 }
+
+JNIEXPORT jint JNICALL
+Java_java_util_zip_CRC32_updateByteBuffer(JNIEnv *env, jclass cls, jint crc,
+                                          jlong address, jint off, jint len)
+{
+    Bytef *buf = (Bytef *)jlong_to_ptr(address);
+    if (buf) {
+        crc = crc32(crc, buf + off, len);
+    }
+    return crc;
+}

jdk/test/java/util/zip/TimeChecksum.java

@@ -0,0 +1,205 @@
+/*
+ * Copyright (c) 2011, 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.
+ */
+
+
+/* @test
+ * @bug 7109837
+ * @summary Test Adler32/CRC32.update(ByteBuffer)
+ */
+
+import java.util.*;
+import java.util.zip.*;
+import java.nio.*;
+
+public class TimeChecksum {
+
+    static long time(Adler32 adler32, byte[] data, int iters, int len) {
+        long start_t = System.nanoTime();
+        for (int i = 0; i < iters; i++) {
+            adler32.reset();
+            adler32.update(data, 0, len);
+        }
+        long t = System.nanoTime() - start_t;
+        System.out.printf("%,12d", t / len);
+        return t;
+    }
+
+    static long time(Adler32 adler32, ByteBuffer buf, int iters) {
+        long start_t = System.nanoTime();
+        for (int i = 0; i < iters; i++) {
+            adler32.reset();
+            buf.mark();
+            adler32.update(buf);
+            buf.reset();
+        }
+        long t = System.nanoTime() - start_t;
+        System.out.printf("%,12d", t / buf.remaining());
+        return t;
+    }
+
+    static void testPosLimit(Adler32 adler32, ByteBuffer buf) {
+        int pos = buf.position();
+        int limit = buf.limit();
+        adler32.update(buf);
+        if (limit != buf.position() || limit != buf.limit()) {
+            System.out.printf("%nFAILED: pos,limit=(%d, %d), expected (%d, %d)%n",
+                    buf.position(), buf.limit(), limit, limit);
+            throw new RuntimeException();
+        }
+        buf.position(pos);
+    }
+
+    static long time(CRC32 crc32, byte[] data, int iters, int len) {
+        long start_t = System.nanoTime();
+        for (int i = 0; i < iters; i++) {
+            crc32.reset();
+            crc32.update(data, 0, len);
+        }
+        long t = System.nanoTime() - start_t;
+        System.out.printf("%,12d", t / len);
+        return t;
+    }
+
+    static long time(CRC32 crc32, ByteBuffer buf, int iters) {
+        long start_t = System.nanoTime();
+        for (int i = 0; i < iters; i++) {
+            crc32.reset();
+            buf.mark();
+            crc32.update(buf);
+            buf.reset();
+        }
+        long t = System.nanoTime() - start_t;
+        System.out.printf("%,12d", t / buf.remaining());
+        return t;
+    }
+
+    static void testPosLimit(CRC32 crc32, ByteBuffer buf) {
+        int pos = buf.position();
+        int limit = buf.limit();
+        crc32.update(buf);
+        if (limit != buf.position() || limit != buf.limit()) {
+            System.out.printf("%nFAILED: pos,limit=(%d, %d), expected (%d, %d)%n",
+                    buf.position(), buf.limit(), limit, limit);
+            throw new RuntimeException();
+        }
+        buf.position(pos);
+    }
+
+    public static void main(String[] args) {
+        int len     = 1024 * 32;
+        int iters   = 1;
+        if (args.length != 0 && "-benchmark".equals(args[0]))
+            iters = 100000;
+        Adler32 adler32 = new Adler32();
+        CRC32 crc32 = new CRC32();
+        Random rdm = new Random();
+        byte[] data = new byte[len];
+        new Random().nextBytes(data);
+        ByteBuffer buf;
+
+        System.out.println("---------- Adler32 ----------");
+        System.out.print("Warmup...");
+        time(adler32, data, iters, len);
+        time(adler32, ByteBuffer.wrap(data), iters);
+        buf = ByteBuffer.allocateDirect(len);
+        buf.put(data, 0, len);
+        buf.flip();
+        time(adler32, buf, iters);
+        System.out.println("\n");
+
+        System.out.println("Length    byte[](ns/len)  ByteBuffer(direct)   ByteBuffer");
+        for (int testlen = 1; testlen < data.length; testlen <<= 1) {
+            System.out.print(testlen + "\t");
+            long baT = time(adler32, data, iters, testlen);
+            long baV = adler32.getValue();
+            System.out.print("\t");
+
+            buf = ByteBuffer.allocateDirect(testlen);
+            buf.put(data, 0, testlen);
+            buf.flip();
+            long bbdT = time(adler32, buf, iters);
+            long bbdV = adler32.getValue();
+            if (baV != bbdV) {
+                System.out.printf("%nFAILED: baV=%x,bbdV=%x%n", baV, bbdV);
+                throw new RuntimeException();
+            }
+            System.out.printf(" (%.2f)", (float)bbdT/baT);
+            testPosLimit(adler32, buf);
+
+            buf = ByteBuffer.allocate(testlen);
+            buf.put(data, 0, testlen);
+            buf.flip();
+            long bbT = time(adler32, buf, iters);
+            long bbV = adler32.getValue();
+            if (baV != bbV) {
+                System.out.printf("%nFAILED: baV=%x,bbV=%x%n", baV, bbV);
+                throw new RuntimeException();
+            }
+            testPosLimit(adler32, buf);
+            System.out.printf(" (%.2f)     checksum=%x%n", (float)bbT/baT, bbV);
+        }
+
+        System.out.println("\n---------- CRC32 ----------");
+        System.out.print("Warmup...");
+        time(crc32, data, iters, len);
+        time(crc32, ByteBuffer.wrap(data), iters);
+        buf = ByteBuffer.allocateDirect(len);
+        buf.put(data, 0, len);
+        buf.flip();
+        time(crc32, buf, iters);
+        System.out.println("\n");
+
+
+        System.out.println("Length    byte[](ns/len)  ByteBuffer(direct)   ByteBuffer");
+        for (int testlen = 1; testlen < data.length; testlen <<= 1) {
+            System.out.print(testlen + "\t");
+            long baT = time(crc32, data, iters, testlen);
+            long baV = crc32.getValue();
+            System.out.print("\t");
+
+            buf = ByteBuffer.allocateDirect(testlen);
+            buf.put(data, 0,  testlen);
+            buf.flip();
+            long bbdT = time(crc32, buf, iters);
+            long bbdV = crc32.getValue();
+            if (baV != bbdV) {
+                System.out.printf("%nFAILED: baV=%x,bbdV=%x%n", baV, bbdV);
+                throw new RuntimeException();
+            }
+            System.out.printf(" (%.2f)", (float)bbdT/baT);
+            testPosLimit(crc32, buf);
+
+            buf = ByteBuffer.allocate(testlen);
+            buf.put(data, 0, testlen);
+            buf.flip();
+            long bbT = time(crc32, buf, iters);
+            long bbV = crc32.getValue();
+            if (baV != bbV) {
+                System.out.printf("%nFAILED: baV=%x,bbV=%x%n", baV, bbV);
+                throw new RuntimeException();
+            }
+            testPosLimit(crc32, buf);
+            System.out.printf(" (%.2f)     checksum=%x%n", (float)bbT / baT, bbV);
+        }
+    }
+}