]>
Commit | Line | Data |
---|---|---|
6fc6879b JM |
1 | /* |
2 | * Dynamic data buffer | |
3 | * Copyright (c) 2007, Jouni Malinen <j@w1.fi> | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License version 2 as | |
7 | * published by the Free Software Foundation. | |
8 | * | |
9 | * Alternatively, this software may be distributed under the terms of BSD | |
10 | * license. | |
11 | * | |
12 | * See README and COPYING for more details. | |
13 | */ | |
14 | ||
15 | #ifndef WPABUF_H | |
16 | #define WPABUF_H | |
17 | ||
18 | /* | |
19 | * Internal data structure for wpabuf. Please do not touch this directly from | |
20 | * elsewhere. This is only defined in header file to allow inline functions | |
21 | * from this file to access data. | |
22 | */ | |
23 | struct wpabuf { | |
24 | size_t size; /* total size of the allocated buffer */ | |
25 | size_t used; /* length of data in the buffer */ | |
26 | u8 *ext_data; /* pointer to external data; NULL if data follows | |
27 | * struct wpabuf */ | |
28 | /* optionally followed by the allocated buffer */ | |
29 | }; | |
30 | ||
31 | ||
32 | int wpabuf_resize(struct wpabuf **buf, size_t add_len); | |
33 | struct wpabuf * wpabuf_alloc(size_t len); | |
34 | struct wpabuf * wpabuf_alloc_ext_data(u8 *data, size_t len); | |
35 | struct wpabuf * wpabuf_alloc_copy(const void *data, size_t len); | |
36 | struct wpabuf * wpabuf_dup(const struct wpabuf *src); | |
37 | void wpabuf_free(struct wpabuf *buf); | |
38 | void * wpabuf_put(struct wpabuf *buf, size_t len); | |
39 | ||
40 | ||
41 | /** | |
42 | * wpabuf_size - Get the currently allocated size of a wpabuf buffer | |
43 | * @buf: wpabuf buffer | |
44 | * Returns: Currently allocated size of the buffer | |
45 | */ | |
46 | static inline size_t wpabuf_size(const struct wpabuf *buf) | |
47 | { | |
48 | return buf->size; | |
49 | } | |
50 | ||
51 | /** | |
52 | * wpabuf_len - Get the current length of a wpabuf buffer data | |
53 | * @buf: wpabuf buffer | |
54 | * Returns: Currently used length of the buffer | |
55 | */ | |
56 | static inline size_t wpabuf_len(const struct wpabuf *buf) | |
57 | { | |
58 | return buf->used; | |
59 | } | |
60 | ||
61 | /** | |
62 | * wpabuf_tailroom - Get size of available tail room in the end of the buffer | |
63 | * @buf: wpabuf buffer | |
64 | * Returns: Tail room (in bytes) of available space in the end of the buffer | |
65 | */ | |
66 | static inline size_t wpabuf_tailroom(const struct wpabuf *buf) | |
67 | { | |
68 | return buf->size - buf->used; | |
69 | } | |
70 | ||
71 | /** | |
72 | * wpabuf_head - Get pointer to the head of the buffer data | |
73 | * @buf: wpabuf buffer | |
74 | * Returns: Pointer to the head of the buffer data | |
75 | */ | |
76 | static inline const void * wpabuf_head(const struct wpabuf *buf) | |
77 | { | |
78 | if (buf->ext_data) | |
79 | return buf->ext_data; | |
80 | return buf + 1; | |
81 | } | |
82 | ||
83 | static inline const u8 * wpabuf_head_u8(const struct wpabuf *buf) | |
84 | { | |
85 | return wpabuf_head(buf); | |
86 | } | |
87 | ||
88 | /** | |
89 | * wpabuf_mhead - Get modifiable pointer to the head of the buffer data | |
90 | * @buf: wpabuf buffer | |
91 | * Returns: Pointer to the head of the buffer data | |
92 | */ | |
93 | static inline void * wpabuf_mhead(struct wpabuf *buf) | |
94 | { | |
95 | if (buf->ext_data) | |
96 | return buf->ext_data; | |
97 | return buf + 1; | |
98 | } | |
99 | ||
100 | static inline u8 * wpabuf_mhead_u8(struct wpabuf *buf) | |
101 | { | |
102 | return wpabuf_mhead(buf); | |
103 | } | |
104 | ||
105 | static inline void wpabuf_put_u8(struct wpabuf *buf, u8 data) | |
106 | { | |
107 | u8 *pos = wpabuf_put(buf, 1); | |
108 | *pos = data; | |
109 | } | |
110 | ||
111 | static inline void wpabuf_put_be16(struct wpabuf *buf, u16 data) | |
112 | { | |
113 | u8 *pos = wpabuf_put(buf, 2); | |
114 | WPA_PUT_BE16(pos, data); | |
115 | } | |
116 | ||
117 | static inline void wpabuf_put_be24(struct wpabuf *buf, u32 data) | |
118 | { | |
119 | u8 *pos = wpabuf_put(buf, 3); | |
120 | WPA_PUT_BE24(pos, data); | |
121 | } | |
122 | ||
123 | static inline void wpabuf_put_be32(struct wpabuf *buf, u32 data) | |
124 | { | |
125 | u8 *pos = wpabuf_put(buf, 4); | |
126 | WPA_PUT_BE32(pos, data); | |
127 | } | |
128 | ||
129 | static inline void wpabuf_put_data(struct wpabuf *buf, const void *data, | |
130 | size_t len) | |
131 | { | |
132 | if (data) | |
133 | os_memcpy(wpabuf_put(buf, len), data, len); | |
134 | } | |
135 | ||
136 | static inline void wpabuf_put_buf(struct wpabuf *dst, | |
137 | const struct wpabuf *src) | |
138 | { | |
139 | wpabuf_put_data(dst, wpabuf_head(src), wpabuf_len(src)); | |
140 | } | |
141 | ||
142 | static inline void wpabuf_set(struct wpabuf *buf, const void *data, size_t len) | |
143 | { | |
144 | buf->ext_data = (u8 *) data; | |
145 | buf->size = buf->used = len; | |
146 | } | |
147 | ||
148 | #endif /* WPABUF_H */ |