OpenVPN
mbuf.h
Go to the documentation of this file.
1/*
2 * OpenVPN -- An application to securely tunnel IP networks
3 * over a single TCP/UDP port, with support for SSL/TLS-based
4 * session authentication and key exchange,
5 * packet encryption, packet authentication, and
6 * packet compression.
7 *
8 * Copyright (C) 2002-2025 OpenVPN Inc <sales@openvpn.net>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, see <https://www.gnu.org/licenses/>.
21 */
22
23#ifndef MBUF_H
24#define MBUF_H
25
26/*
27 * Handle both multicast and broadcast functions.
28 */
29
30/* define this to enable special test mode */
31/*#define MBUF_TEST*/
32
33#include "basic.h"
34#include "buffer.h"
35
36struct multi_instance;
37
38#define MBUF_INDEX(head, offset, size) (((head) + (offset)) & ((size) - 1))
39
41{
42 struct buffer buf;
44
45#define MF_UNICAST (1 << 0)
46 unsigned int flags;
47};
48
50{
53};
54
56{
57 unsigned int head;
58 unsigned int len;
59 unsigned int capacity;
60 unsigned int max_queued;
62};
63
64struct mbuf_set *mbuf_init(unsigned int size);
65
66void mbuf_free(struct mbuf_set *ms);
67
68struct mbuf_buffer *mbuf_alloc_buf(const struct buffer *buf);
69
70void mbuf_free_buf(struct mbuf_buffer *mb);
71
72void mbuf_add_item(struct mbuf_set *ms, const struct mbuf_item *item);
73
74bool mbuf_extract_item(struct mbuf_set *ms, struct mbuf_item *item);
75
76void mbuf_dereference_instance(struct mbuf_set *ms, struct multi_instance *mi);
77
78static inline bool
79mbuf_defined(const struct mbuf_set *ms)
80{
81 return ms && ms->len;
82}
83
84static inline unsigned int
85mbuf_len(const struct mbuf_set *ms)
86{
87 return ms->len;
88}
89
90static inline int
92{
93 return (int)ms->max_queued;
94}
95
96struct multi_instance *mbuf_peek_dowork(struct mbuf_set *ms);
97
98static inline struct multi_instance *
100{
101 if (mbuf_defined(ms))
102 {
103 return mbuf_peek_dowork(ms);
104 }
105 else
106 {
107 return NULL;
108 }
109}
110
111#endif /* ifndef MBUF_H */
static struct multi_instance * mbuf_peek(struct mbuf_set *ms)
Definition mbuf.h:99
void mbuf_add_item(struct mbuf_set *ms, const struct mbuf_item *item)
Definition mbuf.c:88
struct mbuf_buffer * mbuf_alloc_buf(const struct buffer *buf)
Definition mbuf.c:64
static bool mbuf_defined(const struct mbuf_set *ms)
Definition mbuf.h:79
void mbuf_free_buf(struct mbuf_buffer *mb)
Definition mbuf.c:75
void mbuf_dereference_instance(struct mbuf_set *ms, struct multi_instance *mi)
Definition mbuf.c:151
static unsigned int mbuf_len(const struct mbuf_set *ms)
Definition mbuf.h:85
bool mbuf_extract_item(struct mbuf_set *ms, struct mbuf_item *item)
Definition mbuf.c:110
void mbuf_free(struct mbuf_set *ms)
Definition mbuf.c:48
struct multi_instance * mbuf_peek_dowork(struct mbuf_set *ms)
Definition mbuf.c:131
struct mbuf_set * mbuf_init(unsigned int size)
Definition mbuf.c:38
static int mbuf_maximum_queued(const struct mbuf_set *ms)
Definition mbuf.h:91
Wrapper structure for dynamically allocated memory.
Definition buffer.h:60
unsigned int flags
Definition mbuf.h:46
struct buffer buf
Definition mbuf.h:42
int refcount
Definition mbuf.h:43
struct mbuf_buffer * buffer
Definition mbuf.h:51
struct multi_instance * instance
Definition mbuf.h:52
struct mbuf_item * array
Definition mbuf.h:61
unsigned int max_queued
Definition mbuf.h:60
unsigned int head
Definition mbuf.h:57
unsigned int len
Definition mbuf.h:58
unsigned int capacity
Definition mbuf.h:59
Server-mode state structure for one single VPN tunnel.
Definition multi.h:103