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