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  *
  42  * 'frame' and offset conventions:
  43  *
  44  * Network frames (aka "packets"): 'frame' MUST be set to the start of the
  45  *    packet, layer offsets MAY be set as appropriate for the packet.
  46  *    Additionally, we assume in many places that the 'frame' and 'data' are
  47  *    the same for packets.
  48  *
  49  * OpenFlow messages: 'frame' points to the start of the OpenFlow
  50  *    header, while 'l3_ofs' is the length of the OpenFlow header.
  51  *    When parsing, the 'data' will move past these, as data is being
  52  *    pulled from the OpenFlow message.
  53  *
  54  * Actions: When encoding OVS action lists, the 'frame' is used
  55  *    as a pointer to the beginning of the current action (see ofpact_put()).
  56  *
  57  * rconn: Reuses 'frame' as a private pointer while queuing.
  58  */
  59 struct ofpbuf {
  60 #ifdef DPDK_NETDEV
  61     struct rte_mbuf mbuf;       /* DPDK mbuf */
  62 #else
  63     void *base_;                 /* First byte of allocated space. */
  64     void *data_;                 /* First byte actually in use. */
  65     uint32_t size_;              /* Number of bytes in use. */
  66 #endif
  67     uint32_t allocated;         /* Number of bytes allocated. */
  68
  69     void *frame;                /* Packet frame start, or NULL. */
  70     enum ofpbuf_source source;  /* Source of memory allocated as 'base'. */
  71     uint8_t l2_pad_size;        /* Detected l2 padding size.
  72                                  * Padding is non-pullable. */
  73     uint16_t l2_5_ofs;          /* MPLS label stack offset from 'frame', or
  74                                  * UINT16_MAX */
  75     uint16_t l3_ofs;            /* Network-level header offset from 'frame',
  76                                    or UINT16_MAX. */
  77     uint16_t l4_ofs;            /* Transport-level header offset from 'frame',
  78                                    or UINT16_MAX. */
  79     struct ovs_list list_node;  /* Private list element for use by owner. */
  80 };
  81
  82 static inline void * ofpbuf_data(const struct ofpbuf *);
  83 static inline void ofpbuf_set_data(struct ofpbuf *, void *);
  84 static inline void * ofpbuf_base(const struct ofpbuf *);
  85 static inline void ofpbuf_set_base(struct ofpbuf *, void *);
  86
  87 static inline uint32_t ofpbuf_size(const struct ofpbuf *);
  88 static inline void ofpbuf_set_size(struct ofpbuf *, uint32_t);
  89
  90 void * ofpbuf_resize_l2(struct ofpbuf *, int increment);
  91 void * ofpbuf_resize_l2_5(struct ofpbuf *, int increment);
  92 static inline void * ofpbuf_l2(const struct ofpbuf *);
  93 static inline void ofpbuf_set_frame(struct ofpbuf *, void *);
  94 static inline uint8_t ofpbuf_l2_pad_size(const struct ofpbuf *);
  95 static inline void ofpbuf_set_l2_pad_size(struct ofpbuf *, uint8_t);
  96 static inline void * ofpbuf_l2_5(const struct ofpbuf *);
  97 static inline void ofpbuf_set_l2_5(struct ofpbuf *, void *);
  98 static inline void * ofpbuf_l3(const struct ofpbuf *);
  99 static inline void ofpbuf_set_l3(struct ofpbuf *, void *);
 100 static inline void * ofpbuf_l4(const struct ofpbuf *);
 101 static inline void ofpbuf_set_l4(struct ofpbuf *, void *);
 102 static inline size_t ofpbuf_l4_size(const struct ofpbuf *);
 103 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *);
 104 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *);
 105 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *);
 106 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *);
 107
 108 void ofpbuf_use(struct ofpbuf *, void *, size_t);
 109 void ofpbuf_use_stack(struct ofpbuf *, void *, size_t);
 110 void ofpbuf_use_stub(struct ofpbuf *, void *, size_t);
 111 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
 112
 113 void ofpbuf_init_dpdk(struct ofpbuf *b, size_t allocated);
 114
 115 void ofpbuf_init(struct ofpbuf *, size_t);
 116 void ofpbuf_uninit(struct ofpbuf *);
 117 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *);
 118 void ofpbuf_reinit(struct ofpbuf *, size_t);
 119
 120 struct ofpbuf *ofpbuf_new(size_t);
 121 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
 122 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
 123 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
 124                                           size_t headroom);
 125 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
 126 struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t,
 127                                                size_t headroom);
 128 static inline void ofpbuf_delete(struct ofpbuf *);
 129
 130 static inline void *ofpbuf_at(const struct ofpbuf *, size_t offset,
 131                               size_t size);
 132 static inline void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset,
 133                                      size_t size);
 134 static inline void *ofpbuf_tail(const struct ofpbuf *);
 135 static inline void *ofpbuf_end(const struct ofpbuf *);
 136
 137 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
 138 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
 139 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
 140 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
 141 void ofpbuf_reserve(struct ofpbuf *, size_t);
 142 void ofpbuf_reserve_with_tailroom(struct ofpbuf *b, size_t headroom,
 143                                   size_t tailroom);
 144 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
 145 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
 146 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
 147
 148 static inline size_t ofpbuf_headroom(const struct ofpbuf *);
 149 static inline size_t ofpbuf_tailroom(const struct ofpbuf *);
 150 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
 151 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
 152 void ofpbuf_trim(struct ofpbuf *);
 153 void ofpbuf_padto(struct ofpbuf *, size_t);
 154 void ofpbuf_shift(struct ofpbuf *, int);
 155
 156 static inline void ofpbuf_clear(struct ofpbuf *);
 157 static inline void *ofpbuf_pull(struct ofpbuf *, size_t);
 158 static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
 159
 160 void *ofpbuf_steal_data(struct ofpbuf *);
 161
 162 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
 163 static inline struct ofpbuf *ofpbuf_from_list(const struct ovs_list *);
 164 void ofpbuf_list_delete(struct ovs_list *);
 165 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
 166
 167 \f
 168 /* Returns a pointer that may be passed to free() to accomplish the same thing
 169  * as ofpbuf_uninit(b).  The return value is a null pointer if ofpbuf_uninit()
 170  * would not free any memory. */
 171 static inline void *ofpbuf_get_uninit_pointer(struct ofpbuf *b)
 172 {
 173     /* XXX: If 'source' is OFPBUF_DPDK memory gets leaked! */
 174     return b && b->source == OFPBUF_MALLOC ? ofpbuf_base(b) : NULL;
 175 }
 176
 177 /* Frees memory that 'b' points to, as well as 'b' itself. */
 178 static inline void ofpbuf_delete(struct ofpbuf *b)
 179 {
 180     if (b) {
 181         if (b->source == OFPBUF_DPDK) {
 182             /* If this ofpbuf was allocated by DPDK it must have been
 183              * created as a dpif_packet */
 184             free_dpdk_buf((struct dpif_packet*) b);
 185             return;
 186         }
 187
 188         ofpbuf_uninit(b);
 189         free(b);
 190     }
 191 }
 192
 193 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 194  * byte 'offset'.  Otherwise, returns a null pointer. */
 195 static inline void *ofpbuf_at(const struct ofpbuf *b, size_t offset,
 196                               size_t size)
 197 {
 198     return offset + size <= ofpbuf_size(b) ? (char *) ofpbuf_data(b) + offset : NULL;
 199 }
 200
 201 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 202  * 'offset + size' bytes of data. */
 203 static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
 204                                      size_t size)
 205 {
 206     ovs_assert(offset + size <= ofpbuf_size(b));
 207     return ((char *) ofpbuf_data(b)) + offset;
 208 }
 209
 210 /* Returns a pointer to byte following the last byte of data in use in 'b'. */
 211 static inline void *ofpbuf_tail(const struct ofpbuf *b)
 212 {
 213     return (char *) ofpbuf_data(b) + ofpbuf_size(b);
 214 }
 215
 216 /* Returns a pointer to byte following the last byte allocated for use (but
 217  * not necessarily in use) in 'b'. */
 218 static inline void *ofpbuf_end(const struct ofpbuf *b)
 219 {
 220     return (char *) ofpbuf_base(b) + b->allocated;
 221 }
 222
 223 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 224  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
 225  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
 226  * headroom is 0.) */
 227 static inline size_t ofpbuf_headroom(const struct ofpbuf *b)
 228 {
 229     return (char*)ofpbuf_data(b) - (char*)ofpbuf_base(b);
 230 }
 231
 232 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
 233  * 'b' before the ofpbuf must be reallocated. */
 234 static inline size_t ofpbuf_tailroom(const struct ofpbuf *b)
 235 {
 236     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
 237 }
 238
 239 /* Clears any data from 'b'. */
 240 static inline void ofpbuf_clear(struct ofpbuf *b)
 241 {
 242     ofpbuf_set_data(b, ofpbuf_base(b));
 243     ofpbuf_set_size(b, 0);
 244 }
 245
 246 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 247  * 'size' bytes of data.  Returns the first byte of data removed. */
 248 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
 249 {
 250     void *data = ofpbuf_data(b);
 251     ovs_assert(ofpbuf_size(b) - ofpbuf_l2_pad_size(b) >= size);
 252     ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
 253     ofpbuf_set_size(b, ofpbuf_size(b) - size);
 254     return data;
 255 }
 256
 257 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 258  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 259  * null pointer without modifying 'b'. */
 260 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 261 {
 262     return ofpbuf_size(b) - ofpbuf_l2_pad_size(b) >= size
 263         ? ofpbuf_pull(b, size) : NULL;
 264 }
 265
 266 static inline struct ofpbuf *ofpbuf_from_list(const struct ovs_list *list)
 267 {
 268     return CONTAINER_OF(list, struct ofpbuf, list_node);
 269 }
 270
 271 static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
 272 {
 273     return ofpbuf_size(a) == ofpbuf_size(b) &&
 274            memcmp(ofpbuf_data(a), ofpbuf_data(b), ofpbuf_size(a)) == 0;
 275 }
 276
 277 /* Get the start if the Ethernet frame.  'l3_ofs' marks the end of the l2
 278  * headers, so return NULL if it is not set. */
 279 static inline void * ofpbuf_l2(const struct ofpbuf *b)
 280 {
 281     return (b->l3_ofs != UINT16_MAX) ? b->frame : NULL;
 282 }
 283
 284 /* Sets the packet frame start pointer and resets all layer offsets.
 285  * l3 offset must be set before 'l2' can be retrieved. */
 286 static inline void ofpbuf_set_frame(struct ofpbuf *b, void *packet)
 287 {
 288     b->frame = packet;
 289     b->l2_pad_size = 0;
 290     b->l2_5_ofs = UINT16_MAX;
 291     b->l3_ofs = UINT16_MAX;
 292     b->l4_ofs = UINT16_MAX;
 293 }
 294
 295 static inline uint8_t ofpbuf_l2_pad_size(const struct ofpbuf *b)
 296 {
 297     return b->l2_pad_size;
 298 }
 299
 300 static inline void ofpbuf_set_l2_pad_size(struct ofpbuf *b, uint8_t pad_size)
 301 {
 302     ovs_assert(pad_size <= ofpbuf_size(b));
 303     b->l2_pad_size = pad_size;
 304 }
 305
 306 static inline void * ofpbuf_l2_5(const struct ofpbuf *b)
 307 {
 308     return b->l2_5_ofs != UINT16_MAX ? (char *)b->frame + b->l2_5_ofs : NULL;
 309 }
 310
 311 static inline void ofpbuf_set_l2_5(struct ofpbuf *b, void *l2_5)
 312 {
 313     b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->frame : UINT16_MAX;
 314 }
 315
 316 static inline void * ofpbuf_l3(const struct ofpbuf *b)
 317 {
 318     return b->l3_ofs != UINT16_MAX ? (char *)b->frame + b->l3_ofs : NULL;
 319 }
 320
 321 static inline void ofpbuf_set_l3(struct ofpbuf *b, void *l3)
 322 {
 323     b->l3_ofs = l3 ? (char *)l3 - (char *)b->frame : UINT16_MAX;
 324 }
 325
 326 static inline void * ofpbuf_l4(const struct ofpbuf *b)
 327 {
 328     return b->l4_ofs != UINT16_MAX ? (char *)b->frame + b->l4_ofs : NULL;
 329 }
 330
 331 static inline void ofpbuf_set_l4(struct ofpbuf *b, void *l4)
 332 {
 333     b->l4_ofs = l4 ? (char *)l4 - (char *)b->frame : UINT16_MAX;
 334 }
 335
 336 static inline size_t ofpbuf_l4_size(const struct ofpbuf *b)
 337 {
 338     return b->l4_ofs != UINT16_MAX
 339         ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_l4(b)
 340         - ofpbuf_l2_pad_size(b)
 341         : 0;
 342 }
 343
 344 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
 345 {
 346     size_t l4_size = ofpbuf_l4_size(b);
 347
 348     if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
 349         struct tcp_header *tcp = ofpbuf_l4(b);
 350         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
 351
 352         if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
 353             return (const char *)tcp + tcp_len;
 354         }
 355     }
 356     return NULL;
 357 }
 358
 359 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *b)
 360 {
 361     return OVS_LIKELY(ofpbuf_l4_size(b) >= UDP_HEADER_LEN)
 362         ? (const char *)ofpbuf_l4(b) + UDP_HEADER_LEN : NULL;
 363 }
 364
 365 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *b)
 366 {
 367     return OVS_LIKELY(ofpbuf_l4_size(b) >= SCTP_HEADER_LEN)
 368         ? (const char *)ofpbuf_l4(b) + SCTP_HEADER_LEN : NULL;
 369 }
 370
 371 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *b)
 372 {
 373     return OVS_LIKELY(ofpbuf_l4_size(b) >= ICMP_HEADER_LEN)
 374         ? (const char *)ofpbuf_l4(b) + ICMP_HEADER_LEN : NULL;
 375 }
 376
 377 #ifdef DPDK_NETDEV
 378 BUILD_ASSERT_DECL(offsetof(struct ofpbuf, mbuf) == 0);
 379
 380 static inline void * ofpbuf_data(const struct ofpbuf *b)
 381 {
 382     return b->mbuf.pkt.data;
 383 }
 384
 385 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
 386 {
 387     b->mbuf.pkt.data = d;
 388 }
 389
 390 static inline void * ofpbuf_base(const struct ofpbuf *b)
 391 {
 392     return b->mbuf.buf_addr;
 393 }
 394
 395 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
 396 {
 397     b->mbuf.buf_addr = d;
 398 }
 399
 400 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
 401 {
 402     return b->mbuf.pkt.pkt_len;
 403 }
 404
 405 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
 406 {
 407     b->mbuf.pkt.data_len = v;    /* Current seg length. */
 408     b->mbuf.pkt.pkt_len = v;     /* Total length of all segments linked to
 409                                   * this segment. */
 410 }
 411
 412 #else
 413 static inline void * ofpbuf_data(const struct ofpbuf *b)
 414 {
 415     return b->data_;
 416 }
 417
 418 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
 419 {
 420     b->data_ = d;
 421 }
 422
 423 static inline void * ofpbuf_base(const struct ofpbuf *b)
 424 {
 425     return b->base_;
 426 }
 427
 428 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
 429 {
 430     b->base_ = d;
 431 }
 432
 433 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
 434 {
 435     return b->size_;
 436 }
 437
 438 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
 439 {
 440     b->size_ = v;
 441 }
 442 #endif
 443
 444 static inline void ofpbuf_reset_packet(struct ofpbuf *b, int off)
 445 {
 446     ofpbuf_set_size(b, ofpbuf_size(b) - off);
 447     ofpbuf_set_data(b, (void *) ((unsigned char *) b->frame + off));
 448     b->frame = NULL;
 449     b->l2_5_ofs = b->l3_ofs = b->l4_ofs = UINT16_MAX;
 450 }
 451
 452 #ifdef  __cplusplus
 453 }
 454 #endif
 455
 456 #endif /* ofpbuf.h */