2 * Copyright (c) 2016 Pantheon Technologies s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.openflowplugin.impl.protocol.deserialization.match;
10 import io.netty.buffer.ByteBuf;
11 import java.util.HashMap;
13 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
14 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
15 import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderDeserializer;
16 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
17 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntryDeserializerKey;
18 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
19 import org.opendaylight.openflowplugin.api.openflow.protocol.deserialization.MatchEntryDeserializer;
20 import org.opendaylight.openflowplugin.api.openflow.protocol.deserialization.MatchEntryDeserializerRegistry;
21 import org.opendaylight.openflowplugin.extension.api.path.MatchPath;
22 import org.opendaylight.openflowplugin.openflow.md.core.extension.MatchExtensionHelper;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
26 import org.opendaylight.yangtools.yang.common.Uint32;
27 import org.slf4j.Logger;
28 import org.slf4j.LoggerFactory;
30 public class MatchDeserializer implements OFDeserializer<Match>, HeaderDeserializer<Match>,
31 MatchEntryDeserializerRegistry, MatchEntryDeserializer, DeserializerRegistryInjector {
33 private static final Logger LOG = LoggerFactory.getLogger(MatchDeserializer.class);
34 private final Map<MatchEntryDeserializerKey, MatchEntryDeserializer> entryRegistry = new HashMap<>();
35 private final MatchPath matchPath;
36 private DeserializerRegistry registry;
38 public MatchDeserializer(final MatchPath matchPath) {
39 this.matchPath = matchPath;
43 public Match deserialize(final ByteBuf inBuffer) {
44 if (inBuffer.readableBytes() <= 0) {
48 final MatchBuilder builder = new MatchBuilder();
50 // OFP do not have any method to differentiate between OXM and standard match, so we do not care about type
51 inBuffer.readUnsignedShort();
52 final int length = inBuffer.readUnsignedShort();
54 final int startIndex = inBuffer.readerIndex();
55 final int entriesLength = length - 2 * Short.BYTES;
57 while (inBuffer.readerIndex() - startIndex < entriesLength) {
58 deserializeEntry(inBuffer, builder);
61 int paddingRemainder = length % EncodeConstants.PADDING;
63 if (paddingRemainder != 0) {
64 inBuffer.skipBytes(EncodeConstants.PADDING - paddingRemainder);
67 return builder.build();
71 public Match deserializeHeader(final ByteBuf inBuffer) {
72 final MatchBuilder builder = new MatchBuilder();
73 deserializeEntry(inBuffer, builder);
74 return builder.build();
78 public void deserializeEntry(final ByteBuf inBuffer, final MatchBuilder builder) {
79 if (inBuffer.readableBytes() <= 0) {
82 int oxmClass = inBuffer.getUnsignedShort(inBuffer.readerIndex());
83 int oxmField = inBuffer.getUnsignedByte(inBuffer.readerIndex() + Short.BYTES) >>> 1;
85 final MatchEntryDeserializerKey key = new MatchEntryDeserializerKey(
86 EncodeConstants.OF_VERSION_1_3, oxmClass, oxmField);
88 if (oxmClass == EncodeConstants.EXPERIMENTER_VALUE) {
89 long expId = inBuffer.getUnsignedInt(inBuffer.readerIndex() + Short.BYTES + 2 * Byte.BYTES);
90 key.setExperimenterId(Uint32.valueOf(expId));
93 final MatchEntryDeserializer entryDeserializer = entryRegistry.get(key);
95 if (entryDeserializer != null) {
96 entryDeserializer.deserializeEntry(inBuffer, builder);
98 final OFDeserializer<MatchEntry> deserializer = registry.getDeserializer(key);
99 MatchExtensionHelper.injectExtension(EncodeConstants.OF_VERSION_1_3,
100 deserializer.deserialize(inBuffer), builder, matchPath);
105 public void registerEntryDeserializer(final MatchEntryDeserializerKey key,
106 final MatchEntryDeserializer deserializer) {
107 if (key == null || deserializer == null) {
108 throw new IllegalArgumentException("MatchEntryDeserializerKey or Deserializer is null");
111 final MatchEntryDeserializer desInRegistry = entryRegistry.put(key, deserializer);
113 if (desInRegistry != null) {
114 LOG.debug("Deserializer for key {} overwritten. Old deserializer: {}, new deserializer: {}", key,
115 desInRegistry.getClass().getName(), deserializer.getClass().getName());
120 public boolean unregisterEntryDeserializer(final MatchEntryDeserializerKey key) {
122 throw new IllegalArgumentException("MatchEntryDeserializerKey is null");
125 return entryRegistry.remove(key) != null;
129 public void injectDeserializerRegistry(final DeserializerRegistry deserializerRegistry) {
130 registry = deserializerRegistry;