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