wpabuf.h revision 8d520ff1dc2da35cdca849e982051b86468016d8
17dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com/* 27dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * Dynamic data buffer 37dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * Copyright (c) 2007-2009, Jouni Malinen <j@w1.fi> 47dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * 57dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * This program is free software; you can redistribute it and/or modify 67dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * it under the terms of the GNU General Public License version 2 as 77dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * published by the Free Software Foundation. 87dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * 978e7b4e1b928fa69f672be3c743df6d6c3ecbcedtfarina@chromium.org * Alternatively, this software may be distributed under the terms of BSD 107dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * license. 117dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * 127dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * See README and COPYING for more details. 137dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com */ 147dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com 157dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com#ifndef WPABUF_H 167dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com#define WPABUF_H 177dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com 187dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com/* 197dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * Internal data structure for wpabuf. Please do not touch this directly from 207dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * elsewhere. This is only defined in header file to allow inline functions 217dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * from this file to access data. 227dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com */ 237dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.comstruct wpabuf { 247dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com size_t size; /* total size of the allocated buffer */ 254431e7757cfcb8cfa99535eed0e9f156dabf95c2commit-bot@chromium.org size_t used; /* length of data in the buffer */ 267dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com u8 *ext_data; /* pointer to external data; NULL if data follows 277dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com * struct wpabuf */ 287dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com /* optionally followed by the allocated buffer */ 297dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com}; 307dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com 317dfbb0720a133c0f63ac7be504f335bbcc62a291caryclark@google.com 32int wpabuf_resize(struct wpabuf **buf, size_t add_len); 33struct wpabuf * wpabuf_alloc(size_t len); 34struct wpabuf * wpabuf_alloc_ext_data(u8 *data, size_t len); 35struct wpabuf * wpabuf_alloc_copy(const void *data, size_t len); 36struct wpabuf * wpabuf_dup(const struct wpabuf *src); 37void wpabuf_free(struct wpabuf *buf); 38void * wpabuf_put(struct wpabuf *buf, size_t len); 39struct wpabuf * wpabuf_concat(struct wpabuf *a, struct wpabuf *b); 40struct wpabuf * wpabuf_zeropad(struct wpabuf *buf, size_t len); 41void wpabuf_printf(struct wpabuf *buf, char *fmt, ...) PRINTF_FORMAT(2, 3); 42 43 44/** 45 * wpabuf_size - Get the currently allocated size of a wpabuf buffer 46 * @buf: wpabuf buffer 47 * Returns: Currently allocated size of the buffer 48 */ 49static inline size_t wpabuf_size(const struct wpabuf *buf) 50{ 51 return buf->size; 52} 53 54/** 55 * wpabuf_len - Get the current length of a wpabuf buffer data 56 * @buf: wpabuf buffer 57 * Returns: Currently used length of the buffer 58 */ 59static inline size_t wpabuf_len(const struct wpabuf *buf) 60{ 61 return buf->used; 62} 63 64/** 65 * wpabuf_tailroom - Get size of available tail room in the end of the buffer 66 * @buf: wpabuf buffer 67 * Returns: Tail room (in bytes) of available space in the end of the buffer 68 */ 69static inline size_t wpabuf_tailroom(const struct wpabuf *buf) 70{ 71 return buf->size - buf->used; 72} 73 74/** 75 * wpabuf_head - Get pointer to the head of the buffer data 76 * @buf: wpabuf buffer 77 * Returns: Pointer to the head of the buffer data 78 */ 79static inline const void * wpabuf_head(const struct wpabuf *buf) 80{ 81 if (buf->ext_data) 82 return buf->ext_data; 83 return buf + 1; 84} 85 86static inline const u8 * wpabuf_head_u8(const struct wpabuf *buf) 87{ 88 return wpabuf_head(buf); 89} 90 91/** 92 * wpabuf_mhead - Get modifiable pointer to the head of the buffer data 93 * @buf: wpabuf buffer 94 * Returns: Pointer to the head of the buffer data 95 */ 96static inline void * wpabuf_mhead(struct wpabuf *buf) 97{ 98 if (buf->ext_data) 99 return buf->ext_data; 100 return buf + 1; 101} 102 103static inline u8 * wpabuf_mhead_u8(struct wpabuf *buf) 104{ 105 return wpabuf_mhead(buf); 106} 107 108static inline void wpabuf_put_u8(struct wpabuf *buf, u8 data) 109{ 110 u8 *pos = wpabuf_put(buf, 1); 111 *pos = data; 112} 113 114static inline void wpabuf_put_le16(struct wpabuf *buf, u16 data) 115{ 116 u8 *pos = wpabuf_put(buf, 2); 117 WPA_PUT_LE16(pos, data); 118} 119 120static inline void wpabuf_put_le32(struct wpabuf *buf, u32 data) 121{ 122 u8 *pos = wpabuf_put(buf, 4); 123 WPA_PUT_LE32(pos, data); 124} 125 126static inline void wpabuf_put_be16(struct wpabuf *buf, u16 data) 127{ 128 u8 *pos = wpabuf_put(buf, 2); 129 WPA_PUT_BE16(pos, data); 130} 131 132static inline void wpabuf_put_be24(struct wpabuf *buf, u32 data) 133{ 134 u8 *pos = wpabuf_put(buf, 3); 135 WPA_PUT_BE24(pos, data); 136} 137 138static inline void wpabuf_put_be32(struct wpabuf *buf, u32 data) 139{ 140 u8 *pos = wpabuf_put(buf, 4); 141 WPA_PUT_BE32(pos, data); 142} 143 144static inline void wpabuf_put_data(struct wpabuf *buf, const void *data, 145 size_t len) 146{ 147 if (data) 148 os_memcpy(wpabuf_put(buf, len), data, len); 149} 150 151static inline void wpabuf_put_buf(struct wpabuf *dst, 152 const struct wpabuf *src) 153{ 154 wpabuf_put_data(dst, wpabuf_head(src), wpabuf_len(src)); 155} 156 157static inline void wpabuf_set(struct wpabuf *buf, const void *data, size_t len) 158{ 159 buf->ext_data = (u8 *) data; 160 buf->size = buf->used = len; 161} 162 163static inline void wpabuf_put_str(struct wpabuf *dst, const char *str) 164{ 165 wpabuf_put_data(dst, str, os_strlen(str)); 166} 167 168#endif /* WPABUF_H */ 169