From 236dce4925a22153e5ac765d5f3283653497e414 Mon Sep 17 00:00:00 2001 From: Aikar Date: Tue, 27 Nov 2018 21:18:06 -0500 Subject: [PATCH] Handle Large Packets disconnecting client If a players inventory is too big to send in a single packet, split the inventory set into multiple packets instead. --- .../minecraft/network/Connection.java.patch | 51 ++++++++++++++----- .../network/PacketEncoder.java.patch | 35 ++++++++++++- .../network/protocol/Packet.java.patch | 22 ++++++++ ...tboundContainerSetContentPacket.java.patch | 24 +++++++++ ...ClientboundLevelChunkPacketData.java.patch | 9 ++++ 5 files changed, 126 insertions(+), 15 deletions(-) create mode 100644 paper-server/patches/sources/net/minecraft/network/protocol/Packet.java.patch create mode 100644 paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundContainerSetContentPacket.java.patch diff --git a/paper-server/patches/sources/net/minecraft/network/Connection.java.patch b/paper-server/patches/sources/net/minecraft/network/Connection.java.patch index c7d8a673c6..bc949c4d4e 100644 --- a/paper-server/patches/sources/net/minecraft/network/Connection.java.patch +++ b/paper-server/patches/sources/net/minecraft/network/Connection.java.patch @@ -81,7 +81,29 @@ if (this.delayedDisconnect != null) { this.disconnect(this.delayedDisconnect); } -@@ -141,8 +183,10 @@ +@@ -134,6 +176,21 @@ + } + + public void exceptionCaught(ChannelHandlerContext channelhandlercontext, Throwable throwable) { ++ // Paper start - Handle large packets disconnecting client ++ if (throwable instanceof io.netty.handler.codec.EncoderException && throwable.getCause() instanceof PacketEncoder.PacketTooLargeException packetTooLargeException) { ++ final Packet packet = packetTooLargeException.getPacket(); ++ if (packet.packetTooLarge(this)) { ++ ProtocolSwapHandler.handleOutboundTerminalPacket(channelhandlercontext, packet); ++ return; ++ } else if (packet.isSkippable()) { ++ Connection.LOGGER.debug("Skipping packet due to errors", throwable.getCause()); ++ ProtocolSwapHandler.handleOutboundTerminalPacket(channelhandlercontext, packet); ++ return; ++ } else { ++ throwable = throwable.getCause(); ++ } ++ } ++ // Paper end - Handle large packets disconnecting client + if (throwable instanceof SkipPacketException) { + Connection.LOGGER.debug("Skipping packet due to errors", throwable.getCause()); + } else { +@@ -141,8 +198,10 @@ this.handlingFault = true; if (this.channel.isOpen()) { @@ -92,7 +114,7 @@ this.disconnect((Component) Component.translatable("disconnect.timeout")); } else { MutableComponent ichatmutablecomponent = Component.translatable("disconnect.genericReason", "Internal Exception: " + String.valueOf(throwable)); -@@ -155,6 +199,7 @@ +@@ -155,6 +214,7 @@ disconnectiondetails = new DisconnectionDetails(ichatmutablecomponent); } @@ -100,7 +122,7 @@ if (flag) { Connection.LOGGER.debug("Failed to sent packet", throwable); if (this.getSending() == PacketFlow.CLIENTBOUND) { -@@ -176,6 +221,7 @@ +@@ -176,6 +236,7 @@ } } @@ -108,7 +130,7 @@ } protected void channelRead0(ChannelHandlerContext channelhandlercontext, Packet packet) { -@@ -185,11 +231,61 @@ +@@ -185,11 +246,61 @@ if (packetlistener == null) { throw new IllegalStateException("Received a packet before the packet listener was initialized"); } else { @@ -170,7 +192,7 @@ } catch (RejectedExecutionException rejectedexecutionexception) { this.disconnect((Component) Component.translatable("multiplayer.disconnect.server_shutdown")); } catch (ClassCastException classcastexception) { -@@ -205,7 +301,7 @@ +@@ -205,7 +316,7 @@ } private static void genericsFtw(Packet packet, PacketListener listener) { @@ -179,7 +201,7 @@ } private void validateListener(ProtocolInfo state, PacketListener listener) { -@@ -418,12 +514,26 @@ +@@ -418,12 +529,26 @@ } } @@ -206,7 +228,7 @@ } if (!this.isConnected() && !this.disconnectionHandled) { -@@ -431,7 +541,7 @@ +@@ -431,7 +556,7 @@ } if (this.channel != null) { @@ -215,7 +237,7 @@ } if (this.tickCount++ % 20 == 0) { -@@ -464,12 +574,15 @@ +@@ -464,12 +589,15 @@ } public void disconnect(DisconnectionDetails disconnectionInfo) { @@ -232,7 +254,7 @@ this.disconnectionDetails = disconnectionInfo; } -@@ -537,7 +650,7 @@ +@@ -537,7 +665,7 @@ } public void configurePacketHandler(ChannelPipeline pipeline) { @@ -241,7 +263,7 @@ public void write(ChannelHandlerContext channelhandlercontext, Object object, ChannelPromise channelpromise) throws Exception { super.write(channelhandlercontext, object, channelpromise); } -@@ -633,6 +746,7 @@ +@@ -633,6 +761,7 @@ } else { this.channel.pipeline().addAfter("prepender", "compress", new CompressionEncoder(compressionThreshold)); } @@ -249,7 +271,7 @@ } else { if (this.channel.pipeline().get("decompress") instanceof CompressionDecoder) { this.channel.pipeline().remove("decompress"); -@@ -641,6 +755,7 @@ +@@ -641,6 +770,7 @@ if (this.channel.pipeline().get("compress") instanceof CompressionEncoder) { this.channel.pipeline().remove("compress"); } @@ -257,10 +279,11 @@ } } -@@ -661,6 +776,27 @@ +@@ -660,7 +790,28 @@ + }); packetlistener1.onDisconnect(disconnectiondetails); - } ++ } + this.pendingActions.clear(); // Free up packet queue. + // Paper start - Add PlayerConnectionCloseEvent + final PacketListener packetListener = this.getPacketListener(); @@ -280,7 +303,7 @@ + new com.destroystokyo.paper.event.player.PlayerConnectionCloseEvent(profile.getId(), profile.getName(), + ((InetSocketAddress) this.address).getAddress(), false).callEvent(); + } -+ } + } + // Paper end - Add PlayerConnectionCloseEvent } diff --git a/paper-server/patches/sources/net/minecraft/network/PacketEncoder.java.patch b/paper-server/patches/sources/net/minecraft/network/PacketEncoder.java.patch index 70ac5522a3..ce1cafa04d 100644 --- a/paper-server/patches/sources/net/minecraft/network/PacketEncoder.java.patch +++ b/paper-server/patches/sources/net/minecraft/network/PacketEncoder.java.patch @@ -13,7 +13,7 @@ this.protocolInfo.codec().encode(byteBuf, packet); int i = byteBuf.readableBytes(); if (LOGGER.isDebugEnabled()) { -@@ -31,7 +33,7 @@ +@@ -31,14 +33,40 @@ JvmProfiler.INSTANCE.onPacketSent(this.protocolInfo.id(), packetType, channelHandlerContext.channel().remoteAddress(), i); } catch (Throwable var9) { @@ -22,3 +22,36 @@ if (packet.isSkippable()) { throw new SkipPacketException(var9); } + + throw var9; + } finally { ++ // Paper start - Handle large packets disconnecting client ++ int packetLength = byteBuf.readableBytes(); ++ if (packetLength > MAX_PACKET_SIZE || (packetLength > MAX_FINAL_PACKET_SIZE && packet.hasLargePacketFallback())) { ++ throw new PacketTooLargeException(packet, packetLength); ++ } ++ // Paper end - Handle large packets disconnecting client + ProtocolSwapHandler.handleOutboundTerminalPacket(channelHandlerContext, packet); + } + } ++ ++ // Paper start ++ // packet size is encoded into 3-byte varint ++ private static final int MAX_FINAL_PACKET_SIZE = (1 << 21) - 1; ++ // Vanilla Max size for the encoder (before compression) ++ private static final int MAX_PACKET_SIZE = 8388608; ++ ++ public static class PacketTooLargeException extends RuntimeException { ++ private final Packet packet; ++ ++ PacketTooLargeException(Packet packet, int packetLength) { ++ super("PacketTooLarge - " + packet.getClass().getSimpleName() + " is " + packetLength + ". Max is " + MAX_PACKET_SIZE); ++ this.packet = packet; ++ } ++ ++ public Packet getPacket() { ++ return this.packet; ++ } ++ } ++ // Paper end + } diff --git a/paper-server/patches/sources/net/minecraft/network/protocol/Packet.java.patch b/paper-server/patches/sources/net/minecraft/network/protocol/Packet.java.patch new file mode 100644 index 0000000000..ba40a5940e --- /dev/null +++ b/paper-server/patches/sources/net/minecraft/network/protocol/Packet.java.patch @@ -0,0 +1,22 @@ +--- a/net/minecraft/network/protocol/Packet.java ++++ b/net/minecraft/network/protocol/Packet.java +@@ -11,6 +11,19 @@ + + void handle(T listener); + ++ // Paper start ++ default boolean hasLargePacketFallback() { ++ return false; ++ } ++ ++ /** ++ * override {@link #hasLargePacketFallback()} to return true when overriding in subclasses ++ */ ++ default boolean packetTooLarge(net.minecraft.network.Connection manager) { ++ return false; ++ } ++ // Paper end ++ + default boolean isSkippable() { + return false; + } diff --git a/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundContainerSetContentPacket.java.patch b/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundContainerSetContentPacket.java.patch new file mode 100644 index 0000000000..1a14cb1295 --- /dev/null +++ b/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundContainerSetContentPacket.java.patch @@ -0,0 +1,24 @@ +--- a/net/minecraft/network/protocol/game/ClientboundContainerSetContentPacket.java ++++ b/net/minecraft/network/protocol/game/ClientboundContainerSetContentPacket.java +@@ -36,6 +36,21 @@ + this.carriedItem = ItemStack.OPTIONAL_STREAM_CODEC.decode(buf); + } + ++ // Paper start - Handle large packets disconnecting client ++ @Override ++ public boolean hasLargePacketFallback() { ++ return true; ++ } ++ ++ @Override ++ public boolean packetTooLarge(net.minecraft.network.Connection manager) { ++ for (int i = 0 ; i < this.items.size() ; i++) { ++ manager.send(new ClientboundContainerSetSlotPacket(this.containerId, this.stateId, i, this.items.get(i))); ++ } ++ return true; ++ } ++ // Paper end - Handle large packets disconnecting client ++ + private void write(RegistryFriendlyByteBuf buf) { + buf.writeContainerId(this.containerId); + buf.writeVarInt(this.stateId); diff --git a/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundLevelChunkPacketData.java.patch b/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundLevelChunkPacketData.java.patch index 3430e6ce78..26f8a0aa6a 100644 --- a/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundLevelChunkPacketData.java.patch +++ b/paper-server/patches/sources/net/minecraft/network/protocol/game/ClientboundLevelChunkPacketData.java.patch @@ -1,5 +1,14 @@ --- a/net/minecraft/network/protocol/game/ClientboundLevelChunkPacketData.java +++ b/net/minecraft/network/protocol/game/ClientboundLevelChunkPacketData.java +@@ -52,7 +52,7 @@ + throw new RuntimeException("Can't read heightmap in packet for [" + x + ", " + z + "]"); + } else { + int i = buf.readVarInt(); +- if (i > 2097152) { ++ if (i > 2097152) { // Paper - diff on change - if this changes, update PacketEncoder + throw new RuntimeException("Chunk Packet trying to allocate too much memory on read."); + } else { + this.buffer = new byte[i]; @@ -154,6 +154,7 @@ CompoundTag compoundTag = blockEntity.getUpdateTag(blockEntity.getLevel().registryAccess()); BlockPos blockPos = blockEntity.getBlockPos();