libeap/src/utils/wpabuf.h

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