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