-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
LogTailScanner.java
287 lines (256 loc) · 12.2 KB
/
LogTailScanner.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
/*
* Copyright (c) 2002-2017 "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.transaction.log;
import java.io.IOException;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.kernel.impl.transaction.log.entry.CheckPoint;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntry;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryCommit;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryReader;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryStart;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryVersion;
import static org.neo4j.kernel.impl.transaction.log.LogVersionBridge.NO_MORE_CHANNELS;
import static org.neo4j.kernel.impl.transaction.log.LogVersionRepository.INITIAL_LOG_VERSION;
/**
* This class collects information about the latest entries in the transaction log. Since the only way we have to collect
* said information is to scan the transaction log from beginning to end, which is costly, we do this once and save the
* result for others to consume.
* <p>
* Due to the nature of transaction logs and log rotation, a single transaction log file has to be scanned forward, and
* if the required data is not found we search backwards through log file versions.
*/
public class LogTailScanner
{
private final PhysicalLogFiles logFiles;
private final FileSystemAbstraction fileSystem;
private final LogEntryReader<ReadableClosablePositionAwareChannel> logEntryReader;
public LogTailScanner( PhysicalLogFiles logFiles, FileSystemAbstraction fileSystem,
LogEntryReader<ReadableClosablePositionAwareChannel> logEntryReader )
{
this.logFiles = logFiles;
this.fileSystem = fileSystem;
this.logEntryReader = logEntryReader;
}
public LogTailInformation find( long fromVersionBackwards ) throws IOException
{
long version = fromVersionBackwards;
long versionToSearchForCommits = fromVersionBackwards;
LogEntryStart latestStartEntry = null;
LogEntryStart oldestStartEntry = null;
long oldestVersionFound = -1;
LogEntryVersion latestLogEntryVersion = null;
while ( version >= INITIAL_LOG_VERSION )
{
LogVersionedStoreChannel channel =
PhysicalLogFile.tryOpenForVersion( logFiles, fileSystem, version, false );
if ( channel == null )
{
break;
}
oldestVersionFound = version;
CheckPoint latestCheckPoint = null;
ReadableLogChannel recoveredDataChannel =
new ReadAheadLogChannel( channel, NO_MORE_CHANNELS );
boolean firstStartEntry = true;
try ( LogEntryCursor cursor = new LogEntryCursor( logEntryReader, recoveredDataChannel ) )
{
LogEntry entry;
while ( cursor.next() )
{
entry = cursor.get();
// Collect data about latest checkpoint
if ( entry instanceof CheckPoint )
{
latestCheckPoint = entry.as();
}
// Collect data about latest commits
if ( entry instanceof LogEntryStart )
{
LogEntryStart startEntry = entry.as();
if ( version == versionToSearchForCommits )
{
latestStartEntry = startEntry;
}
// The scan goes backwards by log version, although forward per log version
// Oldest start entry will be the first in the last log version scanned.
if ( firstStartEntry )
{
oldestStartEntry = startEntry;
firstStartEntry = false;
}
}
// Collect data about latest entry version
if ( latestLogEntryVersion == null || version == versionToSearchForCommits )
{
latestLogEntryVersion = entry.getVersion();
}
}
}
if ( latestCheckPoint != null )
{
return latestCheckPoint( fromVersionBackwards, version, latestStartEntry, oldestVersionFound,
latestCheckPoint, latestLogEntryVersion );
}
version--;
// if we have found no commits in the latest log, keep searching in the next one
if ( latestStartEntry == null )
{
versionToSearchForCommits--;
}
}
boolean commitsAfterCheckPoint = oldestStartEntry != null;
long firstTxAfterPosition = commitsAfterCheckPoint
? extractFirstTxIdAfterPosition( oldestStartEntry.getStartPosition(), fromVersionBackwards )
: LogTailInformation.NO_TRANSACTION_ID;
return new LogTailInformation( null, commitsAfterCheckPoint, firstTxAfterPosition, oldestVersionFound,
latestLogEntryVersion );
}
protected LogTailInformation latestCheckPoint( long fromVersionBackwards, long version,
LogEntryStart latestStartEntry, long oldestVersionFound, CheckPoint latestCheckPoint,
LogEntryVersion latestLogEntryVersion ) throws IOException
{
// Is the latest start entry in this log file version later than what the latest check point targets?
LogPosition target = latestCheckPoint.getLogPosition();
boolean startEntryAfterCheckPoint = latestStartEntry != null &&
latestStartEntry.getStartPosition().compareTo( target ) >= 0;
if ( !startEntryAfterCheckPoint )
{
if ( target.getLogVersion() < version )
{
// This check point entry targets a previous log file.
// Go there and see if there's a transaction. Reader is capped to that log version.
startEntryAfterCheckPoint = extractFirstTxIdAfterPosition( target, version ) !=
LogTailInformation.NO_TRANSACTION_ID;
}
}
// Extract first transaction id after check point target position.
// Reader may continue into log files after the initial version.
long firstTxIdAfterCheckPoint = startEntryAfterCheckPoint
? extractFirstTxIdAfterPosition( target, fromVersionBackwards )
: LogTailInformation.NO_TRANSACTION_ID;
return new LogTailInformation( latestCheckPoint, startEntryAfterCheckPoint,
firstTxIdAfterCheckPoint, oldestVersionFound, latestLogEntryVersion );
}
/**
* Extracts txId from first commit entry, when starting reading at the given {@code position}.
* If no commit entry found in the version, the reader will continue into next version(s) up till
* {@code maxLogVersion} until finding one.
*
* @param initialPosition {@link LogPosition} to start scan from.
* @param maxLogVersion max log version to scan.
* @return txId of closes commit entry to {@code initialPosition}, or {@link LogTailInformation#NO_TRANSACTION_ID}
* if not found.
* @throws IOException on I/O error.
*/
protected long extractFirstTxIdAfterPosition( LogPosition initialPosition, long maxLogVersion ) throws IOException
{
LogPosition currentPosition = initialPosition;
while ( currentPosition.getLogVersion() <= maxLogVersion )
{
LogVersionedStoreChannel storeChannel = PhysicalLogFile.tryOpenForVersion( logFiles, fileSystem,
currentPosition.getLogVersion(), false );
if ( storeChannel != null )
{
try
{
storeChannel.position( currentPosition.getByteOffset() );
try ( ReadAheadLogChannel logChannel = new ReadAheadLogChannel( storeChannel, NO_MORE_CHANNELS );
LogEntryCursor cursor = new LogEntryCursor( logEntryReader, logChannel ) )
{
while ( cursor.next() )
{
LogEntry entry = cursor.get();
if ( entry instanceof LogEntryCommit )
{
return ((LogEntryCommit) entry).getTxId();
}
}
}
}
finally
{
storeChannel.close();
}
}
currentPosition = LogPosition.start( currentPosition.getLogVersion() + 1 );
}
return LogTailInformation.NO_TRANSACTION_ID;
}
public static class LogTailInformation
{
public static long NO_TRANSACTION_ID = -1;
public final CheckPoint lastCheckPoint;
public final boolean commitsAfterLastCheckPoint;
public final long firstTxIdAfterLastCheckPoint;
public final long oldestLogVersionFound;
public final LogEntryVersion latestLogEntryVersion;
public LogTailInformation( CheckPoint lastCheckPoint, boolean commitsAfterLastCheckPoint,
long firstTxIdAfterLastCheckPoint, long oldestLogVersionFound, LogEntryVersion latestLogEntryVersion )
{
this.lastCheckPoint = lastCheckPoint;
this.commitsAfterLastCheckPoint = commitsAfterLastCheckPoint;
this.firstTxIdAfterLastCheckPoint = firstTxIdAfterLastCheckPoint;
this.oldestLogVersionFound = oldestLogVersionFound;
this.latestLogEntryVersion = latestLogEntryVersion;
}
@Override
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( o == null || getClass() != o.getClass() )
{
return false;
}
LogTailInformation that = (LogTailInformation) o;
return commitsAfterLastCheckPoint == that.commitsAfterLastCheckPoint &&
firstTxIdAfterLastCheckPoint == that.firstTxIdAfterLastCheckPoint &&
oldestLogVersionFound == that.oldestLogVersionFound &&
(lastCheckPoint == null ? that.lastCheckPoint == null : lastCheckPoint
.equals( that.lastCheckPoint )) &&
latestLogEntryVersion.equals( that.latestLogEntryVersion );
}
@Override
public int hashCode()
{
int result = lastCheckPoint != null ? lastCheckPoint.hashCode() : 0;
result = 31 * result + (commitsAfterLastCheckPoint ? 1 : 0);
if ( commitsAfterLastCheckPoint )
{
result = 31 * result + Long.hashCode( firstTxIdAfterLastCheckPoint );
}
result = 31 * result + Long.hashCode( oldestLogVersionFound );
result = 31 * result + latestLogEntryVersion.hashCode();
return result;
}
@Override
public String toString()
{
return "LogTailInformation{" +
"lastCheckPoint=" + lastCheckPoint +
", commitsAfterLastCheckPoint=" + commitsAfterLastCheckPoint +
(commitsAfterLastCheckPoint ? ", firstTxIdAfterLastCheckPoint=" + firstTxIdAfterLastCheckPoint : "") +
", oldestLogVersionFound=" + oldestLogVersionFound +
'}';
}
}
}