akka.dispatch.AbstractNodeQueue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of akka-actor_2.11 Show documentation
akka-actor
The newest version!
/**
 * Copyright (C) 2009-2014 Typesafe Inc. 
 */

package akka.dispatch;

import akka.util.Unsafe;

import java.util.concurrent.atomic.AtomicReference;

/**
 * Lock-free MPSC linked queue implementation based on Dmitriy Vyukov's non-intrusive MPSC queue:
 * http://www.1024cores.net/home/lock-free-algorithms/queues/non-intrusive-mpsc-node-based-queue
 */
@SuppressWarnings("serial")
public abstract class AbstractNodeQueue extends AtomicReference> {
    // Extends AtomicReference for the "head" slot (which is the one that is appended to) since Unsafe does not expose XCHG operation intrinsically
    @SuppressWarnings("unused")
    private volatile Node _tailDoNotCallMeDirectly;

    protected AbstractNodeQueue() {
       final Node n = new Node();
       _tailDoNotCallMeDirectly = n;
       set(n);
    }

    /*
     * !!! There is a copy of this code in pollNode() !!!
     */
    @SuppressWarnings("unchecked")
    protected final Node peekNode() {
        for(;;) {
          final Node tail = ((Node)Unsafe.instance.getObjectVolatile(this, tailOffset));
          final Node next = tail.next();
          if (next != null || get() == tail)
            return next;
        }
    }

    public final T peek() {
        final Node n = peekNode();
        return (n != null) ? n.value : null;
    }

    public final void add(final T value) {
        final Node n = new Node(value);
        getAndSet(n).setNext(n);
    }
    
    public final void addNode(final Node n) {
        n.setNext(null);
        getAndSet(n).setNext(n);
    }

    public final boolean isEmpty() {
        return peek() == null;
    }

    public final int count() {
        int count = 0;
        for(Node n = peekNode();n != null; n = n.next())
          ++count;
        return count;
    }

    /*
     * !!! There is a copy of this code in pollNode() !!!
     */
    public final T poll() {
        final Node next = peekNode();
        if (next == null) return null;
        else {
            final T ret = next.value;
            next.value = null;
            Unsafe.instance.putOrderedObject(this, tailOffset, next);
            return ret;
        }
    }
    
    @SuppressWarnings("unchecked")
    public final Node pollNode() {
      Node tail;
      Node next;
      for(;;) {
        tail = ((Node)Unsafe.instance.getObjectVolatile(this, tailOffset));
        next = tail.next();
        if (next != null || get() == tail)
          break;
      }
      if (next == null) return null;
      else {
        tail.value = next.value;
        next.value = null;
        Unsafe.instance.putOrderedObject(this, tailOffset, next);
        return tail;
      }
    }

    private final static long tailOffset;

    static {
        try {
          tailOffset = Unsafe.instance.objectFieldOffset(AbstractNodeQueue.class.getDeclaredField("_tailDoNotCallMeDirectly"));
        } catch(Throwable t){
            throw new ExceptionInInitializerError(t);
        }
    }

    public static class Node {
        public T value;
        @SuppressWarnings("unused")
        private volatile Node _nextDoNotCallMeDirectly;

        public Node() {
            this(null);
        }

        public Node(final T value) {
            this.value = value;
        }

        @SuppressWarnings("unchecked")
        public final Node next() {
            return (Node)Unsafe.instance.getObjectVolatile(this, nextOffset);
        }

        protected final void setNext(final Node newNext) {
          Unsafe.instance.putOrderedObject(this, nextOffset, newNext);
        }
        
        private final static long nextOffset;
        
        static {
            try {
                nextOffset = Unsafe.instance.objectFieldOffset(Node.class.getDeclaredField("_nextDoNotCallMeDirectly"));
            } catch(Throwable t){
                throw new ExceptionInInitializerError(t);
            } 
        }
    } 
}