www.project-moonshot.org Git - mech_eap.orig/blob - src/utils/wpabuf.h

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