new: kfifo

kernel/common/Makefile

@@ -3,7 +3,7 @@ CFLAGS += -I .
 
 kernel_common_subdirs:=libELF math
 
-all: glib.o printk.o cpu.o bitree.o
+all: glib.o printk.o cpu.o bitree.o kfifo.o
 	@list='$(kernel_common_subdirs)'; for subdir in $$list; do \
     		echo "make all in $$subdir";\
     		cd $$subdir;\
@@ -21,4 +21,7 @@ cpu.o: cpu.c
 	gcc $(CFLAGS) -c cpu.c -o cpu.o
 
 bitree.o: bitree.c
-	gcc $(CFLAGS) -c bitree.c -o bitree.o
+	gcc $(CFLAGS) -c bitree.c -o bitree.o
+
+kfifo.o: kfifo.c
+	gcc $(CFLAGS) -c kfifo.c -o kfifo.o

kernel/common/kfifo.c

@@ -0,0 +1,151 @@
+#include <common/kfifo.h>
+#include <common/glib.h>
+#include <common/errno.h>
+#include <common/compiler.h>
+#include <mm/slab.h>
+
+/**
+ * @brief 通过动态方式初始化kfifo缓冲队列
+ *
+ * @param fifo 队列结构体
+ * @param size 缓冲区大小
+ * @param reserved 暂时保留，请置为0
+ * @return int 错误码：成功->0
+ */
+int kfifo_alloc(struct kfifo_t *fifo, uint32_t size, uint64_t reserved)
+{
+    memset(fifo, 0, sizeof(struct kfifo_t));
+    fifo->buffer = kmalloc(size, 0);
+    if (fifo->buffer == NULL)
+        goto failed;
+
+    fifo->total_size = size;
+    return 0;
+failed:;
+    return -ENOMEM;
+}
+
+/**
+ * @brief 使用指定的缓冲区来初始化kfifo缓冲队列
+ *
+ * @param fifo 队列结构体
+ * @param buffer 缓冲区
+ * @param size 缓冲区大小
+ */
+void kfifo_init(struct kfifo_t *fifo, void *buffer, uint32_t size)
+{
+    memset(fifo, 0, sizeof(struct kfifo_t));
+
+    fifo->buffer = buffer;
+    fifo->total_size = size;
+}
+
+/**
+ * @brief 向kfifo缓冲区推入数据
+ *
+ * @param fifo 队列结构体
+ * @param from 来源数据地址
+ * @param size 数据大小（字节数）
+ * @return uint32_t 推入的数据大小
+ */
+uint32_t kfifo_in(struct kfifo_t *fifo, const void *from, uint32_t size)
+{
+    // 判断空间是否够
+    if (unlikely(fifo->size + size > fifo->total_size))
+        return 0;
+    if (unlikely(from == NULL))
+        return 0;
+
+    // 分两种情况，一种是要发生回环，另一种不发生回环
+    if (fifo->in_offset + size > fifo->total_size) // 发生回环
+    {
+        uint32_t tmp = fifo->total_size - fifo->in_offset;
+        memcpy(fifo->buffer + fifo->in_offset, from, tmp);
+        memcpy(fifo->buffer, from + tmp, size - tmp);
+        fifo->in_offset = size - tmp;
+    }
+    else // 不发生回环
+    {
+        memcpy(fifo->buffer + fifo->in_offset, from, size);
+        fifo->in_offset += size;
+    }
+
+    fifo->size += size;
+
+    return size;
+}
+
+/**
+ * @brief 从kfifo缓冲区取出数据，并从队列中删除数据
+ *
+ * @param fifo 队列结构体
+ * @param to 拷贝目标地址
+ * @param size 数据大小（字节数）
+ * @return uint32_t 取出的数据大小
+ */
+uint32_t kfifo_out(struct kfifo_t *fifo, void *to, uint32_t size)
+{
+    if (unlikely(to == NULL)) // 判断目标地址是否为空
+        return 0;
+    if (unlikely(size > fifo->size)) // 判断队列中是否有这么多数据
+        return 0;
+
+    // 判断是否会发生回环
+    if (fifo->out_offset + size > fifo->total_size) // 发生回环
+    {
+        uint32_t tmp = fifo->total_size - fifo->out_offset;
+        memcpy(to, fifo->buffer + fifo->out_offset, tmp);
+        memcpy(to + tmp, fifo->buffer, size - tmp);
+        fifo->out_offset = size - tmp;
+    }
+    else // 未发生回环
+    {
+        memcpy(to, fifo->buffer + fifo->out_offset, size);
+        fifo->out_offset += size;
+    }
+
+    fifo->size -= size;
+
+    return size;
+}
+
+/**
+ * @brief 从kfifo缓冲区取出数据，但是不从队列中删除数据
+ *
+ * @param fifo 队列结构体
+ * @param to 拷贝目标地址
+ * @param size 数据大小（字节数）
+ * @return uint32_t 取出的数据大小
+ */
+uint32_t kfifo_out_peek(struct kfifo_t *fifo, void *to, uint32_t size)
+{
+    if (unlikely(to == NULL)) // 判断目标地址是否为空
+        return 0;
+    if (unlikely(size > fifo->size)) // 判断队列中是否有这么多数据
+        return 0;
+
+    // 判断是否会发生回环
+    if (fifo->out_offset + size > fifo->total_size) // 发生回环
+    {
+        uint32_t tmp = fifo->total_size - fifo->out_offset;
+        memcpy(to, fifo->buffer + fifo->out_offset, tmp);
+        memcpy(to + tmp, fifo->buffer, size - tmp);
+    }
+    else // 未发生回环
+    {
+        memcpy(to, fifo->buffer + fifo->out_offset, size);
+    }
+
+    return size;
+}
+
+/**
+ * @brief 释放通过kfifo_alloc创建的fifo缓冲区
+ *
+ * @param fifo fifo队列结构体
+ */
+void kfifo_free_alloc(struct kfifo_t *fifo)
+{
+    kfree(fifo->buffer);
+    memset(fifo, 0, sizeof(struct kfifo_t));
+}

