lib/ofpbuf.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef OFPBUF_H
  35 #define OFPBUF_H 1
  36
  37 #include <stddef.h>
  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     void *base;                 /* First byte of area malloc()'d area. */
  43     size_t allocated;           /* Number of bytes allocated. */
  44
  45     void *data;                 /* First byte actually in use. */
  46     size_t size;                /* Number of bytes in use. */
  47
  48     void *l2;                   /* Link-level header. */
  49     void *l3;                   /* Network-level header. */
  50     void *l4;                   /* Transport-level header. */
  51     void *l7;                   /* Application data. */
  52
  53     struct ofpbuf *next;        /* Next in a list of ofpbufs. */
  54     void *private;              /* Private pointer for use by owner. */
  55 };
  56
  57 void ofpbuf_use(struct ofpbuf *, void *, size_t);
  58
  59 void ofpbuf_init(struct ofpbuf *, size_t);
  60 void ofpbuf_uninit(struct ofpbuf *);
  61 void ofpbuf_reinit(struct ofpbuf *, size_t);
  62
  63 struct ofpbuf *ofpbuf_new(size_t);
  64 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
  65 void ofpbuf_delete(struct ofpbuf *);
  66
  67 void *ofpbuf_at(const struct ofpbuf *, size_t offset, size_t size);
  68 void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset, size_t size);
  69 void *ofpbuf_tail(const struct ofpbuf *);
  70 void *ofpbuf_end(const struct ofpbuf *);
  71
  72 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
  73 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
  74 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
  75 void ofpbuf_reserve(struct ofpbuf *, size_t);
  76 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
  77 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
  78
  79 size_t ofpbuf_headroom(struct ofpbuf *);
  80 size_t ofpbuf_tailroom(struct ofpbuf *);
  81 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
  82 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
  83
  84 void ofpbuf_clear(struct ofpbuf *);
  85 void *ofpbuf_pull(struct ofpbuf *, size_t);
  86 void *ofpbuf_try_pull(struct ofpbuf *, size_t);
  87
  88 #endif /* ofpbuf.h */