lib/ofpbuf.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   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 "list.h"
  22
  23 #ifdef  __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /* Buffer for holding arbitrary data.  An ofpbuf is automatically reallocated
  28  * as necessary if it grows too large for the available memory. */
  29 struct ofpbuf {
  30     void *base;                 /* First byte of area malloc()'d area. */
  31     size_t allocated;           /* Number of bytes allocated. */
  32
  33     void *data;                 /* First byte actually in use. */
  34     size_t size;                /* Number of bytes in use. */
  35
  36     void *l2;                   /* Link-level header. */
  37     void *l3;                   /* Network-level header. */
  38     void *l4;                   /* Transport-level header. */
  39     void *l7;                   /* Application data. */
  40
  41     struct list list_node;      /* Private list element for use by owner. */
  42     void *private_p;            /* Private pointer for use by owner. */
  43 };
  44
  45 void ofpbuf_use(struct ofpbuf *, void *, size_t);
  46 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
  47
  48 void ofpbuf_init(struct ofpbuf *, size_t);
  49 void ofpbuf_uninit(struct ofpbuf *);
  50 void ofpbuf_reinit(struct ofpbuf *, size_t);
  51
  52 struct ofpbuf *ofpbuf_new(size_t);
  53 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
  54 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
  55 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
  56                                           size_t headroom);
  57 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
  58 void ofpbuf_delete(struct ofpbuf *);
  59
  60 void *ofpbuf_at(const struct ofpbuf *, size_t offset, size_t size);
  61 void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset, size_t size);
  62 void *ofpbuf_tail(const struct ofpbuf *);
  63 void *ofpbuf_end(const struct ofpbuf *);
  64
  65 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
  66 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
  67 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
  68 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
  69 void ofpbuf_reserve(struct ofpbuf *, size_t);
  70 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
  71 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
  72 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
  73
  74 size_t ofpbuf_headroom(const struct ofpbuf *);
  75 size_t ofpbuf_tailroom(const struct ofpbuf *);
  76 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
  77 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
  78 void ofpbuf_trim(struct ofpbuf *);
  79
  80 void ofpbuf_clear(struct ofpbuf *);
  81 void *ofpbuf_pull(struct ofpbuf *, size_t);
  82 void *ofpbuf_try_pull(struct ofpbuf *, size_t);
  83
  84 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
  85
  86 static inline struct ofpbuf *ofpbuf_from_list(const struct list *list)
  87 {
  88     return CONTAINER_OF(list, struct ofpbuf, list_node);
  89 }
  90 void ofpbuf_list_delete(struct list *);
  91
  92 #ifdef  __cplusplus
  93 }
  94 #endif
  95
  96 #endif /* ofpbuf.h */