muduo源码分析之Buffer

博客网址：www.shicoder.top
微信：kj11011029
欢迎加群聊天 ：452380935

这一次我们来分析下muduo中Buffer的作用，我们知道，当我们客户端向服务器发送数据时候，服务器就会读取我们发送的数据，然后进行一系列处理，然后再发送到其他地方，在这里我们想象一下最简单的EchoServer服务器，客户端建立一个连接，以后服务器和客户端之间的通信都是通过这个connfd发送和接受数据，于是每一个connfd都应该有一个自己buffer，当我们发送数据太快，服务器发送的太慢，则服务器会将待发送的数据这个buffer中，所以这就是这个类的作用。我们先看下buffer的结构是什么：

我们这里主要针对connfd这个对应的channel进行分析，首先上图是buffer的初始状态，前面8个字节中表示该buffer的大小，初始大小为1024。当客户端发送数据给服务器，同时若服务器接受缓慢，则会向buffer中开始写数据，则writerIndex_会向右移动，假如此时移动到如下形式：

则此时缓冲区可以读的数据为writerIndex_ - readerIndex_，可以写的数据为buffer_.size() - writerIndex_。这时候当服务器有多余资源进行读操作，就可以去缓冲区读数据了，假如这时候的状态为如下：

这就是常见的几个状态，下面我们去看几个重点的函数：

    // 把onMessage函数上报的buffer内容转为string
    std::string retrieveAllAsString()
    {
        return retrieveAsString(readableBytes()); // 应用可读取数据的长度
    }
    
    // 可读的数据 就是存放的是即发送的数据
    size_t readableBytes() const 
    {
        return writerIndex_ - readerIndex_;
    }
    
    std::string retrieveAsString(size_t len)
    {
        // 从可读数据开始位置，长度为len的char构造为一个string
        std::string result(peek(), len);
        retrieve(len); // 上面一句把缓冲区中可读的数据，已经读取出来，这里肯定要对缓冲区进行复位操作
        return result;
    }
    
    // 将缓冲区len的长度进行复位
    void retrieve(size_t len)
    {
        // 表示还没有读完数据
        if (len < readableBytes())
        {
            readerIndex_ += len; // 应用只读取了刻度缓冲区数据的一部分，就是len，还剩下readerIndex_ += len -> writerIndex_
        }
        else   // len == readableBytes()
        {
            retrieveAll();
        }
    }

以上是基本的操作，下面的2个函数很重要，一个是向connfd写数据，一个是读数据，对于一个TcpConnection而言，当有数据来的时候，回去调用handleRead回调函数。我们知道muduo设置的每次读取的大小为65536字节，当缓冲区可写的数据大小大于65536，就会直接将读到的数据写入到缓冲区中，但当缓冲区的可写数据大小小于65536的时候，就会将剩余数据先写到一个额外的空间

ssize_t Buffer::readFd(int fd, int* saveErrno)
{
    char extrabuf[65536] = {0}; // 栈上的内存空间  64K
    
    struct iovec vec[2];
    
    // 这是buffer可写的数据
    const size_t writable = writableBytes(); 
    vec[0].iov_base = begin() + writerIndex_;
    vec[0].iov_len = writable;

    vec[1].iov_base = extrabuf;
    vec[1].iov_len = sizeof extrabuf;
    
    const int iovcnt = (writable < sizeof extrabuf) ? 2 : 1;
    // 去百度下readv
    const ssize_t n = ::readv(fd, vec, iovcnt);
    if (n < 0)
    {
        *saveErrno = errno;
    }
    else if (n <= writable) // Buffer的可写缓冲区已经够存储读出来的数据了
    {
        writerIndex_ += n;
    }
    // extrabuf 也写了数据
    else 
    {
        writerIndex_ = buffer_.size();
        append(extrabuf, n - writable);  // writerIndex_开始写 n - writable大小的数据
    }

    return n;
}

这里巧妙的使用了一个readv函数，可以通过按照大小自动写到不同的地方。其中当extrabuf也写了数据，就会调用append函数。

    // 要写len长度的数据
    void ensureWriteableBytes(size_t len)
    {
        if (writableBytes() < len)
        {
            makeSpace(len); // 扩容函数
        }
    }

    // 向缓冲区添加数据
    void append(const char *data, size_t len)
    {
        ensureWriteableBytes(len);
        std::copy(data, data+len, beginWrite());
        writerIndex_ += len;
    }

注意到有一个makeSpace函数，其中有一个注意点，比如当如下这种状态的时候：

此时readerIndex_前面有一部分其实已经被读完了，是空的数据，所以makeSpace函数考虑了这一点，采用内存重组的方式，将readerIndex_向前移动到kCheapPrepend处，然后就可以让空余的内存挨在一起

    void makeSpace(size_t len)
    {
        if (writableBytes() + prependableBytes() < len + kCheapPrepend)
        {
            buffer_.resize(writerIndex_ + len);
        }
        else
        {
            size_t readalbe = readableBytes();
            std::copy(begin() + readerIndex_, 
                    begin() + writerIndex_,
                    begin() + kCheapPrepend);
            readerIndex_ = kCheapPrepend;
            writerIndex_ = readerIndex_ + readalbe;
        }
    }

当向connfd发送数据的时候就比较简单了，直接将可读的数据发送给出去就行

// 通过fd发送数据
ssize_t Buffer::writeFd(int fd, int* saveErrno)
{
    ssize_t n = ::write(fd, peek(), readableBytes());
    if (n < 0)
    {
        *saveErrno = errno;
    }
    return n;
}