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