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