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.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.JdkFutureAdapters;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.SettableFuture;
  16 import io.netty.util.HashedWheelTimer;
  17 import java.math.BigInteger;
  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.TimeUnit;
  24 import javax.annotation.CheckForNull;
  25 import javax.annotation.Nonnull;
  26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  27 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  29 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
  30 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  31 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  33 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  34 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  35 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  36 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  37 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  38 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  39 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  40 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  41 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  42 import org.opendaylight.openflowplugin.impl.common.MultipartRequestInputFactory;
  43 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  44 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
  45 import org.opendaylight.openflowplugin.impl.rpc.RequestContextImpl;
  46 import org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.MultipartReplyBody;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCase;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCase;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDesc;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeatures;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeatures;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.MultipartReplyPortDesc;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.multipart.reply.port.desc.Ports;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.MultipartReplyTableFeatures;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
  81 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  82 import org.opendaylight.yangtools.yang.common.RpcError;
  83 import org.opendaylight.yangtools.yang.common.RpcResult;
  84 import org.slf4j.Logger;
  85 import org.slf4j.LoggerFactory;
  86
  87 /**
  88  *
  89  */
  90 public class DeviceManagerImpl implements DeviceManager {
  91
  92     private static final Logger LOG = LoggerFactory.getLogger(DeviceManagerImpl.class);
  93
  94     private static final long TICK_DURATION = 500; // 0.5 sec.
  95
  96     private final DataBroker dataBroker;
  97     private final HashedWheelTimer hashedWheelTimer;
  98     private RequestContextStack dummyRequestContextStack;
  99     private TranslatorLibrary translatorLibrary;
 100     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
 101     private NotificationProviderService notificationService;
 102
 103
 104     public DeviceManagerImpl(@Nonnull final DataBroker dataBroker) {
 105         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 106         hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, 10);
 107         /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
 108         final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 109         tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), new NodesBuilder().build());
 110         tx.submit();
 111
 112         dummyRequestContextStack = new RequestContextStack() {
 113             @Override
 114             public <T> void forgetRequestContext(final RequestContext<T> requestContext) {
 115                 //NOOP
 116             }
 117
 118             @Override
 119             public <T> SettableFuture<RpcResult<T>> storeOrFail(final RequestContext<T> data) {
 120                 return data.getFuture();
 121             }
 122
 123             @Override
 124             public <T> RequestContext<T> createRequestContext() {
 125                 return new RequestContextImpl<>(this);
 126             }
 127         };
 128     }
 129
 130     @Override
 131     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
 132         deviceInitPhaseHandler = handler;
 133     }
 134
 135     @Override
 136     public void onDeviceContextLevelUp(final DeviceContext deviceContext) {
 137         // final phase - we have to add new Device to MD-SAL DataStore
 138         Preconditions.checkNotNull(deviceContext != null);
 139         ((DeviceContextImpl) deviceContext).submitTransaction();
 140         new BarrierTaskBuilder(deviceContext).buildAndFireBarrierTask();
 141     }
 142
 143     @Override
 144     public void deviceConnected(@CheckForNull final ConnectionContext connectionContext) {
 145         Preconditions.checkArgument(connectionContext != null);
 146
 147         final DeviceState deviceState = new DeviceStateImpl(connectionContext.getFeatures(), connectionContext.getNodeId());
 148
 149         final DeviceContextImpl deviceContext = new DeviceContextImpl(connectionContext, deviceState, dataBroker, hashedWheelTimer);
 150
 151         deviceContext.setNotificationService(notificationService);
 152         deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, deviceState.getNodeInstanceIdentifier(), new NodeBuilder().setId(deviceState.getNodeId()).build());
 153
 154         deviceContext.setTranslatorLibrary(translatorLibrary);
 155
 156         final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
 157                 connectionContext.getConnectionAdapter(), deviceContext);
 158
 159         deviceContext.attachOpenflowMessageListener(messageListener);
 160
 161         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(messageListener,
 162                 MultipartType.OFPMPDESC, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 163
 164         final ListenableFuture<RpcResult<List<MultipartReply>>> replyMeterFeature = getNodeStaticInfo(messageListener,
 165                 MultipartType.OFPMPMETERFEATURES, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 166
 167         final ListenableFuture<RpcResult<List<MultipartReply>>> replyGroupFeatures = getNodeStaticInfo(messageListener,
 168                 MultipartType.OFPMPGROUPFEATURES, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 169
 170         final ListenableFuture<RpcResult<List<MultipartReply>>> replyTableFeatures = getNodeStaticInfo(messageListener,
 171                 MultipartType.OFPMPTABLEFEATURES, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 172
 173         final ListenableFuture<RpcResult<List<MultipartReply>>> replyPortDescription = getNodeStaticInfo(messageListener,
 174                 MultipartType.OFPMPPORTDESC, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 175
 176         final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture =
 177                 Futures.allAsList(Arrays.asList(replyDesc, replyMeterFeature, replyGroupFeatures, replyTableFeatures, replyPortDescription));
 178
 179         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
 180             @Override
 181             public void onSuccess(final List<RpcResult<List<MultipartReply>>> result) {
 182                 // wake up statistics
 183                 deviceInitPhaseHandler.onDeviceContextLevelUp(deviceContext);
 184             }
 185
 186             @Override
 187             public void onFailure(final Throwable t) {
 188                 // FIXME : remove session
 189             }
 190         });
 191     }
 192
 193     @Override
 194     public TranslatorLibrary oook() {
 195         return translatorLibrary;
 196     }
 197
 198     @Override
 199     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
 200         this.translatorLibrary = translatorLibrary;
 201     }
 202
 203     private ListenableFuture<RpcResult<List<MultipartReply>>> getNodeStaticInfo(final MultiMsgCollector multiMsgCollector, final MultipartType type, final DeviceContext deviceContext,
 204                                                                                 final InstanceIdentifier<Node> nodeII, final short version) {
 205
 206         final Xid xid = deviceContext.getNextXid();
 207         final RequestContext<List<MultipartReply>> requestContext = dummyRequestContextStack.createRequestContext();
 208         requestContext.setXid(xid);
 209         multiMsgCollector.registerMultipartXid(xid.getValue());
 210         Futures.addCallback(requestContext.getFuture(), new FutureCallback<RpcResult<List<MultipartReply>>>() {
 211             @Override
 212             public void onSuccess(final RpcResult<List<MultipartReply>> rpcResult) {
 213                 final List<MultipartReply> result = rpcResult.getResult();
 214                 if (result != null) {
 215                     translateAndWriteReply(type, deviceContext, nodeII, result);
 216                 } else {
 217                     final Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
 218                     while (rpcErrorIterator.hasNext()) {
 219                         final RpcError rpcError = rpcErrorIterator.next();
 220                         LOG.info("Failed to retrieve static node {} info: {}", type, rpcError.getMessage());
 221                         if (null != rpcError.getCause()) {
 222                             LOG.trace("Detailed error:", rpcError.getCause());
 223                         }
 224                     }
 225                     if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
 226                         makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
 227                     }
 228                 }
 229             }
 230
 231             @Override
 232             public void onFailure(final Throwable t) {
 233                 LOG.info("Failed to retrieve static node {} info: {}", type, t.getMessage());
 234             }
 235         });
 236
 237         final ListenableFuture<RpcResult<Void>> rpcFuture = JdkFutureAdapters.listenInPoolThread(deviceContext.getPrimaryConnectionContext().getConnectionAdapter()
 238                 .multipartRequest(MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type)));
 239         final OFJResult2RequestCtxFuture OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture(requestContext, deviceContext);
 240         OFJResult2RequestCtxFuture.processResultFromOfJava(rpcFuture);
 241
 242         return requestContext.getFuture();
 243     }
 244
 245     // FIXME : remove after ovs tableFeatures fix
 246     private static void makeEmptyTables(final DeviceContext dContext, final InstanceIdentifier<Node> nodeII, final Short nrOfTables) {
 247         for (int i = 0; i < nrOfTables; i++) {
 248             final short tId = (short) i;
 249             final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class, new TableKey(tId));
 250             final TableBuilder tableBuilder = new TableBuilder().setId(tId).addAugmentation(FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
 251             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
 252         }
 253     }
 254
 255     private static void translateAndWriteReply(final MultipartType type, final DeviceContext dContext,
 256                                                final InstanceIdentifier<Node> nodeII, final Collection<MultipartReply> result) {
 257         for (final MultipartReply reply : result) {
 258             final MultipartReplyBody body = reply.getMultipartReplyBody();
 259             switch (type) {
 260                 case OFPMPDESC:
 261                     Preconditions.checkArgument(body instanceof MultipartReplyDescCase);
 262                     final MultipartReplyDesc replyDesc = ((MultipartReplyDescCase) body).getMultipartReplyDesc();
 263                     final FlowCapableNode fcNode = NodeStaticReplyTranslatorUtil.nodeDescTranslator(replyDesc);
 264                     final InstanceIdentifier<FlowCapableNode> fNodeII = nodeII.augmentation(FlowCapableNode.class);
 265                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, fcNode);
 266                     break;
 267
 268                 case OFPMPTABLEFEATURES:
 269                     Preconditions.checkArgument(body instanceof MultipartReplyTableFeaturesCase);
 270                     final MultipartReplyTableFeatures tableFeatures = ((MultipartReplyTableFeaturesCase) body).getMultipartReplyTableFeatures();
 271                     final List<TableFeatures> tables = NodeStaticReplyTranslatorUtil.nodeTableFeatureTranslator(tableFeatures);
 272                     for (final TableFeatures table : tables) {
 273                         final Short tableId = table.getTableId();
 274                         final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class, new TableKey(tableId));
 275                         final TableBuilder tableBuilder = new TableBuilder().setId(tableId).setTableFeatures(Collections.singletonList(table));
 276                         tableBuilder.addAugmentation(FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
 277                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
 278                     }
 279                     break;
 280
 281                 case OFPMPMETERFEATURES:
 282                     Preconditions.checkArgument(body instanceof MultipartReplyMeterFeaturesCase);
 283                     final MultipartReplyMeterFeatures meterFeatures = ((MultipartReplyMeterFeaturesCase) body).getMultipartReplyMeterFeatures();
 284                     final NodeMeterFeatures mFeature = NodeStaticReplyTranslatorUtil.nodeMeterFeatureTranslator(meterFeatures);
 285                     final InstanceIdentifier<NodeMeterFeatures> mFeatureII = nodeII.augmentation(NodeMeterFeatures.class);
 286                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, mFeatureII, mFeature);
 287                     if (0L < mFeature.getMeterFeatures().getMaxMeter().getValue()) {
 288                         dContext.getDeviceState().isMetersAvailable();
 289                     }
 290                     break;
 291
 292                 case OFPMPGROUPFEATURES:
 293                     Preconditions.checkArgument(body instanceof MultipartReplyGroupFeaturesCase);
 294                     final MultipartReplyGroupFeatures groupFeatures = ((MultipartReplyGroupFeaturesCase) body).getMultipartReplyGroupFeatures();
 295                     final NodeGroupFeatures gFeature = NodeStaticReplyTranslatorUtil.nodeGroupFeatureTranslator(groupFeatures);
 296                     final InstanceIdentifier<NodeGroupFeatures> gFeatureII = nodeII.augmentation(NodeGroupFeatures.class);
 297                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, gFeatureII, gFeature);
 298                     dContext.getDeviceState().groupIsAvailable();
 299                     break;
 300
 301                 case OFPMPPORTDESC:
 302                     Preconditions.checkArgument(body instanceof MultipartReplyPortDescCase);
 303                     final MultipartReplyPortDesc portDesc = ((MultipartReplyPortDescCase) body).getMultipartReplyPortDesc();
 304                     for (final Ports port : portDesc.getPorts()) {
 305                         final short ofVersion = dContext.getDeviceState().getVersion();
 306                         final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
 307                         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = dContext.oook().lookupTranslator(translatorKey);
 308                         final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, dContext, null);
 309
 310                         final BigInteger dataPathId = dContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
 311                         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), port.getPortNo(), ofVersion);
 312                         final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
 313                         ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
 314                         ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 315                         final NodeConnector connector = ncBuilder.build();
 316
 317                         final InstanceIdentifier<NodeConnector> connectorII = nodeII.child(NodeConnector.class, connector.getKey());
 318                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
 319                         //FlowCapableNodeConnectorBuilder
 320                     }
 321
 322                 default:
 323                     throw new IllegalArgumentException("Unnexpected MultipartType " + type);
 324             }
 325         }
 326     }
 327
 328     @Override
 329     public void setNotificationService(final NotificationProviderService notificationServiceParam) {
 330         notificationService = notificationServiceParam;
 331     }
 332 }