openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/initialization/OF10DeviceInitializer.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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 package org.opendaylight.openflowplugin.impl.device.initialization;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import java.util.concurrent.Future;
  17 import javax.annotation.Nonnull;
  18 import javax.annotation.Nullable;
  19 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  20 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  22 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  24 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  25 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
  26 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  27 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  28 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
  29 import org.opendaylight.openflowplugin.impl.services.multilayer.MultiLayerMultipartCollectorService;
  30 import org.opendaylight.openflowplugin.impl.services.singlelayer.SingleLayerMultipartCollectorService;
  31 import org.opendaylight.openflowplugin.impl.util.DeviceInitializationUtil;
  32 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
  33 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  34 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  47 import org.opendaylight.yangtools.yang.common.RpcResult;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 public class OF10DeviceInitializer extends AbstractDeviceInitializer {
  52
  53     private static final Logger LOG = LoggerFactory.getLogger(OF10DeviceInitializer.class);
  54
  55     @Override
  56     protected Future<Void> initializeNodeInformation(@Nonnull final DeviceContext deviceContext,
  57                                                      final boolean switchFeaturesMandatory,
  58                                                      final boolean skipTableFeatures,
  59                                                      @Nullable final MultipartWriterProvider multipartWriterProvider,
  60                                                      @Nullable final ConvertorExecutor convertorExecutor) {
  61         final ConnectionContext connectionContext =
  62                 Preconditions.checkNotNull(deviceContext.getPrimaryConnectionContext());
  63         final DeviceState deviceState = Preconditions.checkNotNull(deviceContext.getDeviceState());
  64         final DeviceInfo deviceInfo = Preconditions.checkNotNull(deviceContext.getDeviceInfo());
  65         final CapabilitiesV10 capabilitiesV10 = connectionContext.getFeatures().getCapabilitiesV10();
  66
  67         // Set capabilities for this device based on capabilities of connection context
  68         LOG.debug("Setting capabilities for device {}", deviceInfo);
  69         DeviceStateUtil.setDeviceStateBasedOnV10Capabilities(deviceState, capabilitiesV10);
  70         final ListenableFuture<Boolean> future = requestMultipart(MultipartType.OFPMPDESC, deviceContext);
  71
  72         Futures.addCallback(future, new FutureCallback<Boolean>() {
  73             @Override
  74             public void onSuccess(@Nullable final Boolean result) {
  75                 if (Boolean.TRUE.equals(result)) {
  76                     LOG.debug("Creating empty flow capable node: {}", deviceInfo);
  77                     makeEmptyFlowCapableNode(deviceContext, deviceInfo);
  78
  79                     LOG.debug("Creating empty tables for {}", deviceInfo);
  80                     DeviceInitializationUtil.makeEmptyTables(
  81                         deviceContext,
  82                         deviceInfo,
  83                         deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
  84                 }
  85             }
  86
  87             @Override
  88             public void onFailure(@Nonnull final Throwable throwable) {
  89                 LOG.warn("Error occurred in preparation node {} for protocol 1.0", deviceInfo);
  90                 LOG.trace("Error for node {} : ", deviceInfo, throwable);
  91             }
  92         }, MoreExecutors.directExecutor());
  93
  94         return Futures.transform(future, new Function<Boolean, Void>() {
  95             @Nullable
  96             @Override
  97             public Void apply(@Nullable final Boolean input) {
  98                 LOG.debug("Writing physical port information for {}", deviceInfo);
  99                 writePhyPortInformation(deviceContext);
 100                 return null;
 101             }
 102         }, MoreExecutors.directExecutor());
 103     }
 104
 105     @SuppressWarnings("checkstyle:IllegalCatch")
 106     private static void writePhyPortInformation(final DeviceContext deviceContext) {
 107         final DeviceInfo deviceInfo = deviceContext.getDeviceInfo();
 108         final ConnectionContext connectionContext = deviceContext.getPrimaryConnectionContext();
 109         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = deviceContext
 110             .oook()
 111             .lookupTranslator(new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
 112
 113         connectionContext.getFeatures().getPhyPort().forEach(port -> {
 114             final NodeConnectorId nodeConnectorId = InventoryDataServiceUtil.nodeConnectorIdfromDatapathPortNo(
 115                 deviceInfo.getDatapathId(),
 116                 port.getPortNo(),
 117                 OpenflowVersion.get(deviceInfo.getVersion()));
 118
 119             try {
 120                 deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL,
 121                     deviceInfo
 122                         .getNodeInstanceIdentifier()
 123                         .child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId)),
 124                     new NodeConnectorBuilder()
 125                         .setId(nodeConnectorId)
 126                         .addAugmentation(
 127                             FlowCapableNodeConnector.class,
 128                             translator.translate(port, deviceInfo, null))
 129                         .addAugmentation(
 130                             FlowCapableNodeConnectorStatisticsData.class,
 131                             new FlowCapableNodeConnectorStatisticsDataBuilder().build())
 132                         .build());
 133             } catch (final Exception e) {
 134                 LOG.debug("Failed to write node {} to DS ", deviceInfo, e);
 135             }
 136         });
 137     }
 138
 139     @SuppressWarnings("checkstyle:IllegalCatch")
 140     private static void makeEmptyFlowCapableNode(final TxFacade txFacade, final DeviceInfo deviceInfo) {
 141         try {
 142             txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL,
 143                 deviceInfo
 144                     .getNodeInstanceIdentifier()
 145                     .augmentation(FlowCapableNode.class),
 146                 new FlowCapableNodeBuilder().build());
 147         } catch (final Exception e) {
 148             LOG.debug("Failed to write empty node {} to DS ", deviceInfo, e);
 149         }
 150     }
 151
 152     private static ListenableFuture<Boolean> requestMultipart(final MultipartType multipartType,
 153                                                               final DeviceContext deviceContext) {
 154         if (deviceContext.canUseSingleLayerSerialization()) {
 155             final SingleLayerMultipartCollectorService service =
 156                     new SingleLayerMultipartCollectorService(deviceContext, deviceContext);
 157
 158             return Futures.transform(service.handleServiceCall(multipartType),
 159                 RpcResult::isSuccessful, MoreExecutors.directExecutor());
 160         }
 161
 162         final MultiLayerMultipartCollectorService service =
 163                 new MultiLayerMultipartCollectorService(deviceContext, deviceContext);
 164
 165         return Futures.transform(service.handleServiceCall(multipartType),
 166             RpcResult::isSuccessful, MoreExecutors.directExecutor());
 167     }
 168
 169 }