linux kfifo解析

本文中引用的图来自linux内核数据结构之kfifo - 云+社区 - 腾讯云

fifo的使用无外乎读出和写入，本文结合源码解释。

buffer为待操作的数据，len为待操作的长度
uint32_t kfifo_put(KFIFO *fifo, uint8_t *buffer, uint32_t len)
{
    uint32_t l;

    len = MIN(len, fifo->size - (fifo->in - fifo->out));
    l = MIN(len, fifo->size - (fifo->in & (fifo->size - 1)));

    memcpy(fifo->buffer + (fifo->in & (fifo->size - 1)), buffer, l);
    memcpy(fifo->buffer, buffer + l, len - l);

    fifo->in += len;

    return len;
}



uint32_t kfifo_get(KFIFO *fifo, uint8_t *buffer, uint32_t len)
{
    uint32_t l;

    len = MIN(len, fifo->in - fifo->out);
    l = MIN(len, fifo->size - (fifo->out & (fifo->size - 1)));

    memcpy(buffer, fifo->buffer + (fifo->out & (fifo->size - 1)), l);  
    memcpy(buffer + l, fifo->buffer, len - l);

    fifo->out += len;

    return len;
}

先来看put函数中 

len = MIN(len, fifo->size - (fifo->in - fifo->out));

len为要写入的长度，这里取len和fifo->size - (fifo->in - fifo->out)的最小值，fifo->size - (fifo->in - fifo->out)在上述图中可以清晰地理解为蓝色部分，即空闲部分，这部分是可以写入的，若len大于蓝色部分长度则只将蓝色部分填满。

 l = MIN(len, fifo->size - (fifo->in & (fifo->size - 1)));

这里关键看fifo->in & (fifo->size - 1))，在linux中要求fifo->size为2的整数幂，fifo->size - 1则低位全为1，fifo->in & (fifo->size - 1))可以看作是fifo->in对fifo->size取模，fifo->size - (fifo->in & (fifo->size - 1))所表示的长度其实就是fifo->in距离fifo->buff缓冲区尾部的部分。而I取len和fifo->size - (fifo->in & (fifo->size - 1))的最小值，可以避免溢出的情况发生，如图四的第三个图，当想要取出的长度大于空余数据长度时，I精准地取了蓝色空余部分的长度。

 memcpy(fifo->buffer + (fifo->in & (fifo->size - 1)), buffer, l);                       ---------1
 memcpy(fifo->buffer, buffer + l, len - l);                                                      ---------2               

这里分两种情况，一种是in距离尾部这段距离的空闲长度满足要put的数据长度如下图：

假设要 put3个数据，蓝色部分为4个数据长度，那么put的目标起始地址为fifo->buffer + (fifo->in & (fifo->size - 1))，执行1处代码即可。

第二种情况如下图：

即假设要put3个数据，而尾部蓝色部分数据长度只剩2个，那么剩下的一个数据就要put到头部，则还需要执行2处代码。

每次操作后将fifo->in后移len个长度。

再来看get函数中

 len = MIN(len, fifo->in - fifo->out);

取出的数据长度肯定不能比缓冲区中剩余的长度多。

 l = MIN(len, fifo->size - (fifo->out & (fifo->size - 1)));

fifo->size - (fifo->out & (fifo->size - 1))表示的长度为fifo->out距离fifo->buffer尾部的距离。

这里以图三举例：

 

memcpy(buffer, fifo->buffer + (fifo->out & (fifo->size - 1)), l);  

假设get一个buffer后fifo中剩余长度为6，要取出5个数据，则这一步是从out所指的位置开始取5个数据到用户分配的buffer中。

这种情况下，即out距离尾部的长度假设是4，执行这行代码后就将这4个数据取出了，还想再取出一个数据就需要下一行代码：

memcpy(buffer + l, fifo->buffer, len - l);

最后每取出一个就将out指针后移一个字节。