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