Repository navigation
Expand file tree
/
Copy pathEngineWrapper.java
More file actions
599 lines (472 loc) · 16.9 KB
/
Copy pathEngineWrapper.java
File metadata and controls
599 lines (472 loc) · 16.9 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
/*
* 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.
*/
package org.mapdb;
import java.io.IOError;
import java.io.IOException;
import java.util.Arrays;
import java.util.Iterator;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.logging.Logger;
/**
* EngineWrapper adapter. It implements all methods on Engine interface.
*
* @author Jan Kotek
*/
public class EngineWrapper implements Engine{
protected static final Logger LOG = !CC.LOG_EWRAP?null :
Logger.getLogger(EngineWrapper.class.getName());
private Engine engine;
protected EngineWrapper(Engine engine){
if(engine == null) throw new IllegalArgumentException();
this.engine = engine;
}
@Override
public long preallocate(){
return getWrappedEngine().preallocate();
}
@Override
public void preallocate(long[] recids){
getWrappedEngine().preallocate(recids);
}
@Override
public <A> long put(A value, Serializer<A> serializer) {
return getWrappedEngine().put(value, serializer);
}
@Override
public <A> A get(long recid, Serializer<A> serializer) {
return getWrappedEngine().get(recid, serializer);
}
@Override
public <A> void update(long recid, A value, Serializer<A> serializer) {
getWrappedEngine().update(recid, value, serializer);
}
@Override
public <A> boolean compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) {
return getWrappedEngine().compareAndSwap(recid, expectedOldValue, newValue, serializer);
}
@Override
public <A> void delete(long recid, Serializer<A> serializer) {
getWrappedEngine().delete(recid, serializer);
}
@Override
public void close() {
Engine e = engine;
try{
if(e!=null)
e.close();
} finally {
engine = CLOSED;
}
}
@Override
public boolean isClosed() {
return engine==CLOSED || engine==null;
}
@Override
public void commit() {
getWrappedEngine().commit();
}
@Override
public void rollback() {
getWrappedEngine().rollback();
}
@Override
public boolean isReadOnly() {
return getWrappedEngine().isReadOnly();
}
@Override
public boolean canRollback() {
return getWrappedEngine().canRollback();
}
@Override
public boolean canSnapshot() {
return getWrappedEngine().canSnapshot();
}
@Override
public Engine snapshot() throws UnsupportedOperationException {
return getWrappedEngine().snapshot();
}
@Override
public void clearCache() {
getWrappedEngine().clearCache();
}
@Override
public void compact() {
getWrappedEngine().compact();
}
@Override
public SerializerPojo getSerializerPojo() {
return getWrappedEngine().getSerializerPojo();
}
@Override
public void closeListenerRegister(Runnable closeListener) {
getWrappedEngine().closeListenerRegister(closeListener);
}
@Override
public void closeListenerUnregister(Runnable closeListener) {
getWrappedEngine().closeListenerUnregister(closeListener);
}
public Engine getWrappedEngine(){
return checkClosed(engine);
}
protected static <V> V checkClosed(V v){
if(v==null) throw new IllegalAccessError("DB has been closed");
return v;
}
/**
* Wraps an <code>Engine</code> and throws
* <code>UnsupportedOperationException("Read-only")</code>
* on any modification attempt.
*/
public static class ReadOnlyEngine extends EngineWrapper {
public ReadOnlyEngine(Engine engine){
super(engine);
}
@Override
public long preallocate() {
throw new UnsupportedOperationException("Read-only");
}
@Override
public void preallocate(long[] recids){
throw new UnsupportedOperationException("Read-only");
}
@Override
public <A> boolean compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) {
throw new UnsupportedOperationException("Read-only");
}
@Override
public <A> long put(A value, Serializer<A> serializer) {
throw new UnsupportedOperationException("Read-only");
}
@Override
public <A> void update(long recid, A value, Serializer<A> serializer) {
throw new UnsupportedOperationException("Read-only");
}
@Override
public <A> void delete(long recid, Serializer<A> serializer){
throw new UnsupportedOperationException("Read-only");
}
@Override
public void commit() {
throw new UnsupportedOperationException("Read-only");
}
@Override
public void rollback() {
throw new UnsupportedOperationException("Read-only");
}
@Override
public boolean isReadOnly() {
return true;
}
@Override
public boolean canSnapshot() {
return true;
}
@Override
public Engine snapshot() throws UnsupportedOperationException {
return this;
}
}
/**
* check if Record Instances were not modified while in cache.
* Usuful to diagnose strange problems with Instance Cache.
*/
public static class ImmutabilityCheckEngine extends EngineWrapper{
protected static class Item {
final Serializer serializer;
final Object item;
final int oldChecksum;
public Item(Serializer serializer, Object item) {
if(item==null || serializer==null) throw new AssertionError("null");
this.serializer = serializer;
this.item = item;
oldChecksum = checksum();
if(oldChecksum!=checksum()) throw new AssertionError("inconsistent serialization");
}
private int checksum(){
try {
DataOutput2 out = new DataOutput2();
serializer.serialize(out, item);
byte[] bb = out.copyBytes();
return Arrays.hashCode(bb);
}catch(IOException e){
throw new IOError(e);
}
}
void check(){
int newChecksum = checksum();
if(oldChecksum!=newChecksum) throw new AssertionError("Record instance was modified: \n "+item+"\n "+serializer);
}
}
protected LongConcurrentHashMap<Item> items = new LongConcurrentHashMap<Item>();
protected ImmutabilityCheckEngine(Engine engine) {
super(engine);
}
@Override
public <A> A get(long recid, Serializer<A> serializer) {
Item item = items.get(recid);
if(item!=null) item.check();
A ret = super.get(recid, serializer);
if(ret!=null) items.put(recid, new Item(serializer,ret));
return ret;
}
@Override
public <A> long put(A value, Serializer<A> serializer) {
long ret = super.put(value, serializer);
if(value!=null) items.put(ret, new Item(serializer,value));
return ret;
}
@Override
public <A> void update(long recid, A value, Serializer<A> serializer) {
Item item = items.get(recid);
if(item!=null) item.check();
super.update(recid, value, serializer);
if(value!=null) items.put(recid, new Item(serializer,value));
}
@Override
public <A> boolean compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) {
Item item = items.get(recid);
if(item!=null) item.check();
boolean ret = super.compareAndSwap(recid, expectedOldValue, newValue, serializer);
if(ret && newValue!=null) items.put(recid, new Item(serializer,item));
return ret;
}
@Override
public void close() {
super.close();
for(Iterator<Item> iter = items.valuesIterator(); iter.hasNext();){
iter.next().check();
}
items.clear();
}
}
/** Engine wrapper with all methods synchronized on global lock, useful to diagnose concurrency issues.*/
public static class SynchronizedEngineWrapper extends EngineWrapper{
protected SynchronizedEngineWrapper(Engine engine) {
super(engine);
}
@Override
synchronized public long preallocate(){
return super.preallocate();
}
@Override
synchronized public void preallocate(long[] recids){
super.preallocate(recids);
}
@Override
synchronized public <A> long put(A value, Serializer<A> serializer) {
return super.put(value, serializer);
}
@Override
synchronized public <A> A get(long recid, Serializer<A> serializer) {
return super.get(recid, serializer);
}
@Override
synchronized public <A> void update(long recid, A value, Serializer<A> serializer) {
super.update(recid, value, serializer);
}
@Override
synchronized public <A> boolean compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) {
return super.compareAndSwap(recid, expectedOldValue, newValue, serializer);
}
@Override
synchronized public <A> void delete(long recid, Serializer<A> serializer) {
super.delete(recid, serializer);
}
@Override
synchronized public void close() {
super.close();
}
@Override
synchronized public boolean isClosed() {
return super.isClosed();
}
@Override
synchronized public void commit() {
super.commit();
}
@Override
synchronized public void rollback() {
super.rollback();
}
@Override
synchronized public boolean isReadOnly() {
return super.isReadOnly();
}
@Override
synchronized public boolean canSnapshot() {
return super.canSnapshot();
}
@Override
synchronized public Engine snapshot() throws UnsupportedOperationException {
return super.snapshot();
}
@Override
synchronized public void compact() {
super.compact();
}
}
/** Checks that Serializer used to serialize item is the same as Serializer used to deserialize it*/
public static class SerializerCheckEngineWrapper extends EngineWrapper{
protected LongMap<Serializer> recid2serializer = new LongConcurrentHashMap<Serializer>();
protected SerializerCheckEngineWrapper(Engine engine) {
super(engine);
}
synchronized protected <A> void checkSerializer(long recid, Serializer<A> serializer) {
Serializer other = recid2serializer.get(recid);
if(other!=null){
if( other!=serializer && other.getClass()!=serializer.getClass())
throw new IllegalArgumentException("Serializer does not match. \n found: "+serializer+" \n expected: "+other);
}else
recid2serializer.put(recid,serializer);
}
@Override
public <A> A get(long recid, Serializer<A> serializer) {
checkSerializer(recid, serializer);
return super.get(recid, serializer);
}
@Override
public <A> void update(long recid, A value, Serializer<A> serializer) {
checkSerializer(recid, serializer);
super.update(recid, value, serializer);
}
@Override
public <A> boolean compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) {
checkSerializer(recid, serializer);
return super.compareAndSwap(recid, expectedOldValue, newValue, serializer);
}
@Override
public <A> void delete(long recid, Serializer<A> serializer) {
checkSerializer(recid, serializer);
recid2serializer.remove(recid);
super.delete(recid, serializer);
}
}
/** throws `IllegalArgumentError("already closed)` on all access */
public static final Engine CLOSED = new Engine(){
@Override
public long preallocate() {
throw new IllegalAccessError("already closed");
}
@Override
public void preallocate(long[] recids) {
throw new IllegalAccessError("already closed");
}
@Override
public <A> long put(A value, Serializer<A> serializer) {
throw new IllegalAccessError("already closed");
}
@Override
public <A> A get(long recid, Serializer<A> serializer) {
throw new IllegalAccessError("already closed");
}
@Override
public <A> void update(long recid, A value, Serializer<A> serializer) {
throw new IllegalAccessError("already closed");
}
@Override
public <A> boolean compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) {
throw new IllegalAccessError("already closed");
}
@Override
public <A> void delete(long recid, Serializer<A> serializer) {
throw new IllegalAccessError("already closed");
}
@Override
public void close() {
throw new IllegalAccessError("already closed");
}
@Override
public boolean isClosed() {
return true;
}
@Override
public void commit() {
throw new IllegalAccessError("already closed");
}
@Override
public void rollback() throws UnsupportedOperationException {
throw new IllegalAccessError("already closed");
}
@Override
public boolean isReadOnly() {
throw new IllegalAccessError("already closed");
}
@Override
public boolean canRollback() {
throw new IllegalAccessError("already closed");
}
@Override
public boolean canSnapshot() {
throw new IllegalAccessError("already closed");
}
@Override
public Engine snapshot() throws UnsupportedOperationException {
throw new IllegalAccessError("already closed");
}
@Override
public void clearCache() {
throw new IllegalAccessError("already closed");
}
@Override
public void compact() {
throw new IllegalAccessError("already closed");
}
@Override
public SerializerPojo getSerializerPojo() {
throw new IllegalAccessError("already closed");
}
@Override
public void closeListenerRegister(Runnable closeListener) {
throw new IllegalAccessError("already closed");
}
@Override
public void closeListenerUnregister(Runnable closeListener) {
//this should be probably empty
}
};
/**
* Closes Engine on JVM shutdown using shutdown hook: {@link Runtime#addShutdownHook(Thread)}
* If engine was closed by user before JVM shutdown, hook is removed to save memory.
*/
public static class CloseOnJVMShutdown extends EngineWrapper{
final protected AtomicBoolean shutdownHappened = new AtomicBoolean(false);
final Runnable hookRunnable = new Runnable() {
@Override
public void run() {
shutdownHappened.set(true);
CloseOnJVMShutdown.this.hook = null;
if(CloseOnJVMShutdown.this.isClosed())
return;
CloseOnJVMShutdown.this.close();
}
};
Thread hook;
public CloseOnJVMShutdown(Engine engine) {
super(engine);
hook = new Thread(hookRunnable,"MapDB shutdown hook");
Runtime.getRuntime().addShutdownHook(hook);
}
@Override
public void close() {
super.close();
if(!shutdownHappened.get() && hook!=null){
Runtime.getRuntime().removeShutdownHook(hook);
}
hook = null;
}
}
}