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.List;
  14 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  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.match.MatchConvertorImpl;
  22 import org.opendaylight.openflowplugin.openflow.md.util.PacketInUtil;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.InPortCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceivedBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.MatchBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId;
  33
  34 /**
  35  * Created by tkubas on 4/1/15.
  36  */
  37 public class PacketReceivedTranslator implements MessageTranslator<PacketInMessage, PacketReceived> {
  38     @Override
  39     public PacketReceived translate(final PacketInMessage input, final DeviceContext deviceContext, final Object connectionDistinguisher) {
  40
  41         PacketReceivedBuilder packetReceivedBuilder = new PacketReceivedBuilder();
  42         BigInteger datapathId = deviceContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
  43
  44         // TODO: connection cookie from connection distinguisher
  45         // packetReceivedBuilder.setConnectionCookie(new ConnectionCookie(input.getCookie().longValue()));
  46
  47         packetReceivedBuilder.setPayload(input.getData());
  48
  49         // get the Cookie if it exists
  50         if (input.getCookie() != null) {
  51             packetReceivedBuilder.setFlowCookie(new FlowCookie(input.getCookie()));
  52         }
  53
  54         NodeConnectorRef nodeConnectorRef = NodeConnectorRefToPortTranslator.toNodeConnectorRef(deviceContext.getDeviceState());
  55
  56         if (nodeConnectorRef != null) {
  57             packetReceivedBuilder.setIngress(nodeConnectorRef);
  58         }
  59
  60         packetReceivedBuilder.setPacketInReason(PacketInUtil.getMdSalPacketInReason(input.getReason()));
  61
  62         if (input.getTableId() != null) {
  63             packetReceivedBuilder.setTableId(new TableId(input.getTableId().getValue().shortValue()));
  64         }
  65
  66         if (input.getMatch() != null) {
  67             org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match packetInMatch = getPacketInMatch(input, datapathId);
  68             packetReceivedBuilder.setMatch(packetInMatch);
  69         }
  70
  71         return packetReceivedBuilder.build();
  72     }
  73
  74     @VisibleForTesting
  75     static org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match getPacketInMatch(final PacketInMessage input, final BigInteger datapathId) {
  76         Match match = MatchConvertorImpl.fromOFMatchToSALMatch(input.getMatch(),
  77                 datapathId,
  78                 OpenflowVersion.get(input.getVersion().shortValue())).build();
  79         MatchBuilder matchBuilder = new MatchBuilder(match);
  80
  81         AugmentTuple<org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match> matchExtensionWrap =
  82                 MatchExtensionHelper.processAllExtensions(
  83                         input.getMatch().getMatchEntry(), OpenflowVersion.get(input.getVersion().shortValue()), MatchPath.PACKETRECEIVED_MATCH);
  84         if (matchExtensionWrap != null) {
  85             matchBuilder.addAugmentation(matchExtensionWrap.getAugmentationClass(), matchExtensionWrap.getAugmentationObject());
  86         }
  87         return matchBuilder.build();
  88     }
  89
  90     @VisibleForTesting
  91     static Long getPortNumberFromMatch(final List<MatchEntry> entries) {
  92         Long port = null;
  93         for (MatchEntry entry : entries) {
  94             if (InPortCase.class.equals(entry.getMatchEntryValue().getImplementedInterface())) {
  95                 InPortCase inPortCase = ((InPortCase) entry.getMatchEntryValue());
  96                 org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.in.port._case.InPort inPort = inPortCase.getInPort();
  97                 if (inPort != null) {
  98                     port = inPort.getPortNumber().getValue();
  99                     break;
 100                 }
 101             }
 102         }
 103         return port;
 104     }
 105 }