OpenVPN
circ_list.h
Go to the documentation of this file.
1 /*
2  * OpenVPN -- An application to securely tunnel IP networks
3  * over a single 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-2018 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, write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23 
24 #ifndef CIRC_LIST_H
25 #define CIRC_LIST_H
26 
27 #include "basic.h"
28 #include "integer.h"
29 #include "error.h"
30 
31 #define CIRC_LIST(name, type) \
32  struct name { \
33  int x_head; \
34  int x_size; \
35  int x_cap; \
36  int x_sizeof; \
37  type x_list[EMPTY_ARRAY_SIZE]; \
38  }
39 
40 #define CIRC_LIST_PUSH(obj, item) \
41  { \
42  (obj)->x_head = modulo_add((obj)->x_head, -1, (obj)->x_cap); \
43  (obj)->x_list[(obj)->x_head] = (item); \
44  (obj)->x_size = min_int((obj)->x_size + 1, (obj)->x_cap); \
45  }
46 
47 #define CIRC_LIST_SIZE(obj) \
48  ((obj)->x_size)
49 
50 #define CIRC_LIST_INDEX(obj, index) \
51  modulo_add((obj)->x_head, \
52  index_verify((index), (obj)->x_size, __FILE__, __LINE__), \
53  (obj)->x_cap)
54 
55 #define CIRC_LIST_ITEM(obj, index) \
56  ((obj)->x_list[CIRC_LIST_INDEX((obj), (index))])
57 
58 #define CIRC_LIST_RESET(obj) \
59  { \
60  (obj)->x_head = 0; \
61  (obj)->x_size = 0; \
62  }
63 
64 #define CIRC_LIST_ALLOC(dest, list_type, size) \
65  { \
66  const int so = sizeof(list_type) + sizeof((dest)->x_list[0]) * (size); \
67  (dest) = (list_type *) malloc(so); \
68  check_malloc_return(dest); \
69  memset((dest), 0, so); \
70  (dest)->x_cap = size; \
71  (dest)->x_sizeof = so; \
72  }
73 
74 #define CIRC_LIST_FREE(dest) \
75  free(dest)
76 
77 #endif /* ifndef CIRC_LIST_H */