openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/translator/PacketReceivedTranslator.java

   1 /**
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.openflowplugin.impl.translator;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import java.math.BigInteger;
  13 import java.util.Optional;
  14 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  15 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  16 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  17 import org.opendaylight.openflowplugin.extension.api.AugmentTuple;
  18 import org.opendaylight.openflowplugin.extension.api.path.MatchPath;
  19 import org.opendaylight.openflowplugin.impl.util.NodeConnectorRefToPortTranslator;
  20 import org.opendaylight.openflowplugin.openflow.md.core.extension.MatchExtensionHelper;
  21 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  22 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionDatapathIdConvertorData;
  23 import org.opendaylight.openflowplugin.impl.util.PacketInUtil;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceivedBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.MatchBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId;
  31
  32 public class PacketReceivedTranslator implements MessageTranslator<PacketInMessage, PacketReceived> {
  33     private final ConvertorExecutor convertorExecutor;
  34
  35     public PacketReceivedTranslator(ConvertorExecutor convertorExecutor) {
  36         this.convertorExecutor = convertorExecutor;
  37     }
  38
  39     @Override
  40     public PacketReceived translate(final PacketInMessage input,
  41                                     final DeviceInfo deviceInfo,
  42                                     final Object connectionDistinguisher) {
  43
  44         PacketReceivedBuilder packetReceivedBuilder = new PacketReceivedBuilder();
  45         BigInteger datapathId = deviceInfo.getDatapathId();
  46
  47         // TODO: connection cookie from connection distinguisher
  48         packetReceivedBuilder.setPayload(input.getData());
  49
  50         // get the Cookie if it exists
  51         if (input.getCookie() != null) {
  52             packetReceivedBuilder.setFlowCookie(new FlowCookie(input.getCookie()));
  53         }
  54
  55         // Try to create the NodeConnectorRef
  56         BigInteger dataPathId = deviceInfo.getDatapathId();
  57         NodeConnectorRef nodeConnectorRef = NodeConnectorRefToPortTranslator.toNodeConnectorRef(input, dataPathId);
  58
  59         // If we was able to create NodeConnectorRef, use it
  60         if (nodeConnectorRef != null) {
  61             packetReceivedBuilder.setIngress(nodeConnectorRef);
  62         }
  63
  64         packetReceivedBuilder.setPacketInReason(PacketInUtil.getMdSalPacketInReason(input.getReason()));
  65
  66         if (input.getTableId() != null) {
  67             packetReceivedBuilder.setTableId(new TableId(input.getTableId().getValue().shortValue()));
  68         }
  69
  70         if (input.getMatch() != null) {
  71             org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match packetInMatch =
  72                     getPacketInMatch(input, datapathId);
  73             packetReceivedBuilder.setMatch(packetInMatch);
  74         }
  75
  76         return packetReceivedBuilder.build();
  77     }
  78
  79     @VisibleForTesting
  80     org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match
  81             getPacketInMatch(final PacketInMessage input, final BigInteger datapathId) {
  82
  83         final VersionDatapathIdConvertorData datapathIdConvertorData =
  84                 new VersionDatapathIdConvertorData(input.getVersion());
  85         datapathIdConvertorData.setDatapathId(datapathId);
  86
  87         final Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder>
  88                 matchOptional = convertorExecutor.convert(input.getMatch(), datapathIdConvertorData);
  89         final MatchBuilder matchBuilder = matchOptional.map(matchBuilder1 -> new MatchBuilder(matchBuilder1.build())).orElseGet(MatchBuilder::new);
  90
  91         final AugmentTuple<org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match>
  92                 matchExtensionWrap = MatchExtensionHelper.processAllExtensions(
  93                         input.getMatch().getMatchEntry(),
  94                         OpenflowVersion.get(input.getVersion()),
  95                         MatchPath.PACKETRECEIVED_MATCH);
  96
  97         if (matchExtensionWrap != null) {
  98             matchBuilder.addAugmentation(matchExtensionWrap.getAugmentationClass(),
  99                                          matchExtensionWrap.getAugmentationObject());
 100         }
 101
 102         return matchBuilder.build();
 103     }
 104 }