From ad73c9652f0548079fe408b2aa8cfccfff970ade Mon Sep 17 00:00:00 2001
From: Heather Miller <heather.miller@epfl.ch>
Date: Mon, 13 Oct 2014 10:54:09 -0700
Subject: [PATCH] WIP, adding ability to version pickles

---
 core/src/main/scala/pickling/Macros.scala     | 26 ++++++-------
 .../main/scala/pickling/PBuilderReader.scala  |  2 +
 .../main/scala/pickling/PickleFormat.scala    |  2 +
 .../pickling/binary/BinaryPickleFormat.scala  | 37 ++++++++++++++++++-
 .../fastbinary/BinaryPickleFormat.scala       | 17 +++++++++
 .../pickling/json/JSONPickleFormat.scala      | 14 +++++++
 .../scala/pickling/run/array-binary.scala     |  2 +-
 .../scala/pickling/run/binary-array-int.scala |  2 +-
 .../run/binary-case-class-int-string.scala    |  2 +-
 .../scala/pickling/run/binary-dpickler.scala  |  1 +
 .../pickling/run/binary-inputstream.scala     |  2 +-
 ...-custom-pickler-implicitly-selection.scala |  2 +-
 .../pickling/run/binary-list-t-new.scala      |  2 +-
 .../run/binary-non-primitive-field.scala      |  2 +-
 .../run/binary-non-primitive-fields.scala     |  2 +-
 .../run/binary-simple-case-class.scala        |  2 +-
 .../scala/pickling/run/c-x-any-binary.scala   |  2 +-
 .../pickling/run/combinator-pickleinto.scala  |  2 +-
 .../scala/pickling/run/generics-tough.scala   |  2 +-
 .../test/scala/pickling/run/null-binary.scala |  2 +-
 .../scala/pickling/run/share-binary-any.scala |  2 +-
 .../scala/pickling/run/share-binary.scala     |  6 +--
 .../scala/pickling/run/tuple2-primitive.scala |  2 +-
 .../test/scala/pickling/run/vector-int.scala  |  2 +-
 24 files changed, 104 insertions(+), 33 deletions(-)

diff --git a/core/src/main/scala/pickling/Macros.scala b/core/src/main/scala/pickling/Macros.scala
index ee7f56374f..882664d7ad 100644
--- a/core/src/main/scala/pickling/Macros.scala
+++ b/core/src/main/scala/pickling/Macros.scala
@@ -77,6 +77,7 @@ trait PicklerMacros extends Macro with PickleMacros {
         (resOpt, resLst)
       }
     }
