-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
DefaultBoltConnection.java
364 lines (320 loc) · 10.7 KB
/
DefaultBoltConnection.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
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
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.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.bolt.runtime;
import io.netty.channel.Channel;
import org.apache.commons.lang3.exception.ExceptionUtils;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.atomic.AtomicBoolean;
import org.neo4j.bolt.BoltChannel;
import org.neo4j.bolt.BoltServer;
import org.neo4j.bolt.v1.packstream.PackOutput;
import org.neo4j.bolt.v1.runtime.BoltConnectionAuthFatality;
import org.neo4j.bolt.v1.runtime.BoltProtocolBreachFatality;
import org.neo4j.bolt.v1.runtime.BoltStateMachine;
import org.neo4j.bolt.v1.runtime.Job;
import org.neo4j.bolt.v1.runtime.Neo4jError;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.kernel.impl.logging.LogService;
import org.neo4j.logging.Log;
import org.neo4j.util.FeatureToggles;
import static java.util.concurrent.TimeUnit.SECONDS;
public class DefaultBoltConnection implements BoltConnection
{
protected static final int DEFAULT_MAX_BATCH_SIZE = FeatureToggles.getInteger( BoltServer.class, "max_batch_size", 100 );
private final String id;
private final BoltChannel channel;
private final BoltStateMachine machine;
private final BoltConnectionLifetimeListener listener;
private final BoltConnectionQueueMonitor queueMonitor;
private final PackOutput output;
private final Log log;
private final Log userLog;
private final int maxBatchSize;
private final List<Job> batch;
private final LinkedBlockingQueue<Job> queue = new LinkedBlockingQueue<>();
private final AtomicBoolean shouldClose = new AtomicBoolean();
private final AtomicBoolean closed = new AtomicBoolean();
public DefaultBoltConnection( BoltChannel channel, PackOutput output, BoltStateMachine machine, LogService logService,
BoltConnectionLifetimeListener listener,
BoltConnectionQueueMonitor queueMonitor )
{
this( channel, output, machine, logService, listener, queueMonitor, DEFAULT_MAX_BATCH_SIZE );
}
public DefaultBoltConnection( BoltChannel channel, PackOutput output, BoltStateMachine machine, LogService logService,
BoltConnectionLifetimeListener listener,
BoltConnectionQueueMonitor queueMonitor, int maxBatchSize )
{
this.id = channel.id();
this.channel = channel;
this.output = output;
this.machine = machine;
this.listener = listener;
this.queueMonitor = queueMonitor;
this.log = logService.getInternalLog( getClass() );
this.userLog = logService.getUserLog( getClass() );
this.maxBatchSize = maxBatchSize;
this.batch = new ArrayList<>( maxBatchSize );
}
@Override
public String id()
{
return id;
}
@Override
public SocketAddress localAddress()
{
return channel.serverAddress();
}
@Override
public SocketAddress remoteAddress()
{
return channel.clientAddress();
}
@Override
public Channel channel()
{
return channel.rawChannel();
}
@Override
public PackOutput output()
{
return output;
}
@Override
public boolean hasPendingJobs()
{
return !queue.isEmpty();
}
@Override
public void start()
{
notifyCreated();
}
@Override
public void enqueue( Job job )
{
enqueueInternal( job );
}
@Override
public boolean processNextBatch()
{
return processNextBatch( maxBatchSize, false );
}
protected boolean processNextBatch( int batchCount, boolean exitIfNoJobsAvailable )
{
try
{
boolean waitForMessage = false;
boolean loop = false;
do
{
// exit loop if we'll close the connection
if ( willClose() )
{
break;
}
// do we have pending jobs or shall we wait for new jobs to
// arrive, which is required only for releasing stickiness
// condition to this thread
if ( waitForMessage || !queue.isEmpty() )
{
queue.drainTo( batch, batchCount );
// if we expect one message but did not get any (because it was already
// processed), silently exit
if ( batch.size() == 0 && !exitIfNoJobsAvailable )
{
// loop until we get a new job, if we cannot then validate
// transaction to check for termination condition. We'll
// break loop if we'll close the connection
while ( !willClose() )
{
Job nextJob = queue.poll( 10, SECONDS );
if ( nextJob != null )
{
batch.add( nextJob );
break;
}
else
{
machine.validateTransaction();
}
}
}
notifyDrained( batch );
// execute each job that's in the batch
while ( batch.size() > 0 )
{
Job current = batch.remove( 0 );
current.perform( machine );
}
// do we have any condition that require this connection to
// stick to the current thread (i.e. is there an open statement
// or an open transaction)?
loop = machine.shouldStickOnThread();
waitForMessage = loop;
}
// we processed all pending messages, let's flush underlying channel
if ( queue.size() == 0 || maxBatchSize == 1 )
{
output.flush();
}
}
while ( loop );
// assert only if we'll stay alive
if ( !willClose() )
{
assert !machine.hasOpenStatement();
}
}
catch ( BoltConnectionAuthFatality ex )
{
// do not log
shouldClose.set( true );
}
catch ( BoltProtocolBreachFatality ex )
{
shouldClose.set( true );
log.error( String.format( "Protocol breach detected in bolt session '%s'.", id() ), ex );
}
catch ( InterruptedException ex )
{
shouldClose.set( true );
log.info( "Bolt session '%s' is interrupted probably due to server shutdown.", id() );
}
catch ( Throwable t )
{
shouldClose.set( true );
userLog.error( String.format( "Unexpected error detected in bolt session '%s'.", id() ), t );
}
finally
{
if ( willClose() )
{
close();
}
}
return !closed.get();
}
@Override
public void handleSchedulingError( Throwable t )
{
String message;
Neo4jError error;
if ( ExceptionUtils.hasCause( t, RejectedExecutionException.class ) )
{
error = Neo4jError.from( Status.Request.NoThreadsAvailable, Status.Request.NoThreadsAvailable.code().description() );
message = String.format( "Unable to schedule bolt session '%s' for execution since there are no available threads to " +
"serve it at the moment. You can retry at a later time or consider increasing max thread pool size for bolt connector(s).", id() );
}
else
{
error = Neo4jError.fatalFrom( t );
message = String.format( "Unexpected error during scheduling of bolt session '%s'.", id() );
}
log.error( message, t );
userLog.error( message );
machine.markFailed( error );
processNextBatch( 1, true );
}
@Override
public void interrupt()
{
machine.interrupt();
}
@Override
public void stop()
{
if ( shouldClose.compareAndSet( false, true ) )
{
machine.terminate();
// Enqueue an empty job for close to be handled linearly
enqueueInternal( ignore ->
{
} );
}
}
private boolean willClose()
{
return shouldClose.get();
}
private void close()
{
if ( closed.compareAndSet( false, true ) )
{
try
{
output.close();
}
catch ( Throwable t )
{
log.error( String.format( "Unable to close pack output of bolt session '%s'.", id() ), t );
}
try
{
machine.close();
}
catch ( Throwable t )
{
log.error( String.format( "Unable to close state machine of bolt session '%s'.", id() ), t );
}
finally
{
notifyDestroyed();
}
}
}
private void enqueueInternal( Job job )
{
queue.offer( job );
notifyEnqueued( job );
}
private void notifyCreated()
{
if ( listener != null )
{
listener.created( this );
}
}
private void notifyDestroyed()
{
if ( listener != null )
{
listener.closed( this );
}
}
private void notifyEnqueued( Job job )
{
if ( queueMonitor != null )
{
queueMonitor.enqueued( this, job );
}
}
private void notifyDrained( List<Job> jobs )
{
if ( queueMonitor != null && jobs.size() > 0 )
{
queueMonitor.drained( this, jobs );
}
}
}