netty5/codec-http/src/main/java/io/netty/handler/codec/http/multipart/MixedAttribute.java
Trustin Lee 3a9f472161 Make retained derived buffers recyclable
Related: #4333 #4421 #5128

Motivation:

slice(), duplicate() and readSlice() currently create a non-recyclable
derived buffer instance. Under heavy load, an application that creates a
lot of derived buffers can put the garbage collector under pressure.

Modifications:

- Add the following methods which creates a non-recyclable derived buffer
  - retainedSlice()
  - retainedDuplicate()
  - readRetainedSlice()
- Add the new recyclable derived buffer implementations, which has its
  own reference count value
- Add ByteBufHolder.retainedDuplicate()
- Add ByteBufHolder.replace(ByteBuf) so that..
  - a user can replace the content of the holder in a consistent way
  - copy/duplicate/retainedDuplicate() can delegate the holder
    construction to replace(ByteBuf)
- Use retainedDuplicate() and retainedSlice() wherever possible
- Miscellaneous:
  - Rename DuplicateByteBufTest to DuplicatedByteBufTest (missing 'D')
  - Make ReplayingDecoderByteBuf.reject() return an exception instead of
    throwing it so that its callers don't need to add dummy return
    statement

Result:

Derived buffers are now recycled when created via retainedSlice() and
retainedDuplicate() and derived from a pooled buffer
2016-05-17 11:16:13 +02:00

