1 /* 2 * Dynamic data buffer 3 * Copyright (c) 2007-2009, Jouni Malinen <j (at) 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 /* 13 * Internal data structure for wpabuf. Please do not touch this directly from 14 * elsewhere. This is only defined in header file to allow inline functions 15 * from this file to access data. 16 */ 17 struct wpabuf { 18 size_t size; /* total size of the allocated buffer */ 19 size_t used; /* length of data in the buffer */ 20 u8 *ext_data; /* pointer to external data; NULL if data follows 21 * struct wpabuf */ 22 /* optionally followed by the allocated buffer */ 23 }; 24 25 26 int wpabuf_resize(struct wpabuf **buf, size_t add_len); 27 struct wpabuf * wpabuf_alloc(size_t len); 28 struct wpabuf * wpabuf_alloc_ext_data(u8 *data, size_t len); 29 struct wpabuf * wpabuf_alloc_copy(const void *data, size_t len); 30 struct wpabuf * wpabuf_dup(const struct wpabuf *src); 31 void wpabuf_free(struct wpabuf *buf); 32 void * wpabuf_put(struct wpabuf *buf, size_t len); 33 struct wpabuf * wpabuf_concat(struct wpabuf *a, struct wpabuf *b); 34 struct wpabuf * wpabuf_zeropad(struct wpabuf *buf, size_t len); 35 void wpabuf_printf(struct wpabuf *buf, char *fmt, ...) PRINTF_FORMAT(2, 3); 36 37 38 /** 39 * wpabuf_size - Get the currently allocated size of a wpabuf buffer 40 * @buf: wpabuf buffer 41 * Returns: Currently allocated size of the buffer 42 */ 43 static inline size_t wpabuf_size(const struct wpabuf *buf) 44 { 45 return buf->size; 46 } 47 48 /** 49 * wpabuf_len - Get the current length of a wpabuf buffer data 50 * @buf: wpabuf buffer 51 * Returns: Currently used length of the buffer 52 */ 53 static inline size_t wpabuf_len(const struct wpabuf *buf) 54 { 55 return buf->used; 56 } 57 58 /** 59 * wpabuf_tailroom - Get size of available tail room in the end of the buffer 60 * @buf: wpabuf buffer 61 * Returns: Tail room (in bytes) of available space in the end of the buffer 62 */ 63 static inline size_t wpabuf_tailroom(const struct wpabuf *buf) 64 { 65 return buf->size - buf->used; 66 } 67 68 /** 69 * wpabuf_head - Get pointer to the head of the buffer data 70 * @buf: wpabuf buffer 71 * Returns: Pointer to the head of the buffer data 72 */ 73 static inline const void * wpabuf_head(const struct wpabuf *buf) 74 { 75 if (buf->ext_data) 76 return buf->ext_data; 77 return buf + 1; 78 } 79 80 static inline const u8 * wpabuf_head_u8(const struct wpabuf *buf) 81 { 82 return wpabuf_head(buf); 83 } 84 85 /** 86 * wpabuf_mhead - Get modifiable pointer to the head of the buffer data 87 * @buf: wpabuf buffer 88 * Returns: Pointer to the head of the buffer data 89 */ 90 static inline void * wpabuf_mhead(struct wpabuf *buf) 91 { 92 if (buf->ext_data) 93 return buf->ext_data; 94 return buf + 1; 95 } 96 97 static inline u8 * wpabuf_mhead_u8(struct wpabuf *buf) 98 { 99 return wpabuf_mhead(buf); 100 } 101 102 static inline void wpabuf_put_u8(struct wpabuf *buf, u8 data) 103 { 104 u8 *pos = wpabuf_put(buf, 1); 105 *pos = data; 106 } 107 108 static inline void wpabuf_put_le16(struct wpabuf *buf, u16 data) 109 { 110 u8 *pos = wpabuf_put(buf, 2); 111 WPA_PUT_LE16(pos, data); 112 } 113 114 static inline void wpabuf_put_le32(struct wpabuf *buf, u32 data) 115 { 116 u8 *pos = wpabuf_put(buf, 4); 117 WPA_PUT_LE32(pos, data); 118 } 119 120 static inline void wpabuf_put_be16(struct wpabuf *buf, u16 data) 121 { 122 u8 *pos = wpabuf_put(buf, 2); 123 WPA_PUT_BE16(pos, data); 124 } 125 126 static inline void wpabuf_put_be24(struct wpabuf *buf, u32 data) 127 { 128 u8 *pos = wpabuf_put(buf, 3); 129 WPA_PUT_BE24(pos, data); 130 } 131 132 static inline void wpabuf_put_be32(struct wpabuf *buf, u32 data) 133 { 134 u8 *pos = wpabuf_put(buf, 4); 135 WPA_PUT_BE32(pos, data); 136 } 137 138 static inline void wpabuf_put_data(struct wpabuf *buf, const void *data, 139 size_t len) 140 { 141 if (data) 142 os_memcpy(wpabuf_put(buf, len), data, len); 143 } 144 145 static inline void wpabuf_put_buf(struct wpabuf *dst, 146 const struct wpabuf *src) 147 { 148 wpabuf_put_data(dst, wpabuf_head(src), wpabuf_len(src)); 149 } 150 151 static inline void wpabuf_set(struct wpabuf *buf, const void *data, size_t len) 152 { 153 buf->ext_data = (u8 *) data; 154 buf->size = buf->used = len; 155 } 156 157 static inline void wpabuf_put_str(struct wpabuf *dst, const char *str) 158 { 159 wpabuf_put_data(dst, str, os_strlen(str)); 160 } 161 162 #endif /* WPABUF_H */ 163