Merge pull request #199 from scala/fastbinary

Adding a new fast binary format, principle: reduce array allocations

Author: heathermiller

core/src/main/scala/pickling/Output.scala

@@ -1,5 +1,7 @@
 package scala.pickling
 
+import scala.reflect.ClassTag
+import scala.collection.mutable.ArrayBuffer
 import java.io.OutputStream
 
 trait Output[T] {
@@ -10,23 +12,18 @@ trait Output[T] {
 
 }
 
-// and then demand Output[Nothing] in the abstract PickleFormat
-// in JSON we can demand Output[String], since Output[Nothing] <: Output[String]
-
-import scala.reflect.ClassTag
-
 class OutputStreamOutput(out: OutputStream) extends ArrayOutput[Byte] {
   def result(): Array[Byte] =
-   null
+    null
 
   def +=(obj: Byte) =
-   out.write(obj.asInstanceOf[Int])
+    out.write(obj.asInstanceOf[Int])
 
   def put(obj: Array[Byte]): this.type = {
-   out.write(obj)
-   this
+    out.write(obj)
+    this
   }
- }
+}
 
 // Array output with a few more methods for performance
 abstract class ArrayOutput[T: ClassTag] extends Output[Array[T]] {
@@ -40,7 +37,6 @@ abstract class ArrayOutput[T: ClassTag] extends Output[Array[T]] {
     this.put(arr)
 }
 
-import scala.collection.mutable.ArrayBuffer
 
 class ByteArrayBufferOutput extends ArrayOutput[Byte] {
 
@@ -100,5 +96,4 @@ class StringOutput extends Output[String] {
   }
 
   override def toString = buf.toString
-
 }

core/src/main/scala/pickling/binary/BinaryPickleFormat.scala

@@ -535,7 +535,7 @@ package binary {
     def endCollection(): Unit = { /* do nothing */ }
   }
 
-  class BinaryPickleFormat extends PickleFormat {
+  trait Constants {
     val NULL_TAG  : Byte = -2
     val REF_TAG   : Byte = -3
     val UNIT_TAG  : Byte = -4
@@ -567,7 +567,9 @@ package binary {
 
     val primitives = Set(KEY_NULL, KEY_REF, KEY_BYTE, KEY_SHORT, KEY_CHAR, KEY_INT, KEY_LONG, KEY_BOOLEAN, KEY_FLOAT, KEY_DOUBLE, KEY_UNIT, KEY_STRING, KEY_ARRAY_BYTE, KEY_ARRAY_SHORT, KEY_ARRAY_CHAR, KEY_ARRAY_INT, KEY_ARRAY_LONG, KEY_ARRAY_BOOLEAN, KEY_ARRAY_FLOAT, KEY_ARRAY_DOUBLE)
     val nullablePrimitives = Set(KEY_NULL, KEY_STRING, KEY_ARRAY_BYTE, KEY_ARRAY_SHORT, KEY_ARRAY_CHAR, KEY_ARRAY_INT, KEY_ARRAY_LONG, KEY_ARRAY_BOOLEAN, KEY_ARRAY_FLOAT, KEY_ARRAY_DOUBLE)
+  }
 
+  class BinaryPickleFormat extends PickleFormat with Constants {
     type PickleType = BinaryPickle
     type OutputType = ArrayOutput[Byte]
     def createBuilder() = new BinaryPickleBuilder(this, null)

core/src/main/scala/pickling/binary/Util.scala

@@ -359,17 +359,17 @@ package binary {
   object UnsafeMemory {
     import sun.misc.Unsafe
 
-    private[binary] val unsafe: Unsafe =
+    private[pickling] val unsafe: Unsafe =
       scala.concurrent.util.Unsafe.instance
 
-    private[binary] val byteArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Byte]])
-    private[binary] val shortArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Short]])
-    private[binary] val intArrayOffset: Long  = unsafe.arrayBaseOffset(classOf[Array[Int]])
-    private[binary] val longArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Long]])
-    private[binary] val floatArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Float]])
-    private[binary] val doubleArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Double]])
-    private[binary] val charArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Char]])
-    private[binary] val booleanArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Boolean]])
+    private[pickling] val byteArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Byte]])
+    private[pickling] val shortArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Short]])
+    private[pickling] val intArrayOffset: Long  = unsafe.arrayBaseOffset(classOf[Array[Int]])
+    private[pickling] val longArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Long]])
+    private[pickling] val floatArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Float]])
+    private[pickling] val doubleArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Double]])
+    private[pickling] val charArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Char]])
+    private[pickling] val booleanArrayOffset: Long = unsafe.arrayBaseOffset(classOf[Array[Boolean]])
 
     def putInt(arr: Array[Byte], i: Int, value: Int): Unit = {
       unsafe.putInt(arr, byteArrayOffset + i, value)