openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/util/DeviceInitializationUtils.java

   1 /*
   2  * Copyright (c) 2016 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.util;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.AsyncFunction;
  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.SettableFuture;
  17 import java.math.BigInteger;
  18 import java.net.InetSocketAddress;
  19 import java.util.Arrays;
  20 import java.util.Collection;
  21 import java.util.Collections;
  22 import java.util.Iterator;
  23 import java.util.List;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  26 import org.opendaylight.openflowplugin.api.ConnectionException;
  27 import org.opendaylight.openflowplugin.api.OFConstants;
  28 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  29 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  30 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  31 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  32 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  33 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  34 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  35 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  36 import org.opendaylight.openflowplugin.impl.common.MultipartRequestInputFactory;
  37 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  38 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IetfInetUtil;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.MultipartReplyBody;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCase;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCase;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDesc;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeatures;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeatures;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.MultipartReplyPortDesc;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.MultipartReplyTableFeatures;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
  77 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  78 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  79 import org.opendaylight.yangtools.yang.common.RpcError;
  80 import org.opendaylight.yangtools.yang.common.RpcResult;
  81 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  82 import org.slf4j.Logger;
  83 import org.slf4j.LoggerFactory;
  84
  85 public class DeviceInitializationUtils {
  86
  87     private static final Logger LOG = LoggerFactory.getLogger(DeviceInitializationUtils.class);
  88
  89     /**
  90      * InitializationNodeInformation is good to call only for MASTER otherwise we will have not empty transaction
  91      * for every Cluster Node (SLAVE too) and we will get race-condition by closing Connection.
  92      *
  93      * @param deviceContext
  94      * @param switchFeaturesMandatory
  95      * @return future - recommended to have blocking call for this future
  96      */
  97     public static ListenableFuture<Void> initializeNodeInformation(final DeviceContext deviceContext, final boolean switchFeaturesMandatory) {
  98         Preconditions.checkArgument(deviceContext != null);
  99         final DeviceState deviceState = Preconditions.checkNotNull(deviceContext.getDeviceState());
 100         final ConnectionContext connectionContext = Preconditions.checkNotNull(deviceContext.getPrimaryConnectionContext());
 101         final short version = deviceState.getVersion();
 102         LOG.trace("initalizeNodeInformation for node {}", deviceState.getNodeId());
 103         final SettableFuture<Void> returnFuture = SettableFuture.<Void>create();
 104         addNodeToOperDS(deviceContext, returnFuture);
 105         final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture;
 106         if (OFConstants.OFP_VERSION_1_0 == version) {
 107             final CapabilitiesV10 capabilitiesV10 = connectionContext.getFeatures().getCapabilitiesV10();
 108
 109             DeviceStateUtil.setDeviceStateBasedOnV10Capabilities(deviceState, capabilitiesV10);
 110
 111             deviceFeaturesFuture = createDeviceFeaturesForOF10(deviceContext, deviceState);
 112             // create empty tables after device description is processed
 113             chainTableTrunkWriteOF10(deviceContext, deviceFeaturesFuture);
 114
 115             final short ofVersion = deviceContext.getDeviceState().getVersion();
 116             final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
 117             final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = deviceContext.oook()
 118                     .lookupTranslator(translatorKey);
 119             final BigInteger dataPathId = deviceContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
 120
 121             for (final PortGrouping port : connectionContext.getFeatures().getPhyPort()) {
 122                 final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, deviceContext.getDeviceState(), null);
 123
 124                 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(
 125                         dataPathId.toString(), port.getPortNo(), ofVersion);
 126                 final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
 127                 ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
 128                 ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class,
 129                         new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 130                 final NodeConnector connector = ncBuilder.build();
 131                 final InstanceIdentifier<NodeConnector> connectorII = deviceState.getNodeInstanceIdentifier().child(
 132                         NodeConnector.class, connector.getKey());
 133                 try {
 134                     deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
 135                 } catch (final Exception e) {
 136                     LOG.debug("Failed to write node {} to DS ", deviceContext.getDeviceState().getNodeId().toString(),
 137                             e);
 138                 }
 139
 140             }
 141         } else if (OFConstants.OFP_VERSION_1_3 == version) {
 142             final Capabilities capabilities = connectionContext.getFeatures().getCapabilities();
 143             LOG.debug("Setting capabilities for device {}", deviceContext.getDeviceState().getNodeId());
 144             DeviceStateUtil.setDeviceStateBasedOnV13Capabilities(deviceState, capabilities);
 145             deviceFeaturesFuture = createDeviceFeaturesForOF13(deviceContext, deviceState, switchFeaturesMandatory);
 146         } else {
 147             deviceFeaturesFuture = Futures.immediateFailedFuture(new ConnectionException("Unsupported version "
 148                     + version));
 149         }
 150
 151         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
 152             @Override
 153             public void onSuccess(final List<RpcResult<List<MultipartReply>>> result) {
 154                 LOG.debug("All init data for node {} is in submited.", deviceState.getNodeId());
 155                 returnFuture.set(null);
 156             }
 157
 158             @Override
 159             public void onFailure(final Throwable t) {
 160                 // FIXME : remove session
 161                 LOG.trace("Device capabilities gathering future failed.");
 162                 LOG.trace("more info in exploration failure..", t);
 163                 LOG.debug("All init data for node {} was not submited correctly - connection has to go down.", deviceState.getNodeId());
 164                 returnFuture.setException(t);
 165             }
 166         });
 167         return returnFuture;
 168     }
 169
 170     private static void addNodeToOperDS(final DeviceContext deviceContext, final SettableFuture<Void> future) {
 171         Preconditions.checkArgument(deviceContext != null);
 172         final DeviceState deviceState = deviceContext.getDeviceState();
 173         final NodeBuilder nodeBuilder = new NodeBuilder().setId(deviceState.getNodeId()).setNodeConnector(
 174                 Collections.<NodeConnector>emptyList());
 175         try {
 176             deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, deviceState.getNodeInstanceIdentifier(),
 177                     nodeBuilder.build());
 178         } catch (final Exception e) {
 179             LOG.warn("Failed to write node {} to DS ", deviceState.getNodeId(), e);
 180             future.cancel(true);
 181         }
 182     }
 183
 184     private static ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF10(
 185             final DeviceContext deviceContext, final DeviceState deviceState) {
 186         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
 187                 deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 188
 189         return Futures.allAsList(Arrays.asList(replyDesc));
 190     }
 191
 192     private static ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF13(
 193             final DeviceContext deviceContext, final DeviceState deviceState, final boolean switchFeaturesMandatory) {
 194
 195         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
 196                 deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 197
 198         //first process description reply, write data to DS and write consequent data if successful
 199         return Futures.transform(replyDesc,
 200                 new AsyncFunction<RpcResult<List<MultipartReply>>, List<RpcResult<List<MultipartReply>>>>() {
 201                     @Override
 202                     public ListenableFuture<List<RpcResult<List<MultipartReply>>>> apply(
 203                             final RpcResult<List<MultipartReply>> rpcResult) throws Exception {
 204
 205                         translateAndWriteReply(MultipartType.OFPMPDESC, deviceContext,
 206                                 deviceState.getNodeInstanceIdentifier(), rpcResult.getResult());
 207
 208                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyMeterFeature = getNodeStaticInfo(
 209                                 MultipartType.OFPMPMETERFEATURES, deviceContext,
 210                                 deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 211
 212                         createSuccessProcessingCallback(MultipartType.OFPMPMETERFEATURES, deviceContext,
 213                                 deviceState.getNodeInstanceIdentifier(), replyMeterFeature);
 214
 215                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyGroupFeatures = getNodeStaticInfo(
 216                                 MultipartType.OFPMPGROUPFEATURES, deviceContext,
 217                                 deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 218                         createSuccessProcessingCallback(MultipartType.OFPMPGROUPFEATURES, deviceContext,
 219                                 deviceState.getNodeInstanceIdentifier(), replyGroupFeatures);
 220
 221                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyTableFeatures = getNodeStaticInfo(
 222                                 MultipartType.OFPMPTABLEFEATURES, deviceContext,
 223                                 deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 224                         createSuccessProcessingCallback(MultipartType.OFPMPTABLEFEATURES, deviceContext,
 225                                 deviceState.getNodeInstanceIdentifier(), replyTableFeatures);
 226
 227                         final ListenableFuture<RpcResult<List<MultipartReply>>> replyPortDescription = getNodeStaticInfo(
 228                                 MultipartType.OFPMPPORTDESC, deviceContext, deviceState.getNodeInstanceIdentifier(),
 229                                 deviceState.getVersion());
 230                         createSuccessProcessingCallback(MultipartType.OFPMPPORTDESC, deviceContext,
 231                                 deviceState.getNodeInstanceIdentifier(), replyPortDescription);
 232                         if (switchFeaturesMandatory) {
 233                             return Futures.allAsList(Arrays.asList(replyMeterFeature, replyGroupFeatures,
 234                                     replyTableFeatures, replyPortDescription));
 235                         } else {
 236                             return Futures.successfulAsList(Arrays.asList(replyMeterFeature, replyGroupFeatures,
 237                                     replyTableFeatures, replyPortDescription));
 238                         }
 239                     }
 240                 });
 241
 242     }
 243
 244     static void translateAndWriteReply(final MultipartType type, final DeviceContext dContext,
 245                                        final InstanceIdentifier<Node> nodeII, final Collection<MultipartReply> result) {
 246         try {
 247             for (final MultipartReply reply : result) {
 248                 final MultipartReplyBody body = reply.getMultipartReplyBody();
 249                 switch (type) {
 250                     case OFPMPDESC:
 251                         Preconditions.checkArgument(body instanceof MultipartReplyDescCase);
 252                         final MultipartReplyDesc replyDesc = ((MultipartReplyDescCase) body).getMultipartReplyDesc();
 253                         final FlowCapableNode fcNode = NodeStaticReplyTranslatorUtil.nodeDescTranslator(replyDesc,
 254                                 getIpAddressOf(dContext));
 255                         final InstanceIdentifier<FlowCapableNode> fNodeII = nodeII.augmentation(FlowCapableNode.class);
 256                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, fcNode);
 257                         break;
 258
 259                     case OFPMPTABLEFEATURES:
 260                         Preconditions.checkArgument(body instanceof MultipartReplyTableFeaturesCase);
 261                         final MultipartReplyTableFeatures tableFeaturesMP = ((MultipartReplyTableFeaturesCase) body)
 262                                 .getMultipartReplyTableFeatures();
 263                         final List<TableFeatures> tableFeatures = NodeStaticReplyTranslatorUtil
 264                                 .nodeTableFeatureTranslator(tableFeaturesMP);
 265                         for (final TableFeatures tableFeature : tableFeatures) {
 266                             final Short tableId = tableFeature.getTableId();
 267                             final KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII =
 268                                     nodeII.augmentation(FlowCapableNode.class)
 269                                             .child(TableFeatures.class, new TableFeaturesKey(tableId));
 270                             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableFeaturesII, tableFeature);
 271
 272                             // write parent for table statistics
 273                             final KeyedInstanceIdentifier<Table, TableKey> tableII =
 274                                     nodeII.augmentation(FlowCapableNode.class)
 275                                             .child(Table.class, new TableKey(tableId));
 276                             final TableBuilder tableBld = new TableBuilder().setId(tableId)
 277                                     .addAugmentation(FlowTableStatisticsData.class,
 278                                             new FlowTableStatisticsDataBuilder().build());
 279
 280                             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBld.build());
 281                         }
 282                         break;
 283
 284                     case OFPMPMETERFEATURES:
 285                         Preconditions.checkArgument(body instanceof MultipartReplyMeterFeaturesCase);
 286                         final MultipartReplyMeterFeatures meterFeatures = ((MultipartReplyMeterFeaturesCase) body)
 287                                 .getMultipartReplyMeterFeatures();
 288                         final NodeMeterFeatures mFeature = NodeStaticReplyTranslatorUtil
 289                                 .nodeMeterFeatureTranslator(meterFeatures);
 290                         final InstanceIdentifier<NodeMeterFeatures> mFeatureII = nodeII
 291                                 .augmentation(NodeMeterFeatures.class);
 292                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, mFeatureII, mFeature);
 293                         if (0L < mFeature.getMeterFeatures().getMaxMeter().getValue()) {
 294                             dContext.getDeviceState().setMeterAvailable(true);
 295                         }
 296                         break;
 297
 298                     case OFPMPGROUPFEATURES:
 299                         Preconditions.checkArgument(body instanceof MultipartReplyGroupFeaturesCase);
 300                         final MultipartReplyGroupFeatures groupFeatures = ((MultipartReplyGroupFeaturesCase) body)
 301                                 .getMultipartReplyGroupFeatures();
 302                         final NodeGroupFeatures gFeature = NodeStaticReplyTranslatorUtil
 303                                 .nodeGroupFeatureTranslator(groupFeatures);
 304                         final InstanceIdentifier<NodeGroupFeatures> gFeatureII = nodeII
 305                                 .augmentation(NodeGroupFeatures.class);
 306                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, gFeatureII, gFeature);
 307                         break;
 308
 309                     case OFPMPPORTDESC:
 310                         Preconditions.checkArgument(body instanceof MultipartReplyPortDescCase);
 311                         final MultipartReplyPortDesc portDesc = ((MultipartReplyPortDescCase) body)
 312                                 .getMultipartReplyPortDesc();
 313                         for (final PortGrouping port : portDesc.getPorts()) {
 314                             final short ofVersion = dContext.getDeviceState().getVersion();
 315                             final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
 316                             final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = dContext.oook()
 317                                     .lookupTranslator(translatorKey);
 318                             final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, dContext.getDeviceState(), null);
 319
 320                             final BigInteger dataPathId = dContext.getPrimaryConnectionContext().getFeatures()
 321                                     .getDatapathId();
 322                             final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(
 323                                     dataPathId.toString(), port.getPortNo(), ofVersion);
 324                             final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
 325                             ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
 326
 327                             ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class,
 328                                     new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 329                             final NodeConnector connector = ncBuilder.build();
 330
 331                             final InstanceIdentifier<NodeConnector> connectorII = nodeII.child(NodeConnector.class,
 332                                     connector.getKey());
 333                             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
 334                         }
 335
 336                         break;
 337
 338                     default:
 339                         throw new IllegalArgumentException("Unnexpected MultipartType " + type);
 340                 }
 341             }
 342         } catch (final Exception e) {
 343             LOG.debug("Failed to write node {} to DS ", dContext.getDeviceState().getNodeId().toString(), e);
 344         }
 345     }
 346
 347     private static void createEmptyFlowCapableNodeInDs(final DeviceContext deviceContext) {
 348         final FlowCapableNodeBuilder flowCapableNodeBuilder = new FlowCapableNodeBuilder();
 349         final InstanceIdentifier<FlowCapableNode> fNodeII = deviceContext.getDeviceState().getNodeInstanceIdentifier()
 350                 .augmentation(FlowCapableNode.class);
 351         try {
 352             deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, flowCapableNodeBuilder.build());
 353         } catch (final Exception e) {
 354             LOG.debug("Failed to write node {} to DS ", deviceContext.getDeviceState().getNodeId().toString(), e);
 355         }
 356     }
 357
 358     private static IpAddress getIpAddressOf(final DeviceContext deviceContext) {
 359
 360         final InetSocketAddress remoteAddress = deviceContext.getPrimaryConnectionContext().getConnectionAdapter()
 361                 .getRemoteAddress();
 362
 363         if (remoteAddress == null) {
 364             LOG.warn("IP address of the node {} cannot be obtained. No connection with switch.", deviceContext
 365                     .getDeviceState().getNodeId());
 366             return null;
 367         }
 368         LOG.info("IP address of switch is: {}", remoteAddress);
 369
 370         return IetfInetUtil.INSTANCE.ipAddressFor(remoteAddress.getAddress());
 371     }
 372
 373     // FIXME : remove after ovs tableFeatures fix
 374     private static void makeEmptyTables(final DeviceContext dContext, final InstanceIdentifier<Node> nodeII,
 375                                         final Short nrOfTables) {
 376         LOG.debug("About to create {} empty tables.", nrOfTables);
 377         for (int i = 0; i < nrOfTables; i++) {
 378             final short tId = (short) i;
 379             final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class,
 380                     new TableKey(tId));
 381             final TableBuilder tableBuilder = new TableBuilder().setId(tId).addAugmentation(
 382                     FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
 383
 384             try {
 385                 dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
 386             } catch (final Exception e) {
 387                 LOG.debug("Failed to write node {} to DS ", dContext.getDeviceState().getNodeId().toString(), e);
 388             }
 389
 390         }
 391     }
 392
 393     static void createSuccessProcessingCallback(final MultipartType type, final DeviceContext deviceContext,
 394                                                 final InstanceIdentifier<Node> nodeII,
 395                                                 final ListenableFuture<RpcResult<List<MultipartReply>>> requestContextFuture) {
 396         Futures.addCallback(requestContextFuture, new FutureCallback<RpcResult<List<MultipartReply>>>() {
 397             @Override
 398             public void onSuccess(final RpcResult<List<MultipartReply>> rpcResult) {
 399                 final List<MultipartReply> result = rpcResult.getResult();
 400                 if (result != null) {
 401                     LOG.info("Static node {} info: {} collected", deviceContext.getDeviceState().getNodeId(), type);
 402                     translateAndWriteReply(type, deviceContext, nodeII, result);
 403                 } else {
 404                     final Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
 405                     while (rpcErrorIterator.hasNext()) {
 406                         final RpcError rpcError = rpcErrorIterator.next();
 407                         LOG.info("Failed to retrieve static node {} info: {}", type, rpcError.getMessage());
 408                         if (null != rpcError.getCause()) {
 409                             LOG.trace("Detailed error:", rpcError.getCause());
 410                         }
 411                     }
 412                     if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
 413                         makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext()
 414                                 .getFeatures().getTables());
 415                     }
 416                 }
 417             }
 418
 419             @Override
 420             public void onFailure(final Throwable throwable) {
 421                 LOG.info("Request of type {} for static info of node {} failed.", type, nodeII);
 422             }
 423         });
 424     }
 425
 426     private static ListenableFuture<RpcResult<List<MultipartReply>>> getNodeStaticInfo(final MultipartType type,
 427                                                                                        final DeviceContext deviceContext, final InstanceIdentifier<Node> nodeII, final short version) {
 428
 429         final OutboundQueue queue = deviceContext.getPrimaryConnectionContext().getOutboundQueueProvider();
 430
 431         final Long reserved = deviceContext.reserveXidForDeviceMessage();
 432         final RequestContext<List<MultipartReply>> requestContext = new AbstractRequestContext<List<MultipartReply>>(
 433                 reserved) {
 434             @Override
 435             public void close() {
 436                 //NOOP
 437             }
 438         };
 439
 440         final Xid xid = requestContext.getXid();
 441
 442         LOG.trace("Hooking xid {} to device context - precaution.", reserved);
 443
 444         final MultiMsgCollector multiMsgCollector = deviceContext.getMultiMsgCollector(requestContext);
 445         queue.commitEntry(xid.getValue(),
 446                 MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type),
 447                 new FutureCallback<OfHeader>() {
 448                     @Override
 449                     public void onSuccess(final OfHeader ofHeader) {
 450                         if (ofHeader instanceof MultipartReply) {
 451                             final MultipartReply multipartReply = (MultipartReply) ofHeader;
 452                             multiMsgCollector.addMultipartMsg(multipartReply);
 453                         } else if (null != ofHeader) {
 454                             LOG.info("Unexpected response type received {}.", ofHeader.getClass());
 455                         } else {
 456                             multiMsgCollector.endCollecting();
 457                             LOG.info("Response received is null.");
 458                         }
 459                     }
 460
 461                     @Override
 462                     public void onFailure(final Throwable t) {
 463                         LOG.info("Fail response from OutboundQueue for multipart type {}.", type);
 464                         final RpcResult<List<MultipartReply>> rpcResult = RpcResultBuilder
 465                                 .<List<MultipartReply>>failed().build();
 466                         requestContext.setResult(rpcResult);
 467                         if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
 468                             makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext()
 469                                     .getFeatures().getTables());
 470                         }
 471                         requestContext.close();
 472                     }
 473                 });
 474
 475         return requestContext.getFuture();
 476     }
 477
 478     static void chainTableTrunkWriteOF10(final DeviceContext deviceContext,
 479                                          final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture) {
 480         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
 481             @Override
 482             public void onSuccess(final List<RpcResult<List<MultipartReply>>> results) {
 483                 boolean allSucceeded = true;
 484                 for (final RpcResult<List<MultipartReply>> rpcResult : results) {
 485                     allSucceeded &= rpcResult.isSuccessful();
 486                 }
 487                 if (allSucceeded) {
 488                     createEmptyFlowCapableNodeInDs(deviceContext);
 489                     makeEmptyTables(deviceContext, deviceContext.getDeviceState().getNodeInstanceIdentifier(),
 490                             deviceContext.getDeviceState().getFeatures().getTables());
 491                 }
 492             }
 493
 494             @Override
 495             public void onFailure(final Throwable t) {
 496                 //NOOP
 497             }
 498         });
 499     }
 500 }