openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/connection/ConnectionAdapterImpl.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. 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
   9
  10 package org.opendaylight.openflowjava.protocol.impl.connection;
  11
  12 import io.netty.channel.Channel;
  13 import io.netty.channel.ChannelFuture;
  14 import io.netty.util.concurrent.GenericFutureListener;
  15
  16 import java.net.InetSocketAddress;
  17 import java.util.concurrent.Future;
  18 import java.util.concurrent.RejectedExecutionException;
  19 import java.util.concurrent.TimeUnit;
  20
  21 import org.opendaylight.controller.sal.common.util.RpcErrors;
  22 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionReadyListener;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInput;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoInput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterInput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncInput;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncOutput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigInput;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigOutput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesInput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigInput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigOutput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInput;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloInput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketOutInput;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInput;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestInput;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestOutput;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetAsyncInput;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInput;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.TableModInput;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
  62 import org.opendaylight.yangtools.yang.binding.DataObject;
  63 import org.opendaylight.yangtools.yang.binding.Notification;
  64 import org.opendaylight.yangtools.yang.common.RpcError;
  65 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  66 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  67 import org.opendaylight.yangtools.yang.common.RpcResult;
  68 import org.slf4j.Logger;
  69 import org.slf4j.LoggerFactory;
  70
  71 import com.google.common.base.Preconditions;
  72 import com.google.common.cache.Cache;
  73 import com.google.common.cache.CacheBuilder;
  74 import com.google.common.cache.RemovalListener;
  75 import com.google.common.cache.RemovalNotification;
  76 import com.google.common.util.concurrent.ListenableFuture;
  77 import com.google.common.util.concurrent.SettableFuture;
  78
  79 /**
  80  * Handles messages (notifications + rpcs) and connections
  81  * @author mirehak
  82  * @author michal.polkorab
  83  */
  84 public class ConnectionAdapterImpl implements ConnectionFacade {
  85     /** after this time, RPC future response objects will be thrown away (in minutes) */
  86     public static final int RPC_RESPONSE_EXPIRATION = 1;
  87
  88     /**
  89      * Default depth of write queue, e.g. we allow these many messages
  90      * to be queued up before blocking producers.
  91      */
  92     public static final int DEFAULT_QUEUE_DEPTH = 1024;
  93
  94     private static final Logger LOG = LoggerFactory
  95             .getLogger(ConnectionAdapterImpl.class);
  96     private static final Exception QUEUE_FULL_EXCEPTION =
  97             new RejectedExecutionException("Output queue is full");
  98
  99     private static final String APPLICATION_TAG = "OPENFLOW_LIBRARY";
 100     private static final String TAG = "OPENFLOW";
 101     private static final RemovalListener<RpcResponseKey, ResponseExpectedRpcListener<?>> REMOVAL_LISTENER =
 102             new RemovalListener<RpcResponseKey, ResponseExpectedRpcListener<?>>() {
 103         @Override
 104         public void onRemoval(
 105                 final RemovalNotification<RpcResponseKey, ResponseExpectedRpcListener<?>> notification) {
 106             notification.getValue().discard();
 107         }
 108     };
 109
 110     /** expiring cache for future rpcResponses */
 111     private Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> responseCache;
 112
 113     private final ChannelOutboundQueue output;
 114     private final Channel channel;
 115
 116     private ConnectionReadyListener connectionReadyListener;
 117     private OpenflowProtocolListener messageListener;
 118     private SystemNotificationsListener systemListener;
 119     private boolean disconnectOccured = false;
 120
 121     /**
 122      * default ctor
 123      * @param channel the channel to be set - used for communication
 124      * @param address client address (used only in case of UDP communication,
 125      *  as there is no need to store address over tcp (stable channel))
 126      */
 127     public ConnectionAdapterImpl(final Channel channel, final InetSocketAddress address) {
 128         responseCache = CacheBuilder.newBuilder()
 129                 .concurrencyLevel(1)
 130                 .expireAfterWrite(RPC_RESPONSE_EXPIRATION, TimeUnit.MINUTES)
 131                 .removalListener(REMOVAL_LISTENER).build();
 132         this.channel = Preconditions.checkNotNull(channel);
 133         this.output = new ChannelOutboundQueue(channel, DEFAULT_QUEUE_DEPTH, address);
 134         channel.pipeline().addLast(output);
 135         LOG.debug("ConnectionAdapter created");
 136     }
 137
 138     @Override
 139     public Future<RpcResult<BarrierOutput>> barrier(final BarrierInput input) {
 140         return sendToSwitchExpectRpcResultFuture(
 141                 input, BarrierOutput.class, "barrier-input sending failed");
 142     }
 143
 144     @Override
 145     public Future<RpcResult<EchoOutput>> echo(final EchoInput input) {
 146         return sendToSwitchExpectRpcResultFuture(
 147                 input, EchoOutput.class, "echo-input sending failed");
 148     }
 149
 150     @Override
 151     public Future<RpcResult<Void>> echoReply(final EchoReplyInput input) {
 152         return sendToSwitchFuture(input, "echo-reply sending failed");
 153     }
 154
 155     @Override
 156     public Future<RpcResult<Void>> experimenter(final ExperimenterInput input) {
 157         return sendToSwitchFuture(input, "experimenter sending failed");
 158     }
 159
 160     @Override
 161     public Future<RpcResult<Void>> flowMod(final FlowModInput input) {
 162         return sendToSwitchFuture(input, "flow-mod sending failed");
 163     }
 164
 165     @Override
 166     public Future<RpcResult<GetConfigOutput>> getConfig(final GetConfigInput input) {
 167         return sendToSwitchExpectRpcResultFuture(
 168                 input, GetConfigOutput.class, "get-config-input sending failed");
 169     }
 170
 171     @Override
 172     public Future<RpcResult<GetFeaturesOutput>> getFeatures(
 173             final GetFeaturesInput input) {
 174         return sendToSwitchExpectRpcResultFuture(
 175                 input, GetFeaturesOutput.class, "get-features-input sending failed");
 176     }
 177
 178     @Override
 179     public Future<RpcResult<GetQueueConfigOutput>> getQueueConfig(
 180             final GetQueueConfigInput input) {
 181         return sendToSwitchExpectRpcResultFuture(
 182                 input, GetQueueConfigOutput.class, "get-queue-config-input sending failed");
 183     }
 184
 185     @Override
 186     public Future<RpcResult<Void>> groupMod(final GroupModInput input) {
 187         return sendToSwitchFuture(input, "group-mod-input sending failed");
 188     }
 189
 190     @Override
 191     public Future<RpcResult<Void>> hello(final HelloInput input) {
 192         return sendToSwitchFuture(input, "hello-input sending failed");
 193     }
 194
 195     @Override
 196     public Future<RpcResult<Void>> meterMod(final MeterModInput input) {
 197         return sendToSwitchFuture(input, "meter-mod-input sending failed");
 198     }
 199
 200     @Override
 201     public Future<RpcResult<Void>> packetOut(final PacketOutInput input) {
 202         return sendToSwitchFuture(input, "packet-out-input sending failed");
 203     }
 204
 205     @Override
 206     public Future<RpcResult<Void>> multipartRequest(final MultipartRequestInput input) {
 207         return sendToSwitchFuture(input, "multi-part-request sending failed");
 208     }
 209
 210     @Override
 211     public Future<RpcResult<Void>> portMod(final PortModInput input) {
 212         return sendToSwitchFuture(input, "port-mod-input sending failed");
 213     }
 214
 215     @Override
 216     public Future<RpcResult<RoleRequestOutput>> roleRequest(
 217             final RoleRequestInput input) {
 218         return sendToSwitchExpectRpcResultFuture(
 219                 input, RoleRequestOutput.class, "role-request-config-input sending failed");
 220     }
 221
 222     @Override
 223     public Future<RpcResult<Void>> setConfig(final SetConfigInput input) {
 224         return sendToSwitchFuture(input, "set-config-input sending failed");
 225     }
 226
 227     @Override
 228     public Future<RpcResult<Void>> tableMod(final TableModInput input) {
 229         return sendToSwitchFuture(input, "table-mod-input sending failed");
 230     }
 231
 232     @Override
 233     public Future<RpcResult<GetAsyncOutput>> getAsync(final GetAsyncInput input) {
 234         return sendToSwitchExpectRpcResultFuture(
 235                 input, GetAsyncOutput.class, "get-async-input sending failed");
 236     }
 237
 238     @Override
 239     public Future<RpcResult<Void>> setAsync(final SetAsyncInput input) {
 240         return sendToSwitchFuture(input, "set-async-input sending failed");
 241     }
 242
 243     @Override
 244     public Future<Boolean> disconnect() {
 245         ChannelFuture disconnectResult = channel.disconnect();
 246         responseCache.invalidateAll();
 247         disconnectOccured = true;
 248
 249         String failureInfo = "switch disconnecting failed";
 250         ErrorSeverity errorSeverity = ErrorSeverity.ERROR;
 251         String message = "Check the switch connection";
 252         return handleTransportChannelFuture(disconnectResult, failureInfo, errorSeverity, message);
 253     }
 254
 255     @Override
 256     public boolean isAlive() {
 257         return channel.isOpen();
 258     }
 259
 260     @Override
 261     public void setMessageListener(final OpenflowProtocolListener messageListener) {
 262         this.messageListener = messageListener;
 263     }
 264
 265     @Override
 266     public void consume(final DataObject message) {
 267         LOG.debug("ConsumeIntern msg");
 268         if (disconnectOccured ) {
 269             return;
 270         }
 271         if (message instanceof Notification) {
 272             // System events
 273             if (message instanceof DisconnectEvent) {
 274                 systemListener.onDisconnectEvent((DisconnectEvent) message);
 275                 responseCache.invalidateAll();
 276                 disconnectOccured = true;
 277             } else if (message instanceof SwitchIdleEvent) {
 278                 systemListener.onSwitchIdleEvent((SwitchIdleEvent) message);
 279             }
 280             // OpenFlow messages
 281               else if (message instanceof EchoRequestMessage) {
 282                 messageListener.onEchoRequestMessage((EchoRequestMessage) message);
 283             } else if (message instanceof ErrorMessage) {
 284                 messageListener.onErrorMessage((ErrorMessage) message);
 285             } else if (message instanceof ExperimenterMessage) {
 286                 messageListener.onExperimenterMessage((ExperimenterMessage) message);
 287             } else if (message instanceof FlowRemovedMessage) {
 288                 messageListener.onFlowRemovedMessage((FlowRemovedMessage) message);
 289             } else if (message instanceof HelloMessage) {
 290                 LOG.info("Hello received / branch");
 291                 messageListener.onHelloMessage((HelloMessage) message);
 292             } else if (message instanceof MultipartReplyMessage) {
 293                 messageListener.onMultipartReplyMessage((MultipartReplyMessage) message);
 294             } else if (message instanceof PacketInMessage) {
 295                 messageListener.onPacketInMessage((PacketInMessage) message);
 296             } else if (message instanceof PortStatusMessage) {
 297                 messageListener.onPortStatusMessage((PortStatusMessage) message);
 298             } else {
 299                 LOG.warn("message listening not supported for type: {}", message.getClass());
 300             }
 301         } else {
 302             if (message instanceof OfHeader) {
 303                 LOG.debug("OFheader msg received");
 304                 RpcResponseKey key = createRpcResponseKey((OfHeader) message);
 305                 final ResponseExpectedRpcListener<?> listener = findRpcResponse(key);
 306                 if (listener != null) {
 307                     LOG.debug("corresponding rpcFuture found");
 308                     listener.completed((OfHeader)message);
 309                     LOG.debug("after setting rpcFuture");
 310                     responseCache.invalidate(key);
 311                 } else {
 312                     LOG.warn("received unexpected rpc response: {}", key);
 313                 }
 314             } else {
 315                 LOG.warn("message listening not supported for type: {}", message.getClass());
 316             }
 317         }
 318     }
 319
 320     private <T> ListenableFuture<RpcResult<T>> enqueueMessage(final AbstractRpcListener<T> promise) {
 321         LOG.debug("Submitting promise {}", promise);
 322
 323         if (!output.enqueue(promise)) {
 324             LOG.debug("Message queue is full, rejecting execution");
 325             promise.failedRpc(QUEUE_FULL_EXCEPTION);
 326         } else {
 327             LOG.debug("Promise enqueued successfully");
 328         }
 329
 330         return promise.getResult();
 331     }
 332
 333     /**
 334      * sends given message to switch, sending result will be reported via return value
 335      * @param input message to send
 336      * @param failureInfo describes, what type of message caused failure by sending
 337      * @return future object, <ul>
 338      *  <li>if send successful, {@link RpcResult} without errors and successful
 339      *  status will be returned, </li>
 340      *  <li>else {@link RpcResult} will contain errors and failed status</li>
 341      *  </ul>
 342      */
 343     private ListenableFuture<RpcResult<Void>> sendToSwitchFuture(
 344             final DataObject input, final String failureInfo) {
 345         return enqueueMessage(new SimpleRpcListener(input, failureInfo));
 346     }
 347
 348     /**
 349      * sends given message to switch, sending result or switch response will be reported via return value
 350      * @param input message to send
 351      * @param responseClazz type of response
 352      * @param failureInfo describes, what type of message caused failure by sending
 353      * @return future object, <ul>
 354      *  <li>if send fails, {@link RpcResult} will contain errors and failed status </li>
 355      *  <li>else {@link RpcResult} will be stored in responseCache and wait for particular timeout
 356      *  ({@link ConnectionAdapterImpl#RPC_RESPONSE_EXPIRATION}),
 357      *  <ul><li>either switch will manage to answer
 358      *  and then corresponding response message will be set into returned future</li>
 359      *  <li>or response in cache will expire and returned future will be cancelled</li></ul>
 360      *  </li>
 361      *  </ul>
 362      */
 363     private <IN extends OfHeader, OUT extends OfHeader> ListenableFuture<RpcResult<OUT>> sendToSwitchExpectRpcResultFuture(
 364             final IN input, final Class<OUT> responseClazz, final String failureInfo) {
 365         final RpcResponseKey key = new RpcResponseKey(input.getXid(), responseClazz.getName());
 366         final ResponseExpectedRpcListener<OUT> listener =
 367                 new ResponseExpectedRpcListener<>(input, failureInfo, responseCache, key);
 368         return enqueueMessage(listener);
 369     }
 370
 371     /**
 372      * @param resultFuture
 373      * @param failureInfo
 374      * @param errorSeverity
 375      * @param message
 376      * @return
 377      */
 378     private static SettableFuture<Boolean> handleTransportChannelFuture(
 379             final ChannelFuture resultFuture, final String failureInfo,
 380             final ErrorSeverity errorSeverity, final String message) {
 381
 382         final SettableFuture<Boolean> transportResult = SettableFuture.create();
 383
 384         resultFuture.addListener(new GenericFutureListener<io.netty.util.concurrent.Future<? super Void>>() {
 385
 386             @Override
 387             public void operationComplete(
 388                     final io.netty.util.concurrent.Future<? super Void> future)
 389                     throws Exception {
 390                 transportResult.set(future.isSuccess());
 391                 if (!future.isSuccess()) {
 392                     transportResult.setException(future.cause());
 393                 }
 394             }
 395         });
 396         return transportResult;
 397     }
 398
 399     /**
 400      * @param cause
 401      * @return
 402      */
 403     static RpcError buildRpcError(final String info, final ErrorSeverity severity, final String message,
 404             final Throwable cause) {
 405         RpcError error = RpcErrors.getRpcError(APPLICATION_TAG, TAG, info, severity, message,
 406                 ErrorType.RPC, cause);
 407         return error;
 408     }
 409
 410     /**
 411      * @param cause
 412      * @return
 413      */
 414     protected static RpcError buildTransportError(final String info, final ErrorSeverity severity, final String message,
 415             final Throwable cause) {
 416         RpcError error = RpcErrors.getRpcError(APPLICATION_TAG, TAG, info, severity, message,
 417                 ErrorType.TRANSPORT, cause);
 418         return error;
 419     }
 420
 421     /**
 422      * @param message
 423      * @return
 424      */
 425     private static RpcResponseKey createRpcResponseKey(final OfHeader message) {
 426         return new RpcResponseKey(message.getXid(), message.getImplementedInterface().getName());
 427     }
 428
 429     /**
 430      * @return
 431      */
 432     private ResponseExpectedRpcListener<?> findRpcResponse(final RpcResponseKey key) {
 433         return responseCache.getIfPresent(key);
 434     }
 435
 436     @Override
 437     public void setSystemListener(final SystemNotificationsListener systemListener) {
 438         this.systemListener = systemListener;
 439     }
 440
 441     @Override
 442     public void checkListeners() {
 443         final StringBuilder buffer =  new StringBuilder();
 444         if (systemListener == null) {
 445             buffer.append("SystemListener ");
 446         }
 447         if (messageListener == null) {
 448             buffer.append("MessageListener ");
 449         }
 450         if (connectionReadyListener == null) {
 451             buffer.append("ConnectionReadyListener ");
 452         }
 453
 454         Preconditions.checkState(buffer.length() == 0, "Missing listeners: %s", buffer.toString());
 455     }
 456
 457     @Override
 458     public void fireConnectionReadyNotification() {
 459         new Thread(new Runnable() {
 460             @Override
 461             public void run() {
 462                 connectionReadyListener.onConnectionReady();
 463             }
 464         }).start();
 465     }
 466
 467     @Override
 468     public void setConnectionReadyListener(
 469             final ConnectionReadyListener connectionReadyListener) {
 470         this.connectionReadyListener = connectionReadyListener;
 471     }
 472
 473     @Override
 474     public InetSocketAddress getRemoteAddress() {
 475         return (InetSocketAddress) channel.remoteAddress();
 476     }
 477
 478     /**
 479      * Used only for testing purposes
 480      * @param cache
 481      */
 482     public void setResponseCache(Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> cache) {
 483         this.responseCache = cache;
 484     }
 485 }