-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
TransportWriteThrottle.java
157 lines (138 loc) · 5.49 KB
/
TransportWriteThrottle.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
/*
* Copyright (c) 2002-2018 "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.bolt.transport;
import io.netty.channel.Channel;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandler;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.channel.WriteBufferWaterMark;
import io.netty.util.AttributeKey;
import org.apache.commons.lang3.time.DurationFormatUtils;
import java.time.Clock;
import java.time.Duration;
import java.util.function.Supplier;
/**
* Throttle that blocks write operations to the channel based on channel's isWritable
* property. Buffer sizes based on which the channel will change its isWritable property
* and whether to apply this throttle are configurable through GraphDatabaseSettings.
*/
public class TransportWriteThrottle implements TransportThrottle
{
static final AttributeKey<ThrottleLock> LOCK_KEY = AttributeKey.valueOf( "BOLT.WRITE_THROTTLE.LOCK" );
static final AttributeKey<Boolean> MAX_DURATION_EXCEEDED_KEY = AttributeKey.valueOf( "BOLT.WRITE_THROTTLE.MAX_DURATION_EXCEEDED" );
private final int lowWaterMark;
private final int highWaterMark;
private final Clock clock;
private final long maxLockDuration;
private final Supplier<ThrottleLock> lockSupplier;
private final ChannelInboundHandler listener;
public TransportWriteThrottle( int lowWaterMark, int highWaterMark, Clock clock, Duration maxLockDuration )
{
this( lowWaterMark, highWaterMark, clock, maxLockDuration, () -> new DefaultThrottleLock() );
}
public TransportWriteThrottle( int lowWaterMark, int highWaterMark, Clock clock, Duration maxLockDuration, Supplier<ThrottleLock> lockSupplier )
{
this.lowWaterMark = lowWaterMark;
this.highWaterMark = highWaterMark;
this.clock = clock;
this.maxLockDuration = maxLockDuration.toMillis();
this.lockSupplier = lockSupplier;
this.listener = new ChannelStatusListener();
}
@Override
public void install( Channel channel )
{
ThrottleLock lock = lockSupplier.get();
channel.attr( LOCK_KEY ).set( lock );
channel.config().setWriteBufferWaterMark( new WriteBufferWaterMark( lowWaterMark, highWaterMark ) );
channel.pipeline().addLast( listener );
}
@Override
public void acquire( Channel channel ) throws TransportThrottleException
{
if ( !isDurationAlreadyExceeded( channel ) )
{
ThrottleLock lock = channel.attr( LOCK_KEY ).get();
long startTimeMillis = 0;
while ( channel.isOpen() && !channel.isWritable() )
{
if ( maxLockDuration > 0 )
{
long currentTimeMillis = clock.millis();
if ( startTimeMillis == 0 )
{
startTimeMillis = currentTimeMillis;
}
else
{
if ( currentTimeMillis - startTimeMillis > maxLockDuration )
{
setDurationExceeded( channel );
throw new TransportThrottleException( String.format(
"Bolt connection [%s] will be closed because the client did not consume outgoing buffers for %s which is not expected.",
channel.remoteAddress(), DurationFormatUtils.formatDurationHMS( maxLockDuration ) ) );
}
}
}
try
{
lock.lock( channel, 1000 );
}
catch ( InterruptedException ex )
{
Thread.currentThread().interrupt();
}
}
}
}
@Override
public void release( Channel channel )
{
if ( channel.isWritable() )
{
ThrottleLock lock = channel.attr( LOCK_KEY ).get();
lock.unlock( channel );
}
}
@Override
public void uninstall( Channel channel )
{
channel.attr( LOCK_KEY ).set( null );
}
private static boolean isDurationAlreadyExceeded( Channel channel )
{
Boolean marker = channel.attr( MAX_DURATION_EXCEEDED_KEY ).get();
return marker != null && marker.booleanValue();
}
private static void setDurationExceeded( Channel channel )
{
channel.attr( MAX_DURATION_EXCEEDED_KEY ).set( Boolean.TRUE );
}
@ChannelHandler.Sharable
private class ChannelStatusListener extends ChannelInboundHandlerAdapter
{
@Override
public void channelWritabilityChanged( ChannelHandlerContext ctx ) throws Exception
{
release( ctx.channel() );
}
}
}