-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
KernelTransactions.java
309 lines (286 loc) · 12.9 KB
/
KernelTransactions.java
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
/*
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.impl.api;
import java.time.Clock;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.function.Supplier;
import org.neo4j.collection.pool.LinkedQueuePool;
import org.neo4j.collection.pool.MarshlandPool;
import org.neo4j.function.Factory;
import org.neo4j.graphdb.DatabaseShutdownException;
import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.kernel.api.KernelTransaction;
import org.neo4j.kernel.api.KernelTransactionHandle;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.kernel.api.security.AccessMode;
import org.neo4j.kernel.api.txstate.LegacyIndexTransactionState;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.configuration.Settings;
import org.neo4j.kernel.impl.api.state.ConstraintIndexCreator;
import org.neo4j.kernel.impl.api.state.LegacyIndexTransactionStateImpl;
import org.neo4j.kernel.impl.index.IndexConfigStore;
import org.neo4j.kernel.impl.locking.StatementLocks;
import org.neo4j.kernel.impl.locking.StatementLocksFactory;
import org.neo4j.kernel.impl.proc.Procedures;
import org.neo4j.kernel.impl.store.TransactionId;
import org.neo4j.kernel.impl.transaction.TransactionHeaderInformationFactory;
import org.neo4j.kernel.impl.transaction.TransactionMonitor;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.kernel.lifecycle.LifecycleAdapter;
import org.neo4j.kernel.monitoring.tracing.Tracers;
import org.neo4j.storageengine.api.StorageEngine;
import static java.util.Collections.newSetFromMap;
import static java.util.stream.Collectors.toSet;
import static org.neo4j.kernel.configuration.Settings.setting;
/**
* Central source of transactions in the database.
* <p>
* This class maintains references to all transactions, a pool of passive kernel transactions, and provides
* capabilities
* for enumerating all running transactions. During normal operation, acquiring new transactions and enumerating live
* ones requires no synchronization (although the live list is not guaranteed to be exact).
*/
public class KernelTransactions extends LifecycleAdapter
implements Supplier<KernelTransactionsSnapshot> // For providing KernelTransactionSnapshots
{
public static final Setting<Boolean> tx_termination_aware_locks = setting(
"unsupported.dbms.tx_termination_aware_locks", Settings.BOOLEAN, Settings.FALSE );
// Transaction dependencies
private final StatementLocksFactory statementLocksFactory;
private final boolean txTerminationAwareLocks;
private final long statementTimeout;
private final ConstraintIndexCreator constraintIndexCreator;
private final StatementOperationParts statementOperations;
private final SchemaWriteGuard schemaWriteGuard;
private final TransactionHeaderInformationFactory transactionHeaderInformationFactory;
private final TransactionCommitProcess transactionCommitProcess;
private final TransactionHooks hooks;
private final TransactionMonitor transactionMonitor;
private final LifeSupport dataSourceLife;
private final Tracers tracers;
private final StorageEngine storageEngine;
private final Procedures procedures;
private final TransactionIdStore transactionIdStore;
private final Supplier<LegacyIndexTransactionState> legacyIndexTxStateSupplier;
private final Clock clock;
private final ReentrantReadWriteLock newTransactionsLock = new ReentrantReadWriteLock();
// End Tx Dependencies
/**
* Used to enumerate all transactions in the system, active and idle ones.
* <p>
* This data structure is *only* updated when brand-new transactions are created, or when transactions are disposed
* of. During normal operation (where all transactions come from and are returned to the pool), this will be left
* in peace, working solely as a collection of references to all transaction objects (idle and active) in the
* database.
* <p>
* As such, it provides a good mechanism for listing all transactions without requiring synchronization when
* starting and committing transactions.
*/
private final Set<KernelTransactionImplementation> allTransactions = newSetFromMap( new ConcurrentHashMap<>() );
public KernelTransactions( StatementLocksFactory statementLocksFactory,
ConstraintIndexCreator constraintIndexCreator,
StatementOperationParts statementOperations,
SchemaWriteGuard schemaWriteGuard,
TransactionHeaderInformationFactory txHeaderFactory,
TransactionCommitProcess transactionCommitProcess,
IndexConfigStore indexConfigStore,
LegacyIndexProviderLookup legacyIndexProviderLookup,
TransactionHooks hooks,
TransactionMonitor transactionMonitor,
LifeSupport dataSourceLife,
Tracers tracers,
StorageEngine storageEngine,
Procedures procedures,
TransactionIdStore transactionIdStore,
Config config,
Clock clock )
{
this.statementLocksFactory = statementLocksFactory;
this.txTerminationAwareLocks = config.get( tx_termination_aware_locks );
this.statementTimeout = config.get( GraphDatabaseSettings.statement_timeout );
this.constraintIndexCreator = constraintIndexCreator;
this.statementOperations = statementOperations;
this.schemaWriteGuard = schemaWriteGuard;
this.transactionHeaderInformationFactory = txHeaderFactory;
this.transactionCommitProcess = transactionCommitProcess;
this.hooks = hooks;
this.transactionMonitor = transactionMonitor;
this.dataSourceLife = dataSourceLife;
this.tracers = tracers;
this.storageEngine = storageEngine;
this.procedures = procedures;
this.transactionIdStore = transactionIdStore;
this.legacyIndexTxStateSupplier = () -> new CachingLegacyIndexTransactionState(
new LegacyIndexTransactionStateImpl( indexConfigStore, legacyIndexProviderLookup ) );
this.clock = clock;
}
/**
* This is the factory that actually builds brand-new instances.
*/
private final Factory<KernelTransactionImplementation> factory = new Factory<KernelTransactionImplementation>()
{
@Override
public KernelTransactionImplementation newInstance()
{
KernelTransactionImplementation tx = new KernelTransactionImplementation(
statementOperations, schemaWriteGuard, hooks, constraintIndexCreator, procedures,
transactionHeaderInformationFactory, transactionCommitProcess, transactionMonitor,
legacyIndexTxStateSupplier, localTxPool, clock, tracers.transactionTracer,
storageEngine, txTerminationAwareLocks, statementTimeout );
allTransactions.add( tx );
return tx;
}
};
public KernelTransaction newInstance( KernelTransaction.Type type, AccessMode accessMode, long timeout )
{
assertCurrentThreadIsNotBlockingNewTransactions();
newTransactionsLock.readLock().lock();
try
{
assertDatabaseIsRunning();
TransactionId lastCommittedTransaction = transactionIdStore.getLastCommittedTransaction();
KernelTransactionImplementation tx = localTxPool.acquire();
StatementLocks statementLocks = statementLocksFactory.newInstance();
tx.initialize( lastCommittedTransaction.transactionId(),
lastCommittedTransaction.commitTimestamp(), statementLocks, type, accessMode, timeout );
return tx;
}
finally
{
newTransactionsLock.readLock().unlock();
}
}
/**
* Global pool of transactions, wrapped by the thread-local marshland pool and so is not used directly.
*/
private final LinkedQueuePool<KernelTransactionImplementation> globalTxPool
= new LinkedQueuePool<KernelTransactionImplementation>( 8, factory )
{
@Override
protected void dispose( KernelTransactionImplementation tx )
{
allTransactions.remove( tx );
tx.dispose();
super.dispose( tx );
}
};
/**
* Give an approximate set of all transactions currently running.
* This is not guaranteed to be exact, as transactions may stop and start while this set is gathered.
*
* @return the set of open transactions.
*/
public Set<KernelTransactionHandle> activeTransactions()
{
return allTransactions.stream()
.map( this::createHandle )
.filter( KernelTransactionHandle::isOpen )
.collect( toSet() );
}
/**
* Create new handle for the given transaction.
* <p>
* <b>Note:</b> this method is package-private for testing <b>only</b>.
*
* @param tx transaction to wrap.
* @return transaction handle.
*/
KernelTransactionHandle createHandle( KernelTransactionImplementation tx )
{
return new KernelTransactionImplementationHandle( tx );
}
/**
* Pool of unused transactions.
*/
private final MarshlandPool<KernelTransactionImplementation> localTxPool = new MarshlandPool<>( globalTxPool );
/**
* Dispose of all pooled transactions. This is done on shutdown or on internal events (like an HA mode switch) that
* require transactions to be re-created.
*/
public void disposeAll()
{
for ( KernelTransactionImplementation tx : allTransactions )
{
// we mark all transactions for termination since we want to make sure these transactions
// won't be reused, ever. Each transaction has, among other things, a Locks.Client and we
// certainly want to keep that from being reused from this point.
tx.markForTermination( Status.General.DatabaseUnavailable );
}
localTxPool.disposeAll();
globalTxPool.disposeAll();
}
@Override
public void shutdown() throws Throwable
{
disposeAll();
}
private void assertDatabaseIsRunning()
{
// TODO: Copied over from original source in NeoXADS - this should probably use DBAvailability,
// rather than this.
// Note, if you change this, you need a separate mechanism to stop transactions from being started during
// Kernel#stop().
if ( !dataSourceLife.isRunning() )
{
throw new DatabaseShutdownException();
}
}
@Override
public KernelTransactionsSnapshot get()
{
return new KernelTransactionsSnapshot( activeTransactions(), clock.millis() );
}
/**
* Do not allow new transactions to start until {@link #unblockNewTransactions()} is called. Current thread have
* responsibility of doing so.
* <p>
* Blocking call.
*/
public void blockNewTransactions()
{
newTransactionsLock.writeLock().lock();
}
/**
* Allow new transactions to be started again if current thread is the one who called
* {@link #blockNewTransactions()}.
*
* @throws IllegalStateException if current thread is not the one that called {@link #blockNewTransactions()}.
*/
public void unblockNewTransactions()
{
if ( !newTransactionsLock.writeLock().isHeldByCurrentThread() )
{
throw new IllegalStateException( "This thread did not block transactions previously" );
}
newTransactionsLock.writeLock().unlock();
}
private void assertCurrentThreadIsNotBlockingNewTransactions()
{
if ( newTransactionsLock.isWriteLockedByCurrentThread() )
{
throw new IllegalStateException(
"Thread that is blocking new transactions from starting can't start new transaction" );
}
}
}