netdev-linux: Quiet down ingress policing.
[openvswitch] / lib / ofpbuf.c
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 #include <config.h>
18 #include "ofpbuf.h"
19 #include <assert.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include "dynamic-string.h"
23 #include "util.h"
24
25 /* Initializes 'b' as an empty ofpbuf that contains the 'allocated' bytes of
26  * memory starting at 'base'.
27  *
28  * 'base' should ordinarily be the first byte of a region obtained from
29  * malloc(), but in circumstances where it can be guaranteed that 'b' will
30  * never need to be expanded or freed, it can be a pointer into arbitrary
31  * memory. */
32 void
33 ofpbuf_use(struct ofpbuf *b, void *base, size_t allocated)
34 {
35     b->base = b->data = base;
36     b->allocated = allocated;
37     b->size = 0;
38     b->l2 = b->l3 = b->l4 = b->l7 = NULL;
39     b->next = NULL;
40     b->private_p = NULL;
41 }
42
43 /* Initializes 'b' as an empty ofpbuf with an initial capacity of 'size'
44  * bytes. */
45 void
46 ofpbuf_init(struct ofpbuf *b, size_t size)
47 {
48     ofpbuf_use(b, size ? xmalloc(size) : NULL, size);
49 }
50
51 /* Frees memory that 'b' points to. */
52 void
53 ofpbuf_uninit(struct ofpbuf *b) 
54 {
55     if (b) {
56         free(b->base);
57     }
58 }
59
60 /* Frees memory that 'b' points to and allocates a new ofpbuf */
61 void
62 ofpbuf_reinit(struct ofpbuf *b, size_t size)
63 {
64     ofpbuf_uninit(b);
65     ofpbuf_init(b, size);
66 }
67
68 /* Creates and returns a new ofpbuf with an initial capacity of 'size'
69  * bytes. */
70 struct ofpbuf *
71 ofpbuf_new(size_t size)
72 {
73     struct ofpbuf *b = xmalloc(sizeof *b);
74     ofpbuf_init(b, size);
75     return b;
76 }
77
78 struct ofpbuf *
79 ofpbuf_clone(const struct ofpbuf *buffer)
80 {
81     return ofpbuf_clone_data(buffer->data, buffer->size);
82 }
83
84 struct ofpbuf *
85 ofpbuf_clone_data(const void *data, size_t size)
86 {
87     struct ofpbuf *b = ofpbuf_new(size);
88     ofpbuf_put(b, data, size);
89     return b;
90 }
91
92 /* Frees memory that 'b' points to, as well as 'b' itself. */
93 void
94 ofpbuf_delete(struct ofpbuf *b) 
95 {
96     if (b) {
97         ofpbuf_uninit(b);
98         free(b);
99     }
100 }
101
102 /* Returns the number of bytes of headroom in 'b', that is, the number of bytes
103  * of unused space in ofpbuf 'b' before the data that is in use.  (Most
104  * commonly, the data in a ofpbuf is at its beginning, and thus the ofpbuf's
105  * headroom is 0.) */
106 size_t
107 ofpbuf_headroom(const struct ofpbuf *b)
108 {
109     return (char*)b->data - (char*)b->base;
110 }
111
112 /* Returns the number of bytes that may be appended to the tail end of ofpbuf
113  * 'b' before the ofpbuf must be reallocated. */
114 size_t
115 ofpbuf_tailroom(const struct ofpbuf *b)
116 {
117     return (char*)ofpbuf_end(b) - (char*)ofpbuf_tail(b);
118 }
119
120 /* Ensures that 'b' has room for at least 'size' bytes at its tail end,
121  * reallocating and copying its data if necessary. */
122 void
123 ofpbuf_prealloc_tailroom(struct ofpbuf *b, size_t size) 
124 {
125     if (size > ofpbuf_tailroom(b)) {
126         size_t new_allocated = b->allocated + MAX(size, 64);
127         void *new_base = xmalloc(new_allocated);
128         uintptr_t base_delta = (char*)new_base - (char*)b->base;
129         memcpy(new_base, b->base, b->allocated);
130         free(b->base);
131         b->base = new_base;
132         b->allocated = new_allocated;
133         b->data = (char*)b->data + base_delta;
134         if (b->l2) {
135             b->l2 = (char*)b->l2 + base_delta;
136         }
137         if (b->l3) {
138             b->l3 = (char*)b->l3 + base_delta;
139         }
140         if (b->l4) {
141             b->l4 = (char*)b->l4 + base_delta;
142         }
143         if (b->l7) {
144             b->l7 = (char*)b->l7 + base_delta;
145         }
146     }
147 }
148
149 void
150 ofpbuf_prealloc_headroom(struct ofpbuf *b, size_t size) 
151 {
152     assert(size <= ofpbuf_headroom(b));
153 }
154
155 /* Trims the size of 'b' to fit its actual content. */
156 void
157 ofpbuf_trim(struct ofpbuf *b)
158 {
159     /* XXX These could be supported, but the current client doesn't care. */
160     assert(b->data == b->base);
161     assert(b->l2 == NULL && b->l3 == NULL && b->l4 == NULL && b->l7 == NULL);
162     if (b->allocated > b->size) {
163         b->base = b->data = xrealloc(b->base, b->size);
164         b->allocated = b->size;
165     }
166 }
167
168 /* Appends 'size' bytes of data to the tail end of 'b', reallocating and
169  * copying its data if necessary.  Returns a pointer to the first byte of the
170  * new data, which is left uninitialized. */
171 void *
172 ofpbuf_put_uninit(struct ofpbuf *b, size_t size) 
173 {
174     void *p;
175     ofpbuf_prealloc_tailroom(b, size);
176     p = ofpbuf_tail(b);
177     b->size += size;
178     return p;
179 }
180
181 /* Appends 'size' zeroed bytes to the tail end of 'b'.  Data in 'b' is
182  * reallocated and copied if necessary.  Returns a pointer to the first byte of
183  * the data's location in the ofpbuf. */
184 void *
185 ofpbuf_put_zeros(struct ofpbuf *b, size_t size)
186 {
187     void *dst = ofpbuf_put_uninit(b, size);
188     memset(dst, 0, size);
189     return dst;
190 }
191
192 /* Appends the 'size' bytes of data in 'p' to the tail end of 'b'.  Data in 'b'
193  * is reallocated and copied if necessary.  Returns a pointer to the first
194  * byte of the data's location in the ofpbuf. */
195 void *
196 ofpbuf_put(struct ofpbuf *b, const void *p, size_t size) 
197 {
198     void *dst = ofpbuf_put_uninit(b, size);
199     memcpy(dst, p, size);
200     return dst;
201 }
202
203 /* Reserves 'size' bytes of headroom so that they can be later allocated with
204  * ofpbuf_push_uninit() without reallocating the ofpbuf. */
205 void
206 ofpbuf_reserve(struct ofpbuf *b, size_t size) 
207 {
208     assert(!b->size);
209     ofpbuf_prealloc_tailroom(b, size);
210     b->data = (char*)b->data + size;
211 }
212
213 void *
214 ofpbuf_push_uninit(struct ofpbuf *b, size_t size) 
215 {
216     ofpbuf_prealloc_headroom(b, size);
217     b->data = (char*)b->data - size;
218     b->size += size;
219     return b->data;
220 }
221
222 /* Prefixes 'size' zeroed bytes to the head end of 'b'.  'b' must have at least
223  * 'size' bytes of headroom.  Returns a pointer to the first byte of the data's
224  * location in the ofpbuf. */
225 void *
226 ofpbuf_push_zeros(struct ofpbuf *b, size_t size)
227 {
228     void *dst = ofpbuf_push_uninit(b, size);
229     memset(dst, 0, size);
230     return dst;
231 }
232
233 void *
234 ofpbuf_push(struct ofpbuf *b, const void *p, size_t size) 
235 {
236     void *dst = ofpbuf_push_uninit(b, size);
237     memcpy(dst, p, size);
238     return dst;
239 }
240
241 /* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
242  * byte 'offset'.  Otherwise, returns a null pointer. */
243 void *
244 ofpbuf_at(const struct ofpbuf *b, size_t offset, size_t size) 
245 {
246     return offset + size <= b->size ? (char *) b->data + offset : NULL;
247 }
248
249 /* Returns a pointer to byte 'offset' in 'b', which must contain at least
250  * 'offset + size' bytes of data. */
251 void *
252 ofpbuf_at_assert(const struct ofpbuf *b, size_t offset, size_t size) 
253 {
254     assert(offset + size <= b->size);
255     return ((char *) b->data) + offset;
256 }
257
258 /* Returns the byte following the last byte of data in use in 'b'. */
259 void *
260 ofpbuf_tail(const struct ofpbuf *b) 
261 {
262     return (char *) b->data + b->size;
263 }
264
265 /* Returns the byte following the last byte allocated for use (but not
266  * necessarily in use) by 'b'. */
267 void *
268 ofpbuf_end(const struct ofpbuf *b) 
269 {
270     return (char *) b->base + b->allocated;
271 }
272
273 /* Clears any data from 'b'. */
274 void
275 ofpbuf_clear(struct ofpbuf *b) 
276 {
277     b->data = b->base;
278     b->size = 0;
279 }
280
281 /* Removes 'size' bytes from the head end of 'b', which must contain at least
282  * 'size' bytes of data.  Returns the first byte of data removed. */
283 void *
284 ofpbuf_pull(struct ofpbuf *b, size_t size) 
285 {
286     void *data = b->data;
287     assert(b->size >= size);
288     b->data = (char*)b->data + size;
289     b->size -= size;
290     return data;
291 }
292
293 /* If 'b' has at least 'size' bytes of data, removes that many bytes from the
294  * head end of 'b' and returns the first byte removed.  Otherwise, returns a
295  * null pointer without modifying 'b'. */
296 void *
297 ofpbuf_try_pull(struct ofpbuf *b, size_t size) 
298 {
299     return b->size >= size ? ofpbuf_pull(b, size) : NULL;
300 }
301
302 /* Returns a string that describes some of 'b''s metadata plus a hex dump of up
303  * to 'maxbytes' from the start of the buffer. */
304 char *
305 ofpbuf_to_string(const struct ofpbuf *b, size_t maxbytes)
306 {
307     struct ds s;
308
309     ds_init(&s);
310     ds_put_format(&s, "size=%zu, allocated=%zu, head=%zu, tail=%zu\n",
311                   b->size, b->allocated,
312                   ofpbuf_headroom(b), ofpbuf_tailroom(b));
313     ds_put_hex_dump(&s, b->data, MIN(b->size, maxbytes), 0, false);
314     return ds_cstr(&s);
315 }