package zab.atomics.pool;

import java.util.concurrent.atomic.AtomicReference;

/**
 * An atomic pool of objects.  It is based on an inverted list.
 * 
 * The pool has no maximum capacity and starts off empty.  You need to load it
 * with objects you want pooled by calling the "release" method.
 * 
 * @author zlatinb
 *
 * @param <T> type of the objects in the pool
 */
public class AtomicPool<T> {

    private final AtomicReference<Wrapper<T>> first = 
            new AtomicReference<Wrapper<T>>();
    
    /**
     * @return an item from the pull, or null if it's empty.
     */
    public Wrapper<T> acquire() {
        while(true) {
            Wrapper<T> f = first.get();
            if (f == null)
                return null;
            if (first.compareAndSet(f,f.getNext()))
                return f;
        }
    }
    
    /**
     * Stores or returns an item to the pool
     */
    public void release(Wrapper<T> item) {
        while(true) {
            Wrapper<T> f = first.get();
            item.setNext(f);
            if (first.compareAndSet(f, item))
                return;
        }
    }
    
    /**
     * Stores or returns many items.  More efficient than calling
     * release repeatedly
     * 
     * @param items array containing items to return
     * @param start start position within the array
     * @param num number of items to return
     */
    public void release(Wrapper<T>[] items, int start, int num) {
        if (num == 0)
            return;
        if (num == 1) {
            release(items[start]);
            return;
        }
        
        for (int i = start; i < start + num - 1; i++)
            items[i].setNext(items[i+1]);
        
        while(true) {
            Wrapper<T> f = first.get();
            items[start + num].setNext(f);
            if (first.compareAndSet(f,items[start]))
                return;
        }
    }
}

@@ -130,17 +130,12 @@
  an 
-inverted 
+free
 list
@@ -288,16 +288,85 @@
 od.%0A * %0A
+ * COSTS: acquire and release cost at least one CAS instruction.%0A * %0A
  * @auth

document that it's a freelist