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