C-基于环形队列的生产消费模型

v1.0 基于数组的简单环形队列 和 v2.0 基于堆的简单环形队列 的侧重点在于理解环形队列的核心思想。要想将ring queue变得更通过，需要在数据结构和接口设计上再花点功夫。每个工程师都可以自行设计，这里，我给出一种实现方式同时也引出"生产者-消费者"的概念，抛砖引玉。

目录结构

|-- bin
|-- build
|-- CMakeLists.txt
|-- inc
|   `-- ring_queue.h
|-- readme.md
|-- src
|   `-- ring_queue.c
`-- test
    |-- simple_ring_queue.c #简单的接口验证
    `-- single_pro_single_con.c　#简单的单生产者单消费者示例

ring_queue.h

typedef struct _node_s
{
    int data;
}node_t;

typedef struct _rq_s
{
    int w;          //write index
    int r;          //read index
    int node_nums;  //node numbers
    node_t* pd;     //data pointer
}rq_t;

ring_queue.c

int is_empty(rq_t* rq)
{
    return rq->w == rq->r;
}

int is_full(rq_t* rq)
{
    return (rq->w+1)%rq->node_nums == rq->r;
}

int enqueue(rq_t* rq, node_t* node)
{
    if (is_full(rq))
    {
        printf("queue is full...\n");
        return 0;
    }

    rq->pd[rq->w].data = node->data;
    rq->w = (rq->w+1)%rq->node_nums;
    return 1;
}

int dequeue(rq_t* rq, node_t* node)
{
    if (is_empty(rq))
    {
        printf("queue is empty...\n");
        return 0;
    }

    node->data = rq->pd[rq->r].data;
    rq->r = (rq->r+1)%rq->node_nums;

    return 1;
}

rq_t* create_ring_queue(int node_nums)
{
    rq_t* rq = NULL;
    
    rq = (rq_t*)malloc(sizeof(rq_t));

    rq->node_nums = node_nums;
    rq->pd = (node_t*)malloc(node_nums*sizeof(node_t));

    return rq;
}

int destroy_ring_queue(rq_t* rq)
{
   free(rq->pd); 
   free(rq);
   return 0;
}

通过数据结构和相应API的设计，ring queue更加的模块化。业务功能如果需要使用环形队列，那么可以直接使用以上的API，数据结构可以让业务要求做适当修改。

下面给出两个示例，展示怎样使用ring queue的API。

simple_ring_queue.c

/***********************************************************************
*   Copyright (C) 2020 junfu0903@aliyun.com All rights reserved.
*   
*   File Name: simple_ring_queue.c 
*   Brief:      
*   Author: frank
*   Email: junfu0903@aliyun.com
*   Version: 3.0
*   Created Time:2020-09-10 08:21:50
*   Blog: https://blog.csdn.net/weixin_43708622
*   Gitee: https://gitee.com/yellow_mamba/c_tutorial
*   
***********************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include "ring_queue.h"

int main()
{
	int i = 0;
    node_t node;

    printf("sizeof(int)=%ld\n", sizeof(int));
    printf("sizeof(node_t*)=%ld\n", sizeof(node_t*));
    printf("sizeof(rq_t)=%ld\n", sizeof(rq_t));

    rq_t* rq = create_ring_queue(5);
    if (NULL == rq)
    {
        printf("create_ring_queue failed\n");
        return -1;
    }

	for (i = 0; i < rq->node_nums; i++)
	{
        node.data = i; 
		if (enqueue(rq, &node))
			printf("queue[%d]=%d\n", i, rq->pd[i].data);
	}

	for (i = 0; i < rq->node_nums; i++)
	{
		if (dequeue(rq, &node))	
			printf("val=%d\n", node.data);
	}
	printf("w=%d, r=%d\n", rq->w, rq->r);

	for (i = 0; i < rq->node_nums; i++)
	{
        node.data = i; 
		if (enqueue(rq, &node))
			printf("queue[%d]=%d\n", i, rq->pd[i].data);
	}

	for (i = 0; i < rq->node_nums; i++)
	{
		if (dequeue(rq, &node))	
			printf("val=%d\n", node.data);
	}

	printf("w=%d, r=%d\n", rq->w, rq->r);

    destroy_ring_queue(rq);
	return 0;
}

single_pro_single_con.c

本例中使用了多线程技术，生产者一个线程，消费者一个线程

/***********************************************************************
*   Copyright (C) 2020 junfu0903@aliyun.com All rights reserved.
*   
*   File Name: single_pro_single_con.c 
*   Brief:      
*   Author: frank
*   Email: junfu0903@aliyun.com
*   Version: 3.0
*   Created Time:2020-09-10 08:20:28
*   Blog: https://blog.csdn.net/weixin_43708622
*   Gitee: https://gitee.com/yellow_mamba/c_tutorial
*   
***********************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <pthread.h>
#include "ring_queue.h"

void* do_produce(void* argv)
{
    int i = 0;
    node_t node;
    rq_t* rq = (rq_t*)argv;

    //for (i = 0; i < rq->node_nums; i++)
    while(1)
	{
        node.data = i; 
		if (enqueue(rq, &node))
        {
			printf("enqueue node:%d\n", i);
            i++;
        }
        else
            sleep(1);
	}

    return NULL;
}

void* do_consume(void* argv)
{
    //int i = 0;
    node_t node;
    rq_t* rq = (rq_t*)argv;
    
    //for (i = 0; i < rq->node_nums; i++)
    while(1)
	{
		if (dequeue(rq, &node))	
			printf("dequeue val=%d\n", node.data);
        else
            sleep(1);
	}
    return NULL;
}

int main(int argc, char** argv)
{
    pthread_t producer;
    pthread_t consumer;

    rq_t* rq = create_ring_queue(5);
    if (NULL == rq)
    {
        printf("create_ring_queue failed\n");
        return -1;
    }

    pthread_create(&producer, NULL, do_produce, rq);
    pthread_create(&consumer, NULL, do_consume, rq);

    pthread_join(producer, NULL);
    pthread_join(consumer, NULL);

    destroy_ring_queue(rq);
    return 0;
}

源码路径：https://gitee.com/yellow_mamba/c_tutorial/tree/master/queue/v3.0
QQ讨论群：679603305