netty源码解析(4.0)-23 ByteBuf内存管理:分配和释放

　　ByteBuf内存分配和释放由具体实现负责，抽象类型只定义的内存分配和释放的时机。

　　内存分配分两个阶段: 第一阶段，初始化时分配内存。第二阶段: 内存不够用时分配新的内存。ByteBuf抽象层没有定义第一阶段的行为，但定义了第二阶段的方法：

　　public abstract ByteBuf capacity(int newCapacity)

　　这个方法负责分配一个长度为newCapacity的新内存。

　　内存释放的抽象实现在AbstractReferenceCountedByteBuf中实现，这个类实现引用计数，当调用release方法把引用计数变成0时，会调用

　　protected abstract void deallocate()

　　执行真正的内存释放操作。

内存相关的属性

　　ByteBuf定义了两个内存相关的属性:

　　capacity: 当前的当前的容量，也就是当前使用的内存大小。使用capacity()方法获得。

　　maxCapacity: 最大容量，也就是可以使用的最大内存大小。使用newCapacity()方法获得。

内存分配时机

　　AbstractByteBuf定义了内存分配的时机。当writeXX方法被调用的时候，如果如果发现可写空间不足，就调用capacity分配新的内存。下面以writeInt为例详细分析这个过程。

    @Override
    public ByteBuf writeInt(int value) {
        ensureWritable0(4);
        _setInt(writerIndex, value);
        writerIndex += 4;
        return this;
    }    


    final void ensureWritable0(int minWritableBytes) {
        ensureAccessible();
        if (minWritableBytes <= writableBytes()) {
            return;
        }

        if (minWritableBytes > maxCapacity - writerIndex) {
            throw new IndexOutOfBoundsException(String.format(
                    "writerIndex(%d) + minWritableBytes(%d) exceeds maxCapacity(%d): %s",
                    writerIndex, minWritableBytes, maxCapacity, this));
        }

        // Normalize the current capacity to the power of 2.
        int newCapacity = calculateNewCapacity(writerIndex + minWritableBytes);

        // Adjust to the new capacity.
        capacity(newCapacity);
    }
        

　　3行: ensureWritable确保当前能写入4Byte的数据。

　　11行: 确保当前ByteBuf是可以访问的。防止多线程环境下，ByteBuf内存被释放后读写数据。

　　12，13行: 如果内存够用，就此作罢。

　　16行:  如果需要内存大于maxCapacity抛出异常。

　　23, 26行行: 计算新内存的大小, 调用capacity(int)分配新内存。

　　

　　重新分配内存之前的一个重要步骤的计算新内存的大小。这个工作由calculateNewCapacity方法完成，它的代码如下:

    private int calculateNewCapacity(int minNewCapacity) {
        final int maxCapacity = this.maxCapacity;
        final int threshold = 1048576 * 4; // 4 MiB page

        if (minNewCapacity == threshold) {
            return threshold;
        }

        // If over threshold, do not double but just increase by threshold.
        if (minNewCapacity > threshold) {
            int newCapacity = minNewCapacity / threshold * threshold;
            if (newCapacity > maxCapacity - threshold) {
                newCapacity = maxCapacity;
            } else {
                newCapacity += threshold;
            }
            return newCapacity;
        }

        // Not over threshold. Double up to 4 MiB, starting from 64.
        int newCapacity = 64;
        while (newCapacity < minNewCapacity) {
            newCapacity <<= 1;
        }

        return Math.min(newCapacity, maxCapacity);
    }

　　1行：接受一个最小的新内存参数minNewCapacity。

　　3行： 定义一个4MB的阈值常量threshold。

　　5，6行: 如果minNewCapacity==threshold，那么新内存大小就是threshold。

　　10-17行: 如果minNewCapacity>threshold, 新内存大小是min(maxCapacity, threshold * n)且threshold * n >= minNewCapacity。

　　21-26行: 如果minNewCapacity<threshold, 新内存大小是min(maxCapacity, 64 * 2ⁿ)且64 * 2ⁿ >= minNewCapacity。

内存分配和释放的具体实现

　　本章涉及到的内存分配和释放的具体实现只涉及到unpooled类型的ByteBuf，即:

　　UnpooledHeapByteBuf

　　UnpooledDirectByteBuf

　　UnpooledUnsafeHeapByteBuf

　　UnpooledUnsafeDirectByteBuf

　　这几个具体实现中涉及到的内存分配和释放代码比较简洁，更容易明白ByteBuf内存管理的原理。相比之下，pooled类型的ByteBuf内存分配和释放的代码要复杂很多，会在后面的章节独立分析。

　　

　　UnpooledHeapByteBuf和UnpooledUnsafeHeapByteBuf实现

　　 UnpooledHeapByteBuf中，内存分配的实现代码主要集中在capacity(int)和allocateArray()方法中。capacity分配新内存的步骤是

• 调用allocateArray分配一块新内存。
• 把旧内存中的实际复制到新内存中。
• 使用新内存替换旧内存(24行)。
• 释放掉旧内存(25行)。

