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

   1 /*
   2  * Copyright (c) 2015 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 package org.opendaylight.openflowjava.protocol.impl.core.connection;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.base.Verify;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.openflowjava.protocol.api.connection.DeviceRequestFailedException;
  16 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  17 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueException;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22
  23 final class OutboundQueueImpl implements OutboundQueue {
  24     private static final Logger LOG = LoggerFactory.getLogger(OutboundQueueImpl.class);
  25     private static final AtomicIntegerFieldUpdater<OutboundQueueImpl> CURRENT_OFFSET_UPDATER =
  26             AtomicIntegerFieldUpdater.newUpdater(OutboundQueueImpl.class, "reserveOffset");
  27     private static final AtomicIntegerFieldUpdater<OutboundQueueImpl> BARRIER_OFFSET_UPDATER =
  28             AtomicIntegerFieldUpdater.newUpdater(OutboundQueueImpl.class, "barrierOffset");
  29     private final OutboundQueueManager<?> manager;
  30     private final OutboundQueueEntry[] queue;
  31     private final long baseXid;
  32     private final long endXid;
  33     private final int reserve;
  34
  35     // Updated concurrently
  36     private volatile int barrierOffset = -1;
  37     private volatile int reserveOffset = 0;
  38
  39     // Updated from Netty only
  40     private int flushOffset;
  41     private int completeCount;
  42     private int lastBarrierOffset = -1;
  43
  44     OutboundQueueImpl(final OutboundQueueManager<?> manager, final long baseXid, final int maxQueue) {
  45         /*
  46          * We use the last entry as an emergency should a timeout-triggered
  47          * flush request race with normal users for the last entry in this
  48          * queue. In that case the flush request will take the last entry and
  49          * schedule a flush, which means that we will get around sending the
  50          * message as soon as the user finishes the reservation.
  51          */
  52         Preconditions.checkArgument(maxQueue > 1);
  53         this.baseXid = baseXid;
  54         this.endXid = baseXid + maxQueue;
  55         this.reserve = maxQueue - 1;
  56         this.manager = Preconditions.checkNotNull(manager);
  57         queue = new OutboundQueueEntry[maxQueue];
  58         for (int i = 0; i < maxQueue; ++i) {
  59             queue[i] = new OutboundQueueEntry();
  60         }
  61     }
  62
  63     private OutboundQueueImpl(final OutboundQueueManager<?> manager, final long baseXid, final OutboundQueueEntry[] queue) {
  64         this.manager = Preconditions.checkNotNull(manager);
  65         this.queue = Preconditions.checkNotNull(queue);
  66         this.baseXid = baseXid;
  67         this.endXid = baseXid + queue.length;
  68         this.reserve = queue.length - 1;
  69         for (OutboundQueueEntry element : queue) {
  70             element.reset();
  71         }
  72     }
  73
  74     OutboundQueueImpl reuse(final long baseXid) {
  75         return new OutboundQueueImpl(manager, baseXid, queue);
  76     }
  77
  78     @Override
  79     public Long reserveEntry() {
  80         return reserveEntry(false);
  81     }
  82
  83     @Override
  84     public void commitEntry(final Long xid, final OfHeader message, final FutureCallback<OfHeader> callback) {
  85         final int offset = (int)(xid - baseXid);
  86         if (message != null) {
  87             Preconditions.checkArgument(xid.equals(message.getXid()), "Message %s has wrong XID %s, expected %s", message, message.getXid(), xid);
  88         }
  89
  90         final OutboundQueueEntry entry = queue[offset];
  91         entry.commit(message, callback);
  92         LOG.debug("Queue {} XID {} at offset {} (of {}) committed", this, xid, offset, reserveOffset);
  93
  94         if (entry.isBarrier()) {
  95             int my = offset;
  96             for (;;) {
  97                 final int prev = BARRIER_OFFSET_UPDATER.getAndSet(this, my);
  98                 if (prev < my) {
  99                     LOG.debug("Queue {} recorded pending barrier offset {}", this, my);
 100                     break;
 101                 }
 102
 103                 // We have traveled back, recover
 104                 my = prev;
 105             }
 106         }
 107
 108         manager.ensureFlushing(this);
 109     }
 110
 111     private Long reserveEntry(final boolean forBarrier) {
 112         final int offset = CURRENT_OFFSET_UPDATER.getAndIncrement(this);
 113         if (offset >= reserve) {
 114             if (forBarrier) {
 115                 LOG.debug("Queue {} offset {}/{}, using emergency slot", this, offset, queue.length);
 116                 return endXid;
 117             } else {
 118                 LOG.debug("Queue {} offset {}/{}, not allowing reservation", this, offset, queue.length);
 119                 return null;
 120             }
 121         }
 122
 123         final Long xid = baseXid + offset;
 124         LOG.debug("Queue {} allocated XID {} at offset {}", this, xid, offset);
 125         return xid;
 126     }
 127
 128     Long reserveBarrierIfNeeded() {
 129         final int bo = barrierOffset;
 130         if (bo >= flushOffset) {
 131             LOG.debug("Barrier found at offset {} (currently at {})", bo, flushOffset);
 132             return null;
 133         } else {
 134             return reserveEntry(true);
 135         }
 136     }
 137
 138     /**
 139      * An empty queue is a queue which has no further unflushed entries.
 140      *
 141      * @return True if this queue does not have unprocessed entries.
 142      */
 143     boolean isEmpty() {
 144         int ro = reserveOffset;
 145         if (ro >= reserve) {
 146             if (queue[reserve].isCommitted()) {
 147                 ro = reserve + 1;
 148             } else {
 149                 ro = reserve;
 150             }
 151         }
 152
 153         LOG.debug("Effective flush/reserve offset {}/{}", flushOffset, ro);
 154         return ro <= flushOffset;
 155     }
 156
 157     /**
 158      * A queue is finished when all of its entries have been completed.
 159      *
 160      * @return False if there are any uncompleted requests.
 161      */
 162     boolean isFinished() {
 163         if (completeCount < reserve) {
 164             return false;
 165         }
 166
 167         // We need to check if the last entry was used
 168         final OutboundQueueEntry last = queue[reserve];
 169         return !last.isCommitted() || last.isCompleted();
 170     }
 171
 172     boolean isFlushed() {
 173         LOG.debug("Check queue {} for completeness (offset {}, reserve {})", flushOffset, reserve);
 174         if (flushOffset < reserve) {
 175             return false;
 176         }
 177
 178         // flushOffset implied == reserve
 179         return flushOffset >= queue.length || !queue[reserve].isCommitted();
 180     }
 181
 182     OfHeader flushEntry() {
 183         for (;;) {
 184             // No message ready
 185             if (isEmpty()) {
 186                 LOG.trace("Flushed all reserved entries up to ", flushOffset);
 187                 return null;
 188             }
 189
 190             final OutboundQueueEntry entry = queue[flushOffset];
 191             if (!entry.isCommitted()) {
 192                 LOG.trace("Request at offset {} not ready yet, giving up", flushOffset);
 193                 return null;
 194             }
 195
 196             final OfHeader msg = entry.getMessage();
 197             flushOffset++;
 198             if (msg != null) {
 199                 return msg;
 200             }
 201
 202             LOG.trace("Null message, skipping to offset {}", flushOffset);
 203         }
 204     }
 205
 206     // Argument is 'long' to explicitly convert before performing operations
 207     private boolean xidInRange(final long xid) {
 208         return xid < endXid && (xid >= baseXid || baseXid > endXid);
 209     }
 210
 211     private static boolean completeEntry(final OutboundQueueEntry entry, final OfHeader response) {
 212         if (response instanceof Error) {
 213             final Error err = (Error)response;
 214             LOG.debug("Device-reported request XID {} failed {}:{}", response.getXid(), err.getTypeString(), err.getCodeString());
 215             entry.fail(new DeviceRequestFailedException("Device-side failure", err));
 216             return true;
 217         } else {
 218             return entry.complete(response);
 219         }
 220     }
 221
 222     /**
 223      * Return the request entry corresponding to a response. Returns null
 224      * if there is no request matching the response.
 225      *
 226      * @param response Response message
 227      * @return Matching request entry, or null if no match is found.
 228      */
 229     OutboundQueueEntry pairRequest(@Nonnull final OfHeader response) {
 230         final Long xid = response.getXid();
 231         if (!xidInRange(xid)) {
 232             LOG.debug("Queue {} {}/{} ignoring XID {}", this, baseXid, queue.length, xid);
 233             return null;
 234         }
 235
 236         final int offset = (int)(xid - baseXid);
 237         final OutboundQueueEntry entry = queue[offset];
 238         if (entry.isCompleted()) {
 239             LOG.debug("Entry {} already is completed, not accepting response {}", entry, response);
 240             return null;
 241         }
 242
 243         if (entry.isBarrier()) {
 244             // This has been a barrier -- make sure we complete all preceding requests.
 245             // XXX: Barriers are expected to complete in one message.
 246             //      If this assumption is changed, this logic will need to be expanded
 247             //      to ensure that the requests implied by the barrier are reported as
 248             //      completed *after* the barrier.
 249             LOG.trace("Barrier XID {} completed, cascading completion to XIDs {} to {}", xid, baseXid + lastBarrierOffset + 1, xid - 1);
 250             completeRequests(offset);
 251             lastBarrierOffset = offset;
 252
 253             final boolean success = completeEntry(entry, response);
 254             Verify.verify(success, "Barrier request failed to complete");
 255             completeCount++;
 256         } else if (completeEntry(entry, response)) {
 257             completeCount++;
 258         }
 259
 260         return entry;
 261     }
 262
 263     private void completeRequests(final int toOffset) {
 264         for (int i = lastBarrierOffset + 1; i < toOffset; ++i) {
 265             final OutboundQueueEntry entry = queue[i];
 266             if (!entry.isCompleted() && entry.complete(null)) {
 267                 completeCount++;
 268             }
 269         }
 270     }
 271
 272     void completeAll() {
 273         completeRequests(queue.length);
 274     }
 275
 276     int failAll(final OutboundQueueException cause) {
 277         int ret = 0;
 278         for (int i = lastBarrierOffset + 1; i < queue.length; ++i) {
 279             final OutboundQueueEntry entry = queue[i];
 280             if (!entry.isCommitted()) {
 281                 break;
 282             }
 283
 284             if (!entry.isCompleted()) {
 285                 entry.fail(cause);
 286                 ret++;
 287             }
 288         }
 289
 290         return ret;
 291     }
 292 }