Repository navigation
Expand file tree
/
Copy pathAtomic.java
More file actions
708 lines (610 loc) · 20.4 KB
/
Copy pathAtomic.java
File metadata and controls
708 lines (610 loc) · 20.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
/*
* Copyright (c) 2012 Jan Kotek
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Adopted from Apache Harmony with following copyright:
*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group and released to the public domain, as explained at
* http://creativecommons.org/licenses/publicdomain
*/
package org.mapdb;
import java.io.DataInput;
import java.io.IOException;
/**
* A small toolkit of classes that support lock-free thread-safe
* programming on single records. In essence, the classes here
* provide provide an atomic conditional update operation of the form:
* <p>
*
* <pre>
* boolean compareAndSet(expectedValue, updateValue);
* </pre>
*
* <p>This method (which varies in argument types across different
* classes) atomically sets a record to the {@code updateValue} if it
* currently holds the {@code expectedValue}, reporting {@code true} on
* success. Classes jere also contain methods to get and
* unconditionally set values.
*
* <p>The specifications of these methods enable to
* employ more efficient internal DB locking. CompareAndSwap
* operation is typically faster than using transactions, global lock or other
* concurrent protection.
*
* <p>Instances of classes
* {@link Atomic.Boolean},
* {@link Atomic.Integer},
* {@link Atomic.Long},
* {@link Atomic.String} and
* {@link Atomic.Var}
* each provide access and updates to a single record of the
* corresponding type. Each class also provides appropriate utility
* methods for that type. For example, classes {@code Atomic.Long} and
* {@code Atomic.Integer} provide atomic increment methods. One
* application is to generate unique keys for Maps:
*
* <pre>
* Atomic.Long id = Atomic.getLong("mapId");
* map.put(id.getAndIncrement(), "something");
* </pre>
*
* <p>Atomic classes are designed primarily as building blocks for
* implementing non-blocking data structures and related infrastructure
* classes. The {@code compareAndSet} method is not a general
* replacement for locking. It applies only when critical updates for an
* object are confined to a <em>single</em> record.
*
* <p>Atomic classes are not general purpose replacements for
* {@code java.lang.Integer} and related classes. They do <em>not</em>
* define methods such as {@code hashCode} and
* {@code compareTo}. (Because atomic records are expected to be
* mutated, they are poor choices for hash table keys.) Additionally,
* classes are provided only for those types that are commonly useful in
* intended applications. Other types has to be wrapped into general {@link Atomic.Var}
* <p/>
* You can also hold floats using
* {@link java.lang.Float#floatToIntBits} and
* {@link java.lang.Float#intBitsToFloat} conversions, and doubles using
* {@link java.lang.Double#doubleToLongBits} and
* {@link java.lang.Double#longBitsToDouble} conversions.
*
*/
final public class Atomic {
private Atomic(){}
/**
* An {@code int} record that may be updated atomically. An
* {@code Atomic@Integer} is used in applications such as atomically
* incremented counters, and cannot be used as a replacement for an
* {@link java.lang.Integer}. However, this class does extend
* {@code Number} to allow uniform access by tools and utilities that
* deal with numerically-based classes.
*/
public final static class Integer extends Number {
private static final long serialVersionUID = 4615119399830853054L;
protected final Engine engine;
protected final long recid;
public Integer(Engine engine, long recid) {
this.engine = engine;
this.recid = recid;
}
/**
* @return recid under which value is saved
*/
public long getRecid(){
return recid;
}
/**
* Gets the current value.
*
* @return the current value
*/
public final int get() {
return engine.get(recid, Serializer.INTEGER);
}
/**
* Sets to the given value.
*
* @param newValue the new value
*/
public final void set(int newValue) {
engine.update(recid, newValue, Serializer.INTEGER);
}
/**
* Atomically sets to the given value and returns the old value.
*
* @param newValue the new value
* @return the previous value
*/
public final int getAndSet(int newValue) {
for (;;) {
int current = get();
if (compareAndSet(current, newValue))
return current;
}
}
/**
* Atomically sets the value to the given updated value
* if the current value {@code ==} the expected value.
*
* @param expect the expected value
* @param update the new value
* @return true if successful. False return indicates that
* the actual value was not equal to the expected value.
*/
public final boolean compareAndSet(int expect, int update) {
return engine.compareAndSwap(recid, expect, update, Serializer.INTEGER);
}
/**
* Atomically increments by one the current value.
*
* @return the previous value
*/
public final int getAndIncrement() {
for (;;) {
int current = get();
int next = current + 1;
if (compareAndSet(current, next))
return current;
}
}
/**
* Atomically decrements by one the current value.
*
* @return the previous value
*/
public final int getAndDecrement() {
for (;;) {
int current = get();
int next = current - 1;
if (compareAndSet(current, next))
return current;
}
}
/**
* Atomically adds the given value to the current value.
*
* @param delta the value to add
* @return the previous value
*/
public final int getAndAdd(int delta) {
for (;;) {
int current = get();
int next = current + delta;
if (compareAndSet(current, next))
return current;
}
}
/**
* Atomically increments by one the current value.
*
* @return the updated value
*/
public final int incrementAndGet() {
for (;;) {
int current = get();
int next = current + 1;
if (compareAndSet(current, next))
return next;
}
}
/**
* Atomically decrements by one the current value.
*
* @return the updated value
*/
public final int decrementAndGet() {
for (;;) {
int current = get();
int next = current - 1;
if (compareAndSet(current, next))
return next;
}
}
/**
* Atomically adds the given value to the current value.
*
* @param delta the value to add
* @return the updated value
*/
public final int addAndGet(int delta) {
for (;;) {
int current = get();
int next = current + delta;
if (compareAndSet(current, next))
return next;
}
}
/**
* Returns the String representation of the current value.
* @return the String representation of the current value.
*/
public java.lang.String toString() {
return java.lang.Integer.toString(get());
}
public int intValue() {
return get();
}
public long longValue() {
return (long)get();
}
public float floatValue() {
return (float)get();
}
public double doubleValue() {
return (double)get();
}
}
/**
* A {@code long} record that may be updated atomically. An
* {@code Atomic#Long} is used in applications such as atomically
* incremented sequence numbers, and cannot be used as a replacement
* for a {@link java.lang.Long}. However, this class does extend
* {@code Number} to allow uniform access by tools and utilities that
* deal with numerically-based classes.
*/
public final static class Long extends Number{
private static final long serialVersionUID = 2882620413591274781L;
protected final Engine engine;
protected final long recid;
public Long(Engine engine, long recid) {
this.engine = engine;
this.recid = recid;
}
/**
* @return recid under which value is saved
*/
public long getRecid(){
return recid;
}
/**
* Gets the current value.
*
* @return the current value
*/
public final long get() {
return engine.get(recid, Serializer.LONG);
}
/**
* Sets to the given value.
*
* @param newValue the new value
*/
public final void set(long newValue) {
engine.update(recid, newValue, Serializer.LONG);
}
/**
* Atomically sets to the given value and returns the old value.
*
* @param newValue the new value
* @return the previous value
*/
public final long getAndSet(long newValue) {
while (true) {
long current = get();
if (compareAndSet(current, newValue))
return current;
}
}
/**
* Atomically sets the value to the given updated value
* if the current value {@code ==} the expected value.
*
* @param expect the expected value
* @param update the new value
* @return true if successful. False return indicates that
* the actual value was not equal to the expected value.
*/
public final boolean compareAndSet(long expect, long update) {
return engine.compareAndSwap(recid, expect, update, Serializer.LONG);
}
/**
* Atomically increments by one the current value.
*
* @return the previous value
*/
public final long getAndIncrement() {
while (true) {
long current = get();
long next = current + 1;
if (compareAndSet(current, next))
return current;
}
}
/**
* Atomically decrements by one the current value.
*
* @return the previous value
*/
public final long getAndDecrement() {
while (true) {
long current = get();
long next = current - 1;
if (compareAndSet(current, next))
return current;
}
}
/**
* Atomically adds the given value to the current value.
*
* @param delta the value to add
* @return the previous value
*/
public final long getAndAdd(long delta) {
while (true) {
long current = get();
long next = current + delta;
if (compareAndSet(current, next))
return current;
}
}
/**
* Atomically increments by one the current value.
*
* @return the updated value
*/
public final long incrementAndGet() {
for (;;) {
long current = get();
long next = current + 1;
if (compareAndSet(current, next))
return next;
}
}
/**
* Atomically decrements by one the current value.
*
* @return the updated value
*/
public final long decrementAndGet() {
for (;;) {
long current = get();
long next = current - 1;
if (compareAndSet(current, next))
return next;
}
}
/**
* Atomically adds the given value to the current value.
*
* @param delta the value to add
* @return the updated value
*/
public final long addAndGet(long delta) {
for (;;) {
long current = get();
long next = current + delta;
if (compareAndSet(current, next))
return next;
}
}
/**
* Returns the String representation of the current value.
* @return the String representation of the current value.
*/
public java.lang.String toString() {
return java.lang.Long.toString(get());
}
public int intValue() {
return (int)get();
}
public long longValue() {
return get();
}
public float floatValue() {
return (float)get();
}
public double doubleValue() {
return (double)get();
}
}
/**
* A {@code boolean} record that may be updated atomically.
*/
public final static class Boolean {
protected final Engine engine;
protected final long recid;
public Boolean(Engine engine, long recid) {
this.engine = engine;
this.recid = recid;
}
/**
* @return recid under which value is saved
*/
public long getRecid(){
return recid;
}
/**
* Returns the current value.
*
* @return the current value
*/
public final boolean get() {
return engine.get(recid, Serializer.BOOLEAN);
}
/**
* Atomically sets the value to the given updated value
* if the current value {@code ==} the expected value.
*
* @param expect the expected value
* @param update the new value
* @return true if successful. False return indicates that
* the actual value was not equal to the expected value.
*/
public final boolean compareAndSet(boolean expect, boolean update) {
return engine.compareAndSwap(recid, expect, update, Serializer.BOOLEAN);
}
/**
* Unconditionally sets to the given value.
*
* @param newValue the new value
*/
public final void set(boolean newValue) {
engine.update(recid, newValue, Serializer.BOOLEAN);
}
/**
* Atomically sets to the given value and returns the previous value.
*
* @param newValue the new value
* @return the previous value
*/
public final boolean getAndSet(boolean newValue) {
for (;;) {
boolean current = get();
if (compareAndSet(current, newValue))
return current;
}
}
/**
* Returns the String representation of the current value.
* @return the String representation of the current value.
*/
public java.lang.String toString() {
return java.lang.Boolean.toString(get());
}
}
/**
* A {@code String} record that may be updated atomically.
*/
public final static class String{
protected final Engine engine;
protected final long recid;
public String(Engine engine, long recid) {
this.engine = engine;
this.recid = recid;
}
/**
* @return recid under which value is saved
*/
public long getRecid(){
return recid;
}
public java.lang.String toString() {
return get();
}
/**
* Returns the current value.
*
* @return the current value
*/
public final java.lang.String get() {
return engine.get(recid, Serializer.STRING_NOSIZE);
}
/**
* Atomically sets the value to the given updated value
* if the current value equals the expected value.
*
* @param expect the expected value
* @param update the new value
* @return true if successful. False return indicates that
* the actual value was not equal to the expected value.
*/
public final boolean compareAndSet(java.lang.String expect, java.lang.String update) {
return engine.compareAndSwap(recid, expect, update, Serializer.STRING_NOSIZE);
}
/**
* Unconditionally sets to the given value.
*
* @param newValue the new value
*/
public final void set(java.lang.String newValue) {
engine.update(recid, newValue, Serializer.STRING_NOSIZE);
}
/**
* Atomically sets to the given value and returns the previous value.
*
* @param newValue the new value
* @return the previous value
*/
public final java.lang.String getAndSet(java.lang.String newValue) {
for (;;) {
java.lang.String current = get();
if (compareAndSet(current, newValue))
return current;
}
}
}
/**
* Atomically updated variable which may contain any type of record.
*/
public static final class Var<E> {
protected final Engine engine;
protected final long recid;
protected final Serializer<E> serializer;
public Var(Engine engine, long recid, Serializer<E> serializer) {
this.engine = engine;
this.recid = recid;
this.serializer = serializer;
}
/** used for deserialization */
protected Var(Engine engine, SerializerBase serializerBase, DataInput is, SerializerBase.FastArrayList<Object> objectStack) throws IOException {
objectStack.add(this);
this.engine = engine;
this.recid = DataInput2.unpackLong(is);
this.serializer = (Serializer<E>) serializerBase.deserialize(is,objectStack);
}
/**
* @return recid under which value is saved
*/
public long getRecid(){
return recid;
}
public java.lang.String toString() {
E v = get();
return v==null? null : v.toString();
}
/**
* Returns the current value.
*
* @return the current value
*/
public final E get() {
return engine.get(recid, serializer);
}
/**
* Atomically sets the value to the given updated value
* if the current value equals the expected value.
*
* @param expect the expected value
* @param update the new value
* @return true if successful. False return indicates that
* the actual value was not equal to the expected value.
*/
public final boolean compareAndSet(E expect, E update) {
return engine.compareAndSwap(recid, expect, update, serializer);
}
/**
* Unconditionally sets to the given value.
*
* @param newValue the new value
*/
public final void set(E newValue) {
engine.update(recid, newValue, serializer);
}
/**
* Atomically sets to the given value and returns the previous value.
*
* @param newValue the new value
* @return the previous value
*/
public final E getAndSet(E newValue) {
for (;;) {
E current = get();
if (compareAndSet(current, newValue))
return current;
}
}
}
}