ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/jsr166e/StripedAdder.java
(Generate patch)

Comparing jsr166/src/jsr166e/StripedAdder.java (file contents):
Revision 1.4 by dl, Sat Jul 23 16:32:53 2011 UTC vs.
Revision 1.10 by dl, Fri Jul 29 13:50:54 2011 UTC

# Line 5 | Line 5
5   */
6  
7   package jsr166e;
8 import java.util.Arrays;
8   import java.util.Random;
9   import java.util.concurrent.atomic.AtomicInteger;
10   import java.util.concurrent.atomic.AtomicLong;
# Line 27 | Line 26 | import java.io.ObjectOutputStream;
26   * update a common sum that is used for purposes such as collecting
27   * statistics. In this case, performance may be significantly faster
28   * than using a shared {@link AtomicLong}, at the expense of using
29 < * much more space.  On the other hand, if it is known that only one
30 < * thread can ever update the sum, performance may be significantly
31 < * slower than just updating a local variable.
29 > * more space.  On the other hand, if it is known that only one thread
30 > * can ever update the sum, performance may be significantly slower
31 > * than just updating a local variable.
32   *
33   * <p>A StripedAdder may optionally be constructed with a given
34   * expected contention level; i.e., the number of threads that are
# Line 44 | Line 43 | public class StripedAdder implements Ser
43  
44      /*
45       * A StripedAdder maintains a table of Atomic long variables. The
46 <     * table is indexed by per-thread hash codes that are initialized
48 <     * to random values.
46 >     * table is indexed by per-thread hash codes.
47       *
48 <     * The table doubles in size upon contention (as indicated by
49 <     * failed CASes when performing add()), but is capped at the
50 <     * nearest power of two >= #CPUS. This reflects the idea that,
51 <     * when there are more threads than CPUs, then if each thread were
48 >     * Table entries are of class Adder; a variant of AtomicLong
49 >     * padded to reduce cache contention on most processors. Padding
50 >     * is overkill for most Atomics because they are usually
51 >     * irregularly scattered in memory and thus don't interfere much
52 >     * with each other. But Atomic objects residing in arrays will
53 >     * tend to be placed adjacent to each other, and so will most
54 >     * often share cache lines (with a huge negative performance
55 >     * impact) without this precaution.
56 >     *
57 >     * Because Adders are relatively large, we avoid creating them
58 >     * until they are needed. On the other hand, we try to create them
59 >     * on any sign of contention.
60 >     *
61 >     * Per-thread hash codes are initialized to random values.
62 >     * Collisions are indicated by failed CASes when performing an add
63 >     * operation (see method retryAdd). Upon a collision, if the table
64 >     * size is less than the capacity, it is doubled in size unless
65 >     * some other thread holds lock. If a hashed slot is empty, and
66 >     * lock is available, a new Adder is created. Otherwise, if the
67 >     * slot exists, a CAS is tried.  Retries proceed by "double
68 >     * hashing", using a secondary hash (Marsaglia XorShift) to try to
69 >     * find a free slot.
70 >     *
71 >     * By default, the table is lazily initialized.  Upon first use,
72 >     * the table is set to size 1, and contains a single Adder. The
73 >     * maximum table size is bounded by nearest power of two >= the
74 >     * number of CPUS.  The table size is capped because, when there
75 >     * are more threads than CPUs, supposing that each thread were
76       * bound to a CPU, there would exist a perfect hash function
77       * mapping threads to slots that eliminates collisions. When we
78       * reach capacity, we search for this mapping by randomly varying
# Line 61 | Line 83 | public class StripedAdder implements Ser
83       * limitations, observed contention is typically low in these
84       * cases.
85       *
64     * Table entries are of class Adder; a form of AtomicLong padded
65     * to reduce cache contention on most processors. Padding is
66     * overkill for most Atomics because they are most often
67     * irregularly scattered in memory and thus don't interfere much
68     * with each other. But Atomic objects residing in arrays will
69     * tend to be placed adjacent to each other, and so will most
70     * often share cache lines without this precaution.  Adders are
71     * constructed upon first use, which further improves per-thread
72     * locality and helps reduce (an already large) footprint.
73     *
86       * A single spinlock is used for resizing the table as well as
87 <     * populating slots with new Adders. Upon lock contention, threads
87 >     * populating slots with new Adders. After initialization, there
88 >     * is no need for a blocking lock: Upon lock contention, threads
89       * try other slots rather than blocking. After initialization, at
90       * least one slot exists, so retries will eventually find a
91 <     * candidate Adder. During these retries, there is increased
91 >     * candidate Adder.  During these retries, there is increased
92       * contention and reduced locality, which is still better than
93       * alternatives.
94       */
95  
96 <    /**
84 <     * Number of processors, to place a cap on table growth.
85 <     */
86 <    static final int NCPU = Runtime.getRuntime().availableProcessors();
96 >    private static final int NCPU = Runtime.getRuntime().availableProcessors();
97  
98      /**
99 <     * Padded version of AtomicLong
99 >     * Padded variant of AtomicLong.  The value field is placed
100 >     * between pads, hoping that the JVM doesn't reorder them.
101 >     * Updates are via inlined CAS in methods add and retryAdd.
102       */
103 <    static final class Adder extends AtomicLong {
104 <        long p0, p1, p2, p3, p4, p5, p6, p7, p8, p9, pa, pb, pc, pd;
105 <        Adder(long x) { super(x); }
103 >    static final class Adder {
104 >        volatile long p0, p1, p2, p3, p4, p5, p6;
105 >        volatile long value;
106 >        volatile long q0, q1, q2, q3, q4, q5, q6;
107 >        Adder(long x) { value = x; }
108      }
109  
110      /**
111 <     * Holder for the thread-local hash code. The code starts off with
112 <     * a given random value, but may be set to a different value upon
99 <     * collisions in retryAdd.
111 >     * Holder for the thread-local hash code. The code is initially
112 >     * random, but may be set to a different value upon collisions.
113       */
114      static final class HashCode {
115 +        static final Random rng = new Random();
116          int code;
117 <        HashCode(int h) { code = h; }
117 >        HashCode() {
118 >            int h = rng.nextInt(); // Avoid zero, because of xorShift rehash
119 >            code = (h == 0) ? 1 : h;
120 >        }
121      }
122  
123      /**
124       * The corresponding ThreadLocal class
125       */
126      static final class ThreadHashCode extends ThreadLocal<HashCode> {
127 <        static final Random rng = new Random();
111 <        public HashCode initialValue() {
112 <            int h = rng.nextInt();
113 <            return new HashCode((h == 0) ? 1 : h); // ensure nonzero
114 <        }
127 >        public HashCode initialValue() { return new HashCode(); }
128      }
129  
130      /**
131       * Static per-thread hash codes. Shared across all StripedAdders
132 <     * because adjustments due to collisions in one table are likely
133 <     * to be appropriate for others.
132 >     * to reduce ThreadLocal pollution and because adjustments due to
133 >     * collisions in one table are likely to be appropriate for
134 >     * others.
135       */
136      static final ThreadHashCode threadHashCode = new ThreadHashCode();
137  
138      /**
139 <     * Table of adders. Minimum size 2. Size grows to be at most NCPU.
139 >     * Table of adders. When non-null, size is a power of 2.
140       */
141      private transient volatile Adder[] adders;
142  
143      /**
144 <     * Serves as a lock when resizing and/or creating Adders.  There
131 <     * is no need for a blocking lock: When busy, other threads try
132 <     * other slots.
144 >     * Spinlock (locked via CAS) used when resizing and/or creating Adders.
145       */
146 <    private final AtomicInteger mutex;
146 >    private volatile int busy;
147  
148      /**
149       * Creates a new adder with zero sum.
150       */
151      public StripedAdder() {
140        this.mutex = new AtomicInteger();
141        // remaining initialization on first call to add.
152      }
153  
154      /**
# Line 150 | Line 160 | public class StripedAdder implements Ser
160       */
161      public StripedAdder(int expectedContention) {
162          int cap = (expectedContention < NCPU) ? expectedContention : NCPU;
163 <        int size = 2;
163 >        int size = 1;
164          while (size < cap)
165              size <<= 1;
166          Adder[] as = new Adder[size];
167          for (int i = 0; i < size; ++i)
168              as[i] = new Adder(0);
169          this.adders = as;
160        this.mutex = new AtomicInteger();
170      }
171  
172      /**
# Line 166 | Line 175 | public class StripedAdder implements Ser
175       * @param x the value to add
176       */
177      public void add(long x) {
178 <        Adder[] as; Adder a; int n; long v; // locals to hold volatile reads
178 >        Adder[] as; Adder a; int n;  // locals to hold volatile reads
179          HashCode hc = threadHashCode.get();
180 <        if ((as = adders) == null || (n = as.length) < 1 ||
181 <            (a = as[hc.code & (n - 1)]) == null ||
182 <            !a.compareAndSet(v = a.get(), v + x))
183 <            retryAdd(x, hc);
180 >        int h = hc.code;
181 >        boolean contended;
182 >        if ((as = adders) != null && (n = as.length) > 0 &&
183 >            (a = as[(n - 1) & h]) != null) {
184 >            long v = a.value;
185 >            if (UNSAFE.compareAndSwapLong(a, valueOffset, v, v + x))
186 >                return;
187 >            contended = true;
188 >        }
189 >        else
190 >            contended = false;
191 >        retryAdd(x, hc, contended);
192      }
193  
194      /**
195       * Handle cases of add involving initialization, resizing,
196 <     * creating new Adders, and/or contention.
196 >     * creating new Adders, and/or contention. See above for
197 >     * explanation. This method suffers the usual non-modularity
198 >     * problems of optimistic retry code, relying on rechecked sets of
199 >     * reads.
200 >     *
201 >     * @param x the value to add
202 >     * @param hc the hash code holder
203 >     * @param precontended true if CAS failed before call
204       */
205 <    private void retryAdd(long x, HashCode hc) {
205 >    private void retryAdd(long x, HashCode hc, boolean precontended) {
206          int h = hc.code;
207 <        final AtomicInteger mutex = this.mutex;
208 <        AtomicInteger lock = null;                     // nonnull when held
209 <        try {
210 <            for (;;) {
211 <                Adder[] as; Adder a; long v; int n, k; // locals for volatiles
212 <                boolean needLock = true;
213 <                if ((as = adders) == null || (n = as.length) < 1) {
214 <                    if (lock != null)                  // default-initialize
215 <                        adders = new Adder[2];
207 >        boolean collide = false; // true if last slot nonempty
208 >        for (;;) {
209 >            Adder[] as; Adder a; int n;
210 >            if ((as = adders) != null && (n = as.length) > 0) {
211 >                if ((a = as[(n - 1) & h]) == null) {
212 >                    if (busy == 0 &&            // Try to attach new Adder
213 >                        UNSAFE.compareAndSwapInt(this, busyOffset, 0, 1)) {
214 >                        boolean created = false;
215 >                        try {                   // Recheck under lock
216 >                            Adder[] rs; int m, j;
217 >                            if ((rs = adders) != null && (m = rs.length) > 0 &&
218 >                                rs[j = (m - 1) & h] == null) {
219 >                                rs[j] = new Adder(x);
220 >                                created = true;
221 >                            }
222 >                        } finally {
223 >                            busy = 0;
224 >                        }
225 >                        if (created)
226 >                            break;
227 >                        continue;               // Slot is now non-empty
228 >                    }
229 >                    collide = false;
230                  }
231 <                else if ((a = as[k = h & (n - 1)]) == null) {
232 <                    if (lock != null) {                // attach new adder
233 <                        as[k] = new Adder(x);
231 >                else if (precontended)          // CAS already known to fail
232 >                    precontended = false;       // Continue after rehash
233 >                else {
234 >                    long v = a.value;
235 >                    if (UNSAFE.compareAndSwapLong(a, valueOffset, v, v + x))
236                          break;
237 +                    if (!collide)
238 +                        collide = true;
239 +                    else if (n >= NCPU || adders != as)
240 +                        collide = false;        // Don't expand
241 +                    else if (busy == 0 &&
242 +                             UNSAFE.compareAndSwapInt(this, busyOffset, 0, 1)) {
243 +                        collide = false;
244 +                        try {
245 +                            if (adders == as) { // Expand table
246 +                                Adder[] rs = new Adder[n << 1];
247 +                                for (int i = 0; i < n; ++i)
248 +                                    rs[i] = as[i];
249 +                                adders = rs;
250 +                            }
251 +                        } finally {
252 +                            busy = 0;
253 +                        }
254 +                        continue;
255                      }
256                  }
257 <                else if (a.compareAndSet(v = a.get(), v + x))
258 <                    break;
259 <                else if (n >= NCPU)                    // cannot expand
260 <                    needLock = false;
261 <                else if (lock != null)                 // expand table
262 <                    adders = Arrays.copyOf(as, n << 1);
263 <
264 <                if (lock == null) {
265 <                    if (needLock && mutex.get() == 0 &&
266 <                        mutex.compareAndSet(0, 1))
267 <                        lock = mutex;
268 <                    else {                             // try elsewhere
269 <                        h ^= h << 13;                  // Marsaglia XorShift
270 <                        h ^= h >>> 17;
271 <                        h ^= h << 5;
257 >                h ^= h << 13;                   // Rehash
258 >                h ^= h >>> 17;
259 >                h ^= h << 5;
260 >            }
261 >            else if (adders == as) {            // Try to default-initialize
262 >                Adder[] rs = new Adder[1];
263 >                rs[0] = new Adder(x);
264 >                boolean init = false;
265 >                while (adders == as) {
266 >                    if (UNSAFE.compareAndSwapInt(this, busyOffset, 0, 1)) {
267 >                        try {
268 >                            if (adders == as) {
269 >                                adders = rs;
270 >                                init = true;
271 >                            }
272 >                        } finally {
273 >                            busy = 0;
274 >                        }
275 >                        break;
276                      }
277 +                    if (adders != as)
278 +                        break;
279 +                    Thread.yield();              // Back off
280                  }
281 +                if (init)
282 +                    break;
283              }
217        } finally {
218            if (lock != null)
219                lock.set(0);
284          }
285 <        if (hc.code != h)                              // avoid unneeded writes
286 <            hc.code = h;
285 >        hc.code = h;                            // Record index for next time
286 >    }
287 >
288 >    /**
289 >     * Equivalent to {@code add(1)}.
290 >     */
291 >    public void increment() {
292 >        add(1L);
293 >    }
294 >
295 >    /**
296 >     * Equivalent to {@code add(-1)}.
297 >     */
298 >    public void decrement() {
299 >        add(-1L);
300      }
301  
302      /**
# Line 237 | Line 314 | public class StripedAdder implements Ser
314              for (int i = 0; i < n; ++i) {
315                  Adder a = as[i];
316                  if (a != null)
317 <                    sum += a.get();
317 >                    sum += a.value;
318              }
319          }
320          return sum;
321      }
322  
323      /**
324 <     * Resets each of the variables to zero. This is effective in
325 <     * fully resetting the sum only if there are no concurrent
326 <     * updates.
250 <     */
251 <    public void reset() {
252 <        Adder[] as = adders;
253 <        if (as != null) {
254 <            int n = as.length;
255 <            for (int i = 0; i < n; ++i) {
256 <                Adder a = as[i];
257 <                if (a != null)
258 <                    a.set(0L);
259 <            }
260 <        }
261 <    }
262 <
263 <    /**
264 <     * Equivalent to {@code add(1)}.
265 <     */
266 <    public void increment() {
267 <        add(1L);
268 <    }
269 <
270 <    /**
271 <     * Equivalent to {@code add(-1)}.
272 <     */
273 <    public void decrement() {
274 <        add(-1L);
275 <    }
276 <
277 <    /**
278 <     * Equivalent to {@link #sum} followed by {@link #reset}.
324 >     * Resets each of the variables to zero, returning the estimated
325 >     * previous sum. This is effective in fully resetting the sum only
326 >     * if there are no concurrent updates.
327       *
328 <     * @return the estimated sum
328 >     * @return the estimated previous sum
329       */
330 <    public long sumAndReset() {
330 >    public long reset() {
331          long sum = 0L;
332          Adder[] as = adders;
333          if (as != null) {
# Line 287 | Line 335 | public class StripedAdder implements Ser
335              for (int i = 0; i < n; ++i) {
336                  Adder a = as[i];
337                  if (a != null) {
338 <                    sum += a.get();
339 <                    a.set(0L);
338 >                    sum += a.value;
339 >                    a.value = 0L;
340                  }
341              }
342          }
# Line 304 | Line 352 | public class StripedAdder implements Ser
352      private void readObject(ObjectInputStream s)
353          throws IOException, ClassNotFoundException {
354          s.defaultReadObject();
355 <        mutex.set(0);
355 >        busy = 0;
356          add(s.readLong());
357      }
358  
359 +    // Unsafe mechanics
360 +    private static final sun.misc.Unsafe UNSAFE;
361 +    private static final long busyOffset;
362 +    private static final long valueOffset;
363 +    static {
364 +        try {
365 +            UNSAFE = getUnsafe();
366 +            Class<?> sk = StripedAdder.class;
367 +            busyOffset = UNSAFE.objectFieldOffset
368 +                (sk.getDeclaredField("busy"));
369 +            Class<?> ak = Adder.class;
370 +            valueOffset = UNSAFE.objectFieldOffset
371 +                (ak.getDeclaredField("value"));
372 +        } catch (Exception e) {
373 +            throw new Error(e);
374 +        }
375 +    }
376 +
377 +    /**
378 +     * Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
379 +     * Replace with a simple call to Unsafe.getUnsafe when integrating
380 +     * into a jdk.
381 +     *
382 +     * @return a sun.misc.Unsafe
383 +     */
384 +    private static sun.misc.Unsafe getUnsafe() {
385 +        try {
386 +            return sun.misc.Unsafe.getUnsafe();
387 +        } catch (SecurityException se) {
388 +            try {
389 +                return java.security.AccessController.doPrivileged
390 +                    (new java.security
391 +                     .PrivilegedExceptionAction<sun.misc.Unsafe>() {
392 +                        public sun.misc.Unsafe run() throws Exception {
393 +                            java.lang.reflect.Field f = sun.misc
394 +                                .Unsafe.class.getDeclaredField("theUnsafe");
395 +                            f.setAccessible(true);
396 +                            return (sun.misc.Unsafe) f.get(null);
397 +                        }});
398 +            } catch (java.security.PrivilegedActionException e) {
399 +                throw new RuntimeException("Could not initialize intrinsics",
400 +                                           e.getCause());
401 +            }
402 +        }
403 +    }
404 +
405   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines