1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
* Circular buffer implementation.
* Copyright (C) 2017 Cumulus Networks
* Quentin Young
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; see the file COPYING; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _FRR_RINGBUF_H_
#define _FRR_RINGBUF_H_
#include <zebra.h>
#include <stdint.h>
#include "memory.h"
struct ringbuf {
size_t size;
ssize_t start;
ssize_t end;
bool empty;
uint8_t *data;
};
/*
* Creates a new ring buffer.
*
* @param size buffer size, in bytes
* @return the newly created buffer
*/
struct ringbuf *ringbuf_new(size_t size);
/*
* Deletes a ring buffer and frees all associated resources.
*
* @param buf the ring buffer to destroy
*/
void ringbuf_del(struct ringbuf *buf);
/*
* Get amount of data left to read from the buffer.
*
* @return number of readable bytes
*/
size_t ringbuf_remain(struct ringbuf *buf);
/*
* Get amount of space left to write to the buffer
*
* @return number of writeable bytes
*/
size_t ringbuf_space(struct ringbuf *buf);
/*
* Put data into the ring buffer.
*
* @param data the data to put in the buffer
* @param size how much of data to put in
* @return number of bytes written; will be less than size if there was not
* enough space
*/
size_t ringbuf_put(struct ringbuf *buf, const void *data, size_t size);
/*
* Get data from the ring buffer.
*
* @param data where to put the data
* @param size how much of data to get
* @return number of bytes read into data; will be less than size if there was
* not enough data to read
*/
size_t ringbuf_get(struct ringbuf *buf, void *data, size_t size);
/*
* Peek data from the ring buffer.
*
* @param offset where to get the data from, in bytes offset from the
* start of the data
* @param data where to put the data
* @param size how much data to get
* @return number of bytes read into data; will be less than size
* if there was not enough data to read; will be -1 if the
* offset exceeds the amount of data left in the ring
* buffer
*/
size_t ringbuf_peek(struct ringbuf *buf, size_t offset, void *data,
size_t size);
/*
* Copy data from one ringbuf to another.
*
* @param to destination ringbuf
* @param from source ringbuf
* @param size how much data to copy
* @return amount of data copied
*/
size_t ringbuf_copy(struct ringbuf *to, struct ringbuf *from, size_t size);
/*
* Reset buffer. Does not wipe.
*
* @param buf
*/
void ringbuf_reset(struct ringbuf *buf);
/*
* Reset buffer. Wipes.
*
* @param buf
*/
void ringbuf_wipe(struct ringbuf *buf);
#endif /* _FRR_RINGBUF_H_ */
|
