Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Save recursive locks on websocket writeFrame #5348

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions src/main/java/io/vertx/core/http/impl/ServerWebSocketImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.Promise;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.core.*;
import io.vertx.core.http.ServerWebSocket;
import io.vertx.core.http.WebSocketFrame;
import io.vertx.core.http.impl.ws.WebSocketFrameImpl;
import io.vertx.core.impl.ContextInternal;
import io.vertx.core.net.HostAndPort;
import io.vertx.core.spi.metrics.HttpServerMetrics;

import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;

import static io.netty.handler.codec.http.HttpResponseStatus.*;
import static io.vertx.core.http.impl.HttpUtils.*;
import static io.vertx.core.spi.metrics.Metrics.*;
Expand All @@ -44,6 +45,8 @@
*/
public class ServerWebSocketImpl extends WebSocketImplBase<ServerWebSocketImpl> implements ServerWebSocket {

private static final AtomicReferenceFieldUpdater<ServerWebSocketImpl, Integer> STATUS_UPDATER =
AtomicReferenceFieldUpdater.newUpdater(ServerWebSocketImpl.class, Integer.class, "status");
private final Http1xServerConnection conn;
private final long closingTimeoutMS;
private final String scheme;
Expand All @@ -54,7 +57,7 @@ public class ServerWebSocketImpl extends WebSocketImplBase<ServerWebSocketImpl>
private final String query;
private final WebSocketServerHandshaker handshaker;
private Http1xServerRequest request;
private Integer status;
private volatile Integer status;
private Promise<Integer> handshakePromise;

ServerWebSocketImpl(ContextInternal context,
Expand Down Expand Up @@ -158,28 +161,26 @@ public Future<Void> close(short statusCode, String reason) {
@Override
public Future<Void> writeFrame(WebSocketFrame frame) {
synchronized (conn) {
Boolean check = checkAccept();
// if lucky, tryHandshake will return true without any need of synchronization lock on connection
final Boolean check = tryHandshake(SC_SWITCHING_PROTOCOLS);
if (check == null) {
throw new IllegalStateException("Cannot write to WebSocket, it is pending accept or reject");
}
if (!check) {
throw new IllegalStateException("Cannot write to WebSocket, it has been rejected");
}
return super.writeFrame(frame);
// this is not going through super.writeFrame as we want to avoid synchronizing against the connection
return super.unsafeWriteFrame((WebSocketFrameImpl) frame);
}
}

private Boolean checkAccept() {
return tryHandshake(SC_SWITCHING_PROTOCOLS);
}

private void handleHandshake(int sc) {
synchronized (conn) {
if (status == null) {
if (sc == SC_SWITCHING_PROTOCOLS) {
doHandshake();
} else {
status = sc;
STATUS_UPDATER.lazySet(this, sc);
HttpUtils.sendError(conn.channel(), HttpResponseStatus.valueOf(sc));
}
}
Expand All @@ -198,7 +199,7 @@ private void doHandshake() {
request = null;
}
response.completeHandshake();
status = SWITCHING_PROTOCOLS.code();
STATUS_UPDATER.lazySet(this, SWITCHING_PROTOCOLS.code());
subProtocol(handshaker.selectedSubprotocol());
// remove compressor as its not needed anymore once connection was upgraded to websockets
ChannelPipeline pipeline = channel.pipeline();
Expand All @@ -210,9 +211,19 @@ private void doHandshake() {
}

Boolean tryHandshake(int sc) {
Integer status = this.status;
if (status != null) {
return status == sc;
}
synchronized (conn) {
if (status == null && handshakePromise == null) {
assert status == null;
status = this.status;
if (status != null) {
return status == sc;
}
if (handshakePromise == null) {
setHandshake(Future.succeededFuture(sc));
status = this.status;
}
return status == null ? null : status == sc;
}
Expand Down
26 changes: 18 additions & 8 deletions src/main/java/io/vertx/core/http/impl/WebSocketImplBase.java
Original file line number Diff line number Diff line change
Expand Up @@ -399,13 +399,18 @@ private Future<Void> writePartialMessage(WebSocketFrameType frameType, Buffer da
@Override
public Future<Void> writeFrame(WebSocketFrame frame) {
synchronized (conn) {
if (isClosed()) {
return context.failedFuture("WebSocket is closed");
}
PromiseInternal<Void> promise = context.promise();
conn.writeToChannel(encodeFrame((WebSocketFrameImpl) frame), promise);
return promise.future();
return unsafeWriteFrame((WebSocketFrameImpl) frame);
}
}

protected final Future<Void> unsafeWriteFrame(WebSocketFrameImpl frame) {
assert Thread.holdsLock(conn);
if (unsafeIsClosed()) {
return context.failedFuture("WebSocket is closed");
}
PromiseInternal<Void> promise = context.promise();
conn.writeToChannel(encodeFrame(frame), promise);
return promise.future();
}

public final S writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler) {
Expand All @@ -424,7 +429,7 @@ private void writeTextFrameInternal(String str) {
writeFrame(new WebSocketFrameImpl(str));
}

private io.netty.handler.codec.http.websocketx.WebSocketFrame encodeFrame(WebSocketFrameImpl frame) {
private static io.netty.handler.codec.http.websocketx.WebSocketFrame encodeFrame(WebSocketFrameImpl frame) {
ByteBuf buf = safeBuffer(frame.getBinaryData());
switch (frame.type()) {
case BINARY:
Expand Down Expand Up @@ -452,10 +457,15 @@ void checkClosed() {

public boolean isClosed() {
synchronized (conn) {
return closed || closeStatusCode != null;
return unsafeIsClosed();
}
}

private boolean unsafeIsClosed() {
assert Thread.holdsLock(conn);
return closed || closeStatusCode != null;
}

void handleFrame(WebSocketFrameInternal frame) {
switch (frame.type()) {
case PING:
Expand Down
Loading