wpabuf.h 3.7 KB

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