openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceManagerImpl.java

   1 /**
   2  * Copyright (c) 2015 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 package org.opendaylight.openflowplugin.impl.device;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.AsyncFunction;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import io.netty.util.HashedWheelTimer;
  16 import java.math.BigInteger;
  17 import java.util.ArrayList;
  18 import java.util.Arrays;
  19 import java.util.Collection;
  20 import java.util.Collections;
  21 import java.util.Iterator;
  22 import java.util.List;
  23 import java.util.concurrent.ExecutionException;
  24 import java.util.concurrent.ScheduledThreadPoolExecutor;
  25 import java.util.concurrent.TimeUnit;
  26 import javax.annotation.CheckForNull;
  27 import javax.annotation.Nonnull;
  28 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  29 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  30 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  31 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  34 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  35 import org.opendaylight.openflowplugin.api.ConnectionException;
  36 import org.opendaylight.openflowplugin.api.OFConstants;
  37 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  38 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  39 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  40 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  41 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  42 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  43 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  44 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  45 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  46 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  47 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  48 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  49 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  50 import org.opendaylight.openflowplugin.impl.common.MultipartRequestInputFactory;
  51 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  52 import org.opendaylight.openflowplugin.impl.connection.OutboundQueueProviderImpl;
  53 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
  54 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
  55 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.MultipartReplyBody;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCase;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCase;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDesc;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeatures;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeatures;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.MultipartReplyPortDesc;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.MultipartReplyTableFeatures;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
  93 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  94 import org.opendaylight.yangtools.yang.common.RpcError;
  95 import org.opendaylight.yangtools.yang.common.RpcResult;
  96 import org.slf4j.Logger;
  97 import org.slf4j.LoggerFactory;
  98
  99 /**
 100  *
 101  */
 102 public class DeviceManagerImpl implements DeviceManager, AutoCloseable {
 103
 104     private static final Logger LOG = LoggerFactory.getLogger(DeviceManagerImpl.class);
 105
 106     private static final long TICK_DURATION = 10; // 0.5 sec.
 107     private ScheduledThreadPoolExecutor spyPool;
 108     private final int spyRate = 10;
 109
 110     private final DataBroker dataBroker;
 111     private final HashedWheelTimer hashedWheelTimer;
 112     private TranslatorLibrary translatorLibrary;
 113     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
 114     private NotificationService notificationService;
 115     private NotificationPublishService notificationPublishService;
 116
 117     private final List<DeviceContext> deviceContexts = new ArrayList<DeviceContext>();
 118     private final MessageIntelligenceAgency messageIntelligenceAgency;
 119
 120     private final long barrierNanos = TimeUnit.MILLISECONDS.toNanos(500);
 121     private final int maxQueueDepth = 25600;
 122
 123     public DeviceManagerImpl(@Nonnull final DataBroker dataBroker,
 124                              @Nonnull final MessageIntelligenceAgency messageIntelligenceAgency) {
 125         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 126         hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, 500);
 127         /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
 128         final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 129
 130         final NodesBuilder nodesBuilder = new NodesBuilder();
 131         nodesBuilder.setNode(Collections.<Node>emptyList());
 132         tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), nodesBuilder.build());
 133         try {
 134             tx.submit().get();
 135         } catch (ExecutionException | InterruptedException e) {
 136             LOG.error("Creation of node failed.", e);
 137             throw new IllegalStateException(e);
 138         }
 139
 140         this.messageIntelligenceAgency = messageIntelligenceAgency;
 141     }
 142
 143     @Override
 144     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
 145         deviceInitPhaseHandler = handler;
 146     }
 147
 148     @Override
 149     public void onDeviceContextLevelUp(final DeviceContext deviceContext) {
 150         // final phase - we have to add new Device to MD-SAL DataStore
 151         Preconditions.checkNotNull(deviceContext);
 152         ((DeviceContextImpl) deviceContext).initialSubmitTransaction();
 153
 154         deviceContext.onPublished();
 155     }
 156
 157     @Override
 158     public void deviceConnected(@CheckForNull final ConnectionContext connectionContext) {
 159         Preconditions.checkArgument(connectionContext != null);
 160
 161         // Cache this for clarity
 162         final ConnectionAdapter connectionAdapter = connectionContext.getConnectionAdapter();
 163
 164         //FIXME: as soon as auxiliary connection are fully supported then this is needed only before device context published
 165         connectionAdapter.setPacketInFiltering(true);
 166
 167         final Short version = connectionContext.getFeatures().getVersion();
 168         final OutboundQueueProvider outboundQueueProvider = new OutboundQueueProviderImpl(version);
 169
 170         final DeviceState deviceState = new DeviceStateImpl(connectionContext.getFeatures(), connectionContext.getNodeId());
 171
 172         final DeviceContext deviceContext = new DeviceContextImpl(connectionContext, deviceState, dataBroker, hashedWheelTimer, messageIntelligenceAgency);
 173         deviceContext.registerOutboundQueueProvider(outboundQueueProvider, maxQueueDepth, barrierNanos);
 174         deviceContext.setNotificationService(notificationService);
 175         deviceContext.setNotificationPublishService(notificationPublishService);
 176         final NodeBuilder nodeBuilder = new NodeBuilder().setId(deviceState.getNodeId()).setNodeConnector(Collections.<NodeConnector>emptyList());
 177         deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, deviceState.getNodeInstanceIdentifier(), nodeBuilder.build());
 178
 179         connectionContext.setDeviceDisconnectedHandler(deviceContext);
 180         deviceContext.setTranslatorLibrary(translatorLibrary);
 181         deviceContext.addDeviceContextClosedHandler(this);
 182
 183         final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
 184                 connectionAdapter, deviceContext);
 185         connectionAdapter.setMessageListener(messageListener);
 186
 187         final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture;
 188         if (OFConstants.OFP_VERSION_1_0 == version) {
 189             final CapabilitiesV10 capabilitiesV10 = connectionContext.getFeatures().getCapabilitiesV10();
 190
 191             DeviceStateUtil.setDeviceStateBasedOnV10Capabilities(deviceState, capabilitiesV10);
 192
 193             deviceFeaturesFuture = createDeviceFeaturesForOF10(deviceContext, deviceState);
 194             // create empty tables after device description is processed
 195             chainTableTrunkWriteOF10(deviceContext, deviceFeaturesFuture);
 196
 197             final short ofVersion = deviceContext.getDeviceState().getVersion();
 198             final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
 199             final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = deviceContext.oook().lookupTranslator(translatorKey);
 200             final BigInteger dataPathId = deviceContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
 201
 202             for (final PortGrouping port : connectionContext.getFeatures().getPhyPort()) {
 203                 final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, deviceContext, null);
 204
 205                 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), port.getPortNo(), ofVersion);
 206                 final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
 207                 ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
 208                 ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 209                 final NodeConnector connector = ncBuilder.build();
 210                 final InstanceIdentifier<NodeConnector> connectorII = deviceState.getNodeInstanceIdentifier().child(NodeConnector.class, connector.getKey());
 211                 deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
 212             }
 213         } else if (OFConstants.OFP_VERSION_1_3 == version) {
 214             final Capabilities capabilities = connectionContext.getFeatures().getCapabilities();
 215             LOG.debug("Setting capabilities for device {}", deviceContext.getDeviceState().getNodeId());
 216             DeviceStateUtil.setDeviceStateBasedOnV13Capabilities(deviceState, capabilities);
 217             deviceFeaturesFuture = createDeviceFeaturesForOF13(deviceContext, deviceState);
 218         } else {
 219             deviceFeaturesFuture = Futures.immediateFailedFuture(new ConnectionException("Unsupported version " + version));
 220         }
 221
 222         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
 223             @Override
 224             public void onSuccess(final List<RpcResult<List<MultipartReply>>> result) {
 225                 deviceContext.getDeviceState().setValid(true);
 226                 deviceInitPhaseHandler.onDeviceContextLevelUp(deviceContext);
 227                 LOG.trace("Device context level up called.");
 228             }
 229
 230             @Override
 231             public void onFailure(final Throwable t) {
 232                 // FIXME : remove session
 233                 LOG.trace("Device capabilities gathering future failed.");
 234                 LOG.trace("more info in exploration failure..", t);
 235             }
 236         });
 237     }
 238
 239     private static void chainTableTrunkWriteOF10(final DeviceContext deviceContext, final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture) {
 240         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
 241             @Override
 242             public void onSuccess(final List<RpcResult<List<MultipartReply>>> results) {
 243                 boolean allSucceeded = true;
 244                 for (final RpcResult<List<MultipartReply>> rpcResult : results) {
 245                     allSucceeded &= rpcResult.isSuccessful();
 246                 }
 247                 if (allSucceeded) {
 248                     createEmptyFlowCapableNodeInDs(deviceContext);
 249                     makeEmptyTables(deviceContext, deviceContext.getDeviceState().getNodeInstanceIdentifier(),
 250                             deviceContext.getDeviceState().getFeatures().getTables());
 251                 }
 252             }
 253
 254             @Override
 255             public void onFailure(final Throwable t) {
 256                 //NOOP
 257             }
 258         });
 259     }
 260
 261
 262     private static ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF10(final DeviceContext deviceContext,
 263                                                                                                        final DeviceState deviceState) {
 264         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
 265                 deviceContext,
 266                 deviceState.getNodeInstanceIdentifier(),
 267                 deviceState.getVersion());
 268
 269         return Futures.allAsList(Arrays.asList(replyDesc));
 270     }
 271
 272     private static ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF13(final DeviceContext deviceContext,
 273                                                                                                        final DeviceState deviceState) {
 274
 275         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
 276                 deviceContext,
 277                 deviceState.getNodeInstanceIdentifier(),
 278                 deviceState.getVersion());
 279
 280         //first process description reply, write data to DS and write consequent data if successful
 281         return Futures.transform(replyDesc, new AsyncFunction<RpcResult<List<MultipartReply>>, List<RpcResult<List<MultipartReply>>>>() {
 282             @Override
 283             public ListenableFuture<List<RpcResult<List<MultipartReply>>>> apply(final RpcResult<List<MultipartReply>> rpcResult) throws Exception {
 284
 285                 translateAndWriteReply(MultipartType.OFPMPDESC, deviceContext, deviceState.getNodeInstanceIdentifier(), rpcResult.getResult());
 286
 287                 final ListenableFuture<RpcResult<List<MultipartReply>>> replyMeterFeature = getNodeStaticInfo(MultipartType.OFPMPMETERFEATURES,
 288                         deviceContext,
 289                         deviceState.getNodeInstanceIdentifier(),
 290                         deviceState.getVersion());
 291
 292                 createSuccessProcessingCallback(MultipartType.OFPMPMETERFEATURES,
 293                         deviceContext,
 294                         deviceState.getNodeInstanceIdentifier(),
 295                         replyMeterFeature);
 296
 297                 final ListenableFuture<RpcResult<List<MultipartReply>>> replyGroupFeatures = getNodeStaticInfo(MultipartType.OFPMPGROUPFEATURES,
 298                         deviceContext,
 299                         deviceState.getNodeInstanceIdentifier(),
 300                         deviceState.getVersion());
 301                 createSuccessProcessingCallback(MultipartType.OFPMPGROUPFEATURES,
 302                         deviceContext,
 303                         deviceState.getNodeInstanceIdentifier(),
 304                         replyGroupFeatures);
 305
 306                 final ListenableFuture<RpcResult<List<MultipartReply>>> replyTableFeatures = getNodeStaticInfo(MultipartType.OFPMPTABLEFEATURES,
 307                         deviceContext,
 308                         deviceState.getNodeInstanceIdentifier(),
 309                         deviceState.getVersion());
 310                 createSuccessProcessingCallback(MultipartType.OFPMPTABLEFEATURES,
 311                         deviceContext,
 312                         deviceState.getNodeInstanceIdentifier(),
 313                         replyTableFeatures);
 314
 315                 final ListenableFuture<RpcResult<List<MultipartReply>>> replyPortDescription = getNodeStaticInfo(MultipartType.OFPMPPORTDESC,
 316                         deviceContext,
 317                         deviceState.getNodeInstanceIdentifier(),
 318                         deviceState.getVersion());
 319                 createSuccessProcessingCallback(MultipartType.OFPMPPORTDESC,
 320                         deviceContext,
 321                         deviceState.getNodeInstanceIdentifier(),
 322                         replyPortDescription);
 323
 324
 325                 return Futures.allAsList(Arrays.asList(
 326                         replyMeterFeature,
 327                         replyGroupFeatures,
 328 //                        replyTableFeatures,
 329                         replyPortDescription));
 330             }
 331         });
 332
 333     }
 334
 335     @Override
 336     public TranslatorLibrary oook() {
 337         return translatorLibrary;
 338     }
 339
 340     @Override
 341     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 342         this.translatorLibrary = translatorLibrary;
 343     }
 344
 345     private static ListenableFuture<RpcResult<List<MultipartReply>>> getNodeStaticInfo(final MultipartType type, final DeviceContext deviceContext,
 346                                                                                        final InstanceIdentifier<Node> nodeII, final short version) {
 347
 348         final OutboundQueue queue = deviceContext.getPrimaryConnectionContext().getOutboundQueueProvider();
 349
 350         final Long reserved = deviceContext.getReservedXid();
 351         final RequestContext<List<MultipartReply>> requestContext = new AbstractRequestContext<List<MultipartReply>>(reserved) {
 352             @Override
 353             public void close() {
 354                 //NOOP
 355             }
 356         };
 357
 358         final Xid xid = requestContext.getXid();
 359
 360         LOG.trace("Hooking xid {} to device context - precaution.", reserved);
 361
 362         final MultiMsgCollector multiMsgCollector = deviceContext.getMultiMsgCollector(requestContext);
 363         queue.commitEntry(xid.getValue(), MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type), new FutureCallback<OfHeader>() {
 364             @Override
 365             public void onSuccess(final OfHeader ofHeader) {
 366                 if (ofHeader instanceof MultipartReply) {
 367                     final MultipartReply multipartReply = (MultipartReply) ofHeader;
 368                     multiMsgCollector.addMultipartMsg(multipartReply);
 369                 } else if (null != ofHeader) {
 370                     LOG.info("Unexpected response type received {}.", ofHeader.getClass());
 371                 } else {
 372                     multiMsgCollector.endCollecting();
 373                     LOG.info("Response received is null.");
 374                 }
 375             }
 376
 377             @Override
 378             public void onFailure(final Throwable t) {
 379                 LOG.info("Fail response from OutboundQueue for multipart type {}.", type, t);
 380                 requestContext.close();
 381                 if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
 382                     makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
 383                 }
 384             }
 385         });
 386
 387         return requestContext.getFuture();
 388     }
 389
 390     private static void createSuccessProcessingCallback(final MultipartType type, final DeviceContext deviceContext, final InstanceIdentifier<Node> nodeII, final ListenableFuture<RpcResult<List<MultipartReply>>> requestContextFuture) {
 391         Futures.addCallback(requestContextFuture, new FutureCallback<RpcResult<List<MultipartReply>>>() {
 392             @Override
 393             public void onSuccess(final RpcResult<List<MultipartReply>> rpcResult) {
 394                 final List<MultipartReply> result = rpcResult.getResult();
 395                 if (result != null) {
 396                     LOG.info("Static node {} info: {} collected", nodeII.toString(), type);
 397                     translateAndWriteReply(type, deviceContext, nodeII, result);
 398                 } else {
 399                     final Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
 400                     while (rpcErrorIterator.hasNext()) {
 401                         final RpcError rpcError = rpcErrorIterator.next();
 402                         LOG.info("Failed to retrieve static node {} info: {}", type, rpcError.getMessage());
 403                         if (null != rpcError.getCause()) {
 404                             LOG.trace("Detailed error:", rpcError.getCause());
 405                         }
 406                     }
 407                     if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
 408                         makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
 409                     }
 410                 }
 411             }
 412
 413             @Override
 414             public void onFailure(final Throwable throwable) {
 415                 LOG.info("Request of type {} for static info of node {} failed.", type, nodeII);
 416             }
 417         });
 418     }
 419
 420     // FIXME : remove after ovs tableFeatures fix
 421     private static void makeEmptyTables(final DeviceContext dContext, final InstanceIdentifier<Node> nodeII, final Short nrOfTables) {
 422         LOG.debug("About to create {} empty tables.", nrOfTables);
 423         for (int i = 0; i < nrOfTables; i++) {
 424             final short tId = (short) i;
 425             final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class, new TableKey(tId));
 426             final TableBuilder tableBuilder = new TableBuilder().setId(tId).addAugmentation(FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
 427             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
 428         }
 429     }
 430
 431     private static void translateAndWriteReply(final MultipartType type, final DeviceContext dContext,
 432                                                final InstanceIdentifier<Node> nodeII, final Collection<MultipartReply> result) {
 433         for (final MultipartReply reply : result) {
 434             final MultipartReplyBody body = reply.getMultipartReplyBody();
 435             switch (type) {
 436                 case OFPMPDESC:
 437                     Preconditions.checkArgument(body instanceof MultipartReplyDescCase);
 438                     final MultipartReplyDesc replyDesc = ((MultipartReplyDescCase) body).getMultipartReplyDesc();
 439                     final FlowCapableNode fcNode = NodeStaticReplyTranslatorUtil.nodeDescTranslator(replyDesc);
 440                     final InstanceIdentifier<FlowCapableNode> fNodeII = nodeII.augmentation(FlowCapableNode.class);
 441                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, fcNode);
 442                     break;
 443
 444                 case OFPMPTABLEFEATURES:
 445                     Preconditions.checkArgument(body instanceof MultipartReplyTableFeaturesCase);
 446                     final MultipartReplyTableFeatures tableFeatures = ((MultipartReplyTableFeaturesCase) body).getMultipartReplyTableFeatures();
 447                     final List<TableFeatures> tables = NodeStaticReplyTranslatorUtil.nodeTableFeatureTranslator(tableFeatures);
 448                     for (final TableFeatures table : tables) {
 449                         final Short tableId = table.getTableId();
 450                         final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class, new TableKey(tableId));
 451                         final TableBuilder tableBuilder = new TableBuilder().setId(tableId).setTableFeatures(Collections.singletonList(table));
 452                         tableBuilder.addAugmentation(FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
 453                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
 454                     }
 455                     break;
 456
 457                 case OFPMPMETERFEATURES:
 458                     Preconditions.checkArgument(body instanceof MultipartReplyMeterFeaturesCase);
 459                     final MultipartReplyMeterFeatures meterFeatures = ((MultipartReplyMeterFeaturesCase) body).getMultipartReplyMeterFeatures();
 460                     final NodeMeterFeatures mFeature = NodeStaticReplyTranslatorUtil.nodeMeterFeatureTranslator(meterFeatures);
 461                     final InstanceIdentifier<NodeMeterFeatures> mFeatureII = nodeII.augmentation(NodeMeterFeatures.class);
 462                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, mFeatureII, mFeature);
 463                     if (0L < mFeature.getMeterFeatures().getMaxMeter().getValue()) {
 464                         dContext.getDeviceState().setMeterAvailable(true);
 465                     }
 466                     break;
 467
 468                 case OFPMPGROUPFEATURES:
 469                     Preconditions.checkArgument(body instanceof MultipartReplyGroupFeaturesCase);
 470                     final MultipartReplyGroupFeatures groupFeatures = ((MultipartReplyGroupFeaturesCase) body).getMultipartReplyGroupFeatures();
 471                     final NodeGroupFeatures gFeature = NodeStaticReplyTranslatorUtil.nodeGroupFeatureTranslator(groupFeatures);
 472                     final InstanceIdentifier<NodeGroupFeatures> gFeatureII = nodeII.augmentation(NodeGroupFeatures.class);
 473                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, gFeatureII, gFeature);
 474                     break;
 475
 476                 case OFPMPPORTDESC:
 477                     Preconditions.checkArgument(body instanceof MultipartReplyPortDescCase);
 478                     final MultipartReplyPortDesc portDesc = ((MultipartReplyPortDescCase) body).getMultipartReplyPortDesc();
 479                     for (final PortGrouping port : portDesc.getPorts()) {
 480                         final short ofVersion = dContext.getDeviceState().getVersion();
 481                         final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
 482                         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = dContext.oook().lookupTranslator(translatorKey);
 483                         final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, dContext, null);
 484
 485                         final BigInteger dataPathId = dContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
 486                         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), port.getPortNo(), ofVersion);
 487                         final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
 488                         ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
 489
 490                         ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 491                         final NodeConnector connector = ncBuilder.build();
 492
 493                         final InstanceIdentifier<NodeConnector> connectorII = nodeII.child(NodeConnector.class, connector.getKey());
 494                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
 495                     }
 496
 497                     break;
 498
 499                 default:
 500                     throw new IllegalArgumentException("Unnexpected MultipartType " + type);
 501             }
 502         }
 503     }
 504
 505     @Override
 506     public void setNotificationService(final NotificationService notificationServiceParam) {
 507         notificationService = notificationServiceParam;
 508     }
 509
 510     @Override
 511     public void setNotificationPublishService(final NotificationPublishService notificationService) {
 512         notificationPublishService = notificationService;
 513     }
 514
 515     @Override
 516     public void close() throws Exception {
 517         for (final DeviceContext deviceContext : deviceContexts) {
 518             deviceContext.close();
 519         }
 520     }
 521
 522     private static void createEmptyFlowCapableNodeInDs(final DeviceContext deviceContext) {
 523         final FlowCapableNodeBuilder flowCapableNodeBuilder = new FlowCapableNodeBuilder();
 524         final InstanceIdentifier<FlowCapableNode> fNodeII = deviceContext.getDeviceState().getNodeInstanceIdentifier().augmentation(FlowCapableNode.class);
 525         deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, flowCapableNodeBuilder.build());
 526     }
 527
 528     @Override
 529     public void onDeviceContextClosed(final DeviceContext deviceContext) {
 530         deviceContexts.remove(deviceContext);
 531     }
 532
 533     @Override
 534     public void initialize() {
 535         spyPool = new ScheduledThreadPoolExecutor(1);
 536         spyPool.scheduleAtFixedRate(messageIntelligenceAgency, spyRate, spyRate, TimeUnit.SECONDS);
 537     }
 538 }