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
  26 #ifdef  __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 enum OVS_PACKED_ENUM ofpbuf_source {
  31     OFPBUF_MALLOC,              /* Obtained via malloc(). */
  32     OFPBUF_STACK,               /* Un-movable stack space or static buffer. */
  33     OFPBUF_STUB,                /* Starts on stack, may expand into heap. */
  34 };
  35
  36 /* Buffer for holding arbitrary data.  An ofpbuf is automatically reallocated
  37  * as necessary if it grows too large for the available memory.
  38  *
  39  * 'header' and 'msg' conventions:
  40  *
  41  * OpenFlow messages: 'header' points to the start of the OpenFlow
  42  *    header, while 'msg' is the OpenFlow msg bofy.
  43  *    When parsing, the 'data' will move past these, as data is being
  44  *    pulled from the OpenFlow message.
  45  *
  46  *    Caution: buffer manipulation of 'struct ofpbuf' must always update
  47  *             the 'header' and 'msg' pointers.
  48  *
  49  *
  50  * Actions: When encoding OVS action lists, the 'header' is used
  51  *    as a pointer to the beginning of the current action (see ofpact_put()).
  52  *
  53  * rconn: Reuses 'header' as a private pointer while queuing.
  54  */
  55 struct ofpbuf {
  56     void *base;                 /* First byte of allocated space. */
  57     void *data;                 /* First byte actually in use. */
  58     uint32_t size;              /* Number of bytes in use. */
  59     uint32_t allocated;         /* Number of bytes allocated. */
  60
  61     void *header;               /* OpenFlow header. */
  62     void *msg;                  /* message's body */
  63     struct ovs_list list_node;  /* Private list element for use by owner. */
  64     enum ofpbuf_source source;  /* Source of memory allocated as 'base'. */
  65 };
  66
  67 void ofpbuf_use(struct ofpbuf *, void *, size_t);
  68 void ofpbuf_use_stack(struct ofpbuf *, void *, size_t);
  69 void ofpbuf_use_stub(struct ofpbuf *, void *, size_t);
  70 void ofpbuf_use_const(struct ofpbuf *, const void *, size_t);
  71
  72 void ofpbuf_init(struct ofpbuf *, size_t);
  73 void ofpbuf_uninit(struct ofpbuf *);
  74 void ofpbuf_reinit(struct ofpbuf *, size_t);
  75
  76 struct ofpbuf *ofpbuf_new(size_t);
  77 struct ofpbuf *ofpbuf_new_with_headroom(size_t, size_t headroom);
  78 struct ofpbuf *ofpbuf_clone(const struct ofpbuf *);
  79 struct ofpbuf *ofpbuf_clone_with_headroom(const struct ofpbuf *,
  80                                           size_t headroom);
  81 struct ofpbuf *ofpbuf_clone_data(const void *, size_t);
  82 struct ofpbuf *ofpbuf_clone_data_with_headroom(const void *, size_t,
  83                                                size_t headroom);
  84 static inline void ofpbuf_delete(struct ofpbuf *);
  85
  86 static inline void *ofpbuf_at(const struct ofpbuf *, size_t offset,
  87                               size_t size);
  88 static inline void *ofpbuf_at_assert(const struct ofpbuf *, size_t offset,
  89                                      size_t size);
  90 static inline void *ofpbuf_tail(const struct ofpbuf *);
  91 static inline void *ofpbuf_end(const struct ofpbuf *);
  92
  93 void *ofpbuf_put_uninit(struct ofpbuf *, size_t);
  94 void *ofpbuf_put_zeros(struct ofpbuf *, size_t);
  95 void *ofpbuf_put(struct ofpbuf *, const void *, size_t);
  96 char *ofpbuf_put_hex(struct ofpbuf *, const char *s, size_t *n);
  97 void ofpbuf_reserve(struct ofpbuf *, size_t);
  98 void *ofpbuf_push_uninit(struct ofpbuf *b, size_t);
  99 void *ofpbuf_push_zeros(struct ofpbuf *, size_t);
 100 void *ofpbuf_push(struct ofpbuf *b, const void *, size_t);
 101
 102 static inline size_t ofpbuf_headroom(const struct ofpbuf *);
 103 static inline size_t ofpbuf_tailroom(const struct ofpbuf *);
 104 void ofpbuf_prealloc_headroom(struct ofpbuf *, size_t);
 105 void ofpbuf_prealloc_tailroom(struct ofpbuf *, size_t);
 106 void ofpbuf_trim(struct ofpbuf *);
 107 void ofpbuf_padto(struct ofpbuf *, size_t);
 108 void ofpbuf_shift(struct ofpbuf *, int);
 109
 110 static inline void ofpbuf_clear(struct ofpbuf *);
 111 static inline void *ofpbuf_pull(struct ofpbuf *, size_t);
 112 static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
 113
 114 void *ofpbuf_steal_data(struct ofpbuf *);
 115
 116 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
 117 static inline struct ofpbuf *ofpbuf_from_list(const struct ovs_list *);
 118 void ofpbuf_list_delete(struct ovs_list *);
 119 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
 120
 121 \f
 122 /* Frees memory that 'b' points to, as well as 'b' itself. */
 123 static inline void ofpbuf_delete(struct ofpbuf *b)
 124 {
 125     if (b) {
 126         ofpbuf_uninit(b);
 127         free(b);
 128     }
 129 }
 130
 131 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
 132  * byte 'offset'.  Otherwise, returns a null pointer. */
 133 static inline void *ofpbuf_at(const struct ofpbuf *b, size_t offset,
 134                               size_t size)
 135 {
 136     return offset + size <= b->size ? (char *) b->data + offset : NULL;
 137 }
 138
 139 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
 140  * 'offset + size' bytes of data. */
 141 static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
 142                                      size_t size)
 143 {
 144     ovs_assert(offset + size <= b->size);
 145     return ((char *) b->data) + offset;
 146 }
 147
 148 /* Returns a pointer to byte following the last byte of data in use in 'b'. */
 149 static inline void *ofpbuf_tail(const struct ofpbuf *b)
 150 {
 151     return (char *) b->data + b->size;
 152 }
 153
 154 /* Returns a pointer to byte following the last byte allocated for use (but
 155  * not necessarily in use) in 'b'. */
 156 static inline void *ofpbuf_end(const struct ofpbuf *b)
 157 {
 158     return (char *) b->base + b->allocated;
 159 }
 160
 161 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
 162  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
 163  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
 164  * headroom is 0.) */
 165 static inline size_t ofpbuf_headroom(const struct ofpbuf *b)
 166 {
 167     return (char*)b->data - (char*)b->base;
 168 }
 169
 170 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
 171  * 'b' before the ofpbuf must be reallocated. */
 172 static inline size_t ofpbuf_tailroom(const struct ofpbuf *b)
 173 {
 174     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
 175 }
 176
 177 /* Clears any data from 'b'. */
 178 static inline void ofpbuf_clear(struct ofpbuf *b)
 179 {
 180     b->data = b->base;
 181     b->size = 0;
 182 }
 183
 184 /* Removes 'size' bytes from the head end of 'b', which must contain at least
 185  * 'size' bytes of data.  Returns the first byte of data removed. */
 186 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
 187 {
 188     void *data = b->data;
 189     b->data = (char*)b->data + size;
 190     b->size = b->size - size;
 191     return data;
 192 }
 193
 194 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
 195  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
 196  * null pointer without modifying 'b'. */
 197 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 198 {
 199     return b->size >= size ? ofpbuf_pull(b, size) : NULL;
 200 }
 201
 202 static inline struct ofpbuf *ofpbuf_from_list(const struct ovs_list *list)
 203 {
 204     return CONTAINER_OF(list, struct ofpbuf, list_node);
 205 }
 206
 207 static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
 208 {
 209     return a->size == b->size &&
 210            memcmp(a->data, b->data, a->size) == 0;
 211 }
 212
 213 #ifdef  __cplusplus
 214 }
 215 #endif
 216
 217 #endif /* ofpbuf.h */