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.ChannelFuture;
  13 import io.netty.channel.socket.SocketChannel;
  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 final Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> responseCache;
 112
 113     private final ChannelOutboundQueue output;
 114     private final SocketChannel 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      */
 125     public ConnectionAdapterImpl(final SocketChannel channel) {
 126         responseCache = CacheBuilder.newBuilder()
 127                 .concurrencyLevel(1)
 128                 .expireAfterWrite(RPC_RESPONSE_EXPIRATION, TimeUnit.MINUTES)
 129                 .removalListener(REMOVAL_LISTENER).build();
 130         this.channel = Preconditions.checkNotNull(channel);
 131         this.output = new ChannelOutboundQueue(channel, DEFAULT_QUEUE_DEPTH);
 132         channel.pipeline().addLast(output);
 133         LOG.debug("ConnectionAdapter created");
 134     }
 135
 136     @Override
 137     public Future<RpcResult<BarrierOutput>> barrier(final BarrierInput input) {
 138         return sendToSwitchExpectRpcResultFuture(
 139                 input, BarrierOutput.class, "barrier-input sending failed");
 140     }
 141
 142     @Override
 143     public Future<RpcResult<EchoOutput>> echo(final EchoInput input) {
 144         return sendToSwitchExpectRpcResultFuture(
 145                 input, EchoOutput.class, "echo-input sending failed");
 146     }
 147
 148     @Override
 149     public Future<RpcResult<Void>> echoReply(final EchoReplyInput input) {
 150         return sendToSwitchFuture(input, "echo-reply sending failed");
 151     }
 152
 153     @Override
 154     public Future<RpcResult<Void>> experimenter(final ExperimenterInput input) {
 155         return sendToSwitchFuture(input, "experimenter sending failed");
 156     }
 157
 158     @Override
 159     public Future<RpcResult<Void>> flowMod(final FlowModInput input) {
 160         return sendToSwitchFuture(input, "flow-mod sending failed");
 161     }
 162
 163     @Override
 164     public Future<RpcResult<GetConfigOutput>> getConfig(final GetConfigInput input) {
 165         return sendToSwitchExpectRpcResultFuture(
 166                 input, GetConfigOutput.class, "get-config-input sending failed");
 167     }
 168
 169     @Override
 170     public Future<RpcResult<GetFeaturesOutput>> getFeatures(
 171             final GetFeaturesInput input) {
 172         return sendToSwitchExpectRpcResultFuture(
 173                 input, GetFeaturesOutput.class, "get-features-input sending failed");
 174     }
 175
 176     @Override
 177     public Future<RpcResult<GetQueueConfigOutput>> getQueueConfig(
 178             final GetQueueConfigInput input) {
 179         return sendToSwitchExpectRpcResultFuture(
 180                 input, GetQueueConfigOutput.class, "get-queue-config-input sending failed");
 181     }
 182
 183     @Override
 184     public Future<RpcResult<Void>> groupMod(final GroupModInput input) {
 185         return sendToSwitchFuture(input, "group-mod-input sending failed");
 186     }
 187
 188     @Override
 189     public Future<RpcResult<Void>> hello(final HelloInput input) {
 190         return sendToSwitchFuture(input, "hello-input sending failed");
 191     }
 192
 193     @Override
 194     public Future<RpcResult<Void>> meterMod(final MeterModInput input) {
 195         return sendToSwitchFuture(input, "meter-mod-input sending failed");
 196     }
 197
 198     @Override
 199     public Future<RpcResult<Void>> packetOut(final PacketOutInput input) {
 200         return sendToSwitchFuture(input, "packet-out-input sending failed");
 201     }
 202
 203     @Override
 204     public Future<RpcResult<Void>> multipartRequest(final MultipartRequestInput input) {
 205         return sendToSwitchFuture(input, "multi-part-request sending failed");
 206     }
 207
 208     @Override
 209     public Future<RpcResult<Void>> portMod(final PortModInput input) {
 210         return sendToSwitchFuture(input, "port-mod-input sending failed");
 211     }
 212
 213     @Override
 214     public Future<RpcResult<RoleRequestOutput>> roleRequest(
 215             final RoleRequestInput input) {
 216         return sendToSwitchExpectRpcResultFuture(
 217                 input, RoleRequestOutput.class, "role-request-config-input sending failed");
 218     }
 219
 220     @Override
 221     public Future<RpcResult<Void>> setConfig(final SetConfigInput input) {
 222         return sendToSwitchFuture(input, "set-config-input sending failed");
 223     }
 224
 225     @Override
 226     public Future<RpcResult<Void>> tableMod(final TableModInput input) {
 227         return sendToSwitchFuture(input, "table-mod-input sending failed");
 228     }
 229
 230     @Override
 231     public Future<RpcResult<GetAsyncOutput>> getAsync(final GetAsyncInput input) {
 232         return sendToSwitchExpectRpcResultFuture(
 233                 input, GetAsyncOutput.class, "get-async-input sending failed");
 234     }
 235
 236     @Override
 237     public Future<RpcResult<Void>> setAsync(final SetAsyncInput input) {
 238         return sendToSwitchFuture(input, "set-async-input sending failed");
 239     }
 240
 241     @Override
 242     public Future<Boolean> disconnect() {
 243         ChannelFuture disconnectResult = channel.disconnect();
 244         responseCache.invalidateAll();
 245         disconnectOccured = true;
 246
 247         String failureInfo = "switch disconnecting failed";
 248         ErrorSeverity errorSeverity = ErrorSeverity.ERROR;
 249         String message = "Check the switch connection";
 250         return handleTransportChannelFuture(disconnectResult, failureInfo, errorSeverity, message);
 251     }
 252
 253     @Override
 254     public boolean isAlive() {
 255         return channel.isOpen();
 256     }
 257
 258     @Override
 259     public void setMessageListener(final OpenflowProtocolListener messageListener) {
 260         this.messageListener = messageListener;
 261     }
 262
 263     @Override
 264     public void consume(final DataObject message) {
 265         LOG.debug("ConsumeIntern msg");
 266         if (disconnectOccured ) {
 267             return;
 268         }
 269         if (message instanceof Notification) {
 270             // System events
 271             if (message instanceof DisconnectEvent) {
 272                 systemListener.onDisconnectEvent((DisconnectEvent) message);
 273                 responseCache.invalidateAll();
 274                 disconnectOccured = true;
 275             } else if (message instanceof SwitchIdleEvent) {
 276                 systemListener.onSwitchIdleEvent((SwitchIdleEvent) message);
 277             }
 278             // OpenFlow messages
 279               else if (message instanceof EchoRequestMessage) {
 280                 messageListener.onEchoRequestMessage((EchoRequestMessage) message);
 281             } else if (message instanceof ErrorMessage) {
 282                 messageListener.onErrorMessage((ErrorMessage) message);
 283             } else if (message instanceof ExperimenterMessage) {
 284                 messageListener.onExperimenterMessage((ExperimenterMessage) message);
 285             } else if (message instanceof FlowRemovedMessage) {
 286                 messageListener.onFlowRemovedMessage((FlowRemovedMessage) message);
 287             } else if (message instanceof HelloMessage) {
 288                 LOG.info("Hello received / branch");
 289                 messageListener.onHelloMessage((HelloMessage) message);
 290             } else if (message instanceof MultipartReplyMessage) {
 291                 messageListener.onMultipartReplyMessage((MultipartReplyMessage) message);
 292             } else if (message instanceof PacketInMessage) {
 293                 messageListener.onPacketInMessage((PacketInMessage) message);
 294             } else if (message instanceof PortStatusMessage) {
 295                 messageListener.onPortStatusMessage((PortStatusMessage) message);
 296             } else {
 297                 LOG.warn("message listening not supported for type: {}", message.getClass());
 298             }
 299         } else {
 300             if (message instanceof OfHeader) {
 301                 LOG.debug("OFheader msg received");
 302                 RpcResponseKey key = createRpcResponseKey((OfHeader) message);
 303                 final ResponseExpectedRpcListener<?> listener = findRpcResponse(key);
 304                 if (listener != null) {
 305                     LOG.debug("corresponding rpcFuture found");
 306                     listener.completed((OfHeader)message);
 307                     LOG.debug("after setting rpcFuture");
 308                     responseCache.invalidate(key);
 309                 } else {
 310                     LOG.warn("received unexpected rpc response: {}", key);
 311                 }
 312             } else {
 313                 LOG.warn("message listening not supported for type: {}", message.getClass());
 314             }
 315         }
 316     }
 317
 318     private <T> ListenableFuture<RpcResult<T>> enqueueMessage(final AbstractRpcListener<T> promise) {
 319         LOG.debug("Submitting promise {}", promise);
 320
 321         if (!output.enqueue(promise)) {
 322             LOG.debug("Message queue is full, rejecting execution");
 323             promise.failedRpc(QUEUE_FULL_EXCEPTION);
 324         } else {
 325             LOG.debug("Promise enqueued successfully");
 326         }
 327
 328         return promise.getResult();
 329     }
 330
 331     /**
 332      * sends given message to switch, sending result will be reported via return value
 333      * @param input message to send
 334      * @param failureInfo describes, what type of message caused failure by sending
 335      * @return future object, <ul>
 336      *  <li>if send successful, {@link RpcResult} without errors and successful
 337      *  status will be returned, </li>
 338      *  <li>else {@link RpcResult} will contain errors and failed status</li>
 339      *  </ul>
 340      */
 341     private ListenableFuture<RpcResult<Void>> sendToSwitchFuture(
 342             final DataObject input, final String failureInfo) {
 343         return enqueueMessage(new SimpleRpcListener(input, failureInfo));
 344     }
 345
 346     /**
 347      * sends given message to switch, sending result or switch response will be reported via return value
 348      * @param input message to send
 349      * @param responseClazz type of response
 350      * @param failureInfo describes, what type of message caused failure by sending
 351      * @return future object, <ul>
 352      *  <li>if send fails, {@link RpcResult} will contain errors and failed status </li>
 353      *  <li>else {@link RpcResult} will be stored in responseCache and wait for particular timeout
 354      *  ({@link ConnectionAdapterImpl#RPC_RESPONSE_EXPIRATION}),
 355      *  <ul><li>either switch will manage to answer
 356      *  and then corresponding response message will be set into returned future</li>
 357      *  <li>or response in cache will expire and returned future will be cancelled</li></ul>
 358      *  </li>
 359      *  </ul>
 360      */
 361     private <IN extends OfHeader, OUT extends OfHeader> ListenableFuture<RpcResult<OUT>> sendToSwitchExpectRpcResultFuture(
 362             final IN input, final Class<OUT> responseClazz, final String failureInfo) {
 363         final RpcResponseKey key = new RpcResponseKey(input.getXid(), responseClazz.getName());
 364         final ResponseExpectedRpcListener<OUT> listener =
 365                 new ResponseExpectedRpcListener<>(input, failureInfo, responseCache, key);
 366         return enqueueMessage(listener);
 367     }
 368
 369     /**
 370      * @param resultFuture
 371      * @param failureInfo
 372      * @param errorSeverity
 373      * @param message
 374      * @return
 375      */
 376     private static SettableFuture<Boolean> handleTransportChannelFuture(
 377             final ChannelFuture resultFuture, final String failureInfo,
 378             final ErrorSeverity errorSeverity, final String message) {
 379
 380         final SettableFuture<Boolean> transportResult = SettableFuture.create();
 381
 382         resultFuture.addListener(new GenericFutureListener<io.netty.util.concurrent.Future<? super Void>>() {
 383
 384             @Override
 385             public void operationComplete(
 386                     final io.netty.util.concurrent.Future<? super Void> future)
 387                     throws Exception {
 388                 transportResult.set(future.isSuccess());
 389                 if (!future.isSuccess()) {
 390                     transportResult.setException(future.cause());
 391                 }
 392             }
 393         });
 394         return transportResult;
 395     }
 396
 397     /**
 398      * @param cause
 399      * @return
 400      */
 401     static RpcError buildRpcError(final String info, final ErrorSeverity severity, final String message,
 402             final Throwable cause) {
 403         RpcError error = RpcErrors.getRpcError(APPLICATION_TAG, TAG, info, severity, message,
 404                 ErrorType.RPC, cause);
 405         return error;
 406     }
 407
 408     /**
 409      * @param cause
 410      * @return
 411      */
 412     protected static RpcError buildTransportError(final String info, final ErrorSeverity severity, final String message,
 413             final Throwable cause) {
 414         RpcError error = RpcErrors.getRpcError(APPLICATION_TAG, TAG, info, severity, message,
 415                 ErrorType.TRANSPORT, cause);
 416         return error;
 417     }
 418
 419     /**
 420      * @param message
 421      * @return
 422      */
 423     private static RpcResponseKey createRpcResponseKey(final OfHeader message) {
 424         return new RpcResponseKey(message.getXid(), message.getImplementedInterface().getName());
 425     }
 426
 427     /**
 428      * @return
 429      */
 430     private ResponseExpectedRpcListener<?> findRpcResponse(final RpcResponseKey key) {
 431         return responseCache.getIfPresent(key);
 432     }
 433
 434     @Override
 435     public void setSystemListener(final SystemNotificationsListener systemListener) {
 436         this.systemListener = systemListener;
 437     }
 438
 439     @Override
 440     public void checkListeners() {
 441         final StringBuilder buffer =  new StringBuilder();
 442         if (systemListener == null) {
 443             buffer.append("SystemListener ");
 444         }
 445         if (messageListener == null) {
 446             buffer.append("MessageListener ");
 447         }
 448         if (connectionReadyListener == null) {
 449             buffer.append("ConnectionReadyListener ");
 450         }
 451
 452         Preconditions.checkState(buffer.length() == 0, "Missing listeners: %s", buffer.toString());
 453     }
 454
 455     @Override
 456     public void fireConnectionReadyNotification() {
 457         new Thread(new Runnable() {
 458             @Override
 459             public void run() {
 460                 connectionReadyListener.onConnectionReady();
 461             }
 462         }).start();
 463     }
 464
 465
 466     @Override
 467     public void setConnectionReadyListener(
 468             final ConnectionReadyListener connectionReadyListener) {
 469         this.connectionReadyListener = connectionReadyListener;
 470     }
 471
 472     @Override
 473     public InetSocketAddress getRemoteAddress() {
 474         return channel.remoteAddress();
 475     }
 476 }