kernel/common/kfifo.h

@@ -0,0 +1,118 @@
+#pragma once
+
+#include <stdint.h>
+
+struct kfifo_t
+{
+    uint32_t total_size; // 缓冲区总空间
+    uint32_t size;       // 元素所占的字节数
+    uint32_t in_offset;  // 入口偏移
+    uint32_t out_offset; // 出口偏移
+    void *buffer;        // 缓冲区
+} __attribute__((aligned(sizeof(long))));
+
+/**
+ * @brief 忽略kfifo队列中的所有内容，并把输入和输出偏移量都归零
+ *
+ */
+#define kfifo_reset(fifo) (void)({ \
+    (fifo)->size = 0;              \
+    (fifo)->in_offset = 0;         \
+    (fifo)->out_offset = 0;        \
+})
+
+/**
+ * @brief 忽略kfifo队列中的所有内容，并使得输出偏移量为输入偏移量
+ *
+ */
+#define kfifo_reset_out(fifo) (void)({      \
+    (fifo)->size = 0;                       \
+    (fifo)->out_offset = (fifo)->in_offset; \
+})
+
+/**
+ * @brief 获取kfifo缓冲区的最大大小
+ *
+ * @param fifo 队列结构体
+ * @return uint32_t 缓冲区最大大小
+ */
+#define kfifo_total_size(fifo) ((fifo)->total_size)
+/**
+ * @brief 获取kfifo缓冲区当前已有元素大小
+ *
+ * @param fifo 队列结构体
+ * @return uint32_t 缓冲区当前已有元素大小
+ */
+#define kfifo_size(fifo) ((fifo)->size)
+
+/**
+ * @brief 判断kfifo缓冲区当前是否为空
+ *
+ * @param fifo 队列结构体
+ * @return uint32_t 0->非空， 1->空
+ */
+#define kfifo_empty(fifo) (((fifo)->size == 0) ? 1 : 0)
+
+/**
+ * @brief 判断kfifo缓冲区当前是否为满
+ *
+ * @param fifo 队列结构体
+ * @return uint32_t 0->不满， 1->满
+ */
+#define kfifo_full(fifo) (((fifo)->size == (fifo)->total_size) ? 1 : 0)
+
+/**
+ * @brief 通过动态方式初始化kfifo缓冲队列
+ *
+ * @param fifo 队列结构体
+ * @param size 缓冲区大小
+ * @param reserved 暂时保留，请置为0
+ * @return int 错误码：成功->0
+ */
+int kfifo_alloc(struct kfifo_t *fifo, uint32_t size, uint64_t reserved);
+
+/**
+ * @brief 释放通过kfifo_alloc创建的fifo缓冲区
+ * 
+ * @param fifo fifo队列结构体
+ */
+void kfifo_free_alloc(struct kfifo_t* fifo);
+
+/**
+ * @brief 使用指定的缓冲区来初始化kfifo缓冲队列
+ *
+ * @param fifo 队列结构体
+ * @param buffer 缓冲区
+ * @param size 缓冲区大小
+ */
+void kfifo_init(struct kfifo_t *fifo, void *buffer, uint32_t size);
+
+/**
+ * @brief 向kfifo缓冲区推入数据
+ *
+ * @param fifo 队列结构体
+ * @param from 来源数据地址
+ * @param size 数据大小（字节数）
+ * @return uint32_t 推入的数据大小
+ */
+uint32_t kfifo_in(struct kfifo_t *fifo, const void *from, uint32_t size);
+
+/**
+ * @brief 从kfifo缓冲区取出数据，并从队列中删除数据
+ *
+ * @param fifo 队列结构体
+ * @param to 拷贝目标地址
+ * @param size 数据大小（字节数）
+ * @return uint32_t 取出的数据大小
+ */
+uint32_t kfifo_out(struct kfifo_t *fifo, void *to, uint32_t size);
+
+/**
+ * @brief 从kfifo缓冲区取出数据，但是不从队列中删除数据
+ *
+ * @param fifo 队列结构体
+ * @param to 拷贝目标地址
+ * @param size 数据大小（字节数）
+ * @return uint32_t 取出的数据大小
+ */
+uint32_t kfifo_out_peek(struct kfifo_t *fifo, void *to, uint32_t size);