Kryo related fixes
- KryoNamespace to allow control over registration id
Change-Id: Idc2a0e27a09916657c725ee97e4366109144cc66
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ArraysAsListSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ArraysAsListSerializer.java
new file mode 100644
index 0000000..fe54804
--- /dev/null
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ArraysAsListSerializer.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2014 Open Networking Laboratory
+ *
+ * Licensed 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.onlab.onos.store.serializers;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import com.esotericsoftware.kryo.Kryo;
+import com.esotericsoftware.kryo.Serializer;
+import com.esotericsoftware.kryo.io.Input;
+import com.esotericsoftware.kryo.io.Output;
+
+/**
+ * Kryo Serializer for {@link java.util.Arrays#asList(Object...)}.
+ */
+public final class ArraysAsListSerializer extends Serializer<List<?>> {
+
+ @Override
+ public void write(Kryo kryo, Output output, List<?> object) {
+ output.writeInt(object.size(), true);
+ for (Object elm : object) {
+ kryo.writeClassAndObject(output, elm);
+ }
+ }
+
+ @Override
+ public List<?> read(Kryo kryo, Input input, Class<List<?>> type) {
+ final int size = input.readInt(true);
+ List<Object> list = new ArrayList<>(size);
+ for (int i = 0; i < size; ++i) {
+ list.add(kryo.readClassAndObject(input));
+ }
+ return list;
+ }
+}
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/DefaultLinkSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/DefaultLinkSerializer.java
index a787012..dd02834 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/DefaultLinkSerializer.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/DefaultLinkSerializer.java
@@ -45,7 +45,7 @@
kryo.writeClassAndObject(output, object.dst());
kryo.writeClassAndObject(output, object.type());
kryo.writeClassAndObject(output, object.state());
- kryo.writeClassAndObject(output, object.isDurable());
+ output.writeBoolean(object.isDurable());
}
@Override
@@ -55,7 +55,7 @@
ConnectPoint dst = (ConnectPoint) kryo.readClassAndObject(input);
Type linkType = (Type) kryo.readClassAndObject(input);
State state = (State) kryo.readClassAndObject(input);
- boolean isDurable = (boolean) kryo.readClassAndObject(input);
+ boolean isDurable = input.readBoolean();
return new DefaultLink(providerId, src, dst, linkType, state, isDurable);
}
}
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableListSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableListSerializer.java
index d51f37b..8c6ee38 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableListSerializer.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableListSerializer.java
@@ -15,9 +15,8 @@
*/
package org.onlab.onos.store.serializers;
-import org.onlab.util.KryoNamespace.FamilySerializer;
-
import com.esotericsoftware.kryo.Kryo;
+import com.esotericsoftware.kryo.Serializer;
import com.esotericsoftware.kryo.io.Input;
import com.esotericsoftware.kryo.io.Output;
import com.google.common.collect.ImmutableList;
@@ -26,7 +25,7 @@
/**
* Creates {@link ImmutableList} serializer instance.
*/
-public class ImmutableListSerializer extends FamilySerializer<ImmutableList<?>> {
+public class ImmutableListSerializer extends Serializer<ImmutableList<?>> {
/**
* Creates {@link ImmutableList} serializer instance.
@@ -53,12 +52,4 @@
}
return builder.build();
}
-
- @Override
- public void registerFamilies(Kryo kryo) {
- kryo.register(ImmutableList.of(1).getClass(), this);
- kryo.register(ImmutableList.of(1, 2).getClass(), this);
- // TODO register required ImmutableList variants
- }
-
}
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableMapSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableMapSerializer.java
index 1a26ea4..85b98a9 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableMapSerializer.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableMapSerializer.java
@@ -19,9 +19,8 @@
import java.util.HashMap;
import java.util.Map;
-import org.onlab.util.KryoNamespace.FamilySerializer;
-
import com.esotericsoftware.kryo.Kryo;
+import com.esotericsoftware.kryo.Serializer;
import com.esotericsoftware.kryo.io.Input;
import com.esotericsoftware.kryo.io.Output;
import com.esotericsoftware.kryo.serializers.MapSerializer;
@@ -30,7 +29,7 @@
/**
* Kryo Serializer for {@link ImmutableMap}.
*/
-public class ImmutableMapSerializer extends FamilySerializer<ImmutableMap<?, ?>> {
+public class ImmutableMapSerializer extends Serializer<ImmutableMap<?, ?>> {
private final MapSerializer mapSerializer = new MapSerializer();
@@ -56,12 +55,4 @@
Map<?, ?> map = kryo.readObject(input, HashMap.class, mapSerializer);
return ImmutableMap.copyOf(map);
}
-
- @Override
- public void registerFamilies(Kryo kryo) {
- kryo.register(ImmutableMap.of().getClass(), this);
- kryo.register(ImmutableMap.of(1, 2).getClass(), this);
- kryo.register(ImmutableMap.of(1, 2, 3, 4).getClass(), this);
- // TODO register required ImmutableMap variants
- }
}
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableSetSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableSetSerializer.java
index f63d17d..bcba7df 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableSetSerializer.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/ImmutableSetSerializer.java
@@ -18,9 +18,8 @@
import java.util.ArrayList;
import java.util.List;
-import org.onlab.util.KryoNamespace.FamilySerializer;
-
import com.esotericsoftware.kryo.Kryo;
+import com.esotericsoftware.kryo.Serializer;
import com.esotericsoftware.kryo.io.Input;
import com.esotericsoftware.kryo.io.Output;
import com.esotericsoftware.kryo.serializers.CollectionSerializer;
@@ -29,7 +28,7 @@
/**
* Kryo Serializer for {@link ImmutableSet}.
*/
-public class ImmutableSetSerializer extends FamilySerializer<ImmutableSet<?>> {
+public class ImmutableSetSerializer extends Serializer<ImmutableSet<?>> {
private final CollectionSerializer serializer = new CollectionSerializer();
@@ -39,6 +38,7 @@
public ImmutableSetSerializer() {
// non-null, immutable
super(false, true);
+ serializer.setElementsCanBeNull(false);
}
@Override
@@ -52,12 +52,4 @@
List<?> elms = kryo.readObject(input, ArrayList.class, serializer);
return ImmutableSet.copyOf(elms);
}
-
- @Override
- public void registerFamilies(Kryo kryo) {
- kryo.register(ImmutableSet.of().getClass(), this);
- kryo.register(ImmutableSet.of(1).getClass(), this);
- kryo.register(ImmutableSet.of(1, 2).getClass(), this);
- // TODO register required ImmutableSet variants
- }
}
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoNamespaces.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoNamespaces.java
index fea74bf..264dd4a 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoNamespaces.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoNamespaces.java
@@ -19,6 +19,7 @@
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
@@ -99,6 +100,15 @@
import org.onlab.onos.net.resource.LambdaResourceRequest;
import org.onlab.onos.net.resource.LinkResourceRequest;
import org.onlab.onos.store.Timestamp;
+import org.onlab.onos.store.service.BatchReadRequest;
+import org.onlab.onos.store.service.BatchWriteRequest;
+import org.onlab.onos.store.service.ReadRequest;
+import org.onlab.onos.store.service.ReadResult;
+import org.onlab.onos.store.service.ReadStatus;
+import org.onlab.onos.store.service.VersionedValue;
+import org.onlab.onos.store.service.WriteRequest;
+import org.onlab.onos.store.service.WriteResult;
+import org.onlab.onos.store.service.WriteStatus;
import org.onlab.packet.ChassisId;
import org.onlab.packet.IpAddress;
import org.onlab.packet.Ip4Address;
@@ -117,41 +127,62 @@
public final class KryoNamespaces {
public static final KryoNamespace BASIC = KryoNamespace.newBuilder()
- .register(ImmutableMap.class, new ImmutableMapSerializer())
- .register(ImmutableList.class, new ImmutableListSerializer())
- .register(ImmutableSet.class, new ImmutableSetSerializer())
- .register(
- ArrayList.class,
- Arrays.asList().getClass(),
- HashMap.class,
- HashSet.class,
- LinkedList.class,
- byte[].class,
- Duration.class
- )
+ .nextId(KryoNamespace.FLOATING_ID)
+ .register(byte[].class)
+ .register(new ImmutableListSerializer(),
+ ImmutableList.class,
+ ImmutableList.of(1).getClass(),
+ ImmutableList.of(1, 2).getClass())
+ .register(new ImmutableSetSerializer(),
+ ImmutableSet.class,
+ ImmutableSet.of().getClass(),
+ ImmutableSet.of(1).getClass(),
+ ImmutableSet.of(1, 2).getClass())
+ .register(new ImmutableMapSerializer(),
+ ImmutableMap.class,
+ ImmutableMap.of().getClass(),
+ ImmutableMap.of("a", 1).getClass(),
+ ImmutableMap.of("R", 2, "D", 2).getClass())
+ .register(HashMap.class)
+ .register(ArrayList.class,
+ LinkedList.class,
+ HashSet.class
+ )
+ .register(new ArraysAsListSerializer(), Arrays.asList().getClass())
+ .register(Collections.singletonList(1).getClass())
+ .register(Duration.class)
.build();
/**
* KryoNamespace which can serialize ON.lab misc classes.
*/
public static final KryoNamespace MISC = KryoNamespace.newBuilder()
- .register(IpPrefix.class, new IpPrefixSerializer())
- .register(Ip4Prefix.class, new Ip4PrefixSerializer())
- .register(Ip6Prefix.class, new Ip6PrefixSerializer())
- .register(IpAddress.class, new IpAddressSerializer())
- .register(Ip4Address.class, new Ip4AddressSerializer())
- .register(Ip6Address.class, new Ip6AddressSerializer())
- .register(MacAddress.class, new MacAddressSerializer())
+ .nextId(KryoNamespace.FLOATING_ID)
+ .register(new IpPrefixSerializer(), IpPrefix.class)
+ .register(new Ip4PrefixSerializer(), Ip4Prefix.class)
+ .register(new Ip6PrefixSerializer(), Ip6Prefix.class)
+ .register(new IpAddressSerializer(), IpAddress.class)
+ .register(new Ip4AddressSerializer(), Ip4Address.class)
+ .register(new Ip6AddressSerializer(), Ip6Address.class)
+ .register(new MacAddressSerializer(), MacAddress.class)
.register(VlanId.class)
.build();
+ /**
+ * Kryo registration Id for user custom registration.
+ */
+ public static final int BEGIN_USER_CUSTOM_ID = 300;
+
// TODO: Populate other classes
/**
* KryoNamespace which can serialize API bundle classes.
*/
public static final KryoNamespace API = KryoNamespace.newBuilder()
- .register(MISC)
+ .nextId(KryoNamespace.INITIAL_ID)
.register(BASIC)
+ .nextId(KryoNamespace.INITIAL_ID + 30)
+ .register(MISC)
+ .nextId(KryoNamespace.INITIAL_ID + 30 + 10)
.register(
ControllerNode.State.class,
Device.Type.class,
@@ -242,19 +273,29 @@
AnnotationConstraint.class,
BooleanConstraint.class
)
- .register(DefaultApplicationId.class, new DefaultApplicationIdSerializer())
- .register(URI.class, new URISerializer())
- .register(NodeId.class, new NodeIdSerializer())
- .register(ProviderId.class, new ProviderIdSerializer())
- .register(DeviceId.class, new DeviceIdSerializer())
- .register(PortNumber.class, new PortNumberSerializer())
- .register(DefaultPort.class, new DefaultPortSerializer())
- .register(LinkKey.class, new LinkKeySerializer())
- .register(ConnectPoint.class, new ConnectPointSerializer())
- .register(DefaultLink.class, new DefaultLinkSerializer())
- .register(MastershipTerm.class, new MastershipTermSerializer())
- .register(HostLocation.class, new HostLocationSerializer())
- .register(DefaultOutboundPacket.class, new DefaultOutboundPacketSerializer())
+ .register(new DefaultApplicationIdSerializer(), DefaultApplicationId.class)
+ .register(new URISerializer(), URI.class)
+ .register(new NodeIdSerializer(), NodeId.class)
+ .register(new ProviderIdSerializer(), ProviderId.class)
+ .register(new DeviceIdSerializer(), DeviceId.class)
+ .register(new PortNumberSerializer(), PortNumber.class)
+ .register(new DefaultPortSerializer(), DefaultPort.class)
+ .register(new LinkKeySerializer(), LinkKey.class)
+ .register(new ConnectPointSerializer(), ConnectPoint.class)
+ .register(new DefaultLinkSerializer(), DefaultLink.class)
+ .register(new MastershipTermSerializer(), MastershipTerm.class)
+ .register(new HostLocationSerializer(), HostLocation.class)
+ .register(new DefaultOutboundPacketSerializer(), DefaultOutboundPacket.class)
+ .register(ReadRequest.class)
+ .register(WriteRequest.class)
+ .register(WriteRequest.Type.class)
+ .register(WriteResult.class)
+ .register(ReadResult.class)
+ .register(BatchReadRequest.class)
+ .register(BatchWriteRequest.class)
+ .register(ReadStatus.class)
+ .register(WriteStatus.class)
+ .register(VersionedValue.class)
.build();
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoSerializer.java
index da37848..4554f8c 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoSerializer.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/KryoSerializer.java
@@ -15,10 +15,14 @@
*/
package org.onlab.onos.store.serializers;
+import java.io.InputStream;
+import java.io.OutputStream;
import java.nio.ByteBuffer;
import org.onlab.util.KryoNamespace;
+import com.google.common.base.MoreObjects;
+
/**
* StoreSerializer implementation using Kryo.
*/
@@ -36,8 +40,8 @@
protected void setupKryoPool() {
serializerPool = KryoNamespace.newBuilder()
.register(KryoNamespaces.API)
- .build()
- .populate(1);
+ .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID)
+ .build();
}
@Override
@@ -63,4 +67,20 @@
return serializerPool.deserialize(buffer);
}
+ @Override
+ public void encode(Object obj, OutputStream stream) {
+ serializerPool.serialize(obj, stream);
+ }
+
+ @Override
+ public <T> T decode(InputStream stream) {
+ return serializerPool.deserialize(stream);
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(getClass())
+ .add("serializerPool", serializerPool)
+ .toString();
+ }
}
diff --git a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/StoreSerializer.java b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/StoreSerializer.java
index 8ebb0e6..a5a95ac 100644
--- a/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/StoreSerializer.java
+++ b/core/store/serializers/src/main/java/org/onlab/onos/store/serializers/StoreSerializer.java
@@ -15,6 +15,8 @@
*/
package org.onlab.onos.store.serializers;
+import java.io.InputStream;
+import java.io.OutputStream;
import java.nio.ByteBuffer;
// TODO: To be replaced with SerializationService from IOLoop activity
@@ -40,6 +42,14 @@
public void encode(final Object obj, ByteBuffer buffer);
/**
+ * Serializes the specified object into bytes.
+ *
+ * @param obj object to be serialized
+ * @param stream to write serialized bytes
+ */
+ public void encode(final Object obj, final OutputStream stream);
+
+ /**
* Deserializes the specified bytes into an object.
*
* @param bytes bytes to be deserialized
@@ -56,4 +66,13 @@
* @param <T> decoded type
*/
public <T> T decode(final ByteBuffer buffer);
+
+ /**
+ * Deserializes the specified bytes into an object.
+ *
+ * @param stream stream containing the bytes to be deserialized
+ * @return deserialized object
+ * @param <T> decoded type
+ */
+ public <T> T decode(final InputStream stream);
}
diff --git a/core/store/serializers/src/test/java/org/onlab/onos/store/serializers/KryoSerializerTest.java b/core/store/serializers/src/test/java/org/onlab/onos/store/serializers/KryoSerializerTest.java
index ff5b250..535b996 100644
--- a/core/store/serializers/src/test/java/org/onlab/onos/store/serializers/KryoSerializerTest.java
+++ b/core/store/serializers/src/test/java/org/onlab/onos/store/serializers/KryoSerializerTest.java
@@ -70,6 +70,7 @@
import org.onlab.util.KryoNamespace;
import java.nio.ByteBuffer;
+import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
@@ -121,8 +122,8 @@
protected void setupKryoPool() {
serializerPool = KryoNamespace.newBuilder()
.register(KryoNamespaces.API)
- .build()
- .populate(1);
+ .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID)
+ .build();
}
};
}
@@ -326,6 +327,11 @@
}
@Test
+ public void testArraysAsList() {
+ testSerializedEquals(Arrays.asList(1, 2, 3));
+ }
+
+ @Test
public void testAnnotationConstraint() {
testSerializable(new AnnotationConstraint("distance", 100.0));
}