14158070bf
The API changes made so far turned out to increase the memory footprint
and consumption while our intention was actually decreasing them.
Memory consumption issue:
When there are many connections which does not exchange data frequently,
the old Netty 4 API spent a lot more memory than 3 because it always
allocates per-handler buffer for each connection unless otherwise
explicitly stated by a user. In a usual real world load, a client
doesn't always send requests without pausing, so the idea of having a
buffer whose life cycle if bound to the life cycle of a connection
didn't work as expected.
Memory footprint issue:
The old Netty 4 API decreased overall memory footprint by a great deal
in many cases. It was mainly because the old Netty 4 API did not
allocate a new buffer and event object for each read. Instead, it
created a new buffer for each handler in a pipeline. This works pretty
well as long as the number of handlers in a pipeline is only a few.
However, for a highly modular application with many handlers which
handles connections which lasts for relatively short period, it actually
makes the memory footprint issue much worse.
Changes:
All in all, this is about retaining all the good changes we made in 4 so
far such as better thread model and going back to the way how we dealt
with message events in 3.
To fix the memory consumption/footprint issue mentioned above, we made a
hard decision to break the backward compatibility again with the
following changes:
- Remove MessageBuf
- Merge Buf into ByteBuf
- Merge ChannelInboundByte/MessageHandler and ChannelStateHandler into ChannelInboundHandler
- Similar changes were made to the adapter classes
- Merge ChannelOutboundByte/MessageHandler and ChannelOperationHandler into ChannelOutboundHandler
- Similar changes were made to the adapter classes
- Introduce MessageList which is similar to `MessageEvent` in Netty 3
- Replace inboundBufferUpdated(ctx) with messageReceived(ctx, MessageList)
- Replace flush(ctx, promise) with write(ctx, MessageList, promise)
- Remove ByteToByteEncoder/Decoder/Codec
- Replaced by MessageToByteEncoder<ByteBuf>, ByteToMessageDecoder<ByteBuf>, and ByteMessageCodec<ByteBuf>
- Merge EmbeddedByteChannel and EmbeddedMessageChannel into EmbeddedChannel
- Add SimpleChannelInboundHandler which is sometimes more useful than
ChannelInboundHandlerAdapter
- Bring back Channel.isWritable() from Netty 3
- Add ChannelInboundHandler.channelWritabilityChanges() event
- Add RecvByteBufAllocator configuration property
- Similar to ReceiveBufferSizePredictor in Netty 3
- Some existing configuration properties such as
DatagramChannelConfig.receivePacketSize is gone now.
- Remove suspend/resumeIntermediaryDeallocation() in ByteBuf
This change would have been impossible without @normanmaurer's help. He
fixed, ported, and improved many parts of the changes.
464 lines
20 KiB
Java
464 lines
20 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
// (BSD License: http://www.opensource.org/licenses/bsd-license)
|
|
//
|
|
// Copyright (c) 2011, Joe Walnes and contributors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or
|
|
// without modification, are permitted provided that the
|
|
// following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above
|
|
// copyright notice, this list of conditions and the
|
|
// following disclaimer.
|
|
//
|
|
// * Redistributions in binary form must reproduce the above
|
|
// copyright notice, this list of conditions and the
|
|
// following disclaimer in the documentation and/or other
|
|
// materials provided with the distribution.
|
|
//
|
|
// * Neither the name of the Webbit nor the names of
|
|
// its contributors may be used to endorse or promote products
|
|
// derived from this software without specific prior written
|
|
// permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
|
// CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
|
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
|
// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
|
// BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
// OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
package io.netty.handler.codec.http.websocketx;
|
|
|
|
import io.netty.buffer.ByteBuf;
|
|
import io.netty.buffer.Unpooled;
|
|
import io.netty.channel.ChannelFutureListener;
|
|
import io.netty.channel.ChannelHandlerContext;
|
|
import io.netty.channel.MessageList;
|
|
import io.netty.handler.codec.CorruptedFrameException;
|
|
import io.netty.handler.codec.ReplayingDecoder;
|
|
import io.netty.handler.codec.TooLongFrameException;
|
|
import io.netty.util.internal.logging.InternalLogger;
|
|
import io.netty.util.internal.logging.InternalLoggerFactory;
|
|
|
|
/**
|
|
* Decodes a web socket frame from wire protocol version 8 format. This code was forked from <a
|
|
* href="https://github.com/joewalnes/webbit">webbit</a> and modified.
|
|
*/
|
|
public class WebSocket08FrameDecoder extends ReplayingDecoder<WebSocket08FrameDecoder.State> {
|
|
|
|
private static final InternalLogger logger = InternalLoggerFactory.getInstance(WebSocket08FrameDecoder.class);
|
|
|
|
private static final byte OPCODE_CONT = 0x0;
|
|
private static final byte OPCODE_TEXT = 0x1;
|
|
private static final byte OPCODE_BINARY = 0x2;
|
|
private static final byte OPCODE_CLOSE = 0x8;
|
|
private static final byte OPCODE_PING = 0x9;
|
|
private static final byte OPCODE_PONG = 0xA;
|
|
|
|
private UTF8Output fragmentedFramesText;
|
|
private int fragmentedFramesCount;
|
|
|
|
private final long maxFramePayloadLength;
|
|
private boolean frameFinalFlag;
|
|
private int frameRsv;
|
|
private int frameOpcode;
|
|
private long framePayloadLength;
|
|
private ByteBuf framePayload;
|
|
private int framePayloadBytesRead;
|
|
private ByteBuf maskingKey;
|
|
private ByteBuf payloadBuffer;
|
|
|
|
private final boolean allowExtensions;
|
|
private final boolean maskedPayload;
|
|
private boolean receivedClosingHandshake;
|
|
|
|
enum State {
|
|
FRAME_START, MASKING_KEY, PAYLOAD, CORRUPT
|
|
}
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param maskedPayload
|
|
* Web socket servers must set this to true processed incoming masked payload. Client implementations
|
|
* must set this to false.
|
|
* @param allowExtensions
|
|
* Flag to allow reserved extension bits to be used or not
|
|
* @param maxFramePayloadLength
|
|
* Maximum length of a frame's payload. Setting this to an appropriate value for you application
|
|
* helps check for denial of services attacks.
|
|
*/
|
|
public WebSocket08FrameDecoder(boolean maskedPayload, boolean allowExtensions, int maxFramePayloadLength) {
|
|
super(State.FRAME_START);
|
|
this.maskedPayload = maskedPayload;
|
|
this.allowExtensions = allowExtensions;
|
|
this.maxFramePayloadLength = maxFramePayloadLength;
|
|
}
|
|
|
|
@Override
|
|
protected void decode(ChannelHandlerContext ctx, ByteBuf in, MessageList<Object> out) throws Exception {
|
|
|
|
// Discard all data received if closing handshake was received before.
|
|
if (receivedClosingHandshake) {
|
|
in.skipBytes(actualReadableBytes());
|
|
return;
|
|
}
|
|
|
|
try {
|
|
switch (state()) {
|
|
case FRAME_START:
|
|
framePayloadBytesRead = 0;
|
|
framePayloadLength = -1;
|
|
framePayload = null;
|
|
payloadBuffer = null;
|
|
|
|
// FIN, RSV, OPCODE
|
|
byte b = in.readByte();
|
|
frameFinalFlag = (b & 0x80) != 0;
|
|
frameRsv = (b & 0x70) >> 4;
|
|
frameOpcode = b & 0x0F;
|
|
|
|
if (logger.isDebugEnabled()) {
|
|
logger.debug("Decoding WebSocket Frame opCode={}", frameOpcode);
|
|
}
|
|
|
|
// MASK, PAYLOAD LEN 1
|
|
b = in.readByte();
|
|
boolean frameMasked = (b & 0x80) != 0;
|
|
int framePayloadLen1 = b & 0x7F;
|
|
|
|
if (frameRsv != 0 && !allowExtensions) {
|
|
protocolViolation(ctx, "RSV != 0 and no extension negotiated, RSV:" + frameRsv);
|
|
return;
|
|
}
|
|
|
|
if (maskedPayload && !frameMasked) {
|
|
protocolViolation(ctx, "unmasked client to server frame");
|
|
return;
|
|
}
|
|
if (frameOpcode > 7) { // control frame (have MSB in opcode set)
|
|
|
|
// control frames MUST NOT be fragmented
|
|
if (!frameFinalFlag) {
|
|
protocolViolation(ctx, "fragmented control frame");
|
|
return;
|
|
}
|
|
|
|
// control frames MUST have payload 125 octets or less
|
|
if (framePayloadLen1 > 125) {
|
|
protocolViolation(ctx, "control frame with payload length > 125 octets");
|
|
return;
|
|
}
|
|
|
|
// check for reserved control frame opcodes
|
|
if (!(frameOpcode == OPCODE_CLOSE || frameOpcode == OPCODE_PING
|
|
|| frameOpcode == OPCODE_PONG)) {
|
|
protocolViolation(ctx, "control frame using reserved opcode " + frameOpcode);
|
|
return;
|
|
}
|
|
|
|
// close frame : if there is a body, the first two bytes of the
|
|
// body MUST be a 2-byte unsigned integer (in network byte
|
|
// order) representing a getStatus code
|
|
if (frameOpcode == 8 && framePayloadLen1 == 1) {
|
|
protocolViolation(ctx, "received close control frame with payload len 1");
|
|
return;
|
|
}
|
|
} else { // data frame
|
|
// check for reserved data frame opcodes
|
|
if (!(frameOpcode == OPCODE_CONT || frameOpcode == OPCODE_TEXT
|
|
|| frameOpcode == OPCODE_BINARY)) {
|
|
protocolViolation(ctx, "data frame using reserved opcode " + frameOpcode);
|
|
return;
|
|
}
|
|
|
|
// check opcode vs message fragmentation state 1/2
|
|
if (fragmentedFramesCount == 0 && frameOpcode == OPCODE_CONT) {
|
|
protocolViolation(ctx, "received continuation data frame outside fragmented message");
|
|
return;
|
|
}
|
|
|
|
// check opcode vs message fragmentation state 2/2
|
|
if (fragmentedFramesCount != 0 && frameOpcode != OPCODE_CONT && frameOpcode != OPCODE_PING) {
|
|
protocolViolation(ctx,
|
|
"received non-continuation data frame while inside fragmented message");
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Read frame payload length
|
|
if (framePayloadLen1 == 126) {
|
|
framePayloadLength = in.readUnsignedShort();
|
|
if (framePayloadLength < 126) {
|
|
protocolViolation(ctx, "invalid data frame length (not using minimal length encoding)");
|
|
return;
|
|
}
|
|
} else if (framePayloadLen1 == 127) {
|
|
framePayloadLength = in.readLong();
|
|
// TODO: check if it's bigger than 0x7FFFFFFFFFFFFFFF, Maybe
|
|
// just check if it's negative?
|
|
|
|
if (framePayloadLength < 65536) {
|
|
protocolViolation(ctx, "invalid data frame length (not using minimal length encoding)");
|
|
return;
|
|
}
|
|
} else {
|
|
framePayloadLength = framePayloadLen1;
|
|
}
|
|
|
|
if (framePayloadLength > maxFramePayloadLength) {
|
|
protocolViolation(ctx, "Max frame length of " + maxFramePayloadLength + " has been exceeded.");
|
|
return;
|
|
}
|
|
|
|
if (logger.isDebugEnabled()) {
|
|
logger.debug("Decoding WebSocket Frame length={}", framePayloadLength);
|
|
}
|
|
|
|
checkpoint(State.MASKING_KEY);
|
|
case MASKING_KEY:
|
|
if (maskedPayload) {
|
|
maskingKey = in.readBytes(4);
|
|
}
|
|
checkpoint(State.PAYLOAD);
|
|
case PAYLOAD:
|
|
// Sometimes, the payload may not be delivered in 1 nice packet
|
|
// We need to accumulate the data until we have it all
|
|
int rbytes = actualReadableBytes();
|
|
|
|
long willHaveReadByteCount = framePayloadBytesRead + rbytes;
|
|
// logger.debug("Frame rbytes=" + rbytes + " willHaveReadByteCount="
|
|
// + willHaveReadByteCount + " framePayloadLength=" +
|
|
// framePayloadLength);
|
|
if (willHaveReadByteCount == framePayloadLength) {
|
|
// We have all our content so proceed to process
|
|
payloadBuffer = ctx.alloc().buffer(rbytes);
|
|
payloadBuffer.writeBytes(in, rbytes);
|
|
} else if (willHaveReadByteCount < framePayloadLength) {
|
|
|
|
// We don't have all our content so accumulate payload.
|
|
// Returning null means we will get called back
|
|
if (framePayload == null) {
|
|
framePayload = ctx.alloc().buffer(toFrameLength(framePayloadLength));
|
|
}
|
|
framePayload.writeBytes(in, rbytes);
|
|
framePayloadBytesRead += rbytes;
|
|
|
|
// Return null to wait for more bytes to arrive
|
|
return;
|
|
} else if (willHaveReadByteCount > framePayloadLength) {
|
|
// We have more than what we need so read up to the end of frame
|
|
// Leave the remainder in the buffer for next frame
|
|
if (framePayload == null) {
|
|
framePayload = ctx.alloc().buffer(toFrameLength(framePayloadLength));
|
|
}
|
|
framePayload.writeBytes(in, toFrameLength(framePayloadLength - framePayloadBytesRead));
|
|
}
|
|
|
|
// Now we have all the data, the next checkpoint must be the next
|
|
// frame
|
|
checkpoint(State.FRAME_START);
|
|
|
|
// Take the data that we have in this packet
|
|
if (framePayload == null) {
|
|
framePayload = payloadBuffer;
|
|
} else if (payloadBuffer != null) {
|
|
framePayload.writeBytes(payloadBuffer);
|
|
}
|
|
|
|
// Unmask data if needed
|
|
if (maskedPayload) {
|
|
unmask(framePayload);
|
|
}
|
|
|
|
// Processing ping/pong/close frames because they cannot be
|
|
// fragmented
|
|
if (frameOpcode == OPCODE_PING) {
|
|
out.add(new PingWebSocketFrame(frameFinalFlag, frameRsv, framePayload));
|
|
return;
|
|
}
|
|
if (frameOpcode == OPCODE_PONG) {
|
|
out.add(new PongWebSocketFrame(frameFinalFlag, frameRsv, framePayload));
|
|
return;
|
|
}
|
|
if (frameOpcode == OPCODE_CLOSE) {
|
|
checkCloseFrameBody(ctx, framePayload);
|
|
receivedClosingHandshake = true;
|
|
out.add(new CloseWebSocketFrame(frameFinalFlag, frameRsv, framePayload));
|
|
return;
|
|
}
|
|
|
|
// Processing for possible fragmented messages for text and binary
|
|
// frames
|
|
String aggregatedText = null;
|
|
if (frameFinalFlag) {
|
|
// Final frame of the sequence. Apparently ping frames are
|
|
// allowed in the middle of a fragmented message
|
|
if (frameOpcode != OPCODE_PING) {
|
|
fragmentedFramesCount = 0;
|
|
|
|
// Check text for UTF8 correctness
|
|
if (frameOpcode == OPCODE_TEXT || fragmentedFramesText != null) {
|
|
// Check UTF-8 correctness for this payload
|
|
checkUTF8String(ctx, framePayload);
|
|
|
|
// This does a second check to make sure UTF-8
|
|
// correctness for entire text message
|
|
aggregatedText = fragmentedFramesText.toString();
|
|
|
|
fragmentedFramesText = null;
|
|
}
|
|
}
|
|
} else {
|
|
// Not final frame so we can expect more frames in the
|
|
// fragmented sequence
|
|
if (fragmentedFramesCount == 0) {
|
|
// First text or binary frame for a fragmented set
|
|
fragmentedFramesText = null;
|
|
if (frameOpcode == OPCODE_TEXT) {
|
|
checkUTF8String(ctx, framePayload);
|
|
}
|
|
} else {
|
|
// Subsequent frames - only check if init frame is text
|
|
if (fragmentedFramesText != null) {
|
|
checkUTF8String(ctx, framePayload);
|
|
}
|
|
}
|
|
|
|
// Increment counter
|
|
fragmentedFramesCount++;
|
|
}
|
|
|
|
// Return the frame
|
|
if (frameOpcode == OPCODE_TEXT) {
|
|
out.add(new TextWebSocketFrame(frameFinalFlag, frameRsv, framePayload));
|
|
return;
|
|
} else if (frameOpcode == OPCODE_BINARY) {
|
|
out.add(new BinaryWebSocketFrame(frameFinalFlag, frameRsv, framePayload));
|
|
return;
|
|
} else if (frameOpcode == OPCODE_CONT) {
|
|
out.add(new ContinuationWebSocketFrame(frameFinalFlag, frameRsv, framePayload, aggregatedText));
|
|
return;
|
|
} else {
|
|
throw new UnsupportedOperationException("Cannot decode web socket frame with opcode: "
|
|
+ frameOpcode);
|
|
}
|
|
case CORRUPT:
|
|
// If we don't keep reading Netty will throw an exception saying
|
|
// we can't return null if no bytes read and state not changed.
|
|
in.readByte();
|
|
return;
|
|
default:
|
|
throw new Error("Shouldn't reach here.");
|
|
}
|
|
} catch (Exception e) {
|
|
if (payloadBuffer != null) {
|
|
if (payloadBuffer.refCnt() > 0) {
|
|
payloadBuffer.release();
|
|
}
|
|
payloadBuffer = null;
|
|
}
|
|
if (framePayload != null) {
|
|
if (framePayload.refCnt() > 0) {
|
|
framePayload.release();
|
|
}
|
|
framePayload = null;
|
|
}
|
|
throw e;
|
|
}
|
|
}
|
|
|
|
private void unmask(ByteBuf frame) {
|
|
for (int i = frame.readerIndex(); i < frame.writerIndex(); i++) {
|
|
frame.setByte(i, frame.getByte(i) ^ maskingKey.getByte(i % 4));
|
|
}
|
|
}
|
|
|
|
private void protocolViolation(ChannelHandlerContext ctx, String reason) {
|
|
checkpoint(State.CORRUPT);
|
|
if (ctx.channel().isActive()) {
|
|
ctx.write(Unpooled.EMPTY_BUFFER).addListener(ChannelFutureListener.CLOSE);
|
|
}
|
|
throw new CorruptedFrameException(reason);
|
|
}
|
|
|
|
private static int toFrameLength(long l) {
|
|
if (l > Integer.MAX_VALUE) {
|
|
throw new TooLongFrameException("Length:" + l);
|
|
} else {
|
|
return (int) l;
|
|
}
|
|
}
|
|
|
|
private void checkUTF8String(ChannelHandlerContext ctx, ByteBuf buffer) {
|
|
try {
|
|
if (fragmentedFramesText == null) {
|
|
fragmentedFramesText = new UTF8Output(buffer);
|
|
} else {
|
|
fragmentedFramesText.write(buffer);
|
|
}
|
|
} catch (UTF8Exception ex) {
|
|
protocolViolation(ctx, "invalid UTF-8 bytes");
|
|
}
|
|
}
|
|
|
|
/** */
|
|
protected void checkCloseFrameBody(
|
|
ChannelHandlerContext ctx, ByteBuf buffer) {
|
|
if (buffer == null || buffer.capacity() == 0) {
|
|
return;
|
|
}
|
|
if (buffer.capacity() == 1) {
|
|
protocolViolation(ctx, "Invalid close frame body");
|
|
}
|
|
|
|
// Save reader index
|
|
int idx = buffer.readerIndex();
|
|
buffer.readerIndex(0);
|
|
|
|
// Must have 2 byte integer within the valid range
|
|
int statusCode = buffer.readShort();
|
|
if (statusCode >= 0 && statusCode <= 999 || statusCode >= 1004 && statusCode <= 1006
|
|
|| statusCode >= 1012 && statusCode <= 2999) {
|
|
protocolViolation(ctx, "Invalid close frame getStatus code: " + statusCode);
|
|
}
|
|
|
|
// May have UTF-8 message
|
|
if (buffer.isReadable()) {
|
|
|
|
try {
|
|
new UTF8Output(buffer);
|
|
} catch (UTF8Exception ex) {
|
|
protocolViolation(ctx, "Invalid close frame reason text. Invalid UTF-8 bytes");
|
|
}
|
|
}
|
|
|
|
// Restore reader index
|
|
buffer.readerIndex(idx);
|
|
}
|
|
}
|