lib/ofpbuf.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OFPBUF_H
  18 #define OFPBUF_H 1
  19
  20 #include <stddef.h>
  21 #include <stdint.h>
  22 #include "list.h"
  23 #include "packets.h"
  24 #include "util.h"
  25 #include "netdev-dpdk.h"
  26
  27 #ifdef  __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 enum OVS_PACKED_ENUM ofpbuf_source {
  32     OFPBUF_MALLOC,              /* Obtained via malloc(). */
  33     OFPBUF_STACK,               /* Un-movable stack space or static buffer. */
  34     OFPBUF_STUB,                /* Starts on stack, may expand into heap. */
  35     OFPBUF_DPDK,                /* buffer data is from DPDK allocated memory.
  36                                    ref to build_ofpbuf() in netdev-dpdk. */
  37 };
  38
  39 /* Buffer for holding arbitrary data.  An ofpbuf is automatically reallocated
  40  * as necessary if it grows too large for the available memory. */
  41 struct ofpbuf {
  42 #ifdef DPDK_NETDEV
  43     struct rte_mbuf mbuf;       /* DPDK mbuf */
  44 #else
  45     void *base;                 /* First byte of allocated space. */
  46     void *data;                 /* First byte actually in use. */
  47     uint32_t size;              /* Number of bytes in use. */
  48 #endif
  49     uint32_t allocated;         /* Number of bytes allocated. */
  50
  51     void *l2;                   /* Link-level header. */
  52     uint16_t l2_5_ofs;          /* MPLS label stack offset from l2, or
  53                                  * UINT16_MAX */
  54     uint16_t l3_ofs;            /* Network-level header offset from l2, or
  55                                  * UINT16_MAX. */
  56     uint16_t l4_ofs;            /* Transport-level header offset from l2, or
  57                                    UINT16_MAX. */
  58     enum ofpbuf_source source;  /* Source of memory allocated as 'base'. */
  59     struct list list_node;      /* Private list element for use by owner. */
  60 };
  61
  62 static inline void * ofpbuf_data(const struct ofpbuf *);
  63 static inline void ofpbuf_set_data(struct ofpbuf *, void *);
  64 static inline void * ofpbuf_base(const struct ofpbuf *);
  65 static inline void ofpbuf_set_base(struct ofpbuf *, void *);
  66
  67 static inline uint32_t ofpbuf_size(const struct ofpbuf *);
  68 static inline void ofpbuf_set_size(struct ofpbuf *, uint32_t);
  69
  70 void * ofpbuf_resize_l2(struct ofpbuf *, int increment);
  71 void * ofpbuf_resize_l2_5(struct ofpbuf *, int increment);
  72 static inline void * ofpbuf_l2_5(const struct ofpbuf *);
  73 static inline void ofpbuf_set_l2_5(struct ofpbuf *, void *);
  74 static inline void * ofpbuf_l3(const struct ofpbuf *);
  75 static inline void ofpbuf_set_l3(struct ofpbuf *, void *);
  76 static inline void * ofpbuf_l4(const struct ofpbuf *);
  77 static inline void ofpbuf_set_l4(struct ofpbuf *, void *);
  78 static inline size_t ofpbuf_l4_size(const struct ofpbuf *);
  79 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *);
  80 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *);
  81 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *);
  82 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *);
  83
  84 void ofpbuf_use(struct ofpbuf *, void *, size_t);
  85 void ofpbuf_use_stack(struct ofpbuf *, void *, size_t);
  86 void ofpbuf_use_stub(struct ofpbuf *, void *, size_t);
  87 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
  88
  89 void ofpbuf_init_dpdk(struct ofpbuf *b, size_t allocated);
  90
  91 void ofpbuf_init(struct ofpbuf *, size_t);
  92 void ofpbuf_uninit(struct ofpbuf *);
  93 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *);
  94 void ofpbuf_reinit(struct ofpbuf *, size_t);
  95
  96 struct ofpbuf *ofpbuf_new(size_t);
  97 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
  98 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
  99 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
 100                                           size_t headroom);
 101 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
 102 struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t,
 103                                                size_t headroom);
 104 static inline void ofpbuf_delete(struct ofpbuf *);
 105
 106 static inline void *ofpbuf_at(const struct ofpbuf *, size_t offset,
 107                               size_t size);
 108 static inline void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset,
 109                                      size_t size);
 110 static inline void *ofpbuf_tail(const struct ofpbuf *);
 111 static inline void *ofpbuf_end(const struct ofpbuf *);
 112
 113 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
 114 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
 115 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
 116 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
 117 void ofpbuf_reserve(struct ofpbuf *, size_t);
 118 void ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
 119                                   size_t tailroom);
 120 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
 121 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
 122 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
 123
 124 static inline size_t ofpbuf_headroom(const struct ofpbuf *);
 125 static inline size_t ofpbuf_tailroom(const struct ofpbuf *);
 126 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
 127 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
 128 void ofpbuf_trim(struct ofpbuf *);
 129 void ofpbuf_padto(struct ofpbuf *, size_t);
 130 void ofpbuf_shift(struct ofpbuf *, int);
 131
 132 static inline void ofpbuf_clear(struct ofpbuf *);
 133 static inline void *ofpbuf_pull(struct ofpbuf *, size_t);
 134 static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
 135
 136 void *ofpbuf_steal_data(struct ofpbuf *);
 137
 138 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
 139 static inline struct ofpbuf *ofpbuf_from_list(const struct list *);
 140 void ofpbuf_list_delete(struct list *);
 141 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
 142
 143 \f
 144 /* Returns a pointer that may be passed to free() to accomplish the same thing
 145  * as ofpbuf_uninit(b).  The return value is a null pointer if ofpbuf_uninit()
 146  * would not free any memory. */
 147 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *b)
 148 {
 149     /* XXX: If 'source' is OFPBUF_DPDK memory gets leaked! */
 150     return b && b->source == OFPBUF_MALLOC ? ofpbuf_base(b) : NULL;
 151 }
 152
 153 /* Frees memory that 'b' points to, as well as 'b' itself. */
 154 static inline void ofpbuf_delete(struct ofpbuf *b)
 155 {
 156     if (b) {
 157         if (b->source == OFPBUF_DPDK) {
 158             free_dpdk_buf(b);
 159             return;
 160         }
 161
 162         ofpbuf_uninit(b);
 163         free(b);
 164     }
 165 }
 166
 167 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 168  * byte 'offset'.  Otherwise, returns a null pointer. */
 169 static inline void *ofpbuf_at(const struct ofpbuf *b, size_t offset,
 170                               size_t size)
 171 {
 172     return offset + size <= ofpbuf_size(b) ? (char *) ofpbuf_data(b) + offset : NULL;
 173 }
 174
 175 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 176  * 'offset + size' bytes of data. */
 177 static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
 178                                      size_t size)
 179 {
 180     ovs_assert(offset + size <= ofpbuf_size(b));
 181     return ((char *) ofpbuf_data(b)) + offset;
 182 }
 183
 184 /* Returns the byte following the last byte of data in use in 'b'. */
 185 static inline void *ofpbuf_tail(const struct ofpbuf *b)
 186 {
 187     return (char *) ofpbuf_data(b) + ofpbuf_size(b);
 188 }
 189
 190 /* Returns the byte following the last byte allocated for use (but not
 191  * necessarily in use) by 'b'. */
 192 static inline void *ofpbuf_end(const struct ofpbuf *b)
 193 {
 194     return (char *) ofpbuf_base(b) + b->allocated;
 195 }
 196
 197 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 198  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
 199  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
 200  * headroom is 0.) */
 201 static inline size_t ofpbuf_headroom(const struct ofpbuf *b)
 202 {
 203     return (char*)ofpbuf_data(b) - (char*)ofpbuf_base(b);
 204 }
 205
 206 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
 207  * 'b' before the ofpbuf must be reallocated. */
 208 static inline size_t ofpbuf_tailroom(const struct ofpbuf *b)
 209 {
 210     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
 211 }
 212
 213 /* Clears any data from 'b'. */
 214 static inline void ofpbuf_clear(struct ofpbuf *b)
 215 {
 216     ofpbuf_set_data(b, ofpbuf_base(b));
 217     ofpbuf_set_size(b, 0);
 218 }
 219
 220 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 221  * 'size' bytes of data.  Returns the first byte of data removed. */
 222 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
 223 {
 224     void *data = ofpbuf_data(b);
 225     ovs_assert(ofpbuf_size(b) >= size);
 226     ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
 227     ofpbuf_set_size(b, ofpbuf_size(b) - size);
 228     return data;
 229 }
 230
 231 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 232  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 233  * null pointer without modifying 'b'. */
 234 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 235 {
 236     return ofpbuf_size(b) >= size ? ofpbuf_pull(b, size) : NULL;
 237 }
 238
 239 static inline struct ofpbuf *ofpbuf_from_list(const struct list *list)
 240 {
 241     return CONTAINER_OF(list, struct ofpbuf, list_node);
 242 }
 243
 244 static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
 245 {
 246     return ofpbuf_size(a) == ofpbuf_size(b) &&
 247            memcmp(ofpbuf_data(a), ofpbuf_data(b), ofpbuf_size(a)) == 0;
 248 }
 249
 250 static inline void * ofpbuf_l2_5(const struct ofpbuf *b)
 251 {
 252     return b->l2_5_ofs != UINT16_MAX ? (char *)b->l2 + b->l2_5_ofs : NULL;
 253 }
 254
 255 static inline void ofpbuf_set_l2_5(struct ofpbuf *b, void *l2_5)
 256 {
 257     b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->l2 : UINT16_MAX;
 258 }
 259
 260 static inline void * ofpbuf_l3(const struct ofpbuf *b)
 261 {
 262     return b->l3_ofs != UINT16_MAX ? (char *)b->l2 + b->l3_ofs : NULL;
 263 }
 264
 265 static inline void ofpbuf_set_l3(struct ofpbuf *b, void *l3)
 266 {
 267     b->l3_ofs = l3 ? (char *)l3 - (char *)b->l2 : UINT16_MAX;
 268 }
 269
 270 static inline void * ofpbuf_l4(const struct ofpbuf *b)
 271 {
 272     return b->l4_ofs != UINT16_MAX ? (char *)b->l2 + b->l4_ofs : NULL;
 273 }
 274
 275 static inline void ofpbuf_set_l4(struct ofpbuf *b, void *l4)
 276 {
 277     b->l4_ofs = l4 ? (char *)l4 - (char *)b->l2 : UINT16_MAX;
 278 }
 279
 280 static inline size_t ofpbuf_l4_size(const struct ofpbuf *b)
 281 {
 282     return b->l4_ofs != UINT16_MAX
 283         ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_l4(b) : 0;
 284 }
 285
 286 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
 287 {
 288     size_t l4_size = ofpbuf_l4_size(b);
 289
 290     if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
 291         struct tcp_header *tcp = ofpbuf_l4(b);
 292         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
 293
 294         if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
 295             return (const char *)tcp + tcp_len;
 296         }
 297     }
 298     return NULL;
 299 }
 300
 301 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *b)
 302 {
 303     return OVS_LIKELY(ofpbuf_l4_size(b) >= UDP_HEADER_LEN)
 304         ? (const char *)ofpbuf_l4(b) + UDP_HEADER_LEN : NULL;
 305 }
 306
 307 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *b)
 308 {
 309     return OVS_LIKELY(ofpbuf_l4_size(b) >= SCTP_HEADER_LEN)
 310         ? (const char *)ofpbuf_l4(b) + SCTP_HEADER_LEN : NULL;
 311 }
 312
 313 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *b)
 314 {
 315     return OVS_LIKELY(ofpbuf_l4_size(b) >= ICMP_HEADER_LEN)
 316         ? (const char *)ofpbuf_l4(b) + ICMP_HEADER_LEN : NULL;
 317 }
 318
 319 #ifdef DPDK_NETDEV
 320 static inline void * ofpbuf_data(const struct ofpbuf *b)
 321 {
 322     return b->mbuf.pkt.data;
 323 }
 324
 325 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
 326 {
 327     b->mbuf.pkt.data = d;
 328 }
 329
 330 static inline void * ofpbuf_base(const struct ofpbuf *b)
 331 {
 332     return b->mbuf.buf_addr;
 333 }
 334
 335 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
 336 {
 337     b->mbuf.buf_addr = d;
 338 }
 339
 340 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
 341 {
 342     return b->mbuf.pkt.pkt_len;
 343 }
 344
 345 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
 346 {
 347     b->mbuf.pkt.data_len = v;    /* Current seg length. */
 348     b->mbuf.pkt.pkt_len = v;     /* Total length of all segments linked to
 349                                   * this segment. */
 350 }
 351
 352 #else
 353 static inline void * ofpbuf_data(const struct ofpbuf *b)
 354 {
 355     return b->data;
 356 }
 357
 358 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
 359 {
 360     b->data = d;
 361 }
 362
 363 static inline void * ofpbuf_base(const struct ofpbuf *b)
 364 {
 365     return b->base;
 366 }
 367
 368 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
 369 {
 370     b->base = d;
 371 }
 372
 373 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
 374 {
 375     return b->size;
 376 }
 377
 378 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
 379 {
 380     b->size = v;
 381 }
 382 #endif
 383
 384 #ifdef  __cplusplus
 385 }
 386 #endif
 387
 388 #endif /* ofpbuf.h */