1/*
2 * Dynamic data buffer
3 * Copyright (c) 2007-2012, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9#ifndef WPABUF_H
10#define WPABUF_H
11
12/* wpabuf::buf is a pointer to external data */
13#define WPABUF_FLAG_EXT_DATA BIT(0)
14
15/*
16 * Internal data structure for wpabuf. Please do not touch this directly from
17 * elsewhere. This is only defined in header file to allow inline functions
18 * from this file to access data.
19 */
20struct wpabuf {
21	size_t size; /* total size of the allocated buffer */
22	size_t used; /* length of data in the buffer */
23	u8 *buf; /* pointer to the head of the buffer */
24	unsigned int flags;
25	/* optionally followed by the allocated buffer */
26};
27
28
29int wpabuf_resize(struct wpabuf **buf, size_t add_len);
30struct wpabuf * wpabuf_alloc(size_t len);
31struct wpabuf * wpabuf_alloc_ext_data(u8 *data, size_t len);
32struct wpabuf * wpabuf_alloc_copy(const void *data, size_t len);
33struct wpabuf * wpabuf_dup(const struct wpabuf *src);
34void wpabuf_free(struct wpabuf *buf);
35void wpabuf_clear_free(struct wpabuf *buf);
36void * wpabuf_put(struct wpabuf *buf, size_t len);
37struct wpabuf * wpabuf_concat(struct wpabuf *a, struct wpabuf *b);
38struct wpabuf * wpabuf_zeropad(struct wpabuf *buf, size_t len);
39void wpabuf_printf(struct wpabuf *buf, char *fmt, ...) PRINTF_FORMAT(2, 3);
40struct wpabuf * wpabuf_parse_bin(const char *buf);
41
42
43/**
44 * wpabuf_size - Get the currently allocated size of a wpabuf buffer
45 * @buf: wpabuf buffer
46 * Returns: Currently allocated size of the buffer
47 */
48static inline size_t wpabuf_size(const struct wpabuf *buf)
49{
50	return buf->size;
51}
52
53/**
54 * wpabuf_len - Get the current length of a wpabuf buffer data
55 * @buf: wpabuf buffer
56 * Returns: Currently used length of the buffer
57 */
58static inline size_t wpabuf_len(const struct wpabuf *buf)
59{
60	return buf->used;
61}
62
63/**
64 * wpabuf_tailroom - Get size of available tail room in the end of the buffer
65 * @buf: wpabuf buffer
66 * Returns: Tail room (in bytes) of available space in the end of the buffer
67 */
68static inline size_t wpabuf_tailroom(const struct wpabuf *buf)
69{
70	return buf->size - buf->used;
71}
72
73/**
74 * wpabuf_cmp - Check if two buffers contain the same data
75 * @a: wpabuf buffer
76 * @b: wpabuf buffer
77 * Returns: 0 if the two buffers contain the same data and non-zero otherwise
78 */
79static inline int wpabuf_cmp(const struct wpabuf *a, const struct wpabuf *b)
80{
81	if (!a && !b)
82		return 0;
83	if (a && b && wpabuf_size(a) == wpabuf_size(b))
84		return os_memcmp(a->buf, b->buf, wpabuf_size(a));
85	return -1;
86}
87
88/**
89 * wpabuf_head - Get pointer to the head of the buffer data
90 * @buf: wpabuf buffer
91 * Returns: Pointer to the head of the buffer data
92 */
93static inline const void * wpabuf_head(const struct wpabuf *buf)
94{
95	return buf->buf;
96}
97
98static inline const u8 * wpabuf_head_u8(const struct wpabuf *buf)
99{
100	return (const u8 *) wpabuf_head(buf);
101}
102
103/**
104 * wpabuf_mhead - Get modifiable pointer to the head of the buffer data
105 * @buf: wpabuf buffer
106 * Returns: Pointer to the head of the buffer data
107 */
108static inline void * wpabuf_mhead(struct wpabuf *buf)
109{
110	return buf->buf;
111}
112
113static inline u8 * wpabuf_mhead_u8(struct wpabuf *buf)
114{
115	return (u8 *) wpabuf_mhead(buf);
116}
117
118static inline void wpabuf_put_u8(struct wpabuf *buf, u8 data)
119{
120	u8 *pos = (u8 *) wpabuf_put(buf, 1);
121	*pos = data;
122}
123
124static inline void wpabuf_put_le16(struct wpabuf *buf, u16 data)
125{
126	u8 *pos = (u8 *) wpabuf_put(buf, 2);
127	WPA_PUT_LE16(pos, data);
128}
129
130static inline void wpabuf_put_le32(struct wpabuf *buf, u32 data)
131{
132	u8 *pos = (u8 *) wpabuf_put(buf, 4);
133	WPA_PUT_LE32(pos, data);
134}
135
136static inline void wpabuf_put_le64(struct wpabuf *buf, u64 data)
137{
138	u8 *pos = (u8 *) wpabuf_put(buf, 8);
139	WPA_PUT_LE64(pos, data);
140}
141
142static inline void wpabuf_put_be16(struct wpabuf *buf, u16 data)
143{
144	u8 *pos = (u8 *) wpabuf_put(buf, 2);
145	WPA_PUT_BE16(pos, data);
146}
147
148static inline void wpabuf_put_be24(struct wpabuf *buf, u32 data)
149{
150	u8 *pos = (u8 *) wpabuf_put(buf, 3);
151	WPA_PUT_BE24(pos, data);
152}
153
154static inline void wpabuf_put_be32(struct wpabuf *buf, u32 data)
155{
156	u8 *pos = (u8 *) wpabuf_put(buf, 4);
157	WPA_PUT_BE32(pos, data);
158}
159
160static inline void wpabuf_put_be64(struct wpabuf *buf, u64 data)
161{
162	u8 *pos = (u8 *) wpabuf_put(buf, 8);
163	WPA_PUT_BE64(pos, data);
164}
165
166static inline void wpabuf_put_data(struct wpabuf *buf, const void *data,
167				   size_t len)
168{
169	if (data)
170		os_memcpy(wpabuf_put(buf, len), data, len);
171}
172
173static inline void wpabuf_put_buf(struct wpabuf *dst,
174				  const struct wpabuf *src)
175{
176	wpabuf_put_data(dst, wpabuf_head(src), wpabuf_len(src));
177}
178
179static inline void wpabuf_set(struct wpabuf *buf, const void *data, size_t len)
180{
181	buf->buf = (u8 *) data;
182	buf->flags = WPABUF_FLAG_EXT_DATA;
183	buf->size = buf->used = len;
184}
185
186static inline void wpabuf_put_str(struct wpabuf *dst, const char *str)
187{
188	wpabuf_put_data(dst, str, os_strlen(str));
189}
190
191#endif /* WPABUF_H */
192