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