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
  45
  46 /**
  47  * wpabuf_size - Get the currently allocated size of a wpabuf buffer
  48  * @buf: wpabuf buffer
  49  * Returns: Currently allocated size of the buffer
  50  */
  51 static inline size_t wpabuf_size(const struct wpabuf *buf)
  52 {
  53         return buf->size;
  54 }
  55
  56 /**
  57  * wpabuf_len - Get the current length of a wpabuf buffer data
  58  * @buf: wpabuf buffer
  59  * Returns: Currently used length of the buffer
  60  */
  61 static inline size_t wpabuf_len(const struct wpabuf *buf)
  62 {
  63         return buf->used;
  64 }
  65
  66 /**
  67  * wpabuf_tailroom - Get size of available tail room in the end of the buffer
  68  * @buf: wpabuf buffer
  69  * Returns: Tail room (in bytes) of available space in the end of the buffer
  70  */
  71 static inline size_t wpabuf_tailroom(const struct wpabuf *buf)
  72 {
  73         return buf->size - buf->used;
  74 }
  75
  76 /**
  77  * wpabuf_head - Get pointer to the head of the buffer data
  78  * @buf: wpabuf buffer
  79  * Returns: Pointer to the head of the buffer data
  80  */
  81 static inline const void * wpabuf_head(const struct wpabuf *buf)
  82 {
  83         return buf->buf;
  84 }
  85
  86 static inline const u8 * wpabuf_head_u8(const struct wpabuf *buf)
  87 {
  88         return (const u8 *)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  */
  96 static inline void * wpabuf_mhead(struct wpabuf *buf)
  97 {
  98         return buf->buf;
  99 }
 100
 101 static inline u8 * wpabuf_mhead_u8(struct wpabuf *buf)
 102 {
 103         return (u8 *)wpabuf_mhead(buf);
 104 }
 105
 106 static inline void wpabuf_put_u8(struct wpabuf *buf, u8 data)
 107 {
 108         u8 *pos = (u8 *)wpabuf_put(buf, 1);
 109         *pos = data;
 110 }
 111
 112 static inline void wpabuf_put_le16(struct wpabuf *buf, u16 data)
 113 {
 114         u8 *pos = (u8 *)wpabuf_put(buf, 2);
 115         WPA_PUT_LE16(pos, data);
 116 }
 117
 118 static inline void wpabuf_put_le32(struct wpabuf *buf, u32 data)
 119 {
 120         u8 *pos = (u8 *)wpabuf_put(buf, 4);
 121         WPA_PUT_LE32(pos, data);
 122 }
 123
 124 static inline void wpabuf_put_be16(struct wpabuf *buf, u16 data)
 125 {
 126         u8 *pos = (u8 *)wpabuf_put(buf, 2);
 127         WPA_PUT_BE16(pos, data);
 128 }
 129
 130 static inline void wpabuf_put_be24(struct wpabuf *buf, u32 data)
 131 {
 132         u8 *pos = (u8 *)wpabuf_put(buf, 3);
 133         WPA_PUT_BE24(pos, data);
 134 }
 135
 136 static inline void wpabuf_put_be32(struct wpabuf *buf, u32 data)
 137 {
 138         u8 *pos = (u8 *)wpabuf_put(buf, 4);
 139         WPA_PUT_BE32(pos, data);
 140 }
 141
 142 static inline void wpabuf_put_data(struct wpabuf *buf, const void *data,
 143                                    size_t len)
 144 {
 145         if (data)
 146                 os_memcpy(wpabuf_put(buf, len), data, len);
 147 }
 148
 149 static inline void wpabuf_put_buf(struct wpabuf *dst,
 150                                   const struct wpabuf *src)
 151 {
 152         wpabuf_put_data(dst, wpabuf_head(src), wpabuf_len(src));
 153 }
 154
 155 static inline void wpabuf_set(struct wpabuf *buf, const void *data, size_t len)
 156 {
 157         buf->buf = (u8 *) data;
 158         buf->flags = WPABUF_FLAG_EXT_DATA;
 159         buf->size = buf->used = len;
 160 }
 161
 162 static inline void wpabuf_put_str(struct wpabuf *dst, const char *str)
 163 {
 164         wpabuf_put_data(dst, str, os_strlen(str));
 165 }
 166
 167 #ifdef __cplusplus
 168 }
 169 #endif
 170
 171 #endif /* WPABUF_H */