+
     def unifiedPickle = { // NOTE: unified = the same code works for both primitives and objects
       val cir = newClassIR(tpe)
       // println(s"CIR for ${tpe.toString}: ${cir.fields.mkString(",")}")
@@ -88,15 +89,17 @@ trait PicklerMacros extends Macro with PickleMacros {
           val noNullTree  = lst.foldLeft[Tree](Literal(Constant(true)))((acc, curr) => q"$acc && ($curr != null)")
           q"""
             if ($noNullTree) {
-              val size = $tree + $typeNameLen + 4
+              val size = $tree + $typeNameLen + 5
               builder.hintKnownSize(size)
             }
           """
       }
+
       val beginEntry = q"""
         $hintKnownSize
         builder.beginEntry(picklee)
       """
+
       val (nonLoopyFields, loopyFields) = cir.fields.partition(fir => !shouldBotherAboutLooping(fir.tpe))
       val putFields =
         if (tpe <:< typeOf[java.io.Externalizable]) {
@@ -383,28 +386,24 @@ trait PickleMacros extends Macro {
   import definitions._
 
   def pickleTo[T: c.WeakTypeTag](output: c.Tree)(format: c.Tree): c.Tree = {
-    val tpe = weakTypeOf[T]
     val q"${_}($pickleeArg)" = c.prefix.tree
-    val endPickle = if (shouldBotherAboutCleaning(tpe)) q"clearPicklees()" else q"";
-    q"""
-      import scala.pickling._
-      import scala.pickling.internal._
-      val picklee: $tpe = $pickleeArg
-      val builder = $format.createBuilder($output)
-      picklee.pickleInto(builder)
-      $endPickle
-    """
+    pickleImpl[T](pickleeArg, q"$format.createBuilder($output)")
   }
 
   def pickle[T: c.WeakTypeTag](format: c.Tree): c.Tree = {
-    val tpe = weakTypeOf[T]
     val q"${_}($pickleeArg)" = c.prefix.tree
+    pickleImpl[T](pickleeArg, q"$format.createBuilder()")
+  }
+
+  def pickleImpl[T: c.WeakTypeTag](pickleeArg: c.Tree, mkBuilder: c.Tree): c.Tree = {
+    val tpe = weakTypeOf[T]
     val endPickle = if (shouldBotherAboutCleaning(tpe)) q"clearPicklees()" else q"";
     q"""
       import scala.pickling._
       import scala.pickling.internal._
       val picklee: $tpe = $pickleeArg
-      val builder = $format.createBuilder()
+      val builder = $mkBuilder
+      builder.beginPickle()
       picklee.pickleInto(builder)
       $endPickle
       builder.result()
@@ -542,6 +541,7 @@ trait UnpickleMacros extends Macro {
       val format = implicitly[PickleFormat]
       val pickle = $pickleArg.thePickle.asInstanceOf[format.PickleType]
       val $readerName = format.createReader(pickle, scala.pickling.internal.`package`.currentMirror)
+      $readerName.beginPickle()
       $readerUnpickleTree
     """
   }
diff --git a/core/src/main/scala/pickling/PBuilderReader.scala b/core/src/main/scala/pickling/PBuilderReader.scala
index 4d3c10a807..df2f4e8bc9 100644
--- a/core/src/main/scala/pickling/PBuilderReader.scala
+++ b/core/src/main/scala/pickling/PBuilderReader.scala
@@ -17,6 +17,7 @@ trait Hintable {
 }
 
 trait PBuilder extends Hintable {
+  def beginPickle(): PBuilder
   def beginEntry(picklee: Any): PBuilder
   def putField(name: String, pickler: PBuilder => Unit): PBuilder
   def endEntry(): Unit
@@ -28,6 +29,7 @@ trait PBuilder extends Hintable {
 
 trait PReader extends Hintable {
   def mirror: Mirror
+  def beginPickle(): PReader
   def beginEntry(): FastTypeTag[_]
   def beginEntryNoTag(): String
   def beginEntryNoTagDebug(debugOn: Boolean): String
diff --git a/core/src/main/scala/pickling/PickleFormat.scala b/core/src/main/scala/pickling/PickleFormat.scala
index f964baf6b9..dfd337cb63 100644
--- a/core/src/main/scala/pickling/PickleFormat.scala
+++ b/core/src/main/scala/pickling/PickleFormat.scala
@@ -13,6 +13,8 @@ trait PickleFormat {
   type PickleType <: Pickle
   type OutputType
 
+  val version: Int
+
   def createBuilder(): PBuilder
   def createBuilder(out: OutputType): PBuilder
   def createReader(pickle: PickleType, mirror: Mirror): PReader
diff --git a/core/src/main/scala/pickling/binary/BinaryPickleFormat.scala b/core/src/main/scala/pickling/binary/BinaryPickleFormat.scala
index 4ac98ccc51..08089c9fc1 100644
--- a/core/src/main/scala/pickling/binary/BinaryPickleFormat.scala
+++ b/core/src/main/scala/pickling/binary/BinaryPickleFormat.scala
@@ -50,10 +50,25 @@ package binary {
 
     private var output: ArrayOutput[Byte] = out
 
+    private var writeVersion = false
+
     @inline private[this] def mkOutput(knownSize: Int): Unit =
-      if (output == null)
+      if (output == null) {
         output = if (knownSize != -1) new ByteArrayOutput(knownSize)
                  else new ByteArrayBufferOutput
+        if (writeVersion) {
+          writeVersion = false
+          Util.encodeByte(output, format.version.asInstanceOf[Byte])
+        }
+      } else if (writeVersion) {
+        writeVersion = false
+        Util.encodeByte(output, format.version.asInstanceOf[Byte])
+      }
+
+    def beginPickle(): PBuilder = {
+      writeVersion = true
+      this
+    }
 
     @inline def beginEntry(picklee: Any): PBuilder = withHints { hints =>
       mkOutput(hints.knownSize)
@@ -197,6 +212,14 @@ package binary {
 
     var gla: Option[Byte] = None
 
+    def beginPickle(): PReader = {
+      // read format version and check for mismatch
+      val v = nextByte()
+      if (v != format.version)
+        throw new Exception(s"Incompatible pickle format version: read version $v, expected version ${format.version}")
+      this
+    }
+
     def beginEntryNoTag(): String =
       beginEntryNoTagDebug(false)
 
@@ -427,6 +450,15 @@ package binary {
 
     private var pos = 0
 
+    def beginPickle(): PReader = {
+      // read format version and check for mismatch
+      val v = arr(pos)
+      pos += 1
+      if (v != format.version)
+        throw new Exception(s"Incompatible pickle format version: read version $v, expected version ${format.version}")
+      this
+    }
+
     def beginEntryNoTag(): String =
       beginEntryNoTagDebug(false)
 
@@ -572,6 +604,9 @@ package binary {
   class BinaryPickleFormat extends PickleFormat with Constants {
     type PickleType = BinaryPickle
     type OutputType = ArrayOutput[Byte]
+
+    val version = 2
+
     def createBuilder() = new BinaryPickleBuilder(this, null)
     def createBuilder(out: ArrayOutput[Byte]): PBuilder = new BinaryPickleBuilder(this, out)
     def createReader(pickle: PickleType, mirror: Mirror) = pickle.createReader(mirror, this)
diff --git a/core/src/main/scala/pickling/fastbinary/BinaryPickleFormat.scala b/core/src/main/scala/pickling/fastbinary/BinaryPickleFormat.scala
index e4b5dd7747..de526a9430 100644
--- a/core/src/main/scala/pickling/fastbinary/BinaryPickleFormat.scala
+++ b/core/src/main/scala/pickling/fastbinary/BinaryPickleFormat.scala
@@ -14,6 +14,8 @@ class BinaryPickleFormat extends PickleFormat with Constants {
   type PickleType = BinaryPickle
   type OutputType = FastArrayOutput
 
+  val version = 2
+
   def createBuilder() = new BinaryPickleBuilder(this, null)
   def createBuilder(out: FastArrayOutput): PBuilder = new BinaryPickleBuilder(this, out)
 
@@ -60,6 +62,11 @@ final class BinaryPickleBuilder(format: BinaryPickleFormat, out: FastArrayOutput
     if (out == null) new FastArrayOutput
     else out
 
+  def beginPickle(): PBuilder = {
+    // TODO: write version of pickle format to pickle
+    this
+  }
+
   @inline def beginEntry(picklee: Any): PBuilder = withHints { hints =>
     if (picklee == null) {
       Util.encodeByte(output, NULL_TAG)
@@ -200,6 +207,11 @@ final class BinaryPickleBuilder(format: BinaryPickleFormat, out: FastArrayOutput
 
     var gla: Option[Byte] = None
 
+    def beginPickle(): PReader = {
+      // TODO: read format version and check for mismatch
+      this
+    }
+
     def beginEntryNoTag(): String =
       beginEntryNoTagDebug(false)
 
@@ -430,6 +442,11 @@ final class BinaryPickleBuilder(format: BinaryPickleFormat, out: FastArrayOutput
 
     private var pos = 0
 
+    def beginPickle(): PReader = {
+      // TODO: read format version and check for mismatch
+      this
+    }
+
     def beginEntryNoTag(): String =
       beginEntryNoTagDebug(false)
 
diff --git a/core/src/main/scala/pickling/json/JSONPickleFormat.scala b/core/src/main/scala/pickling/json/JSONPickleFormat.scala
index d87e9686ce..089df2aebb 100644
--- a/core/src/main/scala/pickling/json/JSONPickleFormat.scala
+++ b/core/src/main/scala/pickling/json/JSONPickleFormat.scala
@@ -23,6 +23,9 @@ package json {
   class JSONPickleFormat extends PickleFormat {
     type PickleType = JSONPickle
     type OutputType = Output[String]
+
+    val version = 2
+
     def createBuilder() = new JSONPickleBuilder(this, new StringOutput)
     def createBuilder(out: Output[String]): PBuilder = new JSONPickleBuilder(this, out)
     def createReader(pickle: JSONPickle, mirror: Mirror) = {
@@ -96,6 +99,12 @@ package json {
       FastTypeTag.ArrayFloat.key -> ((picklee: Any) => pickleArray(picklee.asInstanceOf[Array[Float]], FastTypeTag.Float)),
       FastTypeTag.ArrayDouble.key -> ((picklee: Any) => pickleArray(picklee.asInstanceOf[Array[Double]], FastTypeTag.Double))
     )
+
+    def beginPickle(): PBuilder = {
+      // write version of pickle format to pickle
+      this
+    }
+
     def beginEntry(picklee: Any): PBuilder = withHints { hints =>
       indent()
       if (hints.oid != -1) {
@@ -198,6 +207,11 @@ package json {
       nested
     }
 
+    def beginPickle(): PReader = {
+      // TODO: read format version and check for mismatch
+      this
+    }
+
     def beginEntryNoTag(): String =
       beginEntryNoTagDebug(false)
 
diff --git a/core/src/test/scala/pickling/run/array-binary.scala b/core/src/test/scala/pickling/run/array-binary.scala
index 2e52a0b0b2..727ca9faea 100644
--- a/core/src/test/scala/pickling/run/array-binary.scala
+++ b/core/src/test/scala/pickling/run/array-binary.scala
@@ -11,7 +11,7 @@ case class D(x: Int)
 class ArrayBinaryTest extends FunSuite {
   test("main") {
     val pickle = C(Array(1, 2, 3)).pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,97,114,114,97,121,46,98,105,110,97,114,121,46,67,0,0,0,3,1,0,0,0,2,0,0,0,3,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,97,114,114,97,121,46,98,105,110,97,114,121,46,67,0,0,0,3,1,0,0,0,2,0,0,0,3,0,0,0])")
     assert(pickle.unpickle[C].toString === "C([1,2,3])")
   }
 
diff --git a/core/src/test/scala/pickling/run/binary-array-int.scala b/core/src/test/scala/pickling/run/binary-array-int.scala
index 29649cf5ce..48628347a1 100644
--- a/core/src/test/scala/pickling/run/binary-array-int.scala
+++ b/core/src/test/scala/pickling/run/binary-array-int.scala
@@ -10,7 +10,7 @@ class BinaryArrayIntTest extends FunSuite {
     val ia = Array[Int](30, 31)
 
     val pickle: BinaryPickle = ia.pickle
-    assert(pickle.value.mkString("[", ",", "]") === "[0,0,0,22,115,99,97,108,97,46,65,114,114,97,121,91,115,99,97,108,97,46,73,110,116,93,0,0,0,2,30,0,0,0,31,0,0,0]")
+    assert(pickle.value.mkString("[", ",", "]") === "[2,0,0,0,22,115,99,97,108,97,46,65,114,114,97,121,91,115,99,97,108,97,46,73,110,116,93,0,0,0,2,30,0,0,0,31,0,0,0]")
 
     val readArr = pickle.unpickle[Array[Int]]
     assert(readArr.mkString("[", ",", "]") === "[30,31]")
diff --git a/core/src/test/scala/pickling/run/binary-case-class-int-string.scala b/core/src/test/scala/pickling/run/binary-case-class-int-string.scala
index 484966b471..1c121f6ec0 100644
--- a/core/src/test/scala/pickling/run/binary-case-class-int-string.scala
+++ b/core/src/test/scala/pickling/run/binary-case-class-int-string.scala
@@ -12,7 +12,7 @@ class BinaryCaseClassIntStringTest extends FunSuite {
   test("main") {
     val p = Person("Jim", 43)
     val pickle = p.pickle
-    assert(pickle.value.mkString("[", ",", "]") === "[0,0,0,50,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,99,97,115,101,46,99,108,97,115,115,46,105,110,116,46,115,116,114,105,110,103,46,80,101,114,115,111,110,0,0,0,3,74,105,109,0,0,0,43]")
+    assert(pickle.value.mkString("[", ",", "]") === "[2,0,0,0,50,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,99,97,115,101,46,99,108,97,115,115,46,105,110,116,46,115,116,114,105,110,103,46,80,101,114,115,111,110,0,0,0,3,74,105,109,0,0,0,43]")
     val up = pickle.unpickle[Person]
     assert(p === up)
   }
diff --git a/core/src/test/scala/pickling/run/binary-dpickler.scala b/core/src/test/scala/pickling/run/binary-dpickler.scala
index 47c8df6c44..72fa3ac119 100644
--- a/core/src/test/scala/pickling/run/binary-dpickler.scala
+++ b/core/src/test/scala/pickling/run/binary-dpickler.scala
@@ -15,6 +15,7 @@ class BinaryDPicklerTest extends FunSuite {
       val ff = Firefighter("Jim", 43, 30000)
 
       val builder = pickleFormat.createBuilder()
+      builder.beginPickle()
       dp.pickle(ff, builder)
       val pickle = builder.result()
       val up = pickle.unpickle[Person]
diff --git a/core/src/test/scala/pickling/run/binary-inputstream.scala b/core/src/test/scala/pickling/run/binary-inputstream.scala
index b24d4f9082..717f599cc9 100644
--- a/core/src/test/scala/pickling/run/binary-inputstream.scala
+++ b/core/src/test/scala/pickling/run/binary-inputstream.scala
@@ -26,7 +26,7 @@ class BinaryInputStreamReaderTest extends FunSuite {
     val arr = Array[Int](30, 31)
 
     val pickle: BinaryPickle = arr.pickle
-    assert(pickle.value.mkString("[", ",", "]") === "[0,0,0,22,115,99,97,108,97,46,65,114,114,97,121,91,115,99,97,108,97,46,73,110,116,93,0,0,0,2,30,0,0,0,31,0,0,0]")
+    assert(pickle.value.mkString("[", ",", "]") === "[2,0,0,0,22,115,99,97,108,97,46,65,114,114,97,121,91,115,99,97,108,97,46,73,110,116,93,0,0,0,2,30,0,0,0,31,0,0,0]")
 
     val streamPickle = BinaryPickleStream(new ByteArrayInputStream(pickle.value))
     val readArr = streamPickle.unpickle[Array[Int]]
diff --git a/core/src/test/scala/pickling/run/binary-list-int-custom-pickler-implicitly-selection.scala b/core/src/test/scala/pickling/run/binary-list-int-custom-pickler-implicitly-selection.scala
index 5f36a66641..8478b7fb87 100644
--- a/core/src/test/scala/pickling/run/binary-list-int-custom-pickler-implicitly-selection.scala
+++ b/core/src/test/scala/pickling/run/binary-list-int-custom-pickler-implicitly-selection.scala
@@ -56,7 +56,7 @@ class BinaryListIntCustomTest extends FunSuite {
     }
 
     val pickle = lst.pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,50,115,99,97,108,97,46,99,111,108,108,101,99,116,105,111,110,46,105,109,109,117,116,97,98,108,101,46,36,99,111,108,111,110,36,99,111,108,111,110,91,115,99,97,108,97,46,73,110,116,93,0,0,0,10,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,4,0,0,0,5,0,0,0,6,0,0,0,7,0,0,0,8,0,0,0,9,0,0,0,10])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,50,115,99,97,108,97,46,99,111,108,108,101,99,116,105,111,110,46,105,109,109,117,116,97,98,108,101,46,36,99,111,108,111,110,36,99,111,108,111,110,91,115,99,97,108,97,46,73,110,116,93,0,0,0,10,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,4,0,0,0,5,0,0,0,6,0,0,0,7,0,0,0,8,0,0,0,9,0,0,0,10])")
     assert(pickle.unpickle[List[Int]] === List(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
   }
 }
diff --git a/core/src/test/scala/pickling/run/binary-list-t-new.scala b/core/src/test/scala/pickling/run/binary-list-t-new.scala
index 6c5ac781d3..9667307431 100644
--- a/core/src/test/scala/pickling/run/binary-list-t-new.scala
+++ b/core/src/test/scala/pickling/run/binary-list-t-new.scala
@@ -7,7 +7,7 @@ import binary._
 class BinaryListTNewTest extends FunSuite {
   test("main") {
     val pickle = List(1, 2, 3).pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,50,115,99,97,108,97,46,99,111,108,108,101,99,116,105,111,110,46,105,109,109,117,116,97,98,108,101,46,36,99,111,108,111,110,36,99,111,108,111,110,91,115,99,97,108,97,46,73,110,116,93,0,0,0,3,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,50,115,99,97,108,97,46,99,111,108,108,101,99,116,105,111,110,46,105,109,109,117,116,97,98,108,101,46,36,99,111,108,111,110,36,99,111,108,111,110,91,115,99,97,108,97,46,73,110,116,93,0,0,0,3,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])")
     assert(pickle.unpickle[List[Int]] === List(1, 2, 3))
   }
 }
diff --git a/core/src/test/scala/pickling/run/binary-non-primitive-field.scala b/core/src/test/scala/pickling/run/binary-non-primitive-field.scala
index 87d0f44f84..8ba123fffe 100644
--- a/core/src/test/scala/pickling/run/binary-non-primitive-field.scala
+++ b/core/src/test/scala/pickling/run/binary-non-primitive-field.scala
@@ -13,7 +13,7 @@ class BinaryNonPrimitiveFieldTest extends FunSuite {
     val p = Philipp(gudrun)
     val pckl = p.pickle
 
-    assert(pckl.value.mkString("[", ",", "]") === "[0,0,0,49,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,110,111,110,46,112,114,105,109,105,116,105,118,101,46,102,105,101,108,100,46,80,104,105,108,105,112,112,-5,0,0,0,6,71,117,100,114,117,110,0,0,0,62]")
+    assert(pckl.value.mkString("[", ",", "]") === "[2,0,0,0,49,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,110,111,110,46,112,114,105,109,105,116,105,118,101,46,102,105,101,108,100,46,80,104,105,108,105,112,112,-5,0,0,0,6,71,117,100,114,117,110,0,0,0,62]")
     assert(pckl.unpickle[Philipp] === p)
   }
 }
diff --git a/core/src/test/scala/pickling/run/binary-non-primitive-fields.scala b/core/src/test/scala/pickling/run/binary-non-primitive-fields.scala
index 6ab6c65144..6e2a8d8539 100644
--- a/core/src/test/scala/pickling/run/binary-non-primitive-fields.scala
+++ b/core/src/test/scala/pickling/run/binary-non-primitive-fields.scala
@@ -11,7 +11,7 @@ class BinaryNonPrimitiveFieldsTest extends FunSuite {
   test("main") {
     val ph = new Philipp("German", true, new Person("Gudrun", 62))
     val pckl = ph.pickle
-    assert(pckl.value.mkString("[", ",", "]") === "[0,0,0,50,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,110,111,110,46,112,114,105,109,105,116,105,118,101,46,102,105,101,108,100,115,46,80,104,105,108,105,112,112,0,0,0,6,71,101,114,109,97,110,1,-5,0,0,0,6,71,117,100,114,117,110,0,0,0,62]")
+    assert(pckl.value.mkString("[", ",", "]") === "[2,0,0,0,50,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,110,111,110,46,112,114,105,109,105,116,105,118,101,46,102,105,101,108,100,115,46,80,104,105,108,105,112,112,0,0,0,6,71,101,114,109,97,110,1,-5,0,0,0,6,71,117,100,114,117,110,0,0,0,62]")
     assert(pckl.unpickle[Philipp] == ph)
   }
 }
diff --git a/core/src/test/scala/pickling/run/binary-simple-case-class.scala b/core/src/test/scala/pickling/run/binary-simple-case-class.scala
index 822fdb2b5e..b9910849de 100644
--- a/core/src/test/scala/pickling/run/binary-simple-case-class.scala
+++ b/core/src/test/scala/pickling/run/binary-simple-case-class.scala
@@ -12,7 +12,7 @@ class BinarySimpleCaseClassTest extends FunSuite {
   test("main") {
     val p = Person(43)
     val pickle = p.pickle
-    assert(pickle.value.mkString("[", ",", "]") === "[0,0,0,46,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,115,105,109,112,108,101,46,99,97,115,101,46,99,108,97,115,115,46,80,101,114,115,111,110,0,0,0,43]")
+    assert(pickle.value.mkString("[", ",", "]") === "[2,0,0,0,46,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,98,105,110,97,114,121,46,115,105,109,112,108,101,46,99,97,115,101,46,99,108,97,115,115,46,80,101,114,115,111,110,0,0,0,43]")
     assert(pickle.unpickle[Person] === p)
   }
 }
diff --git a/core/src/test/scala/pickling/run/c-x-any-binary.scala b/core/src/test/scala/pickling/run/c-x-any-binary.scala
index f7ce9def8f..dcb77fd2cf 100644
--- a/core/src/test/scala/pickling/run/c-x-any-binary.scala
+++ b/core/src/test/scala/pickling/run/c-x-any-binary.scala
@@ -10,7 +10,7 @@ class CXAnyBinaryTest extends FunSuite {
   test("main") {
     val c = new C(2)
     val pckl = c.pickle
-    assert(pckl.toString === "BinaryPickle([0,0,0,31,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,99,46,120,46,97,110,121,46,98,105,110,97,114,121,46,67,0,0,0,9,115,99,97,108,97,46,73,110,116,0,0,0,2])")
+    assert(pckl.toString === "BinaryPickle([2,0,0,0,31,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,99,46,120,46,97,110,121,46,98,105,110,97,114,121,46,67,0,0,0,9,115,99,97,108,97,46,73,110,116,0,0,0,2])")
     assert(pckl.unpickle[C] === c)
   }
 }
diff --git a/core/src/test/scala/pickling/run/combinator-pickleinto.scala b/core/src/test/scala/pickling/run/combinator-pickleinto.scala
index 504eade55a..dc93f44cba 100644
--- a/core/src/test/scala/pickling/run/combinator-pickleinto.scala
+++ b/core/src/test/scala/pickling/run/combinator-pickleinto.scala
@@ -69,7 +69,7 @@ class CombinatorPickleIntoTest extends FunSuite {
 
     val bart = new Person(2)
     val pickle = bart.pickle
-    assert(pickle.value.mkString("[", ",", "]") === "[0,0,0,43,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,99,111,109,98,105,110,97,116,111,114,46,112,105,99,107,108,101,105,110,116,111,46,80,101,114,115,111,110,0,0,0,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]")
+    assert(pickle.value.mkString("[", ",", "]") === "[2,0,0,0,43,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,99,111,109,98,105,110,97,116,111,114,46,112,105,99,107,108,101,105,110,116,111,46,80,101,114,115,111,110,0,0,0,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]")
 
     val p = pickle.unpickle[Person]
     assert(p.toString === "Person(Bart, 45)")
diff --git a/core/src/test/scala/pickling/run/generics-tough.scala b/core/src/test/scala/pickling/run/generics-tough.scala
index d8c36c4658..43752f9ec7 100644
--- a/core/src/test/scala/pickling/run/generics-tough.scala
+++ b/core/src/test/scala/pickling/run/generics-tough.scala
@@ -11,7 +11,7 @@ class GenericsToughTest extends FunSuite {
   test("main") {
     val c: C[Int] = D(2)
     val p = c.pickle
-    assert(p.toString === "BinaryPickle([0,0,0,42,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,103,101,110,101,114,105,99,115,46,116,111,117,103,104,46,68,91,115,99,97,108,97,46,73,110,116,93,0,0,0,2])")
+    assert(p.toString === "BinaryPickle([2,0,0,0,42,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,103,101,110,101,114,105,99,115,46,116,111,117,103,104,46,68,91,115,99,97,108,97,46,73,110,116,93,0,0,0,2])")
     assert(p.unpickle[C[Int]] === c)
   }
 }
diff --git a/core/src/test/scala/pickling/run/null-binary.scala b/core/src/test/scala/pickling/run/null-binary.scala
index 5d6e389a74..279341efb0 100644
--- a/core/src/test/scala/pickling/run/null-binary.scala
+++ b/core/src/test/scala/pickling/run/null-binary.scala
@@ -12,7 +12,7 @@ class NullBinaryTest extends FunSuite {
   test("main") {
     val c = C(null, 0, null, null)
     val pickle = c.pickle
-    assert(pickle.value.mkString("[", ",", "]") === "[0,0,0,28,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,110,117,108,108,46,98,105,110,97,114,121,46,67,-2,0,0,0,0,-2,-2]")
+    assert(pickle.value.mkString("[", ",", "]") === "[2,0,0,0,28,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,110,117,108,108,46,98,105,110,97,114,121,46,67,-2,0,0,0,0,-2,-2]")
     assert(pickle.unpickle[C].toString === c.toString)
   }
 }
diff --git a/core/src/test/scala/pickling/run/share-binary-any.scala b/core/src/test/scala/pickling/run/share-binary-any.scala
index a5a5081ea9..694fa37dba 100644
--- a/core/src/test/scala/pickling/run/share-binary-any.scala
+++ b/core/src/test/scala/pickling/run/share-binary-any.scala
@@ -63,7 +63,7 @@ class ShareBinaryAnyTest extends FunSuite {
     import shareNothing._
     c1.c = null
     val pickle = (c3: Any).pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,33,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,97,110,121,46,67,0,0,0,2,99,51,0,0,0,4,100,101,115,99,0,0,0,33,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,97,110,121,46,67,0,0,0,2,99,50,0,0,0,4,100,101,115,99,0,0,0,33,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,97,110,121,46,67,0,0,0,2,99,49,0,0,0,4,100,101,115,99,-2,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,33,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,97,110,121,46,67,0,0,0,2,99,51,0,0,0,4,100,101,115,99,0,0,0,33,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,97,110,121,46,67,0,0,0,2,99,50,0,0,0,4,100,101,115,99,0,0,0,33,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,97,110,121,46,67,0,0,0,2,99,49,0,0,0,4,100,101,115,99,-2,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0])")
     val c23 = pickle.unpickle[Any].asInstanceOf[C]
     val c22 = c23.c
     val c21 = c22.c
diff --git a/core/src/test/scala/pickling/run/share-binary.scala b/core/src/test/scala/pickling/run/share-binary.scala
index 92a988fcc4..001de5a68b 100644
--- a/core/src/test/scala/pickling/run/share-binary.scala
+++ b/core/src/test/scala/pickling/run/share-binary.scala
@@ -23,7 +23,7 @@ class ShareBinaryTest extends FunSuite {
   test("loop-share-nonprimitives") {
     c1.c = c3
     val pickle = c1.pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,67,0,0,0,2,99,49,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,51,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,50,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-3,0,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,67,0,0,0,2,99,49,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,51,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,50,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-3,0,0,0,0])")
 
     val c11 = pickle.unpickle[C]
     val c13 = c11.c
@@ -52,7 +52,7 @@ class ShareBinaryTest extends FunSuite {
     import shareEverything._
     c1.c = c3
     val pickle = c1.pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,67,0,0,0,2,99,49,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,51,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,50,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-3,0,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,67,0,0,0,2,99,49,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,51,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-5,0,0,0,2,99,50,0,0,0,4,100,101,115,99,0,0,0,1,1,0,0,0,-3,0,0,0,0])")
 
     val c11 = pickle.unpickle[C]
     val c13 = c11.c
@@ -73,7 +73,7 @@ class ShareBinaryTest extends FunSuite {
     import shareNothing._
     c1.c = null
     val pickle = c3.pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,67,0,0,0,2,99,51,0,0,0,4,100,101,115,99,-5,0,0,0,2,99,50,0,0,0,4,100,101,115,99,-5,0,0,0,2,99,49,0,0,0,4,100,101,115,99,-2,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,29,115,99,97,108,97,46,112,105,99,107,108,105,110,103,46,115,104,97,114,101,46,98,105,110,97,114,121,46,67,0,0,0,2,99,51,0,0,0,4,100,101,115,99,-5,0,0,0,2,99,50,0,0,0,4,100,101,115,99,-5,0,0,0,2,99,49,0,0,0,4,100,101,115,99,-2,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0,0,0,0,1,1,0,0,0])")
 
     val c23 = pickle.unpickle[C]
     val c22 = c23.c
diff --git a/core/src/test/scala/pickling/run/tuple2-primitive.scala b/core/src/test/scala/pickling/run/tuple2-primitive.scala
index 4363bab7a0..4e296c9b00 100644
--- a/core/src/test/scala/pickling/run/tuple2-primitive.scala
+++ b/core/src/test/scala/pickling/run/tuple2-primitive.scala
@@ -8,7 +8,7 @@ class Tuple2PrimitiveTest extends FunSuite {
   test("main") {
     val tup2 = ("hewrow", 2)
     val pckl = tup2.pickle
-    assert(pckl.value.mkString("[", ",", "]") === "[0,0,0,40,115,99,97,108,97,46,84,117,112,108,101,50,91,106,97,118,97,46,108,97,110,103,46,83,116,114,105,110,103,44,115,99,97,108,97,46,73,110,116,93,0,0,0,6,104,101,119,114,111,119,0,0,0,2]")
+    assert(pckl.value.mkString("[", ",", "]") === "[2,0,0,0,40,115,99,97,108,97,46,84,117,112,108,101,50,91,106,97,118,97,46,108,97,110,103,46,83,116,114,105,110,103,44,115,99,97,108,97,46,73,110,116,93,0,0,0,6,104,101,119,114,111,119,0,0,0,2]")
     assert(pckl.unpickle[(String, Int)] === tup2)
 
     val tup3 = ("hewrow", 2, "bye")
diff --git a/core/src/test/scala/pickling/run/vector-int.scala b/core/src/test/scala/pickling/run/vector-int.scala
index e7a1ab2fc2..e0f18981e1 100644
--- a/core/src/test/scala/pickling/run/vector-int.scala
+++ b/core/src/test/scala/pickling/run/vector-int.scala
@@ -8,7 +8,7 @@ class VectorIntTest extends FunSuite {
   test("main") {
     val v = Vector(1, 2, 3)
     val pickle = v.pickle
-    assert(pickle.toString === "BinaryPickle([0,0,0,44,115,99,97,108,97,46,99,111,108,108,101,99,116,105,111,110,46,105,109,109,117,116,97,98,108,101,46,86,101,99,116,111,114,91,115,99,97,108,97,46,73,110,116,93,0,0,0,3,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])")
+    assert(pickle.toString === "BinaryPickle([2,0,0,0,44,115,99,97,108,97,46,99,111,108,108,101,99,116,105,111,110,46,105,109,109,117,116,97,98,108,101,46,86,101,99,116,111,114,91,115,99,97,108,97,46,73,110,116,93,0,0,0,3,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0])")
     assert(pickle.unpickle[Vector[Int]] === v)
   }
 }