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