328 lines
8.6 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.
*/
package io.netty.handler.codec.http.multipart;
import io.netty.buffer.ByteBuf;
import io.netty.handler.codec.http.HttpConstants;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
/**
* Mixed implementation using both in Memory and in File with a limit of size
*/
public class MixedAttribute implements Attribute {
private Attribute attribute;
private final long limitSize;
private long maxSize = DefaultHttpDataFactory.MAXSIZE;
public MixedAttribute(String name, long limitSize) {
this(name, limitSize, HttpConstants.DEFAULT_CHARSET);
}
public MixedAttribute(String name, long definedSize, long limitSize) {
this(name, definedSize, limitSize, HttpConstants.DEFAULT_CHARSET);
}
public MixedAttribute(String name, long limitSize, Charset charset) {
this.limitSize = limitSize;
attribute = new MemoryAttribute(name, charset);
}
public MixedAttribute(String name, long definedSize, long limitSize, Charset charset) {
this.limitSize = limitSize;
attribute = new MemoryAttribute(name, definedSize, charset);
}
public MixedAttribute(String name, String value, long limitSize) {
this(name, value, limitSize, HttpConstants.DEFAULT_CHARSET);
}
public MixedAttribute(String name, String value, long limitSize, Charset charset) {
this.limitSize = limitSize;
if (value.length() > this.limitSize) {
try {
attribute = new DiskAttribute(name, value, charset);
} catch (IOException e) {
// revert to Memory mode
try {
attribute = new MemoryAttribute(name, value, charset);
} catch (IOException ignore) {
throw new IllegalArgumentException(e);
}
}
} else {
try {
attribute = new MemoryAttribute(name, value, charset);
} catch (IOException e) {
throw new IllegalArgumentException(e);
}
}
}
@Override
public long getMaxSize() {
return maxSize;
}
@Override
public void setMaxSize(long maxSize) {
this.maxSize = maxSize;
attribute.setMaxSize(maxSize);
}
@Override
public void checkSize(long newSize) throws IOException {
if (maxSize >= 0 && newSize > maxSize) {
throw new IOException("Size exceed allowed maximum capacity");
}
}
@Override
public void addContent(ByteBuf buffer, boolean last) throws IOException {
if (attribute instanceof MemoryAttribute) {
checkSize(attribute.length() + buffer.readableBytes());
if (attribute.length() + buffer.readableBytes() > limitSize) {
DiskAttribute diskAttribute = new DiskAttribute(attribute
.getName(), attribute.definedLength());
diskAttribute.setMaxSize(maxSize);
if (((MemoryAttribute) attribute).getByteBuf() != null) {
diskAttribute.addContent(((MemoryAttribute) attribute)
.getByteBuf(), false);
}
attribute = diskAttribute;
}
}
attribute.addContent(buffer, last);
}
@Override
public void delete() {
attribute.delete();
}
@Override
public byte[] get() throws IOException {
return attribute.get();
}
@Override
public ByteBuf getByteBuf() throws IOException {
return attribute.getByteBuf();
}
@Override
public Charset getCharset() {
return attribute.getCharset();
}
@Override
public String getString() throws IOException {
return attribute.getString();
}
@Override
public String getString(Charset encoding) throws IOException {
return attribute.getString(encoding);
}
@Override
public boolean isCompleted() {
return attribute.isCompleted();
}
@Override
public boolean isInMemory() {
return attribute.isInMemory();
}
@Override
public long length() {
return attribute.length();
}
@Override
public long definedLength() {
return attribute.definedLength();
}
@Override
public boolean renameTo(File dest) throws IOException {
return attribute.renameTo(dest);
}
@Override
public void setCharset(Charset charset) {
attribute.setCharset(charset);
}
@Override
public void setContent(ByteBuf buffer) throws IOException {
checkSize(buffer.readableBytes());
if (buffer.readableBytes() > limitSize) {
if (attribute instanceof MemoryAttribute) {
// change to Disk
attribute = new DiskAttribute(attribute.getName(), attribute.definedLength());
attribute.setMaxSize(maxSize);
}
}
attribute.setContent(buffer);
}
@Override
public void setContent(File file) throws IOException {
checkSize(file.length());
if (file.length() > limitSize) {
if (attribute instanceof MemoryAttribute) {
// change to Disk
attribute = new DiskAttribute(attribute.getName(), attribute.definedLength());
attribute.setMaxSize(maxSize);
}
}
attribute.setContent(file);
}
@Override
public void setContent(InputStream inputStream) throws IOException {
if (attribute instanceof MemoryAttribute) {
// change to Disk even if we don't know the size
attribute = new DiskAttribute(attribute.getName(), attribute.definedLength());
attribute.setMaxSize(maxSize);
}
attribute.setContent(inputStream);
}
@Override
public HttpDataType getHttpDataType() {
return attribute.getHttpDataType();
}
@Override
public String getName() {
return attribute.getName();
}
@Override
public int hashCode() {
return attribute.hashCode();
}
@Override
public boolean equals(Object obj) {
return attribute.equals(obj);
}
@Override
public int compareTo(InterfaceHttpData o) {
return attribute.compareTo(o);
}
@Override
public String toString() {
return "Mixed: " + attribute;
}
@Override
public String getValue() throws IOException {
return attribute.getValue();
}
@Override
public void setValue(String value) throws IOException {
if (value != null) {
checkSize(value.getBytes().length);
}
attribute.setValue(value);
}
@Override
public ByteBuf getChunk(int length) throws IOException {
return attribute.getChunk(length);
}
@Override
public File getFile() throws IOException {
return attribute.getFile();
}
@Override
public Attribute copy() {
return attribute.copy();
}
@Override
public Attribute duplicate() {
return attribute.duplicate();
}
@Override
public Attribute retainedDuplicate() {
return attribute.retainedDuplicate();
}
@Override
public Attribute replace(ByteBuf content) {
return attribute.replace(content);
}
@Override
public ByteBuf content() {
return attribute.content();
}
@Override
public int refCnt() {
return attribute.refCnt();
}
@Override
public Attribute retain() {
attribute.retain();
return this;
}
@Override
public Attribute retain(int increment) {
attribute.retain(increment);
return this;
}
@Override
public Attribute touch() {
attribute.touch();
return this;
}
@Override
public Attribute touch(Object hint) {
attribute.touch(hint);
return this;
}
@Override
public boolean release() {
return attribute.release();
}
@Override
public boolean release(int decrement) {
return attribute.release(decrement);
}
}