　　 代码如下:

    @Override
    public ByteBuf capacity(int newCapacity) {
        checkNewCapacity(newCapacity);

        int oldCapacity = array.length;
        byte[] oldArray = array;
        if (newCapacity > oldCapacity) {
            byte[] newArray = allocateArray(newCapacity);
            System.arraycopy(oldArray, 0, newArray, 0, oldArray.length);
            setArray(newArray);
            freeArray(oldArray);
        } else if (newCapacity < oldCapacity) {
            byte[] newArray = allocateArray(newCapacity);
            int readerIndex = readerIndex();
            if (readerIndex < newCapacity) {
                int writerIndex = writerIndex();
                if (writerIndex > newCapacity) {
                    writerIndex(writerIndex = newCapacity);
                }
                System.arraycopy(oldArray, readerIndex, newArray, readerIndex, writerIndex - readerIndex);
            } else {
                setIndex(newCapacity, newCapacity);
            }
            setArray(newArray);
            freeArray(oldArray);
        }
        return this;
    }
    

　　capacity中复制旧内存数据到新内存中的时候分两种情况(newCapacity，oldCapacity分别是新旧内存的大小):

• newCapacity>oldCapacity，这种情况比较简单，直接复制就好了(第8行)。不影响readerIndex和writerIndex。
• newCapacity<oldCapacity,  这种情况比较复杂。capacity尽量把可读的数据复制新内存中。
  • 如果readerIndex<newCapacity且writerIndex<newCapacity。可读数据会全部转移到新内存中。readerIndex和writerIndex保持不变。
  • 如果readerIndex<newCapacity且writeIndex>newCapacity。可端数据会部分转移的新内存中，会丢失部分可读数据。readerIndex不变，writerIndex变成newCapacity。
  • 如果readerIndex>newCapacity，数据全部丢失，readerIndex和writerIndex都会变成newCapacity。

 　　allocateArray方法负责分配一块新内存，它的实现是new byte[]。freeArray方法负责释放内存，这个方法是个空方法。

　　UnpooledUnsafeHeapByteBuf是UnloopedHeadpByteBuf的直接子类，在内存管理上的差别是allocateArray的实现，UnpooledUnsafeHeapByteBuf的实现是:　　

    @Override
    byte[] allocateArray(int initialCapacity) {
        return PlatformDependent.allocateUninitializedArray(initialCapacity);
    }

　　UnpooledDirectByteBuf和UnpooledUnsafeDirectByteBuf实现

　　UnpooledDirectByteBuf类使用DirectByteBuffer作为内存，使用了DirectByteBuffer的能力来实现ByteBuf接口。allocateDirect和freeDirect方法负责分配和释放DirectByteBuffer。capacity(int)方法和UnloopedHeapByteBuf类似，使用allocateDirect创建一个新的DirectByteBuffer, 把旧内存数据复制到新内存中，然后使用新内存替换旧内存，最后调用freeDirect方法释放掉旧的DirectByteBuffer。

    protected ByteBuffer allocateDirect(int initialCapacity) {
        return ByteBuffer.allocateDirect(initialCapacity);
    }

    protected void freeDirect(ByteBuffer buffer) {
        PlatformDependent.freeDirectBuffer(buffer);
    }

　　@Override
    public ByteBuf capacity(int newCapacity) {
        checkNewCapacity(newCapacity);

        int readerIndex = readerIndex();
        int writerIndex = writerIndex();

        int oldCapacity = capacity;
        if (newCapacity > oldCapacity) {
            ByteBuffer oldBuffer = buffer;
            ByteBuffer newBuffer = allocateDirect(newCapacity);
            oldBuffer.position(0).limit(oldBuffer.capacity());
            newBuffer.position(0).limit(oldBuffer.capacity());
            newBuffer.put(oldBuffer);
            newBuffer.clear();
            setByteBuffer(newBuffer);
        } else if (newCapacity < oldCapacity) {
            ByteBuffer oldBuffer = buffer;
            ByteBuffer newBuffer = allocateDirect(newCapacity);
            if (readerIndex < newCapacity) {
                if (writerIndex > newCapacity) {
                    writerIndex(writerIndex = newCapacity);
                }
                oldBuffer.position(readerIndex).limit(writerIndex);
                newBuffer.position(readerIndex).limit(writerIndex);
                newBuffer.put(oldBuffer);
                newBuffer.clear();
            } else {
                setIndex(newCapacity, newCapacity);
            }
            setByteBuffer(newBuffer);
        }
        return this;
    }

　　对比UnloopedHeapByteBuf的capacity(int)方法，发现这两个实现非常类似，也分两种情况处理:

• 18-24行，newCapacity > oldCapacity的情况。
• 26-39行, newCapacity < oldCapacity的情况。

　　两种情况对readerIndex和writerIndex的影响也一样，不同的是数据复制时的具体实现。　　

　　UnpooledUnsafeDirectByteBuf和UnpooledDirectByteBuf同属于AbstractReferenceCountedByteBuf的派生类，它们之间没有继承关系。但内存分配和释放实现是一样的，不同的地方是内存I/O。UnpooledUnsafeDirectByteBuf使用UnsafeByteBufUtil类之间读写DirectByteBuffer的内存，没有使用DirectByteBuffer的I/O能力。